azure / get-proxy-settings

Retrieve proxy settings specified by the system

Note: This project is not actively maintained. If some issues come up we'll look into fixing them but new features will most likely not make it.

System Proxy

This library support

• Reading proxy settings from the HTTP_PROXY or HTTPS_PROXY environment variables
• Reading proxy settings from the HTTP_PROXY or HTTPS_PROXY node configuration
• Retrieving the settings from the internet settings on Windows in the registry
• Validating the connection and asking for credentials if needed
• Note that it doesn't support every proxy system. If you are using electron it is recommended to use electron/chromium built in proxy support which is much more advanced.

Install

npm install --save get-proxy-settings

Usage

Import

// With named import
import { getProxySettings, getAndTestProxySettings } from "get-proxy-settings";

// Or with commonjs
const { getProxySettings, getAndTestProxySettings } = require("get-proxy-settings");

Use

async function basic() {
    const proxy = await getProxySettings();
    console.log("proxy", proxy.http, proxy.https);
}

// Get and validate the proxy settings
async function withValidation() {
    async function login() {
        // Do any async operation to retrieve the username and password of the user(prompt?)
        return {username: "abc", password: "123"}
    }

    const proxy = await getAndTestProxySettings(login);
    console.log("proxy", proxy.http, proxy.https);
}

Config

Update the test url (Which url is used to validate the proxy)

import { defaults } from "get-proxy-settings";

defaults.testUrl = "https://example.com";

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Credits

• Timothee Guerin
• Adar Zandberg from the CxSCA AppSec team at Checkmarx. (Finding Command injection vulnerability)

get-proxy-settings's Issues

Seems to ignore the ProxyEnable registry field

Add option to fetch proxy bypass rules from environment

It will be a good addition if this module could also fetch proxy bypass rules (Ignore Hosts) from system settings, as well.

Type definition of getProxySettings() is not accurate

As you can see in dist/proxy.d.ts:

export declare function getProxySettings(): Promise<ProxySettings>;

getProxySettings() always returns promise that resolves to ProxySettings.

While in reality, it may return null:

get-proxy-settings/src/proxy.ts

Line 9 in 84f90a3

export async function getProxySettings(): Promise<ProxySettings | null> {

As you can see, my code:

const proxy = await getProxySettings();
const bestProxy = proxy.https || proxy.http || undefined;

compiled without any warning, but failed with error:

TypeError: Cannot read property 'https' of null
    at /home/runner/work/google-api-typings-generator/google-api-typings-generator/src/cli.ts:31:27
    at processTicksAndRejections (internal/process/task_queues.js:97:5)

while running

So, the correct type definition should be:

export declare function getProxySettings(): Promise<ProxySettings | null>;

Uncaught (in promise) TypeError: url_1.URL is not a constructor

Uncaught (in promise) TypeError: url_1.URL is not a constructor.

node_modules\get-proxy-settings\dist\proxy-settings.js:43:21

Update package on npmjs

The latest version on npmjs is 0.1.10, and the latest version in this repo is 0.1.11

Throw error when windows proxy settings are not what is expected

If value is not http=x.x.x.x:p;https=x.x.x.x:p; it can throw an error.