jwt

package module

Go to main page

Versions in this module

v5

v5.2.1

Feb 12, 2024

v5.2.0

Nov 24, 2023

Changes in this version

+ type Validator struct

+ func NewValidator(opts ...ParserOption) *Validator

+ func (v *Validator) Validate(claims Claims) error

v5.1.0

Oct 9, 2023

Changes in this version

type ParserOption

+ func WithExpirationRequired() ParserOption

+ type VerificationKey interface

+ type VerificationKeySet struct

+ Keys []VerificationKey

v5.0.0

Apr 17, 2023

Changes in this version

+ const UnsafeAllowNoneSignatureType

+ var ErrECDSAVerification = errors.New("crypto/ecdsa: verification error")

+ var ErrEd25519Verification = errors.New("ed25519: verification error")

+ var ErrHashUnavailable = errors.New("the requested hash function is unavailable")

+ var ErrInvalidKey = errors.New("key is invalid")

+ var ErrInvalidKeyType = errors.New("key is of invalid type")

+ var ErrInvalidType = errors.New("invalid type for claim")

+ var ErrKeyMustBePEMEncoded = errors.New("invalid key: Key must be a PEM encoded PKCS1 or PKCS8 key")

+ var ErrNotECPrivateKey = errors.New("key is not a valid ECDSA private key")

+ var ErrNotECPublicKey = errors.New("key is not a valid ECDSA public key")

+ var ErrNotEdPrivateKey = errors.New("key is not a valid Ed25519 private key")

+ var ErrNotEdPublicKey = errors.New("key is not a valid Ed25519 public key")

+ var ErrNotRSAPrivateKey = errors.New("key is not a valid RSA private key")

+ var ErrNotRSAPublicKey = errors.New("key is not a valid RSA public key")

+ var ErrTokenExpired = errors.New("token is expired")

+ var ErrTokenInvalidAudience = errors.New("token has invalid audience")

+ var ErrTokenInvalidClaims = errors.New("token has invalid claims")

+ var ErrTokenInvalidId = errors.New("token has invalid id")

+ var ErrTokenInvalidIssuer = errors.New("token has invalid issuer")

+ var ErrTokenInvalidSubject = errors.New("token has invalid subject")

+ var ErrTokenMalformed = errors.New("token is malformed")

+ var ErrTokenNotValidYet = errors.New("token is not valid yet")

+ var ErrTokenRequiredClaimMissing = errors.New("token is missing required claim")

+ var ErrTokenSignatureInvalid = errors.New("token signature is invalid")

+ var ErrTokenUnverifiable = errors.New("token is unverifiable")

+ var ErrTokenUsedBeforeIssued = errors.New("token used before issued")

+ var MarshalSingleStringAsArray = true

+ var NoneSignatureTypeDisallowedError error

+ var SigningMethodNone *signingMethodNone

+ var TimePrecision = time.Second

+ func GetAlgorithms() (algs []string)

+ func ParseECPrivateKeyFromPEM(key []byte) (*ecdsa.PrivateKey, error)

+ func ParseECPublicKeyFromPEM(key []byte) (*ecdsa.PublicKey, error)

+ func ParseEdPrivateKeyFromPEM(key []byte) (crypto.PrivateKey, error)

+ func ParseEdPublicKeyFromPEM(key []byte) (crypto.PublicKey, error)

+ func ParseRSAPrivateKeyFromPEM(key []byte) (*rsa.PrivateKey, error)

+ func ParseRSAPrivateKeyFromPEMWithPassword(key []byte, password string) (*rsa.PrivateKey, error)

+ func ParseRSAPublicKeyFromPEM(key []byte) (*rsa.PublicKey, error)

+ func RegisterSigningMethod(alg string, f func() SigningMethod)

+ type ClaimStrings []string

+ func (s *ClaimStrings) UnmarshalJSON(data []byte) (err error)

+ func (s ClaimStrings) MarshalJSON() (b []byte, err error)

+ type Claims interface

+ GetAudience func() (ClaimStrings, error)

+ GetExpirationTime func() (*NumericDate, error)

+ GetIssuedAt func() (*NumericDate, error)

+ GetIssuer func() (string, error)

+ GetNotBefore func() (*NumericDate, error)

+ GetSubject func() (string, error)

+ type ClaimsValidator interface

+ Validate func() error

+ type Keyfunc func(*Token) (interface{}, error)

+ type MapClaims map[string]interface

+ func (m MapClaims) GetAudience() (ClaimStrings, error)

+ func (m MapClaims) GetExpirationTime() (*NumericDate, error)

+ func (m MapClaims) GetIssuedAt() (*NumericDate, error)

+ func (m MapClaims) GetIssuer() (string, error)

+ func (m MapClaims) GetNotBefore() (*NumericDate, error)

+ func (m MapClaims) GetSubject() (string, error)

+ type NumericDate struct

+ func NewNumericDate(t time.Time) *NumericDate

+ func (date *NumericDate) UnmarshalJSON(b []byte) (err error)

+ func (date NumericDate) MarshalJSON() (b []byte, err error)

+ type Parser struct

+ func NewParser(options ...ParserOption) *Parser

+ func (p *Parser) DecodeSegment(seg string) ([]byte, error)

+ func (p *Parser) Parse(tokenString string, keyFunc Keyfunc) (*Token, error)

