org.filesys.server.auth.ClientInfo Maven / Gradle / Ivy
Show all versions of jfileserver Show documentation
/*
* Copyright (C) 2006-2010 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see The client information class holds the details of a remote user from a session setup or
* tree connect request.
*
* @author gkspencer
*/
public class ClientInfo {
// Logon types
public enum LogonType {
Normal,
Guest,
Null,
Administrator,
Unknown
};
// Client information object factory
private static ClientInfoFactory m_factory = new DefaultClientInfoFactory();
// User name and password
private String m_user;
private byte[] m_password;
// ANSI encrypted password
private byte[] m_ansiPwd;
// Logon type
private LogonType m_logonType = LogonType.Unknown;
// User's domain
private String m_domain;
// Operating system type
private String m_opsys;
// Remote network address
private String m_ipAddr;
// PID of the logon process for multi-stage logons
private int m_pid = -1;
// Group and user id
private int m_gid = -1;
private int m_uid = -1;
// List of groups for this user
private int[] m_groups;
// NFS authentication type
private AuthType m_nfsAuthType = AuthType.Invalid;
// Logged on name, may be a principal name
private String m_loggedOnName;
/**
* Class constructor
*
* @param user User name
* @param pwd Password
*/
protected ClientInfo(String user, byte[] pwd) {
setUserName(user);
setPassword(pwd);
}
/**
* Get the remote users domain.
*
* @return String
*/
public final String getDomain() {
return m_domain;
}
/**
* Get the remote operating system
*
* @return String
*/
public final String getOperatingSystem() {
return m_opsys;
}
/**
* Get the password.
*
* @return String.
*/
public final byte[] getPassword() {
return m_password;
}
/**
* Return the password as a string
*
* @return String
*/
public final String getPasswordAsString() {
if (m_password != null)
return new String(m_password);
return null;
}
/**
* Determine if the client has specified an ANSI password
*
* @return boolean
*/
public final boolean hasANSIPassword() {
return m_ansiPwd != null ? true : false;
}
/**
* Return the ANSI encrypted password
*
* @return byte[]
*/
public final byte[] getANSIPassword() {
return m_ansiPwd;
}
/**
* Return the ANSI password as a string
*
* @return String
*/
public final String getANSIPasswordAsString() {
if (m_ansiPwd != null)
return new String(m_ansiPwd);
return null;
}
/**
* Check if there is a valid user name
*
* @return boolean
*/
public final boolean hasUserName() {
return m_user != null && m_user.isEmpty() == false;
}
/**
* Get the user name.
*
* @return String
*/
public final String getUserName() {
return m_user;
}
/**
* Return the logon type
*
* @return LogonType
*/
public final LogonType getLogonType() {
return m_logonType;
}
/**
* Return the logon type as a string
*
* @return String
*/
public final String getLogonTypeString() {
return m_logonType.name();
}
/**
* Determine if the user is logged on as a guest
*
* @return boolean
*/
public final boolean isGuest() {
return m_logonType == LogonType.Guest ? true : false;
}
/**
* Determine if the session is a null session
*
* @return boolean
*/
public final boolean isNullSession() {
return m_logonType == LogonType.Null ? true : false;
}
/**
* Determine if the user if logged on as an administrator
*
* @return boolean
*/
public final boolean isAdministrator() {
return m_logonType == LogonType.Administrator ? true : false;
}
/**
* Determine if the client is an authenticated user logon
*
* @return boolean
*/
public final boolean isAuthenticatedLogon() {
return m_logonType == LogonType.Normal || m_logonType == LogonType.Administrator;
}
/**
* Determine if the client network address has been set
*
* @return boolean
*/
public final boolean hasClientAddress() {
return m_ipAddr != null ? true : false;
}
/**
* Return the client network address
*
* @return String
*/
public final String getClientAddress() {
return m_ipAddr;
}
/**
* Get the group id
*
* @return int
*/
public final int getGid() {
return m_gid;
}
/**
* Return the user id
*
* @return int
*/
public final int getUid() {
return m_uid;
}
/**
* Determine if the client has additional groups
*
* @return boolean
*/
public final boolean hasGroupsList() {
return m_groups != null ? true : false;
}
/**
* Return the additional groups list
*
* @return int[]
*/
public final int[] getGroupsList() {
return m_groups;
}
/**
* Return the NFS authentication type
*
* @return AuthType
*/
public final AuthType getNFSAuthenticationType() {
return m_nfsAuthType;
}
/**
* Return the process id
*
* @return int
*/
public final int getProcessId() {
return m_pid;
}
/**
* Check if the client has a logged on name
*
* @return boolean
*/
public final boolean hasLoggedOnName() {
return m_loggedOnName != null;
}
/**
* Get the logged on user name
*
* @return String
*/
public final String getLoggedOnName() {
return m_loggedOnName;
}
/**
* Set the process id
*
* @param pid int
*/
public final void setProcessId(int pid) {
m_pid = pid;
}
/**
* Set the remote users domain
*
* @param domain Remote users domain
*/
public final void setDomain(String domain) {
m_domain = domain;
}
/**
* Set the remote users operating system type.
*
* @param opsys Remote operating system
*/
public final void setOperatingSystem(String opsys) {
m_opsys = opsys;
}
/**
* Set the password.
*
* @param pwd byte[]
*/
public final void setPassword(byte[] pwd) {
m_password = pwd;
}
/**
* Set the ANSI encrypted password
*
* @param pwd byte[]
*/
public final void setANSIPassword(byte[] pwd) {
m_ansiPwd = pwd;
}
/**
* Set the password
*
* @param pwd Password string.
*/
public final void setPassword(String pwd) {
if (pwd != null)
m_password = pwd.getBytes();
else
m_password = null;
}
/**
* Set the user name
*
* @param user User name string.
*/
public final void setUserName(String user) {
m_user = user;
}
/**
* Set the logon type
*
* @param logonType LogonType
*/
public final void setLogonType(LogonType logonType) {
m_logonType = logonType;
}
/**
* Set the guest logon flag
*
* @param guest boolean
*/
public final void setGuest(boolean guest) {
if (guest == true)
setLogonType(LogonType.Guest);
else if (getLogonType() == LogonType.Unknown)
setLogonType(LogonType.Normal);
}
/**
* Set the client network address
*
* @param addr String
*/
public final void setClientAddress(String addr) {
m_ipAddr = addr;
}
/**
* Set the group id
*
* @param gid int
*/
public final void setGid(int gid) {
m_gid = gid;
}
/**
* Set the user id
*
* @param uid int
*/
public final void setUid(int uid) {
m_uid = uid;
}
/**
* Set the groups list
*
* @param groups int[]
*/
public final void setGroupsList(int[] groups) {
m_groups = groups;
}
/**
* Set the NFS authentication type
*
* @param type AuthType
*/
public final void setNFSAuthenticationType(AuthType type) {
m_nfsAuthType = type;
}
/**
* Set the logged on user name
*
* @param fullName String
*/
public final void setLoggedOnName(String fullName) {
m_loggedOnName = fullName;
}
/**
* Display the client information as a string
*
* @return String
*/
public String toString() {
StringBuffer str = new StringBuffer();
str.append("[Client user=");
str.append(getUserName());
if ( getDomain() != null) {
str.append(",domain=");
str.append(getDomain());
}
if ( getOperatingSystem() != null) {
str.append(",os=");
str.append(getOperatingSystem());
}
if (hasClientAddress()) {
str.append(",addr=");
str.append(getClientAddress());
}
str.append(",logon=");
str.append(getLogonTypeString());
if (isGuest())
str.append(",Guest");
if ( hasLoggedOnName()) {
str.append(", loggedOnAs=");
str.append( getLoggedOnName());
}
str.append("]");
return str.toString();
}
/**
* Return the client information object factory
*
* @return ClientInfoFactory
*/
public static final ClientInfoFactory getFactory() {
return m_factory;
}
/**
* Set the client information object factory
*
* @param factory ClientInfoFactory
*/
public static final void setFactory(ClientInfoFactory factory) {
m_factory = factory;
}
/**
* Create a new client information instance
*
* @param user String
* @param password byte[]
* @return ClientInfo
*/
public static final ClientInfo createInfo(String user, byte[] password) {
return m_factory.createInfo(user, password);
}
}