org.filesys.oncrpc.DefaultRpcAuthenticator 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 RPC authenticator implementation that allows any client to access the RPC servers.
*
* @author gkspencer
*/
public class DefaultRpcAuthenticator implements RpcAuthenticator {
// Authentication types supported by this implementation
private AuthType[] _authTypes = {AuthType.Null, AuthType.Unix};
// Debug enable
private boolean m_debug;
/**
* Authenticate an RPC client and create a unique session id key.
*
* @param authType AuthType
* @param rpc RpcPacket
* @return Object
* @exception RpcAuthenticationException Authentication error
*/
public Object authenticateRpcClient(AuthType authType, RpcPacket rpc)
throws RpcAuthenticationException {
// Create a unique session key depending on the authentication type
Object sessKey = null;
switch (authType) {
// Null authentication
case Null:
sessKey = new Integer(rpc.getClientAddress().hashCode());
break;
// Unix authentication
case Unix:
// Get the gid and uid from the credentials data in the request
rpc.positionAtCredentialsData();
rpc.skipBytes(4);
int nameLen = rpc.unpackInt();
rpc.skipBytes(nameLen);
int uid = rpc.unpackInt();
int gid = rpc.unpackInt();
// Check if the Unix authentication session table is valid
sessKey = new Long((((long) rpc.getClientAddress().hashCode()) << 32) + (gid << 16) + uid);
break;
}
// Check if the session key is valid, if not then the authentication type is unsupported
if (sessKey == null)
throw new RpcAuthenticationException(Rpc.AuthSts.BadCred, "Unsupported auth type, " + authType);
// DEBUG
if (Debug.EnableInfo && hasDebug())
Debug.println("RpcAuth: RPC from " + rpc.getClientDetails() + ", authType=" + authType.name() +
", sessKey=" + sessKey);
// Return the session key
return sessKey;
}
/**
* Determine if debug output is enabled
*
* @return boolean
*/
public final boolean hasDebug() {
return m_debug;
}
/**
* Return the authentication types that are supported by this implementation.
*
* @return AuthType[]
*/
public AuthType[] getRpcAuthenticationTypes() {
return _authTypes;
}
/**
* Return the client information for the specified RPC request
*
* @param sessKey Object
* @param rpc RpcPacket
* @return ClientInfo
*/
public ClientInfo getRpcClientInformation(Object sessKey, RpcPacket rpc) {
// Create a client information object to hold the client details
ClientInfo cInfo = ClientInfo.createInfo("", null);
// Get the authentication type
AuthType authType = rpc.getCredentialsType();
cInfo.setNFSAuthenticationType(authType);
// Unpack the client details from the RPC request
switch (authType) {
// Null authentication
case Null:
cInfo.setClientAddress(rpc.getClientAddress().getHostAddress());
// DEBUG
if (Debug.EnableInfo && hasDebug())
Debug.println("RpcAuth: Client info, type=" + authType.name() + ", addr=" + rpc.getClientAddress().getHostAddress());
break;
// Unix authentication
case Unix:
// Unpack the credentials data
rpc.positionAtCredentialsData();
rpc.skipBytes(4); // stamp id
cInfo.setClientAddress(rpc.unpackString());
cInfo.setUid(rpc.unpackInt());
cInfo.setGid(rpc.unpackInt());
// Check for an additional groups list
int grpLen = rpc.unpackInt();
if (grpLen > 0) {
int[] groups = new int[grpLen];
rpc.unpackIntArray(groups);
cInfo.setGroupsList(groups);
}
// DEBUG
if (Debug.EnableInfo && hasDebug())
Debug.println("RpcAuth: Client info, type=" + authType.name() + ", name=" + cInfo.getClientAddress() +
", uid=" + cInfo.getUid() + ", gid=" + cInfo.getGid() + ", groups=" + grpLen);
break;
}
// Return the client information
return cInfo;
}
/**
* Initialize the RPC authenticator
*
* @param config ServerConfiguration
* @param params ConfigElement
* @exception InvalidConfigurationException Failed to initialize the authenticator
*/
public void initialize(ServerConfiguration config, ConfigElement params)
throws InvalidConfigurationException {
// Check if debug output is enabled
if (params.getChild("Debug") != null)
m_debug = true;
}
/**
* Set the current authenticated user context for processing of the current RPC request
*
* @param sess SrvSession
* @param client ClientInfo
*/
public void setCurrentUser(SrvSession sess, ClientInfo client) {
// Nothing to do
}
}