idtoken

Documentation

Index

• type Header
• type IDToken
  • func NewIDToken(oIDCConfig oidcconfig.Response, rawIDToken string) (*IDToken, error)
  • func (iDToken *IDToken) GetIDTokenHeader() *Header
  • func (iDToken *IDToken) GetIDTokenPayload() *Payload
  • func (iDToken *IDToken) VerifyIDTokenHeader() error
  • func (iDToken *IDToken) VerifyPayloadClaims(options ...Option) error
  • func (iDToken *IDToken) VerifySignature(jWKsResponse jwks.Response) error
• type Option
  • func AccessTokenAccessTokenHash(accessToken string) Option
  • func Audience(audience string) Option
  • func DurationIssuedAt(duration int) Option
  • func Issuer() Option
  • func Nonce(nonce string) Option
• type Payload

Types

type Header

type Header struct {
	Type      string `json:"typ"`
	Algorithm string `json:"alg"`
	KeyID     string `json:"kid"`
}

Header is struct for decoded ID Token Header.

type IDToken

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

IDToken is struct for ID Token.

func NewIDToken

func NewIDToken(oIDCConfig oidcconfig.Response, rawIDToken string) (*IDToken, error)

NewIDToken is IDToken constructor function.

func (*IDToken) GetIDTokenHeader

func (iDToken *IDToken) GetIDTokenHeader() *Header

GetIDTokenHeader is method to getter of Header struct.

func (*IDToken) GetIDTokenPayload

func (iDToken *IDToken) GetIDTokenPayload() *Payload

GetIDTokenPayload is method to getter of Payload struct.

func (*IDToken) VerifyIDTokenHeader

func (iDToken *IDToken) VerifyIDTokenHeader() error

VerifyIDTokenHeader is method to verify ID Token Header.

func (*IDToken) VerifyPayloadClaims

func (iDToken *IDToken) VerifyPayloadClaims(options ...Option) error

VerifyPayloadClaims is method to verify claims included ID Token payload.

func (*IDToken) VerifySignature

func (iDToken *IDToken) VerifySignature(jWKsResponse jwks.Response) error

VerifySignature is method to verify ID Token signature.

type Option

type Option func(*IDToken) error

Option is functional option for VerifyPayload function initialization.

func AccessTokenAccessTokenHash

func AccessTokenAccessTokenHash(accessToken string) Option

AccessTokenAccessTokenHash is functional option to add expected access token of access token hash.

func Audience

func Audience(audience string) Option

Audience is functional option to add expected audience.

func DurationIssuedAt

func DurationIssuedAt(duration int) Option

DurationIssuedAt is functional option to add expected duration of issued at.

func Issuer

func Issuer() Option

Issuer is functional option to add expected issuer.

func Nonce

func Nonce(nonce string) Option

Nonce is functional option to add expected nonce.

type Payload

type Payload struct {
	Issuer                         string `json:"iss"`
	Subject                        string `json:"sub"`
	Audience                       []string
	RawAudience                    json.RawMessage `json:"aud"`
	Expiration                     int             `json:"exp"`
	IssuedAt                       int             `json:"iat"`
	AuthTime                       int             `json:"auth_time"`
	Nonce                          string          `json:"nonce"`
	AuthenticationMethodReference  []string        `json:"amr"`
	AccessTokenHash                string          `json:"at_hash"`
	AuthenticationContextReference string          `json:"acr"`
}

Payload is struct for decoded ID Token Payload.