Documentation ¶
Index ¶
- Variables
- func NewErrAuthenticatorMisconfigured(a Authenticator, err error) *herodot.DefaultError
- func NewErrAuthenticatorNotEnabled(a Authenticator) *herodot.DefaultError
- type AuthenticationSession
- type Authenticator
- type AuthenticatorAnonymous
- func (a *AuthenticatorAnonymous) Authenticate(r *http.Request, session *AuthenticationSession, config json.RawMessage, ...) error
- func (a *AuthenticatorAnonymous) Config(config json.RawMessage) (*AuthenticatorAnonymousConfiguration, error)
- func (a *AuthenticatorAnonymous) GetID() string
- func (a *AuthenticatorAnonymous) Validate(config json.RawMessage) error
- type AuthenticatorAnonymousConfiguration
- type AuthenticatorCookieSession
- func (a *AuthenticatorCookieSession) Authenticate(r *http.Request, session *AuthenticationSession, config json.RawMessage, ...) error
- func (a *AuthenticatorCookieSession) Config(config json.RawMessage) (*AuthenticatorCookieSessionConfiguration, error)
- func (a *AuthenticatorCookieSession) GetID() string
- func (a *AuthenticatorCookieSession) Validate(config json.RawMessage) error
- type AuthenticatorCookieSessionConfiguration
- type AuthenticatorCookieSessionFilter
- type AuthenticatorJWT
- func (a *AuthenticatorJWT) Authenticate(r *http.Request, session *AuthenticationSession, config json.RawMessage, ...) error
- func (a *AuthenticatorJWT) Config(config json.RawMessage) (*AuthenticatorOAuth2JWTConfiguration, error)
- func (a *AuthenticatorJWT) GetID() string
- func (a *AuthenticatorJWT) Validate(config json.RawMessage) error
- type AuthenticatorJWTRegistry
- type AuthenticatorNoOp
- type AuthenticatorOAuth2ClientCredentials
- func (a *AuthenticatorOAuth2ClientCredentials) Authenticate(r *http.Request, session *AuthenticationSession, config json.RawMessage, ...) error
- func (a *AuthenticatorOAuth2ClientCredentials) Config(config json.RawMessage) (*AuthenticatorOAuth2Configuration, error)
- func (a *AuthenticatorOAuth2ClientCredentials) GetID() string
- func (a *AuthenticatorOAuth2ClientCredentials) Validate(config json.RawMessage) error
- type AuthenticatorOAuth2Configuration
- type AuthenticatorOAuth2Introspection
- func (a *AuthenticatorOAuth2Introspection) Authenticate(r *http.Request, session *AuthenticationSession, config json.RawMessage, ...) error
- func (a *AuthenticatorOAuth2Introspection) Config(config json.RawMessage) (*AuthenticatorOAuth2IntrospectionConfiguration, error)
- func (a *AuthenticatorOAuth2Introspection) GetID() string
- func (a *AuthenticatorOAuth2Introspection) Validate(config json.RawMessage) error
- type AuthenticatorOAuth2IntrospectionConfiguration
- type AuthenticatorOAuth2IntrospectionPreAuthConfiguration
- type AuthenticatorOAuth2IntrospectionResult
- type AuthenticatorOAuth2IntrospectionRetryConfiguration
- type AuthenticatorOAuth2JWTConfiguration
- type AuthenticatorUnauthorized
- type MatchContext
- type Registry
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrAuthenticatorNotEnabled = herodot.DefaultError{ ErrorField: "authenticator matching this route is misconfigured or disabled", CodeField: http.StatusInternalServerError, StatusField: http.StatusText(http.StatusInternalServerError), }
View Source
var ErrAuthenticatorNotResponsible = errors.New("Authenticator not responsible")
Functions ¶
func NewErrAuthenticatorMisconfigured ¶
func NewErrAuthenticatorMisconfigured(a Authenticator, err error) *herodot.DefaultError
func NewErrAuthenticatorNotEnabled ¶
func NewErrAuthenticatorNotEnabled(a Authenticator) *herodot.DefaultError
Types ¶
type AuthenticationSession ¶
type AuthenticationSession struct { Subject string `json:"subject"` Extra map[string]interface{} `json:"extra"` Header http.Header `json:"header"` MatchContext MatchContext `json:"match_context"` }
func (*AuthenticationSession) Copy ¶
func (a *AuthenticationSession) Copy() *AuthenticationSession
func (*AuthenticationSession) SetHeader ¶
func (a *AuthenticationSession) SetHeader(key, val string)
type Authenticator ¶
type Authenticator interface { Authenticate(r *http.Request, session *AuthenticationSession, config json.RawMessage, rule pipeline.Rule) error GetID() string Validate(config json.RawMessage) error }
type AuthenticatorAnonymous ¶
type AuthenticatorAnonymous struct {
// contains filtered or unexported fields
}
func NewAuthenticatorAnonymous ¶
func NewAuthenticatorAnonymous(c configuration.Provider) *AuthenticatorAnonymous
func (*AuthenticatorAnonymous) Authenticate ¶
func (a *AuthenticatorAnonymous) Authenticate(r *http.Request, session *AuthenticationSession, config json.RawMessage, _ pipeline.Rule) error
func (*AuthenticatorAnonymous) Config ¶
func (a *AuthenticatorAnonymous) Config(config json.RawMessage) (*AuthenticatorAnonymousConfiguration, error)
func (*AuthenticatorAnonymous) GetID ¶
func (a *AuthenticatorAnonymous) GetID() string
func (*AuthenticatorAnonymous) Validate ¶
func (a *AuthenticatorAnonymous) Validate(config json.RawMessage) error
type AuthenticatorAnonymousConfiguration ¶
type AuthenticatorAnonymousConfiguration struct {
Subject string `json:"subject"`
}
type AuthenticatorCookieSession ¶
type AuthenticatorCookieSession struct {
// contains filtered or unexported fields
}
func NewAuthenticatorCookieSession ¶
func NewAuthenticatorCookieSession(c configuration.Provider) *AuthenticatorCookieSession
func (*AuthenticatorCookieSession) Authenticate ¶
func (a *AuthenticatorCookieSession) Authenticate(r *http.Request, session *AuthenticationSession, config json.RawMessage, _ pipeline.Rule) error
func (*AuthenticatorCookieSession) Config ¶
func (a *AuthenticatorCookieSession) Config(config json.RawMessage) (*AuthenticatorCookieSessionConfiguration, error)
func (*AuthenticatorCookieSession) GetID ¶
func (a *AuthenticatorCookieSession) GetID() string
func (*AuthenticatorCookieSession) Validate ¶
func (a *AuthenticatorCookieSession) Validate(config json.RawMessage) error
type AuthenticatorCookieSessionFilter ¶
type AuthenticatorCookieSessionFilter struct { }
type AuthenticatorJWT ¶
type AuthenticatorJWT struct {
// contains filtered or unexported fields
}
func NewAuthenticatorJWT ¶
func NewAuthenticatorJWT( c configuration.Provider, r AuthenticatorJWTRegistry, ) *AuthenticatorJWT
func (*AuthenticatorJWT) Authenticate ¶
func (a *AuthenticatorJWT) Authenticate(r *http.Request, session *AuthenticationSession, config json.RawMessage, _ pipeline.Rule) error
func (*AuthenticatorJWT) Config ¶
func (a *AuthenticatorJWT) Config(config json.RawMessage) (*AuthenticatorOAuth2JWTConfiguration, error)
func (*AuthenticatorJWT) GetID ¶
func (a *AuthenticatorJWT) GetID() string
func (*AuthenticatorJWT) Validate ¶
func (a *AuthenticatorJWT) Validate(config json.RawMessage) error
type AuthenticatorJWTRegistry ¶
type AuthenticatorJWTRegistry interface { credentials.VerifierRegistry }
type AuthenticatorNoOp ¶
type AuthenticatorNoOp struct {
// contains filtered or unexported fields
}
func NewAuthenticatorNoOp ¶
func NewAuthenticatorNoOp(c configuration.Provider) *AuthenticatorNoOp
func (*AuthenticatorNoOp) Authenticate ¶
func (a *AuthenticatorNoOp) Authenticate(r *http.Request, session *AuthenticationSession, config json.RawMessage, _ pipeline.Rule) error
func (*AuthenticatorNoOp) GetID ¶
func (a *AuthenticatorNoOp) GetID() string
func (*AuthenticatorNoOp) Validate ¶
func (a *AuthenticatorNoOp) Validate(config json.RawMessage) error
type AuthenticatorOAuth2ClientCredentials ¶
type AuthenticatorOAuth2ClientCredentials struct {
// contains filtered or unexported fields
}
func NewAuthenticatorOAuth2ClientCredentials ¶
func NewAuthenticatorOAuth2ClientCredentials(c configuration.Provider) *AuthenticatorOAuth2ClientCredentials
func (*AuthenticatorOAuth2ClientCredentials) Authenticate ¶
func (a *AuthenticatorOAuth2ClientCredentials) Authenticate(r *http.Request, session *AuthenticationSession, config json.RawMessage, _ pipeline.Rule) error
func (*AuthenticatorOAuth2ClientCredentials) Config ¶
func (a *AuthenticatorOAuth2ClientCredentials) Config(config json.RawMessage) (*AuthenticatorOAuth2Configuration, error)
func (*AuthenticatorOAuth2ClientCredentials) GetID ¶
func (a *AuthenticatorOAuth2ClientCredentials) GetID() string
func (*AuthenticatorOAuth2ClientCredentials) Validate ¶
func (a *AuthenticatorOAuth2ClientCredentials) Validate(config json.RawMessage) error
type AuthenticatorOAuth2Introspection ¶
type AuthenticatorOAuth2Introspection struct {
// contains filtered or unexported fields
}
func NewAuthenticatorOAuth2Introspection ¶
func NewAuthenticatorOAuth2Introspection(c configuration.Provider) *AuthenticatorOAuth2Introspection
func (*AuthenticatorOAuth2Introspection) Authenticate ¶
func (a *AuthenticatorOAuth2Introspection) Authenticate(r *http.Request, session *AuthenticationSession, config json.RawMessage, _ pipeline.Rule) error
func (*AuthenticatorOAuth2Introspection) Config ¶
func (a *AuthenticatorOAuth2Introspection) Config(config json.RawMessage) (*AuthenticatorOAuth2IntrospectionConfiguration, error)
func (*AuthenticatorOAuth2Introspection) GetID ¶
func (a *AuthenticatorOAuth2Introspection) GetID() string
func (*AuthenticatorOAuth2Introspection) Validate ¶
func (a *AuthenticatorOAuth2Introspection) Validate(config json.RawMessage) error
type AuthenticatorOAuth2IntrospectionConfiguration ¶
type AuthenticatorOAuth2IntrospectionConfiguration struct { Scopes []string `json:"required_scope"` Audience []string `json:"target_audience"` Issuers []string `json:"trusted_issuers"` PreAuth *AuthenticatorOAuth2IntrospectionPreAuthConfiguration `json:"pre_authorization"` ScopeStrategy string `json:"scope_strategy"` IntrospectionURL string `json:"introspection_url"` BearerTokenLocation *helper.BearerTokenLocation `json:"token_from"` IntrospectionRequestHeaders map[string]string `json:"introspection_request_headers"` Retry *AuthenticatorOAuth2IntrospectionRetryConfiguration `json:"retry"` Cache cacheConfig `json:"cache"` }
type AuthenticatorOAuth2IntrospectionResult ¶
type AuthenticatorOAuth2IntrospectionResult struct { Active bool `json:"active"` Extra map[string]interface{} `json:"ext"` Subject string `json:"sub,omitempty"` Username string `json:"username"` Audience []string `json:"aud"` TokenType string `json:"token_type"` Issuer string `json:"iss"` ClientID string `json:"client_id,omitempty"` Scope string `json:"scope,omitempty"` Expires int64 `json:"exp"` }
type AuthenticatorOAuth2JWTConfiguration ¶
type AuthenticatorOAuth2JWTConfiguration struct { Scope []string `json:"required_scope"` Audience []string `json:"target_audience"` Issuers []string `json:"trusted_issuers"` AllowedAlgorithms []string `json:"allowed_algorithms"` JWKSURLs []string `json:"jwks_urls"` ScopeStrategy string `json:"scope_strategy"` BearerTokenLocation *helper.BearerTokenLocation `json:"token_from"` }
type AuthenticatorUnauthorized ¶
type AuthenticatorUnauthorized struct {
// contains filtered or unexported fields
}
func NewAuthenticatorUnauthorized ¶
func NewAuthenticatorUnauthorized(c configuration.Provider) *AuthenticatorUnauthorized
func (*AuthenticatorUnauthorized) Authenticate ¶
func (a *AuthenticatorUnauthorized) Authenticate(r *http.Request, session *AuthenticationSession, config json.RawMessage, _ pipeline.Rule) error
func (*AuthenticatorUnauthorized) GetID ¶
func (a *AuthenticatorUnauthorized) GetID() string
func (*AuthenticatorUnauthorized) Validate ¶
func (a *AuthenticatorUnauthorized) Validate(config json.RawMessage) error
type MatchContext ¶
Click to show internal directories.
Click to hide internal directories.