Find secrets with regular expressions
org.openrewrite.java.security.secrets.FindSecretsByPattern A secret is a literal that matches any one of the provided patterns.
- groupId: org.openrewrite.recipe
- artifactId: rewrite-java-security
- version: 1.23.0
Type | Name | Description |
|---|---|---|
String | secretName | The type of secret that this recipe is looking for. |
String | keyPattern | Optional. A regular expression to match a 'key' against. For example, a key |
String | valuePattern | A regular expression to search for. |
This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your
rewrite.yml create a new recipe with a unique name. For example: com.yourorg.FindSecretsByPatternExample. Here's how you can define and customize such a recipe within your rewrite.yml:rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.FindSecretsByPatternExample
displayName: Find secrets with regular expressions example
recipeList:
- org.openrewrite.java.security.secrets.FindSecretsByPattern:
secretName: AWS Access Key
keyPattern: '[a-zA-Z0-9+\/=]{88}'
valuePattern: '[a-zA-Z0-9+\/=]{88}'
Now that
com.yourorg.FindSecretsByPatternExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-java-security:1.23.0 in your build file:Gradle
Maven
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.38.0")
}
rewrite {
activeRecipe("com.yourorg.FindSecretsByPatternExample")
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-java-security:1.23.0")
}
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>4.42.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.FindSecretsByPatternExample</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-java-security</artifactId>
<version>1.23.0</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
The Moderne public SaaS instance enables you to easily run recipes across thousands of open-source repositories.
Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.
Last modified 4h ago