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 protocol configuration

Recipe IDio.moderne.cryptography.pqc.FindTlsProtocolConfiguration

Artifactio.moderne.recipe:rewrite-cryptography

Inventories every place a Java source decides which TLS protocol versions and cipher suites may be negotiated, and classifies each by whether TLS 1.3 — the only version JEP 527 hybrid key exchange exists for — remains reachable. Covers SSLContext.getInstance (whose algorithm name is a ceiling, never a floor), the setProtocols/setEnabledProtocols and setCipherSuites/setEnabledCipherSuites sinks, the setSSLParameters sink that applies a parameter bundle assembled elsewhere, the jdk.tls.client.protocols, jdk.tls.server.protocols, https.protocols, jdk.tls.client.cipherSuites and jdk.tls.server.cipherSuites system properties, BouncyCastle getSupportedVersions and getSupportedCipherSuites overrides, and default-acquisition sites that configure no floor at all. A pinned cipher list with no RFC 8446 suite blocks TLS 1.3 even when the protocol floor allows it. Findings land in the TLS configuration inventory data table. Scope is JSSE and BouncyCastle: Netty, OkHttp, Apache HttpClient and servlet-container configuration are not scanned, and -D flags in build files and launch scripts are invisible, so an absent row is not evidence of a modern floor.

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

Parameter	Example	Type	Required
detectAbsence	—	Boolean	Optional
Emit no-explicit-floor rows for default-acquisition call sites — SSLContext.getDefault(), SSLSocketFactory.getDefault(), HttpClient.newHttpClient(), an HttpClient builder chain without sslContext/sslParameters, and an HttpsURLConnection acquired in a file that pins no socket factory. Set to false to restrict the inventory to explicit protocol configuration. Default true.
reportCompliant	—	Boolean	Optional
Include modern-floor-tls12 and modern-floor-tls13 rows so the inventory is a complete census rather than a defect list. Set to false to report only PQC-blocking, legacy or ambiguous configurations. Default true.

Examples

java

Parameter	Value
detectAbsence	null
reportCompliant	null

Unchanged

import javax.net.ssl.SSLContext;

class FactoryUser {
    void use(SSLContext ctx) {
        new CustomFactory(ctx, new String[]{"TLSv1.2"},
            new String[]{"TLS_RSA_WITH_AES_128_CBC_SHA", "TLS_RSA_WITH_AES_256_CBC_SHA"});
    }
}

java

Before

import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLEngine;

class CustomFactory {
    private final SSLContext sslcontext;
    private final String[] enabledProtocols;
    private final String[] enabledCiphersuites;

    CustomFactory(SSLContext sslcontext, String[] enabledProtocols, String[] enabledCiphersuites) {
        this.sslcontext = sslcontext;
        this.enabledProtocols = enabledProtocols;
        this.enabledCiphersuites = enabledCiphersuites;
    }

    void wrapChannel() {
        SSLEngine e = sslcontext.createSSLEngine();
        e.setEnabledProtocols(enabledProtocols);
        e.setEnabledCipherSuites(enabledCiphersuites);
    }
}

After

import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLEngine;

class CustomFactory {
    private final SSLContext sslcontext;
    private final String[] enabledProtocols;
    private final String[] enabledCiphersuites;

    CustomFactory(SSLContext sslcontext, String[] enabledProtocols, String[] enabledCiphersuites) {
        this.sslcontext = sslcontext;
        this.enabledProtocols = enabledProtocols;
        this.enabledCiphersuites = enabledCiphersuites;
    }

    void wrapChannel() {
        SSLEngine e = sslcontext.createSSLEngine();
        /*~~>*/e.setEnabledProtocols(enabledProtocols);
        /*~~>*/e.setEnabledCipherSuites(enabledCiphersuites);
    }
}

Diff

@@ -17,2 +17,2 @@
    void wrapChannel() {
        SSLEngine e = sslcontext.createSSLEngine();
-       e.setEnabledProtocols(enabledProtocols);
-       e.setEnabledCipherSuites(enabledCiphersuites);
+       /*~~>*/e.setEnabledProtocols(enabledProtocols);
+       /*~~>*/e.setEnabledCipherSuites(enabledCiphersuites);
    }

