token

Documentation

Index

• type Claims
• type IssueRequest
• type Issuer
  • func NewIssuer(options *authentication.Options) (Issuer, error)
• type Keys
• type Type
• type VerifiedResponse

Types

type Claims

type Claims struct {
	jwt.RegisteredClaims
	// Private Claim Names
	// TokenType defined the type of the token
	TokenType Type `json:"token_type,omitempty"`
	// Username user identity, deprecated field
	Username string `json:"username,omitempty"`
	// Extra contains the additional information
	Extra map[string][]string `json:"extra,omitempty"`

	// Used for issuing authorization code
	// Scopes can be used to request that specific sets of information be made available as Claim Values.
	Scopes []string `json:"scopes,omitempty"`

	// End-User's full name in displayable form including all name parts,
	// possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
	Name string `json:"name,omitempty"`
	// String value used to associate a Client session with an ID Token, and to mitigate replay attacks.
	// The value is passed through unmodified from the Authentication Request to the ID Token.
	Nonce string `json:"nonce,omitempty"`
	// End-User's preferred e-mail address.
	Email string `json:"email,omitempty"`
	// End-User's locale, represented as a BCP47 [RFC5646] language tag.
	Locale string `json:"locale,omitempty"`
	// Shorthand name by which the End-User wishes to be referred to at the RP,
	PreferredUsername string `json:"preferred_username,omitempty"`
}

type IssueRequest

type IssueRequest struct {
	User      user.Info
	ExpiresIn time.Duration
	Claims
}

type Issuer

type Issuer interface {
	// IssueTo issues a token a User, return error if issuing process failed
	IssueTo(request *IssueRequest) (string, error)

	// Verify verifies a token, and return a user info if it's a valid token, otherwise return error
	Verify(string) (*VerifiedResponse, error)

	// Keys hold encryption and signing keys.
	Keys() *Keys
}

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

func NewIssuer

func NewIssuer(options *authentication.Options) (Issuer, error)

type Keys

type Keys struct {
	SigningKey    *jose.JSONWebKey
	SigningKeyPub *jose.JSONWebKey
}

Keys hold encryption and signing keys.

type Type

type Type string

const (
	AccessToken       Type = "access_token"
	RefreshToken      Type = "refresh_token"
	StaticToken       Type = "static_token"
	AuthorizationCode Type = "code"
	IDToken           Type = "id_token"
)

type VerifiedResponse

type VerifiedResponse struct {
	User user.Info
	Claims
}