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

Upgrade to post-quantum ready TLS

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

The single transformation entry point for post-quantum TLS readiness. Moves a repository off the end-of-life jdk15on BouncyCastle artifacts onto a hybrid-capable bctls, raises the protocol floor to TLS 1.3, and offers an ML-KEM hybrid key-exchange group first wherever groups are pinned. Run BuildPqcReadinessInventory first: this recipe cannot reach configuration held outside the repository, and the sites it deliberately skips are visible only in its data tables. It also cannot upgrade the runtime, which is the other half of the job — JEP 527 hybrid key exchange exists on JDK 27 and later only.

Composite 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.

Examples

java
Before
import javax.net.ssl.SSLParameters;
import javax.net.ssl.SSLSocket;

class Gateway {
void configure(SSLSocket socket) {
SSLParameters params = socket.getSSLParameters();
params.setProtocols(new String[]{"TLSv1.1", "TLSv1.2"});
params.setNamedGroups(new String[]{"x25519", "secp256r1"});
socket.setSSLParameters(params);
}
}
After
import javax.net.ssl.SSLParameters;
import javax.net.ssl.SSLSocket;

class Gateway {
void configure(SSLSocket socket) {
SSLParameters params = socket.getSSLParameters();
params.setProtocols(new String[]{"TLSv1.3"});
params.setNamedGroups(new String[]{"X25519MLKEM768", "x25519", "secp256r1"});
socket.setSSLParameters(params);
}
}
java
Before
import javax.net.ssl.SSLParameters;
import javax.net.ssl.SSLSocket;

class Gateway {
void configure(SSLSocket socket) {
SSLParameters params = socket.getSSLParameters();
params.setProtocols(new String[]{"TLSv1.1", "TLSv1.2"});
params.setNamedGroups(new String[]{"x25519", "secp256r1"});
socket.setSSLParameters(params);
}
}
After
import javax.net.ssl.SSLParameters;
import javax.net.ssl.SSLSocket;

class Gateway {
void configure(SSLSocket socket) {
SSLParameters params = socket.getSSLParameters();
params.setProtocols(new String[]{"TLSv1.3"});
params.setNamedGroups(new String[]{"X25519MLKEM768", "x25519", "secp256r1"});
socket.setSSLParameters(params);
}
}

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 UpgradeToPqcReadyTls

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

Maven metadata failures
org.openrewrite.maven.table.MavenMetadataFailures

Attempts to resolve maven metadata that failed.

ColumnDescription
Group idThe groupId of the artifact for which the metadata download failed.
Artifact idThe artifactId of the artifact for which the metadata download failed.
VersionThe version of the artifact for which the metadata download failed.
Maven repositoryThe URL of the Maven repository that the metadata download failed on.
SnapshotsDoes the repository support snapshots.
ReleasesDoes the repository support releases.
FailureThe reason the metadata download failed.
TLS protocol enforcement
io.moderne.cryptography.pqc.table.ProtocolEnforcementTable

Protocol configuration surfaces rewritten to a TLS 1.3 floor, and surfaces flagged as needing manual review because rewriting them would change behaviour in a way a source scan cannot justify. Rows describe declared configuration only: a JVM's java.security file, container -D flags and environment variables are invisible here, so an enforced source does not prove an enforced runtime.

ColumnDescription
Configuration surfaceThe API or configuration key that produced the row, e.g. SSLContext.getInstance, SSLSocket.setEnabledProtocols, SSLServerSocket.setEnabledProtocols, SSLEngine.setEnabledProtocols, SSLParameters.setProtocols, https.protocols, jdk.tls.client.protocols, jdk.tls.server.protocols, jdk.tls.disabledAlgorithms, AbstractTlsPeer.getSupportedVersions, server.ssl.enabled-protocols, server.ssl.protocol. The token vocabulary is shared with the TLS configuration inventory so discovery and enforcement rows can be joined.
ActionRewritten when the recipe changed the source, or Report only when the surface was flagged but deliberately not transformed — a protocol array shared with non-TLS code, or a jdk.tls.disabledAlgorithms assignment that replaces rather than extends the JDK default list.
Protocols beforeComma-joined protocol tokens found before the change, e.g. TLSv1.1,TLSv1.2. BouncyCastle downTo ranges are expanded to their JSSE spelling, e.g. TLSv1.2,TLSv1.1,TLSv1. For a jdk.tls.disabledAlgorithms row this is the raw property value.
Protocols afterComma-joined protocol tokens after the change, e.g. TLSv1.3, or TLSv1.3,TLSv1.2 where an exception retains TLS 1.2. Empty for Report only rows.
Code snippetThe source code of the detected API usage, e.g. Cipher.getInstance("DES").
Library nameThe library providing the configuration surface: JSSE, BouncyCastle or Spring Boot.
Library languageThe language of the source the row was found in: Java, Properties or YAML.
File locationThe path of the source file relative to the repository root.
Start line1-based line of the start of the API usage.
Start column0-based column of the start of the API usage, or -1 when unavailable.
Start offset0-based character offset of the start of the API usage, or -1 when unavailable.
End line1-based line of the end of the API usage.
End column0-based column of the end of the API usage, or -1 when unavailable.
End offset0-based character offset of the end of the API usage, 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.
Hybrid TLS key exchange enforcement
io.moderne.cryptography.pqc.table.HybridKexEnforcementTable

Named-group configuration rewritten to offer an ML-KEM hybrid group first, and sites flagged as needing manual review because the value is not statically resolvable or the transformation would need a BouncyCastle upgrade to compile. -D flags outside the scanned repository are invisible, so an unchanged repository is not evidence of a hybrid-ready runtime.

ColumnDescription
Configuration surfaceThe API or configuration key that produced the row: SSLParameters.setNamedGroups, BCSSLParameters.setNamedGroups, System.setProperty(jdk.tls.namedGroups), properties file entry, TlsClient.getSupportedGroups, SSLEngine.setSSLParameters or SSLSocket.setSSLParameters. The token vocabulary is shared with the TLS named groups inventory so discovery and enforcement rows can be joined.
Named groupsThe groups found at the site before the change, comma-joined in the order they were offered, e.g. x25519,secp256r1. Empty when the value is not statically resolvable or no groups are configured.
Classificationtransformed when the hybrid group was prepended. report-only: non-literal argument when the named groups arrive as a runtime value. report-only: no named groups configured when SSL parameters are applied without any named-groups call — remediation there is a JDK 27 / BouncyCastle 1.81 upgrade, not an edit, because the provider default already offers a hybrid first. report-only: low-level BC client without hybrid groups for a getSupportedGroups override, where generated code naming NamedGroup.X25519MLKEM768 would only compile against bctls 1.81 or later.
Hybrid group addedThe hybrid group prepended at this site, e.g. X25519MLKEM768. Empty on report-only rows.
Code snippetThe source code of the detected API usage, e.g. Cipher.getInstance("DES").
Library nameThe TLS stack the surface belongs to: JSSE or BouncyCastle. jdk.tls.namedGroups rows are recorded as JSSE even though BCJSSE honours the same property, because the property is a JDK-level surface.
Library languageThe language of the source the row was found in: Java or Properties.
File locationThe path of the source file relative to the repository root.
Start line1-based line of the start of the API usage.
Start column0-based column of the start of the API usage, or -1 when unavailable.
Start offset0-based character offset of the start of the API usage, or -1 when unavailable.
End line1-based line of the end of the API usage.
End column0-based column of the end of the API usage, or -1 when unavailable.
End offset0-based character offset of the end of the API usage, 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.