LDAP::startTls() - Code Metrics - Inspection of "Merge pull request #12053 from nextcloud/enhanceme..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( aff53d...7aa76a )

by Morris

created 2018-10-26 08:28 UTC

LDAP::startTls() A

↳ Parent: LDAP

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	2
rs	10
c	0
b	0
f	0

<?php
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 *
 * @author Alexander Bergolth <[email protected]>
 * @author Arthur Schiwon <[email protected]>
 * @author Joas Schilling <[email protected]>
 * @author Jörn Friedrich Dreyer <[email protected]>
 * @author Lukas Reschke <[email protected]>
 * @author Morris Jobke <[email protected]>
 * @author Robin McCorkell <[email protected]>
 * @author Roger Szabo <[email protected]>
 *
 * @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;
use OCA\User_LDAP\Exceptions\ConstraintViolationException;

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 resource $link
	 * @param resource $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 integer
	 */
	public function errno($link) {
		return $this->invokeLDAPMethod('errno', $link);
	}

	/**
	 * @param LDAP $link
	 * @return string
	 */
	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 $userDN
	 * @param string $password
	 * @return bool
	 */
	public function modReplace($link, $userDN, $password) {
		return $this->invokeLDAPMethod('mod_replace', $link, $userDN, array('userPassword' => $password));
	}

	/**
	 * @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 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);
	}

	/**
	 * Checks whether the return value from LDAP is wrong or not.
	 *
	 * When using ldap_search we provide an array, in case multiple bases are
	 * configured. Thus, we need to check the array elements.
	 *
	 * @param $result
	 * @return bool
	 */
	protected function isResultFalse($result) {
		if($result === false) {
			return true;
		}

		if($this->curFunc === 'ldap_search' && is_array($result)) {
			foreach ($result as $singleResult) {
				if($singleResult === false) {
					return true;
				}
			}
		}

		return false;
	}

	/**
	 * @return mixed
	 */
	protected 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 ($this->isResultFalse($result)) {
				$this->postFunctionCall();
			}
			return $result;
		}
		return null;
	}

	/**
	 * @param string $functionName
	 * @param array $args
	 */
	private function preFunctionCall($functionName, $args) {
		$this->curFunc = $functionName;
		$this->curArgs = $args;
	}

	/**
	 * Analyzes the returned LDAP error and acts accordingly if not 0
	 *
	 * @param resource $resource the LDAP Connection resource
	 * @throws ConstraintViolationException
	 * @throws ServerNotAvailableException
	 * @throws \Exception
	 */
	private function processLDAPError($resource) {
		$errorCode = ldap_errno($resource);
		if($errorCode === 0) {
			return;
		}
		$errorMsg  = ldap_error($resource);

		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 === 52) {
			throw new ServerNotAvailableException('LDAP server is shutting down.');
		} else if ($errorCode === 48) {
			throw new \Exception('LDAP authentication method rejected', $errorCode);
		} else if ($errorCode === 1) {
			throw new \Exception('LDAP Operations error', $errorCode);
		} else if ($errorCode === 19) {
			ldap_get_option($this->curArgs[0], LDAP_OPT_ERROR_STRING, $extended_error);
			throw new ConstraintViolationException(!empty($extended_error)?$extended_error:$errorMsg, $errorCode);
		} else {
			\OC::$server->getLogger()->debug('LDAP error {message} ({code}) after calling {func}', [
				'app' => 'user_ldap',
				'message' => $errorMsg,
				'code' => $errorCode,
				'func' => $this->curFunc,
			]);
		}
	}

	/**
	 * Called after an ldap method is run to act on LDAP error if necessary
	 */
	private function postFunctionCall() {
		if($this->isResource($this->curArgs[0])) {
			$resource = $this->curArgs[0];
		} else if(
			   $this->curFunc === 'ldap_search'
			&& is_array($this->curArgs[0])
			&& $this->isResource($this->curArgs[0][0])
		) {
			// we use always the same LDAP connection resource, is enough to
			// take the first one.
			$resource = $this->curArgs[0][0];
		} else {
			return;
		}

		$this->processLDAPError($resource);

		$this->curFunc = '';
		$this->curArgs = [];
	}
}


1			<?php
2			/**
3			* @copyright Copyright (c) 2016, ownCloud, Inc.
4			*
5			* @author Alexander Bergolth <[email protected]>
6			* @author Arthur Schiwon <[email protected]>
7			* @author Joas Schilling <[email protected]>
8			* @author Jörn Friedrich Dreyer <[email protected]>
9			* @author Lukas Reschke <[email protected]>
10			* @author Morris Jobke <[email protected]>
11			* @author Robin McCorkell <[email protected]>
12			* @author Roger Szabo <[email protected]>
13			*
14			* @license AGPL-3.0
15			*
16			* This code is free software: you can redistribute it and/or modify
17			* it under the terms of the GNU Affero General Public License, version 3,
18			* as published by the Free Software Foundation.
19			*
20			* This program is distributed in the hope that it will be useful,
21			* but WITHOUT ANY WARRANTY; without even the implied warranty of
22			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23			* GNU Affero General Public License for more details.
24			*
25			* You should have received a copy of the GNU Affero General Public License, version 3,
26			* along with this program. If not, see <http://www.gnu.org/licenses/>
27			*
28			*/
29
30			namespace OCA\User_LDAP;
31
32			use OC\ServerNotAvailableException;
33			use OCA\User_LDAP\Exceptions\ConstraintViolationException;
34
35			class LDAP implements ILDAPWrapper {
36			protected $curFunc = '';
37			protected $curArgs = array();
38
39			/**
40			* @param resource $link
41			* @param string $dn
42			* @param string $password
43			* @return bool\|mixed
44			*/
45			public function bind($link, $dn, $password) {
46			return $this->invokeLDAPMethod('bind', $link, $dn, $password);
47			}
48
49			/**
50			* @param string $host
51			* @param string $port
52			* @return mixed
53			*/
54			public function connect($host, $port) {
55			if(strpos($host, '://') === false) {
56			$host = 'ldap://' . $host;
57			}
58			if(strpos($host, ':', strpos($host, '://') + 1) === false) {
59			//ldap_connect ignores port parameter when URLs are passed
60			$host .= ':' . $port;
61			}
62			return $this->invokeLDAPMethod('connect', $host);
63			}
64
65			/**
66			* @param resource $link
67			* @param resource $result
68			* @param string $cookie
69			* @return bool\|LDAP
70			*/
71			public function controlPagedResultResponse($link, $result, &$cookie) {
72			$this->preFunctionCall('ldap_control_paged_result_response',
73			array($link, $result, $cookie));
74			$result = ldap_control_paged_result_response($link, $result, $cookie);
75			$this->postFunctionCall();
76
77			return $result;
78			}
79
80			/**
81			* @param LDAP $link
82			* @param int $pageSize
83			* @param bool $isCritical
84			* @param string $cookie
85			* @return mixed\|true
86			*/
87			public function controlPagedResult($link, $pageSize, $isCritical, $cookie) {
88			return $this->invokeLDAPMethod('control_paged_result', $link, $pageSize,
89			$isCritical, $cookie);
90			}
91
92			/**
93			* @param LDAP $link
94			* @param LDAP $result
95			* @return mixed
96			*/
97			public function countEntries($link, $result) {
98			return $this->invokeLDAPMethod('count_entries', $link, $result);
99			}
100
101			/**
102			* @param LDAP $link
103			* @return integer
104			*/
105			public function errno($link) {
106			return $this->invokeLDAPMethod('errno', $link);
107			}
108
109			/**
110			* @param LDAP $link
111			* @return string
112			*/
113			public function error($link) {
114			return $this->invokeLDAPMethod('error', $link);
115			}
116
117			/**
118			* Splits DN into its component parts
119			* @param string $dn
120			* @param int @withAttrib
			0 ignored issues – show Documentation Bug introduced 2018-10-24 12:40 UTC by Report Bug Copy Issue Report The doc comment `@withAttrib` at position `0` could not be parsed: Unknown type name '@withAttrib' at position 0 in @withAttrib. Loading history...
121			* @return array\|false
122			* @link http://www.php.net/manual/en/function.ldap-explode-dn.php
123			*/
124			public function explodeDN($dn, $withAttrib) {
125			return $this->invokeLDAPMethod('explode_dn', $dn, $withAttrib);
126			}
127
128			/**
129			* @param LDAP $link
130			* @param LDAP $result
131			* @return mixed
132			*/
133			public function firstEntry($link, $result) {
134			return $this->invokeLDAPMethod('first_entry', $link, $result);
135			}
136
137			/**
138			* @param LDAP $link
139			* @param LDAP $result
140			* @return array\|mixed
141			*/
142			public function getAttributes($link, $result) {
143			return $this->invokeLDAPMethod('get_attributes', $link, $result);
144			}
145
146			/**
147			* @param LDAP $link
148			* @param LDAP $result
149			* @return mixed\|string
150			*/
151			public function getDN($link, $result) {
152			return $this->invokeLDAPMethod('get_dn', $link, $result);
153			}
154
155			/**
156			* @param LDAP $link
157			* @param LDAP $result
158			* @return array\|mixed
159			*/
160			public function getEntries($link, $result) {
161			return $this->invokeLDAPMethod('get_entries', $link, $result);
162			}
163
164			/**
165			* @param LDAP $link
166			* @param resource $result
167			* @return mixed
168			*/
169			public function nextEntry($link, $result) {
170			return $this->invokeLDAPMethod('next_entry', $link, $result);
171			}
172
173			/**
174			* @param LDAP $link
175			* @param string $baseDN
176			* @param string $filter
177			* @param array $attr
178			* @return mixed
179			*/
180			public function read($link, $baseDN, $filter, $attr) {
181			return $this->invokeLDAPMethod('read', $link, $baseDN, $filter, $attr);
182			}
183
184			/**
185			* @param LDAP $link
186			* @param string $baseDN
187			* @param string $filter
188			* @param array $attr
189			* @param int $attrsOnly
190			* @param int $limit
191			* @return mixed
192			*/
193			public function search($link, $baseDN, $filter, $attr, $attrsOnly = 0, $limit = 0) {
194			return $this->invokeLDAPMethod('search', $link, $baseDN, $filter, $attr, $attrsOnly, $limit);
195			}
196
197			/**
198			* @param LDAP $link
199			* @param string $userDN
200			* @param string $password
201			* @return bool
202			*/
203			public function modReplace($link, $userDN, $password) {
204			return $this->invokeLDAPMethod('mod_replace', $link, $userDN, array('userPassword' => $password));
205			}
206
207			/**
208			* @param LDAP $link
209			* @param string $option
210			* @param int $value
211			* @return bool\|mixed
212			*/
213			public function setOption($link, $option, $value) {
214			return $this->invokeLDAPMethod('set_option', $link, $option, $value);
215			}
216
217			/**
218			* @param LDAP $link
219			* @return mixed\|true
220			*/
221			public function startTls($link) {
222			return $this->invokeLDAPMethod('start_tls', $link);
223			}
224
225			/**
226			* @param resource $link
227			* @return bool\|mixed
228			*/
229			public function unbind($link) {
230			return $this->invokeLDAPMethod('unbind', $link);
231			}
232
233			/**
234			* Checks whether the server supports LDAP
235			* @return boolean if it the case, false otherwise
236			* */
237			public function areLDAPFunctionsAvailable() {
238			return function_exists('ldap_connect');
239			}
240
241			/**
242			* Checks whether the submitted parameter is a resource
243			* @param Resource $resource the resource variable to check
244			* @return bool true if it is a resource, false otherwise
245			*/
246			public function isResource($resource) {
247			return is_resource($resource);
248			}
249
250			/**
251			* Checks whether the return value from LDAP is wrong or not.
252			*
253			* When using ldap_search we provide an array, in case multiple bases are
254			* configured. Thus, we need to check the array elements.
255			*
256			* @param $result
257			* @return bool
258			*/
259			protected function isResultFalse($result) {
260			if($result === false) {
261			return true;
262			}
263
264			if($this->curFunc === 'ldap_search' && is_array($result)) {
265			foreach ($result as $singleResult) {
266			if($singleResult === false) {
267			return true;
268			}
269			}
270			}
271
272			return false;
273			}
274
275			/**
276			* @return mixed
277			*/
278			protected function invokeLDAPMethod() {
279			$arguments = func_get_args();
280			$func = 'ldap_' . array_shift($arguments);
281			if(function_exists($func)) {
282			$this->preFunctionCall($func, $arguments);
283			$result = call_user_func_array($func, $arguments);
284			if ($this->isResultFalse($result)) {
285			$this->postFunctionCall();
286			}
287			return $result;
288			}
289			return null;
290			}
291
292			/**
293			* @param string $functionName
294			* @param array $args
295			*/
296			private function preFunctionCall($functionName, $args) {
297			$this->curFunc = $functionName;
298			$this->curArgs = $args;
299			}
300
301			/**
302			* Analyzes the returned LDAP error and acts accordingly if not 0
303			*
304			* @param resource $resource the LDAP Connection resource
305			* @throws ConstraintViolationException
306			* @throws ServerNotAvailableException
307			* @throws \Exception
308			*/
309			private function processLDAPError($resource) {
310			$errorCode = ldap_errno($resource);
311			if($errorCode === 0) {
312			return;
313			}
314			$errorMsg = ldap_error($resource);
315
316			if($this->curFunc === 'ldap_get_entries'
317			&& $errorCode === -4) {
318			} else if ($errorCode === 32) {
319			//for now
320			} else if ($errorCode === 10) {
321			//referrals, we switch them off, but then there is AD :)
322			} else if ($errorCode === -1) {
323			throw new ServerNotAvailableException('Lost connection to LDAP server.');
324			} else if ($errorCode === 52) {
325			throw new ServerNotAvailableException('LDAP server is shutting down.');
326			} else if ($errorCode === 48) {
327			throw new \Exception('LDAP authentication method rejected', $errorCode);
328			} else if ($errorCode === 1) {
329			throw new \Exception('LDAP Operations error', $errorCode);
330			} else if ($errorCode === 19) {
331			ldap_get_option($this->curArgs[0], LDAP_OPT_ERROR_STRING, $extended_error);
332			throw new ConstraintViolationException(!empty($extended_error)?$extended_error:$errorMsg, $errorCode);
333			} else {
334			\OC::$server->getLogger()->debug('LDAP error {message} ({code}) after calling {func}', [
335			'app' => 'user_ldap',
336			'message' => $errorMsg,
337			'code' => $errorCode,
338			'func' => $this->curFunc,
339			]);
340			}
341			}
342
343			/**
344			* Called after an ldap method is run to act on LDAP error if necessary
345			*/
346			private function postFunctionCall() {
347			if($this->isResource($this->curArgs[0])) {
348			$resource = $this->curArgs[0];
349			} else if(
350			$this->curFunc === 'ldap_search'
351			&& is_array($this->curArgs[0])
352			&& $this->isResource($this->curArgs[0][0])
353			) {
354			// we use always the same LDAP connection resource, is enough to
355			// take the first one.
356			$resource = $this->curArgs[0][0];
357			} else {
358			return;
359			}
360
361			$this->processLDAPError($resource);
362
363			$this->curFunc = '';
364			$this->curArgs = [];
365			}
366			}
367

nextcloud / server

Push — master ( aff53d...7aa76a )

LDAP::startTls() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like