aConfigMap = array(
'servername' => _('LDAP Server'),
'basedn' => _('Base DN'),
'searchuser' => _('LDAP Search User'),
'searchpassword' => _('LDAP Search Password'),
'searchattributes' => _('Search Attributes'),
'objectclasses' => _('Object Classes'),
);
}
// }}}
// {{{ showSource
function showSource($oSource) {
$aConfig = unserialize($oSource->getConfig());
if (empty($aConfig)) {
$aConfig = array();
}
$sRet = "\n";
foreach ($this->aConfigMap as $sSettingName => $sName) {
$sRet .= " - $sName
\n";
$sValue = KTUtil::arrayGet($aConfig, $sSettingName, _("Unset"));
if (is_array($sValue)) {
$sRet .= " - " . join("
", $sValue) . " \n";
} else {
$sRet .= " - " . $sValue . "
\n";
}
}
$sRet .= "
\n";
return $sRet;
}
// }}}
// {{{ showUserSource
function showUserSource($oUser, $oSource) {
return '' . _('Edit LDAP info') . '';
}
// }}}
// {{{ do_editUserSource
function do_editUserSource() {
$submit = KTUtil::arrayGet($_REQUEST, 'submit');
if (KTUtil::arrayGet($submit, 'save')) {
return $this->_do_saveUserSource();
}
$user_id = KTUtil::arrayGet($_REQUEST, 'user_id');
$oUser =& $this->oValidator->validateUser($user_id);
$this->oPage->setBreadcrumbDetails(_("editing LDAP details"));
$oTemplate = $this->oValidator->validateTemplate('ktstandard/authentication/ldapedituser');
$oAuthenticationSource = KTAuthenticationSource::getForUser($oUser);
$dn = $oUser->getAuthenticationDetails();
$fields = array();
$fields[] = new KTStringWidget(_('Distinguished name'), _('The location of this user in the LDAP tree'), 'dn', $dn, $this->oPage, true);
$aTemplateData = array(
'context' => &$this,
'fields' => $fields,
'user' => $oUser,
);
return $oTemplate->render($aTemplateData);
}
// }}}
// {{{ _do_saveUserSource
function _do_saveUserSource() {
$user_id = KTUtil::arrayGet($_REQUEST, 'user_id');
$oUser =& $this->oValidator->validateUser($user_id);
$dn = KTUtil::arrayGet($_REQUEST, 'dn', "");
if (empty($dn)) {
$this->errorRedirecToMain("Failed to validate LDAP details");
}
$oUser->setAuthenticationDetails($dn);
$oUser->update();
$this->successRedirectTo("editUser", _("Details updated"),
sprintf('user_id=%d', $oUser->getId()));
}
// }}}
// {{{ do_editSourceProvider
function do_editSourceProvider() {
require_once(KT_LIB_DIR . '/widgets/fieldWidgets.php');
$this->oPage->setBreadcrumbDetails(_("editing LDAP settings"));
$oTemplate = $this->oValidator->validateTemplate('ktstandard/authentication/ldapeditsource');
$iSourceId = KTUtil::arrayGet($_REQUEST, 'source_id');
$oSource = KTAuthenticationSource::get($iSourceId);
$aConfig = unserialize($oSource->getConfig());
if (empty($aConfig)) {
$aConfig = array();
}
$aConfig['searchattributes'] = KTUtil::arrayGet($aConfig, 'searchattributes', split(',', 'cn,mail,sAMAccountName'));
$aConfig['objectclasses'] = KTUtil::arrayGet($aConfig, 'objectclasses', split(',', 'user,inetOrgPerson,posixAccount'));
$fields = array();
$fields[] = new KTStringWidget(_('Server name'), 'The host name or IP address of the LDAP server', 'servername', $aConfig['servername'], $this->oPage, true);
$fields[] = new KTStringWidget(_('Base DN'), 'The location in the LDAP directory to start searching from (CN=Users,DC=mycorp,DC=com)', 'basedn', $aConfig['basedn'], $this->oPage, true);
$fields[] = new KTStringWidget(_('Search User'), 'The user account in the LDAP directory to perform searches in the LDAP directory as (such as CN=searchUser,CN=Users,DC=mycorp,DC=com or searchUser@mycorp.com)', 'searchuser', $aConfig['searchuser'], $this->oPage, true);
$fields[] = new KTStringWidget(_('Search Password'), 'The password for the user account in the LDAP directory that performs searches', 'searchpassword', $aConfig['searchpassword'], $this->oPage, true);
$aOptions = array(
'rows' => 7,
'cols' => 25,
);
$fields[] = new KTTextWidget(_('Search Attributes'), 'The LDAP attributes to use to search for users when given their name (one per line, examples: cn, mail)', 'searchattributes_nls', join("\n", $aConfig['searchattributes']), $this->oPage, true, null, null, $aOptions);
$fields[] = new KTTextWidget(_('Object Classes'), 'The LDAP object classes to search for users (one per line, example: user, inetOrgPerson, posixAccount)', 'objectclasses_nls', join("\n", $aConfig['objectclasses']), $this->oPage, true, null, null, $aOptions);
$aTemplateData = array(
'context' => &$this,
'fields' => $fields,
'source' => $oSource,
);
return $oTemplate->render($aTemplateData);
}
// }}}
// {{{ do_performEditSourceProvider
function do_performEditSourceProvider() {
$iSourceId = KTUtil::arrayGet($_REQUEST, 'source_id');
$oSource = KTAuthenticationSource::get($iSourceId);
$aConfig = unserialize($oSource->getConfig());
$aConfig['searchattributes'] = KTUtil::arrayGet($aConfig, 'searchattributes', split(',', 'cn,mail,sAMAccountName'));
$aConfig['objectclasses'] = KTUtil::arrayGet($aConfig, 'objectclasses', split(',', 'user,inetOrgPerson,posixAccount'));
foreach ($this->aConfigMap as $k => $v) {
$sValue = KTUtil::arrayGet($_REQUEST, $k . '_nls');
if ($sValue) {
$aConfig[$k] = split("\n", $sValue);
continue;
}
$sValue = KTUtil::arrayGet($_REQUEST, $k);
if ($sValue) {
$aConfig[$k] = $sValue;
}
}
$oSource->setConfig(serialize($aConfig));
$res = $oSource->update();
$this->successRedirectTo('viewsource', _("Configuration updated"), 'source_id=' . $oSource->getId());
}
// }}}
// {{{ getAuthenticator
function &getAuthenticator($oSource) {
return new $this->sAuthenticatorClass($oSource);
}
// }}}
// {{{ _do_editUserFromSource
function _do_editUserFromSource() {
$oTemplate = $this->oValidator->validateTemplate('ktstandard/authentication/ldapadduser');
$oSource =& KTAuthenticationSource::get($_REQUEST['source_id']);
$id = KTUtil::arrayGet($_REQUEST, 'id');
$aConfig = unserialize($oSource->getConfig());
$oAuthenticator = $this->getAuthenticator($oSource);
$aResults = $oAuthenticator->getUser($id);
$fields = array();
$fields[] = new KTStaticTextWidget(_('LDAP DN'), _('The location of the user within the LDAP directory.'), 'dn', $id, $this->oPage);
$fields[] = new KTStringWidget(_('Username'), _('The username the user will enter to gain access to KnowledgeTree. e.g. jsmith'), 'ldap_username', $aResults[$this->aAttributes[1]], $this->oPage, true);
$fields[] = new KTStringWidget(_('Name'), _('The full name of the user. This is shown in reports and listings. e.g. John Smith'), 'name', $aResults[$this->aAttributes[0]], $this->oPage, true);
$fields[] = new KTStringWidget(_('Email Address'), _('The email address of the user. Notifications and alerts are mailed to this address if email notifications is set below. e.g. jsmith@acme.com'), 'email_address', $aResults[$this->aAttributes[4]], $this->oPage, false);
$fields[] = new KTCheckboxWidget(_('Email Notifications'), _('If this is specified then the user will have notifications sent to the email address entered above. If it is not set, then the user will only see notifications on the Dashboard'), 'email_notifications', true, $this->oPage, false);
$fields[] = new KTStringWidget(_('Mobile Number'), _('The mobile phone number of the user. If the system is configured to send notifications to cellphones, then this number will have an SMS delivered to it with notifications. e.g. 999 9999 999'), 'mobile_number', $aResults[$this->aAttributes[5]], $this->oPage, false);
$fields[] = new KTStringWidget(_('Maximum Sessions'), _('As a safety precaution, it is useful to limit the number of times a given account can log in, before logging out. This prevents a single account being used by many different people.'), 'max_sessions', '3', $this->oPage, true);
$aTemplateData = array(
'context' => &$this,
'fields' => $fields,
'source' => $oSource,
'search_results' => $aSearchResults,
'dn' => $id,
'samaccountname' => $aResults['samaccountname'],
);
return $oTemplate->render($aTemplateData);
}
// }}}
// {{{ _do_createUserFromSource
function _do_createUserFromSource() {
$oSource =& KTAuthenticationSource::get($_REQUEST['source_id']);
$dn = KTUtil::arrayGet($_REQUEST, 'dn');
$samaccountname = KTUtil::arrayGet($_REQUEST, 'samaccountname');
$name = KTUtil::arrayGet($_REQUEST, 'name');
if (empty($name)) { $this->errorRedirectToMain(_('You must specify a name for the user.')); }
$username = KTUtil::arrayGet($_REQUEST, 'ldap_username');
if (empty($name)) { $this->errorRedirectToMain(_('You must specify a new username.')); }
// FIXME check for non-clashing usernames.
$email_address = KTUtil::arrayGet($_REQUEST, 'email_address');
$email_notifications = KTUtil::arrayGet($_REQUEST, 'email_notifications', false);
if ($email_notifications !== false) $email_notifications = true;
$mobile_number = KTUtil::arrayGet($_REQUEST, 'mobile_number');
$max_sessions = KTUtil::arrayGet($_REQUEST, 'max_sessions', '3');
// FIXME check for numeric max_sessions... db-error else?
$oUser =& User::createFromArray(array(
"Username" => $username,
"Name" => $name,
"Email" => $email_address,
"EmailNotification" => $email_notifications,
"SmsNotification" => false, // FIXME do we auto-act if the user has a mobile?
"MaxSessions" => $max_sessions,
"authenticationsourceid" => $oSource->getId(),
"authenticationdetails" => $dn,
"authenticationdetails2" => $samaccountname,
"password" => "",
));
if (PEAR::isError($oUser) || ($oUser == false)) {
$this->errorRedirectToMain(_("failed to create user."));
exit(0);
}
$this->successRedirectToMain(_('Created new user') . ': ' . $oUser->getUsername());
exit(0);
}
// }}}
// {{{ _do_massCreateUsers
function _do_massCreateUsers() {
$aIds = KTUtil::arrayGet($_REQUEST, 'id');
$oSource =& KTAuthenticationSource::get($_REQUEST['source_id']);
$oAuthenticator = $this->getAuthenticator($oSource);
$aNames = array();
foreach ($aIds as $sId) {
$aResults = $oAuthenticator->getUser($sId);
$dn = $sId;
$sUserName = $aResults[$this->aAttributes[1]];
$sName = $aResults[$this->aAttributes[0]];
$sEmailAddress = $aResults[$this->aAttributes[4]];
$sMobileNumber = $aResults[$this->aAttributes[5]];
$oUser = User::createFromArray(array(
"Username" => $sUserName,
"Name" => $sName,
"Email" => $sEmailAddress,
"EmailNotification" => true,
"SmsNotification" => false, // FIXME do we auto-act if the user has a mobile?
"MaxSessions" => 3,
"authenticationsourceid" => $oSource->getId(),
"authenticationdetails" => $dn,
"authenticationdetails2" => $sUserName,
"password" => "",
));
$aNames[] = $sName;
}
$this->successRedirectToMain(_("Added users") . ": " . join(', ', $aNames));
}
// }}}
// {{{ do_addUserFromSource
function do_addUserFromSource() {
$submit = KTUtil::arrayGet($_REQUEST, 'submit');
if (!is_array($submit)) {
$submit = array();
}
if (KTUtil::arrayGet($submit, 'chosen')) {
$id = KTUtil::arrayGet($_REQUEST, 'id');
$massimport = KTUtil::arrayGet($_REQUEST, 'massimport');
if (!empty($id)) {
if ($massimport) {
return $this->_do_massCreateUsers();
} else {
return $this->_do_editUserFromSource();
}
} else {
$this->oPage->addError(_("No valid LDAP user chosen"));
}
}
if (KTUtil::arrayGet($submit, 'create')) {
return $this->_do_createUserFromSource();
}
$oSource =& KTAuthenticationSource::get($_REQUEST['source_id']);
$oTemplate = $this->oValidator->validateTemplate('ktstandard/authentication/ldapsearchuser');
$fields = array();
$fields[] = new KTStringWidget(_("User's name"), _("The user's name, or part thereof, to find the user that you wish to add"), 'ldap_name', '', $this->oPage, true);
$fields[] = new KTCheckboxWidget(_("Mass import"), _("Allow for multiple users to be selected to be added (will not get to manually verify the details if selected)"), 'massimport', false, $this->oPage, true);
$oAuthenticator = $this->getAuthenticator($oSource);
$name = KTUtil::arrayGet($_REQUEST, 'ldap_name');
if (!empty($name)) {
$aSearchResults = $oAuthenticator->searchUsers($name, array('cn', 'dn', $sIdentifierField));
if (PEAR::isError($aSearchResults)) {
$this->oPage->addError($aSearchResults->getMessage());
$aSearchResults = null;
}
}
$massimport = KTUtil::arrayGet($_REQUEST, 'massimport');
$aTemplateData = array(
'context' => &$this,
'fields' => $fields,
'source' => $oSource,
'search_results' => $aSearchResults,
'identifier_field' => $sIdentifierField,
'massimport' => $massimport,
);
return $oTemplate->render($aTemplateData);
}
// }}}
// {{{ do_addGroupFromSource
function do_addGroupFromSource() {
$submit = KTUtil::arrayGet($_REQUEST, 'submit');
if (!is_array($submit)) {
$submit = array();
}
if (KTUtil::arrayGet($submit, 'chosen')) {
$id = KTUtil::arrayGet($_REQUEST, 'id');
if (!empty($id)) {
return $this->_do_editGroupFromSource();
} else {
$this->oPage->addError(_("No valid LDAP group chosen"));
}
}
if (KTUtil::arrayGet($submit, 'create')) {
return $this->_do_createGroupFromSource();
}
$oSource =& KTAuthenticationSource::get($_REQUEST['source_id']);
$oTemplate = $this->oValidator->validateTemplate('ktstandard/authentication/ldapsearchgroup');
$fields = array();
$fields[] = new KTStringWidget(_("Group's name"), _("The group's name, or part thereof, to find the group that you wish to add"), 'name', '', $this->oPage, true);
$oAuthenticator = $this->getAuthenticator($oSource);
$name = KTUtil::arrayGet($_REQUEST, 'name');
if (!empty($name)) {
$oAuthenticator = $this->getAuthenticator($oSource);
$aSearchResults = $oAuthenticator->searchGroups($name);
}
$aTemplateData = array(
'context' => &$this,
'fields' => $fields,
'source' => $oSource,
'search_results' => $aSearchResults,
'identifier_field' => 'displayName',
);
return $oTemplate->render($aTemplateData);
}
// }}}
// {{{ _do_editGroupFromSource
function _do_editGroupFromSource() {
$oTemplate = $this->oValidator->validateTemplate('ktstandard/authentication/ldapaddgroup');
$oSource =& KTAuthenticationSource::get($_REQUEST['source_id']);
$id = KTUtil::arrayGet($_REQUEST, 'id');
$aConfig = unserialize($oSource->getConfig());
$oAuthenticator = $this->getAuthenticator($oSource);
$aAttributes = $oAuthenticator->getGroup($id);
$fields = array();
$fields[] = new KTStaticTextWidget(_('LDAP DN'), _('The location of the group within the LDAP directory.'), 'dn', $aAttributes['dn'], $this->oPage);
$fields[] = new KTStringWidget(_('Group Name'), _('The name the group will enter to gain access to KnowledgeTree. e.g. accountants'), 'ldap_groupname', $aAttributes['cn'], $this->oPage, true);
$fields[] = new KTCheckboxWidget(_('Unit Administrators'),_('Should all the members of this group be given unit administration privileges?'), 'is_unitadmin', false, $this->oPage, false);
$fields[] = new KTCheckboxWidget(_('System Administrators'),_('Should all the members of this group be given system administration privileges?'), 'is_sysadmin', false, $this->oPage, false);
$aTemplateData = array(
'context' => &$this,
'fields' => $fields,
'source' => $oSource,
'search_results' => $aSearchResults,
'dn' => $aAttributes['dn'],
);
return $oTemplate->render($aTemplateData);
}
// }}}
// {{{ _do_createGroupFromSource
function _do_createGroupFromSource() {
$oSource =& KTAuthenticationSource::get($_REQUEST['source_id']);
$dn = KTUtil::arrayGet($_REQUEST, 'dn');
$name = KTUtil::arrayGet($_REQUEST, 'ldap_groupname');
if (empty($name)) { $this->errorRedirectToMain(_('You must specify a name for the group.')); }
$is_unitadmin = KTUtil::arrayGet($_REQUEST, 'is_unitadmin', false);
$is_sysadmin = KTUtil::arrayGet($_REQUEST, 'is_sysadmin', false);
$oGroup =& Group::createFromArray(array(
"name" => $name,
"isunitadmin" => $is_unitadmin,
"issysadmin" => $is_sysadmin,
"authenticationdetails" => $dn,
"authenticationsourceid" => $oSource->getId(),
));
if (PEAR::isError($oGroup) || ($oGroup == false)) {
$this->errorRedirectToMain(_("failed to create group."));
exit(0);
}
$oAuthenticator = $this->getAuthenticator($oSource);
$oAuthenticator->synchroniseGroup($oGroup);
$this->successRedirectToMain(_('Created new group') . ': ' . $oGroup->getName());
exit(0);
}
// }}}
}
class KTLDAPBaseAuthenticator extends Authenticator {
/**
* The LDAP server to connect to
*/
var $sLdapServer;
/**
* The base LDAP DN to perform authentication against
*/
var $sBaseDN;
/**
* The LDAP accessor class
*/
var $oLdap;
function KTLDAPBaseAuthenticator($oSource) {
$this->oSource =& $oSource;
$aConfig = unserialize($oSource->getConfig());
$this->sLdapServer = $aConfig['servername'];
$this->sBaseDN = $aConfig['basedn'];
$this->sSearchUser = $aConfig['searchuser'];
$this->sSearchPassword = $aConfig['searchpassword'];
$this->aObjectClasses = KTUtil::arrayGet($aConfig, 'objectclasses');
if (empty($this->aObjectClasses)) {
$this->aObjectClasses = array('user', 'inetOrgPerson', 'posixAccount');
}
$this->aSearchAttributes = KTUtil::arrayGet($aConfig, 'searchattributes');
if (empty($this->aSearchAttributes)) {
$this->aSearchAttributes = array('cn', 'samaccountname');
}
require_once('Net/LDAP.php');
$config = array(
'dn' => $this->sSearchUser,
'password' => $this->sSearchPassword,
'host' => $this->sLdapServer,
'base' => $this->sBaseDN,
);
$this->oLdap =& Net_LDAP::connect($config);
}
/**
* Authenticate the user against the LDAP directory
*
* @param string the user to authenticate
* @param string the password to check
* @return boolean true if the password is correct, else false
*/
function checkPassword($oUser, $sPassword) {
$dn = $oUser->getAuthenticationDetails();
$config = array(
'host' => $this->sLdapServer,
'base' => $this->sBaseDN,
);
$oLdap =& Net_LDAP::connect($config);
$res = $oLdap->reBind($dn, $sPassword);
return $res;
}
/**
* Searched the directory for a specific user
*
* @param string the username to search for
* @param array the attributes to return from the search
* @return array containing the users found
*/
function getUser($dn) {
if (PEAR::isError($this->oLdap)) {
return $this->oLdap;
}
$oEntry = $this->oLdap->getEntry($dn, $this->aAttributes);
$aAttr = $oEntry->attributes();
$aAttr['dn'] = $oEntry->dn();
foreach ($aAttr as $k => $v) {
$aRet[strtolower($k)] = $v;
}
return $aRet;
}
/**
* Searches the LDAP directory for users matching the supplied search string.
*
* @param string the username to search for
* @param array the attributes to return from the search
* @return array containing the users found
*/
function searchUsers($sSearch) {
if (PEAR::isError($this->oLdap)) {
return $this->oLdap;
}
$aParams = array(
'scope' => 'sub',
'attributes' => array('cn', 'dn', 'samaccountname'),
);
$rootDn = $this->sBaseDN;
if (is_array($rootDn)) {
$rootDn = join(",", $rootDn);
}
$sObjectClasses = "|";
foreach ($this->aObjectClasses as $sObjectClass) {
$sObjectClasses .= sprintf('(objectClass=%s)', trim($sObjectClass));
}
$sSearchAttributes = "|";
foreach ($this->aSearchAttributes as $sSearchAttribute) {
$sSearchAttributes .= sprintf('(%s=*%s*)', trim($sSearchAttribute), $sSearch);
}
$sFilter = sprintf('(&(%s)(%s))', $sObjectClasses, $sSearchAttributes);
$oResult = $this->oLdap->search($rootDn, $sFilter, $aParams);
if (PEAR::isError($oResult)) {
return $oResult;
}
$aRet = array();
foreach($oResult->entries() as $oEntry) {
$aAttr = $oEntry->attributes();
$aAttr['dn'] = $oEntry->dn();
$aRet[] = $aAttr;
}
return $aRet;
}
function searchGroups($sSearch) {
if (PEAR::isError($this->oLdap)) {
return $this->oLdap;
}
$aParams = array(
'scope' => 'sub',
'attributes' => array('cn', 'dn', 'displayName'),
);
$rootDn = $oAuthenticator->sBaseDN;
if (is_array($rootDn)) {
$rootDn = join(",", $rootDn);
}
$sFilter = sprintf('(&(objectClass=group)(cn=*%s*))', $sSearch);
$oResults = $this->oLdap->search($rootDn, $sFilter, $aParams);
$aRet = array();
foreach($oResults->entries() as $oEntry) {
$aAttr = $oEntry->attributes();
$aAttr['dn'] = $oEntry->dn();
$aRet[] = $aAttr;
}
return $aRet;
}
function getGroup($dn, $aAttributes = null) {
if (empty($aAttributes)) {
$aAttributes = array('cn');
}
if (PEAR::isError($this->oLdap)) {
return $this->oLdap;
}
$oEntry = $this->oLdap->getEntry($dn, $aAttributes);
if (PEAR::isError($oEntry)) {
return $oEntry;
}
$aAttr = $oEntry->attributes();
$aAttr['dn'] = $oEntry->dn();
return $aAttr;
}
function synchroniseGroup($oGroup) {
$oGroup =& KTUtil::getObject('Group', $oGroup);
$dn = $oGroup->getAuthenticationDetails();
$aAttr = $this->getGroup($dn, array('member'));
if (PEAR::isError($aAttr)) {
return $aAttr;
}
$aMembers = KTUtil::arrayGet($aAttr, 'member', array());
if (!is_array($aMembers)) {
$aMembers = array($aMembers);
}
$aUserIds = array();
foreach ($aMembers as $sMember) {
$iUserId = User::getByAuthenticationSourceAndDetails($this->oSource, $sMember, array('ids' => true));
if (PEAR::isError($iUserId)) {
continue;
}
$aUserIds[] = $iUserId;
}
$oGroup->setMembers($aUserIds);
}
}