Detect and expose the system proxy settings

Author: pimterry

custom-typings/cypress--get-windows-proxy.d.ts

@@ -0,0 +1,8 @@
+declare module "@cypress/get-windows-proxy" {
+    function getWindowsProxy(): {
+        httpProxy: string | undefined;
+        noProxy: string | undefined;
+    } | undefined;
+
+    export = getWindowsProxy;
+}

package-lock.json

@@ -26,6 +26,7 @@
   "homepage": "https://github.com/httptoolkit/httptoolkit-server",
   "bugs": "https://github.com/httptoolkit/httptoolkit-server/issues",
   "dependencies": {
+    "@cypress/get-windows-proxy": "^1.6.2",
     "@devicefarmer/adbkit": "^2.11.2",
     "@graphql-tools/schema": "^6.0.18",
     "@graphql-tools/utils": "^6.0.18",
@@ -53,6 +54,7 @@
     "iconv-lite": "^0.4.24",
     "lodash": "^4.17.21",
     "lookpath": "^1.2.1",
+    "mac-system-proxy": "^1.0.0",
     "mime-types": "^2.1.27",
     "mockttp": "^2.0.0",
     "node-fetch": "^2.6.1",

package.json

@@ -15,6 +15,7 @@ import { reportError, addBreadcrumb } from './error-tracking';
 import { buildInterceptors, Interceptor, ActivationError } from './interceptors';
 import { ALLOWED_ORIGINS } from './constants';
 import { delay } from './util';
+import { getSystemProxyConfig } from './detect-proxy';
 
 const ENABLE_PLAYGROUND = false;
 
@@ -44,6 +45,7 @@ const typeDefs = `
         interceptors: [Interceptor!]!
         interceptor(id: ID!): Interceptor!
         networkInterfaces: Json
+        systemProxy: Proxy
     }
 
     type Mutation {
@@ -74,6 +76,11 @@ const typeDefs = `
         isActive(proxyPort: Int!): Boolean!
     }
 
+    type Proxy {
+        proxyUrl: String!
+        noProxy: [String!]
+    }
+
     enum MetadataType {
         SUMMARY,
         DETAILED
@@ -116,7 +123,8 @@ const buildResolvers = (
                 // convenient to do it up front.
                 certificateFingerprint: generateSPKIFingerprint(config.https.certContent)
             }),
-            networkInterfaces: () => os.networkInterfaces()
+            networkInterfaces: () => os.networkInterfaces(),
+            systemProxy: () => getSystemProxyConfig()
         },
 
         Mutation: {

src/api-server.ts

@@ -0,0 +1,60 @@
+import { ProxyConfig } from 'mockttp';
+import getWindowsProxy = require('@cypress/get-windows-proxy');
+import { getMacSystemProxy, MacProxySettings } from 'mac-system-proxy';
+
+import { reportError } from './error-tracking';
+
+export async function getSystemProxyConfig(): Promise<ProxyConfig | undefined> {
+    if (process.platform === 'win32') {
+        const proxySettings = getWindowsProxy();
+        if (!proxySettings || !proxySettings.httpProxy) return undefined;
+        else return {
+            proxyUrl: proxySettings.httpProxy,
+            noProxy: proxySettings.noProxy
+                ? proxySettings.noProxy.split(',')
+                : []
+        };
+    } else if (process.platform === 'darwin') {
+        const proxySettings = await getMacSystemProxy().catch((e) => {
+            reportError(e);
+            return {} as MacProxySettings;
+        });
+
+        const noProxy = proxySettings.ExceptionsList;
+
+        if (proxySettings.HTTPSEnable && proxySettings.HTTPSProxy && proxySettings.HTTPSPort) {
+            return {
+                proxyUrl: `https://${proxySettings.HTTPSProxy}:${proxySettings.HTTPSPort}`,
+                noProxy
+            };
+        } else if (proxySettings.HTTPEnable && proxySettings.HTTPProxy && proxySettings.HTTPPort) {
+            return {
+                proxyUrl: `http://${proxySettings.HTTPProxy}:${proxySettings.HTTPPort}`,
+                noProxy
+            };
+        } else if (proxySettings.SOCKSEnable && proxySettings.SOCKSProxy && proxySettings.SOCKSProxy) {
+            return {
+                proxyUrl: `socks://${proxySettings.SOCKSProxy}:${proxySettings.SOCKSProxy}`,
+                noProxy
+            };
+        } else {
+            return undefined;
+        }
+    } else {
+        const proxyUrl = process.env.HTTPS_PROXY ||
+            process.env.HTTP_PROXY ||
+            process.env.https_proxy ||
+            process.env.http_proxy;
+
+        if (!proxyUrl) return undefined;
+
+        const noProxy = process.env.NO_PROXY
+            ? process.env.NO_PROXY.split(',')
+            : undefined;
+
+        return {
+            proxyUrl,
+            noProxy
+        };
+    }
+}