summaryrefslogtreecommitdiffstats
path: root/apps/user_ldap/lib/LDAP.php
diff options
context:
space:
mode:
Diffstat (limited to 'apps/user_ldap/lib/LDAP.php')
-rw-r--r--apps/user_ldap/lib/LDAP.php301
1 files changed, 301 insertions, 0 deletions
diff --git a/apps/user_ldap/lib/LDAP.php b/apps/user_ldap/lib/LDAP.php
new file mode 100644
index 00000000000..a7033d82254
--- /dev/null
+++ b/apps/user_ldap/lib/LDAP.php
@@ -0,0 +1,301 @@
+<?php
+/**
+ * @author Alexander Bergolth <leo@strike.wu.ac.at>
+ * @author Arthur Schiwon <blizzz@owncloud.com>
+ * @author Jörn Friedrich Dreyer <jfd@butonic.de>
+ * @author Lukas Reschke <lukas@owncloud.com>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Robin McCorkell <robin@mccorkell.me.uk>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCA\User_LDAP;
+
+use OC\ServerNotAvailableException;
+
+class LDAP implements ILDAPWrapper {
+ protected $curFunc = '';
+ protected $curArgs = array();
+
+ /**
+ * @param resource $link
+ * @param string $dn
+ * @param string $password
+ * @return bool|mixed
+ */
+ public function bind($link, $dn, $password) {
+ return $this->invokeLDAPMethod('bind', $link, $dn, $password);
+ }
+
+ /**
+ * @param string $host
+ * @param string $port
+ * @return mixed
+ */
+ public function connect($host, $port) {
+ if(strpos($host, '://') === false) {
+ $host = 'ldap://' . $host;
+ }
+ if(strpos($host, ':', strpos($host, '://') + 1) === false) {
+ //ldap_connect ignores port parameter when URLs are passed
+ $host .= ':' . $port;
+ }
+ return $this->invokeLDAPMethod('connect', $host);
+ }
+
+ /**
+ * @param LDAP $link
+ * @param LDAP $result
+ * @param string $cookie
+ * @return bool|LDAP
+ */
+ public function controlPagedResultResponse($link, $result, &$cookie) {
+ $this->preFunctionCall('ldap_control_paged_result_response',
+ array($link, $result, $cookie));
+ $result = ldap_control_paged_result_response($link, $result, $cookie);
+ $this->postFunctionCall();
+
+ return $result;
+ }
+
+ /**
+ * @param LDAP $link
+ * @param int $pageSize
+ * @param bool $isCritical
+ * @param string $cookie
+ * @return mixed|true
+ */
+ public function controlPagedResult($link, $pageSize, $isCritical, $cookie) {
+ return $this->invokeLDAPMethod('control_paged_result', $link, $pageSize,
+ $isCritical, $cookie);
+ }
+
+ /**
+ * @param LDAP $link
+ * @param LDAP $result
+ * @return mixed
+ */
+ public function countEntries($link, $result) {
+ return $this->invokeLDAPMethod('count_entries', $link, $result);
+ }
+
+ /**
+ * @param LDAP $link
+ * @return mixed|string
+ */
+ public function errno($link) {
+ return $this->invokeLDAPMethod('errno', $link);
+ }
+
+ /**
+ * @param LDAP $link
+ * @return int|mixed
+ */
+ public function error($link) {
+ return $this->invokeLDAPMethod('error', $link);
+ }
+
+ /**
+ * Splits DN into its component parts
+ * @param string $dn
+ * @param int @withAttrib
+ * @return array|false
+ * @link http://www.php.net/manual/en/function.ldap-explode-dn.php
+ */
+ public function explodeDN($dn, $withAttrib) {
+ return $this->invokeLDAPMethod('explode_dn', $dn, $withAttrib);
+ }
+
+ /**
+ * @param LDAP $link
+ * @param LDAP $result
+ * @return mixed
+ */
+ public function firstEntry($link, $result) {
+ return $this->invokeLDAPMethod('first_entry', $link, $result);
+ }
+
+ /**
+ * @param LDAP $link
+ * @param LDAP $result
+ * @return array|mixed
+ */
+ public function getAttributes($link, $result) {
+ return $this->invokeLDAPMethod('get_attributes', $link, $result);
+ }
+
+ /**
+ * @param LDAP $link
+ * @param LDAP $result
+ * @return mixed|string
+ */
+ public function getDN($link, $result) {
+ return $this->invokeLDAPMethod('get_dn', $link, $result);
+ }
+
+ /**
+ * @param LDAP $link
+ * @param LDAP $result
+ * @return array|mixed
+ */
+ public function getEntries($link, $result) {
+ return $this->invokeLDAPMethod('get_entries', $link, $result);
+ }
+
+ /**
+ * @param LDAP $link
+ * @param resource $result
+ * @return mixed
+ */
+ public function nextEntry($link, $result) {
+ return $this->invokeLDAPMethod('next_entry', $link, $result);
+ }
+
+ /**
+ * @param LDAP $link
+ * @param string $baseDN
+ * @param string $filter
+ * @param array $attr
+ * @return mixed
+ */
+ public function read($link, $baseDN, $filter, $attr) {
+ return $this->invokeLDAPMethod('read', $link, $baseDN, $filter, $attr);
+ }
+
+ /**
+ * @param LDAP $link
+ * @param string $baseDN
+ * @param string $filter
+ * @param array $attr
+ * @param int $attrsOnly
+ * @param int $limit
+ * @return mixed
+ */
+ public function search($link, $baseDN, $filter, $attr, $attrsOnly = 0, $limit = 0) {
+ return $this->invokeLDAPMethod('search', $link, $baseDN, $filter, $attr, $attrsOnly, $limit);
+ }
+
+ /**
+ * @param LDAP $link
+ * @param string $option
+ * @param int $value
+ * @return bool|mixed
+ */
+ public function setOption($link, $option, $value) {
+ return $this->invokeLDAPMethod('set_option', $link, $option, $value);
+ }
+
+ /**
+ * @param LDAP $link
+ * @return mixed|true
+ */
+ public function startTls($link) {
+ return $this->invokeLDAPMethod('start_tls', $link);
+ }
+
+ /**
+ * @param resource $link
+ * @return bool|mixed
+ */
+ public function unbind($link) {
+ return $this->invokeLDAPMethod('unbind', $link);
+ }
+
+ /**
+ * Checks whether the server supports LDAP
+ * @return boolean if it the case, false otherwise
+ * */
+ public function areLDAPFunctionsAvailable() {
+ return function_exists('ldap_connect');
+ }
+
+ /**
+ * Checks whether PHP supports LDAP Paged Results
+ * @return boolean if it the case, false otherwise
+ * */
+ public function hasPagedResultSupport() {
+ $hasSupport = function_exists('ldap_control_paged_result')
+ && function_exists('ldap_control_paged_result_response');
+ return $hasSupport;
+ }
+
+ /**
+ * Checks whether the submitted parameter is a resource
+ * @param Resource $resource the resource variable to check
+ * @return bool true if it is a resource, false otherwise
+ */
+ public function isResource($resource) {
+ return is_resource($resource);
+ }
+
+ /**
+ * @return mixed
+ */
+ private function invokeLDAPMethod() {
+ $arguments = func_get_args();
+ $func = 'ldap_' . array_shift($arguments);
+ if(function_exists($func)) {
+ $this->preFunctionCall($func, $arguments);
+ $result = call_user_func_array($func, $arguments);
+ if ($result === FALSE) {
+ $this->postFunctionCall();
+ }
+ return $result;
+ }
+ }
+
+ /**
+ * @param string $functionName
+ * @param array $args
+ */
+ private function preFunctionCall($functionName, $args) {
+ $this->curFunc = $functionName;
+ $this->curArgs = $args;
+ }
+
+ private function postFunctionCall() {
+ if($this->isResource($this->curArgs[0])) {
+ $errorCode = ldap_errno($this->curArgs[0]);
+ $errorMsg = ldap_error($this->curArgs[0]);
+ if($errorCode !== 0) {
+ if($this->curFunc === 'ldap_get_entries'
+ && $errorCode === -4) {
+ } else if ($errorCode === 32) {
+ //for now
+ } else if ($errorCode === 10) {
+ //referrals, we switch them off, but then there is AD :)
+ } else if ($errorCode === -1) {
+ throw new ServerNotAvailableException('Lost connection to LDAP server.');
+ } else if ($errorCode === 48) {
+ throw new \Exception('LDAP authentication method rejected', $errorCode);
+ } else if ($errorCode === 1) {
+ throw new \Exception('LDAP Operations error', $errorCode);
+ } else {
+ \OCP\Util::writeLog('user_ldap',
+ 'LDAP error '.$errorMsg.' (' .
+ $errorCode.') after calling '.
+ $this->curFunc,
+ \OCP\Util::DEBUG);
+ }
+ }
+ }
+
+ $this->curFunc = '';
+ $this->curArgs = array();
+ }
+}
generated by cgit v1.2.3 (git 2.39.1) at 2025-01-30 16:46:21 +0000