Skip to content

feat: Support setting evaluationWindowSec for WAF throttling rule #651

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
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
1 change: 1 addition & 0 deletions doc/WAF.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ waf:
- throttle: 200 # limit to 200 requests per 5 minutes period
- throttle:
limit: 200
evaluationWindowSec: 300 # count requests in last 5 minutes, one of 60 | 120 | 300 | 600
priority: 10
aggregateKeyType: FORWARDED_IP
forwardedIPConfig:
Expand Down
56 changes: 56 additions & 0 deletions src/__tests__/__snapshots__/waf.test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ Array [
"Statement": Object {
"RateBasedStatement": Object {
"AggregateKeyType": "IP",
"EvaluationWindowSec": 300,
"ForwardedIPConfig": undefined,
"Limit": 100,
"ScopeDownStatement": Object {
Expand Down Expand Up @@ -229,6 +230,7 @@ Array [
"Statement": Object {
"RateBasedStatement": Object {
"AggregateKeyType": "IP",
"EvaluationWindowSec": 300,
"ForwardedIPConfig": undefined,
"Limit": 100,
"ScopeDownStatement": Object {
Expand Down Expand Up @@ -483,6 +485,57 @@ Object {
}
`;

exports[`Waf Disable introspection should generate a preset rule with custom config 1`] = `
Object {
"Action": Object {
"Block": Object {},
},
"Name": "BaseDisableIntrospection",
"Priority": 200,
"Statement": Object {
"OrStatement": Object {
"Statements": Array [
Object {
"SizeConstraintStatement": Object {
"ComparisonOperator": "GT",
"FieldToMatch": Object {
"Body": Object {},
},
"Size": 8192,
"TextTransformations": Array [
Object {
"Priority": 0,
"Type": "NONE",
},
],
},
},
Object {
"ByteMatchStatement": Object {
"FieldToMatch": Object {
"Body": Object {},
},
"PositionalConstraint": "CONTAINS",
"SearchString": "__schema",
"TextTransformations": Array [
Object {
"Priority": 0,
"Type": "COMPRESS_WHITE_SPACE",
},
],
},
},
],
},
},
"VisibilityConfig": Object {
"CloudWatchMetricsEnabled": false,
"MetricName": "DisableIntrospection",
"SampledRequestsEnabled": false,
},
}
`;

exports[`Waf Disable introspection should generate a preset rule with custon config 1`] = `
Object {
"Action": Object {
Expand Down Expand Up @@ -544,6 +597,7 @@ Object {
"Statement": Object {
"RateBasedStatement": Object {
"AggregateKeyType": "IP",
"EvaluationWindowSec": 300,
"ForwardedIPConfig": undefined,
"Limit": 100,
"ScopeDownStatement": undefined,
Expand All @@ -567,6 +621,7 @@ Object {
"Statement": Object {
"RateBasedStatement": Object {
"AggregateKeyType": "FORWARDED_IP",
"EvaluationWindowSec": 60,
"ForwardedIPConfig": Object {
"FallbackBehavior": "MATCH",
"HeaderName": "X-Forwarded-To",
Expand All @@ -593,6 +648,7 @@ Object {
"Statement": Object {
"RateBasedStatement": Object {
"AggregateKeyType": "IP",
"EvaluationWindowSec": 300,
"ForwardedIPConfig": undefined,
"Limit": 500,
"ScopeDownStatement": undefined,
Expand Down
3 changes: 2 additions & 1 deletion src/__tests__/waf.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ describe('Waf', () => {
throttle: {
priority: 300,
limit: 200,
evaluationWindowSec: 60,
aggregateKeyType: 'FORWARDED_IP',
forwardedIPConfig: {
headerName: 'X-Forwarded-To',
Expand Down Expand Up @@ -125,7 +126,7 @@ describe('Waf', () => {
).toMatchSnapshot();
});

it('should generate a preset rule with custon config', () => {
it('should generate a preset rule with custom config', () => {
expect(
waf.buildWafRule(
{
Expand Down
3 changes: 3 additions & 0 deletions src/resources/Waf.ts
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,7 @@ export class Waf {
): CfnWafRule {
let Name = `${defaultNamePrefix || ''}Throttle`;
let Limit = 100;
let EvaluationWindowSec = 300;
let AggregateKeyType = 'IP';
let ForwardedIPConfig;
let Priority;
Expand All @@ -305,6 +306,7 @@ export class Waf {
Name = config.name || Name;
AggregateKeyType = config.aggregateKeyType || AggregateKeyType;
Limit = config.limit || Limit;
EvaluationWindowSec = config.evaluationWindowSec || EvaluationWindowSec;
Priority = config.priority;
ScopeDownStatement = config.scopeDownStatement;
if (AggregateKeyType === 'FORWARDED_IP') {
Expand All @@ -326,6 +328,7 @@ export class Waf {
RateBasedStatement: {
AggregateKeyType,
Limit,
EvaluationWindowSec,
ForwardedIPConfig,
ScopeDownStatement,
},
Expand Down
1 change: 1 addition & 0 deletions src/types/cloudFormation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@ type CfnWafRuleRateBasedStatement = {
HeaderName: string;
};
Limit: number;
EvaluationWindowSec?: number;
ScopeDownStatement?: CfnWafRuleStatement;
};

Expand Down
1 change: 1 addition & 0 deletions src/types/common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ export type WafThrottleConfig =
action?: WafAction;
aggregateKeyType?: 'IP' | 'FORWARDED_IP';
limit?: number;
evaluationWindowSec?: number;
priority?: number;
forwardedIPConfig?: {
headerName: string;
Expand Down