Config.js

const assert = require('assert');
const { EventEmitter } = require('events');
const fs = require('fs');
const path = require('path');
const url = require('url');
const crypto = require('crypto');

const { v4: uuidv4 } = require('uuid');
const cronParser = require('cron-parser');
const joi = require('@hapi/joi');
const { s3routes, auth: arsenalAuth, s3middleware } = require('arsenal');
const { isValidBucketName } = s3routes.routesUtils;
const validateAuthConfig = arsenalAuth.inMemory.validateAuthConfig;
const { buildAuthDataAccount } = require('./auth/in_memory/builder');
const validExternalBackends = require('../constants').externalBackends;
const {
    azureAccountNameRegex,
    base64Regex,
    allowedUtapiEventFilterFields,
    allowedUtapiEventFilterStates,
    supportedLifecycleRules,
} = require('../constants');

// TODO CLDSRV-610: re-enable utapi
// const { utapiVersion } = require('utapi');
const utapiVersion = null;

const { scaleMsPerDay } = s3middleware.objectUtils;

const constants = require('../constants');

// config paths
const configSearchPaths = [
    path.join(__dirname, '../conf'),
    path.join(__dirname, '..'),
];

function findConfigFile(fileName) {
    if (fileName[0] === '/') {
        return fileName;
    }
    const containingPath = configSearchPaths.find(configPath => {
        const testFilePath = path.join(configPath, fileName);
        return fs.existsSync(testFilePath);
    });
    if (!containingPath) {
        throw new Error(`Unable to find the configuration file "${fileName}" ` +
        `under the paths: ${JSON.stringify(configSearchPaths)}`);
    }
    return path.join(containingPath, fileName);
}

// whitelist IP, CIDR for health checks
const defaultHealthChecks = { allowFrom: ['127.0.0.1/8', '::1'] };

const defaultLocalCache = { host: '127.0.0.1', port: 6379 };
const defaultExternalBackendsConfig = {
    // eslint-disable-next-line camelcase
    aws_s3: {
        httpAgent: {
            keepAlive: false,
            keepAliveMsecs: 1000,
            maxFreeSockets: 256,
            maxSockets: null,
        },
    },
    gcp: {
        httpAgent: {
            keepAlive: true,
            keepAliveMsecs: 1000,
            maxFreeSockets: 256,
            maxSockets: null,
        },
    },
};

function assertCertPaths(key, cert, ca, basePath) {
    const certObj = {};
    certObj.paths = {};
    certObj.certs = {};
    if (key) {
        const keypath = key.startsWith('/') ? key : `${basePath}/${key}`;
        assert.doesNotThrow(() =>
            fs.accessSync(keypath, fs.F_OK | fs.R_OK),
            `File not found or unreachable: ${keypath}`);
        certObj.paths.key = keypath;
        certObj.certs.key = fs.readFileSync(keypath, 'ascii');
    }
    if (cert) {
        const certpath = cert.startsWith('/') ? cert : `${basePath}/${cert}`;
        assert.doesNotThrow(() =>
            fs.accessSync(certpath, fs.F_OK | fs.R_OK),
            `File not found or unreachable: ${certpath}`);
        certObj.paths.cert = certpath;
        certObj.certs.cert = fs.readFileSync(certpath, 'ascii');
    }

    if (ca) {
        const capath = ca.startsWith('/') ? ca : `${basePath}/${ca}`;
        assert.doesNotThrow(() =>
            fs.accessSync(capath, fs.F_OK | fs.R_OK),
            `File not found or unreachable: ${capath}`);
        certObj.paths.ca = capath;
        certObj.certs.ca = fs.readFileSync(capath, 'ascii');
    }
    return certObj;
}

function parseSproxydConfig(configSproxyd) {
    const joiSchema = joi.object({
        bootstrap: joi.array().items(joi.string()).min(1),
        chordCos: joi.number().integer().min(0).max(6),
        path: joi.string(),
    });
    return joi.attempt(configSproxyd, joiSchema, 'bad config');
}

function parseRedisConfig(redisConfig) {
    const joiSchema = joi.object({
        password: joi.string().allow(''),
        host: joi.string(),
        port: joi.number(),
        retry: joi.object({
            connectBackoff: joi.object({
                min: joi.number().required(),
                max: joi.number().required(),
                jitter: joi.number().required(),
                factor: joi.number().required(),
                deadline: joi.number().required(),
            }),
        }),
        // sentinel config
        sentinels: joi.alternatives().try(
            joi.string()
                .pattern(/^[a-zA-Z0-9.-]+:[0-9]+(,[a-zA-Z0-9.-]+:[0-9]+)*$/)
                .custom(hosts => hosts.split(',').map(item => {
                    const [host, port] = item.split(':');
                    return { host, port: Number.parseInt(port, 10) };
                })),
            joi.array().items(
                joi.object({
                    host: joi.string().required(),
                    port: joi.number().required(),
                })
            ).min(1),
        ),
        name: joi.string(),
        sentinelPassword: joi.string().allow(''),
    })
          .and('host', 'port')
          .and('sentinels', 'name')
          .xor('host', 'sentinels')
          .without('sentinels', ['host', 'port'])
          .without('host', ['sentinels', 'sentinelPassword']);

    return joi.attempt(redisConfig, joiSchema, 'bad config');
}

function parseSupportedLifecycleRules(supportedLifecycleRulesConfig) {
    const supportedLifecycleRulesSchema = joi.array()
        .items(joi.string().valid(...supportedLifecycleRules))
        .default(supportedLifecycleRules)
        .min(1);
    return joi.attempt(
        supportedLifecycleRulesConfig,
        supportedLifecycleRulesSchema,
        'bad supported lifecycle rules config',
    );
}

function restEndpointsAssert(restEndpoints, locationConstraints) {
    assert(typeof restEndpoints === 'object',
        'bad config: restEndpoints must be an object of endpoints');
    assert(Object.keys(restEndpoints).every(
        r => typeof restEndpoints[r] === 'string'),
        'bad config: each endpoint must be a string');
    assert(Object.keys(restEndpoints).every(
        r => typeof locationConstraints[restEndpoints[r]] === 'object'),
        'bad config: rest endpoint target not in locationConstraints');
}

function gcpLocationConstraintAssert(location, locationObj) {
    const {
        gcpEndpoint,
        bucketName,
        mpuBucketName,
    } = locationObj.details;
    const stringFields = [
        gcpEndpoint,
        bucketName,
        mpuBucketName,
    ];
    stringFields.forEach(field => {
        if (field !== undefined) {
            assert(typeof field === 'string',
                `bad config: ${field} must be a string`);
        }
    });
}

function azureGetStorageAccountName(location, locationDetails) {
    const { azureStorageAccountName } = locationDetails;
    const storageAccountNameFromEnv =
        process.env[`${location}_AZURE_STORAGE_ACCOUNT_NAME`];
    return storageAccountNameFromEnv || azureStorageAccountName;
}

function azureGetLocationCredentials(location, locationDetails) {
    const storageAccessKey =
        process.env[`${location}_AZURE_STORAGE_ACCESS_KEY`] ||
        locationDetails.azureStorageAccessKey;
    const sasToken =
        process.env[`${location}_AZURE_SAS_TOKEN`] ||
        locationDetails.sasToken;
    const clientKey =
        process.env[`${location}_AZURE_CLIENT_KEY`] ||
        locationDetails.clientKey;

    const authMethod =
        process.env[`${location}_AZURE_AUTH_METHOD`] ||
        locationDetails.authMethod ||
        (storageAccessKey && 'shared-key') ||
        (sasToken && 'shared-access-signature') ||
        (clientKey && 'client-secret') ||
        'shared-key';

    switch (authMethod) {
    case 'shared-key':
    default:
        return {
            authMethod,
            storageAccountName:
                azureGetStorageAccountName(location, locationDetails),
            storageAccessKey,
        };

    case 'shared-access-signature':
        return {
            authMethod,
            sasToken,
        };

    case 'client-secret':
        return {
            authMethod,
            tenantId:
                process.env[`${location}_AZURE_TENANT_ID`] ||
                locationDetails.tenantId,
            clientId:
                process.env[`${location}_AZURE_CLIENT_ID`] ||
                locationDetails.clientId,
            clientKey,
        };
    }
}

function azureLocationConstraintAssert(location, locationObj) {
    const locationParams = {
        ...azureGetLocationCredentials(location, locationObj.details),
        azureStorageEndpoint:
            process.env[`${location}_AZURE_STORAGE_ENDPOINT`] ||
            locationObj.details.azureStorageEndpoint,
        azureContainerName: locationObj.details.azureContainerName,
    };

    Object.keys(locationParams).forEach(param => {
        const value = locationParams[param];
        assert.notEqual(value, undefined,
            `bad location constraint: "${location}" ${param} ` +
            'must be set in locationConfig or environment variable');
        assert.strictEqual(typeof value, 'string',
            `bad location constraint: "${location}" ${param} ` +
            `"${value}" must be a string`);
    });

    if (locationParams.authMethod === 'shared-key') {
        assert(azureAccountNameRegex.test(locationParams.storageAccountName),
            `bad location constraint: "${location}" azureStorageAccountName ` +
            `"${locationParams.storageAccountName}" is an invalid value`);
        assert(base64Regex.test(locationParams.storageAccessKey),
            `bad location constraint: "${location}" ` +
            'azureStorageAccessKey is not a valid base64 string');
    }
    assert(isValidBucketName(locationParams.azureContainerName, []),
        `bad location constraint: "${location}" ` +
        'azureContainerName is an invalid container name');
}

function hdClientLocationConstraintAssert(configHd) {
    const hdclientFields = [];
    if (configHd.bootstrap !== undefined) {
        assert(Array.isArray(configHd.bootstrap)
            && configHd.bootstrap
                .every(e => typeof e === 'string'),
            'bad config: hdclient.bootstrap must be an array of strings');
        assert(configHd.bootstrap.length > 0,
                'bad config: hdclient bootstrap list is empty');
        hdclientFields.push('bootstrap');
    }
    return hdclientFields;
}

function azureArchiveLocationConstraintAssert(locationObj) {
    const checkedFields = [
        'azureContainerName',
        'azureStorageEndpoint',
    ];
    if (Object.keys(locationObj.details).length === 0 ||
        !checkedFields.every(field => field in locationObj.details)) {
        return;
    }
    const {
        azureContainerName,
        azureStorageEndpoint,
    } = locationObj.details;
    const stringFields = [
        azureContainerName,
        azureStorageEndpoint,
    ];
    stringFields.forEach(field => {
        assert(typeof field === 'string',
            `bad config: ${field} must be a string`);
    });

    let hasAuthMethod = false;
    if (locationObj.details.sasToken !== undefined) {
        assert(typeof locationObj.details.sasToken === 'string',
            `bad config: ${locationObj.details.sasToken} must be a string`);
        hasAuthMethod = true;
    }

    if (locationObj.details.azureStorageAccountName !== undefined &&
        locationObj.details.azureStorageAccessKey !== undefined) {
        assert(typeof locationObj.details.azureStorageAccountName === 'string',
            `bad config: ${locationObj.details.azureStorageAccountName} must be a string`);
        assert(typeof locationObj.details.azureStorageAccessKey === 'string',
            `bad config: ${locationObj.details.azureStorageAccessKey} must be a string`);
        assert(!hasAuthMethod, 'Multiple authentication methods are not allowed');
        hasAuthMethod = true;
    }

    if (locationObj.details.tenantId !== undefined &&
        locationObj.details.clientId !== undefined &&
        locationObj.details.clientKey !== undefined) {
        assert(typeof locationObj.details.tenantId === 'string',
            `bad config: ${locationObj.details.tenantId} must be a string`);
        assert(typeof locationObj.details.clientId === 'string',
            `bad config: ${locationObj.details.clientId} must be a string`);
        assert(typeof locationObj.details.clientKey === 'string',
            `bad config: ${locationObj.details.clientKey} must be a string`);
        assert(!hasAuthMethod, 'Multiple authentication methods are not allowed');
        hasAuthMethod = true;
    }
    assert(hasAuthMethod, 'Missing authentication method');
}

function dmfLocationConstraintAssert(locationObj) {
    const checkedFields = [
        'endpoint',
        'username',
        'password',
        'repoId',
        'nsId',
    ];
    if (Object.keys(locationObj.details).length === 0 ||
        !checkedFields.every(field => field in locationObj.details)) {
        return;
    }
    const {
        endpoint,
        username,
        password,
        repoId,
        nsId,
    } = locationObj.details;
    const stringFields = [
        endpoint,
        username,
        password,
        nsId,
    ];
    stringFields.forEach(field => {
        assert(typeof field === 'string',
            `bad config: ${field} must be a string`);
    });
    assert.strictEqual(Array.isArray(repoId), true);
    repoId.forEach(rId => {
        assert(typeof rId === 'string',
            `bad config: ${rId} must be a string`);
    });
    assert(repoId.every(
        r => typeof r === 'string'),
        'bad config: each repoId must be a string',
    );
}

function locationConstraintAssert(locationConstraints) {
    const supportedBackends =
          ['mem', 'file', 'scality',
           'mongodb', 'dmf', 'azure_archive'].concat(Object.keys(validExternalBackends));
    assert(typeof locationConstraints === 'object',
        'bad config: locationConstraints must be an object');
    Object.keys(locationConstraints).forEach(l => {
        assert(typeof locationConstraints[l] === 'object',
            'bad config: locationConstraints[region] must be an object');
        assert(typeof locationConstraints[l].type === 'string',
            'bad config: locationConstraints[region].type is ' +
            'mandatory and must be a string');
        assert(supportedBackends.indexOf(locationConstraints[l].type) > -1,
            'bad config: locationConstraints[region].type must ' +
            `be one of ${supportedBackends}`);
        assert(typeof locationConstraints[l].objectId === 'string',
               'bad config: locationConstraints[region].objectId is ' +
               'mandatory and must be a unique string across locations');
        assert(Object.keys(locationConstraints)
               .filter(loc => (locationConstraints[loc].objectId ===
                               locationConstraints[l].objectId))
               .length === 1,
               'bad config: location constraint objectId ' +
               `"${locationConstraints[l].objectId}" is not unique across ` +
               'configured locations');
        assert(typeof locationConstraints[l].legacyAwsBehavior
            === 'boolean',
            'bad config: locationConstraints[region]' +
            '.legacyAwsBehavior is mandatory and must be a boolean');
        assert(['undefined', 'boolean'].includes(
            typeof locationConstraints[l].isTransient),
               'bad config: locationConstraints[region]' +
               '.isTransient must be a boolean');
        if (locationConstraints[l].sizeLimitGB !== undefined) {
            assert(typeof locationConstraints[l].sizeLimitGB === 'number' ||
                locationConstraints[l].sizeLimitGB === null,
                'bad config: locationConstraints[region].sizeLimitGB ' +
                'must be a number (in gigabytes)');
        }

        const details = locationConstraints[l].details;
        assert(typeof details === 'object',
            'bad config: locationConstraints[region].details is ' +
            'mandatory and must be an object');
        if (details.serverSideEncryption !== undefined) {
            assert(typeof details.serverSideEncryption === 'boolean',
              'bad config: locationConstraints[region]' +
              '.details.serverSideEncryption must be a boolean');
        }
        const stringFields = [
            'awsEndpoint',
            'bucketName',
            'credentialsProfile',
            'region',
        ];
        stringFields.forEach(field => {
            if (details[field] !== undefined) {
                assert(typeof details[field] === 'string',
                    `bad config: ${field} must be a string`);
            }
        });
        if (details.bucketMatch !== undefined) {
            assert(typeof details.bucketMatch === 'boolean',
                'bad config: details.bucketMatch must be a boolean');
        }
        if (details.credentials !== undefined) {
            assert(typeof details.credentials === 'object',
                'bad config: details.credentials must be an object');
            assert(typeof details.credentials.accessKey === 'string',
                'bad config: credentials must include accessKey as string');
            assert(typeof details.credentials.secretKey === 'string',
                'bad config: credentials must include secretKey as string');
        }
        if (process.env.CI_CEPH === 'true') {
            // eslint-disable-next-line no-param-reassign
            locationConstraints[l].details.https = false;
        } else if (details.https !== undefined) {
            assert(typeof details.https === 'boolean', 'bad config: ' +
                'locationConstraints[region].details https must be a boolean');
        } else {
            // eslint-disable-next-line no-param-reassign
            locationConstraints[l].details.https = true;
        }

        if (details.pathStyle !== undefined) {
            assert(typeof details.pathStyle === 'boolean', 'bad config: ' +
                'locationConstraints[region].pathStyle must be a boolean');
        } else if (process.env.CI_CEPH === 'true') {
            // eslint-disable-next-line no-param-reassign
            locationConstraints[l].details.pathStyle = true;
        } else {
            // eslint-disable-next-line no-param-reassign
            locationConstraints[l].details.pathStyle = false;
        }

        if (details.supportsVersioning !== undefined) {
            assert(typeof details.supportsVersioning === 'boolean',
                'bad config: locationConstraints[region].supportsVersioning' +
                'must be a boolean');
        } else {
            // default to true
            // eslint-disable-next-line no-param-reassign
            locationConstraints[l].details.supportsVersioning = true;
        }

        if (locationConstraints[l].type === 'azure') {
            azureLocationConstraintAssert(l, locationConstraints[l]);
        }
        if (locationConstraints[l].type === 'gcp') {
            gcpLocationConstraintAssert(l, locationConstraints[l]);
        }
        if (locationConstraints[l].type === 'dmf') {
            dmfLocationConstraintAssert(locationConstraints[l]);
        }
        if (locationConstraints[l].type === 'azure_archive') {
            azureArchiveLocationConstraintAssert(locationConstraints[l]);
        }
        if (locationConstraints[l].type === 'pfs') {
            assert(typeof details.pfsDaemonEndpoint === 'object',
            'bad config: pfsDaemonEndpoint is mandatory and must be an object');
        }
        if (locationConstraints[l].type === 'scality' &&
            locationConstraints[l].details.connector !== undefined &&
            locationConstraints[l].details.connector.hdclient !== undefined) {
            hdClientLocationConstraintAssert(
                locationConstraints[l].details.connector.hdclient);
        }
    });
    assert(Object.keys(locationConstraints)
        .includes('us-east-1'), 'bad locationConfig: must ' +
        'include us-east-1 as a locationConstraint');
}

function parseUtapiReindex(config) {
    const {
        enabled,
        schedule,
        redis,
        bucketd,
        onlyCountLatestWhenObjectLocked,
    } = config;
    assert(typeof enabled === 'boolean',
           'bad config: utapi.reindex.enabled must be a boolean');

    const parsedRedis = parseRedisConfig(redis);
    assert(Array.isArray(parsedRedis.sentinels),
           'bad config: utapi reindex redis config requires a list of sentinels');

    assert(typeof bucketd === 'object',
        'bad config: utapi.reindex.bucketd must be an object');
    assert(typeof bucketd.port === 'number',
        'bad config: utapi.reindex.bucketd.port must be a number');
    assert(typeof schedule === 'string',
        'bad config: utapi.reindex.schedule must be a string');
    if (onlyCountLatestWhenObjectLocked !== undefined) {
        assert(typeof onlyCountLatestWhenObjectLocked === 'boolean',
            'bad config: utapi.reindex.onlyCountLatestWhenObjectLocked must be a boolean');
    }
    try {
        cronParser.parseExpression(schedule);
    } catch (e) {
        assert(false,
            'bad config: utapi.reindex.schedule must be a valid ' +
            `cron schedule. ${e.message}.`);
    }
    return {
        enabled,
        schedule,
        redis: parsedRedis,
        bucketd,
        onlyCountLatestWhenObjectLocked,
    };
}

function requestsConfigAssert(requestsConfig) {
    if (requestsConfig.viaProxy !== undefined) {
        assert(typeof requestsConfig.viaProxy === 'boolean',
        'config: invalid requests configuration. viaProxy must be a ' +
        'boolean');

        if (requestsConfig.viaProxy) {
            assert(Array.isArray(requestsConfig.trustedProxyCIDRs) &&
            requestsConfig.trustedProxyCIDRs.length > 0 &&
            requestsConfig.trustedProxyCIDRs
                .every(ip => typeof ip === 'string'),
            'config: invalid requests configuration. ' +
            'trustedProxyCIDRs must be set if viaProxy is set to true ' +
            'and must be an array');

            assert(typeof requestsConfig.extractClientIPFromHeader === 'string'
            && requestsConfig.extractClientIPFromHeader.length > 0,
            'config: invalid requests configuration. ' +
            'extractClientIPFromHeader must be set if viaProxy is ' +
            'set to true and must be a string');

            assert(typeof requestsConfig.extractProtocolFromHeader === 'string'
            && requestsConfig.extractProtocolFromHeader.length > 0,
            'config: invalid requests configuration. ' +
            'extractProtocolFromHeader must be set if viaProxy is ' +
            'set to true and must be a string');
        }
    }
}

function bucketNotifAssert(bucketNotifConfig) {
    assert(Array.isArray(bucketNotifConfig),
        'bad config: bucket notification configuration must be an array');
    bucketNotifConfig.forEach(c => {
        const { resource, type, host, port, auth } = c;
        assert(typeof resource === 'string',
            'bad config: bucket notification configuration resource must be a string');
        assert(typeof type === 'string',
            'bad config: bucket notification configuration type must be a string');
        assert(typeof host === 'string' && host !== '',
            'bad config: hostname must be a non-empty string');
        if (port) {
            assert(Number.isInteger(port, 10) && port > 0,
                'bad config: port must be a positive integer');
        }
        if (auth) {
            assert(typeof auth === 'object',
                'bad config: bucket notification auth must be an object');
        }
    });
    return bucketNotifConfig;
}

/**
 * Reads from a config file and returns the content as a config object
 */
class Config extends EventEmitter {
    constructor() {
        super();
        /*
         * Config files will be looked up under the directories:
         * <project-root>/conf
         * <project-root>
         *
         * An error will be thrown if the config files cannot be found
         *
         * The path to the "config.json" config can be overridden using the
         * S3_CONFIG_FILE environment var
         *
         * The path to the "locationConfig.json" config can be overridden using
         * the S3_LOCATION_FILE environment var.
         */
        this._basePath = path.join(__dirname, '..');
        this.configPath = findConfigFile(process.env.S3_CONFIG_FILE ||
                                         'config.json');

        let locationConfigFileName = 'locationConfig.json';
        if (process.env.CI === 'true' && !process.env.S3_END_TO_END) {
            locationConfigFileName =
                'tests/locationConfig/locationConfigTests.json';
        }
        this.locationConfigPath = findConfigFile(process.env.S3_LOCATION_FILE ||
                                                 locationConfigFileName);

        if (process.env.S3_REPLICATION_FILE !== undefined) {
            this.replicationConfigPath = process.env.S3_REPLICATION_FILE;
        }

        // Read config automatically
        this._getLocationConfig();
        this._getConfig();
        this._configureBackends();
    }

    _parseKmsAWS(config) {
        if (!config.kmsAWS) {
            return {};
        }
        let kmsAWS = {};

        const { region, endpoint, ak, sk, tls } = config.kmsAWS;

        assert(endpoint, 'Configuration Error: endpoint must be defined in kmsAWS');
        assert(ak, 'Configuration Error: ak must be defined in kmsAWS');
        assert(sk, 'Configuration Error: sk must be defined in kmsAWS');

        kmsAWS = {
            endpoint,
            ak,
            sk,
        };

        if (region) {
            kmsAWS.region = region;
        }

        if (tls) {
            kmsAWS.tls = {};
            if (tls.rejectUnauthorized !== undefined) {
                assert(typeof tls.rejectUnauthorized === 'boolean');
                kmsAWS.tls.rejectUnauthorized = tls.rejectUnauthorized;
            }
            // min & max TLS: One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'
            // (see https://nodejs.org/api/tls.html#tlscreatesecurecontextoptions)
            if (tls.minVersion !== undefined) {
                assert(typeof tls.minVersion === 'string',
                    'bad config: KMS AWS TLS minVersion must be a string');
                kmsAWS.tls.minVersion = tls.minVersion;
            }
            if (tls.maxVersion !== undefined) {
                assert(typeof tls.maxVersion === 'string',
                    'bad config: KMS AWS TLS maxVersion must be a string');
                kmsAWS.tls.maxVersion = tls.maxVersion;
            }
            if (tls.ca !== undefined) {
                kmsAWS.tls.ca = this._loadTlsFileArray(tls.ca);
            }
            if (tls.cert !== undefined) {
                kmsAWS.tls.cert = this._loadTlsFileArray(tls.cert);
            }
            if (tls.key !== undefined) {
                kmsAWS.tls.key = this._loadTlsFileArray(tls.key);
            }
        }

        return kmsAWS;
    }

    _getLocationConfig() {
        let locationConfig;
        try {
            const data = fs.readFileSync(this.locationConfigPath,
            { encoding: 'utf-8' });
            locationConfig = JSON.parse(data);
        } catch (err) {
            throw new Error(`could not parse location config file:
            ${err.message}`);
        }

        this.locationConstraints = {};
        locationConstraintAssert(locationConfig);
        this.locationConstraints = locationConfig;
        Object.keys(locationConfig).forEach(l => {
            const details = this.locationConstraints[l].details;
            if (locationConfig[l].details.connector !== undefined) {
                assert(typeof locationConfig[l].details.connector ===
                'object', 'bad config: connector must be an object');
                if (locationConfig[l].details.connector.sproxyd !==
                    undefined) {
                    details.connector.sproxyd = parseSproxydConfig(
                        locationConfig[l].details.connector.sproxyd);
                }
            }
        });
    }

    _loadTlsFile(tlsFileName) {
        if (!tlsFileName) {
            return undefined;
        }
        if (typeof tlsFileName !== 'string') {
            throw new Error(
                'bad config: TLS file specification must be a string');
        }
        const tlsFilePath = (tlsFileName[0] === '/')
              ? tlsFileName
              : path.join(this._basePath, tlsFileName);
        let tlsFileContent;
        try {
            tlsFileContent = fs.readFileSync(tlsFilePath);
        } catch (err) {
            throw new Error(`Could not load tls file '${tlsFileName}':` +
                            ` ${err.message}`);
        }
        return tlsFileContent;
    }

    // Load TLS file or array of files
    // if tlsFilename is a string, result will be a Buffer containing the file content
    // if tlsFilename is an array of string, result will be  an array of Buffer
    _loadTlsFileArray(tlsFileName) {
        let res;
        if (Array.isArray(tlsFileName)) {
            res = tlsFileName.map(tlsFile => this._loadTlsFile(tlsFile));
        } else {
            res = this._loadTlsFile(tlsFileName);
        }
        return res;
    }

    /**
     * Parse list of endpoints.
     * @param {string[] | undefined} listenOn - List of string of the form "ip:port"
     * @param {string} fieldName - Name of field being parsed
     * @returns {{ip: string, port: number}[]} - List of ip/port pairs
     */
    _parseEndpoints(listenOn, fieldName) {
        let result = [];
        if (listenOn !== undefined) {
            assert(Array.isArray(listenOn)
                && listenOn.every(e => typeof e === 'string'),
                `bad config: ${fieldName} must be a list of strings`);
            result = listenOn.map(item => {
                const lastColon = item.lastIndexOf(':');
                // if address is IPv6 format, it includes brackets
                // that have to be removed from the final IP address
                const ipAddress = item.indexOf(']') > 0 ?
                    item.substr(1, lastColon - 2) :
                    item.substr(0, lastColon);
                // the port should not include the colon
                const port = item.substr(lastColon + 1);
                assert(Number.parseInt(port, 10),
                    `bad config: ${fieldName} port must be a positive integer`);
                return { ip: ipAddress, port };
            });
        }
        return result;
    }

