oidc

Documentation

Index

• Variables
• func AddOIDCConfigAccessor(builder *di.Builder, obj interface{})
• type ClaimFact
  • func NewClaimFactType(claimType string) ClaimFact
  • func NewClaimFactTypeAndValue(claimType string, value string) ClaimFact
  • func NewClaimFactTypeAndValueClaim(claim claimsprincipalContracts.Claim) ClaimFact
• type ClaimFactDirective
• type ClaimsConfig
  • func (s *ClaimsConfig) GetChild() *ClaimsConfig
  • func (s *ClaimsConfig) WithGrpcEntrypointPermissionsClaimFactsMapAND(claimFacts ...*ClaimFact) *ClaimsConfig
  • func (s *ClaimsConfig) WithGrpcEntrypointPermissionsClaimFactsMapOR(claimFacts ...*ClaimFact) *ClaimsConfig
• type DiscoveryDocument
  • func NewDiscoveryDocument(discoveryURL url.URL) *DiscoveryDocument
  • func (document *DiscoveryDocument) Initialize() error
• type EntryPointConfig
• type IOIDCConfig
• type IOIDCConfigAccessor
  • func GetOIDCConfigAccessorFromContainer(ctn di.Container) IOIDCConfigAccessor
• type JSONWebKey
• type JSONWebKeyResponse
• type NewGinIntrospectionValidationMiddlewareOptions
• type NewJWTValidationMiddlewareOptions
• type NewOIDCAuthenticationOptions
• type OIDCConfig
  • func (c *OIDCConfig) GetAuthority() string
  • func (c *OIDCConfig) GetCronRefreshSchedule() string
  • func (c *OIDCConfig) GetEntryPoints() map[string]*EntryPointConfig
• type User

Variables

var (
	// TypeIOIDCConfig ...
	TypeIOIDCConfig = di.GetInterfaceReflectType((*IOIDCConfig)(nil))
	// TypeIOIDCConfigAccessor ...
	TypeIOIDCConfigAccessor = di.GetInterfaceReflectType((*IOIDCConfigAccessor)(nil))
)

Functions

func AddOIDCConfigAccessor

func AddOIDCConfigAccessor(builder *di.Builder, obj interface{})

AddOIDCConfigAccessor adds service to the DI container

Types

type ClaimFact

type ClaimFact struct {
	Claim     claimsprincipalContracts.Claim
	Directive ClaimFactDirective
}

ClaimFact ...

func NewClaimFactType

func NewClaimFactType(claimType string) ClaimFact

NewClaimFactType ...

func NewClaimFactTypeAndValue

func NewClaimFactTypeAndValue(claimType string, value string) ClaimFact

NewClaimFactTypeAndValue ...

func NewClaimFactTypeAndValueClaim

func NewClaimFactTypeAndValueClaim(claim claimsprincipalContracts.Claim) ClaimFact

NewClaimFactTypeAndValueClaim ...

type ClaimFactDirective

type ClaimFactDirective int64

ClaimFactDirective ...

const (
	// ClaimTypeAndValue ...
	ClaimTypeAndValue ClaimFactDirective = 0
	// ClaimType ...
	ClaimType = 1
)

type ClaimsConfig

type ClaimsConfig struct {
	OR    []*ClaimFact `mapstructure:"OR"`
	AND   []*ClaimFact `mapstructure:"AND"`
	Child *ClaimsConfig
}

ClaimsConfig ...

func (*ClaimsConfig) GetChild

func (s *ClaimsConfig) GetChild() *ClaimsConfig

GetChild gets or creates a child config that will be changed to the parent for evalutation

func (*ClaimsConfig) WithGrpcEntrypointPermissionsClaimFactsMapAND

func (s *ClaimsConfig) WithGrpcEntrypointPermissionsClaimFactsMapAND(claimFacts ...*ClaimFact) *ClaimsConfig

WithGrpcEntrypointPermissionsClaimFactsMapAND helper to add a single entrypoint config

func (*ClaimsConfig) WithGrpcEntrypointPermissionsClaimFactsMapOR

func (s *ClaimsConfig) WithGrpcEntrypointPermissionsClaimFactsMapOR(claimFacts ...*ClaimFact) *ClaimsConfig

WithGrpcEntrypointPermissionsClaimFactsMapOR helper to add a single entrypoint config

type DiscoveryDocument

type DiscoveryDocument struct {
	DiscoveryURL          url.URL
	Algorithms            []string `json:"id_token_signing_alg_values_supported"`
	IntrospectionEndpoint string
	Issuer                string `json:"issuer"`
	JWKSURL               string `json:"jwks_uri"`
	KeyResponse           *JSONWebKeyResponse
}

DiscoveryDocument ...

func NewDiscoveryDocument

func NewDiscoveryDocument(discoveryURL url.URL) *DiscoveryDocument

func (*DiscoveryDocument) Initialize

func (document *DiscoveryDocument) Initialize() error

type EntryPointConfig

type EntryPointConfig struct {
	FullMethodName string                 `mapstructure:"FULL_METHOD_NAME"`
	ClaimsConfig   *ClaimsConfig          `mapstructure:"CLAIMS_CONFIG"`
	MetaData       map[string]interface{} `mapstructure:"META_DATA"`
}

EntryPointConfig ...

type IOIDCConfig

type IOIDCConfig interface {
	GetAuthority() string
	GetCronRefreshSchedule() string
	GetEntryPoints() map[string]*EntryPointConfig
}

IOIDCConfig ...

type IOIDCConfigAccessor

type IOIDCConfigAccessor interface {
	GetOIDCConfig() IOIDCConfig
}

IOIDCConfigAccessor ...

func GetOIDCConfigAccessorFromContainer

func GetOIDCConfigAccessorFromContainer(ctn di.Container) IOIDCConfigAccessor

type JSONWebKey

type JSONWebKey struct {
	Alg string   `json:"alg"`
	Kty string   `json:"kty"`
	Kid string   `json:"kid"`
	Use string   `json:"use"`
	N   string   `json:"n"`
	E   string   `json:"e"`
	X5c []string `json:"x5c"`
}

JSONWebKey ...

type JSONWebKeyResponse

type JSONWebKeyResponse struct {
	Keys []JSONWebKey `json:"keys"`
}

JSONWebKeyResponse ...

type NewGinIntrospectionValidationMiddlewareOptions

type NewGinIntrospectionValidationMiddlewareOptions struct {
	Out      io.Writer
	LogLevel logrus.Level

	DiscoveryURL *url.URL
	ClientID     string
	ClientSecret string
}

NewGinIntrospectionValidationMiddlewareOptions ...

type NewJWTValidationMiddlewareOptions

type NewJWTValidationMiddlewareOptions struct {
	Out      io.Writer
	LogLevel logrus.Level

	DiscoveryURL *url.URL
}

NewJWTValidationMiddlewareOptions ...

type NewOIDCAuthenticationOptions

type NewOIDCAuthenticationOptions struct {
	Authority *url.URL
}

NewOIDCAuthenticationOptions ...

type OIDCConfig

type OIDCConfig struct {
	Authority string `mapstructure:"AUTHORITY"`
	// CronRefreshSchedule i.e. @every 0h1m0s
	CronRefreshSchedule string                       `mapstructure:"CRON_REFRESH_SCHEDULE"`
	EntryPoints         map[string]*EntryPointConfig `mapstructure:"ENTRY_POINTS"`
}

OIDCConfig env:OIDC_CONFIG

func (*OIDCConfig) GetAuthority

func (c *OIDCConfig) GetAuthority() string

GetAuthority ...

func (*OIDCConfig) GetCronRefreshSchedule

func (c *OIDCConfig) GetCronRefreshSchedule() string

GetCronRefreshSchedule ...

func (*OIDCConfig) GetEntryPoints

func (c *OIDCConfig) GetEntryPoints() map[string]*EntryPointConfig

GetEntryPoints ...

type User

type User struct {
	Claims jwt.MapClaims
}

User ...