security

Documentation

Index

• Variables
• func APIKeyAuth(name, in string, authenticate TokenAuthentication) runtime.Authenticator
• func APIKeyAuthCtx(name, in string, authenticate TokenAuthenticationCtx) runtime.Authenticator
• func Authorized() runtime.Authorizer
• func BasicAuth(authenticate UserPassAuthentication) runtime.Authenticator
• func BasicAuthCtx(authenticate UserPassAuthenticationCtx) runtime.Authenticator
• func BasicAuthRealm(realm string, authenticate UserPassAuthentication) runtime.Authenticator
• func BasicAuthRealmCtx(realm string, authenticate UserPassAuthenticationCtx) runtime.Authenticator
• func BearerAuth(name string, authenticate ScopedTokenAuthentication) runtime.Authenticator
• func BearerAuthCtx(name string, authenticate ScopedTokenAuthenticationCtx) runtime.Authenticator
• func FailedBasicAuth(r *http.Request) string
• func FailedBasicAuthCtx(ctx context.Context) string
• func HttpAuthenticator(handler func(*http.Request) (bool, interface{}, error)) runtime.Authenticator
• func OAuth2SchemeName(r *http.Request) string
• func OAuth2SchemeNameCtx(ctx context.Context) string
• func ScopedAuthenticator(handler func(*ScopedAuthRequest) (bool, interface{}, error)) runtime.Authenticator
• type ScopedAuthRequest
• type ScopedTokenAuthentication
• type ScopedTokenAuthenticationCtx
• type TokenAuthentication
• type TokenAuthenticationCtx
• type UserPassAuthentication
• type UserPassAuthenticationCtx

Variables

var DefaultRealmName = "API"

Functions

func APIKeyAuth

func APIKeyAuth(name, in string, authenticate TokenAuthentication) runtime.Authenticator

APIKeyAuth creates an authenticator that uses a token for authorization. This token can be obtained from either a header or a query string

func APIKeyAuthCtx

func APIKeyAuthCtx(name, in string, authenticate TokenAuthenticationCtx) runtime.Authenticator

APIKeyAuthCtx creates an authenticator that uses a token for authorization with support for context.Context. This token can be obtained from either a header or a query string

func Authorized

func Authorized() runtime.Authorizer

Authorized provides a default implementation of the Authorizer interface where all requests are authorized (successful)

func BasicAuth

func BasicAuth(authenticate UserPassAuthentication) runtime.Authenticator

BasicAuth creates a basic auth authenticator with the provided authentication function

func BasicAuthCtx

func BasicAuthCtx(authenticate UserPassAuthenticationCtx) runtime.Authenticator

BasicAuthCtx creates a basic auth authenticator with the provided authentication function with support for context.Context

func BasicAuthRealm

func BasicAuthRealm(realm string, authenticate UserPassAuthentication) runtime.Authenticator

BasicAuthRealm creates a basic auth authenticator with the provided authentication function and realm name

func BasicAuthRealmCtx

func BasicAuthRealmCtx(realm string, authenticate UserPassAuthenticationCtx) runtime.Authenticator

BasicAuthRealmCtx creates a basic auth authenticator with the provided authentication function and realm name with support for context.Context

func BearerAuth

func BearerAuth(name string, authenticate ScopedTokenAuthentication) runtime.Authenticator

BearerAuth for use with oauth2 flows

func BearerAuthCtx

func BearerAuthCtx(name string, authenticate ScopedTokenAuthenticationCtx) runtime.Authenticator

BearerAuthCtx for use with oauth2 flows with support for context.Context.

func FailedBasicAuth

func FailedBasicAuth(r *http.Request) string

func FailedBasicAuthCtx

func FailedBasicAuthCtx(ctx context.Context) string

func HttpAuthenticator

func HttpAuthenticator(handler func(*http.Request) (bool, interface{}, error)) runtime.Authenticator

HttpAuthenticator is a function that authenticates a HTTP request

func OAuth2SchemeName

func OAuth2SchemeName(r *http.Request) string

func OAuth2SchemeNameCtx

func OAuth2SchemeNameCtx(ctx context.Context) string

func ScopedAuthenticator

func ScopedAuthenticator(handler func(*ScopedAuthRequest) (bool, interface{}, error)) runtime.Authenticator

ScopedAuthenticator is a function that authenticates a HTTP request against a list of valid scopes

Types

type ScopedAuthRequest

type ScopedAuthRequest struct {
	Request        *http.Request
	RequiredScopes []string
}

ScopedAuthRequest contains both a http request and the required scopes for a particular operation

type ScopedTokenAuthentication

type ScopedTokenAuthentication func(string, []string) (interface{}, error)

ScopedTokenAuthentication authentication function

type ScopedTokenAuthenticationCtx

type ScopedTokenAuthenticationCtx func(context.Context, string, []string) (context.Context, interface{}, error)

ScopedTokenAuthenticationCtx authentication function with context.Context

type TokenAuthentication

type TokenAuthentication func(string) (interface{}, error)

TokenAuthentication authentication function

type TokenAuthenticationCtx

type TokenAuthenticationCtx func(context.Context, string) (context.Context, interface{}, error)

TokenAuthenticationCtx authentication function with context.Context

type UserPassAuthentication

type UserPassAuthentication func(string, string) (interface{}, error)

UserPassAuthentication authentication function

type UserPassAuthenticationCtx

type UserPassAuthenticationCtx func(context.Context, string, string) (context.Context, interface{}, error)

UserPassAuthenticationCtx authentication function with context.Context