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.

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

feat(certificatemanager): Allow opting out of transparency logging #21686

Merged

Conversation

AKoetsier
Copy link
Contributor

Certificates created with AWS Certificate Manager are recorded in a certificate transparency log. ACM however allows you to opt of out of transparency logging. This feature enables certificates created in ACM through CDK to opt out of transparency logging.

All Submissions:

Adding new Unconventional Dependencies:

  • This PR adds new unconventional dependencies following the process described here

New Features

  • Have you added the new feature to an integration test?
    • Did you use yarn integ to deploy the infrastructure and generate the snapshot (i.e. yarn integ without --dry-run)?

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@gitpod-io
Copy link

gitpod-io bot commented Aug 19, 2022

@aws-cdk-automation aws-cdk-automation requested a review from a team August 19, 2022 14:21
@github-actions github-actions bot added the p2 label Aug 19, 2022
@@ -72,6 +72,13 @@ export interface CertificateProps {
* @default CertificateValidation.fromEmail()
*/
readonly validation?: CertificateValidation;

/**
* Enable or disable transparency logging for this certificate
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add something here about how enabling/disabling this works? For example I think you can't change it after creation?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Well you technically can change it in the api, however it will not have an effect. When a certificate is registered/logged it cannot be undone.

*
* @default TransparencyLoggingPreference.ENABLED
*/
readonly certificateTransparencyLoggingPreference?: TransparencyLoggingPreference;
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
readonly certificateTransparencyLoggingPreference?: TransparencyLoggingPreference;
readonly transparencyLoggingEnabled?: boolean;

Can we shorten the name to just transparencyLoggingEnabled? Also, since it is just enabled/disabled we can make it a boolean.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok will do

@corymhall corymhall added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Aug 22, 2022
@corymhall
Copy link
Contributor

exempting integration test since integration tests for certificatemanager require you to have a valid public domain (hence the lack of existing integration tests).

@AKoetsier AKoetsier force-pushed the feature/acm-toggle-certificate-transparency-logging branch from 67aaa4d to 515c0cb Compare August 23, 2022 06:38
@mergify mergify bot dismissed corymhall’s stale review August 23, 2022 06:38

Pull request has been modified.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: dde8a7c
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify
Copy link
Contributor

mergify bot commented Aug 23, 2022

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit 85b6db0 into aws:main Aug 23, 2022
josephedward pushed a commit to josephedward/aws-cdk that referenced this pull request Aug 30, 2022
…ws#21686)

Certificates created with AWS Certificate Manager are recorded in a certificate transparency log. ACM however allows you to opt of out of transparency logging. This feature enables certificates created in ACM through CDK to opt out of transparency logging.

* [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md)

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p2 pr-linter/exempt-integ-test The PR linter will not require integ test changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants