apikey

package

v0.4.22 Latest Latest Go to latest Published: Apr 12, 2024 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/pace/bricks

Links

Open Source Insights

Documentation ¶

Index ¶

type Authorizer
- func NewAuthorizer(authConfig *Config, apiKey string) *Authorizer
- func (a *Authorizer) Authorize(r *http.Request, w http.ResponseWriter) (context.Context, bool)
- func (a *Authorizer) CanAuthorizeRequest(r http.Request) bool
type Config

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Authorizer ¶

type Authorizer struct {
	// contains filtered or unexported fields
}

Authorizer implements the security.Authorizer interface for an api key based authorization.

func NewAuthorizer ¶

func NewAuthorizer(authConfig *Config, apiKey string) *Authorizer

NewAuthorizer returns a new Authorizer for api key authorization with a config and a valid api key.

func (*Authorizer) Authorize ¶

func (a *Authorizer) Authorize(r *http.Request, w http.ResponseWriter) (context.Context, bool)

Authorize authorizes a request based on the configured api key the config of the security schema Success: A context with a token containing the api key and true Error: the unchanged request context and false. the response already contains the error message

func (*Authorizer) CanAuthorizeRequest ¶ added in v0.1.27

func (a *Authorizer) CanAuthorizeRequest(r http.Request) bool

CanAuthorizeRequest returns true, if the request contains a token in the configured header, otherwise false

type Config ¶

type Config struct {
	// currently not used
	Description string
	// Must be "Header"
	In string
	// Header field name, should never be "Authorization" if OAuth2 and ApiKey Authorization is combined
	Name string
}

Config contains the configuration of the security schema with type "apiKey".

Source Files ¶

View all Source files

authorizer.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL