SpringCloud/spring-cloud-gateway
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Avoids possible null value in Principal.getName()

Browse Source 
Changes to get the Principal first via map, the return the name or empty if null.

Fixes gh-1854
This commit is contained in:
spencergibb
2020-08-28 11:07:09 -04:00
parent 147861bd32
commit b3a69dbcb4
2 changed files with 43 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
spring-cloud-gateway-core/src/main/java/org/springframework/cloud/gateway/filter/ratelimit/PrincipalNameKeyResolver.java
View File

@@ -16,8 +16,6 @@
package org.springframework.cloud.gateway.filter.ratelimit;
import java.security.Principal;
import reactor.core.publisher.Mono;
import org.springframework.web.server.ServerWebExchange;
@@ -31,8 +29,7 @@ public class PrincipalNameKeyResolver implements KeyResolver {
@Override
public Mono<String> resolve(ServerWebExchange exchange) {
return exchange.getPrincipal().map(Principal::getName)
.switchIfEmpty(Mono.empty());
return exchange.getPrincipal().flatMap(p -> Mono.justOrEmpty(p.getName()));
}
}

42
spring-cloud-gateway-core/src/test/java/org/springframework/cloud/gateway/filter/ratelimit/PrincipalNameKeyResolverTests.java Normal file
View File

@@ -0,0 +1,42 @@
/*
* Copyright 2013-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.cloud.gateway.filter.ratelimit;
import java.security.Principal;
import java.time.Duration;
import org.junit.jupiter.api.Test;
import reactor.core.publisher.Mono;
import reactor.test.StepVerifier;
import org.springframework.web.server.ServerWebExchange;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
public class PrincipalNameKeyResolverTests {
@Test
public void nullPrincipalNameWorks() {
PrincipalNameKeyResolver keyResolver = new PrincipalNameKeyResolver();
ServerWebExchange exchange = mock(ServerWebExchange.class);
when(exchange.getPrincipal()).thenReturn(Mono.just(mock(Principal.class)));
StepVerifier.create(keyResolver.resolve(exchange)).expectComplete()
.verify(Duration.ofSeconds(5));
}
}