Repository navigation
Expand file tree
/
Copy patht_ldif.py
More file actions
715 lines (631 loc) · 18.1 KB
/
Copy patht_ldif.py
File metadata and controls
715 lines (631 loc) · 18.1 KB
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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
"""
Automatic tests for python-ldap's module ldif
See https://www.python-ldap.org/ for details.
"""
import os
import textwrap
import unittest
try:
from StringIO import StringIO
except ImportError:
from io import StringIO
# Switch off processing .ldaprc or ldap.conf before importing _ldap
os.environ['LDAPNOINIT'] = '1'
import ldif
class TestLDIFParser(unittest.TestCase):
"""
Various LDIF test cases
"""
def _parse_records(
self,
ldif_string,
ignored_attr_types=None,
max_entries=0,
):
"""
Parse LDIF data in `ldif_string' into list of records
"""
ldif_file = StringIO(ldif_string)
ldif_parser = ldif.LDIFRecordList(
ldif_file,
ignored_attr_types=ignored_attr_types,
max_entries=max_entries,
)
parser_method = getattr(
ldif_parser,
'parse_%s_records' % self.record_type
)
parser_method()
if self.record_type == 'entry':
return ldif_parser.all_records
elif self.record_type == 'change':
return ldif_parser.all_modify_changes
def _unparse_records(self, records):
"""
Returns LDIF string with entry records from list `records'
"""
ldif_file = StringIO()
ldif_writer = ldif.LDIFWriter(ldif_file)
if self.record_type == 'entry':
for dn, entry in records:
ldif_writer.unparse(dn, entry)
elif self.record_type == 'change':
for dn, modops, controls in records:
ldif_writer.unparse(dn, modops)
return ldif_file.getvalue()
def check_records(
self,
ldif_string,
records,
ignored_attr_types=None,
max_entries=0
):
"""
Checks whether entry records in `ldif_string' gets correctly parsed
and matches list of unparsed `records'.
"""
ldif_string = textwrap.dedent(ldif_string).lstrip()
parsed_records = self._parse_records(
ldif_string,
ignored_attr_types=ignored_attr_types,
max_entries=max_entries,
)
generated_ldif = self._unparse_records(records)
parsed_records2 = self._parse_records(
generated_ldif,
ignored_attr_types=ignored_attr_types,
max_entries=max_entries,
)
self.assertEqual(records, parsed_records)
self.assertEqual(records, parsed_records2)
class TestEntryRecords(TestLDIFParser):
"""
Various LDIF test cases
"""
record_type='entry'
def test_empty(self):
self.check_records(
"""
version: 1
""",
[]
)
def test_simple(self):
self.check_records(
"""
version: 1
dn: cn=x,cn=y,cn=z
attrib: value
attrib: value2
""",
[
(
'cn=x,cn=y,cn=z',
{
'attrib': [b'value', b'value2'],
},
),
]
)
def test_simple2(self):
self.check_records(
"""
dn:cn=x,cn=y,cn=z
attrib:value
attrib:value2
""",
[
(
'cn=x,cn=y,cn=z',
{
'attrib': [b'value', b'value2'],
},
),
]
)
def test_multiple(self):
self.check_records(
"""
dn: cn=x,cn=y,cn=z
a: v
attrib: value
attrib: value2
dn: cn=a,cn=b,cn=c
attrib: value2
attrib: value3
b: v
""",
[
(
'cn=x,cn=y,cn=z',
{
'attrib': [b'value', b'value2'],
'a': [b'v'],
},
),
(
'cn=a,cn=b,cn=c',
{
'attrib': [b'value2', b'value3'],
'b': [b'v'],
},
),
]
)
def test_folded(self):
self.check_records(
"""
dn: cn=x,cn=y,cn=z
attrib: very\x20
long
line-folded\x20
value
attrib2: %s
""" % ('asdf.'*20), [
(
'cn=x,cn=y,cn=z',
{
'attrib': [b'very long line-folded value'],
'attrib2': [b'asdf.'*20],
}
),
]
)
def test_empty_attr_values(self):
self.check_records(
"""
dn: cn=x,cn=y,cn=z
attrib1:
attrib1: foo
attrib2:
attrib2: foo
""",
[
(
'cn=x,cn=y,cn=z',
{
'attrib1': [b'', b'foo'],
'attrib2': [b'', b'foo'],
},
),
]
)
def test_binary(self):
self.check_records(
"""
dn: cn=x,cn=y,cn=z
attrib:: CQAKOiVA
""",
[
(
'cn=x,cn=y,cn=z',
{
'attrib': [b'\t\0\n:%@'],
},
),
]
)
def test_binary2(self):
self.check_records(
"""
dn: cn=x,cn=y,cn=z
attrib::CQAKOiVA
""",
[
(
'cn=x,cn=y,cn=z',
{'attrib': [b'\t\0\n:%@']},
),
]
)
def test_big_binary(self):
self.check_records(
"""
dn: cn=x,cn=y,cn=z
attrib:: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
=
""",
[
(
'cn=x,cn=y,cn=z',
{'attrib': [500*b'\0']},
),
]
)
def test_unicode(self):
# Encode "Ströder" as UTF-8+Base64
# Putting "Ströder" in a single line would be an invalid LDIF file
# per https://tools.ietf.org/html/rfc2849 (only safe ascii is allowed in a file)
self.check_records(
"""
dn: cn=Michael Stroeder,dc=stroeder,dc=com
lastname:: U3Ryw7ZkZXI=
""",
[
(
'cn=Michael Stroeder,dc=stroeder,dc=com',
{'lastname': [b'Str\303\266der']},
),
]
)
def test_unencoded_unicode(self):
# Encode "Ströder" as UTF-8, without base64
# This is an invalid LDIF file, but such files are often found in the wild.
self.check_records(
"""
dn: cn=Michael Stroeder,dc=stroeder,dc=com
lastname: Ströder
""",
[
(
'cn=Michael Stroeder,dc=stroeder,dc=com',
{'lastname': [b'Str\303\266der']},
),
]
)
def test_sorted(self):
self.check_records(
"""
dn: cn=x,cn=y,cn=z
b: value_b
c: value_c
a: value_a
""",
[
(
'cn=x,cn=y,cn=z',
{
'a': [b'value_a'],
'b': [b'value_b'],
'c': [b'value_c'],
}
),
]
)
def test_ignored_attr_types(self):
self.check_records(
"""
dn: cn=x,cn=y,cn=z
a: value_a
b: value_b
c: value_c
""",
[
(
'cn=x,cn=y,cn=z',
{
'a': [b'value_a'],
'c': [b'value_c'],
}
),
],
ignored_attr_types=['b'],
)
def test_comments(self):
self.check_records(
"""
# comment #1
with line-folding
dn: cn=x1,cn=y1,cn=z1
b1: value_b1
c1: value_c1
a1: value_a1
# comment #2.1
# comment #2.2
dn: cn=x2,cn=y2,cn=z2
b2: value_b2
c2: value_c2
a2: value_a2
""",
[
(
'cn=x1,cn=y1,cn=z1',
{
'a1': [b'value_a1'],
'b1': [b'value_b1'],
'c1': [b'value_c1'],
}
),
(
'cn=x2,cn=y2,cn=z2',
{
'a2': [b'value_a2'],
'b2': [b'value_b2'],
'c2': [b'value_c2'],
}
),
]
)
def test_max_entries(self):
self.check_records(
"""
dn: cn=x1,cn=y1,cn=z1
b1: value_b1
a1: value_a1
dn: cn=x2,cn=y2,cn=z2
b2: value_b2
a2: value_a2
dn: cn=x3,cn=y3,cn=z3
b3: value_b3
a3: value_a3
dn: cn=x4,cn=y4,cn=z4
b2: value_b4
a2: value_a4
""",
[
(
'cn=x1,cn=y1,cn=z1',
{
'a1': [b'value_a1'],
'b1': [b'value_b1'],
}
),
(
'cn=x2,cn=y2,cn=z2',
{
'a2': [b'value_a2'],
'b2': [b'value_b2'],
}
),
],
max_entries=2
)
def test_missing_trailing_line_separator(self):
self.check_records(
"""
dn: cn=x1,cn=y1,cn=z1
first: value_a1
middle: value_b1
last: value_c1
dn: cn=x2,cn=y2,cn=z2
first: value_a2
middle: value_b2
last: value_c2""",
[
(
'cn=x1,cn=y1,cn=z1',
{
'first': [b'value_a1'],
'middle': [b'value_b1'],
'last': [b'value_c1'],
}
),
(
'cn=x2,cn=y2,cn=z2',
{
'first': [b'value_a2'],
'middle': [b'value_b2'],
'last': [b'value_c2'],
}
),
],
)
def test_weird_empty_lines(self):
self.check_records(
"""
# comment before version
version: 1
dn: cn=x1,cn=y1,cn=z1
first: value_a1
middle: value_b1
last: value_c1
dn: cn=x2,cn=y2,cn=z2
first: value_a2
middle: value_b2
last: value_c2""",
[
(
'cn=x1,cn=y1,cn=z1',
{
'first': [b'value_a1'],
'middle': [b'value_b1'],
'last': [b'value_c1'],
}
),
(
'cn=x2,cn=y2,cn=z2',
{
'first': [b'value_a2'],
'middle': [b'value_b2'],
'last': [b'value_c2'],
}
),
],
)
def test_multiple_empty_lines(self):
"""
test malformed LDIF with multiple empty lines
"""
self.check_records(
"""
# normal
dn: uid=one,dc=tld
uid: one
# after extra empty line
dn: uid=two,dc=tld
uid: two
""",
[
(
'uid=one,dc=tld',
{'uid': [b'one']}
),
(
'uid=two,dc=tld',
{'uid': [b'two']}
),
],
)
class TestChangeRecords(TestLDIFParser):
"""
Various LDIF test cases
"""
record_type='change'
def test_empty(self):
self.check_records(
"""
version: 1
""",
[],
)
def test_simple(self):
self.check_records(
"""
version: 1
dn: cn=x,cn=y,cn=z
changetype: modify
replace: attrib
attrib: value
attrib: value2
-
add: attrib2
attrib2: value
attrib2: value2
-
delete: attrib3
attrib3: value
-
delete: attrib4
-
""",
[
(
'cn=x,cn=y,cn=z',
[
(ldif.MOD_OP_INTEGER['replace'], 'attrib', [b'value', b'value2']),
(ldif.MOD_OP_INTEGER['add'], 'attrib2', [b'value', b'value2']),
(ldif.MOD_OP_INTEGER['delete'], 'attrib3', [b'value']),
(ldif.MOD_OP_INTEGER['delete'], 'attrib4', None),
],
None,
),
],
)
def test_weird_empty_lines(self):
self.check_records(
"""
# comment before version
version: 1
dn: cn=x,cn=y,cn=z
changetype: modify
replace: attrib
attrib: value
attrib: value2
-
add: attrib2
attrib2: value
attrib2: value2
-
delete: attrib3
attrib3: value
-
delete: attrib4
-
dn: cn=foo,cn=bar
changetype: modify
replace: attrib
attrib: value
attrib: value2
-
add: attrib2
attrib2: value
attrib2: value2
-
delete: attrib3
attrib3: value
-
delete: attrib4""",
[
(
'cn=x,cn=y,cn=z',
[
(ldif.MOD_OP_INTEGER['replace'], 'attrib', [b'value', b'value2']),
(ldif.MOD_OP_INTEGER['add'], 'attrib2', [b'value', b'value2']),
(ldif.MOD_OP_INTEGER['delete'], 'attrib3', [b'value']),
(ldif.MOD_OP_INTEGER['delete'], 'attrib4', None),
],
None,
),
(
'cn=foo,cn=bar',
[
(ldif.MOD_OP_INTEGER['replace'], 'attrib', [b'value', b'value2']),
(ldif.MOD_OP_INTEGER['add'], 'attrib2', [b'value', b'value2']),
(ldif.MOD_OP_INTEGER['delete'], 'attrib3', [b'value']),
(ldif.MOD_OP_INTEGER['delete'], 'attrib4', None),
],
None,
),
],
)
def test_missing_trailing_dash_separator(self):
self.check_records(
"""
version: 1
dn: cn=x,cn=y,cn=z
changetype: modify
replace: attrib
attrib: value
attrib: value2
-
add: attrib2
attrib2: value
attrib2: value2
""",
[
(
'cn=x,cn=y,cn=z',
[
(ldif.MOD_OP_INTEGER['replace'], 'attrib', [b'value', b'value2']),
(ldif.MOD_OP_INTEGER['add'], 'attrib2', [b'value', b'value2']),
],
None,
),
],
)
def test_bad_change_records(self):
for bad_ldif_string in (
"""
changetype: modify
replace: attrib
attrib: value
attrib: value2
""",
):
ldif_string = textwrap.dedent(bad_ldif_string).lstrip() + '\n'
try:
res = self._parse_records(ldif_string)
except ValueError as value_error:
pass
else:
self.fail("should have raised ValueError: %r" % bad_ldif_string)
def test_mod_increment(self):
self.check_records(
"""
version: 1
dn: cn=x,cn=y,cn=z
changetype: modify
increment: gidNumber
gidNumber: 1
-
""",
[
(
'cn=x,cn=y,cn=z',
[
(ldif.MOD_OP_INTEGER['increment'], 'gidNumber', [b'1']),
],
None,
),
],
)
if __name__ == '__main__':
unittest.main()