jwttoken

Documentation

Index

• Constants
• func TokenSecretEncode(ts *TokenSecret) (encoded string, err error)
• type JwtPayload
• type KeyType
• type PermissionType
• type Token
  • func NewToken(s *TokenSecret) *Token
  • func (t *Token) GenerateJwtToken(payload interface{}) (token string, err error)
  • func (t *Token) VerifyJwtToken(token string, payload interface{}) error
• type TokenGenerator
  • func GetDefaultTokenGenerator() *TokenGenerator
  • func NewTokenGenerator(ts *TokenSecret) *TokenGenerator
  • func (tg *TokenGenerator) Generate(issuer string, perm PermissionType, uid string, clientId string, ...) (token string, err error)
  • func (tg *TokenGenerator) Verify(token string, payload *JwtPayload) (valid bool, err error)
• type TokenSecret
  • func GenerateTokenSecret(kt KeyType) (ts *TokenSecret, err error)
  • func TokenSecretDecode(encoded string) (ts *TokenSecret, err error)

Constants

const (
	DefaultSecret = "" /* 154-byte string literal not displayed */

	PTAccess  PermissionType = "access"  // Access to all interfaces except the generation of access Token interface
	PTRefresh PermissionType = "refresh" // Only the generated Access Token interface can be accessed
	PTCustom  PermissionType = "custom"  // Custom, not set the ExpirationTime field

	AccessTokenDuration  = time.Hour * 1
	RefreshTokenDuration = time.Hour * 24 * 7
)

Functions

func TokenSecretEncode

func TokenSecretEncode(ts *TokenSecret) (encoded string, err error)

Types

type JwtPayload

type JwtPayload struct {
	jwt.Payload
	Permission PermissionType `json:"perm"`
	Uid        string         `json:"uid"`
	ClientId   string         `json:"cid,omitempty"`
	Extend     interface{}    `json:"extend,omitempty"`
}

type KeyType

type KeyType string

const (
	KTJwtHS256 KeyType = "HS256"
	KTJwtRS256 KeyType = "RS256"
)

type PermissionType

type PermissionType string

type Token

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

func NewToken

func NewToken(s *TokenSecret) *Token

func (*Token) GenerateJwtToken

func (t *Token) GenerateJwtToken(payload interface{}) (token string, err error)

func (*Token) VerifyJwtToken

func (t *Token) VerifyJwtToken(token string, payload interface{}) error

type TokenGenerator

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

func GetDefaultTokenGenerator

func GetDefaultTokenGenerator() *TokenGenerator

GetDefaultTokenGenerator return a singleton TokenGenerator with default secret

func NewTokenGenerator

func NewTokenGenerator(ts *TokenSecret) *TokenGenerator

func (*TokenGenerator) Generate

func (tg *TokenGenerator) Generate(issuer string, perm PermissionType, uid string, clientId string, extend interface{}) (token string, err error)

func (*TokenGenerator) Verify

func (tg *TokenGenerator) Verify(token string, payload *JwtPayload) (valid bool, err error)

type TokenSecret

type TokenSecret struct {
	Type       KeyType `json:"type"`
	PrivateKey []byte  `json:"private_key"`
}

func GenerateTokenSecret

func GenerateTokenSecret(kt KeyType) (ts *TokenSecret, err error)

func TokenSecretDecode

func TokenSecretDecode(encoded string) (ts *TokenSecret, err error)