125 lines
4.2 KiB
Java
125 lines
4.2 KiB
Java
/*
|
|
* Copyright 2020 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.oauth2.server.authorization.config;
|
|
|
|
import org.springframework.util.Assert;
|
|
|
|
import java.time.Duration;
|
|
import java.util.HashMap;
|
|
import java.util.Map;
|
|
|
|
/**
|
|
* A facility for token configuration settings.
|
|
*
|
|
* @author Joe Grandja
|
|
* @since 0.0.2
|
|
* @see Settings
|
|
*/
|
|
public class TokenSettings extends Settings {
|
|
private static final String TOKEN_SETTING_BASE = "setting.token.";
|
|
public static final String ACCESS_TOKEN_TIME_TO_LIVE = TOKEN_SETTING_BASE.concat("access-token-time-to-live");
|
|
public static final String REUSE_REFRESH_TOKENS = TOKEN_SETTING_BASE.concat("reuse-refresh-tokens");
|
|
public static final String REFRESH_TOKEN_TIME_TO_LIVE = TOKEN_SETTING_BASE.concat("refresh-token-time-to-live");
|
|
|
|
/**
|
|
* Constructs a {@code TokenSettings}.
|
|
*/
|
|
public TokenSettings() {
|
|
this(defaultSettings());
|
|
}
|
|
|
|
/**
|
|
* Constructs a {@code TokenSettings} using the provided parameters.
|
|
*
|
|
* @param settings the initial settings
|
|
*/
|
|
public TokenSettings(Map<String, Object> settings) {
|
|
super(settings);
|
|
}
|
|
|
|
/**
|
|
* Returns the time-to-live for an access token. The default is 5 minutes.
|
|
*
|
|
* @return the time-to-live for an access token
|
|
*/
|
|
public Duration accessTokenTimeToLive() {
|
|
return setting(ACCESS_TOKEN_TIME_TO_LIVE);
|
|
}
|
|
|
|
/**
|
|
* Set the time-to-live for an access token. Must be greater than {@code Duration.ZERO}.
|
|
*
|
|
* @param accessTokenTimeToLive the time-to-live for an access token
|
|
* @return the {@link TokenSettings}
|
|
*/
|
|
public TokenSettings accessTokenTimeToLive(Duration accessTokenTimeToLive) {
|
|
Assert.notNull(accessTokenTimeToLive, "accessTokenTimeToLive cannot be null");
|
|
Assert.isTrue(accessTokenTimeToLive.getSeconds() > 0, "accessTokenTimeToLive must be greater than Duration.ZERO");
|
|
setting(ACCESS_TOKEN_TIME_TO_LIVE, accessTokenTimeToLive);
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Returns {@code true} if refresh tokens are reused when returning the access token response,
|
|
* or {@code false} if a new refresh token is issued. The default is {@code true}.
|
|
*/
|
|
public boolean reuseRefreshTokens() {
|
|
return setting(REUSE_REFRESH_TOKENS);
|
|
}
|
|
|
|
/**
|
|
* Set to {@code true} if refresh tokens are reused when returning the access token response,
|
|
* or {@code false} if a new refresh token is issued.
|
|
*
|
|
* @param reuseRefreshTokens {@code true} to reuse refresh tokens, {@code false} to issue new refresh tokens
|
|
* @return the {@link TokenSettings}
|
|
*/
|
|
public TokenSettings reuseRefreshTokens(boolean reuseRefreshTokens) {
|
|
setting(REUSE_REFRESH_TOKENS, reuseRefreshTokens);
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Returns the time-to-live for a refresh token. The default is 60 minutes.
|
|
*
|
|
* @return the time-to-live for a refresh token
|
|
*/
|
|
public Duration refreshTokenTimeToLive() {
|
|
return setting(REFRESH_TOKEN_TIME_TO_LIVE);
|
|
}
|
|
|
|
/**
|
|
* Set the time-to-live for a refresh token. Must be greater than {@code Duration.ZERO}.
|
|
*
|
|
* @param refreshTokenTimeToLive the time-to-live for a refresh token
|
|
* @return the {@link TokenSettings}
|
|
*/
|
|
public TokenSettings refreshTokenTimeToLive(Duration refreshTokenTimeToLive) {
|
|
Assert.notNull(refreshTokenTimeToLive, "refreshTokenTimeToLive cannot be null");
|
|
Assert.isTrue(refreshTokenTimeToLive.getSeconds() > 0, "refreshTokenTimeToLive must be greater than Duration.ZERO");
|
|
setting(REFRESH_TOKEN_TIME_TO_LIVE, refreshTokenTimeToLive);
|
|
return this;
|
|
}
|
|
|
|
protected static Map<String, Object> defaultSettings() {
|
|
Map<String, Object> settings = new HashMap<>();
|
|
settings.put(ACCESS_TOKEN_TIME_TO_LIVE, Duration.ofMinutes(5));
|
|
settings.put(REUSE_REFRESH_TOKENS, true);
|
|
settings.put(REFRESH_TOKEN_TIME_TO_LIVE, Duration.ofMinutes(60));
|
|
return settings;
|
|
}
|
|
}
|