aws-azure-login

1.0.0 • Public • Published

view on npm npm module downloads per month

aws-azure-login

If your organization uses Azure Active Directory to provide SSO login to the AWS console, then there is no easy way to use the AWS CLI. This tool fixes that. It lets you use the normal Azure AD login (including MFA) from a command line to create a federated AWS session and places the temporary credentials in the proper place for the AWS CLI.

Installation

You should first install the AWS CLI using the installation instructions. Then install Node.js. Finally, install aws-azure-login:

npm install -g aws-azure-login

Usage

Configuration

Before using aws-azure-login, you should first configure the AWS CLI. To configure the default profile, run:

aws configure

When prompted for credentials just leave the fields blank. Then configure the aws-azure-login client:

aws-azure-login --configure

You'll need your Azure Tenant ID and the App ID URI. To configure a named profile, use the --profile flag.

aws configure --profile foo
aws-azure-login --configure --profile foo

Logging In

Once the CLIs are configured, you can log in. For the default profile, just run:

aws-azure-login

You will be prompted for your username and password. If MFA is required you'll also be prompted for a verification code. To log in with a named profile:

aws-azure-login --profile foo

Alternatively, you can set the AWS_PROFILE environmental variable to the name of the profile.

Now you can use the AWS CLI as usual!

If you are logging in on an operating system with a GUI, you can log in using the actual Azure web form instead of the CLI:

aws-azure-login --mode gui

Logging in with GUI mode is likely to be much more reliable.

Getting Your Tenant ID and App ID URI

Your Azure AD system admin should be able to provide you with your Tenant ID and App ID URI. If you can't get it from them, you can scrape it from a login page from the myapps.microsoft.com page.

  1. Load the myapps.microsoft.com page.
  2. Click the chicklet for the login you want.
  3. In the window the pops open quickly copy the login.microsoftonline.com URL. (If you miss it just try again. You can also open the developer console with nagivation preservation to capture the URL.)
  4. The GUID right after login.microsoftonline.com/ is the tenant ID.
  5. Copy the SAMLRequest URL param.
  6. Paste it into a URL decoder (like this one) and decode.
  7. Paste the decoded output into the a SAML deflated and encoded XML decoder (like this one).
  8. In the decoded XML output the value of the Issuer tag is the App ID URI.

How It Works

The Azure login page uses JavaScript, which requires a real web browser. To automate this from a command line, aws-azure-login uses Puppeteer, which automates a real Chromium browser. It loads the Azure login page behind the scenes, populates your username and password (and MFA token), parses the SAML assertion, uses the AWS STS AssumeRoleWithSAML API to get temporary credentials, and saves these in the CLI credentials file.

Troubleshooting

The nature of browser automation with Puppeteer means the solution is bit brittle. A minor change on the Microsoft side could break the tool. If something isn't working, you can fall back to GUI mode (above). To debug an issue, you can run in debug mode (--mode debug) to see the GUI while aws-azure-login tries to populate it. You can also have the tool print out more detail on what it is doing to try to do in order to diagnose. aws-azure-login uses the Node debug module to print out debug info. Just set the DEBUG environmental variable to 'aws-azure-login'. On Linux/OS X:

DEBUG=aws-azure-login aws-azure-login

On Windows:

set DEBUG=aws-azure-login
aws-azure-login

Support for Other Authentication Providers

Obviously, this tool only supports Azure AD as an identity provider. However, there is a lot of similarity with how other logins with other providers would work (especially if they are SAML providers). If you are interested in building support for a different provider let me know. It would be great to build a more generic AWS CLI login tool with plugins for the various providers.

Keywords

none

Install

npm i aws-azure-login@1.0.0

Version

1.0.0

License

MIT

Last publish

Collaborators

  • kennethaasan
  • cowboygneox
  • mohamedasan