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

Find TLS key exchange (named groups) configuration

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

Inventories every place a codebase decides which TLS key-exchange groups it offers, and classifies each by whether an ML-KEM hybrid group — the thing JEP 527 and BouncyCastle 1.81 add — is among them. Covers SSLParameters.setNamedGroups and BCSSLParameters.setNamedGroups, the jdk.tls.namedGroups system property set in code or embedded as a -D flag in checked-in YAML and .properties files, getSupportedGroups overrides on BouncyCastle AbstractTlsClient subclasses, BCJSSE provider registration, and jdk.tls.disabledAlgorithms values that disable a hybrid group. When the repository configures named groups nowhere, each TLS-using file gets one A row: that code is post-quantum ready as soon as it runs on JDK 27 or BouncyCastle 1.81, with no source change. -D flags in shell scripts, Dockerfiles and orchestration manifests outside the repository are invisible, so an absent row is not proof that no group pin exists.

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​

2 parameters
2 optional
ParameterExampleTypeRequired
detectConfigKeyHeuristics—BooleanOptional
Also flag ad-hoc .properties and YAML keys whose name looks like a named-groups setting, e.g. tls.named-groups. Off by default: neither the JDK nor Spring Boot has a first-class named-groups configuration key, so any such key is an application's own invention and matching on the name alone produces false positives. The -Djdk.tls.namedGroups= flag embedded in a JVM-options value is matched either way.
reportDefaultReliance—BooleanOptional
Emit one A row per TLS-using source file when the repository configures named groups nowhere at all, anchored at the first TLS entry-point call in the file. This is the row that says "this code becomes post-quantum ready by upgrading the runtime, with no source change", which for most repositories is the whole answer. Set to false for a call-site-only inventory. Default true.

Examples​

java
ParameterValue
reportDefaultReliancenull
detectConfigKeyHeuristicsnull
Before
import javax.net.ssl.SSLParameters;
import javax.net.ssl.SSLSocket;

class ExplicitGroups {
void m(SSLSocket socket) {
SSLParameters p = socket.getSSLParameters();
p.setNamedGroups(new String[]{"x25519", "secp256r1"});
socket.setSSLParameters(p);
}
}
After
import javax.net.ssl.SSLParameters;
import javax.net.ssl.SSLSocket;

class ExplicitGroups {
void m(SSLSocket socket) {
SSLParameters p = socket.getSSLParameters();
/*~~>*/p.setNamedGroups(new String[]{"x25519", "secp256r1"});
socket.setSSLParameters(p);
}
}

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 FindTlsNamedGroupsConfiguration

To also set the recipe's optional settings, add them to the command. The values below are examples, not recommendations; see Options for what each one does.

With optional settings (example values)
mod run . --recipe FindTlsNamedGroupsConfiguration \
--recipe-option "reportDefaultReliance=true" \
--recipe-option "detectConfigKeyHeuristics=true"

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​

TLS named groups inventory
io.moderne.cryptography.pqc.table.TlsNamedGroupsInventoryTable

TLS key-exchange group configuration detected in Java sources, configuration files and checked-in JVM-options values, classified by whether an ML-KEM hybrid group is offered. -D flags in shell scripts, Dockerfiles and orchestration manifests outside the scanned repository are invisible, so an absent row is not evidence that no group pin exists.

