jwt

Documentation

Overview

Package jwt provides simple wrapper functions for managing basic JWT Authentication with username/password credentials.

The package is designed to be used in conjunction with the net/http package in the Go standard library. It includes functions for handling login, renewal, and authorization of JWT tokens.

Index

• Constants
• type Claims
• type Credentials
• type JWT
  • func New(key []byte, userHashFn UserHashFn, opts ...Option) (*JWT, error)
  • func (c *JWT) IsAuthorized(w http.ResponseWriter, r *http.Request) bool
  • func (c *JWT) LoginHandler(w http.ResponseWriter, r *http.Request)
  • func (c *JWT) RenewHandler(w http.ResponseWriter, r *http.Request)
• type Option
  • func WithAuthorizationHeader(authorizationHeader string) Option
  • func WithClaimAudience(audience []string) Option
  • func WithClaimIssuer(issuer string) Option
  • func WithClaimSubject(subject string) Option
  • func WithExpirationTime(expirationTime time.Duration) Option
  • func WithRenewTime(renewTime time.Duration) Option
  • func WithSendResponseFn(sendResponseFn SendResponseFn) Option
  • func WithSigningMethod(signingMethod SigningMethod) Option
• type SendResponseFn
• type SigningMethod
• type UserHashFn

Constants

const (
	// DefaultExpirationTime is the default JWT expiration time.
	DefaultExpirationTime = 5 * time.Minute

	// DefaultRenewTime is the default time before the JWT expiration when the renewal is allowed.
	DefaultRenewTime = 30 * time.Second

	// DefaultAuthorizationHeader is the default authorization header name.
	DefaultAuthorizationHeader = "Authorization"
)

Types

type Claims

type Claims struct {
	Username string `json:"username"`
	jwt.RegisteredClaims
}

Claims holds the JWT information to be encoded.

type Credentials

type Credentials struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

Credentials holds the user name and password from the request body.

type JWT

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

JWT represents an instance of the HTTP retrier.

func New

func New(key []byte, userHashFn UserHashFn, opts ...Option) (*JWT, error)

New creates a new instance.

func (*JWT) IsAuthorized

func (c *JWT) IsAuthorized(w http.ResponseWriter, r *http.Request) bool

IsAuthorized checks if the user is authorized via JWT token.

func (*JWT) LoginHandler

func (c *JWT) LoginHandler(w http.ResponseWriter, r *http.Request)

LoginHandler handles the login endpoint.

func (*JWT) RenewHandler

func (c *JWT) RenewHandler(w http.ResponseWriter, r *http.Request)

RenewHandler handles the JWT renewal endpoint.

type Option

type Option func(c *JWT)

Option is the interface that allows to set the options.

func WithAuthorizationHeader

func WithAuthorizationHeader(authorizationHeader string) Option

WithAuthorizationHeader sets the authorization header name.

func WithClaimAudience

func WithClaimAudience(audience []string) Option

WithClaimAudience sets the `aud` (Audience) claim. See https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.3

func WithClaimIssuer

func WithClaimIssuer(issuer string) Option

WithClaimIssuer sets the `iss` (Issuer) JWT claim. See https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.1

func WithClaimSubject

func WithClaimSubject(subject string) Option

WithClaimSubject sets the `sub` (Subject) claim. See https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.2

func WithExpirationTime

func WithExpirationTime(expirationTime time.Duration) Option

WithExpirationTime set the JWT expiration time.

func WithRenewTime

func WithRenewTime(renewTime time.Duration) Option

WithRenewTime set the time before the JWT expiration when the renewal is allowed.

func WithSendResponseFn

func WithSendResponseFn(sendResponseFn SendResponseFn) Option

WithSendResponseFn set the function used to send back the HTTP responses.

func WithSigningMethod

func WithSigningMethod(signingMethod SigningMethod) Option

WithSigningMethod sets the signing method function.

type SendResponseFn

type SendResponseFn func(ctx context.Context, w http.ResponseWriter, statusCode int, data string)

SendResponseFn is the type of function used to send back the HTTP responses.

type SigningMethod

type SigningMethod jwt.SigningMethod

SigningMethod is a type alias for the Signing Method interface.

type UserHashFn

type UserHashFn func(username string) ([]byte, error)

UserHashFn is the type of function used to retrieve the password hash associated with each user. The hash values should be generated via bcrypt.GenerateFromPassword(pwd, bcrypt.MinCost).