auth

package
v1.13.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 25, 2024 License: MIT Imports: 2 Imported by: 6

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Auth

type Auth interface {
	// Guard attempts to get the guard against the local cache.
	Guard(name string) Auth
	// Parse the given token.
	Parse(ctx http.Context, token string) (*Payload, error)
	// User returns the current authenticated user.
	User(ctx http.Context, user any) error
	// Login logs a user into the application.
	Login(ctx http.Context, user any) (token string, err error)
	// LoginUsingID logs the given user ID into the application.
	LoginUsingID(ctx http.Context, id any) (token string, err error)
	// Refresh the token for the current user.
	Refresh(ctx http.Context) (token string, err error)
	// Logout logs the user out of the application.
	Logout(ctx http.Context) error
}

type Payload added in v1.10.0

type Payload struct {
	Guard    string
	Key      string
	ExpireAt time.Time
	IssuedAt time.Time
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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