Find TLS protocol configuration in properties and YAML
io.moderne.cryptography.pqc.FindTlsPropertyConfigurationio.moderne.recipe:rewrite-cryptographyOptions
Examples
properties
| Parameter | Value |
|---|---|
| additionalPropertyKeys | null |
- properties
- Diff
server.ssl.enabled-protocols=TLSv1.2
server.ssl.protocol=TLS
server.port=8443
server.ssl.enabled-protocols=~~>TLSv1.2
server.ssl.protocol=~~>TLS
server.port=8443
--- application.properties
+++ application.properties
@@ -1,2 +1,2 @@
-server.ssl.enabled-protocols=TLSv1.2
-server.ssl.protocol=TLS
+server.ssl.enabled-protocols=~~>TLSv1.2
+server.ssl.protocol=~~>TLS
server.port=8443
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 FindTlsPropertyConfiguration
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
TLS configuration inventory
io.moderne.cryptography.pqc.table.TlsConfigurationInventoryTableTLS 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.
| 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. |
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. |