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 Fix vault path-help for selected paths with bad regexps into release/1.13.x #21528

Conversation

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

Backport

This PR is auto-generated from #18571 to be assessed for backporting due to the inclusion of the label backport/1.13.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:
@hghaf099
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.


Describe the bug
When a Vault API path has been defined with a regex that requires a final slash, the vault path-help command is unable to retrieve help for it.

Underlying cause
Vault's code automatically appends a trailing slash on to all paths used for ListOperations, but removes a trailing slash for all other operations, including HelpOperations. In order for a path pattern to match both ListOperation and HelpOperation, it must accept both the presence and absence of a trailing slash.

To Reproduce, or test the fix

  1. Start a Vault dev server
  2. Run vault path-help auth/token/accessors/
  3. See an unsupported path error

Expected behavior
Help message displayed as expected.

Fix
Update the few path regex patterns that fall into this trap to end with /? instead of /.

Update a comment to explain why.


Overview of commits

@hc-github-team-secure-vault-core hc-github-team-secure-vault-core force-pushed the backport/fix-path-help-slash/eagerly-closing-osprey branch 2 times, most recently from 3b73253 to e109339 Compare June 30, 2023 17:37
@hashicorp-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 already have 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants