Offer a hybrid ML-KEM key exchange group first
io.moderne.cryptography.pqc.AddHybridTlsNamedGroupio.moderne.recipe:rewrite-cryptographyOptions
Examples
java
| Parameter | Value |
|---|---|
| hybridGroup | null |
| mode | null |
| skipTestSources | null |
- java
- Diff
import javax.net.ssl.SSLParameters;
import javax.net.ssl.SSLSocket;
class TlsClient {
void configure(SSLSocket socket) {
SSLParameters params = socket.getSSLParameters();
params.setNamedGroups(new String[]{"x25519", "secp256r1"});
socket.setSSLParameters(params);
}
}
import javax.net.ssl.SSLParameters;
import javax.net.ssl.SSLSocket;
class TlsClient {
void configure(SSLSocket socket) {
SSLParameters params = socket.getSSLParameters();
params.setNamedGroups(new String[]{"X25519MLKEM768", "x25519", "secp256r1"});
socket.setSSLParameters(params);
}
}
@@ -7,1 +7,1 @@
void configure(SSLSocket socket) {
SSLParameters params = socket.getSSLParameters();
- params.setNamedGroups(new String[]{"x25519", "secp256r1"});
+ 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.
mod run . --recipe AddHybridTlsNamedGroup
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.
- RELEASE
- LATEST
- Pinned version
mod config recipes jar install io.moderne.recipe:rewrite-cryptography:RELEASE
mod config recipes jar install io.moderne.recipe:rewrite-cryptography:LATEST
mod config recipes jar install io.moderne.recipe:rewrite-cryptography:0.14.12
Data tables
Hybrid TLS key exchange enforcement
io.moderne.cryptography.pqc.table.HybridKexEnforcementTableNamed-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.
| Column | Description |
|---|---|
| Configuration surface | The 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 groups | The 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. |
| Classification | transformed 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 added | The hybrid group prepended at this site, e.g. X25519MLKEM768. Empty on report-only rows. |
| Code snippet | The source code of the detected API usage, e.g. Cipher.getInstance("DES"). |
| Library name | The 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 language | The language of the source the row was found in: Java or Properties. |
| File location | The path of the source file relative to the repository root. |
| Start line | 1-based line of the start of the API usage. |
| Start column | 0-based column of the start of the API usage, or -1 when unavailable. |
| Start offset | 0-based character offset of the start of the API usage, or -1 when unavailable. |
| End line | 1-based line of the end of the API usage. |
| End column | 0-based column of the end of the API usage, or -1 when unavailable. |
| End offset | 0-based character offset of the end of the API usage, or -1 when unavailable. |
| Repository name | The repository name from Git provenance, e.g. payment-service. Empty when unknown. |
| Scan source | Where the source was scanned from, derived from Git provenance, e.g. GitHub, GitLab, Local Repository. |
| Branch | The branch from Git provenance, e.g. main. Empty when unknown. |
Source files that had results
org.openrewrite.table.SourcesFileResultsSource files that were modified by the recipe run.
| Column | Description |
|---|---|
| Source path before the run | The source path of the file before the run. null when a source file was created during the run. |
| Source path after the run | A 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 changes | In 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 changes | The specific recipe that made a change. |
| Estimated time saving | An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds. |
| Cycle | The recipe cycle in which the change was made. |
Source files that had search results
org.openrewrite.table.SearchResultsSearch results that were found during the recipe run.
| Column | Description |
|---|---|
| Source path of search result before the run | The source path of the file with the search result markers present. |
| Source path of search result after run the run | A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run. |
| Result | The trimmed printed tree of the LST element that the marker is attached to. |
| Description | The content of the description of the marker. |
| Recipe that added the search marker | The specific recipe that added the Search marker. |
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrorsThe details of all errors produced by a recipe run.
| Column | Description |
|---|---|
| Source path | The file that failed to parse. |
| Recipe that made changes | The specific recipe that made a change. |
| Stack trace | The stack trace of the failure. |
Recipe performance
org.openrewrite.table.RecipeRunStatsStatistics used in analyzing the performance of recipes.
| Column | Description |
|---|---|
| The recipe | The recipe whose stats are being measured both individually and cumulatively. |
| Source file count | The number of source files the recipe ran over. |
| Source file changed count | The 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. |