authtocontext

package

v0.3.1 Latest Latest Go to latest Published: Jan 27, 2024 License: MIT Imports: 9 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/craftamap/hobbit-tracker

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func New() func(http.Handler) http.Handler
type AuthDetails
- func Get(r *http.Request) AuthDetails
type AuthType
type ContextKey
type MiddlewareHandler
- func (m MiddlewareHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

Constants ¶

View Source

const (
	// AuthDetailsContextKey is a key used to store and retrieve the authentication details to/from the http request
	AuthDetailsContextKey ContextKey = "AuthDetails"
	// AuthDetailsSessionKey is a key used to store and retrieve the authentication details to/from the http session
	AuthDetailsSessionKey string = "AuthDetails"
)

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New() func(http.Handler) http.Handler

New returns a new AuthToContextMiddlewareHandler

Types ¶

type AuthDetails ¶

type AuthDetails struct {
	Authenticated bool     `json:"authenticated"`
	Username      string   `json:"username,omitempty"`
	UserID        uint     `json:"userId,omitempty"`
	AuthType      AuthType `json:"authType,omitempty"`
}

AuthDetails is a struct used for storing authentication details within the cookie store

func Get ¶ added in v0.3.0

func Get(r *http.Request) AuthDetails

type AuthType ¶

type AuthType string

AuthType is a alias for string used for AuthTypeSession and AuthTypePassPassword AuthType is used to store the type of used authentication within AuthDetails

const (
	// AuthTypeSession is used to represent a session-authentication in AuthDetails
	AuthTypeSession AuthType = "Session"
	// AuthTypeAppPassword  used to represent a app-password-authentication in AuthDetails
	AuthTypeAppPassword AuthType = "AppPassword"
)

type ContextKey ¶

type ContextKey string

ContextKey is a string-alias used for safe-usage of the context method

type MiddlewareHandler ¶

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

MiddlewareHandler is a middleware for handling all possible authentication options and storing them into the context of the http request

func (MiddlewareHandler) ServeHTTP ¶

func (m MiddlewareHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements the core functionality of this middleware

Source Files ¶

View all Source files

authToContext.go

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