Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions lib/patches/locationConstraints.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,10 @@ import { URL } from 'url';
import { decryptSecret } from '../executables/pensieveCreds/utils';
import { Logger } from 'werelogs';

const CI_CEPH = process.env.CI_CEPH;

export type LocationType =
| 'location-mem-v1'
| 'location-file-v1'
| 'location-azure-v1'
| 'location-ceph-radosgw-s3-v1'
| 'location-scality-ring-s3-v1'
| 'location-aws-s3-v1'
| 'location-wasabi-v1'
Expand Down Expand Up @@ -49,6 +46,17 @@ export type Location = {
legacyAwsBehavior: boolean;
};

function isUnsupportedCephEndpoint(endpoint: unknown): boolean {
if (typeof endpoint !== 'string' || endpoint.length === 0) {
return false;
}

const normalized = endpoint.toLowerCase();
return /(?:^|[^a-z0-9])(ceph|radosgw|rgw)(?:[^a-z0-9]|$)/.test(
normalized
);
}

export function patchLocations(
overlayLocations: OverlayLocations | undefined | null,
creds: any,
Expand All @@ -68,7 +76,7 @@ export function patchLocations(
legacyAwsBehavior: Boolean(l.legacyAwsBehavior),
};
let supportsVersioning = false;
let pathStyle = CI_CEPH !== undefined;
let pathStyle = false;

switch (l.locationType) {
case 'location-mem-v1':
Expand All @@ -94,13 +102,19 @@ export function patchLocations(
};
}
break;
case 'location-ceph-radosgw-s3-v1':
case 'location-scality-ring-s3-v1':
pathStyle = true; // fallthrough
case 'location-aws-s3-v1':
case 'location-wasabi-v1':
supportsVersioning = true; // fallthrough
case 'location-do-spaces-v1':
if (isUnsupportedCephEndpoint(l.details?.endpoint)) {
log.warn('unsupported ceph endpoint for location type', {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe adding the word "deprecated" inside would provide more context

locationType: l.locationType,
endpoint: l.details?.endpoint,
});
return acc;
}
location.type = 'aws_s3';
if (l.details.secretKey && l.details.secretKey.length > 0) {
let https = true;
Expand Down
135 changes: 100 additions & 35 deletions tests/unit/patches/locationConstraints.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -201,41 +201,6 @@ const tests = [
objectId: 'httpsawsbackendtest',
},
},
{
locationType: 'location-ceph-radosgw-s3-v1',
locations: {
objectId: 'cephbackendtest',
details: {
bucketMatch: 'cephbucketmatch',
endpoint: 'https://secure.ceph.end.point',
accessKey: 'cephs3accesskey',
secretKey,
bucketName: 'cephbucketname',
region: 'us-west-1',
},
},
expected: {
details: {
awsEndpoint: 'secure.ceph.end.point',
bucketMatch: 'cephbucketmatch',
bucketName: 'cephbucketname',
credentials: {
accessKey: 'cephs3accesskey',
secretKey: decryptedSecretKey,
},
https: true,
pathStyle: true,
region: 'us-west-1',
serverSideEncryption: false,
supportsVersioning: true,
},
legacyAwsBehavior: false,
isTransient: false,
sizeLimitGB: null,
type: 'aws_s3',
objectId: 'cephbackendtest',
},
},
{
name: 'transient enabled',
locationType: 'location-file-v1',
Expand Down Expand Up @@ -295,6 +260,7 @@ const tests = [
describe('patch location constriants', () => {
const mockLog = {
info: () => {},
warn: () => {},
};

tests.forEach(spec => {
Expand Down Expand Up @@ -350,4 +316,103 @@ describe('patch location constriants', () => {
{},
);
});

it('rejects ceph endpoint on aws location type', () => {
assert.deepStrictEqual(
patchLocations(
{
cephAws: {
name: 'cephAws',
objectId: 'ceph-aws-test',
locationType: 'location-aws-s3-v1',
details: {
endpoint: 'https://secure.ceph.end.point',
accessKey,
secretKey,
bucketName: 'bucket',
bucketMatch: true,
region: 'us-east-1',
},
},
},
{ privateKey },
mockLog,
),
{},
);
});

it('rejects radosgw endpoint on aws location type', () => {
assert.deepStrictEqual(
patchLocations(
{
rgwAws: {
name: 'rgwAws',
objectId: 'rgw-aws-test',
locationType: 'location-aws-s3-v1',
details: {
endpoint: 'http://radosgw.example.local',
accessKey,
secretKey,
bucketName: 'bucket',
bucketMatch: true,
region: 'us-east-1',
},
},
},
{ privateKey },
mockLog,
),
{},
);
});

it('does not reject endpoint with rgw as substring of a token', () => {
assert.deepStrictEqual(
patchLocations(
{
nonRgwToken: {
name: 'nonRgwToken',
objectId: 'non-rgw-token-test',
locationType: 'location-aws-s3-v1',
details: {
endpoint: 'https://forgwave.internal',
accessKey,
secretKey,
bucketName: 'bucket',
bucketMatch: true,
region: 'us-east-1',
},
},
},
{ privateKey },
mockLog,
),
{
nonRgwToken: {
type: 'aws_s3',
name: 'nonRgwToken',
objectId: 'non-rgw-token-test',
locationType: 'location-aws-s3-v1',
sizeLimitGB: null,
isTransient: false,
legacyAwsBehavior: false,
details: {
credentials: {
accessKey,
secretKey: decryptedSecretKey,
},
bucketName: 'bucket',
bucketMatch: true,
serverSideEncryption: false,
region: 'us-east-1',
awsEndpoint: 'forgwave.internal',
supportsVersioning: true,
pathStyle: false,
https: true,
},
},
},
);
});
});
Loading