jwtclaims

Documentation

Index

• Constants
• type AuthorizationClaims
• type ClaimsExtractor
  • func NewClaimsExtractor(options ...ClaimsExtractorOption) *ClaimsExtractor
  • func (c *ClaimsExtractor) FromToken(token *jwt.Token) AuthorizationClaims
• type ClaimsExtractorOption
  • func WithAudience(audience string) ClaimsExtractorOption
  • func WithFromRequestContext(ec ExtractClaims) ClaimsExtractorOption
  • func WithUserIDClaim(userIDClaim string) ClaimsExtractorOption
• type ExtractClaims

Constants

const (
	TokenUserProperty    = "user"
	AccountIDSuffix      = "wt_account_id"
	DomainIDSuffix       = "wt_account_domain"
	DomainCategorySuffix = "wt_account_domain_category"
	UserIDClaim          = "sub"
)

Types

type AuthorizationClaims

type AuthorizationClaims struct {
	UserId         string
	AccountId      string
	Domain         string
	DomainCategory string
}

AuthorizationClaims stores authorization information from JWTs

type ClaimsExtractor

type ClaimsExtractor struct {
	FromRequestContext ExtractClaims
	// contains filtered or unexported fields
}

ClaimsExtractor struct that holds the extract function

func NewClaimsExtractor

func NewClaimsExtractor(options ...ClaimsExtractorOption) *ClaimsExtractor

NewClaimsExtractor returns an extractor, and if provided with a function with ExtractClaims signature, then it will use that logic. Uses ExtractClaimsFromRequestContext by default

func (*ClaimsExtractor) FromToken

func (c *ClaimsExtractor) FromToken(token *jwt.Token) AuthorizationClaims

FromToken extracts claims from the token (after auth)

type ClaimsExtractorOption

type ClaimsExtractorOption func(*ClaimsExtractor)

ClaimsExtractorOption is a function that configures the ClaimsExtractor

func WithAudience

func WithAudience(audience string) ClaimsExtractorOption

WithAudience sets the audience for the extractor

func WithFromRequestContext

func WithFromRequestContext(ec ExtractClaims) ClaimsExtractorOption

WithFromRequestContext sets the function that extracts claims from the request context

func WithUserIDClaim

func WithUserIDClaim(userIDClaim string) ClaimsExtractorOption

WithUserIDClaim sets the user id claim for the extractor

type ExtractClaims

type ExtractClaims func(r *http.Request) AuthorizationClaims

Extract function type