oam-tools

README

OAM Tools

The OAM Tools serve the purpose of extracting, manipulating, and analyzing data in an OAM database.

Current tools are:

Tool	Description
oam_subs	Analyze collected OAM assets
oam_track	Analyze collected OAM data to identify newly discovered assets
oam_viz	Analyze collected OAM data to generate files renderable as graph visualizations

Usage

To understand the various options that the tools offer, check out the Users' Guide!

For a more thorough read to understand the proper use cases of the tool (with examples), check out the Comprehensive Guide.

Installation

From Source

1. Install Go and setup your Go workspace
2. Download all the OAM tools by running go install -v github.com/owasp-amass/oam-tools/cmd/...@master
   • If you want to download a specific tool only, run go install -v github.com/owasp-amass/oam-tools/cmd/TOOL_NAME@master
     • Example: go install -v github.com/owasp-amass/oam-tools/cmd/oam_subs@master
3. At this point, the binary should be in $GOPATH/bin

Local Install

1. Install Go and setup your Go workspace
2. Use git to clone the repository: git clone https://github.com/owasp-amass/oam-tools
   • At this point, a directory called oam-tools should be made
3. Go into the oam-tools directory by running cd oam-tools, and then build the desired program by running go build ./cmd/TOOL_NAME
   • Example: go build ./cmd/oam_i2y
   • To install all the tools at once, you would need to be inside the oam-tools directory and iterate through all the tools under cmd
     • A one-liner (like this one in bash: for i in ./cmd/*; do echo $i; go build $i;done) can be made to handle this scenario.
4. Enjoy! The binary will reside in your current working directory, which should be the oam-tools directory.

Corporate Supporters

Contributing

We are always happy to get new contributors on board! Join our Discord Server to discuss current project goals.

Troubleshooting

If you need help with the installation and/or usage of the tools, please join our Discord server where community members can best help you.

Please avoid opening GitHub issues for support requests or questions!

Licensing

This program is free software: you can redistribute it and/or modify it under the terms of the Apache license. OWASP Amass and any contributions are Copyright © by Jeff Foley 2017-2024. Some subcomponents have separate licenses.