auth

package

v0.1.0 Latest Latest Go to latest Published: Mar 26, 2021 License: Apache-2.0 Imports: 9 Imported by: 1

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/riposo/riposo

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Errorf(message string, args ...interface{}) error
func Register(name string, factory Factory)
func WrapError(err error) error
type Factory
- func Get(name string) (Factory, error)
type Method
- func Basic() Method
- func OneOf(multiple ...Method) Method

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrUnauthenticated = errors.New("unauthenticated")

ErrUnauthenticated defines the basic unauthenticated error.

Functions ¶

func Errorf ¶

func Errorf(message string, args ...interface{}) error

Errorf indicates ErrUnauthenticated with a custom message.

func Register ¶

func Register(name string, factory Factory)

Register registers a new factory by name. It will panic if multiple factories are registered under the same name.

func WrapError ¶

func WrapError(err error) error

WrapError indicates ErrUnauthenticated and wraps an internal error.

Types ¶

type Factory ¶

type Factory func(*riposo.Helpers) (Method, error)

Factory initializes a Method at runtime.

func Get ¶

func Get(name string) (Factory, error)

Get returns a factory by name. Returns an error if not found.

type Method ¶

type Method interface {
	// Authenticate parses an API request and returns a user. If a user cannot authenticated it must
	// return an ErrUnauthenticated compatible error.
	Authenticate(*http.Request) (*api.User, error)

	// Close may release all resources held by the Method implementation.
	Close() error
}

Method implementations are responsible for authenticating users from HTTP requests.

func Basic ¶

func Basic() Method

Basic inits a HTTP basic auth Method.

func OneOf ¶

func OneOf(multiple ...Method) Method

OneOf adds support for multi-method authentication.

Source Files ¶

View all Source files

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