Skip to content

Commit b3c7f3f

Browse files
marcusdacoregiomarcusdacoregio
committed
Rename CompromisedPasswordCheckResult to CompromisedPasswordDecision
Issue gh-7395
1 parent 1ca381c commit b3c7f3f

File tree

11 files changed

+34
-34
lines changed

11 files changed

+34
-34
lines changed

‎config/src/test/java/org/springframework/security/config/annotation/web/configuration/HttpSecurityConfigurationTests.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@
4747
import org.springframework.security.authentication.event.AbstractAuthenticationEvent;
4848
import org.springframework.security.authentication.event.AbstractAuthenticationFailureEvent;
4949
import org.springframework.security.authentication.event.AuthenticationSuccessEvent;
50-
import org.springframework.security.authentication.password.CompromisedPasswordCheckResult;
5150
import org.springframework.security.authentication.password.CompromisedPasswordChecker;
51+
import org.springframework.security.authentication.password.CompromisedPasswordDecision;
5252
import org.springframework.security.authentication.password.CompromisedPasswordException;
5353
import org.springframework.security.config.Customizer;
5454
import org.springframework.security.config.annotation.SecurityContextChangedListenerConfig;
@@ -809,11 +809,11 @@ SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
809809
private static class TestCompromisedPasswordChecker implements CompromisedPasswordChecker {
810810

811811
@Override
812-
public CompromisedPasswordCheckResult check(String password) {
812+
public CompromisedPasswordDecision check(String password) {
813813
if ("password".equals(password)) {
814-
return new CompromisedPasswordCheckResult(true);
814+
return new CompromisedPasswordDecision(true);
815815
}
816-
return new CompromisedPasswordCheckResult(false);
816+
return new CompromisedPasswordDecision(false);
817817
}
818818

819819
}

‎config/src/test/java/org/springframework/security/config/annotation/web/reactive/ServerHttpSecurityConfigurationTests.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import org.springframework.context.ApplicationContext;
2727
import org.springframework.context.annotation.Bean;
2828
import org.springframework.context.annotation.Configuration;
29-
import org.springframework.security.authentication.password.CompromisedPasswordCheckResult;
29+
import org.springframework.security.authentication.password.CompromisedPasswordDecision;
3030
import org.springframework.security.authentication.password.CompromisedPasswordException;
3131
import org.springframework.security.authentication.password.ReactiveCompromisedPasswordChecker;
3232
import org.springframework.security.config.Customizer;
@@ -228,11 +228,11 @@ TestReactivePasswordChecker compromisedPasswordChecker() {
228228
static class TestReactivePasswordChecker implements ReactiveCompromisedPasswordChecker {
229229

230230
@Override
231-
public Mono<CompromisedPasswordCheckResult> check(String password) {
231+
public Mono<CompromisedPasswordDecision> check(String password) {
232232
if ("password".equals(password)) {
233-
return Mono.just(new CompromisedPasswordCheckResult(true));
233+
return Mono.just(new CompromisedPasswordDecision(true));
234234
}
235-
return Mono.just(new CompromisedPasswordCheckResult(false));
235+
return Mono.just(new CompromisedPasswordDecision(false));
236236
}
237237

238238
}

‎core/src/main/java/org/springframework/security/authentication/AbstractUserDetailsReactiveAuthenticationManager.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@
2525
import org.springframework.context.MessageSource;
2626
import org.springframework.context.MessageSourceAware;
2727
import org.springframework.context.support.MessageSourceAccessor;
28-
import org.springframework.security.authentication.password.CompromisedPasswordCheckResult;
2928
import org.springframework.security.authentication.password.CompromisedPasswordChecker;
29+
import org.springframework.security.authentication.password.CompromisedPasswordDecision;
3030
import org.springframework.security.authentication.password.CompromisedPasswordException;
3131
import org.springframework.security.authentication.password.ReactiveCompromisedPasswordChecker;
3232
import org.springframework.security.core.Authentication;
@@ -118,7 +118,7 @@ private Mono<Void> checkCompromisedPassword(String password) {
118118
return Mono.empty();
119119
}
120120
return this.compromisedPasswordChecker.check(password)
121-
.filter(CompromisedPasswordCheckResult::isCompromised)
121+
.filter(CompromisedPasswordDecision::isCompromised)
122122
.flatMap((compromised) -> Mono.error(new CompromisedPasswordException(
123123
"The provided password is compromised, please change your password")));
124124
}

‎core/src/main/java/org/springframework/security/authentication/password/CompromisedPasswordChecker.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ public interface CompromisedPasswordChecker {
2929
/**
3030
* Check whether the password is compromised
3131
* @param password the password to check
32-
* @return a non-null {@link CompromisedPasswordCheckResult}
32+
* @return a non-null {@link CompromisedPasswordDecision}
3333
*/
3434
@NonNull
35-
CompromisedPasswordCheckResult check(String password);
35+
CompromisedPasswordDecision check(String password);
3636

3737
}

‎core/src/main/java/org/springframework/security/authentication/password/CompromisedPasswordCheckResult.java renamed to ‎core/src/main/java/org/springframework/security/authentication/password/CompromisedPasswordDecision.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@
1616

1717
package org.springframework.security.authentication.password;
1818

19-
public class CompromisedPasswordCheckResult {
19+
public class CompromisedPasswordDecision {
2020

2121
private final boolean compromised;
2222

23-
public CompromisedPasswordCheckResult(boolean compromised) {
23+
public CompromisedPasswordDecision(boolean compromised) {
2424
this.compromised = compromised;
2525
}
2626

‎core/src/main/java/org/springframework/security/authentication/password/ReactiveCompromisedPasswordChecker.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ public interface ReactiveCompromisedPasswordChecker {
2929
/**
3030
* Check whether the password is compromised
3131
* @param password the password to check
32-
* @return a {@link Mono} containing the {@link CompromisedPasswordCheckResult}
32+
* @return a {@link Mono} containing the {@link CompromisedPasswordDecision}
3333
*/
34-
Mono<CompromisedPasswordCheckResult> check(String password);
34+
Mono<CompromisedPasswordDecision> check(String password);
3535

3636
}

‎core/src/test/java/org/springframework/security/authentication/UserDetailsRepositoryReactiveAuthenticationManagerTests.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
import reactor.test.StepVerifier;
2828

2929
import org.springframework.context.MessageSource;
30-
import org.springframework.security.authentication.password.CompromisedPasswordCheckResult;
30+
import org.springframework.security.authentication.password.CompromisedPasswordDecision;
3131
import org.springframework.security.authentication.password.CompromisedPasswordException;
3232
import org.springframework.security.authentication.password.ReactiveCompromisedPasswordChecker;
3333
import org.springframework.security.core.Authentication;
@@ -276,11 +276,11 @@ public void setMessageSourceWhenNotNullThenCanGet() {
276276
static class TestReactivePasswordChecker implements ReactiveCompromisedPasswordChecker {
277277

278278
@Override
279-
public Mono<CompromisedPasswordCheckResult> check(String password) {
279+
public Mono<CompromisedPasswordDecision> check(String password) {
280280
if ("password".equals(password)) {
281-
return Mono.just(new CompromisedPasswordCheckResult(true));
281+
return Mono.just(new CompromisedPasswordDecision(true));
282282
}
283-
return Mono.just(new CompromisedPasswordCheckResult(false));
283+
return Mono.just(new CompromisedPasswordDecision(false));
284284
}
285285

286286
}

‎core/src/test/java/org/springframework/security/authentication/dao/DaoAuthenticationProviderTests.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@
3333
import org.springframework.security.authentication.LockedException;
3434
import org.springframework.security.authentication.TestingAuthenticationToken;
3535
import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
36-
import org.springframework.security.authentication.password.CompromisedPasswordCheckResult;
3736
import org.springframework.security.authentication.password.CompromisedPasswordChecker;
37+
import org.springframework.security.authentication.password.CompromisedPasswordDecision;
3838
import org.springframework.security.authentication.password.CompromisedPasswordException;
3939
import org.springframework.security.core.Authentication;
4040
import org.springframework.security.core.GrantedAuthority;
@@ -637,11 +637,11 @@ public UserDetails loadUserByUsername(String username) {
637637
private static class TestCompromisedPasswordChecker implements CompromisedPasswordChecker {
638638

639639
@Override
640-
public CompromisedPasswordCheckResult check(String password) {
640+
public CompromisedPasswordDecision check(String password) {
641641
if ("password".equals(password)) {
642-
return new CompromisedPasswordCheckResult(true);
642+
return new CompromisedPasswordDecision(true);
643643
}
644-
return new CompromisedPasswordCheckResult(false);
644+
return new CompromisedPasswordDecision(false);
645645
}
646646

647647
}

‎web/src/main/java/org/springframework/security/web/authentication/password/HaveIBeenPwnedRestApiPasswordChecker.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626
import org.apache.commons.logging.LogFactory;
2727

2828
import org.springframework.lang.NonNull;
29-
import org.springframework.security.authentication.password.CompromisedPasswordCheckResult;
3029
import org.springframework.security.authentication.password.CompromisedPasswordChecker;
30+
import org.springframework.security.authentication.password.CompromisedPasswordDecision;
3131
import org.springframework.security.crypto.codec.Hex;
3232
import org.springframework.util.Assert;
3333
import org.springframework.util.StringUtils;
@@ -61,15 +61,15 @@ public HaveIBeenPwnedRestApiPasswordChecker() {
6161

6262
@Override
6363
@NonNull
64-
public CompromisedPasswordCheckResult check(String password) {
64+
public CompromisedPasswordDecision check(String password) {
6565
byte[] hash = this.sha1Digest.digest(password.getBytes(StandardCharsets.UTF_8));
6666
String encoded = new String(Hex.encode(hash)).toUpperCase();
6767
String prefix = encoded.substring(0, PREFIX_LENGTH);
6868
String suffix = encoded.substring(PREFIX_LENGTH);
6969

7070
List<String> passwords = getLeakedPasswordsForPrefix(prefix);
7171
boolean isLeaked = findLeakedPassword(passwords, suffix);
72-
return new CompromisedPasswordCheckResult(isLeaked);
72+
return new CompromisedPasswordDecision(isLeaked);
7373
}
7474

7575
/**

‎web/src/main/java/org/springframework/security/web/authentication/password/HaveIBeenPwnedRestApiReactivePasswordChecker.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import reactor.core.publisher.Mono;
2727
import reactor.core.scheduler.Schedulers;
2828

29-
import org.springframework.security.authentication.password.CompromisedPasswordCheckResult;
29+
import org.springframework.security.authentication.password.CompromisedPasswordDecision;
3030
import org.springframework.security.authentication.password.ReactiveCompromisedPasswordChecker;
3131
import org.springframework.security.crypto.codec.Hex;
3232
import org.springframework.util.Assert;
@@ -60,10 +60,10 @@ public HaveIBeenPwnedRestApiReactivePasswordChecker() {
6060
}
6161

6262
@Override
63-
public Mono<CompromisedPasswordCheckResult> check(String password) {
63+
public Mono<CompromisedPasswordDecision> check(String password) {
6464
return getHash(password).map((hash) -> new String(Hex.encode(hash)))
6565
.flatMap(this::findLeakedPassword)
66-
.map(CompromisedPasswordCheckResult::new);
66+
.map(CompromisedPasswordDecision::new);
6767
}
6868

6969
private Mono<Boolean> findLeakedPassword(String encodedPassword) {

‎web/src/test/java/org/springframework/security/web/authentication/password/HaveIBeenPwnedRestApiPasswordCheckerTests.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import org.junit.jupiter.api.BeforeEach;
2626
import org.junit.jupiter.api.Test;
2727

28-
import org.springframework.security.authentication.password.CompromisedPasswordCheckResult;
28+
import org.springframework.security.authentication.password.CompromisedPasswordDecision;
2929
import org.springframework.web.client.RestClient;
3030

3131
import static org.assertj.core.api.Assertions.assertThat;
@@ -69,22 +69,22 @@ void tearDown() throws IOException {
6969
@Test
7070
void checkWhenPasswordIsLeakedThenIsCompromised() throws InterruptedException {
7171
this.server.enqueue(new MockResponse().setBody(this.pwnedPasswords).setResponseCode(200));
72-
CompromisedPasswordCheckResult check = this.passwordChecker.check("P@ssw0rd");
72+
CompromisedPasswordDecision check = this.passwordChecker.check("P@ssw0rd");
7373
assertThat(check.isCompromised()).isTrue();
7474
assertThat(this.server.takeRequest().getPath()).isEqualTo("/range/21BD1");
7575
}
7676

7777
@Test
7878
void checkWhenPasswordNotLeakedThenNotCompromised() {
7979
this.server.enqueue(new MockResponse().setBody(this.pwnedPasswords).setResponseCode(200));
80-
CompromisedPasswordCheckResult check = this.passwordChecker.check("My1nCr3d!bL3P@SS0W0RD");
80+
CompromisedPasswordDecision check = this.passwordChecker.check("My1nCr3d!bL3P@SS0W0RD");
8181
assertThat(check.isCompromised()).isFalse();
8282
}
8383

8484
@Test
8585
void checkWhenNoPasswordsReturnedFromApiCallThenNotCompromised() {
8686
this.server.enqueue(new MockResponse().setResponseCode(200));
87-
CompromisedPasswordCheckResult check = this.passwordChecker.check("123456");
87+
CompromisedPasswordDecision check = this.passwordChecker.check("123456");
8888
assertThat(check.isCompromised()).isFalse();
8989
}
9090

0 commit comments

Comments
 (0)