Skip to content

Commit a3f1143

Browse files
imatlopezrvagg
imatlopez
authored and
rvagg
committed
lib: noproxy support, match proxy detection to request
PR-URL: #1978 Reviewed-By: Rod Vagg <rod@vagg.org>
1 parent 0923f34 commit a3f1143

File tree

5 files changed

+192
-5
lines changed

5 files changed

+192
-5
lines changed

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,8 @@ Some additional resources for Node.js native addons and writing `gyp` configurat
193193
| `--devdir=$path` | SDK download directory (default is OS cache directory)
194194
| `--ensure` | Don't reinstall headers if already present
195195
| `--dist-url=$url` | Download header tarball from custom URL
196-
| `--proxy=$url` | Set HTTP proxy for downloading header tarball
196+
| `--proxy=$url` | Set HTTP(S) proxy for downloading header tarball
197+
| `--noproxy=$urls` | Set urls to ignore proxies when downloading header tarball
197198
| `--cafile=$cafile` | Override default CA chain (to download tarball)
198199
| `--nodedir=$path` | Set the path to the node source code
199200
| `--python=$path` | Set path to the Python binary

‎lib/install.js‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ const request = require('request')
1111
const mkdir = require('mkdirp')
1212
const processRelease = require('./process-release')
1313
const win = process.platform === 'win32'
14+
const getProxyFromURI = require('./proxy')
1415

