CLDSRV-848: create one global list of checksumed methods

Author: leif-scality

lib/Config.js

@@ -545,27 +545,7 @@ function bucketNotifAssert(bucketNotifConfig) {
 }
 
 function parseIntegrityChecks(config) {
-    const integrityChecks = {
-        'bucketPutACL': true,
-        'bucketPutCors': true,
-        'bucketPutEncryption': true,
-        'bucketPutLifecycle': true,
-        'bucketPutNotification': true,
-        'bucketPutObjectLock': true,
-        'bucketPutPolicy': true,
-        'bucketPutReplication': true,
-        'bucketPutVersioning': true,
-        'bucketPutWebsite': true,
-        'bucketPutLogging': true,
-        'bucketPutTagging': true,
-        'multiObjectDelete': true,
-        'objectPutACL': true,
-        'objectPutLegalHold': true,
-        'objectPutTagging': true,
-        'objectPutRetention': true,
-        'objectRestore': true,
-        'completeMultipartUpload': true,
-    };
+    const integrityChecks = {};
 
     if (config && config.integrityChecks) {
         for (const method in integrityChecks) {

lib/api/apiUtils/integrity/validateChecksums.js

@@ -5,6 +5,28 @@ const { CrtCrc64Nvme } = require('@aws-sdk/crc64-nvme-crt');
 const { errors: ArsenalErrors } = require('arsenal');
 const { config } = require('../../../Config');
 
+const checksumedMethods = Object.freeze({
+    'completeMultipartUpload': true,
+    'multiObjectDelete': true,
+    'bucketPutACL': true,
+    'bucketPutCors': true,
+    'bucketPutEncryption': true,
+    'bucketPutLifecycle': true,
+    'bucketPutLogging': true,
+    'bucketPutNotification': true,
+    'bucketPutPolicy': true,
+    'bucketPutReplication': true,
+    'bucketPutTagging': true,
+    'bucketPutVersioning': true,
+    'bucketPutWebsite': true,
+    'objectPutACL': true,
+    'objectPutLegalHold': true,
+    'bucketPutObjectLock': true, // PutObjectLockConfiguration
+    'objectPutRetention': true,
+    'objectPutTagging': true,
+    'objectRestore': true,
+});
+
 const ChecksumError = Object.freeze({
     MD5Mismatch: 'MD5Mismatch',
     MD5Invalid: 'MD5Invalid',
@@ -252,29 +274,6 @@ async function defaultValidationFunc(request, body, log) {
     }
 }
 
-const methodValidationFunc = Object.freeze({
-    'completeMultipartUpload': defaultValidationFunc,
-    'bucketPutACL': defaultValidationFunc,
-    'bucketPutCors': defaultValidationFunc,
-    'bucketPutEncryption': defaultValidationFunc,
-    'bucketPutLifecycle': defaultValidationFunc,
-    'bucketPutNotification': defaultValidationFunc,
-    'bucketPutObjectLock': defaultValidationFunc,
-    'bucketPutPolicy': defaultValidationFunc,
-    'bucketPutReplication': defaultValidationFunc,
-    'bucketPutVersioning': defaultValidationFunc,
-    'bucketPutWebsite': defaultValidationFunc,
-    'bucketPutLogging': defaultValidationFunc,
-    'bucketPutTagging': defaultValidationFunc,
-    // TODO: DeleteObjects requires a checksum. Should return an error if ChecksumError.MissingChecksum.
-    'multiObjectDelete': defaultValidationFunc,
-    'objectPutACL': defaultValidationFunc,
-    'objectPutLegalHold': defaultValidationFunc,
-    'objectPutTagging': defaultValidationFunc,
-    'objectPutRetention': defaultValidationFunc,
-    'objectRestore': defaultValidationFunc,
-});
-
 /**
  * validateMethodChecksumsNoChunking - Validate the checksums of a request.
  * @param {object} request - http request
@@ -283,12 +282,12 @@ const methodValidationFunc = Object.freeze({
  * @return {object} - error
  */
 async function validateMethodChecksumNoChunking(request, body, log) {
-    if (config.integrityChecks[request.apiMethod]) {
-        const validationFunc = methodValidationFunc[request.apiMethod];
-        if (!validationFunc) {
-            return null; //await defaultValidationFunc2(request, body, log);
-        }
-        return await validationFunc(request, body, log);
+    if (config.integrityChecks[request.apiMethod] === false) {
+        return null;
+    }
+
+    if (request.apiMethod in checksumedMethods) {
+        return await defaultValidationFunc(request, body, log);
     }
 
     return null;
@@ -298,4 +297,5 @@ module.exports = {
     ChecksumError,
     validateChecksumsNoChunking,
     validateMethodChecksumNoChunking,
+    checksumedMethods,
 };

tests/unit/Config.js

@@ -920,7 +920,7 @@ describe('Config', () => {
     });
 
     describe('parse integrity checks', () => {
-        it('should replace default values with new values', () => {
+        it('should insert values into integrityCheck object', () => {
             const newConfig = {
                 integrityChecks: {
                     'bucketPutACL': false,

tests/unit/api/apiUtils/integrity/validateChecksums.js

@@ -2,7 +2,7 @@ const assert = require('assert');
 const crypto = require('crypto');
 const sinon = require('sinon');
 
-const { validateChecksumsNoChunking, ChecksumError, validateMethodChecksumNoChunking } =
+const { validateChecksumsNoChunking, ChecksumError, validateMethodChecksumNoChunking, checksumedMethods } =
     require('../../../../../lib/api/apiUtils/integrity/validateChecksums');
 const { errors: ArsenalErrors } = require('arsenal');
 const { config } = require('../../../../../lib/Config');
@@ -278,24 +278,6 @@ describe('validateMethodChecksumNoChunking', () => {
     let sandbox;
     let originalIntegrityChecks;
 
-    const supportedMethods = [
-        'bucketPutACL',
-        'bucketPutCors',
-        'bucketPutEncryption',
-        'bucketPutLifecycle',
-        'bucketPutNotification',
-        'bucketPutObjectLock',
-        'bucketPutPolicy',
-        'bucketPutReplication',
-        'bucketPutVersioning',
-        'bucketPutWebsite',
-        'multiObjectDelete',
-        'objectPutACL',
-        'objectPutLegalHold',
-        'objectPutTagging',
-        'objectPutRetention'
-    ];
-
     beforeEach(() => {
         sandbox = sinon.createSandbox();
         originalIntegrityChecks = { ...config.integrityChecks };
@@ -307,7 +289,7 @@ describe('validateMethodChecksumNoChunking', () => {
     });
 
     describe('when checksum mismatches', () => {
-        supportedMethods.forEach(method => {
+        Object.keys(checksumedMethods).forEach(method => {
             it(`should return BadDigest error for ${method} when checksum mismatch`, async () => {
                 config.integrityChecks[method] = true;
 
@@ -330,7 +312,7 @@ describe('validateMethodChecksumNoChunking', () => {
     });
 
     describe('when checksum mismatches', () => {
-        supportedMethods.forEach(method => {
+        Object.keys(checksumedMethods).forEach(method => {
             it(`should return InvalidDigest error for ${method} when checksum mismatch`, async () => {
                 config.integrityChecks[method] = true;
 
@@ -353,7 +335,7 @@ describe('validateMethodChecksumNoChunking', () => {
     });
 
     describe('when no checksum is provided', () => {
-        supportedMethods.forEach(method => {
+        Object.keys(checksumedMethods).forEach(method => {
             it(`should return null for ${method} when no checksum is provided`, async () => {
                 config.integrityChecks[method] = true;
 
@@ -373,7 +355,7 @@ describe('validateMethodChecksumNoChunking', () => {
     });
 
     describe('when checksum matches', () => {
-        supportedMethods.forEach(method => {
+        Object.keys(checksumedMethods).forEach(method => {
             it(`should return null for ${method} when checksum matches`, async () => {
                 config.integrityChecks[method] = true;
 
@@ -396,7 +378,7 @@ describe('validateMethodChecksumNoChunking', () => {
     });
 
     describe('when method is disabled in config', () => {
-        supportedMethods.forEach(method => {
+        Object.keys(checksumedMethods).forEach(method => {
             it(`should return null for ${method} when disabled, even with checksum mismatch`, async () => {
                 config.integrityChecks[method] = false;