Skip to main content

probator-auditor-iam

Please open issues in the Probator repository

Description

This auditor validates and applies IAM policies for AWS Accounts.

Configuration Options

Option name Default Value Type Description
enabled False bool Enable the IAM roles and auditor
interval 30 int How often the auditor executes, in minutes
manage_roles True bool Enable management of IAM roles
roles True string JSON document with roles to push to accounts. See below for example
delete_inline_policies False bool Delete inline policies from existing roles
hostname None string Git server hostname
repository None string Path of the Git repository
authentication_type oauth-token string Authentication type
oauth_token None string OAuth2 token. Required if authentication_type is oauth-token
username None string Git username. Required if authentication_type is username-password
password None string Git password./Required if authentication_type is username-password
max_session_duration 8 string IAM Assume Role MaxSessionDuration (in hours)
disable_ssl_verify False bool Disable SSL certificate validation

roles configuration

The roles setting allows you to configure roles to create and manage on all accounts enabled in Probator. The JSON document is structured as a dictionary, with the top-level key being the name of the role, and the dictionary value has two keys; trust and policies

trust

The trust setting must be a valid IAM Assume Role Policy Document. If the trust key is an empty object ({}), null or not set, the default trust document is provided.

policies

The policies key contains a list of IAM policy names to attach to the role. These policies must exist within the account before running the auditor, ideally being created by the auditor as well.

Example document

The example below shows how one can manage the role probator assumes for monitoring and auditing in your accounts

{
    "probator_role": {
        "trust": {
            "Version": "2012-10-17",
            "Statement": [
                {
                    "Sid": "",
                    "Effect": "Allow",
                    "Principal": {
                        "AWS": "arn:aws:iam::123456789012:role/probator-instance-role",
                        "Service": "ec2.amazonaws.com"
                    },
                    "Action": "sts:AssumeRole"
                }
            ]
        },
        "policies": [
            "ProbatorAccess"
        ]
    }
}

This project is based on the work for Cloud Inquisitor by Riot Games

Release files for probator-auditor-iam 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for probator-auditor-iam 1.0.2
File Size Uploaded
probator-auditor-iam-1.0.2.tar.gz 9.1 kB Details

Release files / probator-auditor-iam-1.0.2.tar.gz

Download URL probator-auditor-iam-1.0.2.tar.gz
Size 9.1 kB
Tags Source
SHA-256 checksum
How to use checksums
628cc19a375df775783a9b59d177b65f7d7717d3b571820ae05476c03d0bbe97
BLAKE2b-256 checksum
How to use checksums
5eb553bd6b9d880054d02bf05ee5010a96ca8562125bfc9b7c3571047cde1f6e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.7.2

Release history Release notifications | RSS feed

This release

1.0.2 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page