Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/benkehoe/aws-sso-util

Smooth out the rough edges of AWS SSO (temporarily, until AWS makes it better).
https://github.com/benkehoe/aws-sso-util

aws aws-sso cloudformation command-line

Last synced: 3 months ago
JSON representation

Smooth out the rough edges of AWS SSO (temporarily, until AWS makes it better).

Lists

README 

        
# aws-sso-util

## Making life with AWS IAM Identity Center (formerly AWS SSO) a little easier



[IAM Identity Center](https://aws.amazon.com/single-sign-on/) (formerly AWS SSO) has some rough edges, and `aws-sso-util` is here to smooth them out, hopefully temporarily until AWS makes it better.



You can read a primer on IAM Identity Center [here](docs/primer.md).

Note that because it was originally called AWS SSO, field names in configuration and APIs will continue to have "SSO" in them, rather than Identity Center.



`aws-sso-util` contains utilities for the following:

* Configuring `.aws/config`

* Logging in/out

* AWS SDK support

* Looking up identifiers

* CloudFormation



`aws-sso-util` supersedes `aws-sso-credential-process`, which is still available in its original form [here](https://github.com/benkehoe/aws-sso-credential-process).

Read the updated docs for `aws-sso-util credential-process` [here](docs/credential-process.md).



## Programmatic interaction with Identity Center



`aws-sso-util` provides command-line utilities. The underlying Python library for Identity Center authentication is [`aws-sso-lib`](lib/README.md), which has useful functions like interactive login, creating a boto3 session for specific a account and role, and the programmatic versions of the `lookup` functions in `aws-sso-util`. See the documentation [here](lib/README.md).



## Quickstart



0. It's a good idea to [install the AWS CLI v2](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html) (which has Identity Center support).



1. I recommend you install [`pipx`](https://pipxproject.github.io/pipx/), which installs the tool in an isolated virtualenv while linking the script you need.



Mac [and Linux](https://docs.brew.sh/Homebrew-on-Linux):

```bash

brew install pipx

pipx ensurepath

```



Other:

```bash

python3 -m pip install --user pipx

python3 -m pipx ensurepath

```



2. Install

```bash

pipx install aws-sso-util

```



3. Learn

```bash

aws-sso-util --help

```



4. Autocomplete



`aws-sso-util` uses [click](https://click.palletsprojects.com/en/8.0.x/), which supports autocompletion.

The details of enabling shell completion with click vary by shell ([instructions here](https://click.palletsprojects.com/en/8.0.x/shell-completion/)), but here is an example for `.bashrc` that updates the completion script in the background.



```bash

_AWS_SSO_UTIL_COMPLETE_SCRIPT_DIR=~/.local/share/aws-sso-util

_AWS_SSO_UTIL_COMPLETE_SCRIPT=$_AWS_SSO_UTIL_COMPLETE_SCRIPT_DIR/complete.sh

if which aws-sso-util > /dev/null; then

  mkdir -p $_AWS_SSO_UTIL_COMPLETE_SCRIPT_DIR

  ({ _AWS_SSO_UTIL_COMPLETE=bash_source aws-sso-util > $_AWS_SSO_UTIL_COMPLETE_SCRIPT.tmp ;

    mv $_AWS_SSO_UTIL_COMPLETE_SCRIPT.tmp $_AWS_SSO_UTIL_COMPLETE_SCRIPT; } &)

  if [ -f $_AWS_SSO_UTIL_COMPLETE_SCRIPT ]; then

    source $_AWS_SSO_UTIL_COMPLETE_SCRIPT

  fi

fi

```



## Configuring `.aws/config`



Read the full docs for `aws-sso-util configure` and `aws-sso-util roles` [here](docs/configure.md).



The AWS CLI and most AWS SDKs support Identity Center configuration in `~/.aws/config`; each profile specifies the account and role (the *Identity Center* role, also known as a Permission Set, which is distinct from the corresponding IAM role within the given account) to use.

A profile configured for Identity Center looks like this:



```ini

[profile my-sso-profile]

sso_start_url = https://example.awsapps.com/start

sso_region = us-east-1 # the region Identity Center is configured in

sso_account_id = 123456789012

sso_role_name = MyRoleName

region = us-east-2 # the region to use for AWS API calls

```



You can view the roles you have available to you with `aws-sso-util roles`, which you can use to configure your profiles in [`~/.aws/config`](https://ben11kehoe.medium.com/aws-configuration-files-explained-9a7ea7a5b42e), or you can use `aws configure sso` in the AWS CLI v2, but `aws-sso-util` also provides functionality to directly configure profiles for you.



`aws-sso-util configure` has two subcommands, `aws-sso-util configure profile` for configuring a single profile, and `aws-sso-util configure populate` to add _all_ your permissions as profiles, in whatever region(s) you want (with highly configurable profile names).



You probably want to set the environment variables `AWS_DEFAULT_SSO_START_URL` and `AWS_DEFAULT_SSO_REGION`, which will inform these commands of your Identity Center start url and region (that is, the region that you've configured Identity Center in), so that you don't have to pass them in as parameters every time.



`aws-sso-util configure profile` takes a profile name and prompts you with the accounts and roles you have access to, to configure that profile.



`aws-sso-util configure populate` takes one or more regions, and generates a profile for each account+role+region combination.

The profile names are completely customizable.



## Logging in and out



Read the full docs for `aws-sso-util login` and `aws-sso-util logout` [here](docs/login.md).



A problem with [`aws sso login`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sso/login.html) is that it's required to operate on a profile, that is, you have to tell it to log in to Identity Center *plus some account and role.*

But the whole point of Identity Center is that you log in once for *many* accounts and roles.

You could have a particular account and role set up in your default profile, but I prefer not to have a default profile so that I'm always explicitly selecting a profile and never accidentally end up in the default by mistake.

`aws-sso-util login` solves this problem by letting you *just log in* without having to think about where you'll be using those credentials.



## Running one-off commands as a specific account and role



Read the full docs for `aws-sso-util run-as` [here](docs/run-as.md).



In general, in the Identity Center world, you shouldn't be trying to manually set credentials in an environment, nor thinking about "logging in" to a particular account and role.

You log in to *Identity Center* once, and then *use* accounts and roles with that session.

You should orient yourself around configuration profiles—use [`aws-sso-util configure populate`](configure.md) to set up profiles for every account and role you have access to, and then use either the `--profile` argument to tell a command to use a specific profile, or set the `AWS_PROFILE` environment variable to have all commands your shell use a particular profile unless they are told otherwise ([here's a shell function to help manage that env var](https://gist.github.com/benkehoe/0d2985e56059437e489314d021be3fbe)).



However, there are times when it's useful to be able to run a command as a specific account and role, without needing a profile configured for it—or without knowing the profile name corresponding to the account and role.

For this purpose, there's `aws-sso-util run-as`.

Think of it as the shell equivalent to [`aws_sso_lib.get_boto3_session()`](lib/README.md#get_boto3_session).



## Opening the AWS console in a browser



> :warning: This feature is in beta and is subject to change without a compatibility version bump.



Read the full docs for `aws-sso-util console` [here](docs/console.md).



You can open the AWS console in the browser for a given account and role with `aws-sso-util console`, including going to a specific page in the console.

This uses the [federated sign-in](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html) process.

It also allows for the launch configuration to be packaged up as a token, which makes it easier to share between users.



## Debugging issues



Read the full docs for `aws-sso-util check` [here](docs/check.md).



`aws-sso-util check` helps diagnose configuration and access issues.

It can be used to help administrators debug user issues, or as validation in shell scripting.

It validates that `aws-sso-util` can find an Identity Center instance configuration, and additionally whether the user has access to a particular account and/or role.



## Adding Identity Center support to AWS SDKs



The credential process is added automatically (by default) by the `aws-sso-util configure` commands; you only need to read this section if you're not using that or want to understand it more fully.

Read the full docs for `aws-sso-util credential-process` [here](docs/credential-process.md).



Not all AWS SDKs have support for Identity Center (which will change eventually).

However, they all have support for `credential_process`, which allows an external process to provide credentials.

`aws-sso-util credential-process` uses this to allow these SDKs to get credentials from Identity Center.



NOTE: if you test it out with your favorite script or application and get something like `NoCredentialProviders: no valid providers in chain.`, you may need to set the environment variable `AWS_SDK_LOAD_CONFIG=1`



## Administrators: Looking up identifiers and assignments



Read the full docs for `aws-sso-util admin lookup` and `aws-sso-util admin assignments` [here](docs/lookup.md).



When you're creating assignments through the API or CloudFormation, you're required to use identifiers like the instance ARN, the principal ID, etc.

These identifiers aren't readily available through the console, and the principal IDs are not the IDs you're familiar with.

`aws-sso-util admin lookup` allows you to get these identifers, even en masse.



There is no simple API for retrieving all assignments or even a decent subset.

The current best you can do is [list all the users with a particular PermissionSet on a particular account](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_ListAccountAssignments.html).

`aws-sso-util admin assignments` takes the effort out of looping over the necessary APIs.



## Administrators: CloudFormation support



You'll want to read the full docs [here](docs/cloudformation.md).



Identity Center's CloudFormation support currently only includes [`AWS::SSO::Assignment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-assignment.html), which means for every combination of principal (group or user), permission set, and target (AWS account), you need a separate CloudFormation resource.

Additionally, Identity Center does not support OUs as targets, so you need to specify every account separately.



Obviously, this gets verbose, and even an organization of moderate size is likely to have tens of thousands of assignments.

`aws-sso-util admin cfn` provides two mechanisms to make this concise.



I look forward to discarding this part of the tool once there are two prerequisites:

1. OUs as targets for assignments

2. An `AWS::SSO::AssignmentGroup` resource that allows specifications of multiple principals, permission sets, and targets, and performs the combinatorics directly.



### CloudFormation Macro

`aws-sso-util` defines a resource format for an AssignmentGroup that is a combination of multiple principals, permission sets, and targets, and provides a CloudFormation Macro you can deploy that lets you use this resource in your templates.



### Client-side generation



I am against client-side generation of CloudFormation templates, but if you don't want to trust this 3rd party macro, you can generate the CloudFormation templates directly.



`aws-sso-util admin cfn` takes one or more input files, and for each input file, generates a CloudFormation template and potentially one or more child templates.

These templates can then be packaged and uploaded using [`aws cloudformation package`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/package.html) or [the SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html), for example.



The input files can either be templates using the Macro (using the `--macro` flag), or somewhat simpler configuration files using a different syntax.

These configuration files can define permission sets inline, have references that turn into template parameters, and you can provide a base template that the resulting resources are layered on top of.