OsUserAccount.java
/*
** Module : OsUserAccount.java
** Abstract : Represents an OS user account
**
** Copyright (c) 2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- ----------------Description----------------------
** 001 GBB 20230807 Created initial version.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
** Under Section 7 of the GNU Affero GPL version 3, the following additional
** terms apply to the works covered under the License. These additional terms
** are non-permissive additional terms allowed under Section 7 of the GNU
** Affero GPL version 3 and may not be removed by you.
**
** 0. Attribution Requirement.
**
** You must preserve all legal notices or author attributions in the covered
** work or Appropriate Legal Notices displayed by works containing the covered
** work. You may not remove from the covered work any author or developer
** credit already included within the covered work.
**
** 1. No License To Use Trademarks.
**
** This license does not grant any license or rights to use the trademarks
** Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
** of Golden Code Development Corporation. You are not authorized to use the
** name Golden Code, FWD, or the names of any author or contributor, for
** publicity purposes without written authorization.
**
** 2. No Misrepresentation of Affiliation.
**
** You may not represent yourself as Golden Code Development Corporation or FWD.
**
** You may not represent yourself for publicity purposes as associated with
** Golden Code Development Corporation, FWD, or any author or contributor to
** the covered work, without written authorization.
**
** 3. No Misrepresentation of Source or Origin.
**
** You may not represent the covered work as solely your work. All modified
** versions of the covered work must be marked in a reasonable way to make it
** clear that the modified work is not originating from Golden Code Development
** Corporation or FWD. All modified versions must contain the notices of
** attribution required in this license.
*/
package com.goldencode.p2j.security;
import com.goldencode.p2j.directory.*;
/**
* Represents a specific OS user account.
*/
class OsUserAccount
implements SecurityConstants
{
/** The subject ID this account represents. */
private String subjectId;
/** Description of the OS user. */
private String description;
/** Enabled status of this account. */
private boolean enabled = true;
/** Protected status of the password. */
private boolean protect = true;
/** Hashed password for this account. */
private byte[] password;
/** Date password was last changed. */
private DateValue date;
/** Time password was last changed. */
private TimeValue time;
/**
* Constructor.
*
* @param subjectId
* Subject ID also known as account name.
* @param description
* Description of the OS user.
* @param enabled
* <code>true</code> if this account is enabled
* @param password
* Hashed password data, may be <code>null</code>.
* @param date
* The date the password was last changed.
* @param time
* The time the password was last changed.
*/
OsUserAccount(String subjectId,
String description,
boolean enabled,
byte[] password,
DateValue date,
TimeValue time)
{
this.subjectId = subjectId;
this.description = description;
this.enabled = enabled;
this.password = password;
this.date = date;
this.time = time;
}
/**
* Gets the enabled status of this account.
* Only the user and process accounts can be disabled. Disabled accounts
* can't be authenticated successfully.
*
* @return <code>true</code> if the account is enabled
*/
boolean isEnabled()
{
return enabled;
}
/**
* Changes the enabled status of this account.
*
* @param enabled
* <code>true</code> if the account is enabled
*/
void setEnabled(boolean enabled)
{
this.enabled = enabled;
}
/**
* Gets the protected status of the password.
*
* @return <code>true</code> if the password is protected
*/
public boolean isProtected()
{
return protect;
}
/**
* Gets the subject ID for this account.
*
* @return The subject ID.
*/
String getSubjectId()
{
return subjectId;
}
/**
* Gets the description of the OS user.
*
* @return The description.
*/
String getDescription()
{
return description;
}
/**
* Gets the hashed password for this acoount.
*
* @return Hashed password data.
*/
byte[] getPassword()
{
return password;
}
/**
* Sets a new hashed password for this acoount.
*
* @param password
* The hashed password data.
* @param date
* The date the password was last changed.
* @param time
* The time the password was last changed.
*/
void setPassword(byte[] password, DateValue date, TimeValue time)
{
this.password = password;
this.date = date;
this.time = time;
}
/**
* Gets the last password change date.
*
* @return Last password change date.
*/
DateValue getPasswordDate()
{
return date;
}
/**
* Gets the last password change time.
*
* @return Last password change time.
*/
TimeValue getPasswordTime()
{
return time;
}
}