Skip to main content
Moderne OnlyThis recipe is proprietary to Moderne and runs on the Moderne platform or CLI — it isn’t part of the open-source catalog. Available with a Moderne subscription.Contact Sales

Post-quantum TLS readiness report

Recipe IDio.moderne.cryptography.pqc.PqcReadinessReport
Artifactio.moderne.recipe:rewrite-cryptography

Classifies every Maven and Gradle module by how far it is from post-quantum TLS, joining the module's JDK level with the BouncyCastle artifacts it resolves, and records one row per module per BouncyCastle artifact in a data table. Modules with no BouncyCastle at all get exactly one row, so absence is reported rather than inferred from silence. Direct org.bouncycastle declarations in modules that have a gap are marked. bcutil and everything reachable only through it is pruned from the graph walk: it is an internal support artifact that declares BouncyCastle with version ranges, which would otherwise make the reported versions drift with every patch release. Only BouncyCastle that appears in a resolved dependency graph is seen: jars vendored into the repository and wired up with Gradle fileTree/flatDir or Maven system scope, and BouncyCastle shaded into a fat jar, carry no coordinates and therefore report as no-bc. Modules whose build tool did not run are reported as build-file-not-resolved rather than being dropped, so that gap is visible instead of silent.

Single recipeOpenRewriteModerne Proprietary License
Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

3 parameters
3 optional
ParameterExampleTypeRequired
minimumBctlsVersion1.84StringOptional
The lowest bctls version considered hybrid-capable, compared as the Semver range [version,). Defaults to 1.81, the first release carrying NamedGroup.X25519MLKEM768; 1.80 has only the pure ML-KEM draft codepoints. Raise to 1.84 if the interop stance requires the javax.crypto.KEM based implementation.
minimumJdkForNativeHybrid27IntegerOptional
The lowest JDK level whose JSSE offers hybrid ML-KEM key exchange, per JEP 527. Defaults to 27.
minimumJdkForPqcAlgorithms24IntegerOptional
The lowest JDK level shipping the ML-KEM and ML-DSA providers, per JEP 496 and JEP 497. TLS is an explicit non-goal of those JEPs, so this level alone does not make TLS post-quantum. Defaults to 24.

Examples

groovy
ParameterValue
minimumBctlsVersionnull
minimumJdkForNativeHybridnull
minimumJdkForPqcAlgorithmsnull
Unchanged
class Main {
}
Before
plugins {
id 'java'
}

repositories {
mavenCentral()
}

dependencies {
implementation 'org.bouncycastle:bctls-jdk18on:1.80'
}
After
plugins {
id 'java'
}

repositories {
mavenCentral()
}

dependencies {
/*~~(bctls-too-old)~~>*/implementation 'org.bouncycastle:bctls-jdk18on:1.80'
}
xml
ParameterValue
minimumBctlsVersionnull
minimumJdkForNativeHybridnull
minimumJdkForPqcAlgorithmsnull
Unchanged
class Main {
}
Before
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>app</artifactId>
<version>1.0.0</version>
<dependencies>
<dependency>
<groupId>org.bouncycastle</groupId>
<artifactId>bctls-jdk18on</artifactId>
<version>1.78.1</version>
</dependency>
</dependencies>
</project>
After
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>app</artifactId>
<version>1.0.0</version>
<dependencies>
<!--~~(bctls-too-old)~~>--><dependency>
<groupId>org.bouncycastle</groupId>
<artifactId>bctls-jdk18on</artifactId>
<version>1.78.1</version>
</dependency>
</dependencies>
</project>

Usage

Run this recipe

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe PqcReadinessReport

If the recipe is not available locally, then you can install it using:

RELEASE resolves to the newest release and LATEST to the newest build of any kind, including snapshots. Either one lets mod config recipes upgrade pull in later versions without editing this command; a pinned version stays where you put it.

mod config recipes jar install io.moderne.recipe:rewrite-cryptography:RELEASE

Data tables

PQC readiness
io.moderne.cryptography.pqc.table.PqcReadinessTable

Per-module post-quantum TLS readiness derived from the resolved Maven and Gradle dependency models and the JavaVersion markers of the module's Java sources. Modules built by tools OpenRewrite does not parse (Bazel, Ant) and BouncyCastle shaded into fat jars are invisible here, so an absent row is not evidence of health.

