Merge branch 'w/9.3/feature/CLDSRV-886-configurable-server-header' into tmp/normal/q/9.3

Author: bert-e

lib/Config.js

@@ -972,6 +972,8 @@ class Config extends EventEmitter {
                 'bad config: internalPort must be a positive integer');
         }
 
+        this.serverHeader = config.serverHeader || 'S3 Server';
+
         this.port = config.port;
         this.listenOn = this._parseEndpoints(config.listenOn, 'listenOn');
         this.internalPort = config.internalPort;

lib/server.js

@@ -3,6 +3,7 @@ const https = require('https');
 const cluster = require('cluster');
 const { series } = require('async');
 const arsenal = require('arsenal');
+const { setServerHeader } = arsenal.s3routes.routesUtils;
 const { RedisClient, StatsClient } = arsenal.metrics;
 const monitoringClient = require('./utilities/monitoringHandler');
 
@@ -34,6 +35,8 @@ const websiteEndpoints = _config.websiteEndpoints;
 let client = dataWrapper.client;
 const implName = dataWrapper.implName;
 
+setServerHeader(_config.serverHeader);
+
 let allEndpoints;
 function updateAllEndpoints() {
     allEndpoints = Object.keys(_config.restEndpoints);

package.json

@@ -30,7 +30,7 @@
     "@azure/storage-blob": "^12.28.0",
     "@hapi/joi": "^17.1.1",
     "@smithy/node-http-handler": "^3.0.0",
-    "arsenal": "git+https://github.com/scality/Arsenal#8.3.8",
+    "arsenal": "git+https://github.com/scality/Arsenal#8.3.9",
     "async": "2.6.4",
     "bucketclient": "scality/bucketclient#8.2.7",
     "bufferutil": "^4.0.8",

tests/functional/healthchecks/test/checkRoutes.js

@@ -131,6 +131,22 @@ if (config.healthChecks.enableInternalRoute) {
     });
 }
 
+describe('Server response header', () => {
+    it('should return the configured serverHeader value on S3 API responses', done => {
+        const getOptions = deepCopy(options);
+        getOptions.method = 'GET';
+        getOptions.path = '/';
+        getOptions.port = config.port || 8000;
+        getOptions.agent = makeAgent();
+        const req = transport.request(getOptions, res => {
+            assert.strictEqual(res.headers['server'], config.serverHeader);
+            done();
+        });
+        req.on('error', done);
+        req.end();
+    });
+});
+
 describe('Healthcheck stats', () => {
     const totalReqs = 5;
     beforeEach(done => {

tests/unit/Config.js

@@ -983,4 +983,31 @@ describe('Config', () => {
             assert.throws(() => new ConfigObject());
         });
     });
+
+    describe('serverHeader', () => {
+        let sandbox;
+        let readFileStub;
+
+        beforeEach(() => {
+            sandbox = sinon.createSandbox();
+            readFileStub = sandbox.stub(fs, 'readFileSync');
+            readFileStub.callThrough();
+        });
+
+        afterEach(() => {
+            sandbox.restore();
+        });
+
+        it('should default to "S3 Server" when not configured', () => {
+            const config = new ConfigObject();
+            assert.strictEqual(config.serverHeader, 'S3 Server');
+        });
+
+        it('should use the configured value when set', () => {
+            const modifiedConfig = { ...defaultConfig, serverHeader: 'ScalityS3' };
+            readFileStub.withArgs(sinon.match(/config.json$/)).returns(JSON.stringify(modifiedConfig));
+            const config = new ConfigObject();
+            assert.strictEqual(config.serverHeader, 'ScalityS3');
+        });
+    });
 });

yarn.lock

@@ -6181,9 +6181,9 @@ arraybuffer.prototype.slice@^1.0.4:
   optionalDependencies:
     ioctl "^2.0.2"
 
-"arsenal@git+https://github.com/scality/Arsenal#8.3.8":
-  version "8.3.8"
-  resolved "git+https://github.com/scality/Arsenal#ded10b14ec7e1cc4ab813a88439a27a74c7e2a19"
+"arsenal@git+https://github.com/scality/Arsenal#8.3.9":
+  version "8.3.9"
+  resolved "git+https://github.com/scality/Arsenal#51e5b761f7f0612a722c828fa3d43b438c50ab7c"
   dependencies:
     "@aws-sdk/client-kms" "^3.975.0"
     "@aws-sdk/client-s3" "^3.975.0"