Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mrjameshamilton committed Jan 17, 2022
1 parent 02512cf commit 2910de7
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,30 @@ and [Apache Log4j Security Vulnerabilities](https://logging.apache.org/log4j/2.x

# Executing

You can download the release distribution, extract and run the shell/bat script:

```
$ bin/log4shell-detector <path-to-jar>
```

Or executing via Gradle:

```bash
$ ./gradlew run --args=/path/to/my.jar
```

The input can be a jar file, class file, directory, Android aar, Android apk.

# Building

The application can be built from source via Gradle:

```
$ ./gradlew build
```

This will generate distribution archives in the `build/distributions` directory.

# How does it work?

The detector looks for a specific constructor that appears in log4j < 2.15.0,
Expand All @@ -26,7 +44,7 @@ filters are used to look for the specific constructor.

[dex2jar](https://github.com/pxb1988/dex2jar) is used to convert dex files in Android APKs files to class files.

# Shadow packed applications
# Shadow packed log4j

Shadow packed versions of log4j should be detected, for example if
the log4j package is renamed to `com/example/org/apache/logging/log4j`.
Expand Down

0 comments on commit 2910de7

Please sign in to comment.