tyler.durden
/
icingaweb2
mirror of https://github.com/Icinga/icingaweb2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Introduce Interface for inspecting ldap connections 

refs #9605
This commit is contained in:
Matthias Jentsch 2015-07-14 12:30:16 +02:00
parent 3db81a8d0f
commit 6599940e6c
3 changed files with 115 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
library/Icinga/Data/Inspectable.php Normal file
View File

@ -0,0 +1,26 @@
<?php
/* Icinga Web 2 | (c) 2013-2015 Icinga Development Team | GPLv2+ */
namespace Icinga\Data;
/**
* An object for which the user can retrieve status information
*/
interface Inspectable
{
/**
* Get information about this objects state
*
* @return array An array of strings that describe the state in a human-readable form, each array element
* represents one fact about this object
*/
public function getInfo();
/**
* If this object is working in its current configuration
*
* @return Bool True if the object is working, false if not
*/
public function isHealthy();
}

32
library/Icinga/Protocol/Ldap/Capability.php → library/Icinga/Protocol/Ldap/LdapCapabilities.php
View File

@ -9,7 +9,7 @@ namespace Icinga\Protocol\Ldap;
* Provides information about the available encryption mechanisms (StartTLS), the supported
* LDAP protocol (v2/v3), vendor-specific extensions or protocols controls and extensions.
*/
class Capability
class LdapCapabilities
{
const LDAP_SERVER_START_TLS_OID = '1.3.6.1.4.1.1466.20037';
@ -127,7 +127,7 @@ class Capability
}
/**
* Return if the capability object contains support for StartTLS
* Return if the capability object contains support for paged results
*
* @return bool Whether StartTLS is supported
*/
@ -208,4 +208,32 @@ class Capability
}
return$this->attributes->namingContexts;
}
public function getVendor()
{
// AD doesn't include the vendor entry
if ($this->hasAdOid()) {
return 'Microsoft Active Directory';
}
if (! isset($this->attributes->vendorName)) {
// OpenLDAP doesn't include the vendor entry
// TODO: bad, remove this and add proper OpenLDAP version checking
return 'OpenLDAP';
}
return $this->attributes->vendorName;
}
public function getVersion()
{
// AD doesn't include the version string
if ($this->hasAdOid()) {
// TODO: query AD version from cn=schema,cn=configuration,dc=yourdomain,dc=com attribute:ObjectVersion
}
if (! isset($this->attributes->vendorVersion)) {
return 'unknown';
}
return $this->attributes->vendorVersion;
}
}

68
library/Icinga/Protocol/Ldap/LdapConnection.php
View File

@ -3,11 +3,13 @@
namespace Icinga\Protocol\Ldap;
use Exception;
use ArrayIterator;
use Icinga\Application\Config;
use Icinga\Application\Logger;
use Icinga\Application\Platform;
use Icinga\Data\ConfigObject;
use Icinga\Data\Inspectable;
use Icinga\Data\Selectable;
use Icinga\Data\Sortable;
use Icinga\Exception\ProgrammingError;
@ -16,7 +18,7 @@ use Icinga\Protocol\Ldap\LdapException;
/**
* Encapsulate LDAP connections and query creation
*/
class LdapConnection implements Selectable
class LdapConnection implements Selectable, Inspectable
{
/**
* Indicates that the target object cannot be found
@ -142,7 +144,7 @@ class LdapConnection implements Selectable
/**
* The properties and capabilities of the LDAP server
*
* @var Capability
* @var LdapCapabilities
*/
protected $capabilities;
@ -160,6 +162,16 @@ class LdapConnection implements Selectable
*/
protected $encryptionSuccess;
/**
* @var array
*/
protected $info = null;
/**
* @var Boolean
*/
protected $healthy = null;
/**
* Create a new connection object
*
@ -243,7 +255,7 @@ class LdapConnection implements Selectable
/**
* Return the capabilities of the current connection
*
* @return Capability
* @return LdapCapabilities
*/
public function getCapabilities()
{
@ -254,7 +266,7 @@ class LdapConnection implements Selectable
} catch (LdapException $e) {
Logger::debug($e);
Logger::warning('LADP discovery failed, assuming default LDAP capabilities.');
$this->capabilities = new Capability(); // create empty default capabilities
$this->capabilities = new LdapCapabilities(); // create empty default capabilities
$this->discoverySuccess = false;
}
}
@ -660,7 +672,7 @@ class LdapConnection implements Selectable
if ($serverSorting && $query->hasOrder()) {
ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array(
array(
'oid' => Capability::LDAP_SERVER_SORT_OID,
'oid' => LdapCapabilities::LDAP_SERVER_SORT_OID,
'value' => $this->encodeSortRules($query->getOrder())
)
));
@ -755,7 +767,7 @@ class LdapConnection implements Selectable
if ($serverSorting && $query->hasOrder()) {
ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array(
array(
'oid' => Capability::LDAP_SERVER_SORT_OID,
'oid' => LdapCapabilities::LDAP_SERVER_SORT_OID,
'value' => $this->encodeSortRules($query->getOrder())
)
));
@ -1018,7 +1030,7 @@ class LdapConnection implements Selectable
*
* @param resource $ds The link identifier of the current LDAP connection
*
* @return Capability
* @return LdapCapabilities
*
* @throws LdapException In case the capability query has failed
*/
@ -1059,8 +1071,7 @@ class LdapConnection implements Selectable
ldap_error($ds)
);
}
return new Capability($this->cleanupAttributes(ldap_get_attributes($ds, $entry), array_flip($fields)));
return new LdapCapabilities($this->cleanupAttributes(ldap_get_attributes($ds, $entry), array_flip($fields)));
}
/**
@ -1128,6 +1139,45 @@ class LdapConnection implements Selectable
return $dir;
}
protected function logInfo($message)
{
Logger::debug($message);
if (! isset($this->info)) {
$this->info = array();
}
$this->info[] = $message;
}
/**
* Get information about this objects state
*
* @return array An array of strings that describe the state in a human-readable form, each array element
* represents one fact about this object
*/
public function getInfo()
{
if (! isset($this->info)) {
$this->getConnection();
}
return $this->info;
}
/**
* If this object is working in its current configuration
*
* @return Bool True if the object is working, false if not
*/
public function isHealthy()
{
if (! isset($this->healthy)) {
try {
$this->testConnectionHealth();
} catch (Exception $e) {
}
}
return $this->healthy;
}
/**
* Reset the environment variables set by self::prepareTlsEnvironment()
*/