-
Notifications
You must be signed in to change notification settings - Fork 2
/
Client.php
405 lines (359 loc) · 9.77 KB
/
Client.php
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
<?php
namespace MediaWiki\Extension\LDAPProvider;
use BagOStuff;
use Config;
use MediaWiki\Extension\LDAPProvider\Config as LDAPConfig;
use MediaWiki\Logger\LoggerFactory;
use MWException;
class Client {
private const BOUND_NONE = 0;
private const BOUND_ADMIN = 1;
private const BOUND_USER = 2;
/**
*
* @var PlatformFunctionWrapper
*/
protected $connection = null;
/**
*
* @var Config
*/
protected $config = null;
/**
*
* @var \Psr\Log\LoggerInterface
*/
protected $logger = null;
/**
*
* @var BagOStuff
*/
protected $cache = null;
/**
*
* @var int
*/
protected $cacheTime = null;
/**
*
* @var PreSearchUsernameModifierProcessor
*/
protected $preSearchUsernameModifierProcessor = null;
/**
* @var int
*/
protected $boundTo;
/**
* @var bool
*/
protected $adminUserProvided = false;
/**
* @var bool
*/
protected $fetchedUserInfo = false;
/**
* @var ?array[]
*/
protected $userInfo = null;
/**
* @var ?string
*/
protected $LDAPUsername = null;
/**
* @param Config $config for fetching
* @param PreSearchUsernameModifierProcessor $preSearchUsernameModifierProcessor
*/
public function __construct(
Config $config,
PreSearchUsernameModifierProcessor $preSearchUsernameModifierProcessor
) {
$this->config = $config;
$this->preSearchUsernameModifierProcessor = $preSearchUsernameModifierProcessor;
if ( $this->connection === null ) {
$this->connection = new PlatformFunctionWrapper();
}
$this->logger = LoggerFactory::getInstance( __CLASS__ );
$this->boundTo = self::BOUND_NONE;
$this->adminUserProvided = false;
}
/**
* @param string $key bit to get
* @return mixed
*/
public function getConfig( $key ) {
return $this->config->get( $key );
}
/**
* Handle initialization or recall saved connection
*/
protected function init() {
// Already initialized?
if ( $this->connection->isConnected() ) {
return;
}
$this->makeNewConnection();
$this->setupCache();
$this->setConnectionOptions();
$this->maybeStartTLS();
$this->establishBinding();
}
/**
* @return PlatformFunctionWrapper
*/
protected function makeNewConnection() {
$servers = (string)( new Serverlist( $this->config ) );
$this->connection = PlatformFunctionWrapper::getConnection( $servers );
if ( !$this->connection ) {
throw new MWException( "Couldn't connect with $servers" );
}
return $this->connection;
}
/**
* Set standard configuration options
*/
protected function setConnectionOptions() {
$options = [
"LDAP_OPT_PROTOCOL_VERSION" => 3,
"LDAP_OPT_REFERRALS" => 0
];
if ( $this->config->has( ClientConfig::OPTIONS ) ) {
$options = array_merge(
$options, $this->config->get( ClientConfig::OPTIONS )
);
}
foreach ( $options as $key => $value ) {
$this->logger->debug( "Setting $key to $value" );
$ret = $this->connection->setOption( constant( $key ), $value );
if ( $ret === false ) {
$message = 'Cannot set option to LDAP connection!';
$this->logger->debug( $message, [ $key, $value ] );
}
}
}
/**
* Start encrypted connection if so configured
*/
protected function maybeStartTLS() {
if ( $this->config->has( ClientConfig::ENC_TYPE ) ) {
$encType = $this->config->get( ClientConfig::ENC_TYPE );
if ( $encType === EncType::TLS ) {
$ret = $this->connection->startTLS();
if ( $ret === false ) {
throw new MWException( 'Could not start TLS!' );
}
}
}
}
/**
* Make sure we can bind properly
*/
protected function establishBinding() {
if ( $this->boundTo == self::BOUND_ADMIN ||
$this->boundTo == self::BOUND_USER && !$this->adminUserProvided ) {
return;
}
$this->init();
$username = null;
if ( $this->config->has( ClientConfig::USER ) ) {
$username = $this->config->get( ClientConfig::USER );
}
$password = null;
if ( $this->config->has( ClientConfig::PASSWORD ) ) {
$password = $this->config->get( ClientConfig::PASSWORD );
}
$this->adminUserProvided = ( $username != null );
$ret = $this->connection->bind( $username, $password );
if ( $ret === false ) {
$error = $this->connection->error();
$errno = $this->connection->errno();
throw new MWException(
"Could not bind to LDAP: ($errno) $error"
);
}
$this->boundTo = self::BOUND_ADMIN;
}
/**
* Use whatever sort of cache we've configured
*/
protected function setupCache() {
if ( !$this->cache ) {
$conf = new LDAPConfig();
$cacheType = $conf->get( LDAPConfig::CACHE_TYPE );
if ( defined( $cacheType ) ) {
$cacheType = constant( $cacheType );
}
$this->cache = wfGetCache( $cacheType );
$this->cacheTime = $conf->get( LDAPConfig::CACHE_TIME );
}
}
/**
* Perform an LDAP search
* @param string $match desired in ldap search format
* @param string|null $basedn The base DN to search in
* @param array $attrs list of attributes to get, default to '*'
* @return array
*/
public function search( $match, $basedn = null, $attrs = [ "*" ] ) {
$this->establishBinding();
if ( $basedn === null ) {
$basedn = $this->config->get( ClientConfig::BASE_DN );
}
$runTime = -microtime( true );
$res = $this->connection->search( $basedn, $match, $attrs );
if ( !$res ) {
throw new MWException(
"Error in LDAP search: " . $this->connection->error() );
}
$entry = $this->connection->getEntries( $res );
$runTime += microtime( true );
$this->logger->debug( "Ran LDAP search for '$match' in "
. "$runTime seconds.\n" );
return $entry;
}
/**
* Get the user information
*
* @param string $username for user
* @param string $userBaseDN from configuration
* @return array
*/
public function getUserInfo( $username, $userBaseDN = '' ) {
$this->init();
$username = $this->modifyUsername( $username );
return $this->cache->getWithSetCallback(
$this->cache->makeKey(
"ldap-provider", "user-info", $username, $userBaseDN
),
$this->cacheTime,
function () use ( $username ) {
$userInfoRequest = new UserInfoRequest(
$this, $this->config
);
return $userInfoRequest->getUserInfo( $username );
}
);
}
/**
* Gets the searchstring for a user based upon settings for the domain.
* Returns a full DN for a user.
*
* @param string $username
* @return string
*/
private function getSearchString( $username ) {
$searchString = $this->config->get( ClientConfig::SEARCH_STRING );
if ( $searchString ) {
$username = $this->modifyUsername( $username );
// This is a straight bind
$userdn = str_replace( "USER-NAME", $username, $searchString );
} else {
$userdn = $this->getUserDN( $username );
}
$this->logger->debug( __METHOD__ . ": User DN is: '$userdn'" );
return $userdn;
}
/**
* Gets the DN of a user based upon settings for the domain.
* This function will set $this->LDAPUsername
*
* @param string $username user
* @param string $searchattr how to find
* @return string
*/
public function getUserDN( $username, $searchattr = '' ) {
$this->init();
if ( !$searchattr ) {
$searchattr = $this->config->get(
ClientConfig::USER_DN_SEARCH_ATTR
);
}
$modifiedUsername = $this->modifyUsername( $username );
$escapedUsername = new EscapedString( $modifiedUsername );
// we need to do a subbase search for the entry
$filter = "(" . $searchattr . "=" . $escapedUsername . ")";
// We explicitly put memberof here because it's an operational
// attribute in some servers.
$attributes = [ "*", "memberof" ];
$base = $this->config->get( ClientConfig::BASE_DN );
$this->logger->debug(
__METHOD__ . ': search with ' . var_export( [
'base' => $base,
'filter' => $filter,
'attributes' => $attributes
], true )
);
$entry = $this->connection->search( $base, $filter, $attributes );
if ( $this->connection->count( $entry ) == 0 ) {
$this->fetchedUserInfo = false;
$this->userInfo = null;
$this->logger->debug( "Could not get user DN!" );
return '';
}
$this->userInfo = $this->connection->getEntries( $entry );
$this->fetchedUserInfo = true;
if ( isset( $this->userInfo[0][$searchattr] ) ) {
$username = $this->userInfo[0][$searchattr][0];
$this->LDAPUsername = $username;
}
$userdn = $this->userInfo[0]["dn"];
$this->logger->debug( "Found user DN: '$userdn'" );
return $userdn;
}
/**
* Method to determine whether a LDAP password is valid for a
* specific user on the current connection
*
* @param string $username for user
* @param string $password for user
* @return bool
*
* @fixme two binds are done here, first is as admin in init()
*/
public function canBindAs( $username, $password ) {
$this->init();
$username = $this->getSearchString( $username );
if ( $username === '' ) {
return false;
}
$res = $this->connection->bind( $username, $password );
if ( $res ) {
$this->boundTo = self::BOUND_USER;
}
return $res;
}
/**
* @param string $username for user
* @param string $groupBaseDN for group
* @return GroupList
*/
public function getUserGroups( $username, $groupBaseDN = '' ) {
$this->init();
$username = $this->modifyUsername( $username );
return $this->cache->getWithSetCallback(
$this->cache->makeKey(
"ldap-provider", "user-groups", $username, $groupBaseDN
),
$this->cacheTime,
function () use ( $username ) {
$factoryCallback = $this->config->get( 'grouprequest' );
$request = $factoryCallback( $this, $this->config );
if ( $request instanceof UserGroupsRequest === false ) {
throw new MWException( "Configured GroupRequest not valid" );
}
return $request->getUserGroups( $username );
}
);
}
/**
*
* @param string $username
* @return string
*/
private function modifyUsername( $username ) {
$modifiedUsername = $this->preSearchUsernameModifierProcessor->process(
$username,
$this->config->get( 'presearchusernamemodifiers' )
);
return $modifiedUsername;
}
}