Merge pull request #577 from cloudinary/hiding-sensitive-data-on-error

Hiding sensitive data on error

Author: dannyv-cloudinary

lib-es5/api_client/execute_request.js

@@ -1,5 +1,7 @@
 'use strict';
 
+var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
+
 // eslint-disable-next-line import/order
 var config = require("../config");
 var https = /^http:/.test(config().upload_prefix) ? require('http') : require('https');
@@ -74,6 +76,21 @@ function execute_request(method, params, auth, api_url, callback) {
     request_options.headers['Content-Length'] = Buffer.byteLength(query_params);
   }
   handle_response = function handle_response(res) {
+    var _config = config(),
+        _config$hide_sensitiv = _config.hide_sensitive,
+        hide_sensitive = _config$hide_sensitiv === undefined ? false : _config$hide_sensitiv;
+
+    var sanitizedOptions = _extends({}, request_options);
+
+    if (hide_sensitive === true) {
+      if ("auth" in sanitizedOptions) {
+        delete sanitizedOptions.auth;
+      }
+      if ("Authorization" in sanitizedOptions.headers) {
+        delete sanitizedOptions.headers.Authorization;
+      }
+    }
+
     if (includes([200, 400, 401, 403, 404, 409, 420, 500], res.statusCode)) {
       var buffer = "";
       var error = false;
@@ -106,7 +123,7 @@ function execute_request(method, params, auth, api_url, callback) {
 
         if (result.error) {
           deferred.reject(Object.assign({
-            request_options,
+            request_options: sanitizedOptions,
             query_params
           }, result));
         } else {
@@ -122,7 +139,7 @@ function execute_request(method, params, auth, api_url, callback) {
           error: {
             message: e,
             http_code: res.statusCode,
-            request_options,
+            request_options: sanitizedOptions,
             query_params
           }
         };
@@ -136,7 +153,7 @@ function execute_request(method, params, auth, api_url, callback) {
         error: {
           message: "Server returned unexpected status code - " + res.statusCode,
           http_code: res.statusCode,
-          request_options,
+          request_options: sanitizedOptions,
           query_params
         }
       };

lib/api_client/execute_request.js

@@ -66,6 +66,14 @@ function execute_request(method, params, auth, api_url, callback, options = {})
     request_options.headers['Content-Length'] = Buffer.byteLength(query_params);
   }
   handle_response = function (res) {
+    const {hide_sensitive = false} = config();
+    const sanitizedOptions = {...request_options};
+
+    if (hide_sensitive === true){
+      if ("auth" in sanitizedOptions) { delete sanitizedOptions.auth; }
+      if ("Authorization" in sanitizedOptions.headers) { delete sanitizedOptions.headers.Authorization; }
+    }
+
     if (includes([200, 400, 401, 403, 404, 409, 420, 500], res.statusCode)) {
       let buffer = "";
       let error = false;
@@ -98,7 +106,7 @@ function execute_request(method, params, auth, api_url, callback, options = {})
 
         if (result.error) {
           deferred.reject(Object.assign({
-            request_options,
+            request_options: sanitizedOptions,
             query_params
           }, result));
         } else {
@@ -114,7 +122,7 @@ function execute_request(method, params, auth, api_url, callback, options = {})
           error: {
             message: e,
             http_code: res.statusCode,
-            request_options,
+            request_options: sanitizedOptions,
             query_params
           }
         };
@@ -128,7 +136,7 @@ function execute_request(method, params, auth, api_url, callback, options = {})
         error: {
           message: "Server returned unexpected status code - " + res.statusCode,
           http_code: res.statusCode,
-          request_options,
+          request_options: sanitizedOptions,
           query_params
         }
       };

test/unit/config.spec.js

@@ -20,6 +20,35 @@ describe("config", function () {
     cloudinary.config(true);
   });
 
+  it("should not have a `hide_sensitive` property by default", function () {
+    const config = cloudinary.config();
+    expect(config).not.to.have.property("hide_sensitive");
+  });
+
+  it("should support `hide_sensitive` config param", function () {
+    const config = cloudinary.config({hide_sensitive: true});
+    expect(config.hide_sensitive).to.eql(true)
+  });
+
+  it("should hide API key and secret upon error when `hide_sensitive` is true", async function () {
+    try {
+      cloudinary.config({hide_sensitive: true});
+      const result = await cloudinary.v2.api.resource("?");
+      expect(result).fail();
+    } catch (err) {
+      expect(err.request_options).not.to.have.property("auth");
+    }
+  });
+
+  it("should hide Authorization header upon error when `hide_sensitive` is true", async function () {
+    try {
+      cloudinary.config({hide_sensitive: true});
+      const result = await cloudinary.v2.api.resource("?", { oauth_token: 'irrelevant' });
+      expect(result).fail();
+    } catch (err) {
+      expect(err.request_options.headers).not.to.have.property("Authorization");
+    }
+  });
 
   it("should allow nested values in CLOUDINARY_URL", function () {
     process.env.CLOUDINARY_URL = "cloudinary://key:secret@test123?foo[bar]=value";