switch-profile 0.1.1 → 0.1.2

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.1.2](https://github.com/nicolasdao/switch-profile/compare/v0.1.1...v0.1.2) (2022-05-14)
+
+
+### Bug Fixes
+
+* Multiple SSO profiles are not supported. It only uses one. ([b9d9d03](https://github.com/nicolasdao/switch-profile/commit/b9d9d03b4edfa048cc157376222378513138e257))
+
 ### [0.1.1](https://github.com/nicolasdao/switch-profile/compare/v0.1.0...v0.1.1) (2021-08-03)
 
 

package/README.md

@@ -15,7 +15,26 @@ This utility also supports creating new AWS profiles, including SSO profiles as
 >	- `AWS_SECRET_ACCESS_KEY`
 >	- `AWS_SESSION_TOKEN`
 
-# Why using this utility?
+# Table of contents
+
+> * [Extra features](#extra-features)
+> * [FAQ](#faq)
+>	- [Why using this utility?](#why-using-this-utility)
+>	- [How to create a new SSO profile?](#how-to-create-a-new-sso-profile)
+> * [Troubleshooting](#troubleshooting)
+>	- [`invalid_grant: Invalid grant provided`](#invalid_grant-invalid-grant-provided)
+>	- [`Error: Fail to get credentials for profile ... Error loading SSO Token...`](#error-fail-to-get-credentials-for-profile--error-loading-sso-token)
+> * [License](#license)
+
+# Extra features
+
+The `More options` supports the following:
+- `Create profile`: Helps create both a standard or AWS SSO profile.
+- `Delete profiles`: Helps cleaning one or many profiles.
+- `Refresh default profile`: Helps refreshing the current default profile if it has expired (e.g., SSO profile). This option only appears when the default profile has expired.
+
+# FAQ
+## Why using this utility?
 
 `switch-profile` was originally created to refresh short-lived AWS SSO profiles in the terminal and set them as default. Indeed, as of 2021, the only two ways to set up a short-lived SSO profile as default in the terminal are:
 - Manually paste the short-lived credentials in the terminal:
@@ -31,12 +50,22 @@ The issue with the first method is that you have to repeat it every hour, which
 
 `switch-profile` aims to solve those issues by making setting any profile as `default` trivial. 
 
-# Extra features
+## How to create a new SSO profile?
 
-The `More options` supports the following:
-- `Create profile`: Helps create both a standard or AWS SSO profile.
-- `Delete profiles`: Helps cleaning one or many profiles.
-- `Refresh default profile`: Helps refreshing the current default profile if it has expired (e.g., SSO profile). This option only appears when the default profile has expired.
+1. `npx switch-profile`
+2. Select `More options`, then `Create profile`.
+3. Answer all the questions.
+
+# Troubleshooting
+## `invalid_grant: Invalid grant provided`
+
+If this error occurs during a [profile creation step](#how-to-create-a-new-sso-profile), this is most likely due to an incorrect SSO region. AWS SSO is region specific. This error occurs if an incorrect region is specified during the [profile creation step](#how-to-create-a-new-sso-profile).
+
+## `Error: Fail to get credentials for profile ... Error loading SSO Token...`
+
+This is probably due to a recent deletion of the `~/.aws/sso/cache` folder. This folder keeps track of the SSO profiles created on the local machine. Unfortunately in this case, there is no other option but to recreate all the SSO profiles manually:
+1. Execute `npx switch-profile`
+2. Select `More options`, then `Delete profiles`.
 
 # License
 

package/index.js

@@ -310,6 +310,7 @@ const setProfileToDefault = async (profileName, profileList, successMsg) => {
 	if (credsErrors)
 		return printAWSerrors([new Error(`Fail to get credentials for profile ${profile.name}`), ...credsErrors])
 
+	// console.log(profile)
 	// console.log(creds)
 
 	const [errors] = await updateDefaultProfile({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "switch-profile",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "main": "index.js",
   "bin": "index.js",
   "description": "NPX script that exposes terminal shortcut to easily switch between cloud configuration (aws, gcp).",

package/src/aws/index.js

@@ -7,10 +7,10 @@ const fileHelper = require('../fileHelper')
 const regions = require('./regions')
 
 const SSO_GET_CREDS_TIMEOUT = 5*60*1000 // 5 minutes to complete the SSO login
-const AWS_CONFIG_FILE = join(homedir(), '.aws/config')
-const AWS_CREDS_FILE = join(homedir(), '.aws/credentials')
-const AWS_SSO_FOLDER = join(homedir(), '.aws/sso/cache/')
-const AWS_CLI_FOLDER = join(homedir(), '.aws/cli/cache/')
+const AWS_CONFIG_FILE = join(homedir(), '.aws', 'config')
+const AWS_CREDS_FILE = join(homedir(), '.aws', 'credentials')
+const AWS_SSO_FOLDER = join(homedir(), '.aws', 'sso', 'cache')
+const AWS_CLI_FOLDER = join(homedir(), '.aws', 'cli', 'cache')
 const DEFAULT_CONFIG = 
 `[default]
 region = ap-southeast-1
@@ -189,14 +189,15 @@ const getSsoCredsFromCacheFile = (access_key_end, secret_key_end) => catchErrors
 
 	for (let i=0;i<files.length;i++) {
 		const _creds = await fileHelper.json.get(files[i])
+
 		// Creds must be SSO
 		if (!_creds || _creds.ProviderType != 'sso' || !_creds.Credentials)
 			continue
 
 		// Creds must still be valid for the next 2 minutes
 		if (_creds.Credentials.Expiration && (Date.now() - 2*60*1000) < new Date(_creds.Credentials.Expiration).getTime()) {
-			const credsMatch = _creds.Credentials.AccessKeyId||''.slice(-4) == access_key_end && 
-				_creds.Credentials.SecretAccessKey||''.slice(-4) == secret_key_end
+			const credsMatch = (_creds.Credentials.AccessKeyId||'').slice(-4) == access_key_end && 
+				(_creds.Credentials.SecretAccessKey||'').slice(-4) == secret_key_end
 
 			if (credsMatch)
 				return {
@@ -238,6 +239,7 @@ const getSsoCredentials = profile => catchErrors((async () => {
 			return null 
 
 		const [ssoCredsErrors, creds] = await getSsoCredsFromCacheFile(access_key_end, secret_key_end)
+
 		if (ssoCredsErrors)
 			throw wrapErrors(errMsg, ssoCredsErrors)
 		return creds