1516
function install (fs, gyp, argv, callback) {
1617
var release = processRelease(argv, gyp, process.version, process.release)
@@ -410,10 +411,7 @@ function download (gyp, env, url) {
410411
}
411412

412413
// basic support for a proxy server
413-
var proxyUrl = gyp.opts.proxy ||
414-
env.http_proxy ||
415-
env.HTTP_PROXY ||
416-
env.npm_config_proxy
414+
var proxyUrl = getProxyFromURI(gyp, env, url)
417415
if (proxyUrl) {
418416
if (/^https?:\/\//i.test(proxyUrl)) {
419417
log.verbose('download', 'using proxy url: "%s"', proxyUrl)

‎lib/node-gyp.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ proto.configDefs = {
6767
ensure: Boolean, // 'install'
6868
solution: String, // 'build' (windows only)
6969
proxy: String, // 'install'
70+
noproxy: String, // 'install'
7071
devdir: String, // everywhere
7172
nodedir: String, // 'configure'
7273
loglevel: String, // everywhere

‎lib/proxy.js‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
'use strict'
2+
// Taken from https://github.com/request/request/blob/212570b/lib/getProxyFromURI.js
3+
4+
const url = require('url')
5+
6+
function formatHostname (hostname) {
7+
// canonicalize the hostname, so that 'oogle.com' won't match 'google.com'
8+
return hostname.replace(/^\.*/, '.').toLowerCase()
9+
}
10+
11+
function parseNoProxyZone (zone) {
12+
zone = zone.trim().toLowerCase()
13+
14+
var zoneParts = zone.split(':', 2)
15+
var zoneHost = formatHostname(zoneParts[0])
16+
var zonePort = zoneParts[1]
17+
var hasPort = zone.indexOf(':') > -1
18+
19+
return { hostname: zoneHost, port: zonePort, hasPort: hasPort }
20+
}
21+
22+
function uriInNoProxy (uri, noProxy) {
23+
var port = uri.port || (uri.protocol === 'https:' ? '443' : '80')
24+
var hostname = formatHostname(uri.hostname)
25+
var noProxyList = noProxy.split(',')
26+
27+
// iterate through the noProxyList until it finds a match.
28+
return noProxyList.map(parseNoProxyZone).some(function (noProxyZone) {
29+
var isMatchedAt = hostname.indexOf(noProxyZone.hostname)
30+
var hostnameMatched = (
31+
isMatchedAt > -1 &&
32+
(isMatchedAt === hostname.length - noProxyZone.hostname.length)
33+
)
34+
35+
if (noProxyZone.hasPort) {
36+
return (port === noProxyZone.port) && hostnameMatched
37+
}
38+
39+
return hostnameMatched
40+
})
41+
}
42+
43+
function getProxyFromURI (gyp, env, uri) {
44+
// If a string URI/URL was given, parse it into a URL object
45+
if (typeof uri === 'string') {
46+
// eslint-disable-next-line
47+
uri = url.parse(uri)
48+
}
49+
50+
// Decide the proper request proxy to use based on the request URI object and the
51+
// environmental variables (NO_PROXY, HTTP_PROXY, etc.)
52+
// respect NO_PROXY environment variables (see: https://lynx.invisible-island.net/lynx2.8.7/breakout/lynx_help/keystrokes/environments.html)
53+
54+
var noProxy = gyp.opts.noproxy || env.NO_PROXY || env.no_proxy || env.npm_config_noproxy || ''
55+
56+
// if the noProxy is a wildcard then return null
57+
58+
if (noProxy === '*') {
59+
return null
60+
}
61+
62+
// if the noProxy is not empty and the uri is found return null
63+
64+
if (noProxy !== '' && uriInNoProxy(uri, noProxy)) {
65+
return null
66+
}
67+
68+
// Check for HTTP or HTTPS Proxy in environment Else default to null
69+
70+
if (uri.protocol === 'http:') {
71+
return gyp.opts.proxy ||
72+
env.HTTP_PROXY ||
73+
env.http_proxy ||
74+
env.npm_config_proxy || null
75+
}
76+
77+
if (uri.protocol === 'https:') {
78+
return gyp.opts.proxy ||
79+
env.HTTPS_PROXY ||
80+
env.https_proxy ||
81+
env.HTTP_PROXY ||
82+
env.http_proxy ||
83+
env.npm_config_proxy || null
84+
}
85+
86+
// if none of that works, return null
87+
// (What uri protocol are you using then?)
88+
89+
return null
90+
}
91+
92+
module.exports = getProxyFromURI

‎test/test-download.js‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,101 @@ test('download over https with custom ca', function (t) {
9090
})
9191
})
9292

93+
test('download over http with proxy', function (t) {
94+
t.plan(2)
95+
96+
var server = http.createServer(function (req, res) {
97+
t.strictEqual(req.headers['user-agent'],
98+
'node-gyp v42 (node ' + process.version + ')')
99+
res.end('ok')
100+
pserver.close(function () {
101+
server.close()
102+
})
103+
})
104+
105+
var pserver = http.createServer(function (req, res) {
106+
t.strictEqual(req.headers['user-agent'],
107+
'node-gyp v42 (node ' + process.version + ')')
108+
res.end('proxy ok')
109+
server.close(function () {
110+
pserver.close()
111+
})
112+
})
113+
114+
var host = 'localhost'
115+
server.listen(0, host, function () {
116+
var port = this.address().port
117+
pserver.listen(port + 1, host, function () {
118+
var gyp = {
119+
opts: {
120+
proxy: 'http://' + host + ':' + (port + 1)
121+
},
122+
version: '42'
123+
}
124+
var url = 'http://' + host + ':' + port
125+
var req = install.test.download(gyp, {}, url)
126+
req.on('response', function (res) {
127+
var body = ''
128+
res.setEncoding('utf8')
129+
res.on('data', function (data) {
130+
body += data
131+
})
132+
res.on('end', function () {
133+
t.strictEqual(body, 'proxy ok')
134+
})
135+
})
136+
})
137+
})
138+
})
139+
140+
test('download over http with noproxy', function (t) {
141+
t.plan(2)
142+
143+
var server = http.createServer(function (req, res) {
144+
t.strictEqual(req.headers['user-agent'],
145+
'node-gyp v42 (node ' + process.version + ')')
146+
res.end('ok')
147+
pserver.close(function () {
148+
server.close()
149+
})
150+
})
151+
152+
var pserver = http.createServer(function (req, res) {
153+
t.strictEqual(req.headers['user-agent'],
154+
'node-gyp v42 (node ' + process.version + ')')
155+
res.end('proxy ok')
156+
server.close(function () {
157+
pserver.close()
158+
})
159+
})
160+
161+
var host = 'localhost'
162+
server.listen(0, host, function () {
163+
var port = this.address().port
164+
pserver.listen(port + 1, host, function () {
165+
var gyp = {
166+
opts: {
167+
proxy: 'http://' + host + ':' + (port + 1),
168+
noproxy: 'localhost'
169+
},
170+
version: '42'
171+
}
172+
var url = 'http://' + host + ':' + port
173+
var req = install.test.download(gyp, {}, url)
174+
req.on('response', function (res) {
175+
var body = ''
176+
res.setEncoding('utf8')
177+
res.on('data', function (data) {
178+
body += data
179+
})
180+
res.on('end', function () {
181+
t.strictEqual(body, 'ok')
182+
})
183+
})
184+
})
185+
})
186+
})
187+
93188
test('download with missing cafile', function (t) {
94189
t.plan(1)
95190
var gyp = {

0 commit comments

Comments
 (0)