feat(aws-cdk): Detect presence of EC2 credentials #724
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,41 @@ | ||
| import { Environment} from '@aws-cdk/cx-api'; | ||
| import AWS = require('aws-sdk'); | ||
| import child_process = require('child_process'); | ||
| import fs = require('fs-extra'); | ||
| import os = require('os'); | ||
| import path = require('path'); | ||
| import util = require('util'); | ||
| import { debug } from '../../logging'; | ||
| import { PluginHost } from '../../plugin'; | ||
| import { CredentialProviderSource, Mode } from '../aws-auth/credentials'; | ||
| import { AccountAccessKeyCache } from './account-cache'; | ||
| import { SharedIniFile } from './sdk_ini_file'; | ||
|
|
||
| export interface SDKOptions { | ||
| /** | ||
| * Profile name to use | ||
| * | ||
| * @default No profile | ||
| */ | ||
| profile?: string; | ||
|
|
||
| /** | ||
| * Proxy address to use | ||
| * | ||
| * @default No proxy | ||
| */ | ||
| proxyAddress?: string; | ||
|
|
||
| /** | ||
| * Whether we should try instance credentials | ||
| * | ||
| * True/false to force/disable. Default is to guess. | ||
| * | ||
| * @default Automatically determine. | ||
| */ | ||
| ec2creds?: boolean; | ||
| } | ||
|
|
||
| /** | ||
| * Source for SDK client objects | ||
| * | ||
|
|
@@ -22,22 +49,25 @@ export class SDK { | |
| private readonly defaultAwsAccount: DefaultAWSAccount; | ||
| private readonly credentialsCache: CredentialsCache; | ||
| private readonly defaultClientArgs: any = {}; | ||
| private readonly profile?: string; | ||
|
|
||
| constructor(options: SDKOptions) { | ||
| this.profile = options.profile; | ||
|
|
||
| const defaultCredentialProvider = makeCLICompatibleCredentialProvider(options.profile, options.ec2creds); | ||
|
|
||
| // Find the package.json from the main toolkit | ||
| const pkg = (require.main as any).require('../package.json'); | ||
| this.defaultClientArgs.userAgent = `${pkg.name}/${pkg.version}`; | ||
|
|
||
| // https://aws.amazon.com/blogs/developer/using-the-aws-sdk-for-javascript-from-behind-a-proxy/ | ||
| if (options.proxyAddress === undefined) { | ||
| options.proxyAddress = httpsProxyFromEnvironment(); | ||
| } | ||
| if (options.proxyAddress) { // Ignore empty string on purpose | ||
| debug('Using proxy server: %s', options.proxyAddress); | ||
| this.defaultClientArgs.httpOptions = { | ||
| agent: require('proxy-agent')(options.proxyAddress) | ||
| }; | ||
| } | ||
|
|
||
|
|
@@ -224,25 +254,36 @@ class DefaultAWSAccount { | |
| * file location is not given (SDK expects explicit environment variable with name). | ||
| * - AWS_DEFAULT_PROFILE is also inspected for profile name (not just AWS_PROFILE). | ||
| */ | ||
| async function makeCLICompatibleCredentialProvider(profile: string | undefined, ec2creds: boolean | undefined) { | ||
| profile = profile || process.env.AWS_PROFILE || process.env.AWS_DEFAULT_PROFILE || 'default'; | ||
|
|
||
| // Need to construct filename ourselves, without appropriate environment variables | ||
| // no defaults used by JS SDK. | ||
| const filename = process.env.AWS_SHARED_CREDENTIALS_FILE || path.join(os.homedir(), '.aws', 'credentials'); | ||
|
|
||
| const sources = [ | ||
| () => new AWS.EnvironmentCredentials('AWS'), | ||
| () => new AWS.EnvironmentCredentials('AMAZON'), | ||
| ]; | ||
| if (fs.pathExists(filename)) { | ||
| sources.push(() => new AWS.SharedIniFileCredentials({ profile, filename })); | ||
| } | ||
|
|
||
| if (hasEcsCredentials()) { | ||
| sources.push(() => new AWS.ECSCredentials()); | ||
| } else { | ||
| // else if: don't get EC2 creds if we should have gotten ECS creds--ECS instances also | ||
| // run on EC2 boxes but the creds represent something different. Same behavior as | ||
| // upstream code. | ||
|
|
||
| if (ec2creds === undefined) { ec2creds = await hasEc2Credentials(); } | ||
|
|
||
| if (ec2creds) { | ||
| sources.push(() => new AWS.EC2MetadataCredentials()); | ||
| } | ||
| } | ||
|
|
||
| return new AWS.CredentialProviderChain(sources); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -290,4 +331,63 @@ function httpsProxyFromEnvironment(): string | undefined { | |
| return process.env.HTTPS_PROXY; | ||
| } | ||
| return undefined; | ||
| } | ||
|
|
||
| /** | ||
| * Return whether it looks like we'll have ECS credentials available | ||
| */ | ||
| function hasEcsCredentials() { | ||
| return (AWS.ECSCredentials.prototype as any).isConfiguredForEcsCredentials(); | ||
|
There was a problem hiding this comment. Sweet, some more esoteric code of unholy nature doing something that the JS SDK should expose more directly \o/ |
||
| } | ||
|
|
||
| /** | ||
| * Return whether we're on an EC2 instance | ||
|
There was a problem hiding this comment. Is there a reference somewhere for an AWS tool that does this? There was a problem hiding this comment. The EC2 documentation mentions those! |
||
| */ | ||
| async function hasEc2Credentials() { | ||
|
There was a problem hiding this comment. Surely, this is not something that could be included in all the SDKs, right? 🤨 There was a problem hiding this comment. Probably most other ones have semi-sane behavior in this regard already. |
||
| debug("Determining whether we're on an EC2 instance."); | ||
|
|
||
| let instance = false; | ||
| if (process.platform === 'win32') { | ||
| // https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/identify_ec2_instances.html | ||
| const result = await util.promisify(child_process.exec)('wmic path win32_computersystemproduct get uuid', { encoding: 'utf-8' }); | ||
| // output looks like | ||
| // UUID | ||
| // EC2AE145-D1DC-13B2-94ED-01234ABCDEF | ||
| const lines = result.stdout.toString().split('\n'); | ||
| instance = lines.some(x => matchesRegex(/^ec2/i, x)); | ||
| } else { | ||
| // https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/identify_ec2_instances.html | ||
| const files: Array<[string, RegExp]> = [ | ||
| // This recognizes the Xen hypervisor based instances (pre-5th gen) | ||
| ['/sys/hypervisor/uuid', /^ec2/i], | ||
|
|
||
| // This recognizes the new Hypervisor (5th-gen instances and higher) | ||
| // Can't use the advertised file '/sys/devices/virtual/dmi/id/product_uuid' because it requires root to read. | ||
| // Instead, sys_vendor contains something like 'Amazon EC2'. | ||
| ['/sys/devices/virtual/dmi/id/sys_vendor', /ec2/i], | ||
| ]; | ||
| for (const [file, re] of files) { | ||
| if (matchesRegex(re, await readIfPossible(file))) { | ||
| instance = true; | ||
| break; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| debug(instance ? 'Looks like EC2 instance.' : 'Does not look like EC2 instance.'); | ||
| return instance; | ||
| } | ||
|
|
||
| async function readIfPossible(filename: string): Promise<string | undefined> { | ||
| try { | ||
| if (!await fs.pathExists(filename)) { return undefined; } | ||
| return fs.readFile(filename, { encoding: 'utf-8' }); | ||
| } catch (e) { | ||
| debug(e); | ||
| return undefined; | ||
| } | ||
| } | ||
|
|
||
| function matchesRegex(re: RegExp, s: string | undefined) { | ||
| return s !== undefined && re.exec(s) !== null; | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!