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

Backport of Do not acquire a read lock twice on tidyStatusLock during tidy-status into release/1.17.x #28557

Conversation

hc-github-team-secure-vault-core
Copy link
Contributor

Backport

This PR is auto-generated from #28556 to be assessed for backporting due to the inclusion of the label backport/1.17.x.

🚨

Warning automatic cherry-pick of commits failed. If the first commit failed,
you will see a blank no-op commit below. If at least one commit succeeded, you
will see the cherry-picked commits up to, not including, the commit where
the merge conflict occurred.

The person who merged in the original PR is:
@stevendpclark
This person should manually cherry-pick the original PR into a new backport PR,
and close this one when the manual backport PR is merged in.

merge conflict error: POST https://api.github.com/repos/hashicorp/vault/merges: 409 Merge conflict []

The below text is copied from the body of the original PR.


Description

A deadlock can occur when we are reading the PKI tidy-status endpoint. This was introduced within PR28488 so no version of Vault that was released contains this issue.

The deadlock occurs when

  1. The tidy-status api is called and acquires the read lock on tidyStatusLock at the top of pathTidyStatusRead line 1689
  2. A blocking Lock call is performed against tidyStatusLock say within startTidyOperation line 999
  3. The call to b.getLastAutoTidyTime() on line 1727 attempts to re-acquire the read lock on tidyStatusLock. Normally this works as both calls are requesting read locks so it goes through but once a Write lock request is pending we will deadlock.

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.

Overview of commits

Copy link

hashicorp-cla-app bot commented Oct 2, 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


temp seems not to be a GitHub user.
You need a GitHub account to be able to sign the CLA.
If you have already a GitHub account, please add the email address used for this commit to your account.

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

Copy link

github-actions bot commented Oct 2, 2024

CI Results:
All Go tests succeeded! ✅

@stevendpclark stevendpclark force-pushed the backport/stevendpclark/vault-31290-pki-lock-race/terminally-beloved-whale branch from 2b9f5af to 30da4eb Compare October 2, 2024 13:02
@stevendpclark stevendpclark marked this pull request as ready for review October 2, 2024 13:04
@stevendpclark stevendpclark requested a review from a team as a code owner October 2, 2024 13:04
@stevendpclark stevendpclark enabled auto-merge (squash) October 2, 2024 13:07
Copy link

github-actions bot commented Oct 2, 2024

Build Results:
All builds succeeded! ✅

@stevendpclark stevendpclark merged commit f63553d into release/1.17.x Oct 2, 2024
101 of 126 checks passed
@stevendpclark stevendpclark deleted the backport/stevendpclark/vault-31290-pki-lock-race/terminally-beloved-whale branch October 2, 2024 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed pr/no-changelog pr/no-milestone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants