middleware

package
v0.19.0 Latest Latest
Warning

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

Go to latest
Published: Nov 16, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package middleware provides HTTP middleware for extracting an authenticated principal from the request context and attaching it for downstream handlers.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func PrincipalExtractionHandler

func PrincipalExtractionHandler(principalExtractor auth.PrincipalExtractor) func(next http.Handler) http.Handler

PrincipalExtractionHandler returns middleware that extracts principal context, enriches request logs with principal fields (principal, auth_source), and stores the principal in the request context.

The middleware uses the request-scoped zerolog context logger for all log output, so log entries from this middleware automatically carry request_id and other fields injected by upstream middleware (e.g. requestIDMiddleware).

Example

ExamplePrincipalExtractionHandler is the usual API chain: validate the bearer token, turn it into a principal with roles, and let the handler read the principal back from the request context.

Tokens are validated with a shared secret so that the example runs without an identity provider. That is for local development and tests only.

package main

import (
	"fmt"
	"net/http"
	"net/http/httptest"
	"time"

	"github.com/golang-jwt/jwt/v5"
	"github.com/rs/zerolog"

	"github.com/dioad/auth"
	"github.com/dioad/auth/claimrolemapping"
	"github.com/dioad/auth/http/middleware"
	"github.com/dioad/auth/http/server"
	"github.com/dioad/auth/oidc"
)

func main() {
	validate, err := server.OAuth2ValidatorHandler([]oidc.ValidatorConfig{{
		HMACSecret:        "example-secret",
		AllowInsecureHMAC: true,
		Audiences:         []string{"my-api"},
	}})
	if err != nil {
		fmt.Println(err)
		return
	}

	// Roles come from claims. A rule with a Source applies to that source
	// only; "oidc" is the source for a token from a generic OIDC issuer.
	extractor := claimrolemapping.BuildPrincipalExtractor(claimrolemapping.ExtractorConfig{
		ClaimRoleMappings: []claimrolemapping.ClaimRoleMappingConfig{
			{Source: claimrolemapping.SourceOIDC, Claims: map[string]string{"email": "alice@example.com"}, Role: "operator"},
		},
	}, zerolog.Nop())

	handler := validate(middleware.PrincipalExtractionHandler(extractor)(
		http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
			principal := auth.PrincipalContextFromContext(r.Context())
			_, _ = fmt.Fprintf(w, "%s via %s with roles %v", principal.ID, principal.Source, principal.Roles)
		}),
	))

	now := time.Now()
	token, err := jwt.NewWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{
		"sub":   "alice",
		"iss":   "https://idp.example",
		"aud":   "my-api",
		"email": "alice@example.com",
		"iat":   now.Unix(),
		"exp":   now.Add(time.Hour).Unix(),
	}).SignedString([]byte("example-secret"))
	if err != nil {
		fmt.Println(err)
		return
	}

	req := httptest.NewRequest(http.MethodGet, "/", nil)
	req.Header.Set("Authorization", "Bearer "+token)
	rr := httptest.NewRecorder()
	handler.ServeHTTP(rr, req)

	fmt.Println(rr.Code, rr.Body.String())
}
Output:
200 alice via oidc with roles [operator]

Types

This section is empty.

Directories

Path Synopsis
Package jwt provides HTTP middleware for authenticating requests with a bearer JWT and authorizing them against a claim predicate.
Package jwt provides HTTP middleware for authenticating requests with a bearer JWT and authorizing them against a claim predicate.
Package oidc provides HTTP middleware for browser-based, cookie-backed OIDC login sessions: the login/callback/logout flow, session cookie management, and transparent token refresh.
Package oidc provides HTTP middleware for browser-based, cookie-backed OIDC login sessions: the login/callback/logout flow, session cookie management, and transparent token refresh.

Jump to

Keyboard shortcuts

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