    _getConfig() {
        let config;
        try {
            const data = fs.readFileSync(this.configPath,
              { encoding: 'utf-8' });
            config = JSON.parse(data);
        } catch (err) {
            throw new Error(`could not parse config file: ${err.message}`);
        }
        if (this.replicationConfigPath) {
            try {
                const repData = fs.readFileSync(this.replicationConfigPath,
                  { encoding: 'utf-8' });
                const replicationEndpoints = JSON.parse(repData);
                config.replicationEndpoints.push(...replicationEndpoints);
            } catch (err) {
                throw new Error(
                    `could not parse replication file: ${err.message}`);
            }
        }

        this.port = 8000;
        if (config.port !== undefined) {
            assert(Number.isInteger(config.port) && config.port > 0,
                'bad config: port must be a positive integer');
            this.port = config.port;
        }

        this.listenOn = this._parseEndpoints(config.listenOn, 'listenOn');

        this.metricsPort = 8002;
        if (config.metricsPort !== undefined) {
            assert(Number.isInteger(config.metricsPort) && config.metricsPort > 0,
                'bad config: metricsPort must be a positive integer');
            this.metricsPort = config.metricsPort;
        }

        this.metricsListenOn = this._parseEndpoints(config.metricsListenOn, 'metricsListenOn');

        if (config.replicationGroupId) {
            assert(typeof config.replicationGroupId === 'string',
                'bad config: replicationGroupId must be a string');
            this.replicationGroupId = config.replicationGroupId;
        } else {
            this.replicationGroupId = 'RG001';
        }

        this.replicationEndpoints = [];
        if (config.replicationEndpoints) {
            const { replicationEndpoints } = config;
            assert(replicationEndpoints instanceof Array, 'bad config: ' +
                '`replicationEndpoints` property must be an array');
            replicationEndpoints.forEach(replicationEndpoint => {
                assert.strictEqual(typeof replicationEndpoint, 'object',
                    'bad config: `replicationEndpoints` property must be an ' +
                    'array of objects');
                const { site, servers, type } = replicationEndpoint;
                assert.notStrictEqual(site, undefined, 'bad config: each ' +
                    'object of `replicationEndpoints` array must have a ' +
                    '`site` property');
                assert.strictEqual(typeof site, 'string', 'bad config: ' +
                    '`site` property of object in `replicationEndpoints` ' +
                    'must be a string');
                assert.notStrictEqual(site, '', 'bad config: `site` property ' +
                    "of object in `replicationEndpoints` must not be ''");
                if (type !== undefined) {
                    assert(validExternalBackends[type], 'bad config: `type` ' +
                        'property of `replicationEndpoints` object must be ' +
                        'a valid external backend (one of: "' +
                        `${Object.keys(validExternalBackends).join('", "')}")`);
                } else {
                    assert.notStrictEqual(servers, undefined, 'bad config: ' +
                        'each object of `replicationEndpoints` array that is ' +
                        'not an external backend must have `servers` property');
                    assert(servers instanceof Array, 'bad config: ' +
                        '`servers` property of object in ' +
                        '`replicationEndpoints` must be an array');
                    servers.forEach(item => {
                        assert(typeof item === 'string' && item !== '',
                            'bad config: each item of ' +
                            '`replicationEndpoints:servers` must be a ' +
                            'non-empty string');
                    });
                }
            });
            this.replicationEndpoints = replicationEndpoints;
        }

        if (config.backbeat) {
            const { backbeat } = config;
            assert.strictEqual(typeof backbeat.host, 'string',
                'bad config: backbeat host must be a string');
            assert(Number.isInteger(backbeat.port) && backbeat.port > 0,
                'bad config: backbeat port must be a positive integer');
            this.backbeat = backbeat;
        }

        if (config.workflowEngineOperator) {
            const { workflowEngineOperator } = config;
            assert.strictEqual(typeof workflowEngineOperator.host, 'string',
                'bad config: workflowEngineOperator host must be a string');
            assert(Number.isInteger(workflowEngineOperator.port) &&
                   workflowEngineOperator.port > 0,
                'bad config: workflowEngineOperator port not a positive integer');
            this.workflowEngineOperator = workflowEngineOperator;
        }

        // legacy
        if (config.regions !== undefined) {
            throw new Error('bad config: regions key is deprecated. ' +
                'Please use restEndpoints and locationConfig');
        }

        if (config.restEndpoints !== undefined) {
            this.restEndpoints = {};
            restEndpointsAssert(config.restEndpoints, this.locationConstraints);
            this.restEndpoints = config.restEndpoints;
        }

        if (!config.restEndpoints) {
            throw new Error('bad config: config must include restEndpoints');
        }

        this.websiteEndpoints = [];
        if (config.websiteEndpoints !== undefined) {
            assert(Array.isArray(config.websiteEndpoints)
                && config.websiteEndpoints.every(e => typeof e === 'string'),
                'bad config: websiteEndpoints must be a list of strings');
            this.websiteEndpoints = config.websiteEndpoints;
        }

        this.clusters = false;
        if (config.clusters !== undefined) {
            assert(Number.isInteger(config.clusters) && config.clusters > 0,
                   'bad config: clusters must be a positive integer');
            this.clusters = config.clusters;
        }

        if (config.usEastBehavior !== undefined) {
            throw new Error('bad config: usEastBehavior key is deprecated. ' +
                'Please use restEndpoints and locationConfig');
        }
        // legacy
        if (config.sproxyd !== undefined) {
            throw new Error('bad config: sproxyd key is deprecated. ' +
                'Please use restEndpoints and locationConfig');
        }

        this.cdmi = {};
        if (config.cdmi !== undefined) {
            if (config.cdmi.host !== undefined) {
                assert.strictEqual(typeof config.cdmi.host, 'string',
                                   'bad config: cdmi host must be a string');
                this.cdmi.host = config.cdmi.host;
            }
            if (config.cdmi.port !== undefined) {
                assert(Number.isInteger(config.cdmi.port)
                       && config.cdmi.port > 0,
                       'bad config: cdmi port must be a positive integer');
                this.cdmi.port = config.cdmi.port;
            }
            if (config.cdmi.path !== undefined) {
                assert(typeof config.cdmi.path === 'string',
                       'bad config: cdmi.path must be a string');
                assert(config.cdmi.path.length > 0,
                       'bad config: cdmi.path is empty');
                assert(config.cdmi.path.charAt(0) === '/',
                       'bad config: cdmi.path should start with a "/"');
                this.cdmi.path = config.cdmi.path;
            }
            if (config.cdmi.readonly !== undefined) {
                assert(typeof config.cdmi.readonly === 'boolean',
                       'bad config: cdmi.readonly must be a boolean');
                this.cdmi.readonly = config.cdmi.readonly;
            } else {
                this.cdmi.readonly = true;
            }
        }

        this.bucketd = { bootstrap: [] };
        if (config.bucketd !== undefined
                && config.bucketd.bootstrap !== undefined) {
            assert(config.bucketd.bootstrap instanceof Array
                   && config.bucketd.bootstrap.every(
                       e => typeof e === 'string'),
                   'bad config: bucketd.bootstrap must be a list of strings');
            this.bucketd.bootstrap = config.bucketd.bootstrap;
        }

        this.vaultd = {};
        if (config.vaultd) {
            if (config.vaultd.port !== undefined) {
                assert(Number.isInteger(config.vaultd.port)
                       && config.vaultd.port > 0,
                       'bad config: vaultd port must be a positive integer');
                this.vaultd.port = config.vaultd.port;
            }
            if (config.vaultd.host !== undefined) {
                assert.strictEqual(typeof config.vaultd.host, 'string',
                                   'bad config: vaultd host must be a string');
                this.vaultd.host = config.vaultd.host;
            }
            if (process.env.VAULTD_HOST !== undefined) {
                assert.strictEqual(typeof process.env.VAULTD_HOST, 'string',
                    'bad config: vaultd host must be a string');
                this.vaultd.host = process.env.VAULTD_HOST;
            }
        }

        if (config.dataClient) {
            this.dataClient = {};
            assert.strictEqual(typeof config.dataClient.host, 'string',
                               'bad config: data client host must be ' +
                               'a string');
            this.dataClient.host = config.dataClient.host;

            assert(Number.isInteger(config.dataClient.port)
                   && config.dataClient.port > 0,
                   'bad config: dataClient port must be a positive ' +
                   'integer');
            this.dataClient.port = config.dataClient.port;
        }

        if (config.metadataClient) {
            this.metadataClient = {};
            assert.strictEqual(
                typeof config.metadataClient.host, 'string',
                'bad config: metadata client host must be a string');
            this.metadataClient.host = config.metadataClient.host;

            assert(Number.isInteger(config.metadataClient.port)
                   && config.metadataClient.port > 0,
                   'bad config: metadata client port must be a ' +
                   'positive integer');
            this.metadataClient.port = config.metadataClient.port;
        }

        if (config.pfsClient) {
            this.pfsClient = {};
            assert.strictEqual(typeof config.pfsClient.host, 'string',
                'bad config: pfsClient host must be ' +
                'a string');
            this.pfsClient.host = config.pfsClient.host;

            assert(Number.isInteger(config.pfsClient.port) &&
                config.pfsClient.port > 0,
                'bad config: pfsClient port must be a positive ' +
                'integer');
            this.pfsClient.port = config.pfsClient.port;
        }

        if (config.dataDaemon) {
            this.dataDaemon = {};
            assert.strictEqual(
                typeof config.dataDaemon.bindAddress, 'string',
                'bad config: data daemon bind address must be a string');
            this.dataDaemon.bindAddress = config.dataDaemon.bindAddress;

            assert(Number.isInteger(config.dataDaemon.port)
                   && config.dataDaemon.port > 0,
                   'bad config: data daemon port must be a positive ' +
                   'integer');
            this.dataDaemon.port = config.dataDaemon.port;

            /**
             * Configure the file paths for data if using the file
             * backend. If no path provided, uses data at the root of
             * the S3 project directory.
             */
            this.dataDaemon.dataPath =
                process.env.S3DATAPATH ?
                process.env.S3DATAPATH : `${__dirname}/../localData`;
            this.dataDaemon.noSync = process.env.S3DATA_NOSYNC === 'true';
            this.dataDaemon.noCache = process.env.S3DATA_NOCACHE === 'true';
        }

        if (config.pfsDaemon) {
            this.pfsDaemon = {};
            assert.strictEqual(
                typeof config.pfsDaemon.bindAddress, 'string',
                'bad config: data daemon bind address must be a string');
            this.pfsDaemon.bindAddress = config.pfsDaemon.bindAddress;
            assert(Number.isInteger(config.pfsDaemon.port)
                   && config.pfsDaemon.port > 0,
                   'bad config: data daemon port must be a positive ' +
                   'integer');
            this.pfsDaemon.port = config.pfsDaemon.port;
            this.pfsDaemon.dataPath =
                process.env.PFSD_MOUNT_PATH ?
                process.env.PFSD_MOUNT_PATH : `${__dirname}/../localPfs`;
            this.pfsDaemon.noSync = process.env.PFSD_NOSYNC === 'true';
            this.pfsDaemon.noCache = process.env.PFSD_NOCACHE === 'true';
            this.pfsDaemon.isReadOnly =
                process.env.PFSD_READONLY === 'true';
        }

        if (config.metadataDaemon) {
            this.metadataDaemon = {};
            assert.strictEqual(
                typeof config.metadataDaemon.bindAddress, 'string',
                'bad config: metadata daemon bind address must be a string');
            this.metadataDaemon.bindAddress =
                config.metadataDaemon.bindAddress;

            assert(Number.isInteger(config.metadataDaemon.port)
                   && config.metadataDaemon.port > 0,
                   'bad config: metadata daemon port must be a ' +
                   'positive integer');
            this.metadataDaemon.port = config.metadataDaemon.port;

            /**
             * Configure the file path for metadata if using the file
             * backend. If no path provided, uses data and metadata at
             * the root of the S3 project directory.
             */
            this.metadataDaemon.metadataPath =
                process.env.S3METADATAPATH ?
                process.env.S3METADATAPATH : `${__dirname}/../localMetadata`;

            this.metadataDaemon.restEnabled =
                config.metadataDaemon.restEnabled;
            this.metadataDaemon.restPort = config.metadataDaemon.restPort;
        }

        this.recordLog = { enabled: false };
        if (config.recordLog) {
            this.recordLog.enabled = Boolean(config.recordLog.enabled);
            this.recordLog.recordLogName = config.recordLog.recordLogName;
        }

        if (process.env.ENABLE_LOCAL_CACHE) {
            this.localCache = defaultLocalCache;
        }
        if (config.localCache) {
            assert(typeof config.localCache === 'object',
                'config: invalid local cache configuration. localCache must ' +
                'be an object');
            if (config.localCache.sentinels) {
                this.localCache = { sentinels: [], name: null };

                assert(typeof config.localCache.name === 'string',
                    'bad config: localCache sentinel name must be a string');
                this.localCache.name = config.localCache.name;

                assert(Array.isArray(config.localCache.sentinels) ||
                    typeof config.localCache.sentinels === 'string',
                    'bad config: localCache sentinels' +
                    'must be an array or string');

                if (typeof config.localCache.sentinels === 'string') {
                    config.localCache.sentinels.split(',').forEach(item => {
                        const [host, port] = item.split(':');
                        this.localCache.sentinels.push({ host,
                            port: Number.parseInt(port, 10) });
                    });
                } else if (Array.isArray(config.localCache.sentinels)) {
                    config.localCache.sentinels.forEach(item => {
                        const { host, port } = item;
                        assert(typeof host === 'string',
                            'bad config: localCache' +
                            'sentinel host must be a string');
                        assert(typeof port === 'number',
                            'bad config: localCache' +
                            'sentinel port must be a number');
                        this.localCache.sentinels.push({ host, port });
                    });
                }
            } else {
                assert(typeof config.localCache.host === 'string',
                      'config: bad host for localCache. host must be a string');
                assert(typeof config.localCache.port === 'number',
                      'config: bad port for localCache. port must be a number');
                if (config.localCache.password !== undefined) {
                    assert(typeof config.localCache.password === 'string',
                        'config: vad password for localCache. password must' +
                    ' be a string');
                }
                this.localCache = {
                    host: config.localCache.host,
                    port: config.localCache.port,
                    password: config.localCache.password,
                };
            }
        }

        if (config.mongodb) {
            this.mongodb = config.mongodb;
            if (process.env.MONGODB_AUTH_USERNAME &&
                process.env.MONGODB_AUTH_PASSWORD) {
                this.mongodb.authCredentials = {
                  username: process.env.MONGODB_AUTH_USERNAME,
                  password: process.env.MONGODB_AUTH_PASSWORD,
                };
            }
        } else {
            this.mongodb = {};
        }

        if (config.redis) {
            this.redis = parseRedisConfig(config.redis);
        }
        if (config.scuba) {
            this.scuba = {};
            if (config.scuba.host) {
                assert(typeof config.scuba.host === 'string',
                    'bad config: scuba host must be a string');
                this.scuba.host = config.scuba.host;
            }
            if (config.scuba.port) {
                assert(Number.isInteger(config.scuba.port)
                    && config.scuba.port > 0,
                    'bad config: scuba port must be a positive integer');
                this.scuba.port = config.scuba.port;
            }
        }
        if (process.env.SCUBA_HOST && process.env.SCUBA_PORT) {
            assert(typeof process.env.SCUBA_HOST === 'string',
                'bad config: scuba host must be a string');
            assert(Number.isInteger(Number(process.env.SCUBA_PORT))
                && Number(process.env.SCUBA_PORT) > 0,
                'bad config: scuba port must be a positive integer');
            this.scuba = {
                host: process.env.SCUBA_HOST,
                port: Number(process.env.SCUBA_PORT),
            };
        }
        if (this.scuba) {
            this.quotaEnabled = true;
        }
        const maxStaleness = Number(process.env.QUOTA_MAX_STALENESS_MS) ||
            config.quota?.maxStatenessMS ||
            24 * 60 * 60 * 1000;
        assert(Number.isInteger(maxStaleness), 'bad config: maxStalenessMS must be an integer');
        const enableInflights = process.env.QUOTA_ENABLE_INFLIGHTS === 'true' ||
            config.quota?.enableInflights || false;
        this.quota = {
            maxStaleness,
            enableInflights,
        };
        if (config.utapi) {
            this.utapi = { component: 's3' };
            if (config.utapi.host) {
                assert(typeof config.utapi.host === 'string',
                    'bad config: utapi host must be a string');
                this.utapi.host = config.utapi.host;
            }
            if (config.utapi.port) {
                assert(Number.isInteger(config.utapi.port)
                    && config.utapi.port > 0,
                    'bad config: utapi port must be a positive integer');
                this.utapi.port = config.utapi.port;
            }
            if (utapiVersion === 1) {
                if (config.utapi.workers !== undefined) {
                    assert(Number.isInteger(config.utapi.workers)
                        && config.utapi.workers > 0,
                        'bad config: utapi workers must be a positive integer');
                    this.utapi.workers = config.utapi.workers;
                }
                // Utapi uses the same localCache config defined for S3 to avoid
                // config duplication.
                assert(config.localCache, 'missing required property of utapi ' +
                    'configuration: localCache');
                this.utapi.localCache = this.localCache;
                assert(config.redis, 'missing required property of utapi ' +
                    'configuration: redis');
                if (config.utapi.redis) {
                    this.utapi.redis = parseRedisConfig(config.utapi.redis);
                    if (this.utapi.redis.retry === undefined) {
                        this.utapi.redis.retry = {
                            connectBackoff: {
                                min: 10,
                                max: 1000,
                                jitter: 0.1,
                                factor: 1.5,
                                deadline: 10000,
                            },
                        };
                    }
                }
                if (config.utapi.metrics) {
                    this.utapi.metrics = config.utapi.metrics;
                }
                this.utapi.enabledOperationCounters = [];
                if (config.utapi.enabledOperationCounters !== undefined) {
                    const { enabledOperationCounters } = config.utapi;
                    assert(Array.isArray(enabledOperationCounters),
                        'bad config: utapi.enabledOperationCounters must be an ' +
                        'array');
                    assert(enabledOperationCounters.length > 0,
                        'bad config: utapi.enabledOperationCounters cannot be ' +
                        'empty');
                    this.utapi.enabledOperationCounters = enabledOperationCounters;
                }
                this.utapi.disableOperationCounters = false;
                if (config.utapi.disableOperationCounters !== undefined) {
                    const { disableOperationCounters } = config.utapi;
                    assert(typeof disableOperationCounters === 'boolean',
                        'bad config: utapi.disableOperationCounters must be a ' +
                        'boolean');
                    this.utapi.disableOperationCounters = disableOperationCounters;
                }
                if (config.utapi.disableOperationCounters !== undefined &&
                    config.utapi.enabledOperationCounters !== undefined) {
                    assert(config.utapi.disableOperationCounters === false,
                        'bad config: conflicting rules: ' +
                        'utapi.disableOperationCounters and ' +
                        'utapi.enabledOperationCounters cannot both be ' +
                        'specified');
                }
                if (config.utapi.component) {
                    this.utapi.component = config.utapi.component;
                }
                // (optional) The value of the replay schedule should be cron-style
                // scheduling. For example, every five minutes: '*/5 * * * *'.
                if (config.utapi.replaySchedule) {
                    assert(typeof config.utapi.replaySchedule === 'string', 'bad' +
                        'config: utapi.replaySchedule must be a string');
                    this.utapi.replaySchedule = config.utapi.replaySchedule;
                }
                // (optional) The number of elements processed by each call to the
                // Redis local cache during a replay. For example, 50.
                if (config.utapi.batchSize) {
                    assert(typeof config.utapi.batchSize === 'number', 'bad' +
                        'config: utapi.batchSize must be a number');
                    assert(config.utapi.batchSize > 0, 'bad config:' +
                        'utapi.batchSize must be a number greater than 0');
                    this.utapi.batchSize = config.utapi.batchSize;
                }

                // (optional) Expire bucket level metrics on delete bucket
                // Disabled by default
                this.utapi.expireMetrics = false;
                if (config.utapi.expireMetrics !== undefined) {
                    assert(typeof config.utapi.expireMetrics === 'boolean', 'bad' +
                        'config: utapi.expireMetrics must be a boolean');
                    this.utapi.expireMetrics = config.utapi.expireMetrics;
                }
                // (optional) TTL controlling the expiry for bucket level metrics
                // keys when expireMetrics is enabled
                this.utapi.expireMetricsTTL = 0;
                if (config.utapi.expireMetricsTTL !== undefined) {
                    assert(typeof config.utapi.expireMetricsTTL === 'number',
                        'bad config: utapi.expireMetricsTTL must be a number');
                    this.utapi.expireMetricsTTL = config.utapi.expireMetricsTTL;
                }

                if (config.utapi && config.utapi.reindex) {
                    this.utapi.reindex = parseUtapiReindex(config.utapi.reindex);
                }
            }

            if (utapiVersion === 2 && config.utapi.filter) {
                const { filter: filterConfig } = config.utapi;
                const utapiResourceFilters = {};
                allowedUtapiEventFilterFields.forEach(
                    field => allowedUtapiEventFilterStates.forEach(
                        state => {
                            const resources = (filterConfig[state] && filterConfig[state][field]) || null;
                            if (resources) {
                                assert.strictEqual(utapiResourceFilters[field], undefined,
                                    `bad config: utapi.filter.${state}.${field} can't define an allow and a deny list`);
                                assert(resources.every(r => typeof r === 'string'),
                                    `bad config: utapi.filter.${state}.${field} must be an array of strings`);
                                utapiResourceFilters[field] = { [state]: new Set(resources) };
                            }
                        }
                ));
                this.utapi.filter = utapiResourceFilters;
            }
        }
        if (Object.keys(this.locationConstraints).some(
        loc => this.locationConstraints[loc].sizeLimitGB)) {
            assert(this.utapi && this.utapi.metrics &&
                this.utapi.metrics.includes('location'),
                'bad config: if storage size limit set on a location ' +
                'constraint, Utapi must also be configured correctly');
        }

        this.log = { logLevel: 'debug', dumpLevel: 'error' };
        if (config.log !== undefined) {
            if (config.log.logLevel !== undefined) {
                assert(typeof config.log.logLevel === 'string',
                       'bad config: log.logLevel must be a string');
                this.log.logLevel = config.log.logLevel;
            }
            if (config.log.dumpLevel !== undefined) {
                assert(typeof config.log.dumpLevel === 'string',
                        'bad config: log.dumpLevel must be a string');
                this.log.dumpLevel = config.log.dumpLevel;
            }
        }

        this.kms = {};
        if (config.kms) {
            assert(typeof config.kms.userName === 'string');
            assert(typeof config.kms.password === 'string');
            this.kms.userName = config.kms.userName;
            this.kms.password = config.kms.password;
            if (config.kms.helperProgram !== undefined) {
                assert(typeof config.kms.helperProgram === 'string');
                this.kms.helperProgram = config.kms.helperProgram;
            }
            if (config.kms.propertiesFile !== undefined) {
                assert(typeof config.kms.propertiesFile === 'string');
                this.kms.propertiesFile = config.kms.propertiesFile;
            }
            if (config.kms.maxSessions !== undefined) {
                assert(typeof config.kms.maxSessions === 'number');
                this.kms.maxSessions = config.kms.maxSessions;
            }
        }

        this.kmip = {
            client: {
                /* Enable this option if the KMIP Server supports
                 * Create and Activate in one operation.
                 * Leave it disabled to prevent clock desynchronisation
                 * issues because the two steps creation uses server's
                 * time for `now' instead of client specified activation date
                 * which also targets the present instant.
                 */
                compoundCreateActivate:
                (process.env.S3KMIP_COMPOUND_CREATE === 'true') || false,
                /* Set the bucket name attribute name here if the KMIP
                 * server supports storing custom attributes along
                 * with the keys.
                 */
                bucketNameAttributeName:
                process.env.S3KMIP_BUCKET_ATTRIBUTE_NAME || '',
            },
            transport: {
                /* Specify the request pipeline depth here.
                 * If for some reason the server sends the replies
                 * out of order and confuses the client, a value of 1
                 * should be a convenient workaround for a server side bug.
                 * The default value of 8 is fine and there is almost no
                 * benefit to tune this value for performance improvement.
                 * Note: 0 is not an appropriate value and will fall back to 1.
                 */
                pipelineDepth: process.env.S3KMIP_PIPELINE_DEPTH || 8,
                tls: {
                    port: process.env.S3KMIP_PORT || 5696,
                    /* TODO: HA is not implmented yet.
                     * The code expects only one host, but the
                     * configuration already permits to provide
                     * plenty of them (separated with commas).
                     * This comment must be removed, the
                     * S3KMIP_HOSTS must be split and transformed
                     * into an array of strings. And the 'host' attribute
                     * must become 'hosts'
                     */
                    host: process.env.S3KMIP_HOSTS,
                    key: this._loadTlsFile(process.env.S3KMIP_KEY || undefined),
                    cert: this._loadTlsFile(process.env.S3KMIP_CERT ||
                                            undefined),
                    ca: (process.env.S3KMIP_CA
                         ? process.env.S3KMIP_CA.split(',')
                         : []).map(this._loadTlsFile),
                },
            },
        };
        if (config.kmip) {
            if (config.kmip.client) {
                if (config.kmip.client.compoundCreateActivate) {
                    assert(typeof config.kmip.client.compoundCreateActivate ===
                          'boolean');
                    this.kmip.client.compoundCreateActivate =
                        config.kmip.client.compoundCreateActivate;
                }
                if (config.kmip.client.bucketNameAttributeName) {
                    assert(typeof config.kmip.client.bucketNameAttributeName ===
                          'string');
                    this.kmip.client.bucketNameAttributeName =
                        config.kmip.client.bucketNameAttributeName;
                }
            }
            if (config.kmip.transport) {
                if (config.kmip.transport.pipelineDepth) {
                    assert(typeof config.kmip.transport.pipelineDepth ===
                           'number');
                    this.kmip.transport.pipelineDepth =
                        config.kmip.transport.pipelineDepth;
                }
                if (config.kmip.transport.tls) {
                    const { host, port, key, cert, ca } =
                          config.kmip.transport.tls;
                    if (!!key !== !!cert) {
                        throw new Error('bad config: KMIP TLS certificate ' +
                                        'and key must come along');
                    }
                    if (port) {
                        assert(typeof port === 'number',
                               'bad config: KMIP TLS Port must be a number');
                        this.kmip.transport.tls.port = port;
                    }
                    if (host) {
                        assert(typeof host === 'string',
                               'bad config: KMIP TLS Host must be a string');
                        this.kmip.transport.tls.host = host;
                    }

                    if (key) {
                        this.kmip.transport.tls.key = this._loadTlsFile(key);
                    }
                    if (cert) {
                        this.kmip.transport.tls.cert = this._loadTlsFile(cert);
                    }
                    if (Array.isArray(ca)) {
                        this.kmip.transport.tls.ca = ca.map(this._loadTlsFile);
                    } else {
                        this.kmip.transport.tls.ca = this._loadTlsFile(ca);
                    }
                }
            }
        }

        this.kmsAWS = this._parseKmsAWS(config);

        const globalEncryptionEnabled = config.globalEncryptionEnabled;
        this.globalEncryptionEnabled = globalEncryptionEnabled || false;
        assert(typeof this.globalEncryptionEnabled === 'boolean',
            'config.globalEncryptionEnabled must be a boolean');

        const defaultEncryptionKeyPerAccount = config.defaultEncryptionKeyPerAccount;
        this.defaultEncryptionKeyPerAccount = defaultEncryptionKeyPerAccount || false;
        assert(typeof this.defaultEncryptionKeyPerAccount === 'boolean',
            'config.defaultEncryptionKeyPerAccount must be a boolean');

        this.healthChecks = defaultHealthChecks;
        if (config.healthChecks && config.healthChecks.allowFrom) {
            assert(config.healthChecks.allowFrom instanceof Array,
                'config: invalid healthcheck configuration. allowFrom must ' +
                'be an array');
            config.healthChecks.allowFrom.forEach(item => {
                assert(typeof item === 'string',
                'config: invalid healthcheck configuration. allowFrom IP ' +
                'address must be a string');
            });
            this.healthChecks.allowFrom = defaultHealthChecks.allowFrom
                .concat(config.healthChecks.allowFrom);
        }

        if (config.certFilePaths) {
            assert(typeof config.certFilePaths === 'object' &&
                typeof config.certFilePaths.key === 'string' &&
                typeof config.certFilePaths.cert === 'string' && ((
                    config.certFilePaths.ca &&
                    typeof config.certFilePaths.ca === 'string') ||
                    !config.certFilePaths.ca)
               );
        }

        const { key, cert, ca } = config.certFilePaths ?
            config.certFilePaths : {};
        let certObj = undefined;
        if (key && cert) {
            certObj = assertCertPaths(key, cert, ca, this._basePath);
        } else if (key || cert) {
            throw new Error('bad config: both certFilePaths.key and ' +
                'certFilePaths.cert must be defined');
        }
        if (certObj) {
            if (Object.keys(certObj.certs).length > 0) {
                this.https = certObj.certs;
            }
            if (Object.keys(certObj.paths).length > 0) {
                this.httpsPath = certObj.paths;
            }
        }

        this.outboundProxy = {};
        const envProxy = process.env.HTTP_PROXY || process.env.HTTPS_PROXY
            || process.env.http_proxy || process.env.https_proxy;
        const p = config.outboundProxy;
        const proxyUrl = envProxy || (p ? p.url : '');
        if (proxyUrl) {
            assert(typeof proxyUrl === 'string',
                'bad proxy config: url must be a string');
            const { protocol, hostname, port, auth } = url.parse(proxyUrl);
            assert(protocol === 'http:' || protocol === 'https:',
                'bad proxy config: protocol must be http or https');
            assert(typeof hostname === 'string' && hostname !== '',
                'bad proxy config: hostname must be a non-empty string');
            if (port) {
                const portInt = Number.parseInt(port, 10);
                assert(!Number.isNaN(portInt) && portInt > 0,
                    'bad proxy config: port must be a number greater than 0');
            }
            if (auth) {
                assert(typeof auth === 'string',
                    'bad proxy config: auth must be string');
                const authArray = auth.split(':');
                assert(authArray.length === 2 && authArray[0].length > 0
                    && authArray[1].length > 0, 'bad proxy config: ' +
                    'auth must be of format username:password');
            }
            this.outboundProxy.url = proxyUrl;
            this.outboundProxy.certs = {};
            const envCert = process.env.HTTPS_PROXY_CERTIFICATE;
            const key = p ? p.key : '';
            const cert = p ? p.cert : '';
            const caBundle = envCert || (p ? p.caBundle : '');
            if (p) {
                assert(typeof p === 'object',
                    'bad config: "proxy" should be an object');
            }
            if (key) {
                assert(typeof key === 'string',
                    'bad config: proxy.key should be a string');
            }
            if (cert) {
                assert(typeof cert === 'string',
                    'bad config: proxy.cert should be a string');
            }
            if (caBundle) {
                assert(typeof caBundle === 'string',
                    'bad config: proxy.caBundle should be a string');
            }
            const certObj =
                assertCertPaths(key, cert, caBundle, this._basePath);
            this.outboundProxy.certs = certObj.certs;
        }

        this.managementAgent = {};
        this.managementAgent.port = 8010;
        this.managementAgent.host = 'localhost';
        if (config.managementAgent !== undefined) {
            if (config.managementAgent.port !== undefined) {
                assert(Number.isInteger(config.managementAgent.port)
                       && config.managementAgent.port > 0,
                       'bad config: managementAgent port must be a positive ' +
                       'integer');
                this.managementAgent.port = config.managementAgent.port;
            }
            if (config.managementAgent.host !== undefined) {
                assert.strictEqual(typeof config.managementAgent.host, 'string',
                                   'bad config: management agent host must ' +
                                   'be a string');
                this.managementAgent.host = config.managementAgent.host;
            }
        }

        // Ephemeral token to protect the reporting endpoint:
        // try inherited from parent first, then hardcoded in conf file,
        // then create a fresh one as last resort.
        this.reportToken =
            process.env.REPORT_TOKEN ||
            config.reportToken ||
            uuidv4();

        // External backends
        // Currently supports configuring httpAgent(s) for keepAlive
        this.externalBackends = defaultExternalBackendsConfig;
        if (config.externalBackends) {
            const extBackendsConfig = Object.keys(config.externalBackends);
            extBackendsConfig.forEach(b => {
                // assert that it's a valid backend
                assert(validExternalBackends[b] !== undefined,
                    `bad config: ${b} is not one of valid external backends: ` +
                    `${Object.keys(validExternalBackends).join(', ')}`);

                const { httpAgent } = config.externalBackends[b];
                assert(typeof httpAgent === 'object',
                    `bad config: ${b} must have httpAgent object defined`);
                const { keepAlive, keepAliveMsecs, maxFreeSockets, maxSockets }
                    = httpAgent;
                assert(typeof keepAlive === 'boolean',
                    `bad config: ${b}.httpAgent.keepAlive must be a boolean`);
                assert(typeof keepAliveMsecs === 'number' &&
                    httpAgent.keepAliveMsecs > 0,
                    `bad config: ${b}.httpAgent.keepAliveMsecs must be` +
                    ' a number > 0');
                assert(typeof maxFreeSockets === 'number' &&
                    httpAgent.maxFreeSockets >= 0,
                    `bad config: ${b}.httpAgent.maxFreeSockets must be ` +
                    'a number >= 0');
                assert((typeof maxSockets === 'number' && maxSockets >= 0) ||
                    maxSockets === null,
                    `bad config: ${b}.httpAgent.maxFreeSockets must be ` +
                    'null or a number >= 0');
                Object.assign(this.externalBackends[b].httpAgent, httpAgent);
            });
        }

        // requests-proxy configuration
        this.requests = {
            viaProxy: false,
            trustedProxyCIDRs: [],
            extractClientIPFromHeader: '',
            extractProtocolFromHeader: '',
        };
        if (config.requests !== undefined) {
            requestsConfigAssert(config.requests);
            this.requests = config.requests;
        }
        // CLDSRV-378: on 8.x branches, null version compatibility
        // mode is enforced because null keys are not supported by the
        // MongoDB backend.
        this.nullVersionCompatMode = true;
        if (config.bucketNotificationDestinations) {
            this.bucketNotificationDestinations = bucketNotifAssert(config.bucketNotificationDestinations);
        }

        this.lifecycleRoleName = config.lifecycleRoleName || null;

        // Version of the configuration we're running under
        this.overlayVersion = config.overlayVersion || 0;

        this._setTimeOptions();
        this.multiObjectDeleteConcurrency = constants.multiObjectDeleteConcurrency;
        const extractedNumber = Number.parseInt(config.multiObjectDeleteConcurrency, 10);
        if (!isNaN(extractedNumber) && extractedNumber > 0 && extractedNumber < 1000) {
            this.multiObjectDeleteConcurrency = extractedNumber;
        }

        this.multiObjectDeleteEnableOptimizations = true;
        if (config.multiObjectDeleteEnableOptimizations === false) {
            this.multiObjectDeleteEnableOptimizations = false;
        }

        this.testingMode = config.testingMode || false;

        this.maxScannedLifecycleListingEntries = constants.maxScannedLifecycleListingEntries;
        if (config.maxScannedLifecycleListingEntries !== undefined) {
            // maxScannedLifecycleListingEntries > 2 is required as a minimum because we must
            // scan at least three entries to determine version eligibility.
            // Two entries representing the master key and the following one representing the non-current version.
            assert(Number.isInteger(config.maxScannedLifecycleListingEntries) &&
                config.maxScannedLifecycleListingEntries > 2,
                'bad config: maxScannedLifecycleListingEntries must be greater than 2');
            this.maxScannedLifecycleListingEntries = config.maxScannedLifecycleListingEntries;
        }

        this.supportedLifecycleRules = parseSupportedLifecycleRules(config.supportedLifecycleRules);
    }

