access

Documentation

Overview

Package access represents the processing logic of access token.

Index

• type BaseClaim
  • func (c *BaseClaim) Valid() error
• type OAuth2AccessTokenClaim
• type Option
  • func WithAuthorizedClientIDs(m map[string][]string) Option
  • func WithClientCertificateGoBackSeconds(t string) Option
  • func WithClientCertificateOffsetSeconds(t string) Option
  • func WithEnableMTLSCertificateBoundAccessToken(b bool) Option
  • func WithEnableVerifyClientID(b bool) Option
  • func WithJWKProvider(jwkp jwk.Provider) Option
• type Processor
  • func New(opts ...Option) (Processor, error)

Types

type BaseClaim

type BaseClaim struct {
	jwt.StandardClaims
}

func (*BaseClaim) Valid

func (c *BaseClaim) Valid() error

Valid is copy from source code, and changed c.VerifyExpiresAt parameter.

type OAuth2AccessTokenClaim

type OAuth2AccessTokenClaim struct {
	AuthTime       int64             `json:"auth_time"`
	Version        int               `json:"ver"`
	ClientID       string            `json:"client_id"`
	UserID         string            `json:"uid"`
	ProxyPrincipal string            `json:"proxy,omitempty"`
	Scope          []string          `json:"scp"`
	Confirm        map[string]string `json:"cnf"`
	BaseClaim
}

OAuth2AccessTokenClaim represents access token claim data. based on https://github.com/AthenZ/athenz/blob/0e7335dbfa9d41eef0b049c07e7f846bff0f3169/libs/java/auth_core/src/main/java/com/AthenZ/athenz/auth/token/AccessToken.java#L382

type Option

type Option func(*atp) error

Option represents a functional options pattern interface

func WithAuthorizedClientIDs

func WithAuthorizedClientIDs(m map[string][]string) Option

WithAuthorizedClientIDs represents set authorizedClientIDs functional option

func WithClientCertificateGoBackSeconds

func WithClientCertificateGoBackSeconds(t string) Option

WithClientCertificateGoBackSeconds represents set clientCertificateGoBackSeconds functional option

func WithClientCertificateOffsetSeconds

func WithClientCertificateOffsetSeconds(t string) Option

WithClientCertificateOffsetSeconds represents set clientCertificateOffsetSeconds functional option

func WithEnableMTLSCertificateBoundAccessToken

func WithEnableMTLSCertificateBoundAccessToken(b bool) Option

WithEnableMTLSCertificateBoundAccessToken represents set enableMTLSCertificateBoundAccessToken functional option

func WithEnableVerifyClientID

func WithEnableVerifyClientID(b bool) Option

WithEnableVerifyClientID represents set enableVerifyClientID functional option

func WithJWKProvider

func WithJWKProvider(jwkp jwk.Provider) Option

WithJWKProvider represents set pubkey provider functional option

type Processor

type Processor interface {
	ParseAndValidateOAuth2AccessToken(cred string, cert *x509.Certificate) (*OAuth2AccessTokenClaim, error)
}

Processor represents the access token parser interface.

func New

func New(opts ...Option) (Processor, error)

New returns the Processor instance.