@ -1,19 +1,21 @@
# [ OWASP Amass](https://owasp.org/www-project-amass/)
#  OWASP Amass [](https://owasp.org/projects/#sec-flagships) [](https://github.com/OWASP/Amass/releases) [](https://twitter.com/owaspamass) [](https://discord.gg/rtN8GMd)
[](https://owasp.org/projects/#sec-flagships)
[](https://github.com/OWASP/Amass/releases)
[](https://github.com/OWASP/Amass/releases/latest)
[](https://hub.docker.com/r/caffix/amass)
[](https://twitter.com/owaspamass)
[](https://discord.gg/rtN8GMd)
[](https://circleci.com/gh/OWASP/Amass/tree/master)
[](https://pkg.go.dev/github.com/OWASP/Amass/v3?tab=overview)
[](https://www.apache.org/licenses/LICENSE-2.0)
[](https://circleci.com/gh/OWASP/Amass/tree/master)
[](https://goreportcard.com/report/github.com/OWASP/Amass)
[](https://www.codefactor.io/repository/github/OWASP/Amass)
[](https://codeclimate.com/github/OWASP/Amass/maintainability)
[](https://codecov.io/gh/OWASP/Amass)
[](https://hub.docker.com/r/caffix/amass)
The OWASP Amass Project has developed a tool to help information security professionals perform network mapping of attack surfaces and perform external asset discovery using open source information gathering and active reconnaissance techniques.
< p align = "center" >
< img alt = "DNS Enumeration" src = "./images/amass.gif" width = "577" height = "685" / >
< / p >
The OWASP Amass Project performs network mapping of attack surfaces and external asset discovery using open source information gathering and active reconnaissance techniques.
**Information Gathering Techniques Used:**
@ -23,14 +25,14 @@ The OWASP Amass Project has developed a tool to help information security profes
* **APIs:** AlienVault, BinaryEdge, BufferOver, CIRCL, CommonCrawl, DNSDB, GitHub, HackerTarget, IPToASN, Mnemonic, NetworksDB, PassiveTotal, Pastebin, RADb, Robtex, SecurityTrails, ShadowServer, Shodan, Spyse (CertDB & FindSubdomains), Sublist3rAPI, TeamCymru, ThreatCrowd, Twitter, Umbrella, URLScan, VirusTotal, WhoisXML
* **Web Archives:** ArchiveIt, ArchiveToday, Arquivo, LoCArchive, OpenUKArchive, UKGovArchive, Wayback
## Installation
----
## Installation [](https://golang.org/dl/) [](https://hub.docker.com/r/caffix/amass) [](https://github.com/OWASP/Amass/releases/latest)
> You can find some additional installation variations in the [Installation Guide ](./doc/install.md ).
### Prebuilt Packages
[](https://github.com/OWASP/Amass/releases/latest)
1. Simply unzip the [package ](https://github.com/OWASP/Amass/releases/latest )
2. Put the precompiled binary into your path
3. Start using OWASP Amass!
@ -50,8 +52,6 @@ sudo snap install amass
### Docker Container
[](https://hub.docker.com/r/caffix/amass)
1. Install [Docker ](https://www.docker.com )
2. Pull the Docker image by running `docker pull caffix/amass`
3. Run `docker run -v OUTPUT_DIR_PATH:/.config/amass/ caffix/amass --version`
@ -66,14 +66,12 @@ docker run -v OUTPUT_DIR_PATH:/.config/amass/ caffix/amass enum -brute -w /wordl
### From Sources
[](https://golang.org/dl/)
1. Install [Go ](https://golang.org/doc/install ) and setup your Go workspace
2. Add the Go Module environment variable by running `export GO111MODULE=on`
3. Download OWASP Amass by running `go get -v -u github.com/OWASP/Amass/v3/...`
4. At this point, the binary should be in `$GOPATH/bin`
## Documentation
## Documentation [](https://pkg.go.dev/github.com/OWASP/Amass/v3?tab=overview)
Use the [Installation Guide ](./doc/install.md ) to get started.
@ -81,6 +79,12 @@ Go to the [User's Guide](./doc/user_guide.md) for additional information.
See the [Tutorial ](./doc/tutorial.md ) for example usage.
## Troubleshooting [](https://discord.gg/rtN8GMd)
If you need help with installation and/or usage of the tool, please join our [Discord server ](https://discord.gg/rtN8GMd ) where community members can best try to help you.
:stop_sign: **Please avoid opening GitHub issues for support requests or questions!**
## Contributing [](./CONTRIBUTING.md) [](https://discord.gg/rtN8GMd)
We are always happy to get new contributors on board! Please check [CONTRIBUTING.md ](CONTRIBUTING.md ) to learn how to
@ -94,7 +98,7 @@ The OWASP Amass core project team are:
* [Anthony Rhodes ](https://github.com/fork-while-fork ) aka `fork-while-fork`
[](https://twitter.com/fork_while_fork)
For a list of all contributors to the OWASP Amass please visit our [HALL_OF_FAME.md ](HALL_OF_FAME.md ).
For a list of all contributors to the OWASP Amass Project please visit our [HALL_OF_FAME.md ](HALL_OF_FAME.md ).
## References [](https://inventory.rawsec.ml/tools.html#title-tools-osint) [](https://www.youtube.com/watch?v=C-GabM2db9A) [](https://www.defcon.org/html/defcon-27/dc-27-demolabs.html) [](https://reconvillage.org/)
caffix
3 years ago