    _setTimeOptions() {
        // NOTE: EXPIRE_ONE_DAY_EARLIER and TRANSITION_ONE_DAY_EARLIER are deprecated in favor of
        // TIME_PROGRESSION_FACTOR which decreases the weight attributed to a day in order to among other things
        // expedite the lifecycle of objects.

        // moves lifecycle expiration deadlines 1 day earlier, mostly for testing
        const expireOneDayEarlier = process.env.EXPIRE_ONE_DAY_EARLIER === 'true';
        // moves lifecycle transition deadlines 1 day earlier, mostly for testing
        const transitionOneDayEarlier = process.env.TRANSITION_ONE_DAY_EARLIER === 'true';
        // decreases the weight attributed to a day in order to expedite the lifecycle of objects.
        const timeProgressionFactor = Number.parseInt(process.env.TIME_PROGRESSION_FACTOR, 10) || 1;

        const isIncompatible = (expireOneDayEarlier || transitionOneDayEarlier) && (timeProgressionFactor > 1);
        assert(!isIncompatible, 'The environment variables "EXPIRE_ONE_DAY_EARLIER" or ' +
        '"TRANSITION_ONE_DAY_EARLIER" are not compatible with the "TIME_PROGRESSION_FACTOR" variable.');

        // The scaledMsPerDay value is initially set to the number of milliseconds per day
        // (24 * 60 * 60 * 1000)  as the default value.
        // However, during testing, if the timeProgressionFactor is defined and greater than 1,
        // the scaledMsPerDay value is decreased. This adjustment allows for simulating actions occurring
        // earlier in time.
        const scaledMsPerDay = scaleMsPerDay(timeProgressionFactor);

        this.timeOptions = {
            expireOneDayEarlier,
            transitionOneDayEarlier,
            timeProgressionFactor,
            scaledMsPerDay,
        };
    }

    getTimeOptions() {
        return this.timeOptions;
    }

    _getAuthData() {
        return require(findConfigFile(process.env.S3AUTH_CONFIG || 'authdata.json'));
    }

    _configureBackends() {
        /**
         * Configure the backends for Authentication, Data and Metadata.
         */
        let auth = 'mem';
        let data = 'multiple';
        let metadata = 'file';
        let kms = 'file';
        let quota = 'none';
        if (process.env.S3BACKEND) {
            const validBackends = ['mem', 'file', 'scality', 'cdmi'];
            assert(validBackends.indexOf(process.env.S3BACKEND) > -1,
                'bad environment variable: S3BACKEND environment variable ' +
                'should be one of mem/file/scality/cdmi'
            );
            auth = process.env.S3BACKEND;
            data = process.env.S3BACKEND;
            metadata = process.env.S3BACKEND;
            kms = process.env.S3BACKEND;
        }
        if (process.env.S3VAULT) {
            auth = process.env.S3VAULT;
        }
        if (auth === 'file' || auth === 'mem' || auth === 'cdmi') {
            // Auth only checks for 'mem' since mem === file
            auth = 'mem';
            let authData;
            if (process.env.SCALITY_ACCESS_KEY_ID &&
            process.env.SCALITY_SECRET_ACCESS_KEY) {
                authData = buildAuthDataAccount(
                  process.env.SCALITY_ACCESS_KEY_ID,
                  process.env.SCALITY_SECRET_ACCESS_KEY);
            } else {
                authData = this._getAuthData();
            }
            if (validateAuthConfig(authData)) {
                throw new Error('bad config: invalid auth config file.');
            }
            this.authData = authData;
        }  else if (auth === 'multiple') {
            const authData = this._getAuthData();
            if (validateAuthConfig(authData)) {
                throw new Error('bad config: invalid auth config file.');
            }
            this.authData = authData;
        }

        if (process.env.S3DATA) {
            const validData = ['mem', 'file', 'scality', 'multiple'];
            assert(validData.indexOf(process.env.S3DATA) > -1,
                'bad environment variable: S3DATA environment variable ' +
                'should be one of mem/file/scality/multiple'
            );
            data = process.env.S3DATA;
        }
        if (data === 'scality' || data === 'multiple') {
            data = 'multiple';
        }
        assert(this.locationConstraints !== undefined &&
            this.restEndpoints !== undefined,
            'bad config: locationConstraints and restEndpoints must be set'
        );

        if (process.env.S3METADATA) {
            metadata = process.env.S3METADATA;
        }
        if (process.env.S3KMS) {
            kms = process.env.S3KMS;
        }
        if (process.env.S3QUOTA) {
            quota = process.env.S3QUOTA;
        }
        this.backends = {
            auth,
            data,
            metadata,
            kms,
            quota,
        };
    }