ColumnDescription
ModuleModule identity: the Maven groupId:artifactId of the pom, or the Gradle project name from the GradleProject marker.
JDK versionThe module's bytecode/source level, the highest of source and target compatibility across the module's JavaVersion markers, or -1 when there are no Java sources or the level is unparseable (toolchain-only builds).
JDK created byMajor version of the JDK that compiled the sources, or -1 when unknown. A secondary signal: JSSE capability depends on the runtime JDK, of which the target level is only a lower bound.
JDK classificationOne of jdk-native-hybrid-capable (JEP 527 hybrid key exchange in JSSE), jdk-pqc-algos-only (JEP 496/497 ML-KEM and ML-DSA providers, TLS an explicit non-goal), jdk-not-pqc, or jdk-level-unknown.
Library nameThe org.bouncycastle artifactId, e.g. bctls-jdk18on. Empty when the module has no BouncyCastle. bcutil is deliberately absent: it is an internal support artifact declared with version ranges, and its whole subtree is pruned from the graph walk. Maps to AgileSec crypto.library.name.
Library versionThe resolved version, so that property-, BOM-, parent- and version-catalog-declared versions all appear concrete. Empty when the module has no BouncyCastle. Maps to AgileSec crypto.library.version.
Library languageAlways Java: the row inventories a JVM module — its JDK level and the BouncyCastle artifacts it resolves. Maps to AgileSec crypto.library.language.
BouncyCastle artifact lineThe artifact line parsed from the artifactId: jdk18on, jdk15to18, jdk15on, jdk14, lts8on, fips, or empty. Lines carry their own version schemes: jdk15on ends at 1.70, and fips and lts8on are numbered separately from the mainline.
BouncyCastle dependency typedirect when the module declares the artifact itself, transitive when it arrives through another dependency, empty on no-BouncyCastle rows.
BouncyCastle classificationThe module-level TLS bucket, repeated on every row of the module: bctls-hybrid-capable, bctls-too-old, bctls-line-eol, bctls-absent-but-bcprov-present, no-bc, bc-fips-line-needs-separate-assessment, bc-lts-line-needs-separate-assessment, or build-file-not-resolved when the module's build tool never ran so its dependencies were never resolved — a row that must not be read as no-bc. BouncyCastle managed but not consumed (a dependencyManagement pin the module never depends on) is not on the resolved graph and therefore reads as no-bc, as do vendored jars wired up with Gradle fileTree/flatDir or Maven system scope and BouncyCastle shaded into a fat jar, none of which carry coordinates.
Code snippetThe resolved coordinate org.bouncycastle:<artifactId>:<version>. Empty on no-BouncyCastle rows.
File locationThe path of the module's build file relative to the repository root.
Start line1-based line of the start of the dependency declaration, or -1 for transitive, version-catalog-indirected and no-BouncyCastle rows.
Start column0-based column of the start of the dependency declaration, or -1 when unavailable.
Start offset0-based character offset of the start of the dependency declaration, or -1 when unavailable.
End line1-based line of the end of the dependency declaration, or -1 when unavailable.
End column0-based column of the end of the dependency declaration, or -1 when unavailable.
End offset0-based character offset of the end of the dependency declaration, or -1 when unavailable.
Repository nameThe repository name from Git provenance, e.g. payment-service. Empty when unknown.
Scan sourceWhere the source was scanned from, derived from Git provenance, e.g. GitHub, GitLab, Local Repository.
BranchThe branch from Git provenance, e.g. main. Empty when unknown.
Source files that had results
org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

ColumnDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.
Source files that had search results
org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

ColumnDescription
Source path of search result before the runThe source path of the file with the search result markers present.
Source path of search result after run the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
ResultThe trimmed printed tree of the LST element that the marker is attached to.
DescriptionThe content of the description of the marker.
Recipe that added the search markerThe specific recipe that added the Search marker.
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

ColumnDescription
Source pathThe file that failed to parse.
Recipe that made changesThe specific recipe that made a change.
Stack traceThe stack trace of the failure.
Recipe performance
org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

ColumnDescription
The recipeThe recipe whose stats are being measured both individually and cumulatively.
Source file countThe number of source files the recipe ran over.
Source file changed countThe number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)The total time spent across the scanning phase of this recipe.
Max scanning time (ns)The max time scanning any one source file.
Cumulative edit time (ns)The total time spent across the editing phase of this recipe.
Max edit time (ns)The max time editing any one source file.