server

Documentation

Index

• Constants
• Variables
• func AuthenticationMiddleware(authFunc UserAuthenticationFunc) func(http.Handler) http.Handler
• func LoggingMiddleware(next http.Handler) http.Handler
• func TelemetryMiddleware(mux *http.ServeMux) http.Handler
• type ApiKeyMap
  • func NewApiKeyMapFromHashedMap(m map[string]User) (ApiKeyMap, error)
  • func NewApiKeyMapFromPlainMap(m map[string]User) (ApiKeyMap, error)
• type User
  • func AuthenticatedUserFromContext(ctx context.Context) User
• type UserAuthenticationFunc
  • func MultipleUserApiKeyAuthenticationFunc(authData ApiKeyMap, headerName string) UserAuthenticationFunc
  • func SingleUserApiKeyAuthenticationFunc(apiKey, headerName string, user User) UserAuthenticationFunc

Constants

const (
	DefaultXApiKeyHeaderName string = "X-Api-Key"
)

Variables

var (
	ErrNotAuthorized = errors.New("unauthorized")
)

Functions

func AuthenticationMiddleware

func AuthenticationMiddleware(authFunc UserAuthenticationFunc) func(http.Handler) http.Handler

AuthenticationMiddleware is a middleware that authenticates the user through the given UserAuthenticationFunc and sets the user in the context.

func LoggingMiddleware

func LoggingMiddleware(next http.Handler) http.Handler

LoggingMiddleware is a middleware that logs HTTP requests and responses. It extracts the request body and logs it. It also logs the request and response details.

func TelemetryMiddleware

func TelemetryMiddleware(mux *http.ServeMux) http.Handler

TelemetryMiddleware is a middleware that wraps the provided http.ServeMux with OpenTelemetry instrumentation. It instruments the ServeMux with the otelhttp.NewHandler function and enables logging for all requests handled by the ServeMux.

Types

type ApiKeyMap

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

ApiKeyMap stores hashed API keys grouped by a deterministic lookup token.

It uses a bucket index to reduce the amount of bcrypt comparisons performed on each request while still using bcrypt for the final key verification.

func NewApiKeyMapFromHashedMap

func NewApiKeyMapFromHashedMap(m map[string]User) (ApiKeyMap, error)

NewApiKeyMapFromHashedMap creates a new ApiKeyMap from a map of hashed API keys to users.

func NewApiKeyMapFromPlainMap

func NewApiKeyMapFromPlainMap(m map[string]User) (ApiKeyMap, error)

NewApiKeyMapFromPlainMap creates a new ApiKeyMap from a plain map of API keys to users.

type User

type User interface {
	UserID() string
	UserData() map[string]any
}

User represents a user.

func AuthenticatedUserFromContext

func AuthenticatedUserFromContext(ctx context.Context) User

AuthenticatedUserFromContext returns the authenticated user from the context.

type UserAuthenticationFunc

type UserAuthenticationFunc func(r *http.Request) (User, error)

UserAuthenticationFunc is a function that authenticates a user based on the provided request.

func MultipleUserApiKeyAuthenticationFunc

func MultipleUserApiKeyAuthenticationFunc(authData ApiKeyMap, headerName string) UserAuthenticationFunc

MultipleUserApiKeyAuthenticationFunc authenticates the user based on the provided map of API keys to users.

func SingleUserApiKeyAuthenticationFunc

func SingleUserApiKeyAuthenticationFunc(apiKey, headerName string, user User) UserAuthenticationFunc

SingleUserApiKeyAuthenticationFunc authenticates the user based on the provided API key and user.