Moderne licensed

Find secrets with regular expressions

Recipe IDorg.openrewrite.java.security.secrets.FindSecretsByPatternArtifactorg.openrewrite.recipe:rewrite-java-security

A secret is a literal that matches any one of the provided patterns.

Single recipeProprietary

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.java.security.secrets.FindSecretsByPattern")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-java-security:3.41.0")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.security.secrets.FindSecretsByPattern --recipe-option "secretName=AWS Access Key" --recipe-option "valuePattern=[a-zA-Z0-9+\/=]{88}"

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-java-security:RELEASE

Options

Name	Type	Description
`secretName`required	`String`	The type of secret that this recipe is looking for. e.g. `AWS Access Key`
`keyPattern`	`String`	A regular expression to match a 'key' against. For example, a key e.g. `[a-zA-Z0-9+\/=]{88}`
`valuePattern`required	`String`	A regular expression to search for. e.g. `[a-zA-Z0-9+\/=]{88}`

Data tables

Structured output this recipe can produce.

Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats