jwt

Documentation

Index

• Variables
• type AccessToken
  • func IssueAdminToken(signingMethod SigningMethod, claims jwt.MapClaims, expireIn time.Duration) (*AccessToken, error)
• type Guard
  • func NewGuard(cred config.Credentials) Guard
• type Handler
  • func (j *Handler) Login(config config.Credentials) http.HandlerFunc
  • func (j *Handler) Refresh() http.HandlerFunc
• type Middleware
  • func NewMiddleware(config Guard) *Middleware
  • func (m *Middleware) Handler(handler http.Handler) http.Handler
• type Parser
  • func NewParser(config ParserConfig) *Parser
  • func (jp *Parser) GetMapClaims(token *jwt.Token) (jwt.MapClaims, bool)
  • func (jp *Parser) Parse(tokenString string) (*jwt.Token, error)
  • func (jp *Parser) ParseFromRequest(r *http.Request) (*jwt.Token, error)
• type ParserConfig
  • func NewParserConfig(signingMethod ...SigningMethod) ParserConfig
• type Payload
• type SigningMethod
• type User

Variables

var (
	// ErrSigningMethodMismatch is the error returned when token is signed with the method other than verified
	ErrSigningMethodMismatch = errors.New("Signing method mismatch")
	// ErrFailedToParseToken is the error returned when token is failed to parse and validate against secret and expiration date
	ErrFailedToParseToken = errors.New("Failed to parse token")
	// ErrUnsupportedSigningMethod is the error returned when token is signed with unsupported by the library method
	ErrUnsupportedSigningMethod = errors.New("Unsupported signing method")
	// ErrInvalidPEMBlock is the error returned for keys expected to be PEM-encoded
	ErrInvalidPEMBlock = errors.New("Invalid RSA: not PEM-encoded")
	// ErrNotRSAPublicKey is the error returned for invalid RSA public key
	ErrNotRSAPublicKey = errors.New("Invalid RSA: expected PUBLIC KEY block type")
	// ErrBadPublicKey is the error returned for invalid RSA public key
	ErrBadPublicKey = errors.New("Invalid RSA: failed to assert public key")
)

Types

type AccessToken

type AccessToken struct {
	Type    string `json:"token_type"`
	Token   string `json:"access_token"`
	Expires int64  `json:"expires_in"`
}

AccessToken represents a token

func IssueAdminToken

func IssueAdminToken(signingMethod SigningMethod, claims jwt.MapClaims, expireIn time.Duration) (*AccessToken, error)

IssueAdminToken issues admin JWT for API access

type Guard

type Guard struct {
	ParserConfig

	// Duration that a jwt token is valid. Optional, defaults to one hour.
	Timeout time.Duration

	// SigningMethod defines new token signing algorithm/key pair.
	SigningMethod SigningMethod

	// This field allows clients to refresh their token until MaxRefresh has passed.
	// Note that clients can refresh their token in the last moment of MaxRefresh.
	// This means that the maximum validity timespan for a token is MaxRefresh + Timeout.
	// Optional, defaults to 0 meaning not refreshable.
	MaxRefresh time.Duration
}

Guard struct

func NewGuard

func NewGuard(cred config.Credentials) Guard

NewGuard creates a new instance of Guard with default handlers

type Handler

type Handler struct {
	Guard Guard
}

Handler struct

func (*Handler) Login

func (j *Handler) Login(config config.Credentials) http.HandlerFunc

Login can be used by clients to get a jwt token. Payload needs to be json in the form of {"username": "<USERNAME>", "password": "<PASSWORD>"}. Reply will be of the form {"token": "<TOKEN>"}.

func (*Handler) Refresh

func (j *Handler) Refresh() http.HandlerFunc

Refresh can be used to refresh existing and valid jwt token. Reply will be of the form {"token": "<TOKEN>", "expire": "<DateTime in RFC-3339 format>"}.

type Middleware

type Middleware struct {
	Guard Guard
}

Middleware struct contains data and logic required for middleware functionality

func NewMiddleware

func NewMiddleware(config Guard) *Middleware

NewMiddleware builds and returns new JWT middleware instance

func (*Middleware) Handler

func (m *Middleware) Handler(handler http.Handler) http.Handler

Handler implementation

type Parser

type Parser struct {
	Config ParserConfig
}

Parser struct

func NewParser

func NewParser(config ParserConfig) *Parser

NewParser creates a new instance of Parser

func (*Parser) GetMapClaims

func (jp *Parser) GetMapClaims(token *jwt.Token) (jwt.MapClaims, bool)

GetMapClaims returns a map version of Claims Section

func (*Parser) Parse

func (jp *Parser) Parse(tokenString string) (*jwt.Token, error)

Parse a JWT token and validates it

func (*Parser) ParseFromRequest

func (jp *Parser) ParseFromRequest(r *http.Request) (*jwt.Token, error)

ParseFromRequest tries to extract and validate token from request. See "Guard.TokenLookup" for possible ways to pass token in request.

type ParserConfig

type ParserConfig struct {
	// SigningMethods defines chain of token signature verification algorithm/key pairs.
	SigningMethods []SigningMethod

	// TokenLookup is a string in the form of "<source>:<name>" that is used
	// to extract token from the request.
	// Optional. Default value "header:Authorization".
	// Possible values:
	// - "header:<name>"
	// - "query:<name>"
	// - "cookie:<name>"
	TokenLookup string
}

ParserConfig configures the way JWT Parser gets and validates token

func NewParserConfig

func NewParserConfig(signingMethod ...SigningMethod) ParserConfig

NewParserConfig creates a new instance of ParserConfig

type Payload

type Payload struct{}

Payload Represents the context key

type SigningMethod

type SigningMethod struct {
	// Alg defines JWT signing algorithm. Possible values are: HS256, HS384, HS512, RS256, RS384, RS512
	Alg string `json:"alg"`
	Key string `json:"key"`
}

SigningMethod defines signing method algorithm and key

type User

type User struct {
	Username string
	Email    string
}

User represents a logged in user