Skip to main content

Remove hard-coded IP addresses from comments

org.openrewrite.text.RemoveHardcodedIPAddressesFromComments

Removes hard-coded IPv4 addresses from comments when they match private IP ranges or loopback addresses. This targets IP addresses that are commented out in various comment formats: Private IP ranges: * 192.168.0.0 to 192.168.255.255 * 10.0.0.0 to 10.255.255.255 * 172.16.0.0 to 172.31.255.255 Loopback IP range: * 127.0.0.0 to 127.255.255.255 Supported comment formats: * C-style line comments (//) * C-style block comments (/* */) * Shell/Python style comments (#) * XML comments (<!-- -->) * YAML comments (#) * Properties file comments (# or !) For line comments, the entire line is removed. For block comments, only the IP address is removed.

Recipe source​

This recipe is only available to users of Moderne.

This recipe is available under the Moderne Proprietary License.

Options​

TypeNameDescriptionExample
StringipAddressReplacementOptional. If specified, replaces hard-coded IP addresses with this value. Default is 'IP_ADDRESS_REPLACED'IP_ADDRESS_REPLACED

Example​

Parameters​
ParameterValue
ipAddressReplacementnull
Before​
class Test {
    void ipTest() {
        String host = "localhost";
        // Testing with 127.0.0.1
        // Also try 127.1.1.1
        String publicAddress = "8.8.8.8";
        // Boundary case: 127.255.255.255
    }
}
After​
class Test {
    void ipTest() {
        String host = "localhost";
        // Testing with IP_ADDRESS_REPLACED
        // Also try IP_ADDRESS_REPLACED
        String publicAddress = "8.8.8.8";
        // Boundary case: IP_ADDRESS_REPLACED
    }
}

Usage​

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 RemoveHardcodedIPAddressesFromComments

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite.recipe:rewrite-java-security:3.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​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA 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 changesIn 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 changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.