Skip to content

Commit 9fdfaf0

Browse files
committed
updated docs to be consistent with Asset DB
1 parent 8c6361c commit 9fdfaf0

File tree

1 file changed

+6
-27
lines changed

1 file changed

+6
-27
lines changed

doc/user_guide.md

Lines changed: 6 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ amass enum -d example.com
2727
Typical parameters for DNS enumeration:
2828

2929
```bash
30-
$ amass enum -v -src -ip -brute -min-for-recursive 2 -d example.com
31-
[Google] www.example.com
32-
[VirusTotal] ns.example.com
30+
$ amass enum -brute -min-for-recursive 2 -d example.com
31+
example.com (FQDN) --> node --> www.example.com (FQDN)
32+
www.example.com (FQDN) --> a_record --> 123.456.789.01 (IPAddress)
3333
...
3434
```
3535

@@ -156,27 +156,6 @@ This subcommand will perform DNS enumeration and network mapping while populatin
156156
| -w | Path to a different wordlist file for brute forcing | amass enum -brute -w wordlist.txt -d example.com |
157157
| -wm | "hashcat-style" wordlist masks for DNS brute forcing | amass enum -brute -wm ?l?l -d example.com |
158158

159-
### The 'db' Subcommand
160-
161-
Performs viewing and manipulation of the graph database. This subcommand only leverages the 'output_directory' and remote graph database settings from the configuration file. Flags for interacting with the enumeration findings in the graph database include:
162-
163-
| Flag | Description | Example |
164-
|------|-------------|---------|
165-
| -d | Domain names separated by commas (can be used multiple times) | amass db -d example.com |
166-
| -demo | Censor output to make it suitable for demonstrations | amass db -demo -d example.com |
167-
| -df | Path to a file providing root domain names | amass db -df domains.txt |
168-
| -enum | Identify an enumeration via an index from the listing | amass db -enum 1 -show |
169-
| -ip | Show the IP addresses for discovered names | amass db -show -ip -d example.com |
170-
| -ipv4 | Show the IPv4 addresses for discovered names | amass db -show -ipv4 -d example.com |
171-
| -ipv6 | Show the IPv6 addresses for discovered names | amass db -show -ipv6 -d example.com |
172-
| -json | Path to the JSON output file or '-' | amass db -names -silent -json out.json -d example.com |
173-
| -list | Print enumerations in the database and filter on domains specified | amass db -list |
174-
| -names | Print just discovered names | amass db -names -d example.com |
175-
| -o | Path to the text output file | amass db -names -o out.txt -d example.com |
176-
| -show | Print the results for the enumeration index + domains provided | amass db -show |
177-
| -src | Print data sources for the discovered names | amass db -show -src -d example.com |
178-
| -summary | Print just ASN table summary | amass db -summary -d example.com |
179-
180159
## The Output Directory
181160

182161
Amass has several files that it outputs during an enumeration (e.g. the log file). If you are not using a database server to store the network graph information, then Amass creates a file based graph database in the output directory. These files are used again during future enumerations.
@@ -311,13 +290,13 @@ There is nothing preventing multiple users from sharing a single (remote) graph
311290
Once you have the postgres server running on your machine and access to the psql tool, execute the follow two commands to initialize your amass database:
312291

313292
```bash
314-
psql postgres://username:password@localhost:5432/ -c "CREATE DATABASE amass"
315-
psql postgres://username:password@localhost:5432/ -c "ALTER DATABASE amass SET TIMEZONE to 'UTC'"
293+
psql postgres://username:password@localhost:5432/ -c "CREATE DATABASE assetdb"
294+
psql postgres://username:password@localhost:5432/ -c "ALTER DATABASE assetdb SET TIMEZONE to 'UTC'"
316295
```
317296

318297
Now you can add the following setting into your Amass `config.yaml` file for storing and analyzing attack surface discoveries using PostgreSQL:
319298

320299
```yaml
321300
options:
322-
database: "postgres://username:password@localhost:5432/amass?testing=works"
301+
database: "postgres://username:password@localhost:5432/assetdb?testing=works"
323302
```

0 commit comments

Comments
 (0)