Skip to content

Conversation

@jaireddjawed
Copy link
Contributor

@jaireddjawed jaireddjawed commented May 5, 2025

Description

This PR updates our JWT documentation to clearly specify that the bound audience must exactly match the bound claim stored in Vault for successful authentication when using the JWT login method.

TODO only if you're a HashiCorp employee

  • Backport Labels: If this fix needs to be backported, use the appropriate backport/ label that matches the desired release branch. Note that in the CE repo, the latest release branch will look like backport/x.x.x, but older release branches will be backport/ent/x.x.x+ent.
    • LTS: 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.

@jaireddjawed jaireddjawed self-assigned this May 5, 2025
@jaireddjawed jaireddjawed requested review from a team as code owners May 5, 2025 18:08
@jaireddjawed jaireddjawed requested review from anwittin and scellef May 5, 2025 18:08
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label May 5, 2025
@github-actions
Copy link

github-actions bot commented May 5, 2025

CI Results:
All Go tests succeeded! ✅

@github-actions
Copy link

github-actions bot commented May 5, 2025

Build Results:
All builds succeeded! ✅

@jaireddjawed jaireddjawed force-pushed the VAULT-33101-update-bound-audience-docs branch from c08640f to 3c4c325 Compare May 5, 2025 18:25
Copy link
Contributor

@fairclothjm fairclothjm left a comment

Choose a reason for hiding this comment

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

LGTM, if we remove the changelog entry.

FYI: you can skip all the Vault CI checks if you prefix your git branch with docs/.

@jaireddjawed
Copy link
Contributor Author

jaireddjawed commented May 12, 2025

LGTM, if we remove the changelog entry.

FYI: you can skip all the Vault CI checks if you prefix your git branch with docs/.

Sounds good. I'll keep that in mind for the next doc update. Added the "no changelog" entry for this PR for now.

@jaireddjawed jaireddjawed requested a review from fairclothjm May 12, 2025 15:16
yhyakuna
yhyakuna previously approved these changes May 13, 2025
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
@jaireddjawed jaireddjawed dismissed stale reviews from yhyakuna and fairclothjm via 990f0d3 May 13, 2025 20:38
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
@jaireddjawed jaireddjawed merged commit 1face9d into main May 13, 2025
38 of 39 checks passed
@jaireddjawed jaireddjawed deleted the VAULT-33101-update-bound-audience-docs branch May 13, 2025 20:44
jaireddjawed added a commit that referenced this pull request May 13, 2025
* update docs for more clarity around bound audiences

* more updates

* update changelog

* Delete changelog/30519.txt

* Update website/content/docs/auth/jwt/index.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/auth/jwt.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
jaireddjawed added a commit that referenced this pull request May 13, 2025
* update docs for more clarity around bound audiences

* more updates

* update changelog

* Delete changelog/30519.txt

* Update website/content/docs/auth/jwt/index.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/auth/jwt.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
jaireddjawed added a commit that referenced this pull request May 13, 2025
* update docs for more clarity around bound audiences

* more updates

* update changelog

* Delete changelog/30519.txt

* Update website/content/docs/auth/jwt/index.mdx



* Update website/content/api-docs/auth/jwt.mdx



---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
jaireddjawed added a commit that referenced this pull request Jul 17, 2025
* update docs for more clarity around bound audiences

* more updates

* update changelog

* Delete changelog/30519.txt

* Update website/content/docs/auth/jwt/index.mdx



* Update website/content/api-docs/auth/jwt.mdx



---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Erfankam pushed a commit to Erfankam/vault that referenced this pull request Sep 1, 2025
* update docs for more clarity around bound audiences

* more updates

* update changelog

* Delete changelog/30519.txt

* Update website/content/docs/auth/jwt/index.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/auth/jwt.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs 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.

4 participants