jwt

Documentation

Index

• Constants
• func GetTokenStringFromRequest(r *http.Request) (string, errors.Error)
• func GetTokensFromCookie(r *http.Request) (string, string)
• func RemoveTokensFromCookie(w http.ResponseWriter)
• func SetTokensToCookie(w http.ResponseWriter, t *TokenDetails)
• func ValidateAccessToken(tokenString string, secretKey string) (string, string, errors.Error)
• func ValidateRefreshToken(tokenString string, refreshSecretKey string) (string, string, errors.Error)
• type TokenDetails
  • func CreateToken(name, secretKey, refreshSecretKey string, ...) (*TokenDetails, errors.Error)

Constants

const (
	IOTechIssuer = "IOTech"

	Algorithm      = "alg"
	Authorized     = "authorized"
	ClaimAccessId  = "access_id"
	ClaimRefreshId = "refresh_id"
	ClaimUsername  = "user_name"
	ExpiresAt      = "exp"
	Issuer         = "iss"
)

Constants related to JWT

const (
	AccessTokenCookie = "IOTech_access_token"
	// This is not potential hardcoded credentials
	// nolint:gosec
	RefreshTokenCookie = "IOTech_refresh_token"
)

Constants related to Cookie and HTTP headers

Functions

func GetTokenStringFromRequest

func GetTokenStringFromRequest(r *http.Request) (string, errors.Error)

GetTokenStringFromRequest gets the token string from the request header

func GetTokensFromCookie

func GetTokensFromCookie(r *http.Request) (string, string)

GetTokensFromCookie gets the access token and refresh token from the request cookie

func RemoveTokensFromCookie

func RemoveTokensFromCookie(w http.ResponseWriter)

RemoveTokensFromCookie removes the access token and refresh token from the response cookie

func SetTokensToCookie

func SetTokensToCookie(w http.ResponseWriter, t *TokenDetails)

SetTokensToCookie sets the access token and refresh token to the response cookie

func ValidateAccessToken

func ValidateAccessToken(tokenString string, secretKey string) (string, string, errors.Error)

ValidateAccessToken validates the given access token string and gets the accessId and username.

func ValidateRefreshToken

func ValidateRefreshToken(tokenString string, refreshSecretKey string) (string, string, errors.Error)

ValidateRefreshToken validates the given refresh token string and gets the refreshId and username.

Types

type TokenDetails

type TokenDetails struct {
	AccessId     string
	AccessToken  string
	AtExpires    int64
	RefreshId    string
	RefreshToken string
	RtExpires    int64
}

func CreateToken

func CreateToken(name, secretKey, refreshSecretKey string, atExpiresFromNow, reExpiresFromNow *int64) (*TokenDetails, errors.Error)

CreateToken creates a new token with the given name and expiration time, specified in hours from now with the default expiration time of 2 hours for access token and 7 days for refresh token