token

Documentation

Overview

Package token is used by package ssgrpc for generating and validating HMAC-SHA256 tokens sent as "per RPC credentials".

Index

• Variables
• type UserToken
  • func GenUserToken(user string, expires time.Duration, signingKey []byte) (UserToken, string, error)
  • func ValidateUserToken(token string, signingKey []byte) (UserToken, error)

Variables

var (
	ErrTokenExpired = errors.New("token expired")
	ErrBadPayload   = errors.New("payload is missing critical values")

	ErrNoToken        = errors.New("user did not provide a token")
	ErrBadBearerValue = errors.New("user provided an invalid Bearer value")
)

Types

type UserToken

type UserToken struct {
	//authenticated user name
	IAM string `json:"iam"`

	//unix epoc expire time
	EXP int64 `json:"exp"`
}

UserToken represents an authenticated user

func GenUserToken

func GenUserToken(user string, expires time.Duration, signingKey []byte) (UserToken, string, error)

GenUserToken will generate an expiring HMAC-SHA256 signed token representing an authenticated user

func ValidateUserToken

func ValidateUserToken(token string, signingKey []byte) (UserToken, error)

ValidateUserToken will validate the token and attempt to unmarshal it's payload into a UserToken.

error is nil if validation succeeded.