admin

Documentation

Index

• Constants
• Variables
• type MemberstackAdmin
  • func NewMemberstackAdmin(o Options) MemberstackAdmin
  • func (a *MemberstackAdmin) GetJwksKeyfunc() (keyfunc.Keyfunc, error)
  • func (a *MemberstackAdmin) GetLatestJwksKeyfunc() (keyfunc.Keyfunc, error)
  • func (a *MemberstackAdmin) VerifyToken(tokenString string) (*jwt.Token, error)
• type MemberstackJwtClaims
  • func GetMemberstackClaims(token *jwt.Token) *MemberstackJwtClaims
• type Options

Constants

const ISSUER = "https://api.memberstack.com"

const JWKS_ENDPOINT = "http://member-jwt.s3-website-us-east-1.amazonaws.com/"

Variables

var (
	ErrBadJwks = errors.New("bad JWKS")
)

Types

type MemberstackAdmin

type MemberstackAdmin struct {
	Options Options
	// contains filtered or unexported fields
}

func NewMemberstackAdmin

func NewMemberstackAdmin(o Options) MemberstackAdmin

func (*MemberstackAdmin) GetJwksKeyfunc

func (a *MemberstackAdmin) GetJwksKeyfunc() (keyfunc.Keyfunc, error)

GetJwksKeyfunc fetches the JWKS from the HTTP server, parses it into a key function jwt.Parse understands, and caches it on MemberstackAdmin. Subsequent calls returns the cached value.

func (*MemberstackAdmin) GetLatestJwksKeyfunc

func (a *MemberstackAdmin) GetLatestJwksKeyfunc() (keyfunc.Keyfunc, error)

GetLatestJwksKeyfunc does the same as GetJwksKeyfunc() but always fetches from the HTTP server, updating the local cache along the way.

func (*MemberstackAdmin) VerifyToken

func (a *MemberstackAdmin) VerifyToken(tokenString string) (*jwt.Token, error)

type MemberstackJwtClaims

type MemberstackJwtClaims struct {
	MemberID string `json:"id,omitempty"`
	Type     string `json:"type,omitempty"`
	IsAdmin  bool   `json:"isAdmin,omitempty"`
	jwt.RegisteredClaims
}

func GetMemberstackClaims

func GetMemberstackClaims(token *jwt.Token) *MemberstackJwtClaims

GetMemberstackClaims is a utility function to correctly type the verified jwt.Token.Claims to Memberstack-specific JWT format

type Options

type Options struct {
	JWKSEndpoint     string
	Issuer           string
	MemberstackAppId string
}