Skip to content
New issue

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

#

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

Already on GitHub? # to your account

docs(cloudfront): updates to CloudFront ResponseHeadersPolicy XSSProtection #31301

Merged
merged 4 commits into from
Sep 4, 2024
Merged

docs(cloudfront): updates to CloudFront ResponseHeadersPolicy XSSProtection #31301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2774b99
Updated documentation and tests
awslukeguan Aug 30, 2024
dab342e
added statement in readme
awslukeguan Sep 3, 2024
9c3c6da
Update packages/aws-cdk-lib/aws-cloudfront/README.md
kaizencc Sep 4, 2024
d9c61a6
Merge branch 'main' into gprcloudfrontxss00
kaizencc Sep 4, 2024
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
5 changes: 4 additions & 1 deletion packages/aws-cdk-lib/aws-cloudfront/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,9 @@ You can configure CloudFront to add one or more HTTP headers to the responses th
To specify the headers that CloudFront adds to HTTP responses, you use a response headers policy. CloudFront adds the headers regardless of whether it serves the object from the cache or has to retrieve the object from the origin. If the origin response includes one or more of the headers that’s in a response headers policy, the policy can specify whether CloudFront uses the header it received from the origin or overwrites it with the one in the policy.
See https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/adding-response-headers.html

> [!NOTE]
> If xssProtection `reportUri` is specified, then `modeBlock` cannot be set to `true`.

```ts
// Using an existing managed response headers policy
declare const bucketOrigin: origins.S3Origin;
Expand Down Expand Up @@ -343,7 +346,7 @@ const myResponseHeadersPolicy = new cloudfront.ResponseHeadersPolicy(this, 'Resp
frameOptions: { frameOption: cloudfront.HeadersFrameOption.DENY, override: true },
referrerPolicy: { referrerPolicy: cloudfront.HeadersReferrerPolicy.NO_REFERRER, override: true },
strictTransportSecurity: { accessControlMaxAge: Duration.seconds(600), includeSubdomains: true, override: true },
xssProtection: { protection: true, modeBlock: true, reportUri: 'https://example.com/csp-report', override: true },
awslukeguan marked this conversation as resolved.
Show resolved Hide resolved
xssProtection: { protection: true, modeBlock: false, reportUri: 'https://example.com/csp-report', override: true },
},
removeHeaders: ['Server'],
serverTimingSamplingRate: 50,
Expand Down
4 changes: 2 additions & 2 deletions packages/aws-cdk-lib/aws-cloudfront/test/response-headers-policy.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ describe('ResponseHeadersPolicy', () => {
frameOptions: { frameOption: HeadersFrameOption.DENY, override: true },
referrerPolicy: { referrerPolicy: HeadersReferrerPolicy.NO_REFERRER, override: true },
strictTransportSecurity: { accessControlMaxAge: Duration.seconds(600), includeSubdomains: true, override: true },
xssProtection: { protection: true, modeBlock: true, reportUri: 'https://example.com/csp-report', override: true },
xssProtection: { protection: true, modeBlock: false, reportUri: 'https://example.com/csp-report', override: true },
},
removeHeaders: ['Server'],
serverTimingSamplingRate: 12.3456,
Expand Down Expand Up @@ -136,7 +136,7 @@ describe('ResponseHeadersPolicy', () => {
Override: true,
},
XSSProtection: {
ModeBlock: true,
ModeBlock: false,
Override: true,
Protection: true,
ReportUri: 'https://example.com/csp-report',
Expand Down