Skip to content

KEYCLOAK-19701 Load offline client session after evicted while user session is still in cache #8671

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

Closed
lexcao wants to merge 1 commit into from
Closed

KEYCLOAK-19701 Load offline client session after evicted while user session is still in cache #8671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 29 additions & 5 deletions .../src/main/java/org/keycloak/models/sessions/infinispan/InfinispanUserSessionProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,13 +377,37 @@ protected Stream<UserSessionModel> getUserSessionsStream(RealmModel realm, UserS

@Override
public AuthenticatedClientSessionAdapter getClientSession(UserSessionModel userSession, ClientModel client, String clientSessionId, boolean offline) {
return getClientSession(userSession, client, clientSessionId == null ? null : UUID.fromString(clientSessionId), offline);
if (clientSessionId == null) {
return null;
}

AuthenticatedClientSessionEntity clientSessionEntityFromCache = getClientSessionEntity(UUID.fromString(clientSessionId), offline);
if (clientSessionEntityFromCache != null) {
return wrap(userSession, client, clientSessionEntityFromCache, offline);
}

if (!offline) {
return null;
}

log.debugf("Offline client session is not found in cache, try to load from db, userSession [%s] clientSessionId [%s] clientId [%s]", userSession.getId(), clientSessionId, client.getClientId());
return getClientSessionEntityFromPersistenceProvider(userSession, client, offline);
}

@Override
public AuthenticatedClientSessionAdapter getClientSession(UserSessionModel userSession, ClientModel client, UUID clientSessionId, boolean offline) {
AuthenticatedClientSessionEntity entity = getClientSessionEntity(clientSessionId, offline);
return wrap(userSession, client, entity, offline);
private AuthenticatedClientSessionAdapter getClientSessionEntityFromPersistenceProvider(UserSessionModel userSession, ClientModel client, boolean offline) {
if (!(userSession instanceof UserSessionAdapter)) {
log.warnf("User session [%s] is not in cache, should load from db firstly. clientId [%s] offline [%s]", userSession.getId(), client.getClientId(), offline);
return null;
}

UserSessionPersisterProvider persister = session.getProvider(UserSessionPersisterProvider.class);
AuthenticatedClientSessionModel clientSession = persister.loadClientSessionWithClient(session.getContext().getRealm(), client, userSession, offline);

if (clientSession == null) {
return null;
}

return importClientSession((UserSessionAdapter) userSession, clientSession, getTransaction(offline), getClientSessionTransaction(offline), offline);
}

private AuthenticatedClientSessionEntity getClientSessionEntity(UUID id, boolean offline) {
Expand Down
24 changes: 22 additions & 2 deletions model/jpa/src/main/java/org/keycloak/models/jpa/session/JpaUserSessionPersisterProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,22 @@ public UserSessionModel loadUserSession(RealmModel realm, String userSessionId,
}).orElse(null);
}

@Override
public AuthenticatedClientSessionModel loadClientSessionWithClient(RealmModel realm, ClientModel client, UserSessionModel userSession, boolean offline) {
String offlineStr = offlineToString(offline);

TypedQuery<PersistentClientSessionEntity> clientSessionQuery = em.createNamedQuery("findClientSessionsByUserSessionWithClient", PersistentClientSessionEntity.class);
clientSessionQuery.setParameter("userSessionId", userSession.getId());
clientSessionQuery.setParameter("offline", offlineStr);
clientSessionQuery.setParameter("clientId", client.getId());
clientSessionQuery.setMaxResults(1);

return closing(clientSessionQuery.getResultStream())
.map(entity -> toAdapter(realm, client, userSession, entity))
.findFirst()
.orElse(null);
}

@Override
public Stream<UserSessionModel> loadUserSessionsStream(RealmModel realm, ClientModel client, boolean offline, Integer firstResult, Integer maxResults) {

Expand Down Expand Up @@ -438,10 +454,14 @@ private PersistentAuthenticatedClientSessionAdapter toAdapter(RealmModel realm,
}
ClientModel client = realm.getClientById(clientId);

return toAdapter(realm, client, userSession, entity);
}

private PersistentAuthenticatedClientSessionAdapter toAdapter(RealmModel realm, ClientModel client, UserSessionModel userSession, PersistentClientSessionEntity entity) {
PersistentClientSessionModel model = new PersistentClientSessionModel();
model.setClientId(clientId);
model.setClientId(client.getId());
model.setUserSessionId(userSession.getId());
model.setUserId(userSession.getUserId());
model.setUserId(userSession.getUser().getId());
model.setTimestamp(entity.getTimestamp());
model.setData(entity.getData());
return new PersistentAuthenticatedClientSessionAdapter(session, model, realm, client, userSession);
Expand Down
1 change: 1 addition & 0 deletions model/jpa/src/main/java/org/keycloak/models/jpa/session/PersistentClientSessionEntity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
// It is removed from here and added manually in JpaUtils to give a native implementation if needed
//@NamedQuery(name="deleteExpiredClientSessions", query="delete from PersistentClientSessionEntity sess where sess.userSessionId IN (select u.userSessionId from PersistentUserSessionEntity u where u.realmId = :realmId AND u.offline = :offline AND u.lastSessionRefresh < :lastSessionRefresh)"),
@NamedQuery(name="findClientSessionsByUserSession", query="select sess from PersistentClientSessionEntity sess where sess.userSessionId=:userSessionId and sess.offline = :offline"),
@NamedQuery(name="findClientSessionsByUserSessionWithClient", query="select sess from PersistentClientSessionEntity sess where sess.userSessionId=:userSessionId and sess.offline = :offline and sess.clientId=:clientId"),
@NamedQuery(name="findClientSessionsOrderedById", query="select sess from PersistentClientSessionEntity sess where sess.offline = :offline and sess.userSessionId >= :fromSessionId and sess.userSessionId <= :toSessionId order by sess.userSessionId"),
@NamedQuery(name="findClientSessionsCountByClient", query="select count(sess) from PersistentClientSessionEntity sess where sess.offline = :offline and sess.clientId = :clientId")
})
Expand Down
6 changes: 6 additions & 0 deletions ...ivate/src/main/java/org/keycloak/models/session/DisabledUserSessionPersisterProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,16 @@ public void removeExpired(RealmModel realm) {

}

@Override
public UserSessionModel loadUserSession(RealmModel realm, String userSessionId, boolean offline) {
return null;
}

@Override
public AuthenticatedClientSessionModel loadClientSessionWithClient(RealmModel realm, ClientModel client, UserSessionModel userSession, boolean offline) {
return null;
}

@Override
public Stream<UserSessionModel> loadUserSessionsStream(RealmModel realm, ClientModel client, boolean offline, Integer firstResult, Integer maxResults) {
return Stream.empty();
Expand Down
10 changes: 10 additions & 0 deletions ...r-spi-private/src/main/java/org/keycloak/models/session/UserSessionPersisterProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,16 @@ public interface UserSessionPersisterProvider extends Provider {
*/
UserSessionModel loadUserSession(RealmModel realm, String userSessionId, boolean offline);

/**
* Loads the user client session with the given @{@link UserSessionModel} and @{@link ClientModel}.
* @param realm
* @param client
* @param userSession
* @param offline
* @return
*/
AuthenticatedClientSessionModel loadClientSessionWithClient(RealmModel realm, ClientModel client, UserSessionModel userSession, boolean offline);

/**
* Loads the user sessions for the given {@link UserModel} in the given {@link RealmModel} if present.
* @param realm
Expand Down