jwt

Documentation

Index

• Constants
• Variables
• func Decode(jwt string, key string, verify bool) (interface{}, error)
• func Encode(payload map[string]interface{}, customHeaders map[string]interface{}, ...) (string, error)

Constants

const (
	HS256 = "HS256" // HMAC SHA256 implementation
	HS384 = "HS384" // HMAC SHA384 implementation
	HS512 = "HS512" // HMAC SHA512 implementation
)

Supported hash algorithms

Variables

var (
	ErrUnsupportedAlgorithm         = errors.New("Algorithm not supported")
	ErrHashNotAvailable             = errors.New("The specified hash is not available")
	ErrSignatureVerificationFailure = errors.New("Signature verification failed")
	ErrInvalidSegmentEncoding       = errors.New("Invalid segment encoding")
	ErrNotEnoughSegments            = errors.New("Not enough segments")
	ErrTooManySegments              = errors.New("Too many segments")
)

Possible error conditions

Functions

func Decode

func Decode(jwt string, key string, verify bool) (interface{}, error)

Decode returns the payload portion of the JWT and optionally verifies the signature

func Encode

func Encode(payload map[string]interface{}, customHeaders map[string]interface{}, key string, algorithm string) (string, error)

Encode creates a valid, signed JWT with the given payload and optional headers.