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

Docs/secrets sync ssrf private endpoints #28746

Merged
merged 6 commits into from
Dec 13, 2024

Conversation

pixambi
Copy link
Contributor

@pixambi pixambi commented Oct 22, 2024

🔍 Deploy preview

The Secrets Sync update in 1.17.3 introduced SSRF protection that blocks private IP ranges, affecting users accessing secret stores through private endpoints. Adding documentation about the change

Description

This PR adds documentation to the 1.17.x upgrade guide about a breaking change in Secrets Sync introduced in version 1.17.3. The documentation:

  • Explains the new SSRF protection mechanism added to Secrets Sync
  • Provides example error messages users might encounter
  • Lists current options for users affected by this change

This change helps users understand why their Secrets Sync operations might fail after upgrading to 1.17.3 and what options are available to them.

TODO only if you're a HashiCorp employee

  • Backport Labels: If this PR is in the ENT repo and needs to be backported, backport
    to N, N-1, and N-2, using the backport/ent/x.x.x+ent labels. If this PR is in the CE repo, you should only backport to N, using the backport/x.x.x label, not the enterprise labels.
    • If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
  • ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
    of a public function, even if that change is in a CE file, double check that
    applying the patch for this PR to the ENT repo and running tests doesn't
    break any tests. Sometimes ENT only tests rely on public functions in CE
    files.
  • Jira: If this change has an associated Jira, it's referenced either
    in the PR description, commit message, or branch name.
  • RFC: If this change has an associated RFC, please link it in the description.
  • ENT PR: If this change has an associated ENT PR, please link it in the
    description. Also, make sure the changelog is in this PR, not in your ENT PR.

…e guide

The Secrets Sync feature in 1.17.3 introduced SSRF protection that blocks private IP ranges, affecting users accessing secret stores through private endpoints. This adds documentation about the change and available options.
@pixambi pixambi added the docs label Oct 22, 2024
@pixambi pixambi self-assigned this Oct 22, 2024
@pixambi pixambi requested a review from a team as a code owner October 22, 2024 02:35
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Oct 22, 2024
Copy link

hashicorp-cla-app bot commented Oct 22, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes

Have you signed the CLA already but the status is still pending? Recheck it.

Copy link

CI Results:
All Go tests succeeded! ✅

Copy link

Build Results:
All builds succeeded! ✅

Copy link
Contributor

@yhyakuna yhyakuna left a comment

Choose a reason for hiding this comment

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

Added minor suggestions.

Copy link
Contributor Author

@pixambi pixambi left a comment

Choose a reason for hiding this comment

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

N/A

Copy link
Contributor Author

@pixambi pixambi left a comment

Choose a reason for hiding this comment

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

accepted all changes

@yhyakuna yhyakuna merged commit e43fe23 into main Dec 13, 2024
33 of 34 checks passed
@yhyakuna yhyakuna deleted the docs/secrets-sync-ssrf-private-endpoints branch December 13, 2024 15:50
yhyakuna added a commit that referenced this pull request Dec 13, 2024
* docs: add Secrets Sync SSRF protection breaking change to 1.17 upgrade guide

The Secrets Sync feature in 1.17.3 introduced SSRF protection that blocks private IP ranges, affecting users accessing secret stores through private endpoints. This adds documentation about the change and available options.

* renamed issue

* referenced secret sync ssrf known issue

* re-ordered secret sync known issue in page

* Hide copy-to-clipboard button on the output example codeblock

---------

Co-authored-by: yhyakuna <[email protected]>
yhyakuna added a commit that referenced this pull request Dec 13, 2024
* docs: add Secrets Sync SSRF protection breaking change to 1.17 upgrade guide

The Secrets Sync feature in 1.17.3 introduced SSRF protection that blocks private IP ranges, affecting users accessing secret stores through private endpoints. This adds documentation about the change and available options.

* renamed issue

* referenced secret sync ssrf known issue

* re-ordered secret sync known issue in page

* Hide copy-to-clipboard button on the output example codeblock

---------

Co-authored-by: yhyakuna <[email protected]>
yhyakuna added a commit that referenced this pull request Dec 13, 2024
* Docs/secrets sync ssrf private endpoints (#28746)

* docs: add Secrets Sync SSRF protection breaking change to 1.17 upgrade guide

The Secrets Sync feature in 1.17.3 introduced SSRF protection that blocks private IP ranges, affecting users accessing secret stores through private endpoints. This adds documentation about the change and available options.

* renamed issue

* referenced secret sync ssrf known issue

* re-ordered secret sync known issue in page

* Hide copy-to-clipboard button on the output example codeblock

---------

Co-authored-by: yhyakuna <[email protected]>

* Remove extra include

---------

Co-authored-by: James <[email protected]>
yhyakuna added a commit that referenced this pull request Dec 13, 2024
* Docs/secrets sync ssrf private endpoints (#28746)

* docs: add Secrets Sync SSRF protection breaking change to 1.17 upgrade guide

The Secrets Sync feature in 1.17.3 introduced SSRF protection that blocks private IP ranges, affecting users accessing secret stores through private endpoints. This adds documentation about the change and available options.

* renamed issue

* referenced secret sync ssrf known issue

* re-ordered secret sync known issue in page

* Hide copy-to-clipboard button on the output example codeblock

---------

Co-authored-by: yhyakuna <[email protected]>

* Fix build issue

---------

Co-authored-by: James <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/1.18.x docs hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed pr/no-changelog sync/aws
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants