aConfigMap = array(
'servername' => _('LDAP Server'),
'basedn' => _('Base DN'),
'servertype' => _('LDAP Server Type'),
'domain' => _('LDAP Server Domain'),
'searchuser' => _('LDAP Search User'),
'searchpassword' => _('LDAP Search Password'),
);
return parent::KTAuthenticationProvider();
}
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"));
$sRet .= " - " . $sValue . "
\n";
}
$sRet .= "
\n";
return $sRet;
}
function showUserSource($oUser, $oSource) {
return '' . _('Edit LDAP info') . '';
}
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);
$aDetails = unserialize($oUser->getAuthenticationDetails());
$dn = KTUtil::arrayGet($aDetails, 'dn', "");
$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);
}
function _do_saveUserSource() {
$user_id = KTUtil::arrayGet($_REQUEST, 'user_id');
$oUser =& $this->oValidator->validateUser($user_id);
$aDetails['dn'] = KTUtil::arrayGet($_REQUEST, 'dn', "");
$oUser->setAuthenticationDetails(serialize($aDetails));
$oUser->update();
$this->successRedirectTo("editUser", _("Details updated"),
sprintf('user_id=%d', $oUser->getId()));
}
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());
$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'), 'FIXME', 'basedn', $aConfig['basedn'], $this->oPage, true);
$fields[] = new KTStringWidget(_('Server Type'), 'FIXME', 'servertype', $aConfig['servertype'], $this->oPage, true);
$fields[] = new KTStringWidget(_('Domain'), 'FIXME', 'domain', $aConfig['domain'], $this->oPage, true);
$fields[] = new KTStringWidget(_('Search User'), 'FIXME', 'searchuser', $aConfig['searchuser'], $this->oPage, true);
$fields[] = new KTStringWidget(_('Search Password'), 'FIXME', 'searchpassword', $aConfig['searchpassword'], $this->oPage, true);
$aTemplateData = array(
'context' => &$this,
'fields' => $fields,
'source' => $oSource,
);
return $oTemplate->render($aTemplateData);
}
function do_performEditSourceProvider() {
$iSourceId = KTUtil::arrayGet($_REQUEST, 'source_id');
$oSource = KTAuthenticationSource::get($iSourceId);
$aConfig = array();
foreach ($this->aConfigMap as $k => $v) {
$sValue = KTUtil::arrayGet($_REQUEST, $k);
if ($sValue) {
$aConfig[$k] = $sValue;
}
}
$oSource->setConfig(serialize($aConfig));
$oSource->update();
$this->successRedirectTo('viewsource', _("Configuration updated"), 'source_id=' . $oSource->getId());
}
function &getAuthenticator($oSource) {
return new LDAPAuthenticator($oSource);
}
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());
if ($aConfig['servertype'] == "ActiveDirectory") {
$aAttributes = array ("dn", "samaccountname", "givenname", "sn", "userPrincipalName", "telephonenumber");
} else {
$aAttributes = array ("dn", "uid", "givenname", "sn", "mail", "mobile");
}
$oAuthenticator = $this->getAuthenticator($oSource);
$aResults = $oAuthenticator->getUser($id, $aAttributes);
$aResults = $aResults[$id];
$fields = array();
$fields[] = new KTStaticTextWidget(_('LDAP DN'), _('The location of the user within the LDAP directory.'), 'dn', $aResults[$aAttributes[0]], $this->oPage);
$fields[] = new KTStringWidget(_('Username'), _('The username the user will enter to gain access to the KnowledgeTree. e.g. jsmith'), 'ldap_username', $aResults[$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', join(" ", array($aResults[$aAttributes[2]], $aResults[$aAttributes[3]])), $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[$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[$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' => $dn,
);
return $oTemplate->render($aTemplateData);
}
function _do_createUserFromSource() {
$oSource =& KTAuthenticationSource::get($_REQUEST['source_id']);
$dn = KTUtil::arrayGet($_REQUEST, 'dn');
$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" => serialize(array('dn' => $dn)),
"password" => "",
));
if (PEAR::isError($oUser) || ($oUser == false)) {
$this->errorRedirectToMain(_("failed to create user."));
exit(0);
}
$this->successRedirectToMain(_('Created new user') . ': ' . $oUser->getUsername());
exit(0);
}
function do_addUserFromSource() {
$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_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"), 'name', '', $this->oPage, true);
$oAuthenticator = $this->getAuthenticator($oSource);
$sIdentifierField = $oAuthenticator->oLdap->getUserIdentifier();
$name = KTUtil::arrayGet($_REQUEST, 'name');
if (!empty($name)) {
$oAuthenticator = $this->getAuthenticator($oSource);
$aSearchResults = $oAuthenticator->searchUsers($name, array('cn', 'dn', $sIdentifierField));
}
/*
$show_all = KTUtil::arrayGet($_REQUEST, 'show_all');
if (!empty($show_all)) {
$oAuthenticator = $this->getAuthenticator($oSource);
$aSearchResults = $oAuthenticator->searchUsers('', array('cn', 'dn'));
}
*/
$aTemplateData = array(
'context' => &$this,
'fields' => $fields,
'source' => $oSource,
'search_results' => $aSearchResults,
'identifier_field' => $sIdentifierField,
);
return $oTemplate->render($aTemplateData);
}
}
class LDAPAuthenticator 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;
/**
* Creates a new instance of the LDAPAuthenticator
*
* @param string the LDAP server to connect to for validation (optional)
* @param string the dn branch to perform the authentication against (optional)
* @param string the ldap server type (optional)
*/
function LDAPAuthenticator($oSource) {
$this->oSource =& $oSource;
$aConfig = unserialize($oSource->getConfig());
$this->sLdapServer = $aConfig['servername'];
$this->sBaseDN = $aConfig['basedn'];
$this->sServerType = $aConfig['servertype'];
$this->sLdapDomain = $aConfig['domain'];
$this->sSearchUser = $aConfig['searchuser'];
$this->sSearchPassword = $aConfig['searchpassword'];
// initialise and setup ldap class
$this->oLdap = new AuthLdap($this->sLdapServer, $this->sBaseDN, $this->sServerType, $this->sLdapDomain, $this->sSearchUser, $this->sSearchPassword);
}
/**
* Checks the user's password against the LDAP directory
*
* @param string the name of the user to check
* @param string the password to check
* @return boolean true if the password is correct, else false
*/
function checkPassword($oUser, $sPassword) {
$aDetails = unserialize($oUser->getAuthenticationDetails());
if ($this->oLdap->connect()) {
$sBindDn = $aDetails['dn'];
if ($this->sServerType == "ActiveDirectory") {
$sBindDn = sprintf("%s@%s", $oUser->getUserName(), $this->sLdapDomain);
}
if ($this->oLdap->authBind($sBindDn, $sPassword)) {
return true;
} else {
return PEAR::raiseError("LDAP error: (" . $this->oLdap->ldapErrorCode . ") " . $this->oLdap->ldapErrorText);
}
} else {
return PEAR::raiseError('LDAP server unreachable');
}
}
/**
* 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($sUserName, $aAttributes) {
global $default;
// connect and search
if ( $this->oLdap->connect() ) {
// search for the users
// append and prepend wildcards
$aUserResults = $this->oLdap->getUsers($sUserName, $aAttributes);
if ($aUserResults) {
// return the array
return $aUserResults;
} else {
// the search failed, return empty array
return array();
}
} else {
$_SESSION["errorMessage"] = "LDAP error: (" . $this->oLdap->ldapErrorCode . ") " . $this->oLdap->ldapErrorText;
return false;
}
}
/**
* 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($sUserNameSearch, $aAttributes) {
global $default;
// connect and search
if ( $this->oLdap->connect() ) {
// search for the users
// append and prepend wildcards
$aUserResults = $this->oLdap->getUsers("*" . $sUserNameSearch . "*", $aAttributes);
if ($aUserResults) {
// return the array
return $aUserResults;
} else {
// the search failed, return empty array
return array();
}
} else {
$default->log->error("LDAPAuthentication::searchUsers LDAP error: (" . $this->oLdap->ldapErrorCode . ") " . $this->oLdap->ldapErrorText);
return false;
}
}
}