LocalSessionStateBean.java

/*
 * Password Management Servlets (PWM)
 * http://www.pwm-project.org
 *
 * Copyright (c) 2006-2009 Novell, Inc.
 * Copyright (c) 2009-2017 The PWM Project
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package password.pwm.bean;

import password.pwm.util.secure.PwmRandom;

import java.io.Serializable;
import java.time.Instant;
import java.util.Locale;

/**
 * Only information that is particular to the http session is stored in the
 * session bean.  Information more topical to the user is stored in {@link UserInfoBean}.
 * <p/>
 * For any given HTTP session using PWM, one and only one {@link LocalSessionStateBean} will be
 * created.
 *
 * @author Jason D. Rivard
 */
public class LocalSessionStateBean implements Serializable {
// ------------------------------ FIELDS ------------------------------

    private String srcAddress;
    private String srcHostname;
    private String forwardURL;
    private String logoutURL;
    private Locale locale;
    private String sessionID;
    private String theme;
    private String lastRequestURL;

    private String sessionVerificationKey = "key";
    private String restClientKey;

    private boolean debugInitialized;
    private boolean sessionVerified;

    private Instant pageLeaveNoticeTime;
    private Instant sessionCreationTime;
    private Instant sessionLastAccessedTime;

    private boolean passwordModified;
    private boolean privateUrlAccessed;

    private int intruderAttempts;
    private boolean oauthInProgress;

    // settings
    private int sessionVerificationKeyLength;
    private boolean sessionIdRecycleNeeded;



// --------------------- GETTER / SETTER METHODS ---------------------

    public LocalSessionStateBean(final int sessionVerificationKeyLength) {
        this.sessionVerificationKeyLength = sessionVerificationKeyLength;
    }

    public boolean isPasswordModified() {
        return passwordModified;
    }

    public void setPasswordModified(final boolean passwordModified) {
        this.passwordModified = passwordModified;
    }

    public boolean isPrivateUrlAccessed() {
        return this.privateUrlAccessed;
    }

    public void setPrivateUrlAccessed(final boolean privateUrlAccessed) {
        this.privateUrlAccessed = privateUrlAccessed;
    }

    public String getForwardURL() {
        return forwardURL;
    }

    public void setForwardURL(final String forwardURL) {
        this.forwardURL = forwardURL;
    }

    public Locale getLocale() {
        return locale;
    }

    public void setLocale(final Locale locale) {
        this.locale = locale;
    }

    public String getLogoutURL() {
        return logoutURL;
    }

    public void setLogoutURL(final String logoutURL) {
        this.logoutURL = logoutURL;
    }

    public String getSessionID() {
        return sessionID;
    }

    public void setSessionID(final String sessionID) {
        this.sessionID = sessionID;
    }

    public String getSrcAddress() {
        return srcAddress;
    }

    public void setSrcAddress(final String srcAddress) {
        this.srcAddress = srcAddress;
    }

    public String getSrcHostname() {
        return srcHostname;
    }

    public void setSrcHostname(final String srcHostname) {
        this.srcHostname = srcHostname;
    }

    public String getSessionVerificationKey() {
        return sessionVerificationKey;
    }

    public boolean isSessionVerified() {
        return sessionVerified;
    }

    public void setSessionVerified(final boolean sessionVerified) {
        this.sessionVerified = sessionVerified;
    }

    public boolean isDebugInitialized() {
        return debugInitialized;
    }

    public void setDebugInitialized(final boolean debugInitialized) {
        this.debugInitialized = debugInitialized;
    }

    public String getTheme() {
        return theme;
    }

    public void setTheme(final String theme) {
        this.theme = theme;
    }

    public Instant getPageLeaveNoticeTime() {
        return pageLeaveNoticeTime;
    }

    public void setPageLeaveNoticeTime(final Instant pageLeaveNoticeTime) {
        this.pageLeaveNoticeTime = pageLeaveNoticeTime;
    }

    public Instant getSessionCreationTime() {
        return sessionCreationTime;
    }

    public void setSessionCreationTime(final Instant sessionCreationTime) {
        this.sessionCreationTime = sessionCreationTime;
    }

    public Instant getSessionLastAccessedTime() {
        return sessionLastAccessedTime;
    }

    public void setSessionLastAccessedTime(final Instant sessionLastAccessedTime) {
        this.sessionLastAccessedTime = sessionLastAccessedTime;
    }

    public String getLastRequestURL() {
        return lastRequestURL;
    }

    public void setLastRequestURL(final String lastRequestURL) {
        this.lastRequestURL = lastRequestURL;
    }

    public int getIntruderAttempts() {
        return intruderAttempts;
    }

    public void incrementIntruderAttempts() {
        intruderAttempts++;
    }

    public void clearIntruderAttempts() {
        intruderAttempts = 0;
    }

    public boolean isOauthInProgress()
    {
        return oauthInProgress;
    }

    public void setOauthInProgress(final boolean oauthInProgress)
    {
        this.oauthInProgress = oauthInProgress;
    }

    public String getRestClientKey() {
        return restClientKey;
    }

    public void setRestClientKey(final String restClientKey) {
        this.restClientKey = restClientKey;
    }

    public void regenerateSessionVerificationKey() {
        sessionVerificationKey = PwmRandom.getInstance().alphaNumericString(sessionVerificationKeyLength) + Long.toHexString(System.currentTimeMillis());
    }

    public boolean isSessionIdRecycleNeeded() {
        return sessionIdRecycleNeeded;
    }

    public void setSessionIdRecycleNeeded(final boolean sessionIdRecycleNeeded) {
        this.sessionIdRecycleNeeded = sessionIdRecycleNeeded;
    }
}