jwt

Documentation

Index

• Variables
• type Claims
• type IJWTService
• type JWTService
  • func (s *JWTService) CreateToken(authSecret, user string) (string, error)
  • func (s *JWTService) DecryptToken(token string) (string, error)
  • func (s *JWTService) EncryptToken(token string) (string, error)
  • func (s *JWTService) GetUserFromToken(token *jwt.Token) string
  • func (s *JWTService) IsTokenValid(token *jwt.Token) error
  • func (s *JWTService) Parse(tokenFromHeader, authSecret string) (*jwt.Token, error)

Variables

var ErrInvalidIssuer error = fmt.Errorf("Invalid issuer")

var ErrInvalidToken error = fmt.Errorf("Invalid token")

var ErrInvalidUser error = fmt.Errorf("Invalid user")

var ErrTokenMissingClaims error = fmt.Errorf("Token is missing claims")

var JWTIssuer string = "mailslurper"

Types

type Claims

type Claims struct {
	jwt.StandardClaims
	User string `json:"user"`
}

type IJWTService

type IJWTService interface {
	CreateToken(authSecret, user string) (string, error)
	DecryptToken(token string) (string, error)
	EncryptToken(token string) (string, error)
	GetUserFromToken(token *jwt.Token) string
	Parse(tokenFromHeader, authSecret string) (*jwt.Token, error)
	IsTokenValid(token *jwt.Token) error
}

type JWTService

type JWTService struct {
	Config *mailslurper.Configuration
}

JWTService provides methods for working with JWTs in MailSlurper

func (*JWTService) CreateToken

func (s *JWTService) CreateToken(authSecret, user string) (string, error)

CreateToken creates a new JWT token for use in MailSlurper services

func (*JWTService) DecryptToken

func (s *JWTService) DecryptToken(token string) (string, error)

DecryptToken takes a Base64 encoded token which has been encrypted using AES-256 encryption. This returns the unencoded, unencrypted token

func (*JWTService) EncryptToken

func (s *JWTService) EncryptToken(token string) (string, error)

EncryptToken takes a token string, encrypts it using AES-256, then encodes it in Base64.

func (*JWTService) GetUserFromToken

func (s *JWTService) GetUserFromToken(token *jwt.Token) string

GetUserFromToken retrieves the user from the claims in a JWT token

func (*JWTService) IsTokenValid

func (s *JWTService) IsTokenValid(token *jwt.Token) error

IsTokenValid returns an error if there are any issues with the provided JWT token. Possible issues include:

• Missing claims
• Invalid token format
• Invalid issuer
• User doesn't have a corresponding entry in the credentials table

func (*JWTService) Parse

func (s *JWTService) Parse(tokenFromHeader, authSecret string) (*jwt.Token, error)

Parse decrypts the provided token and returns a JWT token object