Source for file abook_ldap_server.php

Documentation is available at abook_ldap_server.php

  1. <?php
  2.  
  3. /**
  4.  * abook_ldap_server.php
  5.  *
  6.  * Address book backend for LDAP server
  7.  *
  8.  * @copyright 1999-2020 The SquirrelMail Project Team
  9.  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10.  * @version $Id: abook_ldap_server.php 14840 2020-01-07 07:42:38Z pdontthink $
  11.  * @package squirrelmail
  12.  * @subpackage addressbook
  13.  */
  14.  
  15. /**
  16.  * Address book backend for LDAP server
  17.  *
  18.  * An array with the following elements must be passed to
  19.  * the class constructor (elements marked ? are optional):
  20.  * <pre>
  21.  *    host      => LDAP server hostname/IP-address
  22.  *    base      => LDAP server root (base dn). Empty string allowed.
  23.  *  ? port      => LDAP server TCP port number (default: 389)
  24.  *  ? charset   => LDAP server charset (default: utf-8)
  25.  *  ? name      => Name for LDAP server (default "LDAP: hostname")
  26.  *                 Used to tag the result data
  27.  *  ? maxrows   => Maximum # of rows in search result
  28.  *  ? timeout   => Timeout for LDAP operations (in seconds, default: 30)
  29.  *                 Might not work for all LDAP libraries or servers.
  30.  *  ? binddn    => LDAP Bind DN.
  31.  *  ? bindpw    => LDAP Bind Password.
  32.  *  ? protocol  => LDAP Bind protocol.
  33.  * </pre>
  34.  * NOTE. This class should not be used directly. Use the
  35.  *       "AddressBook" class instead.
  36.  * @package squirrelmail
  37.  * @subpackage addressbook
  38.  */
  39. class abook_ldap_server extends addressbook_backend {
  40.     /**
  41.      * @var string backend type
  42.      */
  43.     var $btype = 'remote';
  44.     /**
  45.      * @var string backend name
  46.      */
  47.     var $bname = 'ldap_server';
  48.  
  49.     /* Parameters changed by class */
  50.     /**
  51.      * @var string displayed name
  52.      */
  53.     var $sname   = 'LDAP';       /* Service name */
  54.     /**
  55.      * @var string LDAP server name or address or url
  56.      */
  57.     var $server  = '';
  58.     /**
  59.      * @var integer LDAP server port
  60.      */
  61.     var $port    = 389;
  62.     /**
  63.      * @var string LDAP base DN
  64.      */
  65.     var $basedn  = '';
  66.     /**
  67.      * @var string charset used for entries in LDAP server
  68.      */
  69.     var $charset = 'utf-8';
  70.     /**
  71.      * @var object PHP LDAP link ID
  72.      */
  73.     var $linkid  = false;
  74.     /**
  75.      * @var bool True if LDAP server is bound
  76.      */
  77.     var $bound   = false;
  78.     /**
  79.      * @var integer max rows in result
  80.      */
  81.     var $maxrows = 250;
  82.     /**
  83.      * @var integer timeout of LDAP operations (in seconds)
  84.      */
  85.     var $timeout = 30;
  86.     /**
  87.      * @var string DN to bind to (non-anonymous bind)
  88.      * @since 1.5.0 and 1.4.3
  89.      */
  90.     var $binddn = '';
  91.     /**
  92.      * @var string  password to bind with (non-anonymous bind)
  93.      * @since 1.5.0 and 1.4.3
  94.      */
  95.     var $bindpw = '';
  96.     /**
  97.      * @var integer protocol used to connect to ldap server
  98.      * @since 1.5.0 and 1.4.3
  99.      */
  100.     var $protocol = '';
  101.  
  102.     /**
  103.      * Constructor (PHP5 style, required in some future version of PHP)
  104.      * Connects to the database
  105.      * @param array connection options
  106.      */
  107.     function __construct($param) {
  108.         if(!function_exists('ldap_connect')) {
  109.             $this->set_error('LDAP support missing from PHP');
  110.             return;
  111.         }
  112.         if(is_array($param)) {
  113.             $this->server = $param['host'];
  114.             $this->basedn = $param['base'];
  115.             if(!empty($param['port'])) {
  116.                 $this->port = $param['port'];
  117.             }
  118.             if(!empty($param['charset'])) {
  119.                 $this->charset = strtolower($param['charset']);
  120.             }
  121.             if(isset($param['maxrows'])) {
  122.                 $this->maxrows = $param['maxrows'];
  123.             }
  124.             if(isset($param['timeout'])) {
  125.                 $this->timeout = $param['timeout'];
  126.             }
  127.             if(isset($param['binddn'])) {
  128.                 $this->binddn = $param['binddn'];
  129.             }
  130.             if(isset($param['bindpw'])) {
  131.                 $this->bindpw = $param['bindpw'];
  132.             }
  133.             if(isset($param['protocol'])) {
  134.                 $this->protocol = $param['protocol'];
  135.             }
  136.             if(empty($param['name'])) {
  137.                 $this->sname = 'LDAP: ' . $param['host'];
  138.             }
  139.             else {
  140.                 $this->sname = $param['name'];
  141.             }
  142.  
  143.             $this->open(true);
  144.         } else {
  145.             $this->set_error('Invalid argument to constructor');
  146.         }
  147.     }
  148.  
  149.     /**
  150.      * Constructor (PHP4 style, kept for compatibility reasons)
  151.      * Connects to the database
  152.      * @param array connection options
  153.      */
  154.     function abook_ldap_server($param) {
  155.         return self::__construct($param);
  156.     }
  157.  
  158.     /**
  159.      * Open the LDAP server.
  160.      * @param bool $new is it a new connection
  161.      * @return bool 
  162.      */
  163.     function open($new = false) {
  164.         $this->error = '';
  165.  
  166.         /* Connection is already open */
  167.         if($this->linkid != false && !$new) {
  168.             return true;
  169.         }
  170.  
  171.         $this->linkid = @ldap_connect($this->server, $this->port);
  172.         if(!$this->linkid) {
  173.             if(function_exists('ldap_error')) {
  174.                 return $this->set_error(ldap_error($this->linkid));
  175.             } else {
  176.                 return $this->set_error('ldap_connect failed');
  177.             }
  178.         }
  179.  
  180.         if(!empty($this->protocol)) {
  181.             if(!@ldap_set_option($this->linkid, LDAP_OPT_PROTOCOL_VERSION, $this->protocol)) {
  182.                 if(function_exists('ldap_error')) {
  183.                     return $this->set_error(ldap_error($this->linkid));
  184.                 } else {
  185.                     return $this->set_error('ldap_set_option failed');
  186.                 }
  187.             }
  188.         }
  189.  
  190.         if(!empty($this->binddn)) {
  191.             if(!@ldap_bind($this->linkid, $this->binddn, $this->bindpw)) {
  192.                 if(function_exists('ldap_error')) {
  193.                     return $this->set_error(ldap_error($this->linkid));
  194.                 } else {
  195.                     return $this->set_error('authenticated ldap_bind failed');
  196.                 }
  197.               }
  198.         } else {
  199.             if(!@ldap_bind($this->linkid)) {
  200.                 if(function_exists('ldap_error')) {
  201.                     return $this->set_error(ldap_error($this->linkid));
  202.                 } else {
  203.                     return $this->set_error('anonymous ldap_bind failed');
  204.                 }
  205.             }
  206.         }
  207.  
  208.         $this->bound = true;
  209.  
  210.         return true;
  211.     }
  212.  
  213.     /**
  214.      * Converts string to the charset used by LDAP server
  215.      * @param string string that has to be converted
  216.      * @return string converted string
  217.      */
  218.     function charset_encode($str) {
  219.         global $default_charset;
  220.         if($this->charset != $default_charset) {
  221.             return charset_convert($default_charset,$str,$this->charset,false);
  222.         } else {
  223.             return $str;
  224.         }
  225.     }
  226.  
  227.     /**
  228.      * Convert from charset used by LDAP server to charset used by translation
  229.      *
  230.      * Output must be sanitized.
  231.      * @param string string that has to be converted
  232.      * @return string converted string
  233.      */
  234.     function charset_decode($str) {
  235.         global $default_charset;
  236.         if ($this->charset != $default_charset) {
  237.             return charset_convert($this->charset,$str,$default_charset,false);
  238.         } else {
  239.             return $str;
  240.         }
  241.     }
  242.  
  243.     /**
  244.      * Sanitizes ldap search strings.
  245.      * See rfc2254
  246.      * @link http://www.faqs.org/rfcs/rfc2254.html
  247.      * @since 1.5.1 and 1.4.5
  248.      * @param string $string 
  249.      * @return string sanitized string
  250.      */
  251.     function ldapspecialchars($string) {
  252.         $sanitized=array('\\' => '\5c',
  253.                          '*' => '\2a',
  254.                          '(' => '\28',
  255.                          ')' => '\29',
  256.                          "\x00" => '\00');
  257.  
  258.         return str_replace(array_keys($sanitized),array_values($sanitized),$string);
  259.     }
  260.  
  261.     /* ========================== Public ======================== */
  262.  
  263.     /**
  264.      * Search the LDAP server
  265.      * @param string $expr search expression
  266.      * @return array search results
  267.      */
  268.     function search($expr) {
  269.         /* To be replaced by advanded search expression parsing */
  270.         if(is_array($expr)) return false;
  271.  
  272.         /* Encode the expression */
  273.         $expr = $this->charset_encode($expr);
  274.  
  275.         /*
  276.          * allow use of one asterisk in search. 
  277.          * Don't allow any ldap special chars if search is different
  278.          */
  279.         if($expr!='*') {
  280.             $expr = '*' . $this->ldapspecialchars($expr) . '*';
  281.             /* Undo sanitizing of * symbol */
  282.             $expr = str_replace('\2a','*',$expr);
  283.         }
  284.         $expr = preg_replace('/\*+/', '*', $expr); // LDAP chokes on more than one *
  285.         $expression = "(|(cn=$expr)(sn=$expr)(givenname=$expr)(mail=$expr))";
  286.  
  287.         /* Make sure connection is there */
  288.         if(!$this->open()) {
  289.             return false;
  290.         }
  291.  
  292.         $sret = @ldap_search($this->linkid, $this->basedn, $expression,
  293.             array('dn', 'o', 'ou', 'sn', 'givenname', 'cn', 'mail'),
  294.             0, $this->maxrows, $this->timeout);
  295.  
  296.         /* Should get error from server using the ldap_error() function,
  297.          * but it only exist in the PHP LDAP documentation. */
  298.         if(!$sret) {
  299.             if(function_exists('ldap_error')) {
  300.                 return $this->set_error(ldap_error($this->linkid));
  301.             } else {
  302.                 return $this->set_error('ldap_search failed');
  303.             }
  304.         }
  305.  
  306.         if(@ldap_count_entries($this->linkid, $sret) <= 0) {
  307.             return array();
  308.         }
  309.  
  310.         /* Get results */
  311.         $ret = array();
  312.         $returned_rows = 0;
  313.         $res = @ldap_get_entries($this->linkid, $sret);
  314.         for($i = 0 ; $i < $res['count'] ; $i++) {
  315.             $row = $res[$i];
  316.  
  317.             /* Extract data common for all e-mail addresses
  318.              * of an object. Use only the first name */
  319.             $nickname = $this->charset_decode($row['dn']);
  320.             $fullname = $this->charset_decode($row['cn'][0]);
  321.  
  322.             if(!empty($row['ou'][0])) {
  323.                 $label = $this->charset_decode($row['ou'][0]);
  324.             }
  325.             else if(!empty($row['o'][0])) {
  326.                 $label = $this->charset_decode($row['o'][0]);
  327.             } else {
  328.                 $label = '';
  329.             }
  330.  
  331.             if(empty($row['givenname'][0])) {
  332.                 $firstname = '';
  333.             } else {
  334.                 $firstname = $this->charset_decode($row['givenname'][0]);
  335.             }
  336.  
  337.             if(empty($row['sn'][0])) {
  338.                 $surname = '';
  339.             } else {
  340.                 $surname = $this->charset_decode($row['sn'][0]);
  341.             }
  342.  
  343.             /* Add one row to result for each e-mail address */
  344.             if(isset($row['mail']['count'])) {
  345.                 for($j = 0 ; $j < $row['mail']['count'] ; $j++) {
  346.                     array_push($ret, array('nickname'  => $nickname,
  347.                    'name'      => $fullname,
  348.                    'firstname' => $firstname,
  349.                    'lastname'  => $surname,
  350.                    'email'     => $row['mail'][$j],
  351.                    'label'     => $label,
  352.                    'backend'   => $this->bnum,
  353.                    'source'    => &$this->sname));
  354.  
  355.                     // Limit number of hits
  356.                     $returned_rows++;
  357.                     if(($returned_rows >= $this->maxrows) &&
  358.                        ($this->maxrows > 0) ) {
  359.                         ldap_free_result($sret);
  360.                         return $ret;
  361.                     }
  362.  
  363.                 } // for($j ...)
  364.  
  365.             } // isset($row['mail']['count'])
  366.  
  367.         }
  368.  
  369.         ldap_free_result($sret);
  370.         return $ret;
  371.     } /* end search() */
  372.  
  373.  
  374.     /**
  375.      * List all entries present in LDAP server
  376.      *
  377.      * If you run a small-sized LDAP server and you want the "List all"
  378.      * button (found on the address book search screen that is accessed
  379.      * via the "Addresses" button on the compose screen) to show all
  380.      * addresses in the directory, add the following to config/config_local.php
  381.      *
  382.      *    $ldap_abook_allow_listing = TRUE;
  383.      *
  384.      * Remember that the "maxrows" configuration setting for the LDAP
  385.      * server backend might limit list of returned entries.
  386.      *
  387.      * NOTE: You should exercise caution enabling the listing of large
  388.      *       or public LDAP address book backends.
  389.      *
  390.      * @return array all entries in ldap server
  391.      *
  392.      */
  393.      function list_addr() {
  394.          global $ldap_abook_allow_listing;
  395.          if ($ldap_abook_allow_listing)
  396.             return $this->search('*');
  397.          else
  398.             return array();
  399.      }
  400. }

Documentation generated on Mon, 13 Jan 2020 04:24:10 +0100 by phpDocumentor 1.4.3