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.
Enforce a TLS 1.3 floor in YAML files
Recipe ID
io.moderne.cryptography.pqc.EnforceTls13YamlArtifact
io.moderne.recipe:rewrite-cryptographyOptions
Examples
yaml
| Parameter | Value |
|---|---|
| minimumProtocol | null |
| retainTls12In | null |
| strictAlgorithmName | null |
| additionalPropertyKeys | null |
- yaml
- Diff
Before
server:
ssl:
enabled-protocols:
- TLSv1.1
- TLSv1.2
protocol: TLS
port: 8443
After
server:
ssl:
enabled-protocols:
- TLSv1.3
protocol: TLS
port: 8443
--- application.yml
+++ application.yml
@@ -4,2 +4,1 @@
ssl:
enabled-protocols:
- - TLSv1.1
- - TLSv1.2
+ - TLSv1.3
protocol: TLS
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 EnforceTls13Yaml
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 protocol enforcement
io.moderne.cryptography.pqc.table.ProtocolEnforcementTableProtocol 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.
| Column | Description |
|---|---|
| Configuration surface | The 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. |
| Action | Rewritten 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 before | Comma-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 after | Comma-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 snippet | The source code of the detected API usage, e.g. Cipher.getInstance("DES"). |
| Library name | The library providing the configuration surface: JSSE, BouncyCastle or Spring Boot. |
| Library language | The language of the source the row was found in: Java, Properties or YAML. |
| 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. |