spring-projects / spring-projects/spring-security
[Documentation] Update resource server docs about valdiation of JWT 'aud' claim
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
The documentation (https://docs.spring.io/spring-security/reference/reactive/oauth2/resource-server/jwt.html#_runtime_expectations and https://docs.spring.io/spring-security/reference/servlet/oauth2/resource-server/jwt.html#_runtime_expectations) doesn't mention it, but if the configuration has the spring.security.oauth2.resourceserver.jwt.audiences property set than the resource server will validate the aud claims as well.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the reactive and servlet JWT runtime expectations sections linked in the issue and review how the spring.security.oauth2.resourceserver.jwt.audiences property is described. Update both sections to mention validation of the JWT aud claim when that property is configured. Done means the two resource-server documentation pages clearly cover this behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100