jwt

Documentation

Overview

Package jwt brings a mean to manage JWT tokens on top of Axone network authentication mechanisms.

Index

• type Issuer
  • func NewIssuer(secretKey []byte, issuer string, ttl time.Duration) *Issuer
  • func (issuer *Issuer) HTTPAuthHandler(proxy auth.Proxy) http.Handler
  • func (issuer *Issuer) IssueJWT(identity *auth.Identity) (string, error)
  • func (issuer *Issuer) VerifyHTTPMiddleware(next auth.AuthenticatedHandler) http.Handler
  • func (issuer *Issuer) VerifyHTTPRequest(r *http.Request) (*auth.Identity, error)
  • func (issuer *Issuer) VerifyJWT(raw string) (*auth.Identity, error)
• type Permissions
• type ProxyClaims

Types

type Issuer

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

Issuer is an entity responsible to issue and verify JWT tokens.

func NewIssuer

func NewIssuer(secretKey []byte, issuer string, ttl time.Duration) *Issuer

NewIssuer creates a new Issuer with the given secret key, issuer and token time-to-live.

func (*Issuer) HTTPAuthHandler

func (issuer *Issuer) HTTPAuthHandler(proxy auth.Proxy) http.Handler

HTTPAuthHandler returns an HTTP handler that authenticates an auth.Identity and issues a related JWT token.

func (*Issuer) IssueJWT

func (issuer *Issuer) IssueJWT(identity *auth.Identity) (string, error)

IssueJWT forge and sign a new JWT token for the given authenticated auth.Identity.

func (*Issuer) VerifyHTTPMiddleware

func (issuer *Issuer) VerifyHTTPMiddleware(next auth.AuthenticatedHandler) http.Handler

VerifyHTTPMiddleware returns an HTTP middleware that verifies the authenticity of a JWT token before forwarding the request to the next auth.AuthenticatedHandler providing the resolve auth.Identity.

func (*Issuer) VerifyHTTPRequest

func (issuer *Issuer) VerifyHTTPRequest(r *http.Request) (*auth.Identity, error)

VerifyHTTPRequest checks the authenticity of the JWT token from the given HTTP request and returns the authenticated auth.Identity.

func (*Issuer) VerifyJWT

func (issuer *Issuer) VerifyJWT(raw string) (*auth.Identity, error)

VerifyJWT checks the validity and the signature of the given JWT token and returns the authenticated identity.

type Permissions

type Permissions struct {
	Actions []string `json:"actions"`
}

Permissions is the set of permissions that are included in the JWT token.

type ProxyClaims

type ProxyClaims struct {
	jwt.StandardClaims
	Can Permissions `json:"can"`
}

ProxyClaims is the set of claims that are included in the JWT token.