Skip to content

Commit f7ffdeb

Browse files
committed
Update docs to include new util
1 parent 2e6a280 commit f7ffdeb

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,43 @@ ansible --inventory=hosts-file cool-servers \
8282
--become --ask-become-pass --user="ian.kilmister"
8383
```
8484

85+
## Helper utilities ##
86+
87+
Additional helper tools and scripts are bundled with the ioc-scanner.
88+
89+
### `stix-extract` ###
90+
91+
```console
92+
Extract valuable information from STIX (Structured Threat Information Expression) files.
93+
94+
This script parses the STIX file to extract and print the following observables:
95+
- IP addresses, which are associated with network indicators.
96+
- Hashes (SHA256, SHA1, MD5) of files, prioritizing by hash type.
97+
- Fully Qualified Domain Names (FQDNs), which can help identify associated domains.
98+
- URLs, which could represent potential threat sources or command and control servers.
99+
100+
The script prints each observable type in a separate section with a clear title for easy reading.
101+
102+
Usage:
103+
stix-extract [<file>]
104+
105+
Options:
106+
-h --help Show this screen.
107+
108+
Arguments:
109+
file The path to the STIX xml file to parse. If not specified, reads from standard input.
110+
```
111+
112+
The `stix-extract` utility can be used alone or in conjunction with the
113+
`ioc-scan` tool to scan for IoCs in a STIX file.
114+
115+
```console
116+
curl https://www.cisa.gov/sites/default/files/2023-06/aa23-158a.stix_.xml \
117+
| stix-extract | ioc-scan --stdin --target=.
118+
```
119+
120+
### `ioc_scan_by_host.sh` ###
121+
85122
To scan for indicator strings on AWS instances that are accessible via
86123
[SSM](https://docs.aws.amazon.com/systems-manager/latest/userguide/what-is-systems-manager.html),
87124
the `ioc_scan_by_host.sh` shell script has been provided in the `extras`

0 commit comments

Comments
 (0)