Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added the ability for users to specify a CA bundle for HTTPS requests #483

Merged
merged 4 commits into from
Sep 26, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
6 changes: 6 additions & 0 deletions lib/base/RequestClient.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

var _ = require('lodash');
var http = require('request');
var fs = require('fs');
var Q = require('q');
var Response = require('../http/response');
var Request = require('../http/request');
Expand Down Expand Up @@ -53,6 +54,10 @@ RequestClient.prototype.request = function(opts) {
forever: opts.forever === false ? false : true,
};

if (process.env.TWILIO_CA_BUNDLE !== undefined) {
childish-sambino marked this conversation as resolved.
Show resolved Hide resolved
options.ca = fs.readFileSync(process.env.TWILIO_CA_BUNDLE);
}

if (!_.isNull(opts.data)) {
options.formData = opts.data;
}
Expand All @@ -69,6 +74,7 @@ RequestClient.prototype.request = function(opts) {
params: options.qs,
data: options.formData,
headers: options.headers,
ca: options.ca
};

var _this = this;
Expand Down
1 change: 1 addition & 0 deletions lib/http/request.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ var Request = function(opts) {
this.params = opts.params || this.ANY;
this.data = opts.data || this.ANY;
this.headers = opts.headers || this.ANY;
this.ca = opts.ca;
};

Request.prototype.ANY = '*';
Expand Down
6 changes: 6 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
"jasmine": "^3.4.0",
"jsdoc": "^3.6.3",
"jshint": "^2.10.2",
"mock-fs": "^4.10.1",
"node-mocks-http": "^1.8.0",
"proxyquire": "1.8.0",
"typescript": "^2.8.3"
Expand Down
46 changes: 46 additions & 0 deletions spec/unit/base/RequestClient.spec.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
var mockfs = require('mock-fs');
var proxyquire = require('proxyquire');

describe('lastResponse and lastRequest defined', function() {
Expand Down Expand Up @@ -85,3 +86,48 @@ describe('lastRequest defined, lastResponse undefined', function() {
});

});

describe('User specified CA bundle', function() {
var client;
beforeEach(function() {
RequestClientMock = proxyquire('../../../lib/base/RequestClient', {
request: function (options, callback) {
callback('failed', null);
},
});

client = new RequestClientMock();

options = {
method: 'GET',
uri: 'test-uri',
username: 'test-username',
password: 'test-password',
headers: {'test-header-key': 'test-header-value'},
params: {'test-param-key': 'test-param-value'},
data: {'test-data-key': 'test-data-value'}
};

mockfs({
'/path/to/ca': {
'test-ca.pem': 'test ca data'
}
});
});

afterEach(function () {
mockfs.restore();
});

it('should not modify CA if not specified', function() {
client.request(options);
expect(client.lastRequest.ca).toBeUndefined();
});

it('should use CA if it is specified', function() {
process.env.TWILIO_CA_BUNDLE = '/path/to/ca/test-ca.pem';
client.request(options);
expect(client.lastRequest.ca.toString()).toEqual('test ca data');
delete process.env.TWILIO_CA_BUNDLE;
});
});