+ func (p *Parser) ParseUnverified(tokenString string, claims Claims) (token *Token, parts []string, err error)

+ func (p *Parser) ParseWithClaims(tokenString string, claims Claims, keyFunc Keyfunc) (*Token, error)

+ type ParserOption func(*Parser)

+ func WithAudience(aud string) ParserOption

+ func WithIssuedAt() ParserOption

+ func WithIssuer(iss string) ParserOption

+ func WithJSONNumber() ParserOption

+ func WithLeeway(leeway time.Duration) ParserOption

+ func WithPaddingAllowed() ParserOption

+ func WithStrictDecoding() ParserOption

+ func WithSubject(sub string) ParserOption

+ func WithTimeFunc(f func() time.Time) ParserOption

+ func WithValidMethods(methods []string) ParserOption

+ func WithoutClaimsValidation() ParserOption

+ type RegisteredClaims struct

+ Audience ClaimStrings

+ ExpiresAt *NumericDate

+ ID string

+ IssuedAt *NumericDate

+ Issuer string

+ NotBefore *NumericDate

+ Subject string

+ func (c RegisteredClaims) GetAudience() (ClaimStrings, error)

+ func (c RegisteredClaims) GetExpirationTime() (*NumericDate, error)

+ func (c RegisteredClaims) GetIssuedAt() (*NumericDate, error)

+ func (c RegisteredClaims) GetIssuer() (string, error)

+ func (c RegisteredClaims) GetNotBefore() (*NumericDate, error)

+ func (c RegisteredClaims) GetSubject() (string, error)

+ type SigningMethod interface

+ Alg func() string

+ Sign func(signingString string, key interface{}) ([]byte, error)

+ Verify func(signingString string, sig []byte, key interface{}) error

+ func GetSigningMethod(alg string) (method SigningMethod)

+ type SigningMethodECDSA struct

+ CurveBits int

+ Hash crypto.Hash

+ KeySize int

+ Name string

+ var SigningMethodES256 *SigningMethodECDSA

+ var SigningMethodES384 *SigningMethodECDSA

+ var SigningMethodES512 *SigningMethodECDSA

+ func (m *SigningMethodECDSA) Alg() string

+ func (m *SigningMethodECDSA) Sign(signingString string, key interface{}) ([]byte, error)

+ func (m *SigningMethodECDSA) Verify(signingString string, sig []byte, key interface{}) error

+ type SigningMethodEd25519 struct

+ var SigningMethodEdDSA *SigningMethodEd25519

+ func (m *SigningMethodEd25519) Alg() string

+ func (m *SigningMethodEd25519) Sign(signingString string, key interface{}) ([]byte, error)

+ func (m *SigningMethodEd25519) Verify(signingString string, sig []byte, key interface{}) error

+ type SigningMethodHMAC struct

+ Hash crypto.Hash

+ Name string

+ var ErrSignatureInvalid = errors.New("signature is invalid")

+ var SigningMethodHS256 *SigningMethodHMAC

+ var SigningMethodHS384 *SigningMethodHMAC

+ var SigningMethodHS512 *SigningMethodHMAC

+ func (m *SigningMethodHMAC) Alg() string

+ func (m *SigningMethodHMAC) Sign(signingString string, key interface{}) ([]byte, error)

+ func (m *SigningMethodHMAC) Verify(signingString string, sig []byte, key interface{}) error

+ type SigningMethodRSA struct

+ Hash crypto.Hash

+ Name string

+ var SigningMethodRS256 *SigningMethodRSA

+ var SigningMethodRS384 *SigningMethodRSA

+ var SigningMethodRS512 *SigningMethodRSA

+ func (m *SigningMethodRSA) Alg() string

+ func (m *SigningMethodRSA) Sign(signingString string, key interface{}) ([]byte, error)

+ func (m *SigningMethodRSA) Verify(signingString string, sig []byte, key interface{}) error

+ type SigningMethodRSAPSS struct

+ Options *rsa.PSSOptions

+ VerifyOptions *rsa.PSSOptions

+ var SigningMethodPS256 *SigningMethodRSAPSS

+ var SigningMethodPS384 *SigningMethodRSAPSS

+ var SigningMethodPS512 *SigningMethodRSAPSS

+ func (m *SigningMethodRSAPSS) Sign(signingString string, key interface{}) ([]byte, error)

+ func (m *SigningMethodRSAPSS) Verify(signingString string, sig []byte, key interface{}) error

+ type Token struct

+ Claims Claims

+ Header map[string]interface{}

+ Method SigningMethod

+ Raw string

+ Signature []byte

+ Valid bool

+ func New(method SigningMethod, opts ...TokenOption) *Token

+ func NewWithClaims(method SigningMethod, claims Claims, opts ...TokenOption) *Token

+ func Parse(tokenString string, keyFunc Keyfunc, options ...ParserOption) (*Token, error)

+ func ParseWithClaims(tokenString string, claims Claims, keyFunc Keyfunc, options ...ParserOption) (*Token, error)

+ func (*Token) EncodeSegment(seg []byte) string

+ func (t *Token) SignedString(key interface{}) (string, error)

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

+ type TokenOption func(*Token)

v5.0.0-rc.2

Mar 24, 2023

v5.0.0-rc.1

Feb 21, 2023

Other modules containing this package

github.com/golang-jwt/jwt

github.com/golang-jwt/jwt/v4

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL