8000 Update Docs For Bound Audience Explanation by jaireddjawed · Pull Request #30519 · hashicorp/vault · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Update Docs For Bound Audience Explanation #30519

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 9 commits into from
May 13, 2025
Merged

Update Docs For Bound Audience Explanation #30519

merged 9 commits into from
May 13, 2025

Conversation

jaireddjawed
Copy link
Contributor
@jaireddjawed jaireddjawed commented May 5, 2025 •
edited
Loading

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 scellef and anwittin 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 GitHub Actions
Copy link
github-actions bot commented 8000 May 5, 2025 •
edited
Loading

CI Results:
All Go tests succeeded! ✅

@github-actions GitHub Actions
Copy link
github-actions bot commented May 5, 2025 •
edited
Loading

Build Results:
All builds succeeded! ✅

@jaireddjawed jaireddjawed requested review from lursu, benashz, stevealmyHC and a team May 5, 2025 18:09
@jaireddjawed jaireddjawed force-pushed the VAULT-33101-update-bound-audience-docs branch from c08640f to 3c4c325 Compare May 5, 2025 18:25
@jaireddjawed jaireddjawed added backport/ent/1.17.x+ent Changes are backported to 1.17.x+ent backport/ent/1.18.x+ent labels May 5, 2025
@jaireddjawed jaireddjawed requested a review from a team as a code owner May 5, 2025 18:44
@jaireddjawed jaireddjawed removed backport/ent/1.17.x+ent Changes are backported to 1.17.x+ent backport/ent/1.18.x+ent labels May 5, 2025
fairclothjm
fairclothjm reviewed May 12, 2025
View reviewed changes
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 •
edited
Loading

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
fairclothjm
fairclothjm previously approved these changes May 12, 2025
View reviewed changes
yhyakuna
yhyakuna previously approved these changes May 13, 2025
View reviewed changes
schavis
schavis requested changes May 13, 2025
View reviewed changes
@jaireddjawed @schavis
Update website/content/docs/auth/jwt/index.mdx
990f0d3 
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
@jaireddjawed @schavis
Update website/content/api-docs/auth/jwt.mdx
8e1962c 
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
@jaireddjawed jaireddjawed added backport/ent/1.17.x+ent Changes are backported to 1.17.x+ent backport/ent/1.18.x+ent labels May 13, 2025
@jaireddjawed jaireddjawed requested a review from schavis May 13, 2025 20:40
@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
Open
6 tasks
jaireddjawed added a commit that referenced this pull request May 13, 2025
@jaireddjawed @schavis
Update Docs For Bound Audience Explanation (#30519)
cb1fc76 
* 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
@jaireddjawed @schavis
Update Docs For Bound Audience Explanation (#30519)
32365f6 
* 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>
This was referenced May 13, 2025
Merged
Open
jaireddjawed added a commit that referenced this pull request May 13, 2025
@jaireddjawed @schavis
Update Docs For Bound Audience Explanation (#30519) (#30608)
0bbb446 
* 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>
drivera258 pushed a commit that referenced this pull request May 14, 2025
@jaireddjawed @schavis @drivera258
Update Docs For Bound Audience Explanation (#30519)
dab53bb 
* 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>
drivera258 pushed a commit that referenced this pull request May 14, 2025
@jaireddjawed @schavis @drivera258
Update Docs For Bound Audience Explanation (#30519)
3c0ffa8 
* 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
Reviewers

@schavis schavis schavis approved these changes

@yhyakuna yhyakuna yhyakuna left review comments

@fairclothjm fairclothjm fairclothjm left review comments

@scellef scellef Awaiting requested review from scellef scellef is a code owner automatically assigned from hashicorp/vault-customer-engineering

@anwittin anwittin Awaiting requested review from anwittin anwittin is a code owner automatically assigned from hashicorp/vault-customer-engineering

@lursu lursu Awaiting requested review from lursu

@benashz benashz Awaiting requested review from benashz

@stevealmyHC stevealmyHC Awaiting requested review from stevealmyHC

Assignees

@jaireddjawed jaireddjawed

Labels
backport/ent/1.17.x+ent Changes are backported to 1.17.x+ent backport/ent/1.18.x+ent backport/1.19.x docs hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed pr/no-changelog pr/no-milestone
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jaireddjawed @yhyakuna @fairclothjm @schavis
0