token

Documentation

Index

• Constants
• type Claims
• type Issuer
  • func NewTokenIssuer(secret string, maximumClockSkew time.Duration) Issuer
• type TokenType

Constants

const (
	DefaultIssuerName = "kubesphere"
)

Types

type Claims

type Claims struct {
	Username  string    `json:"username"`
	UID       string    `json:"uid"`
	TokenType TokenType `json:"token_type"`
	// Currently, we are not using any field in jwt.StandardClaims
	jwt.StandardClaims
}

type Issuer

type Issuer interface {
	// IssueTo issues a token a User, return error if issuing process failed
	IssueTo(user user.Info, tokenType TokenType, expiresIn time.Duration) (string, error)

	// Verify verifies a token, and return a user info if it's a valid token, otherwise return error
	Verify(string) (user.Info, TokenType, error)
}

Issuer issues token to user, tokens are required to perform mutating requests to resources

func NewTokenIssuer

func NewTokenIssuer(secret string, maximumClockSkew time.Duration) Issuer

type TokenType

type TokenType string

const (
	AccessToken  TokenType = "access_token"
	RefreshToken TokenType = "refresh_token"
	StaticToken  TokenType = "static_token"
)