package jwt

import "github.com/golang-jwt/jwt"

Package jwt is a Go implementation of JSON Web Tokens: http://self-issued.info/docs/draft-jones-json-web-token.html

See README.md for more info.

Index ¶

• Constants
• Variables
• func DecodeSegment(seg string) ([]byte, error)
• func EncodeSegment(seg []byte) string
• func RegisterSigningMethod(alg string, f func() SigningMethod)
• type Keyfunc
• type SigningMethod
• func GetSigningMethod(alg string) (method SigningMethod)
• type SigningMethodHS256
• func (m *SigningMethodHS256) Alg() string
• func (m *SigningMethodHS256) Sign(signingString string, key []byte) (string, error)
• func (m *SigningMethodHS256) Verify(signingString, signature string, key []byte) (err error)
• type SigningMethodRS256
• func (m *SigningMethodRS256) Alg() string
• func (m *SigningMethodRS256) Sign(signingString string, key []byte) (string, error)
• func (m *SigningMethodRS256) Verify(signingString, signature string, key []byte) error
• type Token
• func New(method SigningMethod) *Token
• func Parse(tokenString string, keyFunc Keyfunc) (*Token, error)
• func ParseFromRequest(req *http.Request, keyFunc Keyfunc) (token *Token, err error)
• func (t *Token) SignedString(key []byte) (string, error)
• func (t *Token) SigningString() (string, error)
• type ValidationError
• func (e ValidationError) Error() string

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 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 ¶

func DecodeSegment(seg string) ([]byte, error)

Decode JWT specific base64url encoding with padding stripped

func EncodeSegment ¶

func EncodeSegment(seg []byte) string

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 ¶

type Keyfunc func(*Token) ([]byte, error)

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 ¶

type SigningMethod interface {
	Verify(signingString, signature string, key []byte) error
	Sign(signingString string, key []byte) (string, error)
	Alg() string
}

Signing method

func GetSigningMethod ¶

func GetSigningMethod(alg string) (method SigningMethod)

Get a signing method from an "alg" string

type SigningMethodHS256 ¶

type SigningMethodHS256 struct{}

func (*SigningMethodHS256) Alg ¶

func (m *SigningMethodHS256) Alg() string

func (*SigningMethodHS256) Sign ¶

func (m *SigningMethodHS256) Sign(signingString string, key []byte) (string, error)

func (*SigningMethodHS256) Verify ¶

func (m *SigningMethodHS256) Verify(signingString, signature string, key []byte) (err error)

type SigningMethodRS256 ¶

type SigningMethodRS256 struct{}

func (*SigningMethodRS256) Alg ¶

func (m *SigningMethodRS256) Alg() string

func (*SigningMethodRS256) Sign ¶

func (m *SigningMethodRS256) Sign(signingString string, key []byte) (string, error)

Implements the Sign method from SigningMethod For this signing method, must be PEM encoded PKCS1 or PKCS8 RSA private key

func (*SigningMethodRS256) Verify ¶

func (m *SigningMethodRS256) Verify(signingString, signature string, key []byte) 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 New ¶

func New(method SigningMethod) *Token

Create a new Token. Takes a signing method

func Parse ¶

func Parse(tokenString string, keyFunc Keyfunc) (*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 ParseFromRequest ¶

func ParseFromRequest(req *http.Request, keyFunc Keyfunc) (token *Token, err error)

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 ¶

func (t *Token) SignedString(key []byte) (string, error)

Get the complete, signed token

func (*Token) SigningString ¶

func (t *Token) SigningString() (string, error)

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 ¶

doc.go jwt.go rs256.go sha256.go signing_method.go

Directories ¶