Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Frichetten authored Sep 11, 2024
1 parent 95e1769 commit 84a9c7c
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ A tool to uncover, extract, and monitor undocumented AWS APIs from the AWS conso
## Table of Contents

- [How does it work?](#how-does-it-work)
- [Docker Install/Usage](#docker-installusage)
- [Usage](#usage)
- [How to Build Docker Container](#how-to-build-docker-container)
- [Manual Installation/Usage](#manual-installationusage)
- [Scripts (generate stats)](#scripts-generate-stats)
- [Undocumented parameters are only compared at top level](#undocumented-parameters-are-only-compared-at-top-level)
Expand All @@ -22,24 +23,26 @@ undocumented-aws-api-hunter will deduplicate models and only store shapes, opera
> [!WARNING]
> From some nominal testing it appears that this tool works on M series Macs, however be aware that because this tool uses [Selenium](https://www.selenium.dev/) and hence, [Google Chrome](https://www.google.com/chrome/), there may be some funkyness on non-x86-64 machines. If you'd like to run this in production it would be best to do so on an x86 Linux machine.
## Docker Install/Usage
## Usage

Please create an IAM user in your account with console access. Then create a `.env` with the following environment variables with the associated info: `UAH_USERNAME`, `UAH_PASSWORD`, and `UAH_ACCOUNT_ID`. With those variables set you can run the tool. This user must **NOT** have any permissions. If they have any IAM policies granting permissions it runs the risk of the automation accidentally invoking something.

Run the container with the following:

```
git clone https://github.com/DataDog/undocumented-aws-api-hunter.git
docker run -it --rm -v ${PWD}/models:/app/models -v ${PWD}/logs:/app/logs --env-file .env ghcr.io/datadog/undocumented-aws-api-hunter:latest
```

Build the Docker container:
## How to Build Docker Container

```
docker build -t undocumented-aws-api-hunter .
git clone https://github.com/DataDog/undocumented-aws-api-hunter.git
```

Please create an IAM user in your account with console access. Then create a `.env` with the following environment variables with the associated info: `UAH_USERNAME`, `UAH_PASSWORD`, and `UAH_ACCOUNT_ID`. With those variables set you can run the tool. This user must **NOT** have any permissions. If they have any IAM policies granting permissions it runs the risk of the automation accidentally invoking something.

Run the container with the following:
Build the Docker container:

```
docker run -it --rm -v ${PWD}/models:/app/models -v ${PWD}/logs:/app/logs --env-file .env undocumented-aws-api-hunter
docker build -t undocumented-aws-api-hunter .
```

## Manual Installation/Usage
Expand Down

0 comments on commit 84a9c7c

Please sign in to comment.