auth

package

v0.0.0-...-05cadd0 Latest Latest Go to latest Published: Sep 9, 2023 License: MIT Imports: 8 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/bhmj/pg-api

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func GetCaller(ctx context.Context) string
func SetCaller(ctx context.Context, caller string) context.Context
type Verifier
- func NewVerifier(logger log.Logger, accessFiles []string) (*Verifier, error)
- func (v *Verifier) GetAccessKey(caller string) string
- func (v *Verifier) Wrap(next http.HandlerFunc) http.HandlerFunc

Constants ¶

View Source

const (

	// KeyHeader contains secret private key of a remote service
	KeyHeader = "X-Auth-Sign"
	// CallerHeader contains name of a remote service
	CallerHeader = "X-Auth-Id"
)

Variables ¶

This section is empty.

Functions ¶

func GetCaller ¶

func GetCaller(ctx context.Context) string

GetCaller returns a caller associated with the given context or 'unknown'.

func SetCaller ¶

func SetCaller(ctx context.Context, caller string) context.Context

SetCaller returns a copy of context associated with the given caller.

Types ¶

type Verifier ¶

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

Verifier parses and verifies access keys.

func (*Verifier) GetAccessKey ¶

func (v *Verifier) GetAccessKey(caller string) string

GetAccessKey returns a key associated with the given caller or ”.

func (*Verifier) Wrap ¶

func (v *Verifier) Wrap(next http.HandlerFunc) http.HandlerFunc

Wrap wraps an HTTP handler with a middleware that acts as a access limiter. Requests which wouldn't have an access key are simply rejected with an error. The successfully verified caller is saved to the request's context.