Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Victor GRENU committed Dec 23, 2019
1 parent dea3dd6 commit f4fa305
Showing 1 changed file with 29 additions and 21 deletions.
50 changes: 29 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,10 @@
# AWS Security Toolbox :lock:

This toolbox will bring to you all necessary apps and tooling as a simple portable and preinstalled Docker container for SecOps on AWS, especially for auditing and assessment purpose.
This toolbox will bring to you all necessary apps and tooling as a simple portable and preinstalled Docker container for SecOps on AWS, especially for auditing and assessments purpose.

This will reduce the overhead and the headache of installation these tools and dependencies.

## Requirements

- docker [macOS](https://docs.docker.com/docker-for-mac/) or [Linux](https://docs.docker.com/install/linux/docker-ce/debian/)
- `awscli` configured

## Tools

### Optional tools (host machine)

- [aws-vault](https://github.com/99designs/aws-vault)

### Tools (guest container)
## Included Tools

- [awscli](https://aws.amazon.com/cli/)
- [CloudMapper](https://github.com/duo-labs/cloudmapper)
Expand All @@ -25,30 +14,41 @@ This will reduce the overhead and the headache of installation these tools and d
- [PMapper](https://github.com/nccgroup/PMapper)
- [Enumerate-IAM](https://github.com/andresriancho/enumerate-iam)

## Getting Started

### Optional (host machine)

- [aws-vault](https://github.com/99designs/aws-vault)

### Requirements

- docker [macOS](https://docs.docker.com/docker-for-mac/) or [Linux](https://docs.docker.com/install/linux/docker-ce/debian/)
- `awscli` installed & configured

## Usage

Clone the repository:

$ git clone https://github.com/z0ph/aws-security-toolbox.git

There is two options to use this toolbox,
There is two options to use this toolbox,

- Option #1, you are using local `awscli` with `~/.aws/credentials` populated.
- Option #2, you want to use local `aws-vault`.
- Option #1 (Interactive), you are using local `awscli` with `~/.aws/credentials` populated.
- Option #2 (aws-vault), you want to use your local `aws-vault` installation.

Info: Working directory within the container: `/opt/secops`
*Info: Working directory within the container: `/opt/secops`*

## Option 1 (Interactive)

$ ./ast.sh login

When you are logged into the shell of the container in interactive mode (`-it`), you will be able to perform your audit/assessment with confidence.
When you are logged into the shell of the container in interactive mode (`-it`), you will be able to perform your audit/assessment with confidence thanks to pre-populated tools.

Example:

$ ./opt/secops/prowler/prowler -b | ansi2html -la > /tmp/prowler-report.html

*nb: `/tmp` is mapped to your own host `/tmp` folder.*
*nb: `/tmp` is mapped to your own (host machine) `/tmp` folder.*

## Option 2 (`aws-vault`)

Expand All @@ -58,6 +58,14 @@ Example:

### Optional

if you want to build your own container **locally** to get latest updates from tools maintainers
if you want to build your own container **locally** to get latest updates from tools maintainers, run the following command.

$ make build

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Authors

$ make build
* **Victor GRENU** - *Initial work* - [zoph.io](https://github.com/zoph-io)

0 comments on commit f4fa305

Please sign in to comment.