README
¶
JWT
JSON Web Tokens
JSON Web Tokens are an open, industry standard RFC 7519 method for representing claims securely between two parties.
Usage of jwt:
One of the following flags is required: sign, verify
-alg string
signing algorithm identifier
-claim value
add additional claims. may be used more than once (default {})
-compact
output compact JSON
-debug
print out all kinds of debug data
-header value
add additional header params. may be used more than once (default {})
-key string
path to key file or '-' to read from stdin
-show
Show header
-sign string
path to claims object to sign, '-' to read from stdin
-verify string
path to JWT token to verify or '-' to read from stdin
License
This project is licensed under the MIT License.
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.") )
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 ¶ added in v0.2.2
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 SigningMethod ¶ added in v0.2.2
type SigningMethod interface {
Verify(signingString, signature string, key interface{}) error
Sign(signingString string, key interface{}) (string, error)
Alg() string
}
Signing method
func GetSigningMethod ¶ added in v0.2.2
func GetSigningMethod(alg string) (method SigningMethod)
Get a signing method from an "alg" string
type SigningMethodHMAC ¶
Implements the HMAC-SHA family of signing methods signing methods
var ( SigningMethodHS256 *SigningMethodHMAC SigningMethodHS384 *SigningMethodHMAC SigningMethodHS512 *SigningMethodHMAC )
Specific instances for HS256 and company
func (*SigningMethodHMAC) Alg ¶
func (m *SigningMethodHMAC) Alg() string
func (*SigningMethodHMAC) Sign ¶
func (m *SigningMethodHMAC) Sign(signingString string, key interface{}) (string, error)
func (*SigningMethodHMAC) Verify ¶
func (m *SigningMethodHMAC) Verify(signingString, signature string, key interface{}) error
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 ¶
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 ParseFromRequest ¶
Try to find the token in an http.Request. This method will call ParseMultipartForm if there's no token in the header. Currently, it looks in the Authorization header as well as looking for an 'access_token' request parameter in req.Form.
func (*Token) SignedString ¶
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
Directories