Skip to content

Add nullability contract to PasswordEncoder#encode #18334

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

Merged
rwinch merged 2 commits into from
Jan 12, 2026
Merged

Add nullability contract to PasswordEncoder#encode #18334

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d526a24
Add nullability contract to `PasswordEncoder#encode`
scordio Dec 18, 2025
faba8b8
Fix checkstyle
rwinch Jan 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions crypto/src/main/java/org/springframework/security/crypto/password/PasswordEncoder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@

import org.jspecify.annotations.Nullable;

import org.springframework.lang.Contract;

/**
* Service interface for encoding passwords.
*
Expand All @@ -36,6 +38,7 @@ public interface PasswordEncoder {
* @return A non-null encoded password, unless the rawPassword was null in which case
* the result must be null.
*/
@Contract("null -> null; !null -> !null")
Copy link

@msridhar msridhar Jan 13, 2026

Choose a reason for hiding this comment

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

LGTM! Technically, I think this contract should also be copied down to any implementations of encode in classes implementing PasswordEncoder as well. That way, if you enable NullAway's contract checking, it will check that the implementation adheres to the contract. Plus, right now if you write BCryptPasswordEncoder b = ...; x = b.encode(...);, NullAway won't see the contract on the interface method and won't apply it.

Copy link
Contributor Author

@scordio scordio Jan 13, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Ah, good point! Addressed in #18490.

@Nullable String encode(@Nullable CharSequence rawPassword);

/**
Expand Down
Loading