Repository navigation
0.5.0 was tagged by mistake and then removed, so 0.5.1 is the first 0.5 release. There is no 0.5.0 to use.
Optional JWT/OIDC and an outbound HTTP client, credential redaction in logs,
and continuous fuzzing. Apps must rebuild: Config gained auth and Request
gained bearer material. crocket::auth links crocket::client.
CROCKET_AUTH=ON fails configure when the client is off, and with both left
on AUTO, turning the client off turns auth off. Log redaction now treats -
and _ as the same character, so a field such as X-Api-Key matches api_key.
Added
- Style guide for new and touched code: docs/style.md. It records the conventions already in the tree. clang-format stays off
(#52). - Continuous fuzzing.
.github/workflows/fuzz.yml
runs./dev fuzzwith AddressSanitizer once a day and on demand, apart from
pull-request CI (which still runs each corpus and two seconds of mutations).
Each target is capped at 90 seconds and the job at 30 minutes. A crash or hang
fails the job and uploads the input, seed, and log. Nothing is committed back
intotests/fuzz/corpus; copy a crash there by hand so it stays a regression
(#49). crocket::client: opt-in outbound HTTP on h2o's client, same event loop.
http::Clientcarries a base URL, timeout, per-host pool, retries, and a
circuit breaker. Retries and the breaker are on unless a call opts out
({.retry = retry::none},{.breaker = breaker::none}). Only idempotent
methods are retried, plus any call that setsIdempotency-Key, and a retry
budget caps retries at 20% of recent calls (at least 3). Failures are
upstream.timeout(504),upstream.unavailable(503), and
upstream.circuit_open(503). An inboundx-request-idis forwarded;
traceparentis not.examples/client.cppiscrocket_client_example.
Two services are two clients:.with_state<Tag>()and
State<http::Client::For<Tag>>(examples/client_multi.cpp,
crocket_client_multi_example)../dev bench clienttimes one localhost GET
(#46).crocket::auth: opt-in JWT and OIDC (auth::Jwt,Auth<T>,auth::require/
auth::any_of). Defaults are RS256, ES256 and EdDSA. HS256 (and HS384/HS512)
verify only with an explicit.secret/CROCKET_AUTH_SECRET, and are not in
the default algorithm list. JWKS refresh does not block a request;/readyz
stays not ready until the first key set loads.examples/auth.cppis
crocket_auth_examplewhen auth is on, and./dev bench authtimes
me(Auth<>). See the README
(#45)
Changed
- Docs. CI is
./dev checkin the GCC 16.2 toolchain image, not a compiler
build in a plain Ubuntu container. The CMake options for the client, auth, and
Postgres sayAUTO/ON/OFF, including auth failing closed when the
client is off. Logging states the request-line credential scrub next to
field-name redaction.db::Poolthrows if it cannot open its connections at
startup. Versions note that 1.0 is not released and that 0.x minors have no
compatibility shim. The roadmap section points at the 1.0 roadmap issue.
(#50). - Log redaction treats
-and_as the same character, so a field named
X-Api-Keymatchesapi_key.http::for_logprints headers, a call, a
response, orClientOptionswithout userinfo, query, fragment, CA paths, or
header values whose names look like credentials. Bodies are a byte count.
Logging a raw string under an unrelated field name is still printed as
itself. The bytes on the wire are unchanged
(#48). crocket::authJWKS fetch usescrocket::clientinstead of its own HTTPS
client. A fetch times out at 5 seconds, keeps at most 1 MiB, checks the TLS
hostname, and does not retry; the refresh loop tries again.crocket::auth
linkscrocket::client.CROCKET_AUTH=ONwith the client off fails configure.
With both onAUTO, turning the client off turns auth off
(#47).
Fixed
- Adaptive placement in
tls_h2. The socket test required 1,000 handler
runs in a row under 100 µs of wall time. One preemption on a busy runner
resets that streak, so the route stayed on workers and the demotion checks
failed with it. The same thresholds are now applied to durations the test
supplies (tests/placement.cpp). The socket test still checks that a plain
route starts on workers and that aPoolroute stays there
(#51).
Security
- Vulnerability reports: SECURITY.md is the security policy.
It says how to report a vulnerability in private, what is in scope for the
framework, and how long a report should expect to wait
(#43) - Signed hello images and SBOMs: the release workflow signs
ghcr.io/sean3z/crocket-hellowith Sigstore (keyless) on every channel, and
publishes a CycloneDX and an SPDX software bill of materials for that image.
A tagged release attaches both files. SECURITY.md has the
verify commands
(#43)