Skip to content
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

Jump to bottom

feat(jans-auth-server): add configurable option to put all tokens into cache service #7563 #7686

Merged
merged 2 commits into from
Feb 9, 2024
Merged

feat(jans-auth-server): add configurable option to put all tokens into cache service #7563 #7686

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a59e84f
feat(jans-auth-server): add configurable option to put all tokens int…
yuriyz Feb 9, 2024
7f90585
Merge branch 'main' into jans-auth-server-7563
yuriyz Feb 9, 2024
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
22 changes: 22 additions & 0 deletions jans-auth-server/model/src/main/java/io/jans/as/model/configuration/AppConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,6 +354,12 @@ public class AppConfiguration implements Configuration {
@DocProperty(description = "Boolean value specifying whether idToken filters claims based on accessToken")
private Boolean idTokenFilterClaimsBasedOnAccessToken;

@DocProperty(description = "Boolean value specifying whether to save access_token, id_token and refresh_token in cache (with cacheKey=sha256Hex(token_code))")
private Boolean saveTokensInCache;

@DocProperty(description = "Boolean value specifying whether to save access_token, id_token and refresh_token in cache and skip persistence in DB at the same time (with cacheKey=sha256Hex(token_code))")
private Boolean saveTokensInCacheAndDontSaveInPersistence;

@DocProperty(description = "The lifetime of the short lived Access Token")
private int accessTokenLifetime;

Expand Down Expand Up @@ -2294,6 +2300,22 @@ public void setAccessTokenLifetime(int accessTokenLifetime) {
this.accessTokenLifetime = accessTokenLifetime;
}

public Boolean getSaveTokensInCache() {
return saveTokensInCache;
}

public void setSaveTokensInCache(Boolean saveTokensInCache) {
this.saveTokensInCache = saveTokensInCache;
}

public Boolean getSaveTokensInCacheAndDontSaveInPersistence() {
return saveTokensInCacheAndDontSaveInPersistence;
}

public void setSaveTokensInCacheAndDontSaveInPersistence(Boolean saveTokensInCacheAndDontSaveInPersistence) {
this.saveTokensInCacheAndDontSaveInPersistence = saveTokensInCacheAndDontSaveInPersistence;
}

public int getUmaRptLifetime() {
return umaRptLifetime;
}
Expand Down
52 changes: 38 additions & 14 deletions jans-auth-server/server/src/main/java/io/jans/as/server/service/GrantService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,7 @@

package io.jans.as.server.service;

import static org.apache.commons.lang.BooleanUtils.isTrue;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.UUID;

import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;

import com.google.common.collect.Lists;

import io.jans.as.model.config.StaticConfiguration;
import io.jans.as.model.configuration.AppConfiguration;
import io.jans.as.model.configuration.LockMessageConfig;
Expand All @@ -35,6 +24,15 @@
import jakarta.ejb.Stateless;
import jakarta.inject.Inject;
import jakarta.inject.Named;
import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.UUID;

import static org.apache.commons.lang.BooleanUtils.isTrue;

/**
* @author Yuriy Zabrovarnyy
Expand Down Expand Up @@ -93,19 +91,42 @@ public void mergeSilently(TokenEntity token) {
}
}

public boolean shouldPersist() {
if (isTrue(appConfiguration.getSaveTokensInCacheAndDontSaveInPersistence())) {
return false;
}
return true;
}

public boolean shouldSaveInCache() {
return isTrue(appConfiguration.getSaveTokensInCache()) || isTrue(appConfiguration.getSaveTokensInCacheAndDontSaveInPersistence());
}

public void persist(TokenEntity token) {
persistenceEntryManager.persist(token);

if (shouldPersist()) {
persistenceEntryManager.persist(token);
}

if (shouldSaveInCache()) {
saveInCache(token);
}

if (TokenType.ID_TOKEN.getValue().equals(token.getTokenType())) {
publishIdTokenLockMessage(token, "add");
}
}

private void saveInCache(TokenEntity token) {
long lifeTimeAsMillis = token.getExpirationDate().getTime() - System.currentTimeMillis();
int lifetimeInSeconds = (int) (lifeTimeAsMillis / 1000);
cacheService.put(lifetimeInSeconds, TokenHashUtil.hash(token.getTokenCode()), token.getTokenCode());
}

public void remove(TokenEntity token) {
persistenceEntryManager.remove(token);
log.trace("Removed token from LDAP, code: {}", token.getTokenCode());

if (TokenType.ID_TOKEN.equals(token.getTokenType())) {
if (TokenType.ID_TOKEN == token.getTokenTypeEnum()) {
publishIdTokenLockMessage(token, "del");
}
}
Expand All @@ -129,6 +150,9 @@ public void removeSilently(TokenEntity token) {
if (StringUtils.isNotBlank(token.getAuthorizationCode())) {
cacheService.remove(CacheGrant.cacheKey(token.getAuthorizationCode(), token.getGrantId()));
}
if (shouldSaveInCache()) {
cacheService.remove(token.getTokenCode());
}
} catch (Exception e) {
log.error(e.getMessage(), e);
}
Expand Down
31 changes: 31 additions & 0 deletions jans-auth-server/server/src/test/java/io/jans/as/server/service/GrantServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,37 @@ public class GrantServiceTest {
@Mock
private CacheConfiguration cacheConfiguration;

@Test
public void shouldPersist_byDefault_shouldReturnTrue() {
assertTrue(grantService.shouldPersist());
}

@Test
public void shouldPersist_whenDontPersistConfIsTrue_shouldReturnFalse() {
Mockito.doReturn(true).when(appConfiguration).getSaveTokensInCacheAndDontSaveInPersistence();

assertFalse(grantService.shouldPersist());
}

@Test
public void shouldSaveInCache_byDefault_shoultReturnFalse() {
assertFalse(grantService.shouldSaveInCache());
}

@Test
public void shouldSaveInCache_whenAllowedByConfig_shoultReturnTrue() {
Mockito.doReturn(true).when(appConfiguration).getSaveTokensInCacheAndDontSaveInPersistence();

assertTrue(grantService.shouldSaveInCache());
}

@Test
public void shouldSaveInCache_whenAllowedByMainConfig_shoultReturnTrue() {
Mockito.doReturn(true).when(appConfiguration).getSaveTokensInCache();

assertTrue(grantService.shouldSaveInCache());
}

@Test
public void filterOutRefreshTokenFromDeletion_forTokenWithoutOnlineAccess_shouldFilterOut() {
Mockito.doReturn(false).when(appConfiguration).getRemoveRefreshTokensForClientOnLogout();
Expand Down