    setAuthDataAccounts(accounts) {
        this.authData.accounts = accounts;
        this.emit('authdata-update');
    }

    getAwsBucketName(locationConstraint) {
        return this.locationConstraints[locationConstraint].details.bucketName;
    }

    getGcpBucketNames(locationConstraint) {
        const {
            bucketName,
            mpuBucketName,
        } = this.locationConstraints[locationConstraint].details;
        return { bucketName, mpuBucketName };
    }

    getLocationConstraintType(locationConstraint) {
        const dataStoreName = this.locationConstraints[locationConstraint];
        return dataStoreName && dataStoreName.type;
    }

    getLocationConstraint(locationConstraintName) {
        return this.locationConstraints[locationConstraintName];
    }

    setRestEndpoints(restEndpoints) {
        restEndpointsAssert(restEndpoints, this.locationConstraints);
        this.restEndpoints = restEndpoints;
        this.emit('rest-endpoints-update');
    }

    setLocationConstraints(locationConstraints) {
        restEndpointsAssert(this.restEndpoints, locationConstraints);
        this.locationConstraints = locationConstraints;
        this.emit('location-constraints-update');
    }

    setReplicationEndpoints(locationConstraints) {
        this.replicationEndpoints =
        Object.keys(locationConstraints)
        .map(key => ({ site: key, type: locationConstraints[key].type }));
    }

