Skip to content

Commit

Permalink
fix(stepfunctions): no validation on state machine name (#13387)
Browse files Browse the repository at this point in the history
closes #13289


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
jonnekaunisto authored Mar 9, 2021
1 parent 01b94f8 commit 6c3d407
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 1 deletion.
15 changes: 14 additions & 1 deletion packages/@aws-cdk/aws-stepfunctions/lib/state-machine.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export enum LogLevel {
/**
* Log all errors
*/
ERROR= 'ERROR',
ERROR = 'ERROR',
/**
* Log fatal errors
*/
Expand Down Expand Up @@ -379,6 +379,10 @@ export class StateMachine extends StateMachineBase {
physicalName: props.stateMachineName,
});

if (props.stateMachineName != undefined) {
this.validateStateMachineName(props.stateMachineName);
}

this.role = props.role || new iam.Role(this, 'Role', {
assumedBy: new iam.ServicePrincipal('states.amazonaws.com'),
});
Expand Down Expand Up @@ -426,6 +430,15 @@ export class StateMachine extends StateMachineBase {
this.role.addToPrincipalPolicy(statement);
}

private validateStateMachineName(stateMachineName: string) {
if (stateMachineName.length < 1 || stateMachineName.length > 80) {
throw new Error(`State Machine name must be between 1 and 80 characters. Received: ${stateMachineName}`);
}
if (!stateMachineName.match('^[0-9a-zA-Z+!@._-]+$')) {
throw new Error(`State Machine name must match "^[0-9a-zA-Z+!@._-]+$". Received: ${stateMachineName}`);
}
}

private buildLoggingConfiguration(logOptions: LogOptions): CfnStateMachine.LoggingConfigurationProperty {
// https://docs.aws.amazon.com/step-functions/latest/dg/cw-logs.html#cloudwatch-iam-policy
this.addToRolePolicy(new iam.PolicyStatement({
Expand Down
30 changes: 30 additions & 0 deletions packages/@aws-cdk/aws-stepfunctions/test/state-machine.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,36 @@ describe('State Machine', () => {

}),

test('State Machine with invalid name', () => {
// GIVEN
const stack = new cdk.Stack();

// WHEN
const createStateMachine = (name: string) => {
new stepfunctions.StateMachine(stack, name + 'StateMachine', {
stateMachineName: name,
definition: stepfunctions.Chain.start(new stepfunctions.Pass(stack, name + 'Pass')),
stateMachineType: stepfunctions.StateMachineType.EXPRESS,
});
};
const tooShortName = '';
const tooLongName = 'M'.repeat(81);
const invalidCharactersName = '*';

// THEN
expect(() => {
createStateMachine(tooShortName);
}).toThrow(`State Machine name must be between 1 and 80 characters. Received: ${tooShortName}`);

expect(() => {
createStateMachine(tooLongName);
}).toThrow(`State Machine name must be between 1 and 80 characters. Received: ${tooLongName}`);

expect(() => {
createStateMachine(invalidCharactersName);
}).toThrow(`State Machine name must match "^[0-9a-zA-Z+!@._-]+$". Received: ${invalidCharactersName}`);
});

test('log configuration', () => {
// GIVEN
const stack = new cdk.Stack();
Expand Down

0 comments on commit 6c3d407

Please sign in to comment.