spring-projects / spring-projects/spring-security

Revisit Authentication Configuration Documentation

Open
#12,632 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

status: waiting-for-triage type: enhancement
Dominant language
Java
Stars
9.6k
Forks
6.3k
Avg merge
2d 11h
Merged PRs (30d)
52

Description

We should go through the Authentication documentation and ensure that we explain that UserDetailsService can be published as a Bean (optionally PasswordEncoder) and they will automatically create an AuthenticationManager.

The documentation should also state that if AuthenticationProvider is provided as a Bean it will be used rather than a UserDetailsService.

If the user wants the most power an AuthenticationManager can be published as a Bean.

If specific Authentication needs to be on specific HttpSecurity it can be provided on the DSL.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Authentication documentation referenced in the issue. Review the existing explanation of UserDetailsService, PasswordEncoder, AuthenticationProvider, AuthenticationManager, and the HttpSecurity DSL, then update it to cover their publication and precedence. Done means the documentation clearly explains each configuration option and when to use it.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
authentication, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.