2007-03-29 18:10:14 +02:00
|
|
|
|
<?php
|
|
|
|
|
/*******************************************************************************
|
|
|
|
|
* Copyright (C) 2007 Easter-eggs
|
2021-04-13 18:04:19 +02:00
|
|
|
|
* https://ldapsaisie.org
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
|
|
|
|
* Author: See AUTHORS file in top-level directory.
|
|
|
|
|
*
|
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
|
* modify it under the terms of the GNU General Public License version 2
|
|
|
|
|
* as published by the Free Software Foundation.
|
|
|
|
|
*
|
|
|
|
|
* 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.
|
|
|
|
|
|
|
|
|
|
******************************************************************************/
|
|
|
|
|
|
2020-05-08 15:16:24 +02:00
|
|
|
|
LSsession :: loadLSclass('LSlog_staticLoggerClass');
|
|
|
|
|
|
2007-03-29 18:10:14 +02:00
|
|
|
|
/**
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* Gestion de l'accès à l'annaire Ldap
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* Cette classe gère l'accès à l'annuaire ldap en s'appuyant sur PEAR :: Net_LDAP2
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
|
|
|
|
* @author Benjamin Renard <brenard@easter-eggs.com>
|
|
|
|
|
*/
|
2020-05-08 15:16:24 +02:00
|
|
|
|
class LSldap extends LSlog_staticLoggerClass {
|
2007-03-29 18:10:14 +02:00
|
|
|
|
|
2009-01-25 15:37:03 +01:00
|
|
|
|
private static $config;
|
|
|
|
|
private static $cnx = NULL;
|
2020-04-29 15:54:21 +02:00
|
|
|
|
|
2007-03-29 18:10:14 +02:00
|
|
|
|
/**
|
2020-04-29 15:54:21 +02:00
|
|
|
|
* D<EFBFBD>fini la configuration
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* Cette methode définis la configuration de l'accès à l'annuaire
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
|
|
|
|
* @author Benjamin Renard <brenard@easter-eggs.com>
|
|
|
|
|
*
|
2014-11-18 13:16:38 +01:00
|
|
|
|
* @param[in] $config array Tableau de configuration au format Net_LDAP2
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
|
|
|
|
* @retval void
|
|
|
|
|
*/
|
2019-03-12 11:42:53 +01:00
|
|
|
|
public static function setConfig ($config) {
|
2009-01-25 15:37:03 +01:00
|
|
|
|
self :: $config = $config;
|
2007-03-29 18:10:14 +02:00
|
|
|
|
}
|
2020-04-29 15:54:21 +02:00
|
|
|
|
|
2007-03-29 18:10:14 +02:00
|
|
|
|
/**
|
2014-11-18 13:16:38 +01:00
|
|
|
|
* Connect to LDAP server
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
2014-11-18 13:16:38 +01:00
|
|
|
|
* This method establish connection to LDAP server
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
|
|
|
|
* @author Benjamin Renard <brenard@easter-eggs.com>
|
2020-04-29 15:54:21 +02:00
|
|
|
|
*
|
2014-11-18 13:16:38 +01:00
|
|
|
|
* @param[in] $config array LDAP configuration array in format of Net_LDAP2
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
2014-11-18 13:16:38 +01:00
|
|
|
|
* @retval boolean true if connected, false instead
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*/
|
2009-01-25 15:37:03 +01:00
|
|
|
|
public static function connect($config = null) {
|
|
|
|
|
if ($config) {
|
|
|
|
|
self :: setConfig($config);
|
|
|
|
|
}
|
|
|
|
|
self :: $cnx = Net_LDAP2::connect(self :: $config);
|
|
|
|
|
if (Net_LDAP2::isError(self :: $cnx)) {
|
|
|
|
|
LSerror :: addErrorCode('LSldap_01',self :: $cnx -> getMessage());
|
|
|
|
|
self :: $cnx = NULL;
|
2007-03-29 18:10:14 +02:00
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
return true;
|
|
|
|
|
}
|
2020-04-29 15:54:21 +02:00
|
|
|
|
|
2014-11-18 13:16:38 +01:00
|
|
|
|
/**
|
|
|
|
|
* Reconnect (or connect) with other credentials
|
|
|
|
|
*
|
|
|
|
|
* @author Benjamin Renard <brenard@easter-eggs.com>
|
|
|
|
|
*
|
|
|
|
|
* @param[in] $dn string Bind DN
|
|
|
|
|
* @param[in] $pwd array Bind password
|
|
|
|
|
* @param[in] $config array LDAP configuration array in format of Net_LDAP2
|
2021-02-17 11:45:39 +01:00
|
|
|
|
* (optional, default: keep current)
|
2014-11-18 13:16:38 +01:00
|
|
|
|
*
|
|
|
|
|
* @retval boolean true if connected, false instead
|
|
|
|
|
*/
|
2021-02-17 11:45:39 +01:00
|
|
|
|
public static function reconnectAs($dn, $pwd, $config=null) {
|
2014-11-18 13:16:38 +01:00
|
|
|
|
if ($config) {
|
|
|
|
|
self :: setConfig($config);
|
|
|
|
|
}
|
2021-02-17 11:45:39 +01:00
|
|
|
|
if (self :: $cnx) {
|
|
|
|
|
self :: $cnx -> done();
|
|
|
|
|
}
|
|
|
|
|
$config = self :: $config;
|
|
|
|
|
$config['binddn'] = $dn;
|
|
|
|
|
$config['bindpw'] = $pwd;
|
|
|
|
|
self :: $cnx = Net_LDAP2::connect($config);
|
|
|
|
|
if (Net_LDAP2::isError(self :: $cnx)) {
|
|
|
|
|
LSerror :: addErrorCode('LSldap_01', self :: $cnx -> getMessage());
|
|
|
|
|
self :: $cnx = NULL;
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
return true;
|
2014-11-18 13:16:38 +01:00
|
|
|
|
}
|
|
|
|
|
|
2007-03-29 18:10:14 +02:00
|
|
|
|
/**
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* Déconnection
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* Cette methode clos la connexion à l'annuaire Ldap
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
|
|
|
|
* @author Benjamin Renard <brenard@easter-eggs.com>
|
|
|
|
|
*
|
|
|
|
|
* @retval void
|
|
|
|
|
*/
|
2009-01-25 15:37:03 +01:00
|
|
|
|
public static function close() {
|
|
|
|
|
self :: $cnx -> done();
|
2007-03-29 18:10:14 +02:00
|
|
|
|
}
|
2020-04-29 15:54:21 +02:00
|
|
|
|
|
2007-03-29 18:10:14 +02:00
|
|
|
|
/**
|
|
|
|
|
* Recherche dans l'annuaire
|
|
|
|
|
*
|
|
|
|
|
* Cette methode effectue une recherche dans l'annuaire et retourne le resultat
|
|
|
|
|
* de celle-ci sous la forme d'un tableau.
|
|
|
|
|
*
|
|
|
|
|
* @author Benjamin Renard <brenard@easter-eggs.com>
|
|
|
|
|
*
|
|
|
|
|
* @param[in] $filter [<b>required</b>] string Filtre de recherche Ldap
|
|
|
|
|
* @param[in] $basedn string DN de base pour la recherche
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* @param[in] $params array Paramètres de recherche au format Net_LDAP2::search()
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
2008-04-25 15:48:12 +02:00
|
|
|
|
* @see Net_LDAP2::search()
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
|
|
|
|
* @retval array Retourne un tableau associatif contenant :
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* - ['dn'] : le DN de l'entré
|
|
|
|
|
* - ['attrs'] : tableau associatif contenant les attributs (clé)
|
2007-03-29 18:10:14 +02:00
|
|
|
|
* et leur valeur (valeur).
|
|
|
|
|
*/
|
2020-12-22 19:43:50 +01:00
|
|
|
|
public static function search($filter, $basedn=NULL, $params=array()) {
|
|
|
|
|
$filterstr = (is_a($filter, 'Net_LDAP2_Filter')?$filter->as_string():$filter);
|
|
|
|
|
if (is_empty($basedn)) {
|
|
|
|
|
$basedn = self :: getConfig('basedn');
|
|
|
|
|
if (is_empty($basedn)) {
|
|
|
|
|
LSerror :: addErrorCode('LSldap_08');
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
self :: log_debug("LSldap::search($filterstr): empty basedn provided, use basedn from configuration: ".varDump($basedn));
|
|
|
|
|
}
|
|
|
|
|
self :: log_trace("LSldap::search($filterstr, $basedn): run search with parameters: ".varDump($params));
|
|
|
|
|
$ret = self :: $cnx -> search($basedn, $filter, $params);
|
2008-04-25 15:48:12 +02:00
|
|
|
|
if (Net_LDAP2::isError($ret)) {
|
2020-12-22 19:43:50 +01:00
|
|
|
|
LSerror :: addErrorCode('LSldap_02', $ret -> getMessage());
|
2007-03-29 18:10:14 +02:00
|
|
|
|
return;
|
|
|
|
|
}
|
2020-12-22 19:43:50 +01:00
|
|
|
|
self :: log_debug("LSldap::search($filterstr, $basedn) : return ".$ret->count()." objet(s)");
|
|
|
|
|
$retInfos = array();
|
2012-08-02 15:51:49 +02:00
|
|
|
|
foreach($ret as $dn => $entry) {
|
2012-08-02 15:26:02 +02:00
|
|
|
|
if (!$entry instanceof Net_LDAP2_Entry) {
|
2020-12-22 19:43:50 +01:00
|
|
|
|
LSerror :: addErrorCode('LSldap_02', "LDAP search return an ".get_class($entry).". object");
|
2012-08-02 15:26:02 +02:00
|
|
|
|
continue;
|
|
|
|
|
}
|
2020-12-22 19:43:50 +01:00
|
|
|
|
$retInfos[] = array(
|
|
|
|
|
'dn' => $dn,
|
|
|
|
|
'attrs' => $entry -> getValues()
|
|
|
|
|
);
|
2007-03-29 18:10:14 +02:00
|
|
|
|
}
|
|
|
|
|
return $retInfos;
|
|
|
|
|
}
|
2020-04-29 15:54:21 +02:00
|
|
|
|
|
2007-03-29 18:10:14 +02:00
|
|
|
|
/**
|
|
|
|
|
* Compte le nombre de retour d'une recherche dans l'annuaire
|
|
|
|
|
*
|
|
|
|
|
* Cette methode effectue une recherche dans l'annuaire et retourne le nombre
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* d'entrés trouvées.
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
|
|
|
|
* @author Benjamin Renard <brenard@easter-eggs.com>
|
|
|
|
|
*
|
|
|
|
|
* @param[in] $filter [<b>required</b>] string Filtre de recherche Ldap
|
|
|
|
|
* @param[in] $basedn string DN de base pour la recherche
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* @param[in] $params array Paramètres de recherche au format Net_LDAP2::search()
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
2008-04-25 15:48:12 +02:00
|
|
|
|
* @see Net_LDAP2::search()
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* @retval numeric Le nombre d'entré trouvées
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*/
|
2020-12-22 19:43:50 +01:00
|
|
|
|
public static function getNumberResult($filter, $basedn=NULL, $params=array()) {
|
2007-03-29 18:10:14 +02:00
|
|
|
|
if (empty($filter))
|
2020-12-22 19:43:50 +01:00
|
|
|
|
$filter = NULL;
|
|
|
|
|
$filterstr = (is_a($filter, 'Net_LDAP2_Filter')?$filter->as_string():$filter);
|
|
|
|
|
if (is_empty($basedn)) {
|
|
|
|
|
$basedn = self :: getConfig('basedn');
|
|
|
|
|
if (is_empty($basedn)) {
|
|
|
|
|
LSerror :: addErrorCode('LSldap_08');
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
self :: log_debug("LSldap::getNumberResult($filterstr): empty basedn provided, use basedn from configuration: ".varDump($basedn));
|
|
|
|
|
}
|
|
|
|
|
self :: log_trace("LSldap::getNumberResult($filterstr, $basedn): run search with parameters: ".varDump($params));
|
|
|
|
|
$ret = self :: $cnx -> search($basedn, $filter, $params);
|
2008-04-25 15:48:12 +02:00
|
|
|
|
if (Net_LDAP2::isError($ret)) {
|
2009-01-24 18:45:14 +01:00
|
|
|
|
LSerror :: addErrorCode('LSldap_02',$ret -> getMessage());
|
2007-03-29 18:10:14 +02:00
|
|
|
|
return;
|
|
|
|
|
}
|
2020-12-22 19:43:50 +01:00
|
|
|
|
$count = $ret -> count();
|
|
|
|
|
self :: log_trace("LSldap::getNumberResult($filterstr, $basedn): result=$count");
|
|
|
|
|
return $count;
|
2007-03-29 18:10:14 +02:00
|
|
|
|
}
|
2020-04-29 15:54:21 +02:00
|
|
|
|
|
2007-03-29 18:10:14 +02:00
|
|
|
|
/**
|
2020-09-21 12:43:47 +02:00
|
|
|
|
* Load values of an LDAP entry attributes
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
2020-09-21 12:43:47 +02:00
|
|
|
|
* This method retreive attributes values of an LDAP entry and return it
|
|
|
|
|
* as associative array.
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
|
|
|
|
* @author Benjamin Renard <brenard@easter-eggs.com>
|
|
|
|
|
*
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* @param[in] $dn string DN de l'entré Ldap
|
2020-09-21 12:43:47 +02:00
|
|
|
|
* @param[in] $filter string LDAP filter string (optional, default: null == '(objectClass=*)')
|
|
|
|
|
* @param[in] $attrs array|null Array of requested attribute (optional, default: null == all attributes, excepted internal)
|
|
|
|
|
* @param[in] $include_internal boolean If true, internal attributes will be included (default: false)
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*
|
2020-09-21 12:43:47 +02:00
|
|
|
|
* @retval array|false Associative array of attributes values (with attribute name as key), or false on error
|
2007-03-29 18:10:14 +02:00
|
|
|
|
*/
|
2020-09-21 12:43:47 +02:00
|
|
|
|
public static function getAttrs($dn, $filter=null, $attrs=null, $include_internal=false) {
|
2007-03-29 18:10:14 +02:00
|
|
|
|
$infos = ldap_explode_dn($dn,0);
|
|
|
|
|
if((!$infos)||($infos['count']==0))
|
|
|
|
|
return;
|
2020-05-14 11:05:08 +02:00
|
|
|
|
if (!$filter)
|
|
|
|
|
$filter = '(objectClass=*)';
|
2020-09-21 12:43:47 +02:00
|
|
|
|
$params = array(
|
|
|
|
|
'scope' => 'base',
|
|
|
|
|
'attributes' => (is_array($attrs)?$attrs:array('*')),
|
|
|
|
|
);
|
|
|
|
|
if ($include_internal && !in_array('+', $params['attributes']))
|
|
|
|
|
$params['attributes'][] = '+';
|
|
|
|
|
$return = self :: search($filter, $dn, $params);
|
2020-05-14 11:05:08 +02:00
|
|
|
|
if (is_array($return) && count($return) == 1)
|
|
|
|
|
return $return[0]['attrs'];
|
|
|
|
|
return false;
|
2007-03-29 18:10:14 +02:00
|
|
|
|
}
|
2020-04-29 15:54:21 +02:00
|
|
|
|
|
2007-11-15 19:07:24 +01:00
|
|
|
|
/**
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* Retourne une entrée existante ou nouvelle
|
2007-11-15 19:07:24 +01:00
|
|
|
|
*
|
|
|
|
|
* @author Benjamin Renard <brenard@easter-eggs.com>
|
|
|
|
|
*
|
|
|
|
|
* @param[in] $object_type string Type de l'objet Ldap
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* @param[in] $dn string DN de l'entré Ldap
|
2007-11-15 19:07:24 +01:00
|
|
|
|
*
|
2008-05-05 16:39:41 +02:00
|
|
|
|
* @retval ldapentry|array Un objet ldapentry (PEAR::Net_LDAP2)
|
2020-04-29 15:54:21 +02:00
|
|
|
|
* ou un tableau (si c'est une nouvelle entr<EFBFBD>e):
|
2008-05-15 12:01:59 +02:00
|
|
|
|
* Array (
|
|
|
|
|
* 'entry' => ldapentry,
|
|
|
|
|
* 'new' => true
|
|
|
|
|
* )
|
2007-11-15 19:07:24 +01:00
|
|
|
|
*/
|
2009-01-25 15:37:03 +01:00
|
|
|
|
public static function getEntry($object_type,$dn) {
|
2020-09-09 19:02:32 +02:00
|
|
|
|
$obj_classes = LSconfig :: get("LSobjects.$object_type.objectclass");
|
|
|
|
|
if(!is_array($obj_classes)){
|
2009-01-24 18:45:14 +01:00
|
|
|
|
LSerror :: addErrorCode('LSldap_03');
|
2007-11-15 19:07:24 +01:00
|
|
|
|
return;
|
|
|
|
|
}
|
2020-09-09 19:02:32 +02:00
|
|
|
|
$entry = self :: getLdapEntry($dn);
|
|
|
|
|
if ($entry === false) {
|
|
|
|
|
$newentry = self :: getNewEntry($dn, $obj_classes, array());
|
|
|
|
|
if (!$newentry) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Mark entry as new
|
|
|
|
|
$newentry -> markAsNew();
|
|
|
|
|
return $newentry;
|
|
|
|
|
}
|
|
|
|
|
// Mark entry as NOT new
|
|
|
|
|
$entry -> markAsNew(false);
|
|
|
|
|
|
|
|
|
|
return $entry;
|
2007-11-15 19:07:24 +01:00
|
|
|
|
}
|
2020-04-29 15:54:21 +02:00
|
|
|
|
|
2009-04-15 16:04:21 +02:00
|
|
|
|
/**
|
|
|
|
|
* Retourne un object NetLDAP d'une entree existante
|
|
|
|
|
*
|
|
|
|
|
* @author Benjamin Renard <brenard@easter-eggs.com>
|
|
|
|
|
*
|
|
|
|
|
* @param[in] $dn string DN de l'entré Ldap
|
|
|
|
|
*
|
|
|
|
|
* @retval ldapentry|boolean Un objet ldapentry (PEAR::Net_LDAP2) ou false en
|
2020-04-29 15:54:21 +02:00
|
|
|
|
* cas de probl<EFBFBD>me
|
2009-04-15 16:04:21 +02:00
|
|
|
|
*/
|
|
|
|
|
public static function getLdapEntry($dn) {
|
|
|
|
|
$entry = self :: $cnx -> getEntry($dn);
|
|
|
|
|
if (Net_LDAP2::isError($entry)) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
else {
|
|
|
|
|
return $entry;
|
|
|
|
|
}
|
|
|
|
|
}
|
2020-04-29 15:54:21 +02:00
|
|
|
|
|
2020-12-14 19:42:19 +01:00
|
|
|
|
/**
|
|
|
|
|
* Check if an LDAP object exists
|
|
|
|
|
*
|
|
|
|
|
* @author Benjamin Renard <brenard@easter-eggs.com>
|
|
|
|
|
*
|
|
|
|
|
* @param[in] $dn string DN of the LDAP entry to check
|
|
|
|
|
*
|
|
|
|
|
* @retval boolean True if entry exists, false otherwise
|
|
|
|
|
*/
|
|
|
|
|
public static function exists($dn) {
|
|
|
|
|
return is_a(self :: getLdapEntry($dn), 'Net_LDAP2_Entry');
|
|
|
|
|
}
|
|
|
|
|
|
2008-08-06 19:04:03 +02:00
|
|
|
|
/**
|
2020-04-29 15:54:21 +02:00
|
|
|
|
* Retourne une nouvelle entr<EFBFBD>e
|
|
|
|
|
*
|
2008-08-06 19:04:03 +02:00
|
|
|
|
* @param[in] $dn string Le DN de l'objet
|
|
|
|
|
* @param[in] $objectClass array Un tableau contenant les objectClass de l'objet
|
|
|
|
|
* @param[in] $attrs array Un tabeau du type array('attr_name' => attr_value, ...)
|
2020-04-29 15:54:21 +02:00
|
|
|
|
*
|
|
|
|
|
* @retval mixed Le nouvelle objet en cas de succ<EFBFBD>s, false sinon
|
2008-08-06 19:04:03 +02:00
|
|
|
|
*/
|
2009-01-25 15:37:03 +01:00
|
|
|
|
public static function getNewEntry($dn,$objectClass,$attrs,$add=false) {
|
2008-08-06 19:04:03 +02:00
|
|
|
|
$newentry = Net_LDAP2_Entry::createFresh($dn,array_merge(array('objectclass' =>$objectClass),(array)$attrs));
|
|
|
|
|
if(Net_LDAP2::isError($newentry)) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
if($add) {
|
2009-01-25 15:37:03 +01:00
|
|
|
|
if(!self :: $cnx -> add($newentry)) {
|
2008-08-06 19:04:03 +02:00
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return $newentry;
|
|
|
|
|
}
|
2020-04-29 15:54:21 +02:00
|
|
|
|
|
2007-11-15 19:07:24 +01:00
|
|
|
|
/**
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* Met à jour une entrée dans l'annuaire
|
2020-04-29 15:54:21 +02:00
|
|
|
|
*
|
2008-02-26 18:40:05 +01:00
|
|
|
|
* Remarque : Supprime les valeurs vides de attributs et les attributs sans valeur.
|
2007-11-15 19:07:24 +01:00
|
|
|
|
*
|
|
|
|
|
* @author Benjamin Renard <brenard@easter-eggs.com>
|
|
|
|
|
*
|
|
|
|
|
* @param[in] $object_type string Type de l'objet Ldap
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* @param[in] $dn string DN de l'entré Ldap
|
|
|
|
|
* @param[in] $change array Tableau des modifications à apporter
|
2007-11-15 19:07:24 +01:00
|
|
|
|
*
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* @retval boolean true si l'objet a bien été mis à jour, false sinon
|
2007-11-15 19:07:24 +01:00
|
|
|
|
*/
|
2020-09-09 19:02:32 +02:00
|
|
|
|
public static function update($object_type, $dn, $change) {
|
|
|
|
|
self :: log_trace("update($object_type, $dn): change=".varDump($change));
|
|
|
|
|
|
|
|
|
|
// Retreive current LDAP entry
|
|
|
|
|
$entry = self :: getEntry($object_type, $dn);
|
|
|
|
|
if(!is_a($entry, 'Net_LDAP2_Entry')) {
|
|
|
|
|
LSerror :: addErrorCode('LSldap_04');
|
|
|
|
|
return;
|
2008-05-15 12:01:59 +02:00
|
|
|
|
}
|
2008-05-05 16:39:41 +02:00
|
|
|
|
|
2020-09-09 19:02:32 +02:00
|
|
|
|
// Distinguish drop attributes from change attributes
|
|
|
|
|
$changed_attrs = array();
|
|
|
|
|
$dropped_attrs = array();
|
|
|
|
|
foreach($change as $attrName => $attrVal) {
|
|
|
|
|
$drop = true;
|
|
|
|
|
if (is_array($attrVal)) {
|
|
|
|
|
foreach($attrVal as $val) {
|
2020-09-11 13:34:42 +02:00
|
|
|
|
if (!is_empty($val)) {
|
2008-04-25 15:48:12 +02:00
|
|
|
|
$drop = false;
|
2020-09-09 19:02:32 +02:00
|
|
|
|
$changed_attrs[$attrName][]=$val;
|
2008-04-25 15:48:12 +02:00
|
|
|
|
}
|
|
|
|
|
}
|
2010-11-16 19:49:35 +01:00
|
|
|
|
}
|
|
|
|
|
else {
|
2020-09-11 13:34:42 +02:00
|
|
|
|
if (!is_empty($val)) {
|
2020-09-09 19:02:32 +02:00
|
|
|
|
$drop = false;
|
|
|
|
|
$changed_attrs[$attrName][]=$attrVal;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
if($drop) {
|
|
|
|
|
$dropped_attrs[] = $attrName;
|
2010-11-16 19:49:35 +01:00
|
|
|
|
}
|
2020-09-09 19:02:32 +02:00
|
|
|
|
}
|
|
|
|
|
self :: log_trace("update($object_type, $dn): changed attrs=".varDump($changed_attrs));
|
|
|
|
|
self :: log_trace("update($object_type, $dn): dropped attrs=".varDump($dropped_attrs));
|
|
|
|
|
|
|
|
|
|
// Set an error flag to false
|
|
|
|
|
$error = false;
|
2008-04-25 15:48:12 +02:00
|
|
|
|
|
2020-09-09 19:02:32 +02:00
|
|
|
|
// Handle attributes changes (if need)
|
|
|
|
|
if ($changed_attrs) {
|
|
|
|
|
$entry -> replace($changed_attrs);
|
|
|
|
|
if ($entry -> isNew()) {
|
|
|
|
|
self :: log_debug("update($object_type, $dn): add new entry");
|
2009-01-25 15:37:03 +01:00
|
|
|
|
$ret = self :: $cnx -> add($entry);
|
2008-05-15 12:01:59 +02:00
|
|
|
|
}
|
|
|
|
|
else {
|
2020-09-09 19:02:32 +02:00
|
|
|
|
self :: log_debug("update($object_type, $dn): update entry (for changed attributes)");
|
2008-05-15 12:01:59 +02:00
|
|
|
|
$ret = $entry -> update();
|
|
|
|
|
}
|
2020-04-29 15:54:21 +02:00
|
|
|
|
|
2008-04-25 15:48:12 +02:00
|
|
|
|
if (Net_LDAP2::isError($ret)) {
|
2009-01-24 18:45:14 +01:00
|
|
|
|
LSerror :: addErrorCode('LSldap_05',$dn);
|
|
|
|
|
LSerror :: addErrorCode(0,'NetLdap-Error : '.$ret->getMessage());
|
2020-09-09 19:02:32 +02:00
|
|
|
|
return false;
|
2007-11-15 19:07:24 +01:00
|
|
|
|
}
|
2020-09-09 19:02:32 +02:00
|
|
|
|
}
|
|
|
|
|
elseif ($entry -> isNew()) {
|
|
|
|
|
self :: log_error("update($object_type, $dn): no changed attribute but it's a new entry...");
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
else {
|
|
|
|
|
self :: log_debug("update($object_type, $dn): no changed attribute");
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Handle droped attributes (is need and not a new entry)
|
|
|
|
|
if ($dropped_attrs && !$entry -> isNew()) {
|
|
|
|
|
// $entry -> delete() method is buggy (for some attribute like jpegPhoto)
|
|
|
|
|
// Prefer replace attribute by an empty array
|
|
|
|
|
$replace_attrs = array();
|
|
|
|
|
foreach($dropped_attrs as $attr) {
|
|
|
|
|
// Check if attribute is present
|
|
|
|
|
if(!$entry -> exists($attr)) {
|
|
|
|
|
// Attribute not present on LDAP entry
|
|
|
|
|
self :: log_debug("update($object_type, $dn): dropped attr $attr is not present in LDAP entry => ignore it");
|
|
|
|
|
continue;
|
2008-05-15 12:01:59 +02:00
|
|
|
|
}
|
2020-09-09 19:02:32 +02:00
|
|
|
|
$replace_attrs[$attr] = array();
|
|
|
|
|
}
|
|
|
|
|
if (!$replace_attrs) {
|
|
|
|
|
self :: log_debug("update($object_type, $dn): no attribute to drop");
|
2007-11-15 19:07:24 +01:00
|
|
|
|
return true;
|
|
|
|
|
}
|
2020-09-09 19:02:32 +02:00
|
|
|
|
|
|
|
|
|
// Replace values in LDAP
|
|
|
|
|
$entry -> replace($replace_attrs);
|
|
|
|
|
self :: log_debug("update($object_type, $dn): update entry (for dropped attributes: ".implode(', ', array_keys($replace_attrs)).")");
|
|
|
|
|
$ret = $entry -> update();
|
|
|
|
|
|
|
|
|
|
// Check result
|
|
|
|
|
if (Net_LDAP2::isError($ret)) {
|
|
|
|
|
LSerror :: addErrorCode('LSldap_06');
|
|
|
|
|
LSerror :: addErrorCode(0,'NetLdap-Error : '.$ret->getMessage());
|
|
|
|
|
return false;
|
|
|
|
|
}
|
2007-11-15 19:07:24 +01:00
|
|
|
|
}
|
2020-09-09 19:02:32 +02:00
|
|
|
|
return true;
|
2007-11-15 19:07:24 +01:00
|
|
|
|
}
|
2008-02-05 17:11:21 +01:00
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Test de bind
|
|
|
|
|
*
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* Cette methode établie une connexion à l'annuaire Ldap et test un bind
|
|
|
|
|
* avec un login et un mot de passe passé en paramètre
|
2008-02-05 17:11:21 +01:00
|
|
|
|
*
|
|
|
|
|
* @author Benjamin Renard <brenard@easter-eggs.com>
|
|
|
|
|
*
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* @retval boolean true si la connection à réussi, false sinon
|
2008-02-05 17:11:21 +01:00
|
|
|
|
*/
|
2009-01-25 15:37:03 +01:00
|
|
|
|
public static function checkBind($dn,$pwd) {
|
|
|
|
|
$config = self :: $config;
|
2008-02-12 18:59:44 +01:00
|
|
|
|
$config['binddn'] = $dn;
|
|
|
|
|
$config['bindpw'] = $pwd;
|
2008-04-25 15:48:12 +02:00
|
|
|
|
$cnx = Net_LDAP2::connect($config);
|
|
|
|
|
if (Net_LDAP2::isError($cnx)) {
|
2008-02-05 17:11:21 +01:00
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
|
2008-02-12 18:59:44 +01:00
|
|
|
|
/**
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* Retourne l'état de la connexion Ldap
|
2008-02-12 18:59:44 +01:00
|
|
|
|
*
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* @retval boolean True si le serveur est connecté, false sinon.
|
2008-02-12 18:59:44 +01:00
|
|
|
|
*/
|
2009-01-25 15:37:03 +01:00
|
|
|
|
public static function isConnected() {
|
|
|
|
|
return (self :: $cnx == NULL)?false:true;
|
2008-02-12 18:59:44 +01:00
|
|
|
|
}
|
2020-04-29 15:54:21 +02:00
|
|
|
|
|
2008-02-12 18:59:44 +01:00
|
|
|
|
/**
|
|
|
|
|
* Supprime un objet de l'annuaire
|
|
|
|
|
*
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* @param[in] string DN de l'objet à supprimer
|
2020-04-29 15:54:21 +02:00
|
|
|
|
*
|
2008-04-25 16:09:27 +02:00
|
|
|
|
* @retval boolean True si l'objet à été supprimé, false sinon
|
2008-02-12 18:59:44 +01:00
|
|
|
|
*/
|
2009-01-25 15:37:03 +01:00
|
|
|
|
public static function remove($dn) {
|
|
|
|
|
$ret = self :: $cnx -> delete($dn,array('recursive' => true));
|
2008-07-29 16:23:47 +02:00
|
|
|
|
if (Net_LDAP2::isError($ret)) {
|
2009-01-24 18:45:14 +01:00
|
|
|
|
LSerror :: addErrorCode(0,'NetLdap-Error : '.$ret->getMessage());
|
2008-07-29 16:23:47 +02:00
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
return true;
|
2008-02-12 18:59:44 +01:00
|
|
|
|
}
|
2008-02-05 17:11:21 +01:00
|
|
|
|
|
2008-07-29 15:45:02 +02:00
|
|
|
|
/**
|
2020-04-29 15:54:21 +02:00
|
|
|
|
* D<EFBFBD>place un objet LDAP dans l'annuaire
|
|
|
|
|
*
|
2008-07-29 15:45:02 +02:00
|
|
|
|
* @param[in] $old string Le DN actuel
|
|
|
|
|
* @param[in] $new string Le futur DN
|
2020-04-29 15:54:21 +02:00
|
|
|
|
*
|
|
|
|
|
* @retval boolean True si l'objet a <EFBFBD>t<EFBFBD> d<EFBFBD>plac<EFBFBD>, false sinon
|
2008-07-29 15:45:02 +02:00
|
|
|
|
*/
|
2009-01-25 15:37:03 +01:00
|
|
|
|
public static function move($old,$new) {
|
2021-02-04 11:52:26 +01:00
|
|
|
|
$ret = self :: $cnx -> move($old, $new);
|
2008-07-29 16:23:47 +02:00
|
|
|
|
if (Net_LDAP2::isError($ret)) {
|
2009-01-24 18:45:14 +01:00
|
|
|
|
LSerror :: addErrorCode('LSldap_07');
|
|
|
|
|
LSerror :: addErrorCode(0,'NetLdap-Error : '.$ret->getMessage());
|
2008-07-29 16:23:47 +02:00
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
return true;
|
2008-07-29 15:45:02 +02:00
|
|
|
|
}
|
2020-04-29 15:54:21 +02:00
|
|
|
|
|
2009-10-29 23:17:30 +01:00
|
|
|
|
/**
|
|
|
|
|
* Combine LDAP Filters
|
2020-04-29 15:54:21 +02:00
|
|
|
|
*
|
2009-10-29 23:17:30 +01:00
|
|
|
|
* @params array Array of LDAP filters
|
2020-04-29 15:54:21 +02:00
|
|
|
|
*
|
2009-10-29 23:17:30 +01:00
|
|
|
|
* @retval Net_LDAP2_Filter | False The combined filter or False
|
|
|
|
|
**/
|
|
|
|
|
public static function combineFilters($op,$filters,$asStr=false) {
|
|
|
|
|
if (is_array($filters) && !empty($filters)) {
|
|
|
|
|
if (count($filters)==1) {
|
2014-11-28 16:16:30 +01:00
|
|
|
|
if ($asStr && $filters[0] instanceof Net_LDAP2_Filter) {
|
|
|
|
|
return $filters[0]->asString();
|
|
|
|
|
}
|
|
|
|
|
else {
|
|
|
|
|
return $filters[0];
|
|
|
|
|
}
|
2009-10-29 23:17:30 +01:00
|
|
|
|
}
|
|
|
|
|
$filter=Net_LDAP2_Filter::combine($op,$filters);
|
|
|
|
|
if (!Net_LDAP2::isError($filter)) {
|
|
|
|
|
if ($asStr) {
|
|
|
|
|
return $filter->asString();
|
|
|
|
|
}
|
|
|
|
|
else {
|
|
|
|
|
return $filter;
|
|
|
|
|
}
|
|
|
|
|
}
|
2010-02-03 03:07:30 +01:00
|
|
|
|
else {
|
|
|
|
|
LSerror :: addErrorCode(0,$filter -> getMessage());
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return;
|
|
|
|
|
}
|
2020-04-29 15:54:21 +02:00
|
|
|
|
|
2010-02-03 03:07:30 +01:00
|
|
|
|
/**
|
|
|
|
|
* Check LDAP Filters String
|
2020-04-29 15:54:21 +02:00
|
|
|
|
*
|
2010-02-03 03:07:30 +01:00
|
|
|
|
* @params string A LDAP filter as string
|
2020-04-29 15:54:21 +02:00
|
|
|
|
*
|
2010-02-03 03:07:30 +01:00
|
|
|
|
* @retval boolean True only if the filter could be parsed
|
|
|
|
|
**/
|
|
|
|
|
public static function isValidFilter($filter) {
|
|
|
|
|
if (is_string($filter) && !empty($filter)) {
|
|
|
|
|
$filter=Net_LDAP2_Filter::parse($filter);
|
|
|
|
|
if (!Net_LDAP2::isError($filter)) {
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
else {
|
|
|
|
|
LSerror :: addErrorCode(0,$filter -> getMessage());
|
|
|
|
|
}
|
2009-10-29 23:17:30 +01:00
|
|
|
|
}
|
|
|
|
|
return;
|
|
|
|
|
}
|
2020-12-22 19:43:50 +01:00
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Return a configuration parameter (or default value)
|
|
|
|
|
*
|
|
|
|
|
* @param[] $param The configuration parameter
|
|
|
|
|
* @param[] $default The default value (default : null)
|
|
|
|
|
* @param[] $cast Cast resulting value in specific type (default : disabled)
|
|
|
|
|
*
|
|
|
|
|
* @retval mixed The configuration parameter value or default value if not set
|
|
|
|
|
**/
|
|
|
|
|
private static function getConfig($param, $default=null, $cast=null) {
|
|
|
|
|
return LSconfig :: get($param, $default, $cast, self :: $config);
|
|
|
|
|
}
|
2007-03-29 18:10:14 +02:00
|
|
|
|
}
|
|
|
|
|
|
2009-01-02 17:00:25 +01:00
|
|
|
|
/*
|
|
|
|
|
* Error Codes
|
|
|
|
|
*/
|
2009-01-25 15:37:03 +01:00
|
|
|
|
LSerror :: defineError('LSldap_01',
|
2020-12-22 19:43:50 +01:00
|
|
|
|
___("LSldap: Error during the LDAP server connection (%{msg}).")
|
2009-01-02 17:00:25 +01:00
|
|
|
|
);
|
2009-01-25 15:37:03 +01:00
|
|
|
|
LSerror :: defineError('LSldap_02',
|
2020-12-22 19:43:50 +01:00
|
|
|
|
___("LSldap: Error during the LDAP search (%{msg}).")
|
2009-01-02 17:00:25 +01:00
|
|
|
|
);
|
2009-01-25 15:37:03 +01:00
|
|
|
|
LSerror :: defineError('LSldap_03',
|
2020-12-22 19:43:50 +01:00
|
|
|
|
___("LSldap: Object type unknown.")
|
2009-01-02 17:00:25 +01:00
|
|
|
|
);
|
2009-01-25 15:37:03 +01:00
|
|
|
|
LSerror :: defineError('LSldap_04',
|
2020-12-22 19:43:50 +01:00
|
|
|
|
___("LSldap: Error while fetching the LDAP entry.")
|
2009-01-02 17:00:25 +01:00
|
|
|
|
);
|
2009-01-25 15:37:03 +01:00
|
|
|
|
LSerror :: defineError('LSldap_05',
|
2020-12-22 19:43:50 +01:00
|
|
|
|
___("LSldap: Error while changing the LDAP entry (DN : %{dn}).")
|
2009-01-02 17:00:25 +01:00
|
|
|
|
);
|
2009-01-25 15:37:03 +01:00
|
|
|
|
LSerror :: defineError('LSldap_06',
|
2020-12-22 19:43:50 +01:00
|
|
|
|
___("LSldap: Error while deleting empty attributes.")
|
2009-01-02 17:00:25 +01:00
|
|
|
|
);
|
2009-01-25 15:37:03 +01:00
|
|
|
|
LSerror :: defineError('LSldap_07',
|
2020-12-22 19:43:50 +01:00
|
|
|
|
___("LSldap: Error while changing the DN of the object.")
|
|
|
|
|
);
|
|
|
|
|
LSerror :: defineError('LSldap_08',
|
|
|
|
|
___("LSldap: LDAP server base DN not configured.")
|
2009-01-02 17:00:25 +01:00
|
|
|
|
);
|