You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
216 lines
6.7 KiB
216 lines
6.7 KiB
<?php |
|
/** |
|
* @copyright Copyright (c) 2016, ownCloud, Inc. |
|
* |
|
* @author Arthur Schiwon <blizzz@arthur-schiwon.de> |
|
* @author Joas Schilling <coding@schilljs.com> |
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de> |
|
* @author Lukas Reschke <lukas@statuscode.ch> |
|
* @author Morris Jobke <hey@morrisjobke.de> |
|
* @author Robin McCorkell <robin@mccorkell.me.uk> |
|
* @author Roger Szabo <roger.szabo@web.de> |
|
* @author Vinicius Cubas Brand <vinicius@eita.org.br> |
|
* |
|
* @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; |
|
|
|
interface ILDAPWrapper { |
|
|
|
//LDAP functions in use |
|
|
|
/** |
|
* Bind to LDAP directory |
|
* @param resource $link LDAP link resource |
|
* @param string $dn an RDN to log in with |
|
* @param string $password the password |
|
* @return bool true on success, false otherwise |
|
* |
|
* with $dn and $password as null a anonymous bind is attempted. |
|
*/ |
|
public function bind($link, $dn, $password); |
|
|
|
/** |
|
* connect to an LDAP server |
|
* @param string $host The host to connect to |
|
* @param string $port The port to connect to |
|
* @return mixed a link resource on success, otherwise false |
|
*/ |
|
public function connect($host, $port); |
|
|
|
/** |
|
* Send LDAP pagination control |
|
* @param resource $link LDAP link resource |
|
* @param int $pageSize number of results per page |
|
* @param bool $isCritical Indicates whether the pagination is critical of not. |
|
* @param string $cookie structure sent by LDAP server |
|
* @return bool true on success, false otherwise |
|
*/ |
|
public function controlPagedResult($link, $pageSize, $isCritical, $cookie); |
|
|
|
/** |
|
* Retrieve the LDAP pagination cookie |
|
* @param resource $link LDAP link resource |
|
* @param resource $result LDAP result resource |
|
* @param string $cookie structure sent by LDAP server |
|
* @return bool true on success, false otherwise |
|
* |
|
* Corresponds to ldap_control_paged_result_response |
|
*/ |
|
public function controlPagedResultResponse($link, $result, &$cookie); |
|
|
|
/** |
|
* Count the number of entries in a search |
|
* @param resource $link LDAP link resource |
|
* @param resource $result LDAP result resource |
|
* @return int|false number of results on success, false otherwise |
|
*/ |
|
public function countEntries($link, $result); |
|
|
|
/** |
|
* Return the LDAP error number of the last LDAP command |
|
* @param resource $link LDAP link resource |
|
* @return int error code |
|
*/ |
|
public function errno($link); |
|
|
|
/** |
|
* Return the LDAP error message of the last LDAP command |
|
* @param resource $link LDAP link resource |
|
* @return string error message |
|
*/ |
|
public function 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 first result id |
|
* @param resource $link LDAP link resource |
|
* @param resource $result LDAP result resource |
|
* @return Resource an LDAP search result resource |
|
* */ |
|
public function firstEntry($link, $result); |
|
|
|
/** |
|
* Get attributes from a search result entry |
|
* @param resource $link LDAP link resource |
|
* @param resource $result LDAP result resource |
|
* @return array containing the results, false on error |
|
* */ |
|
public function getAttributes($link, $result); |
|
|
|
/** |
|
* Get the DN of a result entry |
|
* @param resource $link LDAP link resource |
|
* @param resource $result LDAP result resource |
|
* @return string containing the DN, false on error |
|
*/ |
|
public function getDN($link, $result); |
|
|
|
/** |
|
* Get all result entries |
|
* @param resource $link LDAP link resource |
|
* @param resource $result LDAP result resource |
|
* @return array containing the results, false on error |
|
*/ |
|
public function getEntries($link, $result); |
|
|
|
/** |
|
* Return next result id |
|
* @param resource $link LDAP link resource |
|
* @param resource $result LDAP entry result resource |
|
* @return resource an LDAP search result resource |
|
* */ |
|
public function nextEntry($link, $result); |
|
|
|
/** |
|
* Read an entry |
|
* @param resource $link LDAP link resource |
|
* @param array $baseDN The DN of the entry to read from |
|
* @param string $filter An LDAP filter |
|
* @param array $attr array of the attributes to read |
|
* @return resource an LDAP search result resource |
|
*/ |
|
public function read($link, $baseDN, $filter, $attr); |
|
|
|
/** |
|
* Search LDAP tree |
|
* @param resource $link LDAP link resource |
|
* @param string $baseDN The DN of the entry to read from |
|
* @param string $filter An LDAP filter |
|
* @param array $attr array of the attributes to read |
|
* @param int $attrsOnly optional, 1 if only attribute types shall be returned |
|
* @param int $limit optional, limits the result entries |
|
* @return resource|false an LDAP search result resource, false on error |
|
*/ |
|
public function search($link, $baseDN, $filter, $attr, $attrsOnly = 0, $limit = 0); |
|
|
|
/** |
|
* Replace the value of a userPassword by $password |
|
* @param resource $link LDAP link resource |
|
* @param string $userDN the DN of the user whose password is to be replaced |
|
* @param string $password the new value for the userPassword |
|
* @return bool true on success, false otherwise |
|
*/ |
|
public function modReplace($link, $userDN, $password); |
|
|
|
/** |
|
* Sets the value of the specified option to be $value |
|
* @param resource $link LDAP link resource |
|
* @param string $option a defined LDAP Server option |
|
* @param int $value the new value for the option |
|
* @return bool true on success, false otherwise |
|
*/ |
|
public function setOption($link, $option, $value); |
|
|
|
/** |
|
* establish Start TLS |
|
* @param resource $link LDAP link resource |
|
* @return bool true on success, false otherwise |
|
*/ |
|
public function startTls($link); |
|
|
|
/** |
|
* Unbind from LDAP directory |
|
* @param resource $link LDAP link resource |
|
* @return bool true on success, false otherwise |
|
*/ |
|
public function unbind($link); |
|
|
|
//additional required methods in Nextcloud |
|
|
|
/** |
|
* Checks whether the server supports LDAP |
|
* @return bool true if it the case, false otherwise |
|
* */ |
|
public function areLDAPFunctionsAvailable(); |
|
|
|
/** |
|
* 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); |
|
|
|
}
|
|
|