LDAPAccountManager/lam/lib/ldap.inc

466 lines
14 KiB
PHP
Raw Normal View History

<?php
/*
$Id$
This code is part of LDAP Account Manager (http://www.sourceforge.net/projects/lam)
Copyright (C) 2003 Roland Gruber
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
2003-04-27 16:29:53 +00:00
// ldap.inc provides basic functions to connect to the OpenLDAP server.
2003-04-23 19:13:55 +00:00
include_once("config.inc");
2003-08-08 15:35:59 +00:00
2003-10-04 13:26:37 +00:00
// returns the hash value of a plain text password
// the hash algorithm depends on the configuration file
// $password: the password string
// $enabled: marks the hash as enabled/disabled (e.g. by prefixing "!")
function pwd_hash($password, $enabled=true) {
// check for empty password
if (! $password || ($password == "")) {
if ($enabled) return "";
else return "!";
}
2003-10-04 13:26:37 +00:00
// hash password with algorithm from config file
$hash = "";
switch ($_SESSION['config']->get_pwdhash()) {
case 'CRYPT':
$hash = "{CRYPT}" . crypt($password);
2003-10-04 13:26:37 +00:00
break;
case 'MD5':
$hash = "{MD5}" . base64_encode(mHash(MHASH_MD5, $password));
break;
case 'SMD5':
$salt = mhash_keygen_s2k(MHASH_MD5, $password, substr(pack("h*", md5(mt_rand())), 0, 8), 4);
$hash = base64_encode(mHash(MHASH_SMD5, $password . $salt) . $salt);
$hash = "{SMD5}" . $hash;
break;
case 'SHA':
$hash = base64_encode(mHash(MHASH_SHA1, $password));
$hash = "{SHA}" . $hash;
break;
case 'SSHA':
$salt = mhash_keygen_s2k(MHASH_SHA1, $password, substr(pack("h*", md5(mt_rand())), 0, 8), 4);
$hash = base64_encode(mHash(MHASH_SHA1, $password . $salt) . $salt);
$hash = "{SSHA}" . $hash;
break;
case 'PLAIN':
$hash = $password;
break;
2003-10-04 13:26:37 +00:00
// use SSHA if the setting is invalid
default:
$salt = mhash_keygen_s2k(MHASH_SHA1, $password, substr(pack("h*", md5(mt_rand())), 0, 8), 4);
$hash = base64_encode(mHash(MHASH_SHA1, $password . $salt) . $salt);
$hash = "{SSHA}" . $hash;
break;
}
// enable/disable password
if (! $enabled) return "!" . $hash;
else return $hash;
}
// marks an password hash as enabled
// and returns the new hash string
2003-10-11 15:43:47 +00:00
// hash: hash value to enable
2003-10-04 13:26:37 +00:00
function pwd_enable($hash) {
// check if password is disabled
if ((substr($hash, 0, 1) == "!") || ((substr($hash, 0, 1) == "*"))) {
return substr($hash, 1, strlen($hash));
}
else {
return $hash;
}
}
// marks an password hash as disabled
// and returns the new hash string
2003-10-11 15:43:47 +00:00
// hash: hash value to disable
2003-10-04 13:26:37 +00:00
function pwd_disable($hash) {
// check if already disabled
if ((substr($hash, 0, 1) == "!") || ((substr($hash, 0, 1) == "*"))) {
return $hash;
}
else {
return "!" . $hash;
}
}
// checks if a password hash is enabled/disabled
// returns true if the password is marked as enabled
function pwd_is_enabled($hash) {
// disabled passwords have a "!" or "*" at the beginning
if ((substr($hash, 0, 1) == "!") || ((substr($hash, 0, 1) == "*"))) return false;
else return true;
}
2003-07-26 12:37:31 +00:00
// manages connection to LDAP and several helper functions
class Ldap{
2003-07-30 20:46:07 +00:00
// object of Config to access preferences
var $conf;
// server handle
var $server;
// LDAP username and password used for bind
var $username;
var $password;
// Arrays that contain LDAP attributes and their descriptions which are translated
var $ldapUserAttributes;
var $ldapGroupAttributes;
var $ldapHostAttributes;
// array with all objectClass strings from the LDAP server
var $objectClasses;
// capabilities of the LDAP server
var $supports_unix_hosts=false; // host attribute in inetOrgPerson
var $supports_samba2_schema=false; // objectClass sambaAccount
var $supports_samba3_schema=false; // objectClass sambaSamAccount
2003-10-16 18:49:25 +00:00
// random number (changes on every page request)
var $rand;
2003-07-30 20:46:07 +00:00
// constructor
2003-10-11 15:43:47 +00:00
// $config: an object of Config (../config/config.php)
2003-07-30 20:46:07 +00:00
function Ldap($config) {
2003-08-08 15:35:59 +00:00
setlanguage();
2003-07-30 20:46:07 +00:00
if (is_object($config)) $this->conf = $config;
else return false;
// construct arrays with known LDAP attributes
$this->ldapUserAttributes = array (
"uid" => _("User ID"),
"uidnumber" => _("UID number"),
"gidnumber" => _("GID number"),
2003-07-30 20:46:07 +00:00
"cn" => _("Username"),
"host" => _("Allowed hosts"),
"givenname" => _("First name"),
2003-07-30 20:46:07 +00:00
"sn" => _("Last name"),
"homedirectory" => _("Home directory"),
"loginshell" => _("Login shell"),
2003-07-30 20:46:07 +00:00
"mail" => _("E-Mail"),
"gecos" => _("Description")
);
$this->ldapGroupAttributes = array (
"cn" => _("Group name"),
"gidnumber" => _("GID number"),
"memberuid" => _("Group members"),
2003-07-30 20:46:07 +00:00
"member" => _("Group member DNs"),
"description" => _("Group description")
);
$this->ldapHostAttributes = array (
"uid" => _("Host username"),
"cn" => _("Host name"),
"rid" => _("RID (Windows UID)"),
"description" => _("Host description"),
"uidnumber" => _("UID number"),
"gidnumber" => _("GID number")
2003-07-30 20:46:07 +00:00
);
2003-10-16 18:49:25 +00:00
mt_srand((double)microtime()*1000000);
$this->rand = mt_rand();
2003-07-30 20:46:07 +00:00
return true;
}
// connects to the server using the given username and password
// if connect succeeds the server handle is returned
2003-10-11 15:43:47 +00:00
// $user: user name
// $passwd: password
2003-07-30 20:46:07 +00:00
function connect($user, $passwd) {
// close any prior connection
@$this->close();
// do not allow anonymous bind
if ((!$user)||($user == "")||(!$passwd)) {
return false;
}
// save password und username encrypted
$this->encrypt($user, $passwd);
$this->server = @ldap_connect($this->conf->get_ServerURL());
2003-07-30 20:46:07 +00:00
if ($this->server) {
// use LDAPv3
ldap_set_option($this->server, LDAP_OPT_PROTOCOL_VERSION, 3);
2003-08-16 08:30:05 +00:00
// start TLS if possible
if (function_exists('ldap_start_tls')) {
@ldap_start_tls($this->server);
// connect without TLS if it failed
if (ldap_errno($this->server) > 0) {
@ldap_close($this->server);
$this->server = @ldap_connect($this->conf->get_ServerURL());
ldap_set_option($this->server, LDAP_OPT_PROTOCOL_VERSION, 3);
}
}
2003-07-30 20:46:07 +00:00
$bind = @ldap_bind($this->server, $user, $passwd);
if ($bind) {
// read objectClasses from server and update capabilities if needed
if (! $this->objectClasses) {
$this->updateClasses();
$this->updateCapabilities();
}
2003-07-30 20:46:07 +00:00
// return server handle
return $this->server;
}
}
}
2003-07-26 12:37:31 +00:00
// closes connection to server
function close() {
@ldap_close($this->server);
2003-06-08 18:58:01 +00:00
}
2003-07-26 12:37:31 +00:00
// searches LDAP for a specific user name
// and returns its DN entry
2003-10-11 15:43:47 +00:00
// $name: user name
2003-07-26 12:37:31 +00:00
function search_username($name) {
$filter = "(uid=$name)";
2003-07-26 12:37:31 +00:00
$attrs = array();
$sr = @ldap_search($this->server, $this->conf->get_UserSuffix(), $filter, $attrs);
if ($sr) {
$info = ldap_get_entries($this->server, $sr);
// return only first DN entry
$ret = $info[0]["dn"];
ldap_free_result($sr);
return $ret;
}
}
// returns an array with all organizational units under the given suffix
2003-10-11 15:43:47 +00:00
// $suffix: search suffix
function search_units($suffix) {
2003-07-26 12:37:31 +00:00
$ret = array();
$sr = @ldap_search($_SESSION["ldap"]->server(), $suffix, "objectClass=organizationalunit", array("DN"));
if ($sr) {
$units = ldap_get_entries($_SESSION["ldap"]->server, $sr);
// extract Dns
for ($i = 0; $i < sizeof($units); $i++) {
if ($units[$i]['dn']) $ret[] = $units[$i]['dn'];
}
2003-06-28 09:30:21 +00:00
}
2003-07-26 12:37:31 +00:00
// add root suffix if needed
$found = false;
2003-07-26 12:37:31 +00:00
for ($i = 0; $i < sizeof($ret); $i++) { // search suffix case-intensitive
if (strtolower($suffix) == strtolower($ret[$i])) {
$found = true;
break;
}
}
2003-07-26 12:37:31 +00:00
if (!$found) {
$ret[] = $suffix;
}
usort($ret, array($this,"cmp_array"));
return $ret;
}
2003-07-26 12:37:31 +00:00
// returns an array with all Samba 3 domain entries under the given suffix
2003-10-11 15:43:47 +00:00
// $suffix: search suffix
2003-07-26 12:37:31 +00:00
function search_domains($suffix) {
$ret = array();
$attr = array("DN", "sambaDomainName", "sambaSID", "sambaNextRid", "sambaNextGroupRid",
"sambaNextUserRid", "sambaAlgorithmicRidBase");
2003-08-07 12:00:30 +00:00
$sr = @ldap_search($_SESSION["ldap"]->server(), $suffix, "objectClass=sambaDomain", $attr);
2003-07-26 12:37:31 +00:00
if ($sr) {
$units = ldap_get_entries($_SESSION["ldap"]->server, $sr);
// delete count entry
array_shift($units);
// extract attributes
for ($i = 0; $i < sizeof($units); $i++) {
$ret[$i] = new samba3domain();
$ret[$i]->dn = $units[$i]['dn'];
$ret[$i]->name = $units[$i]['sambadomainname'][0];
$ret[$i]->SID = $units[$i]['sambasid'][0];
$ret[$i]->nextRID = $units[$i]['sambanextrid'][0];
$ret[$i]->nextGroupRID = $units[$i]['sambanextgrouprid'][0];
$ret[$i]->nextUserRID = $units[$i]['sambanextuserrid'][0];
if (isset($units[$i]['sambaalgorithmicridbase'][0])) $ret[$i]->RIDbase = $units[$i]['sambaalgorithmicridbase'][0];
}
// sort array by domain name
usort($ret, array($this,"cmp_domain"));
}
return $ret;
}
// reads the array of objectClasses from the LDAP server
function updateClasses() {
// read from default cn
$sr = @ldap_read($this->server, 'cn=subschema', '(objectClass=*)', array('objectclasses'));
// if default was not correct check different cn
if (!$sr) $sr = @ldap_read($this->server, 'cn=schema', '(objectClass=*)', array('objectclasses'));
if ($sr) {
// get search result and save it
$info = @ldap_get_entries($this->server,$sr);
if ($info) {
$this->objectClasses = $info[0]['objectclasses'];
array_shift($this->objectClasses);
return true;
}
}
// if search failed save empty result
$this->objectClasses = array();
}
// updates the capabilities values (var $supports_*)
function updateCapabilities() {
for ($i = 0; $i < sizeof($this->objectClasses); $i++) {
$line = $this->objectClasses[$i];
// search keywords
if (strpos($line, "NAME 'inetOrgPerson'") && strpos($line, " host ")) $this->supports_unix_hosts = true;
if (strpos($line, "NAME 'sambaAccount'")) $this->supports_samba2_schema = true;
if (strpos($line, "NAME 'sambaSamAccount'")) $this->supports_samba3_schema = true;
}
}
2003-07-26 12:37:31 +00:00
// returns the LDAP connection handle
function server() {
return $this->server;
}
2003-07-26 12:37:31 +00:00
// closes connection to LDAP server before serialization
function __sleep() {
$this->close();
// define which attributes to save
return array("conf", "username", "password", "ldapUserAttributes", "ldapGroupAttributes",
"ldapHostAttributes", "objectClasses", "supports_unix_hosts", "supports_samba2_schema",
2003-10-16 18:49:25 +00:00
"supports_samba3_schema", "rand");
2003-07-26 12:37:31 +00:00
}
2003-07-26 12:37:31 +00:00
// reconnects to LDAP server when deserialized
function __wakeup() {
$data = $this->decrypt();
$this->connect($data[0], $data[1]);
2003-10-16 18:49:25 +00:00
// change random number
mt_srand($this->rand + (microtime() * 1000000));
$this->rand = mt_rand();
2003-07-26 12:37:31 +00:00
}
2003-07-02 17:58:55 +00:00
// encrypts username and password
2003-10-11 15:43:47 +00:00
// $username: LDAP user name
// $password: LDAP password
2003-07-02 17:58:55 +00:00
function encrypt($username, $password) {
// read key and iv from cookie
$iv = base64_decode($_COOKIE["IV"]);
$key = base64_decode($_COOKIE["Key"]);
// encrypt username and password
$this->username = base64_encode(mcrypt_encrypt(MCRYPT_RIJNDAEL_256, $key, $username, MCRYPT_MODE_ECB, $iv));
$this->password = base64_encode(mcrypt_encrypt(MCRYPT_RIJNDAEL_256, $key, $password, MCRYPT_MODE_ECB, $iv));
}
2003-07-02 17:58:55 +00:00
// decrypts username and password
2003-10-11 15:43:47 +00:00
// returns an array
// return[0]: user name
// return[1]: password
2003-07-02 17:58:55 +00:00
function decrypt() {
// read key and iv from cookie
$iv = base64_decode($_COOKIE["IV"]);
$key = base64_decode($_COOKIE["Key"]);
// decrypt username and password
$username = mcrypt_decrypt(MCRYPT_RIJNDAEL_256, $key, base64_decode($this->username), MCRYPT_MODE_ECB, $iv);
$password = mcrypt_decrypt(MCRYPT_RIJNDAEL_256, $key, base64_decode($this->password), MCRYPT_MODE_ECB, $iv);
$ret = array($username, $password);
$ret[0] = str_replace(chr(00), "", $ret[0]);
$ret[1] = str_replace(chr(00), "", $ret[1]);
return $ret;
}
2003-07-02 17:58:55 +00:00
// closes connection to LDAP server and deletes encrypted username/password
function destroy() {
$this->close();
$this->username="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
$this->password="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
}
2003-07-02 17:58:55 +00:00
// returns an array that contains LDAP attribute names and their description
function attributeUserArray() {
return $this->ldapUserAttributes;
}
2003-07-02 17:58:55 +00:00
// returns an array that contains LDAP attribute names and their description
function attributeGroupArray() {
return $this->ldapGroupAttributes;
}
// returns an array that contains LDAP attribute names and their description
function attributeHostArray() {
return $this->ldapHostAttributes;
}
2003-07-02 17:58:55 +00:00
// helper function to sort the unit DNs
function cmp_array($a, $b) {
// split DNs
$array_a = explode(",", $a);
$array_b = explode(",", $b);
$len_a = sizeof($array_a);
$len_b = sizeof($array_b);
// check how many parts to compare
$len = min($len_a, $len_b);
// compare from last part on
for ($i = 0; $i < $len; $i++) {
// get parts to compare
$part_a = strtolower($array_a[$len_a - $i - 1]);
$part_b = strtolower($array_b[$len_b - $i - 1]);
// compare parts
if ($part_a == $part_b) { // part is identical
if ($i == ($len - 1)) {
if ($len_a > $len_b) return 1;
elseif ($len_a < $len_b) return -1;
else return 0; // DNs are identical
}
}
elseif ($part_a == max($part_a, $part_b)) return 1;
else return -1;
}
}
2003-07-26 12:37:31 +00:00
// helper function to sort the domains
function cmp_domain($a, $b) {
if ($a->name == $b->name) return 0;
elseif ($a->name == max($a->name, $b->name)) return 1;
else return -1;
}
}
2003-07-26 12:37:31 +00:00
// represents a Samba 3 domain entry
class samba3domain {
// DN
var $dn;
// domain name
var $name;
// domain SID
var $SID;
// next RID
var $nextRID;
// next user RID
var $nextUserRID;
// next group RID
var $nextGroupRID;
// RID base to calculate RIDs, default 1000
var $RIDbase=1000;
}
?>