Export after a run
mod study . --last-recipe-run \
--data-table io.moderne.cryptography.pqc.table.TlsNamedGroupsInventoryTable
ColumnDescription
ClassificationA — no explicit named-groups configuration, so the runtime decides: PQC-capable on JDK 27+ (JEP 527) or BouncyCastle 1.81+, not before. B — explicit configuration naming no ML-KEM hybrid group, which pins the connection to classical key exchange regardless of the runtime. C — an ML-KEM hybrid group is already configured. B-indeterminate — a configuration surface is used but its value is not statically resolvable. never-PQC — a low-level BouncyCastle client relying on AbstractTlsClient defaults, which contain no ML-KEM group at any version, so a dependency upgrade alone will never enable PQC here. modifier — a jdk.tls.disabledAlgorithms value that disables a hybrid group, silently turning a C back into a B after an upgrade.
Configuration surfaceThe API or configuration key that produced the row: SSLParameters.setNamedGroups, BCSSLParameters.setNamedGroups, jdk.tls.namedGroups, jdk.tls.namedGroups JVM flag, BCJSSE provider registration, AbstractTlsClient.getSupportedGroups, AbstractTlsClient defaults, jdk.tls.disabledAlgorithms, or none (provider default) for an A row. The token vocabulary is shared with the hybrid key exchange enforcement table so discovery and transformation rows can be joined.
Protocol nameAlways TLS: named-group configuration selects TLS key-exchange groups. Maps to AgileSec crypto.protocol.name.
Protocol kex algorithmsThe TLS named groups — the key-exchange algorithms in AgileSec terms — named at the site, comma-joined in the order they are offered, e.g. x25519,secp256r1. BouncyCastle NamedGroup constants are recorded by their simple name. Empty when nothing is named or the value is not statically resolvable. For a modifier row this lists only the hybrid groups being disabled. Maps to AgileSec crypto.protocol.kex_algorithms.
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, Properties or YAML.
Code snippetThe source code of the detected API usage, e.g. Cipher.getInstance("DES").
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.
Cryptography inventory
io.moderne.cryptography.table.CryptographyInventoryTable

Every cryptographic finding this module detects, joined into one sparse table so that a consumer does not have to match the per-detector tables on source location. A row carries the columns of whichever detectors reported at its location and leaves the others empty; the Finding type column names those detectors. The per-detector tables (Cipher inventory, PQC readiness, TLS configuration inventory, TLS named groups inventory) are still emitted unchanged, and carry the same findings unjoined.

