Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(opensearch): add validation to domainName property #17017

Merged
merged 5 commits into from
Oct 19, 2021
Merged

fix(opensearch): add validation to domainName property #17017

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d108026
fix(opensearch): add validation to domainName property
nom3ad Oct 16, 2021
413598f
chore(opensearch): add better validation
nom3ad Oct 19, 2021
543e8b8
fix(elasticsearch): add domainName validation
nom3ad Oct 19, 2021
57b8c3c
fix failing tests
nom3ad Oct 19, 2021
d9cc98d
Merge branch 'master' into issue-17016-opensearch-domainName-validation
kaizencc Oct 19, 2021
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
22 changes: 18 additions & 4 deletions packages/@aws-cdk/aws-elasticsearch/lib/domain.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1540,9 +1540,9 @@ export class Domain extends DomainBase implements IDomain, ec2.IConnectable {

if (props.logging?.auditLogEnabled) {
this.auditLogGroup = props.logging.auditLogGroup ??
new logs.LogGroup(this, 'AuditLogs', {
retention: logs.RetentionDays.ONE_MONTH,
});
new logs.LogGroup(this, 'AuditLogs', {
retention: logs.RetentionDays.ONE_MONTH,
});

logGroups.push(this.auditLogGroup);
};
Expand Down Expand Up @@ -1692,7 +1692,21 @@ export class Domain extends DomainBase implements IDomain, ec2.IConnectable {

if (logGroupResourcePolicy) { this.domain.node.addDependency(logGroupResourcePolicy); }

if (props.domainName) { this.node.addMetadata('aws:cdk:hasPhysicalName', props.domainName); }
if (props.domainName) {
if (!cdk.Token.isUnresolved(props.domainName)) {
// https://docs.aws.amazon.com/opensearch-service/latest/developerguide/configuration-api.html#configuration-api-datatypes-domainname
if (!props.domainName.match(/^[a-z0-9\-]+$/)) {
throw new Error(`Invalid domainName '${props.domainName}'. Valid characters are a-z (lowercase only), 0-9, and – (hyphen).`);
}
if (props.domainName.length < 3 || props.domainName.length > 28) {
throw new Error(`Invalid domainName '${props.domainName}'. It must be between 3 and 28 characters`);
}
if (props.domainName[0] < 'a' || props.domainName[0] > 'z') {
throw new Error(`Invalid domainName '${props.domainName}'. It must start with a lowercase letter`);
}
}
this.node.addMetadata('aws:cdk:hasPhysicalName', props.domainName);
}

this.domainName = this.getResourceNameAttribute(this.domain.ref);

Expand Down
15 changes: 15 additions & 0 deletions packages/@aws-cdk/aws-elasticsearch/test/domain.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1317,6 +1317,21 @@ describe('custom error responses', () => {
})).toThrow(/Unknown Elasticsearch version: 5\.4/);
});

test('error when invalid domain name is given', () => {
expect(() => new Domain(stack, 'Domain1', {
version: ElasticsearchVersion.V7_4,
domainName: 'InvalidName',
})).toThrow(/Valid characters are a-z/);
expect(() => new Domain(stack, 'Domain2', {
version: ElasticsearchVersion.V7_4,
domainName: 'a'.repeat(29),
})).toThrow(/It must be between 3 and 28 characters/);
expect(() => new Domain(stack, 'Domain3', {
version: ElasticsearchVersion.V7_4,
domainName: '123domain',
})).toThrow(/It must start with a lowercase letter/);
});

test('error when error log publishing is enabled for elasticsearch version < 5.1', () => {
const error = /Error logs publishing requires Elasticsearch version 5.1 or later/;
expect(() => new Domain(stack, 'Domain1', {
Expand Down
22 changes: 18 additions & 4 deletions packages/@aws-cdk/aws-opensearchservice/lib/domain.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1472,9 +1472,9 @@ export class Domain extends DomainBase implements IDomain, ec2.IConnectable {

if (props.logging?.auditLogEnabled) {
this.auditLogGroup = props.logging.auditLogGroup ??
new logs.LogGroup(this, 'AuditLogs', {
retention: logs.RetentionDays.ONE_MONTH,
});
new logs.LogGroup(this, 'AuditLogs', {
retention: logs.RetentionDays.ONE_MONTH,
});

logGroups.push(this.auditLogGroup);
};
Expand Down Expand Up @@ -1624,7 +1624,21 @@ export class Domain extends DomainBase implements IDomain, ec2.IConnectable {

if (logGroupResourcePolicy) { this.domain.node.addDependency(logGroupResourcePolicy); }

if (props.domainName) { this.node.addMetadata('aws:cdk:hasPhysicalName', props.domainName); }
if (props.domainName) {
if (!cdk.Token.isUnresolved(props.domainName)) {
// https://docs.aws.amazon.com/opensearch-service/latest/developerguide/configuration-api.html#configuration-api-datatypes-domainname
if (!props.domainName.match(/^[a-z0-9\-]+$/)) {
throw new Error(`Invalid domainName '${props.domainName}'. Valid characters are a-z (lowercase only), 0-9, and – (hyphen).`);
}
if (props.domainName.length < 3 || props.domainName.length > 28) {
throw new Error(`Invalid domainName '${props.domainName}'. It must be between 3 and 28 characters`);
}
if (props.domainName[0] < 'a' || props.domainName[0] > 'z') {
throw new Error(`Invalid domainName '${props.domainName}'. It must start with a lowercase letter`);
}
}
this.node.addMetadata('aws:cdk:hasPhysicalName', props.domainName);
}

this.domainName = this.getResourceNameAttribute(this.domain.ref);

Expand Down
15 changes: 15 additions & 0 deletions packages/@aws-cdk/aws-opensearchservice/test/domain.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1319,6 +1319,21 @@ describe('custom error responses', () => {
})).toThrow('Unknown Elasticsearch version: 5.4');
});

test('error when invalid domain name is given', () => {
expect(() => new Domain(stack, 'Domain1', {
version: EngineVersion.OPENSEARCH_1_0,
domainName: 'InvalidName',
})).toThrow(/Valid characters are a-z/);
expect(() => new Domain(stack, 'Domain2', {
version: EngineVersion.OPENSEARCH_1_0,
domainName: 'a'.repeat(29),
})).toThrow(/It must be between 3 and 28 characters/);
expect(() => new Domain(stack, 'Domain3', {
version: EngineVersion.OPENSEARCH_1_0,
domainName: '123domain',
})).toThrow(/It must start with a lowercase letter/);
});

test('error when error log publishing is enabled for Elasticsearch version < 5.1', () => {
const error = /Error logs publishing requires Elasticsearch version 5.1 or later or OpenSearch version 1.0 or later/;
expect(() => new Domain(stack, 'Domain1', {
Expand Down