Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Audiences ¶ added in v1.13.5
type Audiences []string
Audiences is a container for the Audiences of a token.
func AudiencesFrom ¶ added in v1.13.5
AudiencesFrom returns a request's expected audiences stored in the request context.
type Password ¶
type Password interface {
AuthenticatePassword(ctx context.Context, user, password string) (*Response, bool, error)
}
Password checks a username and password against a backing authentication store and returns a Response or an error if the password could not be checked.
type PasswordFunc ¶
PasswordFunc is a function that implements the Password interface.
func (PasswordFunc) AuthenticatePassword ¶
func (f PasswordFunc) AuthenticatePassword(ctx context.Context, user, password string) (*Response, bool, error)
AuthenticatePassword implements authenticator.Password.
type Request ¶
Request attempts to extract authentication information from a request and returns a Response or an error if the request could not be checked.
func WrapAudienceAgnosticRequest ¶ added in v1.13.5
WrapAudienceAgnosticRequest wraps an audience agnostic request authenticator to restrict its accepted audiences to a set of implicit audiences.
type RequestFunc ¶
RequestFunc is a function that implements the Request interface.
func (RequestFunc) AuthenticateRequest ¶
AuthenticateRequest implements authenticator.Request.
type Response ¶ added in v1.13.5
type Response struct { // Audiences is the set of audiences the authenticator was able to validate // the token against. If the authenticator is not audience aware, this field // will be empty. Audiences Audiences // User is the UserInfo associated with the authentication context. User user.Info }
Response is the struct returned by authenticator interfaces upon successful authentication. It contains information about whether the authenticator authenticated the request, information about the context of the authentication, and information about the authenticated user.
type Token ¶
type Token interface {
AuthenticateToken(ctx context.Context, token string) (*Response, bool, error)
}
Token checks a string value against a backing authentication store and returns a Response or an error if the token could not be checked.
func WrapAudienceAgnosticToken ¶ added in v1.13.5
WrapAudienceAgnosticToken wraps an audience agnostic token authenticator to restrict its accepted audiences to a set of implicit audiences.