jwt

package module

v0.0.0-...-8e5d0db Latest Latest Go to latest Published: Jul 28, 2022 License: MIT Imports: 9 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/go-funcards/jwt

README ¶

JWT

License

Installation

Use go get.

go get github.com/go-funcards/jwt

Then import jwt package into your own code.

import "github.com/go-funcards/jwt"

License

Distributed under MIT License, please see license file within the code for more details.

Documentation ¶

Index ¶

Variables
func GetKey(key string) ([]byte, error)
func ParseRSAPrivateKeyFromPEM(key []byte) (*rsa.PrivateKey, error)
func ParseRSAPublicKeyFromPEM(key []byte) (*rsa.PublicKey, error)
type Generator
type SignerConfig
- func (cfg *SignerConfig) Generator() (*generator, error)
- func (cfg *SignerConfig) NewGenerator(privKey *rsa.PrivateKey) (*generator, error)
type User
type UserClaims
- func Unmarshal(claims json.RawMessage) (UserClaims, error)
- func (uc UserClaims) User() User
- func (uc UserClaims) Validate(audience string) error
type Verifier
type VerifierConfig
- func (cfg *VerifierConfig) NewVerifier(pubKey *rsa.PublicKey) (*verifier, error)
- func (cfg *VerifierConfig) Verifier() (*verifier, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrTokenInvalidAudience  = errors.New("token has invalid audience")
	ErrTokenExpired          = errors.New("token is expired")
	ErrTokenUsedBeforeIssued = errors.New("token used before issued")
	ErrTokenNotValidYet      = errors.New("token is not valid yet")
)

View Source

var (
	ErrKeyMustBePEMEncoded = errors.New("invalid key: Key must be a PEM encoded PKCS1 or PKCS8 key")
	ErrNotRSAPrivateKey    = errors.New("key is not a valid RSA private key")
	ErrNotRSAPublicKey     = errors.New("key is not a valid RSA public key")
)

View Source

var (
	ErrNoPrivKeyFile  = errors.New("private key file unreadable")
	ErrInvalidPrivKey = errors.New("RSA private key invalid")
)

View Source

var (
	// ErrInvalidSigningAlgorithm indicates signing algorithm is invalid, needs to be RS256, RS384 or RS512
	ErrInvalidSigningAlgorithm = errors.New("invalid signing algorithm")
	ErrTokenInvalidClaims      = errors.New("token has invalid claims")
	ErrNoPubKeyFile            = errors.New("public key file unreadable")
	ErrInvalidPubKey           = errors.New("RSA public key invalid")
)

Functions ¶

func GetKey ¶

func GetKey(key string) ([]byte, error)

func ParseRSAPrivateKeyFromPEM ¶

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

ParseRSAPrivateKeyFromPEM parses a PEM encoded PKCS1 or PKCS8 private key

func ParseRSAPublicKeyFromPEM ¶

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

ParseRSAPublicKeyFromPEM parses a PEM encoded PKCS1 or PKCS8 public key

Types ¶

type Generator ¶

type Generator interface {
	GenerateToken(user User) (string, error)
}

type SignerConfig ¶

type SignerConfig struct {
	PrivateKey string        `mapstructure:"private_key" yaml:"private_key" env:"PRIVATE_KEY" env-required:"true"`
	Audience   []string      `mapstructure:"audience" yaml:"audience" env:"AUDIENCE" env-required:"true"`
	Algorithm  jwt.Algorithm `mapstructure:"algorithm" yaml:"algorithm" env:"ALGORITHM" env-default:"RS256"`
	TTL        time.Duration `mapstructure:"ttl" yaml:"ttl" env:"TTL" env-default:"5m"`
}

func (*SignerConfig) Generator ¶

func (cfg *SignerConfig) Generator() (*generator, error)

func (*SignerConfig) NewGenerator ¶

func (cfg *SignerConfig) NewGenerator(privKey *rsa.PrivateKey) (*generator, error)

type User ¶

type User struct {
	UserID   string   `json:"user_id,omitempty"`
	Name     string   `json:"name,omitempty"`
	Email    string   `json:"email,omitempty"`
	Roles    []string `json:"roles,omitempty"`
	Metadata any      `json:"metadata,omitempty"`
}

type UserClaims ¶

type UserClaims struct {
	jwt.RegisteredClaims
	Name     string   `json:"name,omitempty"`
	Email    string   `json:"email,omitempty"`
	Roles    []string `json:"roles,omitempty"`
	Metadata any      `json:"metadata,omitempty"`
}

func Unmarshal ¶

func Unmarshal(claims json.RawMessage) (UserClaims, error)

func (UserClaims) User ¶

func (uc UserClaims) User() User

func (UserClaims) Validate ¶

func (uc UserClaims) Validate(audience string) error

type Verifier ¶

type Verifier interface {
	Parse(token string) (*jwt.Token, UserClaims, error)
	ExtractUser(token string) (User, error)
}

type VerifierConfig ¶

type VerifierConfig struct {
	PublicKey string        `mapstructure:"public_key" yaml:"public_key" env:"PUBLIC_KEY" env-required:"true"`
	Audience  string        `mapstructure:"audience" yaml:"audience" env:"AUDIENCE" env-required:"true"`
	Algorithm jwt.Algorithm `mapstructure:"algorithm" yaml:"algorithm" env:"ALGORITHM" env-default:"RS256"`
}

func (*VerifierConfig) NewVerifier ¶

func (cfg *VerifierConfig) NewVerifier(pubKey *rsa.PublicKey) (*verifier, error)

func (*VerifierConfig) Verifier ¶

func (cfg *VerifierConfig) Verifier() (*verifier, error)

Source Files ¶

View all Source files

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