jwt

Documentation

Index

• Constants
• Variables
• type Config
  • func GetConfigFromEnv() (*Config, error)
  • func (c Config) GetPrivateKey() ([]byte, error)
  • func (c Config) GetPublicKey() ([]byte, error)
• type Payload
  • func DecodeClaims(c fiber.Ctx) (*Payload, error)
• type Service
  • func NewJWT(privateKey, publicKey []byte) (*Service, error)
  • func (j *Service) Generate(payload Payload) (accessToken, refreshToken string, err error)
  • func (j *Service) GenerateTokenPair(payload Payload) (TokenPair, error)
  • func (j *Service) GetSigningKey() jwtware.SigningKey
  • func (j *Service) ParsePayload(tokenString string) (*Payload, error)
  • func (j *Service) PublicSigningKey() (SigningKey, error)
• type SigningKey
• type TokenPair

Constants

const (
	ContextJWTKey = "user"
)

const EnvPrefix = "JWT"

Variables

var ErrJWTTokenNotFound = errors.New("jwt token not found")

Types

type Config

type Config struct {
	PrivateKey string `env:"_PRIVATE_KEY,required,expand" envDefault:"${PWD}/testdata/test-jwt.key"`
	PublicKey  string `env:"_PUBLIC_KEY,required,expand" envDefault:"${PWD}/testdata/test-jwt.pem"`
}

func GetConfigFromEnv

func GetConfigFromEnv() (*Config, error)

func (Config) GetPrivateKey

func (c Config) GetPrivateKey() ([]byte, error)

func (Config) GetPublicKey

func (c Config) GetPublicKey() ([]byte, error)

type Payload

type Payload struct {
	UserID         string         `json:"user_id"`
	OrgID          string         `json:"org_id"`
	Role           model.UserRole `json:"role"`
	OrgSlug        string         `json:"org_slug"`
	OrgName        string         `json:"org_name"`
	UserName       string         `json:"user_name"`
	Scopes         model.Scopes   `json:"scopes"`
	ChangePassword bool           `json:"change_password"`
}

func DecodeClaims

func DecodeClaims(c fiber.Ctx) (*Payload, error)

Deprecated: use ParsePayload for token parsing without Fiber middleware types.

type Service

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

func NewJWT

func NewJWT(privateKey, publicKey []byte) (*Service, error)

func (*Service) Generate

func (j *Service) Generate(payload Payload) (accessToken, refreshToken string, err error)

func (*Service) GenerateTokenPair

func (j *Service) GenerateTokenPair(payload Payload) (TokenPair, error)

GenerateTokenPair generates access and refresh tokens with a core-owned result type.

func (*Service) GetSigningKey

func (j *Service) GetSigningKey() jwtware.SigningKey

GetSigningKey returns a Fiber JWT middleware signing key.

Deprecated: use PublicSigningKey for a core-owned signing key result.

func (*Service) ParsePayload

func (j *Service) ParsePayload(tokenString string) (*Payload, error)

ParsePayload parses and validates a JWT string into the core Payload model.

func (*Service) PublicSigningKey

func (j *Service) PublicSigningKey() (SigningKey, error)

PublicSigningKey returns the public signing key without exposing Fiber JWT middleware types.

type SigningKey

type SigningKey struct {
	Algorithm string
	PublicKey []byte
}

SigningKey is the core-owned public signing key description.

type TokenPair

type TokenPair struct {
	AccessToken  string
	RefreshToken string
}

TokenPair is the core-owned result shape for generated JWT credentials.