java

Parameter	Value
detectAbsence	null
reportCompliant	null

java

Before

import javax.net.ssl.SSLContext;

class LegacyPinnedContext {
    void direct() throws Exception {
        SSLContext ctx = SSLContext.getInstance("TLSv1.2");
        ctx.init(null, null, null);
    }

    void indirect(String protocol) throws Exception {
        SSLContext ctx = SSLContext.getInstance(protocol);
    }
}

After

import javax.net.ssl.SSLContext;

class LegacyPinnedContext {
    void direct() throws Exception {
        SSLContext ctx = /*~~>*/SSLContext.getInstance("TLSv1.2");
        ctx.init(null, null, null);
    }

    void indirect(String protocol) throws Exception {
        SSLContext ctx = /*~~>*/SSLContext.getInstance(protocol);
    }
}

Diff

@@ -5,1 +5,1 @@
class LegacyPinnedContext {
    void direct() throws Exception {
-       SSLContext ctx = SSLContext.getInstance("TLSv1.2");
+       SSLContext ctx = /*~~>*/SSLContext.getInstance("TLSv1.2");
        ctx.init(null, null, null);
@@ -10,1 +10,1 @@

    void indirect(String protocol) throws Exception {
-       SSLContext ctx = SSLContext.getInstance(protocol);
+       SSLContext ctx = /*~~>*/SSLContext.getInstance(protocol);
    }

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 FindTlsProtocolConfiguration

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 FindTlsProtocolConfiguration \
  --recipe-option "detectAbsence=true" \
  --recipe-option "reportCompliant=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.

RELEASE

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

LATEST

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

Pinned version

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

Data tables

TLS configuration inventory

io.moderne.cryptography.pqc.table.TlsConfigurationInventoryTable

TLS protocol version and cipher suite configuration detected in Java sources and in Spring Boot .properties/.yaml files, classified by whether TLS 1.3 — and therefore JEP 527 / BouncyCastle 1.81 hybrid key exchange — remains reachable. Non-JSSE TLS stacks (Netty, OkHttp, Tomcat and Jetty server configuration, -D flags in build files and launch scripts) are out of scope, so an absent row is not evidence that a module has no legacy TLS floor.

Export after a run

mod study . --last-recipe-run \
  --data-table io.moderne.cryptography.pqc.table.TlsConfigurationInventoryTable

Column	Description
Configuration surface	The API or configuration key that produced the row, e.g. SSLContext.getInstance, SSLContext.getDefault, SSLSocket.setEnabledProtocols, SSLServerSocket.setEnabledProtocols, SSLEngine.setEnabledProtocols, SSLParameters.setProtocols, SSLSocketFactory.getDefault, HttpsURLConnection, HttpClient.newHttpClient, HttpClient.Builder.build, jdk.tls.client.protocols, jdk.tls.server.protocols, https.protocols, AbstractTlsPeer.getSupportedVersions, server.ssl.enabled-protocols, server.ssl.protocol, or a cipher-suite surface: SSLSocket.setEnabledCipherSuites, SSLServerSocket.setEnabledCipherSuites, SSLEngine.setEnabledCipherSuites, SSLParameters.setCipherSuites, jdk.tls.client.cipherSuites, jdk.tls.server.cipherSuites, server.ssl.ciphers, AbstractTlsClient.getSupportedCipherSuites. The token vocabulary is shared with the enforcement table so discovery and transformation rows can be joined.
Protocol name	The protocol family the configuration applies to: TLS, or DTLS for a datagram context. Maps to AgileSec crypto.protocol.name.
Protocol versions	Comma-joined protocol version tokens exactly as written at the site, e.g. TLSv1,TLSv1.1,TLSv1.2. BouncyCastle ProtocolVersion names are translated to their JSSE spelling and downTo ranges are expanded. Empty when nothing is declared (a default-acquisition site) or the value is not statically resolvable. Maps to AgileSec crypto.protocol.version.
Protocol cipher suites	Comma-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 rows (setEnabledCipherSuites, SSLParameters.setCipherSuites, jdk.tls.client.cipherSuites, jdk.tls.server.cipherSuites, server.ssl.ciphers, AbstractTlsClient.getSupportedCipherSuites); empty on protocol-version rows. Maps to AgileSec crypto.protocol.ciphers.
Classification	One of allows-legacy (SSLv3, TLSv1 or TLSv1.1 is declared), ceiling-below-tls13 (TLS 1.3 is unreachable — a version-specific TLSv1.2 context or a protocol list that stops at TLSv1.2), ceiling-tls13 (a version-specific TLSv1.3 context: TLS 1.3 is reachable but so is everything below it), modern-floor-tls12 (TLSv1.2 and TLSv1.3, no legacy), modern-floor-tls13 (TLSv1.3 alone), ambiguous-default (TLS, SSL or Default: the floor is decided by runtime properties), no-explicit-floor (a default-acquisition site with no protocol configuration in the file), unresolved-value (the protocol or cipher expression is not statically resolvable), dtls (a datagram context, which JEP 527 explicitly excludes), ciphers-allow-tls13 (a pinned cipher list containing at least one RFC 8446 suite), or ciphers-block-tls13 (a pinned cipher list with no RFC 8446 suite, which makes TLS 1.3 unnegotiable even when the protocol floor allows it). Version-specific SSLContext.getInstance algorithm names are ceilings, never floors: on both SunJSSE and BCJSSE they enable everything up to the named version.
PQC readiness	Whether JEP 527 / BouncyCastle 1.81+ hybrid key exchange can negotiate under this configuration: blocked (TLS 1.3 is unreachable, or the endpoint is DTLS), capable (TLS 1.3 is reachable — subject to the runtime JDK being 27+ for JSSE or BouncyCastle being 1.81+ for BCJSSE), or unknown (the value is not statically resolvable). Orthogonal to legacy hygiene: a list containing both TLSv1 and TLSv1.3 is allows-legacy and capable.
Library name	The library providing the configuration surface: JSSE, BouncyCastle, JDK (system-property surface) or Spring Boot (configuration-file surface).
Library language	The language of the source the row was found in: Java, Properties or YAML.
Code snippet	The source code of the detected API usage, e.g. Cipher.getInstance("DES").
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.

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

Column	Description
Finding type	Which 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 name	The 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 function	What the algorithm is used for, e.g. Encryption/Decryption, Hashing, MAC/Signing. Filled on cipher-usage rows.
Algorithm parameter	Additional parameters captured from the API such as mode of operation, padding, key length or digest length. Empty when not expressed at the call site.
Insecure	true 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 name	The protocol family the configuration applies to: TLS, or DTLS for a datagram context. Maps to AgileSec crypto.protocol.name.
Protocol versions	Comma-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 suites	Comma-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 algorithms	The 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 name	The 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 version	The 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 language	The language of the source the row was found in: Java, C#, C/C++, Properties or YAML. Maps to AgileSec crypto.library.language.
Configuration surface	The 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 surface	The 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 classification	How 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 classification	How 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 readiness	Whether 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.
Module	Module identity: the Maven groupId:artifactId of the pom, or the Gradle project name from the GradleProject marker. Filled on module-readiness rows.
JDK version	The 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 by	Major version of the JDK that compiled the sources, or -1 when unknown or not a module-readiness row.
JDK classification	One 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 line	The artifact line parsed from the artifactId: jdk18on, jdk15to18, jdk15on, jdk14, lts8on, fips, or empty.
BouncyCastle dependency type	direct when the module declares the artifact itself, transitive when it arrives through another dependency, empty otherwise.
BouncyCastle classification	The 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 snippet	The source of the detected usage, e.g. Cipher.getInstance("DES"), or the resolved coordinate on a module-readiness row.
File location	The path of the source file relative to the repository root.
Start line	1-based line of the start of the finding, or -1 when unavailable.
Start column	0-based column of the start of the finding, or -1 when unavailable.
Start offset	0-based character offset of the start of the finding, or -1 when unavailable.
End line	1-based line of the end of the finding, or -1 when unavailable.
End column	0-based column of the end of the finding, or -1 when unavailable.
End offset	0-based character offset of the end of the finding, or -1 when unavailable.
Repository origin	The 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 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.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

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

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

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

Statistics used in analyzing the performance of recipes.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.table.RecipeRunStats

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.