Skip to content

Commit

Permalink
Update README to include information about deleting PCAs and Add SECU…
Browse files Browse the repository at this point in the history
…RITY.MD (cert-manager#17)

Co-authored-by: Akbar Baig <[email protected]>
  • Loading branch information
anbaig and baiakbar authored May 19, 2021
1 parent 0578579 commit 667441c
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,4 +114,6 @@ The tests will then spin up a kind cluster and create various Issuer/ClusterIssu

After the test, the resources created with the kind cluster are cleaned up, the kind cluster is deleted, and the CAs used during the test are deleted.

The Private CAs created during this test run are cleaned up on a **best-effort basis**. To ensure no runaway costs, verify via the AWS CLI or Console that the Private CAs created during the test run are in a deleted state. If you need to delete the Private CAs created during the test run yourself you may use the script test_utils/delete_ca.sh or refer to the [AWS Private CA documentation](https://docs.aws.amazon.com/acm-pca/latest/userguide/PCADeleteCA.html)

If at any point, ```make runtests``` encounters an error, the integration tests should be considered a failure.
41 changes: 41 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Vulnerability Reporting Process

Security is the number one priority for the AWS Private Certificate Authority (AWS PCA) external issuer for cert-manager. If you think you've found a
security vulnerability in the AWS PCA external issuer for
cert-manager, you're in the right place.

Our reporting procedure is a work-in-progress, and will evolve over time. We
welcome advice, feedback and pull requests for improving our security
reporting processes.

## Covered Repositories and Issues

This reporting process is intended only for security issues in the AWS PCA external
issuer itself, and doesn't apply to applications _using_ the exteral issuer or to
issues which do not affect security.

Broadly speaking, if the issue cannot be fixed by a change to the AWS PCA external issuer
, then it might not be appropriate to use this reporting
mechanism and a GitHub issue in the appropriate repo.

All that said, **if you're unsure** please reach out using this process before
raising your issue through another channel. We'd rather err on the side of
caution!

## Reporting Process

1. Describe the issue in English, ideally with some example configuration or
code which allows the issue to be reproduced. Explain why you believe this
to be a security issue in AWS PCA external issuer, if that's not obvious.
2. Put that information into an email. Use a descriptive title.
3. Send the email to [`AWS Security and the Maintainers of this Plugin`](mailto:[email protected],[email protected],[email protected],[email protected])

## Response

Response times could be affected by weekends, holidays, breaks or time zone
differences. That said, the security response team will endeavour to reply as
soon as possible.

As soon as the team decides that the report is of a genuine vulnerability,
one of the team will respond to the reporter acknowledging the issue and
establishing a disclosure timeline, which should be as soon as possible.

0 comments on commit 667441c

Please sign in to comment.