Skip to main content

IAM AWS Permissions Evaluator

Project description

iam-ape

IAM APE

IAM AWS Policy Evaluator

APE takes all of your AWS IAM policies attached to a User, Group, or Role object, and presents you with a single policy, summarizing all of their actual permissions. Taking into account permissions, denials, inherited permissions and permission boundaries!

Setup

Requires Python >= 3.9

From PyPI

  1. Run pip install iam-ape
  2. Run iam-ape

From source

  1. Clone this repository
  2. Change directory to iam_ape
  3. Run python -m pip install .
  4. Run iam-ape

Usage

Prerequisite

Have aws-cli installed on your machine and a profile with aws:GetAccountAuthorizationDetails permissions.
Alternatively, have the json output from aws iam get-account-authorization-details saved to a file.

Before your first run, it's recommended to run iam-ape --update - this updates APE's database with the most current list of all available AWS IAM actions.

The simplest way to use iam-ape is to simply run iam-ape --arn <your-arn-here>
APE will then attempt to fetch the account authorization details, evaluate your permissions, and output a neatly formatted policy to stdout

The --input flag:

If you don't want to fetch the report every time, you can run aws iam get-account-authorization-details by yourself and save the output to a json file. You can then pass that output to APE using the --input flag.

Additional flags:

-o, --output write the output to file instead of stdout
-f, --format (clean|verbose) output the policy in clean, AWS policy-like JSON format, or a long verbose JSON containing all specific actions allowed to the entity, the denied actions, and the ineffective (allowed in one place, denied in another) permissions.
-p, --profile the AWS CLI profile to use when fetching Account Authorization Details
-u, --update update APE's database with the most current list of all available AWS IAM actions
-v, --verbose set logging level to DEBUG

Important note: the policy created by this tool might not always be compliant with AWS's constraints. For example, if a user is granted ec2:AttachVolume access to arn:aws:ec2:* by one policy, but denied access to arn:aws:ec2:us-east-1:123456789012:instance/i-123456abc, the resulting policy statement will look like this:

{
    "Action": "ec2:AttachVolume",
    "Resource": "arn:aws:ec2:*",
    "NotResource": "arn:aws:ec2:us-east-1:123456789012:instance/i-123456abc"
}

This statement, having both Resource and NotResource together, is not supported by AWS but makes more sense when trying to understand what the effective permissions of a user are.

Roadmap

  • Add an option to supply a resource policy and evaluate whether the entity has access to that resource
  • Support additional permissions inherited by Role assumption
  • Support SCP Policies

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iam_ape-1.0.1.tar.gz (272.8 kB view details)

Uploaded Source

Built Distribution

iam_ape-1.0.1-py3-none-any.whl (272.1 kB view details)

Uploaded Python 3

File details

Details for the file iam_ape-1.0.1.tar.gz.

File metadata

  • Download URL: iam_ape-1.0.1.tar.gz
  • Upload date:
  • Size: 272.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.28.2 requests-toolbelt/0.9.1 tqdm/4.64.1 CPython/3.9.16

File hashes

Hashes for iam_ape-1.0.1.tar.gz
Algorithm Hash digest
SHA256 b3d60604eafa147e5b69233895879df17559b653275b7d0bce53c0c5c02a936e
MD5 e937ca35c7993a062370b0c47cd39930
BLAKE2b-256 756bb883a5dcf133fcceaa3a7e129c341b56bbf83dd9d4aaf8fae89cc2289034

See more details on using hashes here.

File details

Details for the file iam_ape-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: iam_ape-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 272.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.28.2 requests-toolbelt/0.9.1 tqdm/4.64.1 CPython/3.9.16

File hashes

Hashes for iam_ape-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7202cc5c54e0775cf955c9b7f951b1ed901a61fc3089517609461aa7c87578c5
MD5 795e44f5ee4647000fa77e4cffe92f39
BLAKE2b-256 d099b4a10b596f52795f56bda58c0d68f9789d2e6ee8e125c3f99203b215b2c9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page