remove/inject backups secret fields

follow same pattern as dns code

fixes #615

src/storage/filesystem.js

@@ -11,7 +11,9 @@ exports = module.exports = {
     remove: remove,
     removeDir: removeDir,
 
-    testConfig: testConfig
+    testConfig: testConfig,
+    removePrivateFields: removePrivateFields,
+    injectPrivateFields: injectPrivateFields
 };
 
 var assert = require('assert'),
@@ -189,3 +191,9 @@ function testConfig(apiConfig, callback) {
     });
 }
 
+function removePrivateFields(apiConfig) {
+    return apiConfig;
+}
+
+function injectPrivateFields(/* newConfig, currentConfig */) {
+}

src/storage/gcs.js

@@ -11,6 +11,8 @@ exports = module.exports = {
     removeDir: removeDir,
 
     testConfig: testConfig,
+    removePrivateFields: removePrivateFields,
+    injectPrivateFields: injectPrivateFields,
 
     // Used to mock GCS
     _mockInject: mockInject,
@@ -19,6 +21,7 @@ exports = module.exports = {
 
 var assert = require('assert'),
     async = require('async'),
+    backups = require('../backups.js'),
     BackupsError = require('../backups.js').BackupsError,
     debug = require('debug')('box:storage/gcs'),
     EventEmitter = require('events'),
@@ -258,3 +261,11 @@ function testConfig(apiConfig, callback) {
     });
 }
 
+function removePrivateFields(apiConfig) {
+    apiConfig.credentials.private_key = backups.SECRET_PLACEHOLDER;
+    return apiConfig;
+}
+
+function injectPrivateFields(newConfig, currentConfig) {
+    if (newConfig.credentials.private_key === backups.SECRET_PLACEHOLDER && currentConfig.credentials) newConfig.credentials.private_key = currentConfig.credentials.private_key;
+}

src/storage/interface.js

@@ -22,12 +22,23 @@ exports = module.exports = {
     remove: remove,
     removeDir: removeDir,
 
-    testConfig: testConfig
+    testConfig: testConfig,
+    removePrivateFields: removePrivateFields,
+    injectPrivateFields: injectPrivateFields
 };
 
 var assert = require('assert'),
     EventEmitter = require('events');
 
+function removePrivateFields(apiConfig) {
+    // in-place removal of tokens and api keys with domains.SECRET_PLACEHOLDER
+    return apiConfig;
+}
+
+function injectPrivateFields(newConfig, currentConfig) {
+    // in-place injection of tokens and api keys which came in with domains.SECRET_PLACEHOLDER
+}
+
 function upload(apiConfig, backupFilePath, sourceStream, callback) {
     assert.strictEqual(typeof apiConfig, 'object');
     assert.strictEqual(typeof backupFilePath, 'string');

src/storage/noop.js

@@ -11,7 +11,9 @@ exports = module.exports = {
     remove: remove,
     removeDir: removeDir,
 
-    testConfig: testConfig
+    testConfig: testConfig,
+    removePrivateFields: removePrivateFields,
+    injectPrivateFields: injectPrivateFields
 };
 
 var assert = require('assert'),
@@ -103,3 +105,9 @@ function testConfig(apiConfig, callback) {
     callback(null);
 }
 
+function removePrivateFields(apiConfig) {
+    return apiConfig;
+}
+
+function injectPrivateFields(newConfig, currentConfig) {
+}

src/storage/s3.js

@@ -11,6 +11,8 @@ exports = module.exports = {
     removeDir: removeDir,
 
     testConfig: testConfig,
+    removePrivateFields: removePrivateFields,
+    injectPrivateFields: injectPrivateFields,
 
     // Used to mock AWS
     _mockInject: mockInject,
@@ -20,6 +22,7 @@ exports = module.exports = {
 var assert = require('assert'),
     async = require('async'),
     AWS = require('aws-sdk'),
+    backups = require('../backups.js'),
     BackupsError = require('../backups.js').BackupsError,
     chunk = require('lodash.chunk'),
     config = require('../config.js'),
@@ -48,10 +51,6 @@ function S3_NOT_FOUND(error) {
     return error.code === 'NoSuchKey' || error.code === 'NotFound' || error.code === 'ENOENT';
 }
 
-function S3_ACCESS_DENIED(error) {
-    return error.code === 'AccessDenied' || error.statusCode === 403;
-}
-
 function getCaasConfig(apiConfig, callback) {
     assert.strictEqual(typeof apiConfig, 'object');
     assert.strictEqual(typeof callback, 'function');
@@ -486,3 +485,12 @@ function testConfig(apiConfig, callback) {
         });
     });
 }
+
+function removePrivateFields(apiConfig) {
+    apiConfig.secretAccessKey = backups.SECRET_PLACEHOLDER;
+    return apiConfig;
+}
+
+function injectPrivateFields(newConfig, currentConfig) {
+    if (newConfig.secretAccessKey === backups.SECRET_PLACEHOLDER) newConfig.secretAccessKey = currentConfig.secretAccessKey;
+}