README

Composable PHP HTTP middleware helpers.

Part of the Oihana PHP ecosystem, this package ships procedural helpers for HTTP security headers, CORS, CSRF, request-id propagation, maintenance mode, fixed-window rate limiting, observability, content negotiation, distributed tracing (W3C Trace Context), RFC 9457 Problem Details, webhook signature verification, request-defense guards, HTTP caching & conditional requests, and pagination headers — PSR-7 compatible, zero magic strings.

📚 Documentation

Full API reference (generated with phpDocumentor): https://bcommebois.github.io/oihana-php-middleware

User guides (FR + EN) live under wiki/.

📦 Installation

Requires PHP 8.4+. Install via Composer:

composer require oihana/php-middleware

✨ What you can do

Security headers

withSecurityHeaders() — single helper to apply HSTS, Content-Security-Policy, X-Frame-Options, Referrer-Policy, X-Content-Type-Options, the three Cross-Origin policies (COOP / COEP / CORP) and Permissions-Policy to a PSR-7 Response in one call. Typed values via ReferrerPolicy, FrameOptions, CrossOriginOpenerPolicy, CrossOriginEmbedderPolicy, CrossOriginResourcePolicy and PermissionsPolicyFeature enums — no magic strings.
buildCspHeader() — compose a Content-Security-Policy value from an associative array of directives. CspDirective enum exposes the canonical directive names.
buildPermissionsPolicyHeader() — compose a Permissions-Policy value with a smart allowlist API (false, true / '*', 'self', single origin or array — self stays a token, origins auto-quoted).
withDefaultSecurityBaseline() — opinionated alias of withSecurityHeaders() shipping a "safe-for-most-apps" baseline (HSTS 1 year, X-Frame-Options: DENY, nosniff, Referrer-Policy: strict-origin-when-cross-origin, COOP / CORP same-origin) with caller-supplied overrides merged on top.

CORS

applyCorsHeaders() — origin allowlist with configurable methods, headers, exposed headers, credentials and max-age. Handles the preflight OPTIONS request automatically. Defensive defaults: no * when credentials = true, Vary: Origin added when the allowlist is dynamic.
isCorsRequest() / isCorsPreflight() — pure predicates so middlewares can short-circuit on same-origin requests or detect a preflight without spelling out the underlying header names.

CSRF

generateCsrfToken() / verifyCsrfToken() — stateless signed double-submit pattern. Wire format <id>.<exp>.<sig> with a 128-bit base64url random <id>, an absolute expiry timestamp and a base64url HMAC-SHA256 signature keyed by your secret. Optional TTL. Constant-time verification — never throws on bad input, returns bool. CsrfField enum ships the conventional cookie and header names.

Request ID

requestIdFromRequest() — reads X-Request-Id from the incoming request and returns it when it passes a conservative shape check (1 to 128 chars, URL-safe alphabet), otherwise generates a fresh 128-bit base64url identifier. Defense-in-depth against log-pollution attacks via a forged incoming header.
withRequestIdHeader() — stamps the request ID on the response (PSR-7 immutable).
RequestIdField enum — HEADER_NAME (X-Request-Id) and ATTRIBUTE_NAME (requestId) for wiring the propagation through the middleware chain.

Maintenance mode

respondMaintenanceMode() — turns a PSR-7 response into a clean 503 Service Unavailable with optional Retry-After header (accepts int delta-seconds, DateTimeInterface formatted as IMF-fixdate, or raw string) and optional body. MaintenanceOption enum carries the option keys.

Rate limiting

enforceRateLimit() — fixed-window rate-limit enforcement on PSR-7 requests. Identity resolved verbatim from KEY (string), via callable fn(Request): string, or by fallback to the client IP. Returns an immutable RateLimitDecision (allowed, limit, remaining, reset, retryAfter).
withRateLimitHeaders() — stamps Limit / Remaining / Reset on the response from a decision, plus Retry-After when blocked. Defaults to the legacy X-RateLimit-* family, opt-in to the RFC 9421 draft RateLimit-* family.
RateLimitStore interface — single atomic method increment(string $key, int $window): int. Shipped InMemoryRateLimitStore (process-local, for tests and CLI tools) ; production-grade MemcachedRateLimitStore in oihana/php-memcached.

