',IMGDIR,('Home'))),
'purge'=>array(
'title'=>('Purge caches'),
'enable'=>isset($_SESSION[APPCONFIG]) ? $_SESSION[APPCONFIG]->isCommandAvailable('script','purge_cache') : false,
'link'=>sprintf('href="cmd.php?cmd=purge_cache" onclick="return ajDISPLAY(\'BODY\',\'cmd=purge_cache\',\'%s\');" title="%s"',
('Clearing cache'),('Purge caches')),
'image'=>sprintf('
',IMGDIR,('Purge caches'))),
'hide_debug_info'=>array(
'title'=>('Show Cache'),
'enable'=>isset($_SESSION[APPCONFIG]) ? $_SESSION[APPCONFIG]->isCommandAvailable('script','show_cache') : false,
'link'=>sprintf('href="cmd.php?cmd=show_cache" onclick="return ajDISPLAY(\'BODY\',\'cmd=show_cache\',\'%s\');" title="%s"',
('Loading'),('Show Cache'),('Show Cache')),
'image'=>sprintf('
',IMGDIR,('Show Cache'))),
);
break;
case 'top' :
return array(
'forum'=>array(
'title'=>('Forum'),
'enable'=>isset($_SESSION[APPCONFIG]) ? $_SESSION[APPCONFIG]->isCommandAvailable('cmd','oslinks') : true,
'link'=>sprintf('href="%s" title="%s" onclick="target=\'_blank\';"',get_href('forum'),('Forum')),
'image'=>sprintf('
',IMGDIR,('Forum'))),
'feature'=>array(
'title'=>('Request feature'),
'enable'=>isset($_SESSION[APPCONFIG]) ? $_SESSION[APPCONFIG]->isCommandAvailable('cmd','oslinks') : true,
'link'=>sprintf('href="%s" title="%s" onclick="target=\'_blank\';"',get_href('add_rfe'),('Request feature')),
'image'=>sprintf('
',IMGDIR,('Request feature'))),
'bug'=>array(
'title'=>('Report a bug'),
'enable'=>isset($_SESSION[APPCONFIG]) ? $_SESSION[APPCONFIG]->isCommandAvailable('cmd','oslinks') : true,
'link'=>sprintf('href="%s" title="%s" onclick="target=\'_blank\';"',get_href('add_bug'),('Report a bug')),
'image'=>sprintf('
',IMGDIR,('Report a bug'))),
'donation'=>array(
'title'=>('Donate'),
'enable'=>isset($_SESSION[APPCONFIG]) ? $_SESSION[APPCONFIG]->isCommandAvailable('cmd','oslinks') : true,
'link'=>sprintf('href="%s" title="%s" onclick="target=\'_blank\';"',get_href('donate'),('Donate')),
'image'=>sprintf('
',IMGDIR,('Donate'))),
'help'=>array(
'title'=>('Help'),
'enable'=>isset($_SESSION[APPCONFIG]) ? $_SESSION[APPCONFIG]->isCommandAvailable('cmd','oslinks') : true,
'link'=>sprintf('href="%s" title="%s" onclick="target=\'_blank\';"',get_href('documentation'),('Help')),
'image'=>sprintf('
',IMGDIR,('Help')))
);
break;
}
}
/**
* This function dumps the $variable for debugging purposes
*
* @param string|array Variable to dump
* @param boolean Whether to stop execution or not.
*/
function debug_dump($variable,$die=false,$onlydebugaddr=false) {
if ($die) die();
}
/**
* This function generates a backtrace
*
* @param boolean Whether to stop execution or not.
*/
function debug_dump_backtrace($msg='Calling BackTrace',$die=false) {
error($msg,'note',null,$die,true);
}
/**
* Send a debug as a sys message
*/
function debug_sysmsg($msg) {
system_message(array('title'=>('Debug'),'body'=>$msg,'type'=>'debug'));
}
/**
* Debug Logging
*
* The global debug level is turned on in your configuration file by setting:
*
* $config->custom->appearance['obfuscate_password_display'] = true;
*
*
* Or if it is OK to show encrypted passwords but not clear text passwords
*
* $config->custom->appearance['show_clear_password'] = false;
*
*
* @param string Password encoding type
* @return boolean
*/
function obfuscate_password_display($enc=null) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
if ($_SESSION[APPCONFIG]->getValue('appearance','obfuscate_password_display'))
$return = true;
elseif (! $_SESSION[APPCONFIG]->getValue('appearance','show_clear_password') && (is_null($enc) || $enc == 'clear'))
$return = true;
else
$return = false;
if (DEBUG_ENABLED)
debug_log('Returning (%s)',1,0,__FILE__,__LINE__,__METHOD__,$return);
return $return;
}
/**
* Returns an HTML-beautified version of a DN.
* Internally, this function makes use of pla_explode_dn() to break the
* the DN into its components. It then glues them back together with
* "pretty" HTML. The returned HTML is NOT to be used as a real DN, but
* simply displayed.
*
* @param string The DN to pretty-print.
* @return string
*/
function pretty_print_dn($dn) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
$dn_save = $dn;
$dn = pla_explode_dn($dn);
if (! $dn)
return $dn_save;
foreach ($dn as $i => $element) {
$element = htmlspecialchars($element);
$element = explode('=',$element,2);
$element = implode('=',$element);
$dn[$i] = $element;
}
$dn = implode(',',$dn);
return $dn;
}
/**
* Given a string, this function returns true if the string has the format
* of a DN (ie, looks like "cn=Foo,dc=example,dc=com"). Returns false otherwise.
* The purpose of this function is so that developers can examine a string and
* know if it looks like a DN, and draw a hyperlink as needed.
*
* (See unit_test.php for test cases)
*
* @param string The attribute to examine for "DNness"
* @return boolean
*/
function is_dn_string($str) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
/* Try to break the string into its component parts if it can be done
ie, "uid=Manager" "dc=example" and "dc=com" */
$parts = pla_explode_dn($str);
if (! is_array($parts) || ! count($parts))
return false;
/* Foreach of the "parts", look for an "=" character,
and make sure neither the left nor the right is empty */
foreach ($parts as $part) {
if (! strpos($part,"="))
return false;
$sub_parts = explode('=',$part,2);
$left = $sub_parts[0];
$right = $sub_parts[1];
if ( ! strlen(trim($left)) || ! strlen(trim($right)))
return false;
if (strpos($left,'#') !== false)
return false;
}
# We survived the above rigor. This is a bonified DN string.
return true;
}
/**
* Get whether a string looks like an email address (user@example.com).
*
* @param string The string to analyze.
* @return boolean Returns true if the specified string looks like an email address or false otherwise.
*/
function is_mail_string($str) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
$mail_regex = "/^[_A-Za-z0-9-]+(\\.[_A-Za-z0-9-]+)*@[A-Za-z0-9-]+(\\.[A-Za-z0-9-]+)*$/";
if (preg_match($mail_regex,$str))
return true;
else
return false;
}
/**
* Get whether a string looks like a web URL (http://www.example.com/)
*
* @param string The string to analyze.
* @return boolean Returns true if the specified string looks like a web URL or false otherwise.
*/
function is_url_string($str) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
$url_regex = '/^(ftp|https?):\/\/+[\w\.\-\/\?\=\&]*\w+/';
if (preg_match($url_regex,$str))
return true;
else
return false;
}
/**
* Compares 2 DNs. If they are equivelant, returns 0, otherwise,
* returns their sorting order (similar to strcmp()):
* Returns < 0 if dn1 is less than dn2.
* Returns > 0 if dn1 is greater than dn2.
*
* The comparison is performed starting with the top-most element
* of the DN. Thus, the following list:
*
* ou=people,dc=example,dc=com
* cn=Admin,ou=People,dc=example,dc=com
* cn=Joe,ou=people,dc=example,dc=com
* dc=example,dc=com
* cn=Fred,ou=people,dc=example,dc=org
* cn=Dave,ou=people,dc=example,dc=org
*
* Will be sorted thus using usort( $list, "pla_compare_dns" ):
*
* dc=com
* dc=example,dc=com
* ou=people,dc=example,dc=com
* cn=Admin,ou=People,dc=example,dc=com
* cn=Joe,ou=people,dc=example,dc=com
* cn=Dave,ou=people,dc=example,dc=org
* cn=Fred,ou=people,dc=example,dc=org
*
*
* @param string The first of two DNs to compare
* @param string The second of two DNs to compare
* @return int
*/
function pla_compare_dns($dn1,$dn2) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
# If pla_compare_dns is passed via a tree, then we'll just get the DN part.
if (is_array($dn1))
if (isset($dn1['dn']))
$dn1 = $dn1['dn'];
else
$dn1 = implode('+',$dn1);
if (is_array($dn2))
if (isset($dn2['dn']))
$dn2 = $dn2['dn'];
else
$dn2 = implode('+',$dn2);
# If they are obviously the same, return immediately
if (! strcasecmp($dn1,$dn2))
return 0;
$dn1_parts = pla_explode_dn(pla_reverse_dn($dn1));
$dn2_parts = pla_explode_dn(pla_reverse_dn($dn2));
assert(is_array($dn1_parts));
assert(is_array($dn2_parts));
# Foreach of the "parts" of the smaller DN
for ($i=0; $i < count($dn1_parts) && $i < count($dn2_parts); $i++) {
/* dnX_part is of the form: "cn=joe" or "cn = joe" or "dc=example"
ie, one part of a multi-part DN. */
$dn1_part = $dn1_parts[$i];
$dn2_part = $dn2_parts[$i];
/* Each "part" consists of two sub-parts:
1. the attribute (ie, "cn" or "o")
2. the value (ie, "joe" or "example") */
$dn1_sub_parts = explode('=',$dn1_part,2);
$dn2_sub_parts = explode('=',$dn2_part,2);
$dn1_sub_part_attr = trim($dn1_sub_parts[0]);
$dn2_sub_part_attr = trim($dn2_sub_parts[0]);
if (0 != ($cmp = strcasecmp($dn1_sub_part_attr,$dn2_sub_part_attr)))
return $cmp;
$dn1_sub_part_val = trim($dn1_sub_parts[1]);
$dn2_sub_part_val = trim($dn2_sub_parts[1]);
if (0 != ($cmp = strcasecmp($dn1_sub_part_val,$dn2_sub_part_val)))
return $cmp;
}
/* If we iterated through all entries in the smaller of the two DNs
(ie, the one with fewer parts), and the entries are different sized,
then, the smaller of the two must be "less than" than the larger. */
if (count($dn1_parts) > count($dn2_parts)) {
return 1;
} elseif (count($dn2_parts) > count($dn1_parts)) {
return -1;
} else {
return 0;
}
}
/**
* For LDAP servers with auto_number enabled, this function will get the next
* available number using the host's preferred mechanism (pool or search).
*
* This is configured in config.php by server:
*
*
* $servers->setValue('auto_number','enable',true|false);
*
*
* The available mechanisms are:
* pool:
* The pool mechanism uses a user-configured entry in the LDAP server to
* store the last used "number". This mechanism simply fetches and increments
* and returns that value.
*
* search:
* The search mechanism will search the LDAP server that has the attribute
* set. It will then find the smallest value and "fills in the gaps" by
* incrementing the smallest attribute until an unused value is found.
*
* NOTE: Both mechanisms do NOT prevent race conditions or toe-stomping, so
* care must be taken when actually creating the entry to check that the number
* returned here has not been used in the mean time. Note that the two different
* mechanisms may (will!) return different values as they use different algorithms
* to arrive at their result. Do not be alarmed if (when!) this is the case.
*
* See config.php.example for more notes on the two mechanisms.
*
* @param string Base to start the search from
* @param string Attribute to query
* @param boolean Increment the result (for pool searches)
* @param string LDAP filter to use (for pool searches)
* @return int
*/
function get_next_number($base,$attr,$increment=false,$filter=false,$startmin=null) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
$server = $_SESSION[APPCONFIG]->getServer(get_request('server_id','REQUEST'));
$attr = strtolower($attr);
$query = array();
if (! $server->getValue('auto_number','enable')) {
system_message(array(
'title'=>('AUTO_NUMBER is disabled for this server'),
'body'=>sprintf('%s (%s)',('A call was made to get_next_number(), however, it is disabled for this server'),$attr),
'type'=>'warn'));
return false;
}
# Check see and use our alternate uid_dn and password if we have it.
if (! $server->login($server->getValue('auto_number','dn'),$server->getValue('auto_number','pass'),'auto_number')) {
system_message(array(
'title'=>('AUTO_NUMBER invalid login/password'),
'body'=>sprintf('%s (%s)',('Unable to connect to LDAP server with the auto_number login/password, please check your configuration.'),
$server->getName()),
'type'=>'warn'));
return false;
}
# Some error checking
if (! $base) {
$query['base'] = $server->getValue('auto_number','search_base');
if (! trim($query['base'])) {
system_message(array(
'title'=>('No AUTO_NUMBER search_base configured for this server'),
'body'=>('A call was made to get_next_number(), however, the base to search is empty.'),
'type'=>'warn'));
return false;
}
} else
$query['base'] = $base;
if (! $server->dnExists($query['base'])) {
system_message(array(
'title'=>('No AUTO_NUMBER search_base exists for this server'),
'body'=>sprintf('%s (%s)',('A call was made to get_next_number(), however, the base to search does not exist for this server.'),$query['base']),
'type'=>'warn'));
return false;
}
if (! is_string($attr) || ! $server->getSchemaAttribute($attr)) {
system_message(array(
'title'=>('AUTO_NUMBER search attribute invalid'),
'body'=>sprintf('%s (%s)',('The search attribute for AUTO_NUMBER is invalid, expecting a single valid attribute.'),$attr),
'type'=>'warn'));
return false;
}
$query['attrs'] = array($attr);
# Based on the configured mechanism, go get the next available uidNumber!
switch ($server->getValue('auto_number','mechanism')) {
case 'search':
$query['filter'] = sprintf('(%s=*)',$attr);
$search = $server->query($query,'auto_number');
# Construct a list of used numbers
$autonum = array(0);
foreach ($search as $dn => $values) {
$values = array_change_key_case($values);
foreach ($values[$attr] as $value)
array_push($autonum,$value);
}
$autonum = array_unique($autonum);
sort($autonum);
# Start with the least existing autoNumber and add 1
$minNumber = is_null($startmin) ? intval($autonum[0])+1 : $startmin;
# Override our minNumber by the configuration if it exists.
if (count($server->getValue('auto_number','min'))) {
$min = array_change_key_case($server->getValue('auto_number','min'));
if (isset($min[$attr]))
$minNumber = $min[$attr] > $minNumber ? $min[$attr] : $minNumber;
}
for ($i=0;$i
* Array (
* [title] => "Invalid Credentials"
* [description] => "An invalid username and/or password was supplied to the LDAP server."
* )
*
*
* @param string The hex error number (ie, "0x42") of the LDAP error of interest.
* @return array An associative array contianing the error title and description like so:
*/
function pla_verbose_error($key) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
static $CACHE = array();
if (! count($CACHE)) {
$source_file = LIBDIR.'ldap_error_codes.txt';
if (! file_exists($source_file) || ! is_readable($source_file) || ! ($f = fopen($source_file,'r')))
return false;
$contents = fread($f,filesize($source_file));
fclose($f);
$entries = array();
preg_match_all("/0x[A-Fa-f0-9][A-Za-z0-9]\s+[0-9A-Za-z_]+\s+\"[^\"]*\"\n/",
$contents,$entries);
foreach ($entries[0] as $values) {
$entry = array();
preg_match("/(0x[A-Za-z0-9][A-Za-z0-9])\s+([0-9A-Za-z_]+)\s+\"([^\"]*)\"/",$values,$entry);
$hex_code = isset($entry[1]) ? $entry[1] : null;
$title = isset($entry[2]) ? $entry[2] : null;
$desc = isset($entry[3]) ? $entry[3] : null;
$desc = preg_replace('/\s+/',' ',$desc);
$CACHE[$hex_code] = array('title'=>$title,'desc'=>$desc);
}
}
if (isset($CACHE[$key]))
return $CACHE[$key];
else
return array('title' => null,'desc' => null);
}
/**
* Given an LDAP OID number, returns a verbose description of the OID.
* This function parses ldap_supported_oids.txt and looks up the specified
* OID, and returns the verbose message defined in that file.
*
*
* Array (
* [title] => All Operational Attribute
* [ref] => RFC 3673
* [desc] => An LDAP extension which clients may use to request the return of all operational attributes.
* )
*
*
* @param string The OID number (ie, "1.3.6.1.4.1.4203.1.5.1") of the OID of interest.
* @return array An associative array contianing the OID title and description like so:
*/
function support_oid_to_text($key) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
static $CACHE = array();
$unknown = array();
$unknown['desc'] = 'We have no description for this OID, if you know what this OID provides, please let us know. Please also include an RFC reference if it is available.';
$unknown['title'] = 'Can you help with this OID info?';
if (! count($CACHE)) {
$source_file = LIBDIR.'ldap_supported_oids.txt';
if (! file_exists($source_file) || ! is_readable($source_file) || ! ($f = fopen($source_file,'r')))
return false;
$contents = fread($f,filesize($source_file));
fclose($f);
$entries = array();
preg_match_all("/[0-9]\..+\s+\"[^\"]*\"\n/",$contents,$entries);
foreach ($entries[0] as $values) {
$entry = array();
preg_match("/([0-9]\.([0-9]+\.)*[0-9]+)(\s+\"([^\"]*)\")?(\s+\"([^\"]*)\")?(\s+\"([^\"]*)\")?/",$values,$entry);
$oid_id = isset($entry[1]) ? $entry[1] : null;
if ($oid_id) {
$CACHE[$oid_id]['title'] = isset($entry[4]) ? $entry[4] : null;
$CACHE[$oid_id]['ref'] = isset($entry[6]) ? $entry[6] : null;
$desc = isset($entry[8]) ? $entry[8] : sprintf('%s',$unknown['desc'],$unknown['title']);
$CACHE[$oid_id]['desc'] = preg_replace('/\s+/',' ',$desc);
}
}
}
if (isset($CACHE[$key]))
return $CACHE[$key];
else
return array(
'title'=>$key,
'ref'=>null,
'desc'=>sprintf('%s',$unknown['desc'],$unknown['title']));
}
/**
* Print an LDAP error message
*/
function ldap_error_msg($msg,$errnum) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
$body = '| %s: | %s |
| %s: | %s (%s) |
| %s: | %s |
| %s: | %s |
| %s: | (%s) |
* draw_jpeg_photo(0,'cn=Bob,ou=People,dc=example,dc=com',"jpegPhoto",0,true,array('img_opts'=>"border: 1px; width: 150px"));
* draw_jpeg_photo(1,'cn=Fred,ou=People,dc=example,dc=com',null,1);
*
*
* @param object The Server to get the image from.
* @param string The DN of the entry that contains the jpeg attribute you want to draw.
* @param string The name of the attribute containing the jpeg data (usually 'jpegPhoto').
* @param int Index of the attribute to draw
* @param boolean If true, draws a button beneath the image titled 'Delete' allowing the user
* to delete the jpeg attribute by calling JavaScript function deleteAttribute() provided
* in the default modification template.
* @param array Specifies optional image and CSS style attributes for the table tag. Supported keys are
* fixed_width, fixed_height, img_opts.
*/
function draw_jpeg_photo($server,$dn,$attr_name='jpegphoto',$index,$draw_delete_buttons=false,$options=array()) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
$fixed = array();
$fixed['width'] = isset($options['fixed_width']) ? $options['fixed_width'] : false;
$fixed['height'] = isset($options['fixed_height']) ? $options['fixed_height'] : false;
if (is_null($server))
$jpeg_data = $_SESSION['tmp'];
else
$jpeg_data = $server->getDNAttrValues($dn,null,LDAP_DEREF_NEVER,array($attr_name));
if (! isset($jpeg_data[$attr_name][$index]) || ! $jpeg_data[$attr_name][$index]) {
system_message(array(
'title'=>_('Unable to retrieve image'),
'body'=>sprintf(_('Could not fetch jpeg data from LDAP server for attribute [%s].'),
$attr_name),
'type'=>'warn'));
# This should atleast generate some text that says "Image not available"
printf('%s', $attr_name,_('Delete photo')); } /** * Return the list of available password types * * @todo Dynamically work this list out so we only present hashes that we can encrypt */ function password_types() { if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS')) debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs); return array( ''=>'clear', 'crypt'=>'crypt', 'md5'=>'md5', 'sha'=>'sha', 'smd5'=>'smd5', 'ssha'=>'ssha' ); } /** * Hashes a password and returns the hash based on the specified enc_type. * * @param string The password to hash in clear text. * @param string Standard LDAP encryption type which must be one of * crypt, ext_des, md5crypt, blowfish, md5, sha, smd5, ssha, or clear. * @return string The hashed password. */ function password_hash($password_clear,$enc_type) { if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS')) debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs); $enc_type = strtolower($enc_type); switch($enc_type) { case 'crypt': if ($_SESSION[APPCONFIG]->getValue('password', 'no_random_crypt_salt')) $new_value = sprintf('{CRYPT}%s',crypt($password_clear,substr($password_clear,0,2))); else $new_value = sprintf('{CRYPT}%s',crypt($password_clear,random_salt(2))); break; case 'md5': $new_value = sprintf('{MD5}%s',base64_encode(pack('H*',md5($password_clear)))); break; case 'sha': $new_value = sprintf('{SHA}%s',base64_encode(pack('H*',sha1($password_clear)))); break; case 'ssha': mt_srand((double)microtime()*1000000); $salt = mhash_keygen_s2k(MHASH_SHA1,$password_clear,substr(pack('h*',md5(mt_rand())),0,8),4); $new_value = sprintf('{SSHA}%s',base64_encode(mhash(MHASH_SHA1,$password_clear.$salt).$salt)); break; case 'smd5': mt_srand((double)microtime()*1000000); $salt = mhash_keygen_s2k(MHASH_MD5,$password_clear,substr(pack('h*',md5(mt_rand())),0,8),4); $new_value = sprintf('{SMD5}%s',base64_encode(mhash(MHASH_MD5,$password_clear.$salt).$salt)); break; case 'clear': default: $new_value = $password_clear; } return $new_value; } /** * Given a clear-text password and a hash, this function determines if the clear-text password * is the password that was used to generate the hash. This is handy to verify a user's password * when all that is given is the hash and a "guess". * @param String The hash. * @param String The password in clear text to test. * @return Boolean True if the clear password matches the hash, and false otherwise. */ function password_check($cryptedpassword,$plainpassword,$attribute='userpassword') { if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS')) debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs); if (in_array($attribute,array('sambalmpassword','sambantpassword'))) { $smb = new smbHash; switch($attribute) { case 'sambalmpassword': if (strcmp($smb->lmhash($plainpassword),$cryptedpassword) == 0) return true; else return false; case 'sambantpassword': if (strcmp($smb->nthash($plainpassword),$cryptedpassword) == 0) return true; else return false; } return false; } if (preg_match('/{([^}]+)}(.*)/',$cryptedpassword,$matches)) { $cryptedpassword = $matches[2]; $cypher = strtolower($matches[1]); } else { $cypher = null; } switch($cypher) { # SSHA crypted passwords case 'ssha': # Check php mhash support before using it if (function_exists('mhash')) { $hash = base64_decode($cryptedpassword); # OpenLDAP uses a 4 byte salt, SunDS uses an 8 byte salt - both from char 20. $salt = substr($hash,20); $new_hash = base64_encode(mhash(MHASH_SHA1,$plainpassword.$salt).$salt); if (strcmp($cryptedpassword,$new_hash) == 0) return true; else return false; } else { error(('Your PHP install does not have the mhash() function. Cannot do SHA hashes.'),'error','index.php'); } break; # Salted MD5 case 'smd5': # Check php mhash support before using it if (function_exists('mhash')) { $hash = base64_decode($cryptedpassword); $salt = substr($hash,16); $new_hash = base64_encode(mhash(MHASH_MD5,$plainpassword.$salt).$salt); if (strcmp($cryptedpassword,$new_hash) == 0) return true; else return false; } else { error(('Your PHP install does not have the mhash() function. Cannot do SHA hashes.'),'error','index.php'); } break; # SHA crypted passwords case 'sha': if (strcasecmp(password_hash($plainpassword,'sha'),'{SHA}'.$cryptedpassword) == 0) return true; else return false; break; # MD5 crypted passwords case 'md5': if( strcasecmp(password_hash($plainpassword,'md5'),'{MD5}'.$cryptedpassword) == 0) return true; else return false; break; # Crypt passwords case 'crypt': # Check if it's blowfish crypt if (preg_match('/^\\$2+/',$cryptedpassword)) { list($version,$rounds,$salt_hash) = explode('$',$cryptedpassword); if (crypt($plainpassword,'$'.$version.'$'.$rounds.'$'.$salt_hash) == $cryptedpassword) return true; else return false; } # Check if it's an crypted md5 elseif (strstr($cryptedpassword,'$1$')) { list($dummy,$type,$salt,$hash) = explode('$',$cryptedpassword); if (crypt($plainpassword,'$1$'.$salt) == $cryptedpassword) return true; else return false; } # Check if it's extended des crypt elseif (strstr($cryptedpassword,'_')) { if (crypt($plainpassword,$cryptedpassword) == $cryptedpassword) return true; else return false; } # Password is plain crypt else { if (crypt($plainpassword,$cryptedpassword) == $cryptedpassword) return true; else return false; } break; # No crypt is given assume plaintext passwords are used default: if ($plainpassword == $cryptedpassword) return true; else return false; } } /** * Detects password encryption type * * Returns crypto string listed in braces. If it is 'crypt' password, * returns crypto detected in password hash. Function should detect * md5crypt, blowfish and extended DES crypt. If function fails to detect * encryption type, it returns NULL. * @param string Hashed password * @return string */ function get_enc_type($user_password) { if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS')) debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs); # Capture the stuff in the { } to determine if this is crypt, md5, etc. $enc_type = null; if (preg_match('/{([^}]+)}/',$user_password,$enc_type)) $enc_type = strtolower($enc_type[1]); else return null; # Handle crypt types if (strcasecmp($enc_type,'crypt') == 0) { # No need to check for standard crypt, because enc_type is already equal to 'crypt'. if (preg_match('/{[^}]+}\\$1\\$+/',$user_password)) $enc_type = 'md5crypt'; elseif (preg_match('/{[^}]+}\\$2+/',$user_password)) $enc_type = 'blowfish'; elseif (preg_match('/{[^}]+}_+/',$user_password)) $enc_type = 'ext_des'; } return $enc_type; } /** * Draws an HTML browse button which, when clicked, pops up a DN chooser dialog. * @param string The name of the form element to which this chooser * dialog will publish the user's choice. The form element must be a member * of a form with the "name" or "id" attribute set in the form tag, and the element * must also define "name" or "id" for JavaScript to uniquely identify it. * Example $form_element values may include "creation_form.container" or * "edit_form.member_uid". See /templates/modification/default.php for example usage. * @param boolean (optional) If true, the function draws the localized text "choose" to the right of the button. */ function draw_chooser_link($form,$element,$include_choose_text=true,$rdn='none') { if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS')) debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs); $href = sprintf("javascript:dnChooserPopup('%s','%s','%s');",$form,$element,$rdn == 'none' ? '' : rawurlencode($rdn)); $title = _('Click to popup a dialog to select an entry (DN) graphically'); printf('
',$href,$title,IMGDIR);
if ($include_choose_text)
printf('%s',$href,$title,_('browse'));
}
/**
* Explode a DN into an array of its RDN parts.
*
* NOTE: When a multivalue RDN is passed to ldap_explode_dn, the results returns with 'value + value';
*
*
* Array (
* [0] => uid=ppratt
* [1] => ou=People
* [2] => dc=example
* [3] => dc=com
* )
*
*
* @param string The DN to explode.
* @param int (optional) Whether to include attribute names (see http://php.net/ldap_explode_dn for details)
* @return array An array of RDN parts of this format:
*/
function pla_explode_dn($dn,$with_attributes=0) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
global $CACHE;
if (isset($CACHE['explode'][$dn][$with_attributes])) {
if (DEBUG_ENABLED)
debug_log('Return CACHED result (%s) for (%s)',1,0,__FILE__,__LINE__,__METHOD__,
$CACHE['explode'][$dn][$with_attributes],$dn);
return $CACHE['explode'][$dn][$with_attributes];
}
$dn = addcslashes($dn,'<>+";');
# split the dn
$result[0] = ldap_explode_dn(dn_escape($dn),0);
$result[1] = ldap_explode_dn(dn_escape($dn),1);
if (! $result[$with_attributes]) {
if (DEBUG_ENABLED)
debug_log('Returning NULL - NO result.',1,0,__FILE__,__LINE__,__METHOD__);
return array();
}
# Remove our count value that ldap_explode_dn returns us.
unset($result[0]['count']);
unset($result[1]['count']);
# Record the forward and reverse entries in the cache.
foreach ($result as $key => $value) {
# translate hex code into ascii for display
$result[$key] = dn_unescape($value);
$CACHE['explode'][implode(',',$result[0])][$key] = $result[$key];
$CACHE['explode'][implode(',',array_reverse($result[0]))][$key] = array_reverse($result[$key]);
}
if (DEBUG_ENABLED)
debug_log('Returning (%s)',1,0,__FILE__,__LINE__,__METHOD__,$result[$with_attributes]);
return $result[$with_attributes];
}
/**
* Parse a DN and escape any special characters
*/
function dn_escape($dn) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
$olddn = $dn;
# Check if the RDN has a comma and escape it.
while (preg_match('/([^\\\\]),(\s*[^=]*\s*),/',$dn))
$dn = preg_replace('/([^\\\\]),(\s*[^=]*\s*),/','$1\\\\2C$2,',$dn);
$dn = preg_replace('/([^\\\\]),(\s*[^=]*\s*)([^,])$/','$1\\\\2C$2$3',$dn);
if (DEBUG_ENABLED)
debug_log('Returning (%s)',1,0,__FILE__,__LINE__,__METHOD__,$dn);
return $dn;
}
/**
* Parse a DN and unescape any special characters
*/
function dn_unescape($dn) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
if (is_array($dn)) {
$a = array();
foreach ($dn as $key => $rdn)
$a[$key] = preg_replace('/\\\([0-9A-Fa-f]{2})/e',"''.chr(hexdec('\\1')).''",$rdn);
return $a;
} else {
return preg_replace('/\\\([0-9A-Fa-f]{2})/e',"''.chr(hexdec('\\1')).''",$dn);
}
}
/**
* Fetches the URL for the specified item. This is a convenience function for
* fetching project HREFs (like bugs)
*
* @param string One of "open_bugs", "add_bug", "donate", or "add_rfe"
* (rfe = request for enhancement)
* @return string The URL to the requested item.
*/
function get_href($type,$extra_info='') {
$sf = 'https://sourceforge.net';
$pla = 'http://phpldapadmin.sourceforge.net';
$group_id = '61828';
$bug_atid = '498546';
$rfe_atid = '498549';
$forum_id = 'phpldapadmin-users';
switch($type) {
case 'add_bug':
return sprintf('%s/tracker/?func=add&group_id=%s&atid=%s',$sf,$group_id,$bug_atid);
case 'add_rfe':
return sprintf('%s/tracker/?func=add&group_id=%s&atid=%s',$sf,$group_id,$rfe_atid);
case 'credits':
return sprintf('%s/Credits',$pla);
case 'documentation':
return sprintf('%s/Documentation',$pla);
case 'donate':
return sprintf('%s/donate/index.php?group_id=%s',$sf,$group_id);
case 'forum':
return sprintf('%s/mailarchive/forum.php?forum_name=%s',$sf,$forum_id);
case 'logo':
if (! isset($_SERVER['HTTPS']) || strtolower($_SERVER['HTTPS']) != 'on')
$proto = 'http';
else
$proto = 'https';
return isset($_SESSION) && ! $_SESSION[APPCONFIG]->getValue('appearance','remoteurls') ? '' : sprintf('%s://sflogo.sourceforge.net/sflogo.php?group_id=%s&type=10',$proto,$group_id);
case 'sf':
return sprintf('%s/projects/phpldapadmin',$sf);
case 'web':
return sprintf('%s',$pla);
default:
return null;
}
}
/**
* Returns the current time as a double (including micro-seconds).
*
* @return double The current time in seconds since the beginning of the UNIX epoch (Midnight Jan. 1, 1970)
*/
function utime() {
$time = explode(' ',microtime());
$usec = (double)$time[0];
$sec = (double)$time[1];
return $sec + $usec;
}
/**
* Converts an array to a query-string with the option to exclude certain variables
* from the returned query string. This is convenient if callers want to convert the
* current GET query string or POST array into a string and replace certain
* variables with their own.
*
* @param array The associate array to convert whose form is such that the keys are the
* names of the variables and the values are said variables' values like this:
*
* Array (
* [server_id] = 0,
* [dn] = "dc=example,dc=com",
* [attr] = "sn"
* )
*
* This will produce a string like this: "server_id=0&dn=dc=example,dc=com&attr=sn"
* @param array (optional) An array of variables to exclude in the resulting string
* @return string The string created from the array.
*/
function array_to_query_string($array,$exclude_vars=array()) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
if (! is_array($array) || ! count($array))
return '';
$str = '';
$i = 0;
foreach ($array as $name => $val)
if (! in_array($name,$exclude_vars))
if (is_array($val))
foreach ($val as $v) {
if ($i++ > 0)
$str .= '&';
$str .= sprintf('%s[]=%s',rawurlencode($name),rawurlencode($v));
}
else {
if ($i++ > 0)
$str .= '&';
$str .= sprintf('%s=%s',rawurlencode($name),rawurlencode($val));
}
return $str;
}
/**
* Reverses a DN such that the top-level RDN is first and the bottom-level RDN is last
* For example:
*
* cn=Brigham,ou=People,dc=example,dc=com
*
* Becomes:
*
* dc=com,dc=example,ou=People,cn=Brigham
*
* This makes it possible to sort lists of DNs such that they are grouped by container.
*
* @param string The DN to reverse
* @return string The reversed DN
*
* @see pla_compare_dns
* @see pla_explode_dns
*/
function pla_reverse_dn($dn) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
return (implode(',',array_reverse(pla_explode_dn($dn))));
}
/**
* Attribute sorting
*/
function sortAttrs($a,$b) {
if ($a == $b)
return 0;
return strcasecmp($a->getName(),$b->getName());
}
/**
* Reads an array and returns the array values back in lower case
*
* @param array $array The array to convert the values to lowercase.
* @returns array Array with values converted to lowercase.
*/
function arrayLower($array) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
if (! is_array($array))
return $array;
$newarray = array();
foreach ($array as $key => $value)
$newarray[$key] = strtolower($value);
return $newarray;
}
/**
* Gets a DN string using the user-configured tree_display_format string to format it.
*/
function draw_formatted_dn($server,$entry) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
$dn = $entry->getDn();
$formats = $_SESSION[APPCONFIG]->getValue('appearance','tree_display_format');
foreach ($formats as $format) {
$has_none = false;
preg_match_all('/%[a-zA-Z_0-9]+/',$format,$tokens);
$tokens = $tokens[0];
if (DEBUG_ENABLED)
debug_log('The tokens are (%s)',1,0,__FILE__,__LINE__,__METHOD__,$tokens);
foreach ($tokens as $token) {
if (strcasecmp($token,'%dn') == 0)
$format = str_replace($token,pretty_print_dn($dn),$format);
elseif (strcasecmp($token,'%rdn') == 0)
$format = str_replace($token,pretty_print_dn($entry->getRDN()),$format);
elseif (strcasecmp($token,'%rdnvalue') == 0) {
$rdn = get_rdn($dn,0,true);
$rdn_value = explode('=',$rdn,2);
$rdn_value = $rdn_value[1];
$format = str_replace($token,$rdn_value,$format);
} else {
$attr_name = str_replace('%','',$token);
$attr_values = $server->getDNAttrValue($dn,$attr_name);
if (is_null($attr_values) || (count($attr_values) <= 0)) {
$display = '<'._('none').'>';
$has_none = true;
} elseif (is_array($attr_values))
$display = implode(', ',$attr_values);
else
$display = $attr_values;
$format = str_replace($token,$display,$format);
}
}
# If this format has all values available, use it. Otherwise, try the next one
if (!$has_none)
return $format;
}
return $format;
}
/**
* Server html select list
*/
function server_select_list($selected=null,$logged_on=false,$name='index',$isVisible=true,$js=null) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
$count = 0;
$server_menu_html = sprintf('';
if ($count > 1)
return $server_menu_html;
elseif ($count)
return sprintf('%s ',
$selected_server->getName(),$name,$selected_server->getIndex());
else
return '';
}
/**
* Converts a little-endian hex-number to one, that 'hexdec' can convert
*/
function littleEndian($hex) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
$result = '';
for ($x=strlen($hex)-2;$x>= 0;$x=$x-2)
$result .= substr($hex,$x,2);
return $result;
}
function binSIDtoText($binsid) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
$hex_sid = bin2hex($binsid);
$rev = hexdec(substr($hex_sid,0,2)); // Get revision-part of SID
$subcount = hexdec(substr($hex_sid,2,2)); // Get count of sub-auth entries
$auth = hexdec(substr($hex_sid,4,12)); // SECURITY_NT_AUTHORITY
$result = "$rev-$auth";
for ($x=0;$x<$subcount;$x++) {
$subauth[$x] = hexdec(littleEndian(substr($hex_sid,16+($x*8),8))); // get all SECURITY_NT_AUTHORITY
$result .= sprintf('-%s',$subauth[$x]);
}
return $result;
}
/**
* Query LDAP and return a hash.
*
* @param string The base DN to use.
* @param string LDAP Query filter.
* @param string LDAP attribute to use as key.
* @param array Attributes to use as values.
* @param boolean Specify false to not sort results by DN
* or true to have the returned array sorted by DN (uses ksort)
* or an array of attribute names to sort by attribute values
* @return array Array of values keyed by $key.
*/
function return_ldap_hash($base,$filter,$key,$attrs,$sort=true) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
$server = $_SESSION[APPCONFIG]->getServer(get_request('server_id','REQUEST'));
$key = strtolower($key);
$query = array();
$query['base'] = $base;
$query['filter'] = $filter;
$query['attrs'] = $attrs;
$search = $server->query($query,null);
$results = array();
foreach ($search as $dn => $values)
if (isset($values[$key]))
if (is_array($values[$key]))
foreach ($values[$key] as $i => $k)
foreach ($attrs as $attr) {
$lattr = strtolower($attr);
if (isset($values[$lattr])) {
$v = '';
if (is_array($values[$lattr]) && isset($values[$lattr][$i]))
$v = $values[$lattr][$i];
if (is_string($v) && (strlen($v) > 0))
$results[$k][$attr] = $v;
}
}
else
foreach ($attrs as $attr) {
$lattr = strtolower($attr);
if (isset($values[$lattr]))
$results[$values[$key]][$attr] = $values[$lattr];
}
if ($sort)
masort($results,is_array($sort) ? implode(',',$sort) : 'dn');
return $results;
}
/**
* This function returns a string automatically generated
* based on the criteria defined in the array $criteria in config.php
*/
function password_generate() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
$no_use_similiar = ! $_SESSION[APPCONFIG]->getValue('password','use_similar');
$lowercase = $_SESSION[APPCONFIG]->getValue('password','lowercase');
$uppercase = $_SESSION[APPCONFIG]->getValue('password','uppercase');
$digits = $_SESSION[APPCONFIG]->getValue('password','numbers');
$punctuation = $_SESSION[APPCONFIG]->getValue('password','punctuation');
$length = $_SESSION[APPCONFIG]->getValue('password','length');
$outarray = array();
if ($no_use_similiar) {
$raw_lower = 'a b c d e f g h k m n p q r s t u v w x y z';
$raw_numbers = '2 3 4 5 6 7 8 9';
$raw_punc = '# $ % ^ & * ( ) _ - + = . , [ ] { } :';
} else {
$raw_lower = 'a b c d e f g h i j k l m n o p q r s t u v w x y z';
$raw_numbers = '1 2 3 4 5 6 7 8 9 0';
$raw_punc = '# $ % ^ & * ( ) _ - + = . , [ ] { } : |';
}
$llower = explode(' ',$raw_lower);
shuffle($llower);
$lupper = explode(' ',strtoupper($raw_lower));
shuffle($lupper);
$numbers = explode(' ',$raw_numbers);
shuffle($numbers);
$punc = explode(' ',$raw_punc);
shuffle($punc);
if ($lowercase > 0)
$outarray = array_merge($outarray,a_array_rand($llower,$lowercase));
if ($uppercase > 0)
$outarray = array_merge($outarray,a_array_rand($lupper,$uppercase));
if ($digits > 0)
$outarray = array_merge($outarray,a_array_rand($numbers,$digits));
if ($punctuation > 0)
$outarray = array_merge($outarray,a_array_rand($punc,$punctuation));
$num_spec = $lowercase + $uppercase + $digits + $punctuation;
if ($num_spec < $length) {
$leftover = array();
if ($lowercase > 0)
$leftover = array_merge($leftover,$llower);
if ($uppercase > 0)
$leftover = array_merge($leftover,$lupper);
if ($digits > 0)
$leftover = array_merge($leftover,$numbers);
if ($punctuation > 0)
$leftover = array_merge($leftover,$punc);
if (count($leftover) == 0)
$leftover = array_merge($leftover,$llower,$lupper,$numbers,$punc);
shuffle($leftover);
$outarray = array_merge($outarray,a_array_rand($leftover,$length-$num_spec));
}
shuffle($outarray);
$return = implode('',$outarray);
if (DEBUG_ENABLED)
debug_log('Returning (%s)',1,0,__FILE__,__LINE__,__METHOD__,$return);
return $return;
}
/**
* This function returns an array of $num_req values
* randomly picked from the $input array
*
* @param array Array of values
* @param integer Number of values in returned array
* @return string The padded string
*/
function a_array_rand($input,$num_req) {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
if (count($input) == 0)
return array();
if ($num_req < 1)
return array();
$return = array();
if ($num_req > count($input)) {
for($i = 0; $i < $num_req; $i++) {
$idx = array_rand($input,1);
$return[] = $input[$idx];
}
} else {
$idxlist = array_rand($input,$num_req);
if ($num_req == 1)
$idxlist = array($idxlist);
for($i = 0; $i < count($idxlist); $i++)
$return[] = $input[$idxlist[$i]];
}
if (DEBUG_ENABLED)
debug_log('Returning (%s)',1,0,__FILE__,__LINE__,__METHOD__,$return);
return $return;
}
/**
* This is for Opera. By putting "random junk" in the query string, it thinks
* that it does not have a cached version of the page, and will thus
* fetch the page rather than display the cached version
*/
function random_junk() {
$time = gettimeofday();
return md5(strtotime('now').$time['usec']);
}
/**
* Returns a HTML id that can be used in the URL after the #.
*
* @param string The DN to pretty-print.
* @return string
*/
function htmlid($sid,$dn) {
return sprintf('SID%s:%s',$sid,preg_replace('/[\ =,]/','_',$dn));
}
/**
* Is PLA configured for AJAX display
*/
function isAjaxEnabled() {
if (DEBUG_ENABLED && (($fargs=func_get_args())||$fargs='NOARGS'))
debug_log('Entered (%%)',1,0,__FILE__,__LINE__,__METHOD__,$fargs);
if (isset($_SESSION[APPCONFIG]))
return ($_SESSION[APPCONFIG]->getValue('appearance','tree') == 'AJAXTree');
else
return false;
}
?>