fix(cli): proxy support

Proxy support was broken in the PR that introduced support for custom CA bundles. Fix the support. Fixes #5743, fixes #5791.
aws · Jan 15, 2020 · 5dfec17 · 5dfec17
1 parent 34d3e7d
commit 5dfec17
Show file tree

Hide file tree

Showing 3 changed files with 335 additions and 38 deletions.
diff --git a/packages/aws-cdk/lib/api/util/sdk.ts b/packages/aws-cdk/lib/api/util/sdk.ts
@@ -195,9 +195,9 @@ export class SDK implements ISDK {
     return environment;
   }
 
-  private async configureSDKHttpOptions(options: SDKOptions) {
+  private configureSDKHttpOptions(options: SDKOptions) {
     const config: {[k: string]: any} = {};
-    const httpOptions: {[k: string]: any} = {};
+    config.httpOptions = {};
 
     let userAgent = options.userAgent;
     if (userAgent == null) {
@@ -207,19 +207,30 @@ export class SDK implements ISDK {
     }
     config.customUserAgent = userAgent;
 
-    // https://aws.amazon.com/blogs/developer/using-the-aws-sdk-for-javascript-from-behind-a-proxy/
-    options.proxyAddress = options.proxyAddress || httpsProxyFromEnvironment();
-    options.caBundlePath = options.caBundlePath || caBundlePathFromEnvironment();
+    const proxyAddress = options.proxyAddress || httpsProxyFromEnvironment();
+    const caBundlePath = options.caBundlePath || caBundlePathFromEnvironment();
 
-    if (options.proxyAddress) { // Ignore empty string on purpose
-      debug('Using proxy server: %s', options.proxyAddress);
-      httpOptions.proxy = options.proxyAddress;
+    if (proxyAddress && caBundlePath) {
+      throw new Error(`Cannot specify Proxy (${proxyAddress}) and CA Bundle (${caBundlePath}) at the same time`);
+      // Maybe it's possible after all, but I've been staring at
+      // https://github.com/TooTallNate/node-proxy-agent/blob/master/index.js#L79
+      // a while now trying to figure out what to pass in so that the underlying Agent
+      // object will get the 'ca' argument. It's not trivial and I don't want to risk it.
     }
-    if (options.caBundlePath) {
-      debug('Using ca bundle path: %s', options.caBundlePath);
-      httpOptions.agent = new https.Agent({ca: await readIfPossible(options.caBundlePath)});
+
+    if (proxyAddress) { // Ignore empty string on purpose
+      // https://aws.amazon.com/blogs/developer/using-the-aws-sdk-for-javascript-from-behind-a-proxy/
+      debug('Using proxy server: %s', proxyAddress);
+      // eslint-disable-next-line @typescript-eslint/no-require-imports
+      const ProxyAgent: any = require('proxy-agent');
+      config.httpOptions.agent = new ProxyAgent(proxyAddress);
+    }
+    if (caBundlePath) {
+      debug('Using CA bundle path: %s', caBundlePath);
+      config.httpOptions.agent = new https.Agent({
+        ca: readIfPossible(caBundlePath)
+      });
     }
-    config.httpOptions = httpOptions;
 
     AWS.config.update(config);
   }
@@ -512,7 +523,7 @@ async function hasEc2Credentials() {
       ['/sys/devices/virtual/dmi/id/sys_vendor', /ec2/i],
     ];
     for (const [file, re] of files) {
-      if (matchesRegex(re, await readIfPossible(file))) {
+      if (matchesRegex(re, readIfPossible(file))) {
         instance = true;
         break;
       }
@@ -532,10 +543,15 @@ async function setConfigVariable() {
   }
 }
 
-async function readIfPossible(filename: string): Promise<string | undefined> {
+/**
+ * Read a file if it exists, or return undefined
+ *
+ * Not async because it is used in the constructor
+ */
+function readIfPossible(filename: string): string | undefined {
   try {
-    if (!await fs.pathExists(filename)) { return undefined; }
-    return fs.readFile(filename, { encoding: 'utf-8' });
+    if (!fs.pathExistsSync(filename)) { return undefined; }
+    return fs.readFileSync(filename, { encoding: 'utf-8' });
   } catch (e) {
     debug(e);
     return undefined;

diff --git a/packages/aws-cdk/package.json b/packages/aws-cdk/package.json
@@ -78,6 +78,7 @@
     "json-diff": "^0.5.4",
     "minimatch": ">=3.0",
     "promptly": "^3.0.3",
+    "proxy-agent": "^3.1.1",
     "request": "^2.88.0",
     "semver": "^7.1.1",
     "source-map-support": "^0.5.16",