fixed typos, added error prefix and added usage to README.md

This commit is contained in:
ston1th 2018-09-13 16:29:45 +02:00
commit 4076e5cf17
3 changed files with 83 additions and 21 deletions

34
jwt.go
View file

@ -39,21 +39,23 @@ const (
// DefaultSecretReader is the default secret key generator
var DefaultSecretReader = rand.Reader
const jwtErr = "jwt: "
var (
ErrNoJWT = errors.New("not a json web token")
ErrEmptyToken = errors.New("token is empty")
ErrUnsupportedAlg = errors.New("unsupported algorithm")
ErrInvalid = errors.New("token validation failed")
ErrBlacklisted = errors.New("token blacklisted")
ErrBlacklistNotEnabled = errors.New("blacklisting is not enabled")
ErrNbf = errors.New("token not valid yet")
ErrExp = errors.New("token expired")
ErrMissingNbf = errors.New("missing nbf claim")
ErrMissingExp = errors.New("missing exp claim")
ErrMissingTokenParts = errors.New("missing token parts")
ErrEmptySignature = errors.New("token signature is empty")
ErrTokenIsNil = errors.New("token is nil")
ErrInvalidKeySize = errors.New("invalid secret key size")
ErrNoJWT = errors.New(jwtErr + "not a json web token")
ErrEmptyToken = errors.New(jwtErr + "token is empty")
ErrUnsupportedAlg = errors.New(jwtErr + "unsupported algorithm")
ErrInvalid = errors.New(jwtErr + "token validation failed")
ErrBlacklisted = errors.New(jwtErr + "token blacklisted")
ErrBlacklistNotEnabled = errors.New(jwtErr + "blacklisting is not enabled")
ErrNbf = errors.New(jwtErr + "token not valid yet")
ErrExp = errors.New(jwtErr + "token expired")
ErrMissingNbf = errors.New(jwtErr + "missing nbf claim")
ErrMissingExp = errors.New(jwtErr + "missing exp claim")
ErrMissingTokenParts = errors.New(jwtErr + "missing token parts")
ErrEmptySignature = errors.New(jwtErr + "token signature is empty")
ErrTokenIsNil = errors.New(jwtErr + "token is nil")
ErrInvalidKeySize = errors.New(jwtErr + "invalid secret key size")
)
// JWT represents the JSON Web Token signing and blacklisting infrastructure
@ -83,7 +85,7 @@ func New(expiry time.Duration, blacklist Blacklist, secret io.Reader) (*JWT, err
key := make([]byte, KeySize)
i, err := secret.Read(key)
if err != nil {
return nil, errors.New("secret reader error: " + err.Error())
return nil, errors.New(jwtErr + "secret reader error: " + err.Error())
}
if i < KeySize {
return nil, ErrInvalidKeySize
@ -250,7 +252,7 @@ func (jwt *JWT) Verify(t *Token) error {
return nil
}
// Stop will end the cleaner goroutinge execution
// Stop will end the cleaner goroutine execution
func (jwt *JWT) Stop() error {
if jwt.blacklist == nil {
return ErrBlacklistNotEnabled