Add support JdbcOneTimeTokenService
Closes gh-15735
This commit is contained in:
Max Batischev
@@ -0,0 +1,59 @@
|
||||
/*
|
||||
* Copyright 2002-2024 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.security.aot.hint;
|
||||
|
||||
import java.util.stream.Stream;
|
||||
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.params.ParameterizedTest;
|
||||
import org.junit.jupiter.params.provider.MethodSource;
|
||||
|
||||
import org.springframework.aot.hint.RuntimeHints;
|
||||
import org.springframework.aot.hint.RuntimeHintsRegistrar;
|
||||
import org.springframework.aot.hint.predicate.RuntimeHintsPredicates;
|
||||
import org.springframework.core.io.support.SpringFactoriesLoader;
|
||||
import org.springframework.util.ClassUtils;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Tests for {@link OneTimeTokenRuntimeHints}
|
||||
*
|
||||
* @author Max Batischev
|
||||
*/
|
||||
class OneTimeTokenRuntimeHintsTests {
|
||||
|
||||
private final RuntimeHints hints = new RuntimeHints();
|
||||
|
||||
@BeforeEach
|
||||
void setup() {
|
||||
SpringFactoriesLoader.forResourceLocation("META-INF/spring/aot.factories")
|
||||
.load(RuntimeHintsRegistrar.class)
|
||||
.forEach((registrar) -> registrar.registerHints(this.hints, ClassUtils.getDefaultClassLoader()));
|
||||
}
|
||||
|
||||
@ParameterizedTest
|
||||
@MethodSource("getOneTimeTokensSqlFiles")
|
||||
void oneTimeTokensSqlFilesHasHints(String schemaFile) {
|
||||
assertThat(RuntimeHintsPredicates.resource().forResource(schemaFile)).accepts(this.hints);
|
||||
}
|
||||
|
||||
private static Stream<String> getOneTimeTokensSqlFiles() {
|
||||
return Stream.of("org/springframework/security/core/ott/jdbc/one-time-tokens-schema.sql");
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,196 @@
|
||||
/*
|
||||
* Copyright 2002-2024 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.security.authentication.ott;
|
||||
|
||||
import java.time.Clock;
|
||||
import java.time.Instant;
|
||||
import java.time.ZoneOffset;
|
||||
import java.time.temporal.ChronoUnit;
|
||||
import java.util.List;
|
||||
|
||||
import org.junit.jupiter.api.AfterEach;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.jdbc.core.ArgumentPreparedStatementSetter;
|
||||
import org.springframework.jdbc.core.JdbcOperations;
|
||||
import org.springframework.jdbc.core.JdbcTemplate;
|
||||
import org.springframework.jdbc.core.PreparedStatementSetter;
|
||||
import org.springframework.jdbc.core.SqlParameterValue;
|
||||
import org.springframework.jdbc.datasource.embedded.EmbeddedDatabase;
|
||||
import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder;
|
||||
import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType;
|
||||
import org.springframework.util.CollectionUtils;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
|
||||
|
||||
/**
|
||||
* Tests for {@link JdbcOneTimeTokenService}.
|
||||
*
|
||||
* @author Max Batischev
|
||||
*/
|
||||
public class JdbcOneTimeTokenServiceTests {
|
||||
|
||||
private static final String USERNAME = "user";
|
||||
|
||||
private static final String TOKEN_VALUE = "1234";
|
||||
|
||||
private static final String ONE_TIME_TOKEN_SQL_RESOURCE = "org/springframework/security/core/ott/jdbc/one-time-tokens-schema.sql";
|
||||
|
||||
private EmbeddedDatabase db;
|
||||
|
||||
private JdbcOperations jdbcOperations;
|
||||
|
||||
private JdbcOneTimeTokenService oneTimeTokenService;
|
||||
|
||||
private final JdbcOneTimeTokenService.OneTimeTokenParametersMapper oneTimeTokenParametersMapper = new JdbcOneTimeTokenService.OneTimeTokenParametersMapper();
|
||||
|
||||
@BeforeEach
|
||||
void setUp() {
|
||||
this.db = createDb();
|
||||
this.jdbcOperations = new JdbcTemplate(this.db);
|
||||
this.oneTimeTokenService = new JdbcOneTimeTokenService(this.jdbcOperations);
|
||||
}
|
||||
|
||||
@AfterEach
|
||||
public void tearDown() {
|
||||
this.db.shutdown();
|
||||
}
|
||||
|
||||
private static EmbeddedDatabase createDb() {
|
||||
// @formatter:off
|
||||
return new EmbeddedDatabaseBuilder()
|
||||
.generateUniqueName(true)
|
||||
.setType(EmbeddedDatabaseType.HSQL)
|
||||
.setScriptEncoding("UTF-8")
|
||||
.addScript(ONE_TIME_TOKEN_SQL_RESOURCE)
|
||||
.build();
|
||||
// @formatter:on
|
||||
}
|
||||
|
||||
@Test
|
||||
void constructorWhenJdbcOperationsIsNullThenThrowIllegalArgumentException() {
|
||||
// @formatter:off
|
||||
assertThatIllegalArgumentException()
|
||||
.isThrownBy(() -> new JdbcOneTimeTokenService(null))
|
||||
.withMessage("jdbcOperations cannot be null");
|
||||
// @formatter:on
|
||||
}
|
||||
|
||||
@Test
|
||||
void generateWhenGenerateOneTimeTokenRequestIsNullThenThrowIllegalArgumentException() {
|
||||
// @formatter:off
|
||||
assertThatIllegalArgumentException()
|
||||
.isThrownBy(() -> this.oneTimeTokenService.generate(null))
|
||||
.withMessage("generateOneTimeTokenRequest cannot be null");
|
||||
// @formatter:on
|
||||
}
|
||||
|
||||
@Test
|
||||
void consumeWhenAuthenticationTokenIsNullThenThrowIllegalArgumentException() {
|
||||
// @formatter:off
|
||||
assertThatIllegalArgumentException()
|
||||
.isThrownBy(() -> this.oneTimeTokenService.consume(null))
|
||||
.withMessage("authenticationToken cannot be null");
|
||||
// @formatter:on
|
||||
}
|
||||
|
||||
@Test
|
||||
void generateThenTokenValueShouldBeValidUuidAndProvidedUsernameIsUsed() {
|
||||
OneTimeToken oneTimeToken = this.oneTimeTokenService.generate(new GenerateOneTimeTokenRequest(USERNAME));
|
||||
|
||||
OneTimeToken persistedOneTimeToken = selectOneTimeToken(oneTimeToken.getTokenValue());
|
||||
assertThat(persistedOneTimeToken).isNotNull();
|
||||
assertThat(persistedOneTimeToken.getUsername()).isNotNull();
|
||||
assertThat(persistedOneTimeToken.getTokenValue()).isNotNull();
|
||||
assertThat(persistedOneTimeToken.getExpiresAt()).isNotNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
void consumeWhenTokenExistsThenReturnItself() {
|
||||
OneTimeToken oneTimeToken = this.oneTimeTokenService.generate(new GenerateOneTimeTokenRequest(USERNAME));
|
||||
OneTimeTokenAuthenticationToken authenticationToken = new OneTimeTokenAuthenticationToken(
|
||||
oneTimeToken.getTokenValue());
|
||||
|
||||
OneTimeToken consumedOneTimeToken = this.oneTimeTokenService.consume(authenticationToken);
|
||||
|
||||
assertThat(consumedOneTimeToken).isNotNull();
|
||||
assertThat(consumedOneTimeToken.getUsername()).isNotNull();
|
||||
assertThat(consumedOneTimeToken.getTokenValue()).isNotNull();
|
||||
assertThat(consumedOneTimeToken.getExpiresAt()).isNotNull();
|
||||
OneTimeToken persistedOneTimeToken = selectOneTimeToken(consumedOneTimeToken.getTokenValue());
|
||||
assertThat(persistedOneTimeToken).isNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
void consumeWhenTokenDoesNotExistsThenReturnNull() {
|
||||
OneTimeTokenAuthenticationToken authenticationToken = new OneTimeTokenAuthenticationToken(TOKEN_VALUE);
|
||||
|
||||
OneTimeToken consumedOneTimeToken = this.oneTimeTokenService.consume(authenticationToken);
|
||||
|
||||
assertThat(consumedOneTimeToken).isNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
void consumeWhenTokenIsExpiredThenReturnNull() {
|
||||
GenerateOneTimeTokenRequest request = new GenerateOneTimeTokenRequest(USERNAME);
|
||||
OneTimeToken generated = this.oneTimeTokenService.generate(request);
|
||||
OneTimeTokenAuthenticationToken authenticationToken = new OneTimeTokenAuthenticationToken(
|
||||
generated.getTokenValue());
|
||||
Clock tenMinutesFromNow = Clock.fixed(Instant.now().plus(10, ChronoUnit.MINUTES), ZoneOffset.UTC);
|
||||
this.oneTimeTokenService.setClock(tenMinutesFromNow);
|
||||
|
||||
OneTimeToken consumed = this.oneTimeTokenService.consume(authenticationToken);
|
||||
assertThat(consumed).isNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
void cleanupExpiredTokens() {
|
||||
OneTimeToken token1 = new DefaultOneTimeToken("123", USERNAME, Instant.now().minusSeconds(300));
|
||||
OneTimeToken token2 = new DefaultOneTimeToken("456", USERNAME, Instant.now().minusSeconds(300));
|
||||
saveToken(token1);
|
||||
saveToken(token2);
|
||||
|
||||
this.oneTimeTokenService.cleanUpExpiredTokens();
|
||||
|
||||
OneTimeToken deletedOneTimeToken1 = selectOneTimeToken("123");
|
||||
OneTimeToken deletedOneTimeToken2 = selectOneTimeToken("456");
|
||||
assertThat(deletedOneTimeToken1).isNull();
|
||||
assertThat(deletedOneTimeToken2).isNull();
|
||||
}
|
||||
|
||||
private void saveToken(OneTimeToken oneTimeToken) {
|
||||
List<SqlParameterValue> parameters = this.oneTimeTokenParametersMapper.apply(oneTimeToken);
|
||||
PreparedStatementSetter pss = new ArgumentPreparedStatementSetter(parameters.toArray());
|
||||
this.jdbcOperations.update("INSERT INTO one_time_tokens (token_value, username, expires_at) VALUES (?, ?, ?)",
|
||||
pss);
|
||||
}
|
||||
|
||||
private OneTimeToken selectOneTimeToken(String tokenValue) {
|
||||
// @formatter:off
|
||||
List<OneTimeToken> result = this.jdbcOperations.query(
|
||||
"select token_value, username, expires_at from one_time_tokens where token_value = ?",
|
||||
new JdbcOneTimeTokenService.OneTimeTokenRowMapper(), tokenValue);
|
||||
if (CollectionUtils.isEmpty(result)) {
|
||||
return null;
|
||||
}
|
||||
return result.get(0);
|
||||
// @formatter:on
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user