org.lockss.account.BasicUserAccount Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lockss-core Show documentation
The Slimmed Down LOCKSS Daemon Core
The newest version!
/*
 * $Id$
 */

/*

Copyright (c) 2000-2012 Board of Trustees of Leland Stanford Jr. University,
all rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
STANFORD UNIVERSITY BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of Stanford University shall not
be used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from Stanford University.

*/

package org.lockss.account;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import org.lockss.config.*;
import org.lockss.state.StateManager;

/** User account data with parameters for standard rules set from config
 */
public class BasicUserAccount extends UserAccount {

  static final String PREFIX = AccountManager.PREFIX;

  /** Default password hash algorithm */
  static final String PARAM_HASH_ALGORITHM = PREFIX + "hashAlgorithm";
  static final String DEFAULT_HASH_ALGORITHM = "SHA-256";

  /** Mininum password length */
  static final String PARAM_MIN_PASSWORD_LENGTH = PREFIX + "minPasswordLength";
  static final int DEFAULT_MIN_PASSWORD_LENGTH = 6;

  /** Users may not change their own password more often than this */
  static final String PARAM_MIN_PASSWORD_CHANGE_INTERVAL =
    PREFIX + "minPasswordChangeInterval";
  static final long DEFAULT_MIN_PASSWORD_CHANGE_INTERVAL = -1;

  /** Users must change  their password at least this often */
  static final String PARAM_MAX_PASSWORD_CHANGE_INTERVAL =
    PREFIX + "maxPasswordChangeInterval";
  static final long DEFAULT_MAX_PASSWORD_CHANGE_INTERVAL = -1;

  /** Users are reminded to change their password this long before it
   * expires */
  static final String PARAM_PASSWORD_CHANGE_REMINDER_INTERVAL =
    PREFIX + "passwordChangeReminderInterval";
  static final long DEFAULT_PASSWORD_CHANGE_REMINDER_INTERVAL = -1;

  /** Users are logged out after this much inactivity */
  static final String PARAM_INACTIVITY_LOGOUT = PREFIX + "inactivityLogout";
  static final long DEFAULT_INACTIVITY_LOGOUT = -1;

  /** May not reuse this many previous passwords */
  static final String PARAM_PASSWORD_HISTORY_SIZE =
    PREFIX + "passwordHistorySize";
  static final int DEFAULT_PASSWORD_HISTORY_SIZE = -1;

  /** Number of consecutive failed password attempts after which the
   * account is disabled */
  static final String PARAM_MAX_FAILED_ATTEMPTS = PREFIX + "maxFailedAttempts";
  static final int DEFAULT_MAX_FAILED_ATTEMPTS = -1;

  /** Interval within which consecutive failed attempts are counted. */
  static final String PARAM_FAILED_ATTEMPT_WINDOW =
    PREFIX + "failedAttemptWindow";
  static final long DEFAULT_FAILED_ATTEMPT_WINDOW = -1;

  /** Time after last failed attempt that disabled account is reenabled */
  static final String PARAM_FAILED_ATTEMPT_RESET_INTERVAL =
    PREFIX + "failedAttemptResetInterval";
  static final long DEFAULT_FAILED_ATTEMPT_RESET_INTERVAL = -1;

  @JsonCreator
  public BasicUserAccount(@JsonProperty("userName")  String name) {
    super(name);
  }

  protected void commonInit(AccountManager acctMgr, Configuration config) {
    super.commonInit(acctMgr, config);
  }

  public String getType() {
    return USER_ACCOUNT_TYPE;
  }

  public static final String USER_ACCOUNT_TYPE = "Basic";

  protected Configuration getConfig() {
    return CurrentConfig.getCurrentConfig();
  }

  protected int getMinPasswordLength() {
    return getConfig().getInt(PARAM_MIN_PASSWORD_LENGTH,
			      DEFAULT_MIN_PASSWORD_LENGTH);
  }

  protected int getHistorySize() {
    return getConfig().getInt(PARAM_PASSWORD_HISTORY_SIZE,
			      DEFAULT_PASSWORD_HISTORY_SIZE);
  }

  protected long getMinPasswordChangeInterval() {
    return getConfig().getTimeInterval(PARAM_MIN_PASSWORD_CHANGE_INTERVAL,
				       DEFAULT_MIN_PASSWORD_CHANGE_INTERVAL);
  }

  protected long getMaxPasswordChangeInterval() {
    return getConfig().getTimeInterval(PARAM_MAX_PASSWORD_CHANGE_INTERVAL,
				       DEFAULT_MAX_PASSWORD_CHANGE_INTERVAL);
  }

  protected long getPasswordChangeReminderInterval() {
    return getConfig().getTimeInterval(PARAM_PASSWORD_CHANGE_REMINDER_INTERVAL,
				       DEFAULT_PASSWORD_CHANGE_REMINDER_INTERVAL);
  }

  public long getInactivityLogout() {
    return getConfig().getTimeInterval(PARAM_INACTIVITY_LOGOUT,
				       DEFAULT_INACTIVITY_LOGOUT);
  }

  protected int getMaxFailedAttempts() {
    return getConfig().getInt(PARAM_MAX_FAILED_ATTEMPTS,
			      DEFAULT_MAX_FAILED_ATTEMPTS);
  }

  protected long getFailedAttemptWindow() {
    return getConfig().getTimeInterval(PARAM_FAILED_ATTEMPT_WINDOW,
				       DEFAULT_FAILED_ATTEMPT_WINDOW);
  }

  protected long getFailedAttemptResetInterval() {
    return getConfig().getTimeInterval(PARAM_FAILED_ATTEMPT_RESET_INTERVAL,
				       DEFAULT_FAILED_ATTEMPT_RESET_INTERVAL);
  }

  protected String getDefaultHashAlgorithm() {
    return getConfig().get(PARAM_HASH_ALGORITHM, DEFAULT_HASH_ALGORITHM);
  }


  public static class Factory extends UserAccount.Factory {
    public UserAccount newUser(String name, AccountManager acctMgr,
                               Configuration config) {
      if (config == null) {
	throw new NullPointerException();
      }
      BasicUserAccount acct = new BasicUserAccount(name);
      acct.init(acctMgr, config);
      return acct;
    }
  }
}