1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
<?php
/**
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OCA\User_LDAP;
interface ILDAPWrapper {
//LDAP functions in use
/**
* Bind to LDAP directory
* @param \LDAP\Connection $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 \LDAP\Connection|false a link resource on success, otherwise false
*/
public function connect($host, $port);
/**
* Retrieve the LDAP pagination cookie
* @param \LDAP\Connection $link LDAP link resource
* @param \LDAP\Result $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 \LDAP\Connection $link LDAP link resource
* @param \LDAP\Result $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 \LDAP\Connection $link LDAP link resource
* @return int error code
*/
public function errno($link);
/**
* Return the LDAP error message of the last LDAP command
* @param \LDAP\Connection $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 https://www.php.net/manual/en/function.ldap-explode-dn.php
*/
public function explodeDN($dn, $withAttrib);
/**
* Return first result id
* @param \LDAP\Connection $link LDAP link resource
* @param \LDAP\Result $result LDAP result resource
* @return \LDAP\ResultEntry an LDAP entry resource
* */
public function firstEntry($link, $result);
/**
* Get attributes from a search result entry
* @param \LDAP\Connection $link LDAP link resource
* @param \LDAP\ResultEntry $result LDAP result resource
* @return array|false containing the results, false on error
* */
public function getAttributes($link, $result);
/**
* Get the DN of a result entry
* @param \LDAP\Connection $link LDAP link resource
* @param \LDAP\ResultEntry $result LDAP result resource
* @return string|false containing the DN, false on error
*/
public function getDN($link, $result);
/**
* Get all result entries
* @param \LDAP\Connection $link LDAP link resource
* @param \LDAP\Result $result LDAP result resource
* @return array|false containing the results, false on error
*/
public function getEntries($link, $result);
/**
* Return next result id
* @param \LDAP\Connection $link LDAP link resource
* @param \LDAP\ResultEntry $result LDAP result resource
* @return \LDAP\ResultEntry an LDAP entry resource
* */
public function nextEntry($link, $result);
/**
* Read an entry
* @param \LDAP\Connection $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
* @return \LDAP\Result an LDAP search result resource
*/
public function read($link, $baseDN, $filter, $attr);
/**
* Search LDAP tree
* @param \LDAP\Connection $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 \LDAP\Result|false an LDAP search result resource, false on error
*/
public function search($link, string $baseDN, string $filter, array $attr, int $attrsOnly = 0, int $limit = 0, int $pageSize = 0, string $cookie = '');
/**
* Replace the value of a userPassword by $password
* @param \LDAP\Connection $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);
/**
* Performs a PASSWD extended operation.
* @param \LDAP\Connection $link LDAP link resource
* @return bool|string The generated password if new_password is empty or omitted. Otherwise true on success and false on failure.
*/
public function exopPasswd($link, string $userDN, string $oldPassword, string $password);
/**
* Sets the value of the specified option to be $value
* @param \LDAP\Connection $link LDAP link resource
* @param int $option a defined LDAP Server option
* @param mixed $value the new value for the option
* @return bool true on success, false otherwise
*/
public function setOption($link, $option, $value);
/**
* establish Start TLS
* @param \LDAP\Connection $link LDAP link resource
* @return bool true on success, false otherwise
*/
public function startTls($link);
/**
* Unbind from LDAP directory
* @param \LDAP\Connection $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 mixed $resource the resource variable to check
* @psalm-assert-if-true object $resource
* @return bool true if it is a resource or LDAP object, false otherwise
*/
public function isResource($resource);
}
|
