rename ssl client certs options into --ssl-client-cert-list and add an example of ssl client cert list

Author: chengchengmu

README.md

@@ -221,8 +221,8 @@ Newman supports SSL client certificates, via the following CLI options (availabl
 
 #### Use a ssl client certificates configuration file (supports multiple certificates per run)
 
-- --ssl-client-certs<br/>
-The path to the ssl client certs configuration file (json format). See [examples/multiple-ssl-client-certs.json](https://github.com/postmanlabs/newman/blob/develop/examples/multiple-ssl-client-certs.json)
+- --ssl-client-cert-list<br/>
+The path to the ssl client certificate list configuration file (json format). See [examples/ssl-client-cert-list.json](https://github.com/postmanlabs/newman/blob/develop/examples/ssl-client-cert-list.json)
 This option allows multiple ssl client certificiates and different ssl client certificate per url or hostname.
 This option and --ssl-client-cert, --ssl-client-key and --ssl-client-passphrase are exclusives.
 

bin/newman.js

@@ -52,7 +52,7 @@ program
     .option('--timeout-script [n]', 'Specify a timeout for script (in milliseconds).', util.cast.integer, 0)
     .option('--ignore-redirects', 'If present, Newman will not follow HTTP Redirects.')
     .option('-k, --insecure', 'Disables SSL validations.')
-    .option('--ssl-client-certs <path>',
+    .option('--ssl-client-cert-list <path>',
         'Specify the path to the Client SSL certificates configuration file (json format).' +
         '\nThis option different ssl client certificate per url/hostname.' +
         '\nThis option and --ssl-client-cert, --ssl-client-key and --ssl-client-passphrase are exclusives.')

examples/ssl-client-cert-list.json

@@ -0,0 +1,16 @@
+[
+    {
+        "name": "domain1",
+        "matches": ["https://test.domain1.com/*", "https://www.domain1/*"],
+        "key": {"src": "./client.domain1.key"},
+        "cert": {"src": "./client.domain1.crt"},
+        "passphrase": "changeme"
+    },
+    {
+        "name": "domain2",
+        "matches": ["https://domain2.com/*"],
+        "key": {"src": "./client.domain2.key"},
+        "cert": {"src": "./client.domain2.crt"},
+        "passphrase": "changeme"
+    }
+]

lib/run/index.js

@@ -136,29 +136,29 @@ module.exports = function (options, callback) {
         // to store the exported content from reporters
         emitter.exports = [];
 
-        let secureFileResolver, sslClientCerts;
+        let secureFileResolver, sslClientCertList;
 
         secureFileResolver = new SecureFS(options.workingDir, options.insecureFileRead);
-        sslClientCerts = [];
+        sslClientCertList = [];
 
-        if (options.sslClientCert && options.sslClientCerts) {
+        if (options.sslClientCert && options.sslClientCertList) {
             err = 'newman: too many ssl client cert options: use only one of them.';
 
             return callback(new Error(err));
         }
 
         // new client certificate option that manages client certificate <-> url mapping
-        if (options.sslClientCerts) {
+        if (options.sslClientCertList) {
             try {
-                sslClientCerts = JSON.parse(secureFileResolver.readFileSync(options.sslClientCerts));
+                sslClientCertList = JSON.parse(secureFileResolver.readFileSync(options.sslClientCertList));
             }
             catch (error) {
                 return callback(new Error('newman: unable to read the ssl client certificates file'));
             }
         }
         // keeping this option to pass one client certificate for all urls
         if (options.sslClientCert) {
-            sslClientCerts = [{
+            sslClientCertList = [{
                 name: 'client-cert',
                 matches: [sdk.UrlMatchPattern.MATCH_ALL_URLS],
                 key: { src: options.sslClientKey },
@@ -193,8 +193,8 @@ module.exports = function (options, callback) {
                 timings: Boolean(options.verbose),
                 extendedRootCA: options.sslExtraCaCerts
             },
-            certificates: (options.sslClientCerts || options.sslClientCert) &&
-              new sdk.CertificateList({}, sslClientCerts)
+            certificates: (options.sslClientCertList || options.sslClientCert) &&
+              new sdk.CertificateList({}, sslClientCertList)
         }, function (err, run) {
             if (err) { return callback(err); }
 

test/cli/ssl-client-cert.test.js

@@ -65,15 +65,15 @@ describe('SSL Client certificates', function () {
 
     it('should not work when both client certificate options are used', function (done) {
         // eslint-disable-next-line max-len
-        exec('node ./bin/newman.js run test/fixtures/run/multiple-ssl-client-certs.json --ssl-client-certs test/fixtures/ssl/sslClientCerts.json --ssl-client-cert test/fixtures/ssl/client.crt --ssl-client-key test/fixtures/ssl/client.key --ssl-client-passphrase password -k', function (code) {
+        exec('node ./bin/newman.js run test/fixtures/run/ssl-client-cert-list.json --ssl-client-cert-list test/fixtures/ssl/sslClientCertList.json --ssl-client-cert test/fixtures/ssl/client.crt --ssl-client-key test/fixtures/ssl/client.key --ssl-client-passphrase password -k', function (code) {
             expect(code, 'should have exit code different than 0').to.not.equal(0);
             done();
         });
     });
 
     it('should work correctly with multiple client certificates', function (done) {
         // eslint-disable-next-line max-len
-        exec('node ./bin/newman.js run test/fixtures/run/multiple-ssl-client-certs.json --verbose --ssl-client-certs ./test/fixtures/ssl/sslClientCerts.json -k', function (code) {
+        exec('node ./bin/newman.js run test/fixtures/run/ssl-client-cert-list.json --verbose --ssl-client-cert-list ./test/fixtures/ssl/sslClientCertList.json -k', function (code) {
             expect(code, 'should have exit code of 0').to.equal(0);
             done();
         });

test/fixtures/run/multiple-ssl-client-certs.json renamed to test/fixtures/run/ssl-client-cert-list.json

@@ -65,8 +65,8 @@ describe('SSL Client certificates', function () {
 
     it('should work correctly with multiple client certificates', function (done) {
         newman.run({
-            collection: 'test/fixtures/run/multiple-ssl-client-certs.json',
-            sslClientCerts: 'test/fixtures/ssl/sslClientCerts.json',
+            collection: 'test/fixtures/run/ssl-client-cert-list.json',
+            sslClientCertList: 'test/fixtures/ssl/sslClientCertList.json',
             insecure: true
         }, done);
     });