jwt

Documentation

Index

• Constants
• type AuthClaim
• type JWTConfig
• type JWTIssuer
  • func (i *JWTIssuer) IssueJWT(claim *AuthClaim) (string, error)
  • func (i *JWTIssuer) ValidateJWT(str string) (claim *AuthClaim, err error)
• type Jwter
  • func NewJwter(getter kv.Getter) Jwter
• type RawJWT
  • func (r *RawJWT) DID() (res string, ok bool)
  • func (r *RawJWT) Group() *uuid.UUID
  • func (r *RawJWT) OrgDID() (did string, ok bool)
  • func (r *RawJWT) Role() (role uint32, ok bool)
  • func (r *RawJWT) SetDID(did string) *RawJWT
  • func (r *RawJWT) SetExpirationTimestamp(expiration time.Duration) *RawJWT
  • func (r *RawJWT) SetGroup(group *uuid.UUID) *RawJWT
  • func (r *RawJWT) SetOrgDID(org string) *RawJWT
  • func (r *RawJWT) SetRole(role uint32) *RawJWT
  • func (r *RawJWT) SetTokenAccess() *RawJWT
  • func (r *RawJWT) SetTokenRefresh() *RawJWT
  • func (r *RawJWT) TokenType() (typ TokenType, ok bool)
• type TokenType

Constants

const (
	AuthorizationHeaderName = "Authorization"
	BearerTokenPrefix       = "Bearer "
)

const (
	UserDIDClaimName             = "sub"
	ExpirationTimestampClaimName = "exp"
	RoleClaimName                = "role"
	GroupClaimName               = "group"
	OrgDIDClaimName              = "org"
	TokenTypeClaimName           = "type"
)

Types

type AuthClaim

type AuthClaim struct {
	OrgDID  string
	UserDID string
	Role    uint32
	Group   *uuid.UUID
	Type    TokenType
}

AuthClaim is a helper structure to organize all claims in one entity

type JWTConfig

type JWTConfig struct {
	SecretKey             string        `fig:"secret_key,required"`
	AccessExpirationTime  time.Duration `fig:"access_expiration_time,required"`
	RefreshExpirationTime time.Duration `fig:"refresh_expiration_time,required"`
}

type JWTIssuer

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

func (*JWTIssuer) IssueJWT

func (i *JWTIssuer) IssueJWT(claim *AuthClaim) (string, error)

func (*JWTIssuer) ValidateJWT

func (i *JWTIssuer) ValidateJWT(str string) (claim *AuthClaim, err error)

type Jwter

type Jwter interface {
	JWT() *JWTIssuer
}

func NewJwter

func NewJwter(getter kv.Getter) Jwter

type RawJWT

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

RawJWT represents helper structure to provide setter and getter methods to work with JWT claims

func (*RawJWT) DID

func (r *RawJWT) DID() (res string, ok bool)

func (*RawJWT) Group

func (r *RawJWT) Group() *uuid.UUID

func (*RawJWT) OrgDID

func (r *RawJWT) OrgDID() (did string, ok bool)

func (*RawJWT) Role

func (r *RawJWT) Role() (role uint32, ok bool)

func (*RawJWT) SetDID

func (r *RawJWT) SetDID(did string) *RawJWT

func (*RawJWT) SetExpirationTimestamp

func (r *RawJWT) SetExpirationTimestamp(expiration time.Duration) *RawJWT

func (*RawJWT) SetGroup

func (r *RawJWT) SetGroup(group *uuid.UUID) *RawJWT

func (*RawJWT) SetOrgDID

func (r *RawJWT) SetOrgDID(org string) *RawJWT

func (*RawJWT) SetRole

func (r *RawJWT) SetRole(role uint32) *RawJWT

func (*RawJWT) SetTokenAccess

func (r *RawJWT) SetTokenAccess() *RawJWT

func (*RawJWT) SetTokenRefresh

func (r *RawJWT) SetTokenRefresh() *RawJWT

func (*RawJWT) TokenType

func (r *RawJWT) TokenType() (typ TokenType, ok bool)

type TokenType

type TokenType string

var (
	AccessTokenType  TokenType = "access"
	RefreshTokenType TokenType = "refresh"
)