readme.md in aws_recon-0.2.25 vs readme.md in aws_recon-0.2.26

- old
+ new

@@ -5,13 +5,13 @@ A multi-threaded AWS inventory collection tool. The [creators](https://darkbit.io) of this tool have a recurring need to be able to efficiently collect a large amount of AWS resource attributes and metadata to help clients understand their cloud security posture. -There are a handful of tools (e.g. [AWS Config](https://aws.amazon.com/config), [CloudMapper](https://github.com/duo-labs/cloudmapper), [CloudSploit](https://github.com/cloudsploit/scans), [Prowler](https://github.com/toniblyx/prowler)) that do some form of resource collection to support other functions. But we found we needed broader coverage and more details at a per-service level. We also needed a consistent and structured format that allowed for integration with our other systems and tooling. +Existing tools (e.g. [AWS Config](https://aws.amazon.com/config)) that do some form of resource collection lack the coverage and specificity we needed. We also needed a tool that produced consistent output that was easily consumed by other tools/systems. -Enter AWS Recon, multi-threaded AWS inventory collection tool written in plain Ruby. Though most AWS tooling tends to be dominated by Python, the [Ruby SDK](https://aws.amazon.com/sdk-for-ruby/) is quite mature and capable. The maintainers of the Ruby SDK have done a fantastic job making it easy to handle automatic retries, paging of large responses, and threading huge numbers of requests. +Enter AWS Recon, multi-threaded AWS inventory collection tool written in plain Ruby. Though Python tends to dominate the AWS tooling landscape, the [Ruby SDK](https://aws.amazon.com/sdk-for-ruby/) has a few convenient advantages over the [other](https://aws.amazon.com/sdk-for-node-js/) [AWS](https://aws.amazon.com/sdk-for-python/) [SDKs](https://aws.amazon.com/sdk-for-go/) we tested. Specifically, easy handling of automatic retries, paging of large responses, and - with some help - threading huge numbers of requests. ## Project Goals - More complete resource coverage than available tools (especially for ECS & EKS) - More granular resource detail, including nested related resources in the output @@ -21,59 +21,65 @@ ## Setup ### Requirements -Ruby 2.5.x or 2.6.x (developed and tested with 2.6.5) +AWS Recon needs AWS account role or credentials with `ReadOnlyAccess`. Full `AdministratorAccess` is over-privileged, but will work as well. The `SecurityAudit` policy is **not** sufficient as it omits access to many services. +#### Running via Docker + +Use Docker version 19.x or above to run the pre-built image without having to install anything. + +#### Running locally via Ruby + +If you already have Ruby installed (2.5.x or 2.6.x), you may want to install the Ruby gem. + ### Installation -AWS Recon can be run locally by installing the Ruby gem, or via a Docker container. +AWS Recon can be run locally via a Docker container or by installing the Ruby gem. +To run via a Docker a container, pass the necessary AWS credentials into the Docker `run` command. For example: + +``` +$ docker run -t --rm \ + -e AWS_REGION \ + -e AWS_ACCESS_KEY_ID \ + -e AWS_SECRET_ACCESS_KEY \ + -e AWS_SESSION_TOKEN \ + -v $(pwd)/output.json:/recon/output.json \ + darkbitio/aws_recon:latest \ + aws_recon -v -s EC2 -r global,us-east-1,us-east-2 +``` + To run locally, first install the gem: ``` $ gem install aws_recon -Fetching aws_recon-0.2.8.gem -Fetching aws-sdk-resources-3.76.0.gem +Fetching aws_recon-0.2.26.gem Fetching aws-sdk-3.0.1.gem -Fetching parallel-1.19.2.gem +Fetching parallel-1.20.1.gem ... Successfully installed aws-sdk-3.0.1 -Successfully installed parallel-1.19.2 -Successfully installed aws_recon-0.2.8 +Successfully installed parallel-1.20.1 +Successfully installed aws_recon-0.2.26 ``` Or add it to your Gemfile using `bundle`: ``` $ bundle add aws_recon Fetching gem metadata from https://rubygems.org/ Resolving dependencies... ... Using aws-sdk 3.0.1 -Using parallel 1.19.2 -Using aws_recon 0.2.8 +Using parallel-1.20.1 +Using aws_recon 0.2.26 ``` -To run via a Docker a container, pass the necessary AWS credentials into the Docker `run` command. For example: - -``` -$ docker run -t --rm \ - -e AWS_REGION \ - -e AWS_ACCESS_KEY_ID \ - -e AWS_SECRET_ACCESS_KEY \ - -e AWS_SESSION_TOKEN \ - -v $(pwd)/output.json:/recon/output.json \ - darkbitio/aws_recon:latest \ - aws_recon -v -s EC2 -r global,us-east-1,us-east-2 -``` - - ## Usage -AWS Recon will leverage any AWS credentials currently available to the environment it runs in. If you are collecting from multiple accounts, you may want to leverage something like [aws-vault](https://github.com/99designs/aws-vault) to manage different credentials. +AWS Recon will leverage any AWS credentials (see [requirements](#requirements)) currently available to the environment it runs in. If you are collecting from multiple accounts, you may want to leverage something like [aws-vault](https://github.com/99designs/aws-vault) to manage different credentials. ``` $ aws-vault exec profile -- aws_recon ``` @@ -93,11 +99,11 @@ -e AWS_SESSION_TOKEN \ darkbitio/aws_recon:latest \ aws_recon -j -s EC2 -r global,us-east-1,us-east-2 ``` -To run from a Docker container using `aws-vault` managed credentials and output to a file, you will need to satisfy a couple of requirements. First, Docker needs access to bind mount the path you specify (or a parent path above). Second, you need to create an empty file to save the output into (e.g. `output.json`). This is because we are only mounting that one file into the Docker container at run time. For example: +To run from a Docker container using `aws-vault` managed credentials and output to a file, you will need to satisfy a couple of requirements. First, Docker needs access to bind mount the path you specify (or a parent path above). Second, you need to create an empty file to save the output into (e.g. `output.json`). This is because only that one file is mounted into the Docker container at run time. For example: Create an empty file. ``` $ touch output.json @@ -165,35 +171,60 @@ $ AWS_PROFILE=<profile> aws_recon -s S3,EC2 -r global,us-east-1,us-east-2 -f custom > output.json ``` #### Errors -An exception will be raised on `AccessDeniedException` errors. This typically means your user/role doesn't have the necessary permissions to get/list/describe for that service. These exceptions are raised so troubleshooting access issues is easier. +API exceptions related to permissions are silently ignored in most cases. These errors are usually due to one of these cases: +- using a role without sufficient permissions +- querying an account with SCPs in place that prevent usage of certain services +- trying to query a service that isn't enabled/available in your region/account + +In `verbose` mode, you will see exception logs in the output: + ``` +t2.us-east-1.EC2.describe_subnets.0 +t4.us-east-1.SSM.describe_instance_information.0 +t6.us-east-1.SecurityHub.InvalidAccessException <----- +t2.us-east-1.EC2.describe_addresses.0 +t4.us-east-1.SSM.describe_parameters.0 +t1.us-east-1.GuardDuty.list_detectors.0 +``` + +Use the `-q` command line option to re-raise these exceptions so troubleshooting access issues is easier. + +``` Traceback (most recent call last): -arn:aws:sts::1234567890:assumed-role/role/9876543210 is not authorized to perform: codepipeline:GetPipeline on resource: arn:aws:codepipeline:us-west-2:876543210123:pipeline (Aws::CodePipeline::Errors::AccessDeniedException) +arn:aws:sts::1234567890:assumed-role/role/my-audit-role is not authorized to perform: + codepipeline:GetPipeline on resource: arn:aws:codepipeline:us-west-2:1234567890:pipeline + (Aws::CodePipeline::Errors::AccessDeniedException) ``` -The exact API operation that triggered the exception is indicated on the last line of the stack trace. If you can't resolve the necessary access, you should exclude those services with `-x` or `--not-services` so the collection can continue. +The exact API operation that triggered the exception is indicated on the last line of the stack trace. If you can't resolve the necessary access, you should exclude those services with `-x` or `--not-services`, or leave off the `-q` option so the collection can continue. ### Threads AWS Recon uses multiple threads to try to overcome some of the I/O challenges of performing many API calls to endpoints all over the world. For global services like IAM, Shield, and Support, requests are not multi-threaded. The S3 module is multi-threaded since each bucket requires several additional calls to collect complete metadata. For regional services, a thread (up to the thread limit) is spawned for each service in a region. By default, up to 8 threads will be used. If your account has resources spread across many regions, you may see a speed improvement by increasing threads with `-t X`, where `X` is the number of threads. +### Performance + +AWS Recon will make a minimum of ~2,000 API calls in a new/empty account, just to query the supported services in all 20 standard (non-GovCloud, non-China) regions. It is very likely to encounter API rate-limiting (throttling) on large accounts if you enable more threads than the default (8). + +Recon will automatically backoff and respect the retry limits in the API response. If you observe long pauses during collection, this is likely what is happening. Retry collection with the `-d` or `--debug` option to observe the wire trace and see if you're being throttled. Consider using fewer threads or requesting higher rate limits from AWS if you are regularly getting rate-limited. + ### Options -Most users will want to limit collection to relevant services and regions. Running without any options will attempt to collect all resources from all 16 regular regions. +Most users will want to limit collection to relevant services and regions. Running without any exclusions will attempt to collect all resources from all regions enabled for the account. ``` $ aws_recon -h -AWS Recon - AWS Inventory Collector (0.2.8) +AWS Recon - AWS Inventory Collector (0.2.26) Usage: aws_recon [options] -r, --regions [REGIONS] Regions to scan, separated by comma (default: all) -n, --not-regions [REGIONS] Regions to skip, separated by comma (default: none) -s, --services [SERVICES] Services to scan, separated by comma (default: all) @@ -202,12 +233,14 @@ -o, --output [OUTPUT] Specify output file (default: output.json) -f, --format [FORMAT] Specify output format (default: aws) -t, --threads [THREADS] Specify max threads (default: 8, max: 128) -u, --user-data Collect EC2 instance user data (default: false) -z, --skip-slow Skip slow operations (default: false) + -g, --skip-credential-report Skip generating IAM credential report (default: false) -j, --stream-output Stream JSON lines to stdout (default: false) -v, --verbose Output client progress and current operation + -q, --quit-on-exception Stop collection if an API error is encountered (default: false) -d, --debug Output debug with wire trace info -h, --help Print this help information ``` @@ -215,22 +248,22 @@ Output is always some form of JSON - either JSON lines or plain JSON. The output is either written to a file (the default), or written to stdout (with `-j`). ## Support for Manually Enabled Regions -If you have enabled manually enabled regions: +If you have enabled **manually enabled regions**: - me-south-1 - Middle East (Bahrain) - af-south-1 - Africa (Cape Town) - ap-east-1 - Asia Pacific (Hong Kong) - eu-south-1 - Europe (Milan) and you are using STS to assume a role into an account, you will need to [enable v2 STS tokens](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the account you are assuming the role **from** to be able to run AWS Recon against those regions. > Version 1 tokens are valid only in AWS Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. -If you are using a static access key/secret, you can collect from these regions with either `v1` or `v2` STS tokens. +If you are using a static access key/secret, you can collect from these regions regardless of STS token version. ## Supported Services & Resources Current "coverage" by service is listed below. The services without coverage will eventually be added. PRs are certainly welcome. :) @@ -322,13 +355,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). ### TODO -- [ ] Optionally suppress AWS API errors instead of re-raising them -- [x] Package as a gem - [ ] Test coverage with AWS SDK stubbed resources - ## Kudos AWS Recon was inspired by the excellent work of the people and teams behind these tools: