wst

Documentation

Index

• Constants
• Variables
• func WithCipherSecret(secret []byte)
• type CheckFunc
• type Claims
  • func (c Claims) Validate() bool
• type KeyFunc
• type Token
  • func New(signature signature, encoderType encodeType, encoderTypes ...encodeType) *Token
  • func (t *Token) Check(tokenString string, keyFunc KeyFunc, checkFunc CheckFunc, claims Claims, ...) (bool, error)
  • func (t *Token) Generate(claims Claims, key interface{}) (string, error)

Constants

const (
	HeaderTypeJwt = "JWT"
	HeaderTypeWst = "WST"

	HeaderTypeKey        = "typ"
	HeaderAlgorithmKey   = "alg"
	HeaderContentTypeKey = "cty"

	ClaimsUssuerKey   = "iss"
	ClaimsSubjectKey  = "sub"
	ClaimsAudienceKey = "aud"
	CLaimsJwtId       = "jti"

	ClaimsIssuedAtKey  = "iat"
	ClaimsExpireAtKey  = "exp"
	ClaimsNotBeforeKey = "nbf"
)

const (
	EncodeAscii85     encodeType = "ascii85"
	EncodeBase32      encodeType = "base32"
	EncodeBase64      encodeType = "base64"
	EncodeHexadecimal encodeType = "hexadecimal"
	EncodeCipher      encodeType = "cipher"
)

const (
	SignatureES256 signature = "ES256"
	SignatureES384 signature = "ES384"
	SignatureES512 signature = "ES512"
	SignatureRS256 signature = "RS256"
	SignatureRS384 signature = "RS384"
	SignatureRS512 signature = "RS512"
	SignaturePS256 signature = "PS256"
	SignaturePS384 signature = "PS384"
	SignaturePS512 signature = "PS512"
	SignatureHS256 signature = "HS256"
	SignatureHS384 signature = "HS384"
	SignatureHS512 signature = "HS512"
	SignatureNONE  signature = "NONE"
)

Variables

var (
	ErrorInvalidAuthorization   = errors.New(errors.LevelError, http.StatusUnauthorized, "invalid authorization")
	ErrorInvalidSignatureMethod = errors.New(errors.LevelError, http.StatusUnauthorized, "invalid signature method")
	ErrorInvalidJwtAlgorithm    = errors.New(errors.LevelError, http.StatusUnauthorized, "invalid signature method")
	ErrorClaimsValidation       = errors.New(errors.LevelError, http.StatusUnauthorized, "error on claims validation")
	ErrorCipherTextTooShort     = errors.New(errors.LevelError, http.StatusUnauthorized, "cipher text too short")
)

Functions

func WithCipherSecret

func WithCipherSecret(secret []byte)

Types

type CheckFunc

type CheckFunc func(Claims) (bool, error)

type Claims

type Claims map[string]interface{}

func (Claims) Validate

func (c Claims) Validate() bool

type KeyFunc

type KeyFunc func(*Token) (interface{}, error)

type Token

type Token struct {
	// contains filtered or unexported fields
}

func New

func New(signature signature, encoderType encodeType, encoderTypes ...encodeType) *Token

func (*Token) Check

func (t *Token) Check(tokenString string, keyFunc KeyFunc, checkFunc CheckFunc, claims Claims, skipClaims bool) (bool, error)

func (*Token) Generate

func (t *Token) Generate(claims Claims, key interface{}) (string, error)