Skip to content

Commit 238d92f

Browse files
committed
updates
1 parent 5ba0aaa commit 238d92f

File tree

3 files changed

+48
-11
lines changed

3 files changed

+48
-11
lines changed

docs/index.md

Lines changed: 43 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**OWASP Amass** is an open-source, versatile **attack surface intelligence** framework designed to comprehensively map an organization’s footprint. Built for flexibility and depth, Amass combines advanced data collection, network mapping, and OSINT capabilities to deliver detailed insights into physical and digital assets.
44

5-
## **//** Overview
5+
## Overview
66

77
[OWASP Amass](https://github.com/owasp-amass) extends **far beyond basic subdomain enumeration**, offering a comprehensive, automated approach to information gathering that reveals the full scope of an entity's **physical** and **digital** footprint.
88

@@ -19,14 +19,10 @@ __[Unlocking the Power of OWASP Amass]__ by [@jeff_foley](https://x.com/jeff_fol
1919

2020
- **Automated Deployment and Enumeration:** Easily deploy Amass with [Docker Compose](https://docs.docker.com/compose/) for quick, automated asset discovery across multiple domains with minimal configuration.
2121

22-
- **Centralized Asset Management with Asset DB:** Use the Asset DB for storing, managing, and retrieving discovered assets, with support for long-term tracking and consistent data collection via the Open Asset Model.
22+
- **Centralized Asset Management with Asset Database:** Use the Asset Database for storing, managing, and retrieving discovered assets, with support for long-term tracking and consistent data collection via the Open Asset Model.
2323

2424
- **Scalable and Flexible Infrastructure:** Designed for enterprise environments, [Docker](https://www.docker.com/products/docker-desktop/) enables scalable deployments of Amass, ensuring consistent attack surface management for organizations of any size.
2525

26-
- **Advanced Collection and Monitoring:** The Collections Engine refines the data collection process, while open-source tools like [syslog-ng](https://github.com/syslog-ng/syslog-ng) provide centralized logging, enabling real-time monitoring and diagnostics.
27-
28-
- **Visualization and Data-Driven Insights:** The latest release features a fully integrated [Grafana](https://grafana.com/oss/grafana/) dashboard, providing dynamic visualization and analysis for deeper attack surface intelligence.
29-
3026
---
3127

3228
## :octicons-tools-16: Getting Started
@@ -44,7 +40,47 @@ Install the Amass swiss army knife executable in your preferred environment.
4440
#### Perform the build and installation process
4541

4642
```bash
47-
go install -v github.com/owasp-amass/amass/v5/cmd/amass@main
43+
CGO_ENABLED=0 go install -v github.com/owasp-amass/amass/v5/cmd/amass@main
44+
```
45+
46+
At this point, the binary should be in *$GOPATH/bin*.
47+
48+
#### Install with Libpostal for Street Address Parsing
49+
50+
**On Ubuntu/Debian**
51+
```bash
52+
sudo apt-get install curl autoconf automake libtool pkg-config
53+
```
54+
55+
**On CentOS/RHEL**
56+
```bash
57+
sudo yum install curl autoconf automake libtool pkgconfig
58+
```
59+
60+
**On Mac OSX**
61+
```bash
62+
sudo brew install curl autoconf automake libtool pkg-config
63+
```
64+
65+
**Installing libpostal**
66+
```bash
67+
git clone https://github.com/openvenues/libpostal.git
68+
cd libpostal
69+
./bootstrap.sh
70+
./configure --datadir=[...some dir with a few GB of space...]
71+
make
72+
sudo make install
73+
```
74+
75+
On Linux it's probably a good idea to run.
76+
```bash
77+
sudo ldconfig
78+
```
79+
80+
Now, build OWASP Amass with libpostal compiled in for street address parsing.
81+
82+
```bash
83+
CGO_ENABLED=1 go install -v github.com/owasp-amass/amass/v5/cmd/amass@main
4884
```
4985

5086
At this point, the binary should be in *$GOPATH/bin*.

docs/open_asset_model/assets/account.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ acct --o idRel
6969
idRel --> ident
7070
7171
org["Organization"]
72-
person["Person]
72+
person["Person"]
7373
user@{ shape: braces, label: "user" }
7474
acct --o user
7575
user --> org

mkdocs.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
# mkdocs serve
33
# mkdocs gh-deploy
44

5-
site_name: OWASP Amass
5+
site_name: OWASP Amass Project
66
site_url: https://owasp-amass.github.io/docs/
77
repo_name: OWASP Amass
88
repo_url: https://github.com/owasp-amass/amass
9-
site_description: "In-depth OSINT collection and external attack surface mapping "
9+
site_description: "In-depth OSINT collection and external attack surface mapping"
1010
site_author: OWASP Amass Contributors
1111
remote_branch: gh-pages
1212

@@ -118,10 +118,11 @@ nav:
118118
- Configuration:
119119
- Configuration: open_asset_model/configuration/index.md
120120
- Data Sources: open_asset_model/configuration/data_sources.md
121+
- Transformations: asset_db/transformations.md
121122
- Asset Database:
122123
- Asset Database: asset_db/index.md
124+
- PostgreSQL: asset_db/postgres.md
123125
- Triples: asset_db/triples.md
124-
- Transformations: asset_db/transformations.md
125126
- Open Asset Model:
126127
- Open Asset Model: open_asset_model/index.md
127128
- Assets:

0 commit comments

Comments
 (0)