Skip to content

Commit 41667b9

Browse files
authored
Update README.md
1 parent 1084d92 commit 41667b9

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
# attack-surface-detector-cli
22

3-
The `attack-surface-detector-cli` program is a command-line tool that takes in a folder location and outputs the set of endpoints detected within that codebase. [It uses the `threadfix-ham` module to generate these endpoints.](https://github.com/secdec/attack-surface-detector-cli/blob/master/threadfix-cli-endpoints/src/com/denimgroup/threadfix/cli/endpoints/EndpointMain.java#L268)
4-
3+
The `attack-surface-detector-cli` program is a command-line tool that takes in a folder location and outputs the set of endpoints detected within that codebase. It uses the [ASTAM Correlator's](https://github.com/secdec/astam-correlator) `threadfix-ham` module to generate these endpoints.
54
## Usage
65

7-
Once compiled to a JAR, run the program with:
6+
Once you have a compiled JAR, run the program with:
87

9-
java -jar attack-surface-detector-cli.jar <root-folder>
8+
java -jar attack-surface-detector-cli.jar <root-folder> [-flags]
109

1110
If successful, you should see various output in the console regarding endpoints declared in the given code.
1211

@@ -26,15 +25,16 @@ If successful, you should see various output in the console regarding endpoints
2625
Generated 50 total parameters
2726
To enable logging include the -debug argument
2827

29-
## Generating JSON
28+
## Saving to JSON
3029

3130
The detected endpoints can be serialized and stored in a JSON file. This is done using the `-json` and `-output=...` parameters:
3231

3332
> java -jar attack-surface-detector-cli.jar C:\...\SourceCode -json -output=C:\...\endpoints.json
3433

35-
The default `json` format carries extra information and is intended to be used with the `threadfix-ham` module from the ASTAM Correlator through `com.denimgroup.threadfix.framework.engine.full.EndpointSerialization.deserializeAll(..)`. A simplified output can be created by using the `-simple-json` flag instead of `-json`. See the Options section below for more details.
34+
This `json` output carries extra information and is intended to be used with the `threadfix-ham` module from the ASTAM Correlator through `com.denimgroup.threadfix.framework.engine.full.EndpointSerialization.deserializeAll(..)`. A simplified output can be created by using the `-simple-json` flag instead of `-json`. See the Options section below for more details.
3635

3736
## Options
37+
3838
<folder-path>
3939
Runs endpoint detection on code location in the given folder path. _(Required, unless -path-list-file=... is specified)_
4040

@@ -96,7 +96,7 @@ For simplicity, this `jar` is referred to as `attack-surface-detector-cli.jar` t
9696

9797
## Debug Information
9898

99-
The console output includes various debug information at the end of a scan for validation. This typically looks like:
99+
The console output can include various debug information at the end of a scan for validation. This typically looks like:
100100

101101
Got an absolute file path when a relative path was expected instead, for: GET,/^(?P<i18>[\w\-_]+)/^admin/^mypageextension/$,{}
102102
Failed to validate serialization for at least one of these endpoints

0 commit comments

Comments
 (0)