You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,11 @@
1
1
# attack-surface-detector-cli
2
2
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.
5
4
## Usage
6
5
7
-
Once compiled to a JAR, run the program with:
6
+
Once you have a compiled JAR, run the program with:
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.
36
35
37
36
## Options
37
+
38
38
<folder-path>
39
39
Runs endpoint detection on code location in the given folder path. _(Required, unless -path-list-file=... is specified)_
40
40
@@ -96,7 +96,7 @@ For simplicity, this `jar` is referred to as `attack-surface-detector-cli.jar` t
96
96
97
97
## Debug Information
98
98
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:
100
100
101
101
Got an absolute file path when a relative path was expected instead, for: GET,/^(?P<i18>[\w\-_]+)/^admin/^mypageextension/$,{}
102
102
Failed to validate serialization for at least one of these endpoints
0 commit comments