mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-10-01 01:36:00 -04:00
116 lines
3.4 KiB
PHP
116 lines
3.4 KiB
PHP
<?php namespace BookStack\Services;
|
|
|
|
|
|
/**
|
|
* Class Ldap
|
|
* An object-orientated thin abstraction wrapper for common PHP LDAP functions.
|
|
* Allows the standard LDAP functions to be mocked for testing.
|
|
* @package BookStack\Services
|
|
*/
|
|
class Ldap
|
|
{
|
|
|
|
/**
|
|
* Connect to a LDAP server.
|
|
* @param string $hostName
|
|
* @param int $port
|
|
* @return resource
|
|
*/
|
|
public function connect($hostName, $port)
|
|
{
|
|
/*
|
|
* LDAPS is not working because even if port 363 is specified,
|
|
* BookStack tries to open a LDAP connection on the LDAPS channel.
|
|
* The if-clause below fixed this, although it would be better to
|
|
* change the settings in .env from
|
|
* LDAP_SERVER=servername:port
|
|
* to
|
|
* LDAP_SERVER=ldap://servername:389
|
|
* LDAP_SERVER=ldaps://servername:363
|
|
* in order to be compatible with non-standard setups. Currently,
|
|
* specifying ldap:// or ldaps:// results in an error because BookStack
|
|
* splits at ":" and takes the seconds chunk (in this case "//servername"
|
|
* as the port value.
|
|
*/
|
|
if ($port == 363)
|
|
{
|
|
$hostName = "ldaps://".$hostName;
|
|
}
|
|
return ldap_connect($hostName, $port);
|
|
}
|
|
|
|
/**
|
|
* Set the value of a LDAP option for the given connection.
|
|
* @param resource $ldapConnection
|
|
* @param int $option
|
|
* @param mixed $value
|
|
* @return bool
|
|
*/
|
|
public function setOption($ldapConnection, $option, $value)
|
|
{
|
|
return ldap_set_option($ldapConnection, $option, $value);
|
|
}
|
|
|
|
/**
|
|
* Set the version number for the given ldap connection.
|
|
* @param $ldapConnection
|
|
* @param $version
|
|
* @return bool
|
|
*/
|
|
public function setVersion($ldapConnection, $version)
|
|
{
|
|
return $this->setOption($ldapConnection, LDAP_OPT_PROTOCOL_VERSION, $version);
|
|
}
|
|
|
|
/**
|
|
* Search LDAP tree using the provided filter.
|
|
* @param resource $ldapConnection
|
|
* @param string $baseDn
|
|
* @param string $filter
|
|
* @param array|null $attributes
|
|
* @return resource
|
|
*/
|
|
public function search($ldapConnection, $baseDn, $filter, array $attributes = null)
|
|
{
|
|
return ldap_search($ldapConnection, $baseDn, $filter, $attributes);
|
|
}
|
|
|
|
/**
|
|
* Get entries from an ldap search result.
|
|
* @param resource $ldapConnection
|
|
* @param resource $ldapSearchResult
|
|
* @return array
|
|
*/
|
|
public function getEntries($ldapConnection, $ldapSearchResult)
|
|
{
|
|
return ldap_get_entries($ldapConnection, $ldapSearchResult);
|
|
}
|
|
|
|
/**
|
|
* Search and get entries immediately.
|
|
* @param resource $ldapConnection
|
|
* @param string $baseDn
|
|
* @param string $filter
|
|
* @param array|null $attributes
|
|
* @return resource
|
|
*/
|
|
public function searchAndGetEntries($ldapConnection, $baseDn, $filter, array $attributes = null)
|
|
{
|
|
$search = $this->search($ldapConnection, $baseDn, $filter, $attributes);
|
|
return $this->getEntries($ldapConnection, $search);
|
|
}
|
|
|
|
/**
|
|
* Bind to LDAP directory.
|
|
* @param resource $ldapConnection
|
|
* @param string $bindRdn
|
|
* @param string $bindPassword
|
|
* @return bool
|
|
*/
|
|
public function bind($ldapConnection, $bindRdn = null, $bindPassword = null)
|
|
{
|
|
return ldap_bind($ldapConnection, $bindRdn, $bindPassword);
|
|
}
|
|
|
|
}
|