Find sensitive API endpoints
org.openrewrite.java.security.search.FindSensitiveApiEndpoints
Find data models exposed by REST APIs that contain sensitive information like PII and secrets.
Recipe source
This recipe is only available to users of Moderne.
Options
| Type | Name | Description | Example |
|---|---|---|---|
List | fieldNames | Field names to search for. | password,dateOfBirth,dob,ssn |
Boolean | transitive | Optional. Find model objects that contain other model objects that contain sensitive data. |
License
This recipe is available under the Moderne Proprietary License.
Usage
This recipe has required configuration parameters and can only be run by users of Moderne.
To run this recipe, you will need to provide the Moderne CLI run command with the required options.
Or, if you'd like to create a declarative recipe, please see the below example of a rewrite.yml file:
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.FindSensitiveApiEndpointsExample
displayName: Find sensitive API endpoints example
recipeList:
- org.openrewrite.java.security.search.FindSensitiveApiEndpoints:
fieldNames: password,dateOfBirth,dob,ssn
- Moderne CLI
You will need to have configured the Moderne CLI on your machine before you can run the following command.
mod run . --recipe FindSensitiveApiEndpoints --recipe-option "fieldNames=password,dateOfBirth,dob,ssn"
If the recipe is not available locally, then you can install it using:
mod config recipes jar install org.openrewrite.recipe:rewrite-java-security:2.17.0
See how this recipe works across multiple open-source repositories
Run this recipe on OSS repos at scale with the Moderne SaaS.
The community edition of the Moderne platform 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.
Data Tables
Sensitive API endpoints
org.openrewrite.java.security.table.SensitiveApiEndpoints
The API endpoints that expose sensitive data.
| Column Name | Description |
|---|---|
| Source path | The path to the source file containing the API endpoint definition. |
| Method name | The name of the method that defines the API endpoint. |
| Method | The HTTP method of the API endpoint. |
| Path | The path of the API endpoint. |
| Sensitive field | The piece of sensitive data that is included. |
| Sensitive data path | The sensitive data exposed by the API endpoint. |
Source files that had results
org.openrewrite.table.SourcesFileResults
Source files that were modified by the recipe run.
| Column Name | 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 errored on a recipe
org.openrewrite.table.SourcesFileErrors
The details of all errors produced by a recipe run.
| Column Name | 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.
| Column Name | 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 | The total time spent across the scanning phase of this recipe. |
| 99th percentile scanning time | 99 out of 100 scans completed in this amount of time. |
| Max scanning time | The max time scanning any one source file. |
| Cumulative edit time | The total time spent across the editing phase of this recipe. |
| 99th percentile edit time | 99 out of 100 edits completed in this amount of time. |
| Max edit time | The max time editing any one source file. |