security

Documentation

Index

• func APIKeyAuth(name, in string, authenticate TokenAuthentication) runtime.Authenticator
• func BasicAuth(authenticate UserPassAuthentication) runtime.Authenticator
• func BearerAuth(name string, authenticate ScopedTokenAuthentication) runtime.Authenticator
• func HttpAuthenticator(handler func(*http.Request) (bool, interface{}, error)) runtime.Authenticator
• func ScopedAuthenticator(handler func(*ScopedAuthRequest) (bool, interface{}, error)) runtime.Authenticator
• type ScopedAuthRequest
• type ScopedTokenAuthentication
• type TokenAuthentication
• type UserPassAuthentication

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 BasicAuth

func BasicAuth(authenticate UserPassAuthentication) runtime.Authenticator

BasicAuth creates a basic auth authenticator with the provided authentication function

func BearerAuth

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

BearerAuth for use with oauth2 flows

func HttpAuthenticator

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

HttpAuthenticator is a function that authenticates a HTTP request

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 TokenAuthentication

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

TokenAuthentication authentication function

type UserPassAuthentication

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

UserPassAuthentication authentication function