org.yamcs.security.SessionManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-core Show documentation
There is a newer version: 5.10.7
package org.yamcs.security;

import static java.util.concurrent.TimeUnit.SECONDS;

import java.security.SecureRandom;
import java.util.Base64;
import java.util.Collection;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.CopyOnWriteArraySet;
import java.util.stream.Collectors;

import org.yamcs.YamcsServer;
import org.yamcs.logging.Log;

/**
 * Implementation-agnostic session store. Sessions have a limited lifespan, but can be renewed before expiring.
 * 
 * In a future iteration, UserSession could be split into UserSession and ClientSession for covering implementations
 * that support SSO across multiple clients (e.g. OIDC).
 */
public class SessionManager {

    protected static final Log log = new Log(SessionManager.class);
    private static final SecureRandom RG = new SecureRandom();

    /**
     * Time before a session is considered to be expired.
     * 
     * In terms of OAuth this corresponds to the lifetime of a refresh token.
     */
    private static final long SESSION_IDLE = 30 * 60 * 1000L; // 30 minutes

    private ConcurrentMap sessions = new ConcurrentHashMap<>();
    private CopyOnWriteArraySet sessionListeners = new CopyOnWriteArraySet<>();

    public SessionManager() {
        YamcsServer yamcs = YamcsServer.getServer();
        yamcs.getThreadPoolExecutor().scheduleWithFixedDelay(this::purgeExpiredSessions, 10, 10, SECONDS);
    }

    public UserSession createSession(AuthenticationInfo authenticationInfo, String ipAddress, String hostname) {
        String sessionId = generateSessionId();
        UserSession session = new UserSession(sessionId, authenticationInfo, ipAddress, hostname, SESSION_IDLE);
        sessions.put(sessionId, session);
        sessionListeners.forEach(l -> l.onCreated(session));
        return session;
    }

    public UserSession getSession(String id) {
        return sessions.get(id);
    }

    public Collection getSessions() {
        return sessions.values();
    }

    public void renewSession(String id) throws SessionExpiredException {
        UserSession session = sessions.get(id);
        if (session == null) {
            throw new SessionExpiredException();
        }
        session.touch();
    }

    public void invalidateSession(String id) {
        var session = sessions.get(id);
        if (session != null) {
            log.info("Session invalidated: {}", session);
            sessions.remove(session.getId());
            sessionListeners.forEach(l -> l.onInvalidated(session));
        }
    }

    public void addSessionListener(SessionListener listener) {
        sessionListeners.add(listener);
    }

    public void removeSessionListener(SessionListener listener) {
        sessionListeners.remove(listener);
    }

    private String generateSessionId() {
        // Generate something that is url-safe
        byte[] bytes = new byte[10];
        RG.nextBytes(bytes);
        return Base64.getUrlEncoder().withoutPadding().encodeToString(bytes);
    }

    private void purgeExpiredSessions() {
        Set toExpire = sessions.values().stream()
                .filter(session -> session.isExpired())
                .collect(Collectors.toSet());
        for (UserSession expiredSession : toExpire) {
            log.info("Session expired: {}", expiredSession);
            sessions.remove(expiredSession.getId());
            sessionListeners.forEach(l -> l.onExpired(expiredSession));
        }
    }
}