Skip to main content

A tool for scan policies using AWS access Analyzer API and create reports

Project description

Validate AWS policies

This package scan AWS SCP policies and create report in HTML format.

Pre-Requirements

Setup AWS Cli profile for interacting with IAM access analyzer API using IAM or SSO credentials.

Requirements

  • python >= 3.8

Install

$ pip install --upgrade validate-aws-policies

From AWS CodeArtifacts repository

You must have a user into AWS account Sophos Organization, it could be for projects, products, or IT internal Organizations. Before create AWS CLI profile using AWS IAM Identity Center (SSO) or IAM.

  1. Configure your pip cli for download package from private CodeArtifacts repository
$ aws codeartifact login --tool pip --repository <repository_name> --domain <domain> --domain-owner <123456789012>  --profile <profile_name> --region <repository_region>
$ pip install --upgrade validate-aws-policies

From Azure Artifacts repository

Project setup

Ensure you have installed the latest version of the Azure Artifacts keyring from the "Get the tools" menu.

If you don't already have one, create a virtualenv using these instructions from the official Python documentation. Per the instructions, "it is always recommended to use a virtualenv while developing Python applications."

Add a pip.ini (Windows) or pip.conf (Mac/Linux) file to your virtualenv

[global]
index-url=https://pkgs.dev.azure.com/<organizations>/.../_packaging/.../pypi/simple/

Instructions

validate-aws-policies -h
usage: validate-aws-policies [-h] [-c] [-u UPLOAD_REPORT] [-b] [-d DIRECTORY_POLICIES_PATH] [-p PROFILE] [-z] [-cp] [-v]

options:
  -h, --help            show this help message and exit
  -c, --ci              Run into pipeline if it's present
  -u UPLOAD_REPORT, --upload_report UPLOAD_REPORT
                        Upload reports to s3 bucket
  -b, --bucket_name     Use this flag for setting the bucket tool if --upload_report is present.
  -d DIRECTORY_POLICIES_PATH, --directory_policies_path DIRECTORY_POLICIES_PATH
                        Path where Policies are defined in json format
  -p PROFILE, --profile PROFILE
                        AWS cli profile for Access Analyzer Api
  -z, --zip_reports     Set in True if you want to create a zip file for reports
  -cp, --create_pdf_reports
                        Set it if you want to create a pdf report, this need wkhtmltopdf file for reports
  -v, --version         Print the package version

Examples

validate-aws-policies -d project_configurations/policies/ -p sh-devsecops

Example_validate_pol

The previous command create a report in the current folder with the syntax name: AccessAnalyzerReport_2023-06-26 155116.844676.html. For example:

report

Extras

Enable autocomplete

Argcomplete provides easy, extensible command line tab completion of arguments for your Python application.

It makes two assumptions:

  • You’re using bash or zsh as your shell

  • You’re using argparse to manage your command line arguments/options

Argcomplete is particularly useful if your program has lots of options or subparsers, and if your program can dynamically suggest completions for your argument/option values (for example, if the user is browsing resources over the network). Run:

activate-global-python-argcomplete

and to make sure that bash knows about this script, you use

echo 'eval "$(register-python-argcomplete validate-aws-policies)"' >> ~/.bashrc
source ~/.bashrc

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

validate_aws_policies-3.1.1.tar.gz (269.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

validate_aws_policies-3.1.1-py3-none-any.whl (28.4 kB view details)

Uploaded Python 3

File details

Details for the file validate_aws_policies-3.1.1.tar.gz.

File metadata

  • Download URL: validate_aws_policies-3.1.1.tar.gz
  • Upload date:
  • Size: 269.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for validate_aws_policies-3.1.1.tar.gz
Algorithm Hash digest
SHA256 042cb5ec7d2a328980b3d27b755b097eed965527c9ef4e2cc039ce65cd2e1d31
MD5 9d4545f913fa9ca7864880e01111bbc5
BLAKE2b-256 54f431cada8f8bb20e0b90724e2186cdef8f7f77fb779bf1ef0434941c28e63f

See more details on using hashes here.

Provenance

The following attestation bundles were made for validate_aws_policies-3.1.1.tar.gz:

Publisher: publish.yml on velez94/validate-aws-policies

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file validate_aws_policies-3.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for validate_aws_policies-3.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 de9a69a942770fe89be0f858f1aead1b39d901b423cc0f08d5d5df086fa26a46
MD5 84326222be9a939e02e72a1d4d369d1a
BLAKE2b-256 d696903e26220649825b8f872beb60b61cc65cd32d0ad7f8fdc4e245c91a06f8

See more details on using hashes here.

Provenance

The following attestation bundles were made for validate_aws_policies-3.1.1-py3-none-any.whl:

Publisher: publish.yml on velez94/validate-aws-policies

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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