trailscraper 0.4.3

A command-line tool to get valuable information out of AWS CloudTrail

TrailScraper

A command-line tool to get valuable information out of AWS CloudTrail

Installation

$ pip install trailscraper

Usage

# Download some logs (including us-east-1 for global aws services)
$ trailscraper download --bucket some-bucket \
                        --account-id some-account-id \
                        --region some-other-region \
                        --region us-east-1 \
                        --from 'two days ago' \
                        --to 'now' \
# Generate an IAM Policy
$ trailscraper generate-policy
{
    "Statement": [
        {
            "Action": [
                "ec2:DescribeInstances",
                "ec2:DescribeSecurityGroups",
                "ec2:DescribeSubnets",
                "ec2:DescribeVolumes",
                "ec2:DescribeVpcs",
            ],
            "Effect": "Allow",
            "Resource": [
                "*"
            ]
        },
        {
            "Action": [
                "sts:AssumeRole"
            ],
            "Effect": "Allow",
            "Resource": [
                "arn:aws:iam::1111111111:role/someRole"
            ]
        }
    ],
    "Version": "2012-10-17"
}

Development

$ ./go setup   # set up venv, dependencies and tools
$ ./go test    # run some tests
$ ./go check   # run some style checks
$ ./go         # let's see what we can do here

Troubleshooting

TrailScraper is missing some events

• Make sure you have logs for the us-east-1 region. Some global AWS services (e.g. Route53, IAM, STS, CloudFront) use this region. For details, check the CloudTrail Documentation

TrailScraper generated actions that aren’t IAM actions

This is totally possible. Unfortunately, there is no good, machine-readable documentation on how CloudTrail events map to IAM actions so TrailScraper is using heuristics to figure out the right actions. These heuristics likely don’t cover all special cases of the AWS world.

This is where you come in: If you find a special case that’s not covered by TrailScraper, please open a new issue or, even better, submit a pull request.

For more details, check out the contribution guide

Click thinks you are in an ASCII environment

Click will abort further execution because Python 3 was configured to use ASCII as encoding for the environment.

Set environment variables that describe your locale, e.g. :

export LC_ALL=de_DE.utf-8
export LANG=de_DE.utf-8

or

LC_ALL=C.UTF-8
LANG=C.UTF-8

For details, see http://click.pocoo.org/5/python3/#python-3-surrogate-handling

Changelog

This changelog contains a loose collection of changes in every release including breaking changes to the API.

The format is based on Keep a Changelog

0.4.3

Fixed

• Made trailscraper timezone-aware. Until now, trailscraper implicitly treated everything as UTC, meaning relative timestamps (e.g. now, two hours ago) didn’t work properly when filtering logfiles to download or records to generate from. (#39)

Added

• New command trailscraper last-event-timestamp to get the last known event timestamp.
• New flag trailscraper download --wait to wait until events for the specified timeframe are found. Useful if you are waiting for CloudTrail to ship logs for a recent operation.

0.4.2

Fixed

• Fixed various special cases in mapping CloudTrail to IAM Actions:
  • API Gateway
  • App Stream 2
  • DynamoDB Streams
  • Lex
  • Mechanical Turk
  • S3
  • STS
  • Tagging

0.4.1

Fixed

• Ignore record files that can’t be read (e.g. not valid GZIP) in Python 2.7 (was only working in Python 3.* before)
• Fixed permissions generated for services that include the API version date (e.g. Lambda, CloudFront) (#20)

0.4.0

Added

• Support for CloudTrail lookup_events API that allows users to generate a policy without downloading logs from an S3 bucket. Note that this API only returns `“create, modify, and delete API calls” <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events-supported-services.html>`__
• trailscraper download now supports --from and --to flags to specify the timeframe that should be downloaded. Accepts precise (e.g. “2017-10-12”) and relative (e.g. “-2days”) arguments.
• trailscraper generate-policy now supports --from and --to to filter events to consider for the generated policy. Accepts precise (e.g. “2017-10-12”) and relative (e.g. “-2days”) arguments.
• Performance optimizations: generate-policy only reads logfiles for the timeframe requested
• Added --version command line argument

Changed

• Set more flexible dependencies

Removed

• Removed --past-days parameter in trailscraper download. Was replaced by --from and --to (see above)

Fixed

• Ignore record files that can’t be read (e.g. not valid GZIP)

0.3.0

Added

• Support for Python >= 2.7

Changed

• Do not download CloudTrail Logs from S3 if they already exist in the target folder (#9)
• Removed dependency on fork of the awacs-library to simplify installation and development

Fixed

• Bug that led to policy-statements with the same set of actions not being combined properly in some cases (#7)

0.2.0

Added

• Basic filtering for role-arns when generating policy (#3)

0.1.0

Initial Release

Added

• Basic feature to download CloudTrail Logs from S3 for certain accounts and timeframe
• Basic feature to generate IAM Policies from a set of downloaded CloudTrail logs