PyPI 官网下载 | gimme%20aws%20creds-2.3.1.tar.gz

# Gimme AWS Creds [![][license img]][license] [](https://travis-ci.org/Nike-Inc/gimme-aws-creds) gimme-aws-creds is a CLI that utilizes an [Okta](https://www.okta.com/) IdP via SAML to acquire temporary AWS credentials via AWS STS. Okta is a SAML identity provider (IdP), that can be easily set-up to do SSO to your AWS console. Okta does offer an [OSS java CLI]((https://github.com/oktadeveloper/okta-aws-cli-assume-role)) tool to obtain temporary AWS credentials, but I found it needs more information than the average Okta user would have and doesn't scale well if have more than one Okta App. With gimme-aws-creds all you need to know is your username, password, Okta url and MFA token, if MFA is enabled. gimme-aws-creds gives you the option to select which Okta AWS application and role you want credentials for. Alternatively, you can pre-configure the app and role name by passing -c or editing the config file. This is all covered in the usage section. ## Prerequisites [Okta SAML integration to AWS using the AWS App](https://help.okta.com/en/prod/Content/Topics/Miscellaneous/References/OktaAWSMulti-AccountConfigurationGuide.pdf) Python 3 ### Optional [Gimme-creds-lambda](https://github.com/Nike-Inc/gimme-aws-creds/tree/master/lambda) can be used as a proxy to the Okta APIs needed by gimme-aws-creds. This removes the requirement of an Okta API key. Gimme-aws-creds authenticates to gimme-creds-lambda using OpenID Connect and the lambda handles all interactions with the Okta APIs. Alternately, you can set the `OKTA_API_KEY` environment variable and the `gimme_creds_server` configuration value to 'internal' to call the Okta APIs directly from gimme-aws-creds. ## Installation This is a Python 3 project. Install/Upgrade from PyPi: ```bash pip3 install --upgrade gimme-aws-creds ``` __OR__ Install/Upgrade the latest gimme-aws-creds package direct from GitHub: ```bash pip3 install --upgrade git+git://github.com/Nike-Inc/gimme-aws-creds.git ``` __OR__ Install the gimme-aws-creds package if you have already cloned the source: ```bash python3 setup.py install ``` __OR__ Build the docker image locally: ```bash docker build -t gimme-aws-creds . ``` To make it easier you can also create an alias for the gimme-aws-creds command with docker: ```bash # make sure you have the "~/.okta_aws_login_config" locally first! touch ~/.okta_aws_login_config && \ alias gimme-aws-creds="docker run -it --rm \ -v ~/.aws/credentials:/root/.aws/credentials \ -v ~/.okta_aws_login_config:/root/.okta_aws_login_config \ gimme-aws-creds" ``` With this config, you will be able to run further commands seamlessly! ## Configuration To set-up the configuration run: ```bash gimme-aws-creds --action-configure ``` You can also set up different Okta configuration profiles, this useful if you have multiple Okta accounts or environments you need credentials for. You can use the configuration wizard or run: ```bash gimme-aws-creds --action-configure --profile profileName ``` A configuration wizard will prompt you to enter the necessary configuration parameters for the tool to run, the only one that is required is the `okta_org_url`. The configuration file is written to `~/.okta_aws_login_config`, but you can change the location with the environment variable `OKTA_CONFIG`. - conf_profile - This sets the Okta configuration profile name, the default is DEFAULT. - okta_org_url - This is your Okta organization url, which is typically something like `https://companyname.okta.com`. - okta_auth_server - [Okta API Authorization Server](https://help.okta.com/en/prev/Content/Topics/Security/API_Access.htm) used for OpenID Connect authentication for gimme-creds-lambda - client_id - OAuth client ID for gimme-creds-lambda - gimme_creds_server - URL for gimme-creds-lambda - 'internal' for direct interaction with the Okta APIs (`OKTA_API_KEY` environment variable required) - 'appurl' to set an aws application link url. This setting removes the need of an OKTA API key. - write_aws_creds - True or False - If True, the AWS credentials will be written to `~/.aws/credentials` otherwise it will be written to stdout. - cred_profile - If writing to the AWS cred file, this sets the name of the AWS credential profile. - The reserved word `role` will use the name component of the role arn as the profile name. i.e. arn:aws:iam::123456789012:role/okta-1234-role becomes section [okta-1234-role] in the aws credentials file - The reserved word `acc-role` will use the name component of the role arn prepended with account number (or alias if `resolve_aws_alias` is set to y) to avoid collisions, i.e. arn:aws:iam::123456789012:role/okta-1234-role becomes section [123456789012-okta-1234-role], or if `resolve_aws_alias` [<my alias>-okta-1234-role] in the aws credentials file - If set to `default` then the temp creds will be stored in the default profile - Note: if there are multiple roles, and `default` is selected it will be overwritten multiple times and last role wins. The same happens when `role` is selected and you have many accounts with the same role names. Consider using `acc-role` if this happens. - aws_appname - This is optional. The Okta AWS App name, which has the role you want to assume. - aws_rolename - This is optional. The ARN of the role you want temporary AWS credentials for. The reserved word 'all' can be used to get and store credentials for every role the user is permissioned for. - aws_default_duration = This is optional. Lifetime for temporary credentials, in seconds. Defaults to 1 hour (3600) - app_url - If using 'appurl' setting for gimme_creds_server, this sets the url to the aws application configured in Okta. It is typically something like <https://something.okta[preview].com/home/amazon_aws/app_instance_id/something> - okta_username - use this username to authenticate - preferred_mfa_type - automatically select a particular device when prompted for MFA: - push - Okta Verify App push - token:software:totp - OTP using the Okta Verify App - token:hardware - OTP using hardware like Yubikey - call - OTP via Voice call - sms - OTP via SMS message - resolve_aws_alias - y or n. If yes, gimme-aws-creds will try to resolve AWS account ids with respective alias names (default: n). This option can also be set interactively in the command line using `-r` or `--resolve` parameter - include_path - (optional) Includes full role path to the role name in AWS credential profile name. (default: n). If `y`: `<acct>-/some/path/administrator`. If `n`: `<acct>-administrator` - remember_device - y or n. If yes, the MFA device will be remembered by Okta service for a limited time. This option can also be set interactively in the command line using `-m` or `--remember-device` - output_format - `json` or `export`, determines default credential output format, can be also specified by `--output-format FORMAT` and `-o FORMAT`. ## Configuration File The config file follows a [configfile](https://docs.python.org/3/library/configparser.html) format. By default, it is located in $HOME/.okta_aws_login_config Example file: ```ini [myprofile] client_id = myclient_id ``` Configurations can inherit from other configurations to share common configuration parameters. ```ini [my-base-profile] client_id = myclient_id [myprofile] inherit = my-base-profile aws_rolename = my-role ``` ## Usage **If you are not using gimme-creds-lambda nor using appurl settings, make sure you set the OKTA_API_KEY environment variable.** After running --action-configure, just run gimme-aws-creds. You will be prompted for the necessary information. ```bash $ ./gimme-aws-creds Username: [email protected] Password for [email protected]: Authentication Success! Calling Gimme-Creds Server... Pick an app: [ 0 ] AWS Test Account [ 1 ] AWS Prod Account Selection: 1 Pick a role: [ 0 ]: OktaAWSAdminRole [ 1 ]: OktaAWSReadOnlyRole Selecti