Observability

withResponseTime() — stamps the elapsed processing time on the response. Two output formats: de-facto X-Response-Time: 42.50ms (default) or W3C Server-Timing: total;dur=42.50 (opt-in via ResponseTimeOption::USE_SERVER_TIMING).

Content negotiation

negotiateMimeType() — thin PSR-7 wrapper over oihana\http\helpers\negotiation\negotiate() to select the best server-side MIME type from the client Accept header. Honours RFC 7231 quality values, standard wildcards (universal and type/*) and q=0 explicit refusals.
negotiateCharset() / negotiateEncoding() / negotiateLanguage() — sibling wrappers selecting the best charset, content-encoding or language from the matching Accept-Charset / Accept-Encoding / Accept-Language request header, with the same quality-value semantics.

Distributed tracing

traceContextFromRequest() / withTracingAttribute() / withTraceparentResponseHeader() / parseTraceparent() — W3C Trace Context propagation. Extract or generate a traceparent, expose the TraceContext value object as a request attribute, and echo the canonical traceparent back on the response so a single user request can be reconstructed end-to-end across services from your log aggregator. TracingField enum carries the wiring names.

Problem Details

respondProblemDetails() — RFC 9457 standardised error responses (application/problem+json) built from a Problem value object: typed standard fields (type, title, status, detail, instance) plus arbitrary extension members. ProblemField enum carries the field names.

Webhook signature verification

verifyWebhookSignature() — verifies the simple-HMAC signature pattern shared by GitHub, Slack, Shopify, Twilio and SendGrid. Constant-time comparison, configurable algorithm / header prefix / encoding via the WebhookSignatureOption enum.

Request defense

enforceMaxBodySize() / enforceTrustedHosts() — pre-parsing guards that reject obviously-bad requests before the application has to handle them: oversized request bodies (declared Content-Length or streamed) and Host-header attacks (allowlist with wildcard-subdomain support, port stripping, fail-open on an empty allowlist).

HTTP caching & conditional requests

buildCacheControl() — compose a Cache-Control value from typed CacheDirective names (RFC 9111 / 5861 / 8246), catching the max_age vs max-age typo class that silently disables caching.
isNotModified() / respondNotModified() — evaluate RFC 9110 conditional requests (ETag / If-None-Match weak comparison, If-Modified-Since) and emit a canonical 304 Not Modified response.

Pagination

withPaginationHeaders() — stamps the RFC 5988 / RFC 8288 Link header (rel="first|prev|next|last") and the de-facto X-Total-Count header from a PaginationLinks value object, keeping the response body pure data (GitHub-style API pagination).

Under the hood

Pure PSR-7 — no framework lock-in. Works with Slim, Laravel, Symfony HTTP Foundation (via PSR-7 bridge), Hyperf, RoadRunner, etc.
Built on oihana/php-http primitives (IP detection, content negotiation, etc.) and oihana/php-enums typed HTTP constants (HttpHeader, HttpMethod, HttpStatusCode, AuthScheme, …).

✅ Running tests

Run all tests:

composer test

Measure coverage (requires Xdebug or PCOV):

composer coverage      # text + Clover + HTML under build/coverage/
composer coverage:md   # readable Markdown summary (build/coverage/COVERAGE.md)

See CONTRIBUTING.md for the full testing & coverage workflow.

🛠️ Generate the documentation

composer doc

🧾 License

Licensed under the Mozilla Public License 2.0 (MPL‑2.0).

👤 About the author

Author: Marc ALCARAZ (aka eKameleon)
Email: marc@ooop.fr
Website: https://www.ooop.fr

🔗 Related packages

Package	Description
`oihana/php-http`	Composable PHP HTTP primitives (client IP detection, signed URLs, cookies, content negotiation, …) consumed by this library.
`oihana/php-enums`	Typed HTTP constants (`HttpHeader`, `HttpMethod`, `HttpStatusCode`, `AuthScheme`, …).
`oihana/php-memcached`	Production-grade `MemcachedRateLimitStore` implementing this package's `RateLimitStore` interface.

oihana / php-middleware

Maintainers

Package info

Statistics

Security