    getAzureEndpoint(locationConstraint) {
        let azureStorageEndpoint =
            process.env[`${locationConstraint}_AZURE_STORAGE_ENDPOINT`] ||
            this.locationConstraints[locationConstraint].details.azureStorageEndpoint;
        if (!azureStorageEndpoint.endsWith('/')) {
            // append the trailing slash
            azureStorageEndpoint = `${azureStorageEndpoint}/`;
        }
        return azureStorageEndpoint;
    }

    getAzureStorageAccountName(locationConstraint) {
        const accountName = azureGetStorageAccountName(
            locationConstraint,
            this.locationConstraints[locationConstraint].details
        );
        if (accountName) {
            return accountName;
        }

        // For SAS & ServicePrincipal, retrieve the accountName from the endpoint
        const endpoint = this.getAzureEndpoint(locationConstraint);
        const url = new URL(endpoint);
        const fragments = url.hostname.split('.', 3);
        if (fragments.length === 3 && fragments[1] === 'blob') {
            return fragments[0];
        }

        // We should always reach here, though it may not be the case for "mock" servers,
        // where the accoutName is in the path
        const path = url.pathname.replace(/^\//, '').replace(/\/$/, '');
        if (path) {
            return path;
        }

        // We should not reach here; if that happens, use the endpoint itself, which
        // should be close-enough since this function is used for detecting when two
        // locations actually point to the same account
        return endpoint;
    }

    getAzureStorageCredentials(locationConstraint) {
        return azureGetLocationCredentials(
            locationConstraint,
            this.locationConstraints[locationConstraint].details
        );
    }

    getPfsDaemonEndpoint(locationConstraint) {
        return process.env[`${locationConstraint}_PFSD_ENDPOINT`] ||
        this.locationConstraints[locationConstraint].details.pfsDaemonEndpoint;
    }

    isSameAzureAccount(locationConstraintSrc, locationConstraintDest) {
        if (!locationConstraintDest) {
            return true;
        }
        const azureSrcAccount =
            this.getAzureStorageAccountName(locationConstraintSrc);
        const azureDestAccount =
            this.getAzureStorageAccountName(locationConstraintDest);
        return azureSrcAccount === azureDestAccount;
    }

    isAWSServerSideEncryption(locationConstraint) {
        return this.locationConstraints[locationConstraint].details
        .serverSideEncryption === true;
    }

    getPublicInstanceId() {
        return this.publicInstanceId;
    }

    setPublicInstanceId(instanceId) {
        this.publicInstanceId = crypto.createHash('sha256')
                                .update(instanceId)
                                .digest('hex');
    }

    isQuotaEnabled() {
        return !!this.quotaEnabled;
    }

    isQuotaInflightEnabled() {
        return this.quota.enableInflights;
    }
}

module.exports = {
    parseSproxydConfig,
    parseRedisConfig,
    locationConstraintAssert,
    ConfigObject: Config,
    config: new Config(),
    requestsConfigAssert,
    bucketNotifAssert,
    azureGetStorageAccountName,
    azureGetLocationCredentials,
    azureArchiveLocationConstraintAssert,
    parseSupportedLifecycleRules,
};