/
DistinguishedName.php
443 lines (386 loc) · 9.02 KB
/
DistinguishedName.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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
<?php
namespace LdapRecord\Models\Attributes;
use LdapRecord\EscapesValues;
use LdapRecord\Support\Arr;
class DistinguishedName
{
use EscapesValues;
/**
* The underlying raw value.
*
* @var string
*/
protected $value;
/**
* Constructor.
*
* @param string|null $value
*/
public function __construct($value = null)
{
$this->value = trim((string) $value);
}
/**
* Get the distinguished name value.
*
* @return string
*/
public function __toString()
{
return (string) $this->value;
}
/**
* Alias of the "build" method.
*
* @param string|null $value
*
* @return DistinguishedNameBuilder
*/
public static function of($value = null)
{
return static::build($value);
}
/**
* Get a new DN builder object from the given DN.
*
* @param string|null $value
*
* @return DistinguishedNameBuilder
*/
public static function build($value = null)
{
return new DistinguishedNameBuilder($value);
}
/**
* Make a new distinguished name instance.
*
* @param string|null $value
*
* @return static
*/
public static function make($value = null)
{
return new static($value);
}
/**
* Determine if the given value is a valid distinguished name.
*
* @param string $value
*
* @return bool
*/
public static function isValid($value)
{
return ! static::make($value)->isEmpty();
}
/**
* Explode a distinguished name into relative distinguished names.
*
* @param string $dn
*
* @return array
*/
public static function explode($dn)
{
$components = ldap_explode_dn($dn, (int) $withoutAttributes = false);
if (! is_array($components)) {
return [];
}
if (! array_key_exists('count', $components)) {
return [];
}
unset($components['count']);
return $components;
}
/**
* Un-escapes a hexadecimal string into its original string representation.
*
* @param string $value
*
* @return string
*/
public static function unescape($value)
{
return preg_replace_callback('/\\\([0-9A-Fa-f]{2})/', function ($matches) {
return chr(hexdec($matches[1]));
}, $value);
}
/**
* Explode the RDN into an attribute and value.
*
* @param string $rdn
*
* @return array
*/
public static function explodeRdn($rdn)
{
return explode('=', $rdn, $limit = 2);
}
/**
* Implode the component attribute and value into an RDN.
*
* @param string $rdn
*
* @return string
*/
public static function makeRdn(array $component)
{
return implode('=', $component);
}
/**
* Get the underlying value.
*
* @return string|null
*/
public function get()
{
return $this->value;
}
/**
* Set the underlying value.
*
* @param string|null $value
*
* @return $this
*/
public function set($value)
{
$this->value = $value;
return $this;
}
/**
* Get the distinguished name values without attributes.
*
* @return array
*/
public function values()
{
$values = [];
foreach ($this->multi() as [, $value]) {
$values[] = static::unescape($value);
}
return $values;
}
/**
* Get the distinguished name attributes without values.
*
* @return array
*/
public function attributes()
{
$attributes = [];
foreach ($this->multi() as [$attribute]) {
$attributes[] = $attribute;
}
return $attributes;
}
/**
* Get the distinguished name components with attributes.
*
* @return array
*/
public function components()
{
$components = [];
foreach ($this->multi() as [$attribute, $value]) {
// When a distinguished name is exploded, the values are automatically
// escaped. This cannot be opted out of. Here we will unescape
// the attribute value, then re-escape it to its original
// representation from the server using the "dn" flag.
$value = $this->escape(static::unescape($value))->dn();
$components[] = static::makeRdn([$attribute, $value]);
}
return $components;
}
/**
* Convert the distinguished name into an associative array.
*
* @return array
*/
public function assoc()
{
$map = [];
foreach ($this->multi() as [$attribute, $value]) {
$attribute = $this->normalize($attribute);
array_key_exists($attribute, $map)
? $map[$attribute][] = $value
: $map[$attribute] = [$value];
}
return $map;
}
/**
* Split the RDNs into a multi-dimensional array.
*
* @return array
*/
public function multi()
{
return array_map(function ($rdn) {
return static::explodeRdn($rdn);
}, $this->rdns());
}
/**
* Split the distinguished name into an array of unescaped RDN's.
*
* @return array
*/
public function rdns()
{
return static::explode($this->value);
}
/**
* Get the first RDNs value.
*
* @return string|null
*/
public function name()
{
return Arr::first($this->values());
}
/**
* Get the first RDNs attribute.
*
* @return string|null
*/
public function head()
{
return Arr::first($this->attributes());
}
/**
* Get the relative distinguished name.
*
* @return string|null
*/
public function relative()
{
return Arr::first($this->components());
}
/**
* Alias of relative().
*
* Get the first RDN from the distinguished name.
*
* @return string|null
*/
public function first()
{
return $this->relative();
}
/**
* Get the parent distinguished name.
*
* @return string|null
*/
public function parent()
{
$components = $this->components();
array_shift($components);
return implode(',', $components) ?: null;
}
/**
* Determine if the distinguished name is empty.
*
* @return bool
*/
public function isEmpty()
{
return empty(
array_filter($this->values())
);
}
/**
* Determine if the current distinguished name is a parent of the given child.
*
* @param DistinguishedName $child
*
* @return bool
*/
public function isParentOf(self $child)
{
return $child->isChildOf($this);
}
/**
* Determine if the current distinguished name is a child of the given parent.
*
* @param DistinguishedName $parent
*
* @return bool
*/
public function isChildOf(self $parent)
{
if (
empty($components = $this->components()) ||
empty($parentComponents = $parent->components())
) {
return false;
}
array_shift($components);
return $this->compare($components, $parentComponents);
}
/**
* Determine if the current distinguished name is an ancestor of the descendant.
*
* @param DistinguishedName $descendant
*
* @return bool
*/
public function isAncestorOf(self $descendant)
{
return $descendant->isDescendantOf($this);
}
/**
* Determine if the current distinguished name is a descendant of the ancestor.
*
* @param DistinguishedName $ancestor
*
* @return bool
*/
public function isDescendantOf(self $ancestor)
{
if (
empty($components = $this->components()) ||
empty($ancestorComponents = $ancestor->components())
) {
return false;
}
if (! $length = count($components) - count($ancestorComponents)) {
return false;
}
array_splice($components, $offset = 0, $length);
return $this->compare($components, $ancestorComponents);
}
/**
* Compare whether the two distinguished name values are equal.
*
* @param array $values
* @param array $other
*
* @return bool
*/
protected function compare(array $values, array $other)
{
return $this->recase($values) == $this->recase($other);
}
/**
* Recase the array values.
*
* @param array $values
*
* @return array
*/
protected function recase(array $values)
{
return array_map([$this, 'normalize'], $values);
}
/**
* Normalize the string value.
*
* @param string $value
*
* @return string
*/
protected function normalize($value)
{
return strtolower($value);
}
}