Documentation
¶
Index ¶
Constants ¶
const ( ValidationErrorMalformed uint32 = 1 << iota // Token is malformed ValidationErrorUnverifiable // Token could not be verified because of signing problems ValidationErrorSignatureInvalid // Signature validation failed ValidationErrorExpired // Exp validation failed ValidationErrorNotValidYet // NBF validation failed )
The errors that might occur when parsing and validating a token
Variables ¶
var ( ErrInvalidKey = errors.New("key is invalid or of invalid type") ErrNoTokenInRequest = errors.New("no token present in request") )
Error constants
var TimeFunc = time.Now
TimeFunc provides the current time when parsing token to validate "exp" claim (expiration time). You can override it to use another time value. This is useful for testing or if your server uses a different time zone than your tokens.
Functions ¶
func DecodeSegment ¶
Decode JWT specific base64url encoding with padding stripped
func EncodeSegment ¶
Encode JWT specific base64url encoding with padding stripped
func RegisterSigningMethod ¶
func RegisterSigningMethod(alg string, f func() SigningMethod)
Register the "alg" name and a factory function for signing method. This is typically done during init() in the method's implementation
Types ¶
type Keyfunc ¶
Parse methods use this callback function to supply the key for verification. The function receives the parsed, but unverified Token. This allows you to use propries in the Header of the token (such as `kid`) to identify which key to use.
type Parser ¶
type SigningMethod ¶
type SigningMethod interface {
Verify(signingString, signature string, key interface{}) error // Returns nil if signature is valid
Sign(signingString string, key interface{}) (string, error) // Returns encoded signature or error
Alg() string // returns the alg identifier for this method (example: 'HS256')
}
Implement SigningMethod to add new methods for signing or verifying tokens.
func GetSigningMethod ¶
func GetSigningMethod(alg string) (method SigningMethod)
Get a signing method from an "alg" string
type Token ¶
type Token struct {
Raw string // The raw token. Populated when you Parse a token
// Method SigningMethod // The signing method used or to be used
Header map[string]interface{} // The first segment of the token
Claims map[string]interface{} // The second segment of the token
Signature string // The third segment of the token. Populated when you Parse a token
Valid bool // Is the token valid? Populated when you Parse/Verify a token
}
A JWT Token. Different fields will be used depending on whether you're creating or parsing/verifying a token.
func Parse ¶
func Parse(tokenString string, pkey *cryptostack.Pkey) (*Token, error)
Parse, validate, and return a token. keyFunc will receive the parsed token and should return the key for validating. If everything is kosher, err will be nil
func (*Token) SignedString ¶
func (t *Token) SignedString(skey *cryptostack.Skey) (string, error)
Get the complete, signed token
func (*Token) SigningString ¶
Generate the signing string. This is the most expensive part of the whole deal. Unless you need this for something special, just go straight for the SignedString.
type ValidationError ¶
type ValidationError struct {
Errors uint32 // bitfield. see ValidationError... constants
// contains filtered or unexported fields
}
The error from Parse if token is not valid
func (ValidationError) Error ¶
func (e ValidationError) Error() string
Validation error is an error type
Source Files