Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

jwt

package module

Go to main page

Versions in this module

v5

v5.4.0

Nov 8, 2023

v5.3.0

Nov 8, 2023

retracted

v5.2.0

Nov 7, 2023

retracted

Changes in this version

+ var ErrNotJWTType = errors.New("token of not JWT type")

v5.1.0

May 6, 2023

v5.0.1

Feb 24, 2023

v5.0.0

Feb 19, 2023

Changes in this version

+ var ErrAlgorithmMismatch = errors.New("token is signed by another algorithm")

+ var ErrAudienceInvalidFormat = errors.New("audience format is not valid")

+ var ErrDateInvalidFormat = errors.New("date is not valid")

+ var ErrInvalidFormat = errors.New("token format is not valid")

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

+ var ErrInvalidSignature = errors.New("signature is not valid")

+ var ErrNilKey = errors.New("key is nil")

+ var ErrUninitializedToken = errors.New("token was not initialized")

+ var ErrUnsupportedAlg = errors.New("algorithm is not supported")

+ func GenerateRandomBits(bits int) ([]byte, error)

+ func ParseClaims(raw []byte, verifier Verifier, claims interface{}) error

+ type Algorithm string

+ const ES256

+ const ES384

+ const ES512

+ const EdDSA

+ const HS256

+ const HS384

+ const HS512

+ const PS256

+ const PS384

+ const PS512

+ const RS256

+ const RS384

+ const RS512

+ func (a Algorithm) String() string

+ type Audience []string

+ func (a *Audience) UnmarshalJSON(b []byte) error

+ func (a Audience) MarshalJSON() ([]byte, error)

+ type Builder struct

+ func NewBuilder(signer Signer, opts ...BuilderOption) *Builder

+ func (b *Builder) Build(claims interface{}) (*Token, error)

+ type BuilderOption func(*Builder)

+ func WithContentType(cty string) BuilderOption

+ func WithKeyID(kid string) BuilderOption

+ type ESAlg struct

+ func NewSignerES(alg Algorithm, key *ecdsa.PrivateKey) (*ESAlg, error)

+ func NewVerifierES(alg Algorithm, key *ecdsa.PublicKey) (*ESAlg, error)

+ func (es *ESAlg) Algorithm() Algorithm

+ func (es *ESAlg) Sign(payload []byte) ([]byte, error)

+ func (es *ESAlg) SignSize() int

+ func (es *ESAlg) Verify(token *Token) error

+ type EdDSAAlg struct

+ func NewSignerEdDSA(key ed25519.PrivateKey) (*EdDSAAlg, error)

+ func NewVerifierEdDSA(key ed25519.PublicKey) (*EdDSAAlg, error)

+ func (ed *EdDSAAlg) Algorithm() Algorithm

+ func (ed *EdDSAAlg) Sign(payload []byte) ([]byte, error)

+ func (ed *EdDSAAlg) SignSize() int

+ func (ed *EdDSAAlg) Verify(token *Token) error

+ type HSAlg struct

+ func NewSignerHS(alg Algorithm, key []byte) (*HSAlg, error)

+ func NewVerifierHS(alg Algorithm, key []byte) (*HSAlg, error)

+ func (hs *HSAlg) Algorithm() Algorithm

+ func (hs *HSAlg) Sign(payload []byte) ([]byte, error)

+ func (hs *HSAlg) SignSize() int

+ func (hs *HSAlg) Verify(token *Token) error

+ type Header struct

+ Algorithm Algorithm

+ ContentType string

+ KeyID string

+ Type string

+ func (h Header) MarshalJSON() ([]byte, error)

+ type NumericDate struct

+ func NewNumericDate(t time.Time) *NumericDate

+ func (t *NumericDate) UnmarshalJSON(data []byte) error

+ func (t NumericDate) MarshalJSON() ([]byte, error)

+ type PSAlg struct

+ func NewSignerPS(alg Algorithm, key *rsa.PrivateKey) (*PSAlg, error)

+ func NewVerifierPS(alg Algorithm, key *rsa.PublicKey) (*PSAlg, error)

+ func (ps *PSAlg) Algorithm() Algorithm

+ func (ps *PSAlg) Sign(payload []byte) ([]byte, error)

+ func (ps *PSAlg) SignSize() int

+ func (ps *PSAlg) Verify(token *Token) error

+ type RSAlg struct

+ func NewSignerRS(alg Algorithm, key *rsa.PrivateKey) (*RSAlg, error)

+ func NewVerifierRS(alg Algorithm, key *rsa.PublicKey) (*RSAlg, error)

+ func (rs *RSAlg) Algorithm() Algorithm

+ func (rs *RSAlg) Sign(payload []byte) ([]byte, error)

+ func (rs *RSAlg) SignSize() int

+ func (rs *RSAlg) Verify(token *Token) error

+ type RegisteredClaims struct

+ Audience Audience

+ ExpiresAt *NumericDate

+ ID string

+ IssuedAt *NumericDate

+ Issuer string

+ NotBefore *NumericDate

+ Subject string

+ func (sc *RegisteredClaims) IsForAudience(audience string) bool

+ func (sc *RegisteredClaims) IsID(id string) bool

+ func (sc *RegisteredClaims) IsIssuer(issuer string) bool

+ func (sc *RegisteredClaims) IsSubject(subject string) bool

+ func (sc *RegisteredClaims) IsValidAt(now time.Time) bool

+ func (sc *RegisteredClaims) IsValidExpiresAt(now time.Time) bool

+ func (sc *RegisteredClaims) IsValidIssuedAt(now time.Time) bool

+ func (sc *RegisteredClaims) IsValidNotBefore(now time.Time) bool

+ type Signer interface

+ Algorithm func() Algorithm

+ Sign func(payload []byte) ([]byte, error)

+ SignSize func() int

+ type Token struct

+ func Parse(raw []byte, verifier Verifier) (*Token, error)

+ func ParseNoVerify(raw []byte) (*Token, error)

+ func (t *Token) Bytes() []byte

+ func (t *Token) Claims() json.RawMessage

+ func (t *Token) ClaimsPart() []byte

+ func (t *Token) DecodeClaims(dst interface{}) error

+ func (t *Token) Header() Header

+ func (t *Token) HeaderPart() []byte

+ func (t *Token) PayloadPart() []byte

+ func (t *Token) Signature() []byte

+ func (t *Token) SignaturePart() []byte

+ func (t *Token) String() string

+ type Verifier interface

+ Algorithm func() Algorithm

+ Verify func(token *Token) error

Other modules containing this package

github.com/cristalhq/jwt

github.com/cristalhq/jwt/v2

github.com/cristalhq/jwt/v3

github.com/cristalhq/jwt/v4