security

package
v0.1.6 Latest Latest
Warning

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

 Go to latest Published: Oct 9, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Overview

Package security defines transport-independent, typed authentication and authorization contracts. Applications own credentials, identities, principals, resources and the meaning of their fields. Implementations shared through DI must be safe for concurrent use.

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrMissingCredentials = errors.New("security: credentials are missing")
	ErrInvalidCredentials = errors.New("security: credentials are invalid")
	ErrUnauthenticated    = errors.New("security: principal is unavailable")
	ErrForbidden          = errors.New("security: access is forbidden")
)

Functions

func Current 

func Current[P any](ctx context.Context) (P, error)

Current retrieves P or returns ErrUnauthenticated. A different type, nil context, or a masked/absent principal never causes a type assertion panic. A zero-valued P deliberately published by WithPrincipal is still present.

func WithPrincipal 

func WithPrincipal[P any](ctx context.Context, principal P) context.Context

WithPrincipal propagates a trusted principal. Only authentication boundaries or trusted application code should call it. P must be the same instantiated type used by Current. Principals (including slices/maps/pointers) must be treated as immutable after publication; no copy or validation is performed.

func WithoutPrincipal 

func WithoutPrincipal[P any](ctx context.Context) context.Context

WithoutPrincipal masks an upstream principal of P while preserving other context values and cancellation. Anonymous authentication uses this to avoid accidentally retaining an upstream identity of the same type.

Types

type Authenticator 

type Authenticator[C, I any] interface {
	Authenticate(context.Context, C) (I, error)
}

Authenticator verifies credentials before producing an identity. Credential rejection should wrap ErrInvalidCredentials; infrastructure errors must remain distinguishable. I carries only data from the verified identity source.

type Authorizer 

type Authorizer[P, R any] interface {
	Check(context.Context, P, string, R) error
}

Authorizer evaluates an action on a typed resource for an explicit principal. Policies should deny unsupported actions with ErrForbidden. Operational errors must not be converted into access denials.

type PrincipalResolver 

type PrincipalResolver[I, P any] interface {
	Resolve(context.Context, I) (P, error)
}

PrincipalResolver builds an application principal from a verified identity. It may load application data or use the identity directly. A principal is accepted only on a nil error; its shape and validity belong to the application.

Source Files

View all Source files

Directories

Path Synopsis
Package http connects typed security contracts to net/http.
 Package http connects typed security contracts to net/http.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.