Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ To use a proxy for local testing -
* proxyPass: Password for USERNAME, will be ignored if USERNAME is empty or not specified
* useCaCertificate: Path to ca cert file, if required

The same settings, including proxyUser/proxyPass and useCaCertificate, are used when the library downloads the BrowserStack Local binary. The download goes through the proxy only when both proxyHost and proxyPort are set.

```js
bs_local_args = { 'key': '<browserstack-accesskey>', 'proxyHost': '127.0.0.1', 'proxyPort': '8000', 'proxyUser': 'user', 'proxyPass': 'password', 'useCaCertificate': '/Users/test/cert.pem' }
```
Expand Down
6 changes: 6 additions & 0 deletions lib/Local.js
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,12 @@ function Local(){
if(this.proxyHost && this.proxyPort){
conf.proxyHost = this.proxyHost;
conf.proxyPort = this.proxyPort;
/* The running binary already gets these as --proxy-user/--proxy-pass
(getBinaryArgs); the download goes through the same proxy and needs them too. */
if(this.proxyUser) {
conf.proxyUser = this.proxyUser;
conf.proxyPass = this.proxyPass;
}
}
if (this.useCaCertificate) {
conf.useCaCertificate = this.useCaCertificate;
Expand Down
29 changes: 22 additions & 7 deletions lib/LocalBinary.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ var https = require('https'),
util = require('util'),
childProcess = require('child_process'),
zlib = require('zlib'),
HttpsProxyAgent = require('https-proxy-agent'),
{ buildProxyAgent } = require('./util'),
version = require('../package.json').version,
LocalError = require('./LocalError'),
fetchDownloadSourceUrlAsync = require('./fetchDownloadSourceUrlAsync');
Expand Down Expand Up @@ -37,6 +37,21 @@ function LocalBinary(){
*/
this.downloadState = { fallbackEnabled: false, errorMessage: null, sourceURL: null };

/* Proxy credentials reach the spawned download scripts through their environment,
never argv — same reason as the auth token. A copy already sitting in process.env
is dropped first so only this instance's settings are used. */
this.addProxyCredentialsToEnv = function(env, conf) {
delete env.BROWSERSTACK_LOCAL_PROXY_USER;
delete env.BROWSERSTACK_LOCAL_PROXY_PASS;
if(conf.proxyHost && conf.proxyPort && conf.proxyUser) {
env.BROWSERSTACK_LOCAL_PROXY_USER = String(conf.proxyUser);
if(conf.proxyPass !== undefined && conf.proxyPass !== null) {
env.BROWSERSTACK_LOCAL_PROXY_PASS = String(conf.proxyPass);
}
}
return env;
};

this.getSourceUrlSync = function(conf, retries) {
/* Request for an endpoint to download the local binary from Rails no more than twice with 5 retries each */
if (![4, 9].includes(retries) && this.sourceURL != null) {
Expand Down Expand Up @@ -74,6 +89,7 @@ function LocalBinary(){
if (this.key) {
env.BROWSERSTACK_LOCAL_AUTH_TOKEN = this.key;
}
this.addProxyCredentialsToEnv(env, conf);
const obj = childProcess.spawnSync(cmd, opts, { env: env });
/* stdout is null on a spawn failure; reading .length masked the real cause. */
if(obj.error) {
Expand Down Expand Up @@ -108,7 +124,7 @@ function LocalBinary(){
downloadErrorMessage = this.downloadErrorMessage || this.downloadState.errorMessage;
}

fetchDownloadSourceUrlAsync(this.key, this.bsHost, downloadFallback, downloadErrorMessage, conf.proxyHost, conf.proxyPort, conf.useCaCertificate, (err, sourceURL) => {
fetchDownloadSourceUrlAsync(this.key, this.bsHost, downloadFallback, downloadErrorMessage, conf.proxyHost, conf.proxyPort, conf.proxyUser, conf.proxyPass, conf.useCaCertificate, (err, sourceURL) => {
if (err) return callback(err);
this.sourceURL = sourceURL;
this.downloadState.sourceURL = sourceURL;
Expand Down Expand Up @@ -242,6 +258,7 @@ function LocalBinary(){
try{
const userAgent = [packageName, version].join('/');
const env = Object.assign({ 'USER_AGENT': userAgent }, process.env);
this.addProxyCredentialsToEnv(env, conf);
const obj = childProcess.spawnSync(cmd, opts, { env: env });
if(obj.status !== 0) {
that.binaryDownloadError('Download failed with status', String(obj.status));
Expand Down Expand Up @@ -304,11 +321,9 @@ function LocalBinary(){
});

var options = url.parse(this.httpPath);
if(conf.proxyHost && conf.proxyPort) {
options.agent = new HttpsProxyAgent({
host: conf.proxyHost,
port: conf.proxyPort
});
var agent = buildProxyAgent(conf.proxyHost, conf.proxyPort, conf.proxyUser, conf.proxyPass);
if(agent) {
options.agent = agent;
}
if (conf.useCaCertificate) {
try {
Expand Down
21 changes: 10 additions & 11 deletions lib/download.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
const https = require('https'),
fs = require('fs'),
HttpsProxyAgent = require('https-proxy-agent'),
url = require('url'),
zlib = require('zlib'),
{ isUndefined } = require('./util');
{ isUndefined, buildProxyAgent } = require('./util');

const binaryPath = process.argv[2], httpPath = process.argv[3], proxyHost = process.argv[4], proxyPort = process.argv[5], useCaCertificate = process.argv[6];
/* Proxy credentials come through the environment, never argv (see fetchDownloadSourceUrl.js). */
const proxyUser = process.env.BROWSERSTACK_LOCAL_PROXY_USER, proxyPass = process.env.BROWSERSTACK_LOCAL_PROXY_PASS;

var fileStream = fs.createWriteStream(binaryPath);

Expand All @@ -22,15 +23,13 @@ fileStream.on('error', function (err) {
});

var options = url.parse(httpPath);
/* isUndefined, not plain truthiness: the parent passes literal `undefined`
placeholders for the proxy slots when only a CA is configured, and those
arrive here as the *string* "undefined" — which is truthy, and previously
built a proxy agent pointing at the host "undefined". */
if(!isUndefined(proxyHost) && !isUndefined(proxyPort)) {
options.agent = new HttpsProxyAgent({
host: proxyHost,
port: proxyPort
});
/* buildProxyAgent treats the *string* "undefined" as absent: the parent passes
literal `undefined` placeholders for the proxy slots when only a CA is
configured, and plain truthiness previously built a proxy agent pointing at
the host "undefined". */
const agent = buildProxyAgent(proxyHost, proxyPort, proxyUser, proxyPass);
if(agent) {
options.agent = agent;
}

/* Applied regardless of whether a proxy is configured: this is the caller's TLS
Expand Down
18 changes: 8 additions & 10 deletions lib/fetchDownloadSourceUrl.js
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
const https = require('https'),
fs = require('fs'),
HttpsProxyAgent = require('https-proxy-agent'),
{ isUndefined } = require('./util');
{ isUndefined, buildProxyAgent } = require('./util');

/* The auth token is read from the environment, never from argv: argv is world-readable
via `ps` / /proc/<pid>/cmdline, whereas /proc/<pid>/environ is restricted to the
owning user. Keep it out of this argument list. */
/* The auth token and proxy credentials are read from the environment, never from argv:
argv is world-readable via `ps` / /proc/<pid>/cmdline, whereas /proc/<pid>/environ is
restricted to the owning user. Keep them out of this argument list. */
const authToken = process.env.BROWSERSTACK_LOCAL_AUTH_TOKEN, bsHost = process.argv[2], proxyHost = process.argv[5], proxyPort = process.argv[6], useCaCertificate = process.argv[7], downloadFallback = process.argv[3], downloadErrorMessage = process.argv[4];
const proxyUser = process.env.BROWSERSTACK_LOCAL_PROXY_USER, proxyPass = process.env.BROWSERSTACK_LOCAL_PROXY_PASS;

let body = '', data = {'auth_token': authToken};
const options = {
Expand All @@ -24,11 +24,9 @@ if (downloadFallback == 'true') {
data['error_message'] = downloadErrorMessage;
}

if(!isUndefined(proxyHost) && !isUndefined(proxyPort)) {
options.agent = new HttpsProxyAgent({
host: proxyHost,
port: proxyPort
});
const agent = buildProxyAgent(proxyHost, proxyPort, proxyUser, proxyPass);
if(agent) {
options.agent = agent;
}
if (!isUndefined(useCaCertificate)) {
try {
Expand Down
13 changes: 5 additions & 8 deletions lib/fetchDownloadSourceUrlAsync.js
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
const https = require('https'),
fs = require('fs'),
HttpsProxyAgent = require('https-proxy-agent'),
{ isUndefined } = require('./util'),
{ isUndefined, buildProxyAgent } = require('./util'),
version = require('../package.json').version;

const packageName = 'browserstack-local-nodejs';

function fetchDownloadSourceUrlAsync(authToken, bsHost, downloadFallback, downloadErrorMessage, proxyHost, proxyPort, useCaCertificate, callback) {
function fetchDownloadSourceUrlAsync(authToken, bsHost, downloadFallback, downloadErrorMessage, proxyHost, proxyPort, proxyUser, proxyPass, useCaCertificate, callback) {
let body = '', data = {'auth_token': authToken};
const userAgent = [packageName, version].join('/');
const options = {
Expand All @@ -24,11 +23,9 @@ function fetchDownloadSourceUrlAsync(authToken, bsHost, downloadFallback, downlo
data['error_message'] = downloadErrorMessage;
}

if(!isUndefined(proxyHost) && !isUndefined(proxyPort)) {
options.agent = new HttpsProxyAgent({
host: proxyHost,
port: proxyPort
});
const agent = buildProxyAgent(proxyHost, proxyPort, proxyUser, proxyPass);
if(agent) {
options.agent = agent;
}
if (!isUndefined(useCaCertificate)) {
try {
Expand Down
22 changes: 21 additions & 1 deletion lib/util.js
Original file line number Diff line number Diff line change
@@ -1 +1,21 @@
module.exports.isUndefined = value => (value === undefined || value === null || value === 'undefined');
const HttpsProxyAgent = require('https-proxy-agent');

const isUndefined = value => (value === undefined || value === null || value === 'undefined');
module.exports.isUndefined = isUndefined;

const isBlank = value => (isUndefined(value) || value === '');

/* Builds the proxy agent for every binary-download request: the in-process async
download and the scripts the sync path spawns. Without proxyUser/proxyPass in it,
an authenticating proxy answers the CONNECT with 407 and the binary is never
downloaded, even though the running binary gets them as --proxy-user/--proxy-pass.
Same rule as the README: proxyPass is ignored unless proxyUser is set. */
module.exports.buildProxyAgent = (proxyHost, proxyPort, proxyUser, proxyPass) => {
if(isBlank(proxyHost) || isBlank(proxyPort)) return undefined;
const agentOptions = { host: proxyHost, port: proxyPort };
if(!isBlank(proxyUser)) {
/* https-proxy-agent sends this as `Proxy-Authorization: Basic base64(auth)`. */
agentOptions.auth = proxyUser + ':' + (isUndefined(proxyPass) ? '' : proxyPass);
}
return new HttpsProxyAgent(agentOptions);
};
29 changes: 29 additions & 0 deletions test/fixtures/recording_proxy.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/* Test double for a corporate proxy that requires Basic auth. It runs in its own
process so the sync download path, which blocks the test process in spawnSync,
can still reach it. Every CONNECT is recorded and refused with 407, so nothing
leaves the machine. Talks to the parent over the fork IPC channel:
sends { port } once listening, answers 'dump' with { requests }, exits on 'stop'. */
const http = require('http');

const requests = [];
const server = http.createServer(function (req, res) {
res.writeHead(405);
res.end();
});

server.on('connect', function (req, socket) {
requests.push({ target: req.url, auth: req.headers['proxy-authorization'] || null });
socket.end('HTTP/1.1 407 Proxy Authentication Required\r\n' +
'Proxy-Authenticate: Basic realm="corp"\r\n' +
'Content-Length: 0\r\n' +
'Connection: close\r\n\r\n');
});

process.on('message', function (msg) {
if (msg === 'dump') process.send({ requests: requests.splice(0) });
if (msg === 'stop') server.close(function () { process.exit(0); });
});

server.listen(0, '127.0.0.1', function () {
process.send({ port: server.address().port });
});
Loading
Loading