Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 2.39 KB

README.md

File metadata and controls

83 lines (52 loc) · 2.39 KB
Raw

cfn-permission-checker

cfn-permission-checker is a command-line tool that extracts CloudFormation events from CloudTrail logs to verify the permissions required for deployment.

Features

  • Extract and analyze CloudFormation deployment events from CloudTrail logs
  • Filter events by time range
  • Display specific properties of events
  • Help troubleshoot permission issues and audit CloudFormation deployments

Usage

Displaying Events

To display events from 2 hours ago:

cfn-permission-checker filter --from '2h'

To display specific properties of events:

cfn-permission-checker filter --from '2h' -p 'requestParameters'

Setup

Prerequisites

  1. AWS SAM CLI - Required to deploy the CloudTrail stack
  2. Rye - Package manager for Python projects

Install AWS SAM CLI

To enable CloudTrail, you need to deploy an AWS SAM stack. Please refer to the official AWS SAM CLI documentation for installation instructions.

Deploy the CloudTrail Stack

cd sam
make

Install Rye

Install Rye by following the official Rye installation guide.

Install cfn-permission-checker

Once Rye is installed, you can install cfn-permission-checker using the following command:

rye tools install --git 'https://github.com/ajisaka/cfn-permission-checker#subdirectory=app/' cfn-permission-checker

This will install the cfn-permission-checker command-line tool.

Examples

Here are some additional examples of how to use cfn-permission-checker:

# Filter events from the last 24 hours
cfn-permission-checker filter --from '24h'

# Display only the 'eventName' and 'userIdentity' properties
cfn-permission-checker filter --from '1d' -p 'eventName' -p 'userIdentity'

# Save output to a JSON file
cfn-permission-checker filter --from '1w' > cfn_events.json

Troubleshooting

If you encounter any issues during installation or usage, please check the following:

  1. Ensure you have the latest versions of AWS SAM CLI and Rye installed.
  2. Verify that your AWS credentials are properly configured.
  3. Check the CloudTrail logs to ensure events are being recorded correctly.

For more detailed information, please refer to the project's GitHub repository or open an issue if you encounter any problems.