auth

package

v0.9.7 Latest Latest Go to latest Published: Feb 7, 2025 License: GPL-3.0 Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ralvarezdev/go-net

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type Authenticator
type Middleware
- func NewMiddleware(validator gojwtvalidator.Validator, handler gonethttphandler.Handler) (*Middleware, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrCodeInvalidAuthorizationHeader *string
	ErrCodeInvalidTokenClaims         *string
	ErrCodeFailedToRefreshToken       *string
)

View Source

var (
	ErrNilAuthenticator           = errors.New("authenticator cannot be nil")
	ErrInvalidAuthorizationHeader = gonethttpresponse.NewHeaderError(
		gojwtnethttp.AuthorizationHeaderKey,
		"invalid authorization header",
		ErrCodeInvalidAuthorizationHeader,
		http.StatusUnauthorized,
	)
)

Functions ¶

This section is empty.

Types ¶

type Authenticator ¶

type Authenticator interface {
	Authenticate(
		token gojwttoken.Token,
		rawToken string,
		failHandler func(
			w http.ResponseWriter,
			err string,
			httpStatus int,
			errorCode *string,
		),
		refreshTokenFn func(
			w http.ResponseWriter,
			r *http.Request,
		) error,
		authenticateFn func(next http.Handler) http.Handler,
	) func(next http.Handler) http.Handler
	AuthenticateFromHeader(
		token gojwttoken.Token,
	) func(next http.Handler) http.Handler
	AuthenticateFromCookie(
		token gojwttoken.Token,
		cookieName string,
		refreshTokenFn func(
			w http.ResponseWriter,
			r *http.Request,
		) error,
	) func(next http.Handler) http.Handler
}

Authenticator interface

type Middleware ¶

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

Middleware struct is the authentication middleware

func NewMiddleware ¶

func NewMiddleware(
	validator gojwtvalidator.Validator,
	handler gonethttphandler.Handler,
) (*Middleware, error)

NewMiddleware creates a new authentication middleware

func (*Middleware) Authenticate ¶

func (m *Middleware) Authenticate(
	token gojwttoken.Token,
	rawToken string,
	failHandler func(
		w http.ResponseWriter,
		err string,
		errorCode *string,
		httpStatus int,
	),
	refreshTokenFn func(
		w http.ResponseWriter,
		r *http.Request,
	) error,
	authenticateFn func(next http.Handler) http.Handler,
) func(next http.Handler) http.Handler

Authenticate return the middleware function that authenticates the request

func (*Middleware) AuthenticateFromCookie ¶ added in v0.8.0

func (m *Middleware) AuthenticateFromCookie(
	token gojwttoken.Token,
	cookieName string,
	refreshTokenFn func(
		w http.ResponseWriter,
		r *http.Request,
	) error,
) func(next http.Handler) http.Handler

AuthenticateFromCookie return the middleware function that authenticates the request from the cookie

func (*Middleware) AuthenticateFromHeader ¶ added in v0.8.0

func (m *Middleware) AuthenticateFromHeader(
	token gojwttoken.Token,
) func(next http.Handler) http.Handler

AuthenticateFromHeader return the middleware function that authenticates the request from the header

Source Files ¶

View all Source files

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