Changelog¶
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog,
and this project adheres to the crypto-service suite's 0.0.x
versioning: each release moves by 0.0.1, in lockstep with the suite.
[0.0.41] - Unreleased¶
Highlights¶
- Errors are safe to log, even from a hostile server:
ApiErrormessages and thetoStringofProblemandValidationErrorescape control characters and Unicode line separators in text the server chose, so it cannot forge log lines (CWE-117). - Releases rebuild bit for bit: CI and releases pin exact Temurin
builds,
make repro-checkruns in CI, andmake reproduce VERSION=...checks a published release against itsSHA256SUMSand Maven Central (docs/REPRODUCING.md). - An assurance case and a first security review:
docs/ASSURANCE.mdtraces trust boundaries, design principles and the CWE/OWASP weaknesses to the code and tests that counter them;docs/security-review-2026-11.mdrecords nine findings and their dispositions.
Added¶
docs/ASSURANCE.md, the assurance case, anddocs/security-review-2026-11.md, the first security review.- Regression tests for earlier fixes:
RetryAfterFuzzTestandmake api-check-selftest, plus aClientTestcase pinning that a rawrequestpath cannot change the configured host; the regression-test policy inDEVELOPMENT.md; code review requirements inCONTRIBUTING.mdand the pull request template. - The README demo (
.github/demo.gif), the release signing key's fingerprint and keyservers indocs/packaging.md, and a one-year roadmap with non-goals.
Changed¶
- The code follows the Google Java Style Guide, enforced by
google-java-format (
make style,make format); every file was reformatted once. - CI and releases use exact Temurin builds (21.0.13+9, 17.0.21+9), and
same-class Javadoc links carry explicit labels, so every release
asset rebuilds bit for bit;
make repro-checkruns in CI andmake reproduce VERSION=...checks a published release (docs/REPRODUCING.md). - Every source file states its copyright (
SPDX-FileCopyrightText). - The Maven wrapper fetches Maven 3.10.1, and the workflows use
actions/setup-java6.3.0. - The README links the 0.0.40 artifact on Maven Central and the reproduction guide.
Fixed¶
make api-checkruns again now that a release exists: japicmp no longer trips the trusted-checksum gate on the build being compared.make api-checkfails when it cannot fetch its baseline from Maven Central instead of passing (F-09).
Security¶
ApiErrormessages and thetoStringofProblemandValidationErrorescape control characters and line separators in text the server chose, so a hostile server cannot forge log lines (CWE-117; security review findings F-01 and F-02).
[0.0.40] - 2026-11-16¶
Highlights¶
- Every v2 operation, async and blocking: 59 v2 operations plus
/,/health,/liveand/ready, each asxxxAsyncreturningCompletableFutureand a blockingxxx, over one sharedjava.net.http.HttpClient. - The shared resilience contract: per-attempt timeout, overall
deadline, opt-in retries with full jitter and
Retry-Afterfollowing the TypeScript SDK's retry-safety table, cancellation that aborts the exchange, andApiError/TransportErrorwith RFC 9457 problems. - Proven against crypto-server: the vendored conformance kit (119 vectors) runs against a live server in CI, mostly through the typed methods; 100 % line and branch coverage, two Jazzer targets and JMH scenarios.
Added¶
CryptoServiceClientwith its builder (baseUrl,apiKey,token,timeout,deadline,retry,traceparent,autoTraceparent,responseListener,httpClient) and the rawrequest.- Request and result records for every operation, with
...Bytes()accessors for hex and base64 members,Byteshelpers and enums for the closed request vocabularies. Problem,ValidationError,ApiError,TransportErrorand their baseCryptoServiceException.- The conformance kit from crypto-service at
3e8ecfd757e3577011953d8b47677f4c003426fb(ci/server.ref), its runner, examples, README snippet checks, fuzz targets, benchmarks, CI, release workflow and documentation.
Not included¶
- Typed methods for the deprecated v1 routes (sunset 2027-01-01) and
/metrics;requestreaches them.