Export after a run
mod study . --last-recipe-run \
--data-table io.moderne.cryptography.table.CryptographyInventoryTable
ColumnDescription
Finding typeWhich detectors reported at this location, comma-joined in a fixed order when a row joins several: cipher-usage (an insecure algorithm API usage), tls-protocol-config (a TLS protocol version or cipher suite configuration site), tls-named-groups (a TLS key-exchange group configuration site) and module-readiness (a Maven or Gradle module's JDK level and BouncyCastle artifacts). A row's empty columns are those its finding types do not own, not evidence of an absent value.
Algorithm nameThe canonical algorithm name, e.g. DES, 3DES, RC2, RC4, Blowfish, MD5, SHA1, HMAC-SHA1. Filled on cipher-usage rows. Maps to AgileSec crypto.algorithm.name.
Algorithm functionWhat the algorithm is used for, e.g. Encryption/Decryption, Hashing, MAC/Signing. Filled on cipher-usage rows.
Algorithm parameterAdditional parameters captured from the API such as mode of operation, padding, key length or digest length. Empty when not expressed at the call site.
Insecuretrue or false on cipher-usage rows, according to whether the algorithm is considered cryptographically weak or broken. Empty on every other finding type, which does not assess algorithm strength — an empty value is not false.
Protocol nameThe protocol family the configuration applies to: TLS, or DTLS for a datagram context. Maps to AgileSec crypto.protocol.name.
Protocol versionsComma-joined protocol version tokens exactly as written at the site, e.g. TLSv1,TLSv1.1,TLSv1.2. Empty when nothing is declared or the value is not statically resolvable. Maps to AgileSec crypto.protocol.version.
Protocol cipher suitesComma-joined cipher suite names exactly as written at the site, e.g. TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256. Filled on cipher-suite configuration sites only. Maps to AgileSec crypto.protocol.ciphers.
Protocol kex algorithmsThe TLS named groups named at the site, comma-joined in the order they are offered, e.g. x25519,secp256r1. Maps to AgileSec crypto.protocol.kex_algorithms.
Library nameThe library the finding belongs to: JCA/JCE, BouncyCastle, OpenSSL, .NET Crypto, JSSE, JDK, Spring Boot, or a resolved org.bouncycastle artifactId on module-readiness rows. Maps to AgileSec crypto.library.name.
Library versionThe resolved library version. Filled on module-readiness rows, where the dependency model makes it concrete; empty on source-level findings, which do not carry one. Maps to AgileSec crypto.library.version.
Library languageThe language of the source the row was found in: Java, C#, C/C++, Properties or YAML. Maps to AgileSec crypto.library.language.
Configuration surfaceThe protocol or cipher-suite API or configuration key that produced the row, e.g. SSLContext.getInstance, SSLSocket.setEnabledProtocols, SSLParameters.setCipherSuites, jdk.tls.client.protocols, server.ssl.enabled-protocols. Filled on tls-protocol-config rows.
Named groups configuration surfaceThe key-exchange API or configuration key that produced the row, e.g. SSLParameters.setNamedGroups, jdk.tls.namedGroups, AbstractTlsClient.getSupportedGroups, or none (provider default) where a TLS endpoint configures no groups at all. Kept apart from Configuration surface so that a joined row records both what it pins and what it leaves to the provider.
TLS configuration classificationHow the protocol or cipher-suite configuration is bucketed: allows-legacy, ceiling-below-tls13, ceiling-tls13, modern-floor-tls12, modern-floor-tls13, ambiguous-default, no-explicit-floor, unresolved-value, dtls, ciphers-allow-tls13 or ciphers-block-tls13. See the TLS configuration inventory table for what each bucket means.
TLS named groups classificationHow the key-exchange group configuration is bucketed: A (no explicit configuration, so the runtime decides), B (explicit groups with no ML-KEM hybrid), C (an ML-KEM hybrid group is configured), B-indeterminate, never-PQC or modifier. See the TLS named groups inventory table for what each bucket means.
PQC readinessWhether hybrid key exchange can negotiate under the protocol configuration at this site: blocked, capable or unknown. Assesses the protocol floor only, so it is filled from tls-protocol-config and stays empty on rows without one; a capable row whose TLS named groups classification is B is still pinned to classical key exchange.
ModuleModule identity: the Maven groupId:artifactId of the pom, or the Gradle project name from the GradleProject marker. Filled on module-readiness rows.
JDK versionThe module's bytecode/source level, or -1 when there are no Java sources, the level is unparseable, or the row is not a module-readiness row.
JDK created byMajor version of the JDK that compiled the sources, or -1 when unknown or not a module-readiness row.
JDK classificationOne of jdk-native-hybrid-capable, jdk-pqc-algos-only, jdk-not-pqc or jdk-level-unknown. See the PQC readiness table for what each bucket means.
BouncyCastle artifact lineThe artifact line parsed from the artifactId: jdk18on, jdk15to18, jdk15on, jdk14, lts8on, fips, or empty.
BouncyCastle dependency typedirect when the module declares the artifact itself, transitive when it arrives through another dependency, empty otherwise.
BouncyCastle classificationThe module-level TLS bucket: 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. See the PQC readiness table for what each bucket means.
Code snippetThe source of the detected usage, e.g. Cipher.getInstance("DES"), or the resolved coordinate on a module-readiness row.
File locationThe path of the source file relative to the repository root.
Start line1-based line of the start of the finding, or -1 when unavailable.
Start column0-based column of the start of the finding, or -1 when unavailable.
Start offset0-based character offset of the start of the finding, or -1 when unavailable.
End line1-based line of the end of the finding, or -1 when unavailable.
End column0-based column of the end of the finding, or -1 when unavailable.
End offset0-based character offset of the end of the finding, or -1 when unavailable.
Repository originThe git remote URL the source was scanned from, e.g. https://github.com/apache/zookeeper.git. Empty when there is no remote. Part of the key rows are joined on: repository names are bare, so this is what tells two same-named repositories in different organizations apart in a cross-repository run.
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.

Export after a run
mod study . --last-recipe-run \
--data-table org.openrewrite.table.SourcesFileResults
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.

Export after a run
mod study . --last-recipe-run \
--data-table org.openrewrite.table.SearchResults
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.

Export after a run
mod study . --last-recipe-run \
--data-table org.openrewrite.table.SourcesFileErrors
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.

Export after a run
mod study . --last-recipe-run \
--data-table org.openrewrite.table.RecipeRunStats
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.