forked from baccenfutter/ldap_hopper
-
Notifications
You must be signed in to change notification settings - Fork 1
/
ldap_hopper.py
508 lines (436 loc) · 16.4 KB
/
ldap_hopper.py
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
"""ldap_hopper.nodes"""
__author__ = "Brian Wiborg <baccenfutter@c-base.org>"
__date__ = "2013-12-01"
__license__ = "public domain"
import ldap
from ldap.modlist import addModlist
class Cursor(object):
def __init__(self, server: str, dn: str, bind_dn: str, bind_pw: str):
"""
:param server: LDAP server url
:param dn: distinguishable name
:param bind_dn: bindDN
:param bind_pw: password for bindDN
"""
self.server = self.__qualify_server(server)
self.dn = dn
self.__bind_dn = bind_dn
self.__bind_pw = bind_pw
def __repr__(self):
return "<Cursor(%s)>" % self.dn
def __getitem__(self, item: any):
if item in self.attrs:
return self.attrs[item]
def __setitem__(self, key: str, value: any):
self.attrs = {key: value}
def __initialize(self):
"""Convenience wrapper for initializing the LDAP connection"""
self.__session = ldap.initialize(self.server)
self.__session.simple_bind_s(self.__bind_dn, self.__bind_pw)
def __unbind(self):
self.__session.unbind_s()
@staticmethod
def __qualify_server(server: str):
"""Convenience helper for qualifying hostname of server
:param server: Hostname"""
try:
if not server.startswith("ldap://"):
server = "ldap://%s" % server
if ":" not in server[7:]:
server = server + ":389"
if not server.endswith("/"):
server = server + "/"
return server
except Exception:
raise ValueError("Malformed hostname: %s" % server)
@property
def attrs(self):
"""Load all attributes into local cache"""
self.__initialize()
scope = ldap.SCOPE_BASE
attr_filter = "objectClass=*"
result = dict(self.__session.search_s(self.dn, scope, attr_filter, None)[0][1])
self.__unbind()
return result
@attrs.setter
def attrs(self, new_attrs: dict):
assert isinstance(new_attrs, dict), "Not of type dict: {}".format(new_attrs)
old_attrs = self.attrs
change_list = []
for set_k, set_v in new_attrs.items():
# make sure the value is a list
if not isinstance(set_v, list):
set_v = [set_v]
action = None
if set_k not in old_attrs:
action = ldap.MOD_ADD
elif old_attrs[set_k] != set_v:
action = ldap.MOD_REPLACE
else:
raise NotImplementedError("BUG! BUG! BUG!")
change_list.append((action, str(set_k), set_v))
if change_list:
self.__initialize()
self.__session.modify_s(self.dn, change_list)
self.__unbind()
def set_password(self, old_pw: str, new_pw: str):
self.__initialize()
self.__session.passwd_s(self.dn, old_pw, new_pw)
self.__unbind()
@property
def parent(self):
"""Obtain parent object
:returns obj: instance of ldap_hopper.Cursor
"""
self.__initialize()
dn = ",".join(self.dn.split(",")[1:])
try:
parent = self.__session.search_s(dn, ldap.SCOPE_BASE, "objectClass=*")
except Exception:
return None
self.__unbind()
dn = parent[0][0]
attrs = parent[0][1]
return Cursor(self.server, dn, self.__bind_dn, self.__bind_pw)
@property
def children(self):
"""Obtain all children (onelevel)
:returns list: instances of ldap_hopper.Cursor
"""
self.__initialize()
search_filter = "objectClass=*"
result_id = self.__session.search(self.dn, ldap.SCOPE_ONELEVEL, search_filter)
output = []
while 1:
r_type, r_data = self.__session.result(result_id, 0)
if not r_data:
break
else:
if r_type == ldap.RES_SEARCH_ENTRY:
if isinstance(r_data, list):
for r in r_data:
dn = r[0]
output.append(
Cursor(self.server, dn, self.__bind_dn, self.__bind_pw)
)
else:
dn = r_data[0]
output.append(
Cursor(self.server, dn, self.__bind_dn, self.__bind_pw)
)
self.__unbind()
return output
@property
def subs(self):
"""Obtain children (subtree)
:returns list: instances of ldap_hopper.Cursor
"""
self.__initialize()
search_filter = "objectClass=*"
result_id = self.__session.search(self.dn, ldap.SCOPE_SUBTREE, search_filter)
output = []
while 1:
r_type, r_data = self.__session.result(result_id, 0)
if r_data is []:
break
else:
if r_type == ldap.RES_SEARCH_ENTRY:
if isinstance(r_data, list):
for r in r_data:
dn = r[0]
output.append(
Cursor(self.server, dn, self.__bind_dn, self.__bind_pw)
)
else:
dn = r_data[0]
output.append(
Cursor(self.server, dn, self.__bind_dn, self.__bind_pw)
)
self.__unbind()
return output
def new_cursor(self, dn: str = None, bind_dn: str = None, bind_pw: str = None):
if dn is None:
if bind_dn is None:
dn = self.dn
else:
dn = bind_dn
if bind_dn is None and bind_pw is None:
bind_dn = self.__bind_dn
bind_pw = self.__bind_pw
return Cursor(self.server, dn, bind_dn, bind_pw)
def add_child(self, dn: str, attrs: dict):
"""Add a child-node to this object-node
:param dn: either dn or rdn relative to self.dn
:param attrs: attributes dictionary
:returns obj: instance of Cursor
"""
if self.dn not in dn:
dn = "%s,%s" % (dn, self.dn)
ldif = addModlist(attrs)
self.__initialize()
self.__session.add_s(dn, ldif)
self.__unbind()
return Cursor(self.server, dn, self.__bind_dn, self.__bind_pw)
def delete(self):
"""Delete this object-node
:returns None: or passes python-ldap exception
"""
self.__initialize()
self.__session.delete_s(self.dn)
self.__unbind()
return None
def modify(self, new_attrs: dict):
self.__initialize()
change = ldap.modlist.modifyModlist(self.attrs, new_attrs)
self.__session.modify_s(self.dn, change)
self.__unbind()
return self
def search(self, search_filter, scope=None):
"""Search from this node as search-base
:param search_filter:
:param scope: search_scope, e.g. ldap.SCOPE_SUBTREE
(defaults to ldap.SCOPE_ONELEVEL)
"""
if scope is None:
scope = ldap.SCOPE_ONELEVEL
if scope == "subtree":
scope = ldap.SCOPE_SUBTREE
self.__initialize()
result_id = self.__session.search(self.dn, scope, search_filter)
output = []
while True:
r_type, r_data = self.__session.result(result_id, 0)
if r_data is []:
break
else:
if r_type == ldap.RES_SEARCH_ENTRY:
if isinstance(r_data, list):
for r in r_data:
dn = r[0]
output.append(
Cursor(self.server, dn, self.__bind_dn, self.__bind_pw)
)
else:
dn = r[0]
output.append(
Cursor(self.server, dn, self.__bind_dn, self.__bind_pw)
)
return output
def as_tuple(self):
"""Convenience method for obtaining a ldap result-like tuple
:returns tuple: ( str(dn), dict(attrs) )
"""
return self.dn, self.attrs
class ObjectNode(object):
def __new__(cls, *args, **kwargs):
print("ObjectNode is deprecated, use Cursor instead!")
return object.__new__(cls)
def __init__(self, server, dn, bind_dn, bind_pw):
"""
:param server: LDAP server url
:param dn: distinguishable name
:param bind_dn: bindDN
:param bind_pw: password for bindDN
"""
self.server = self.__qualify_server(server)
self.dn = dn
self.__bind_dn = bind_dn
self.__bind_pw = bind_pw
def __repr__(self):
return "<ObjectNode(%s)>" % self.dn
def __getitem__(self, item):
attrs = self.get_attrs()
if item in attrs:
return attrs[item]
def __setitem__(self, key, value):
self.set_attrs({key: value})
def __initialize(self):
"""Convenience wrapper for initializing the LDAP connection"""
self.__session = ldap.initialize(self.server)
self.__session.simple_bind_s(self.__bind_dn, self.__bind_pw)
def __unbind(self):
self.__session.unbind_s()
@staticmethod
def __qualify_server(server):
"""Convenience helper for qualifying hostname of server"""
try:
if not server.startswith("ldap://"):
server = "ldap://%s" % server
if ":" not in server[7:]:
server = server + ":389"
if not server.endswith("/"):
server = server + "/"
return server
except Exception:
raise ValueError("Malformed hostname: %s" % server)
def get_attrs(self):
"""Load all attributes into local cache"""
self.__initialize()
scope = ldap.SCOPE_BASE
search_filter = "objectClass=*"
result = dict(
self.__session.search_s(self.dn, scope, search_filter, None)[0][1]
)
self.__unbind()
return result
def set_attrs(self, new_attrs):
old_attrs = self.get_attrs()
change_list = []
for set_k, set_v in new_attrs.items():
# make sure the value is a list
if not isinstance(set_v, list):
set_v = [set_v]
if set_k not in old_attrs:
action = ldap.MOD_ADD
change_list.append((action, str(set_k), set_v))
elif old_attrs[set_k] != set_v:
action = ldap.MOD_REPLACE
change_list.append((action, str(set_k), set_v))
if change_list:
self.__initialize()
self.__session.modify_s(self.dn, change_list)
self.__unbind()
def set_password(self, old_pw, new_pw):
self.__initialize()
self.__session.passwd_s(self.dn, old_pw, new_pw)
self.__unbind()
def get_parent(self):
"""Obtain parent object
:returns obj: instance of ldap_hopper.ObjectNode
"""
self.__initialize()
dn = ",".join(self.dn.split(",")[1:])
parent = self.__session.search_s(dn, ldap.SCOPE_BASE, "objectClass=*")
self.__unbind()
dn = parent[0][0]
attrs = parent[0][1]
return ObjectNode(self.server, dn, self.__bind_dn, self.__bind_pw)
def get_children(self, by_attr=None):
"""Obtain all children (onelevel)
:param by_attr: (optional) filter by attribute
:returns list: instances of ldap_hopper.ObjectNode
"""
self.__initialize()
if by_attr:
search_filter = by_attr
else:
search_filter = "objectClass=*"
result_id = self.__session.search(self.dn, ldap.SCOPE_ONELEVEL, search_filter)
output = []
while 1:
r_type, r_data = self.__session.result(result_id, 0)
if r_data is []:
break
else:
if r_type == ldap.RES_SEARCH_ENTRY:
if isinstance(r_data, list):
for r in r_data:
dn = r[0]
output.append(
ObjectNode(
self.server, dn, self.__bind_dn, self.__bind_pw
)
)
else:
dn = r_data[0]
output.append(
ObjectNode(self.server, dn, self.__bind_dn, self.__bind_pw)
)
self.__unbind()
return output
def get_subs(self, by_attr=None):
"""Obtain children (subtree)
:param by_attr: (optional) filter by attribute
:returns list: instances of ldap_hopper.ObjectNode
"""
self.__initialize()
if by_attr:
search_filter = by_attr
else:
search_filter = "objectClass=*"
result_id = self.__session.search(self.dn, ldap.SCOPE_SUBTREE, search_filter)
output = []
while 1:
r_type, r_data = self.__session.result(result_id, 0)
if r_data is []:
break
else:
if r_type == ldap.RES_SEARCH_ENTRY:
if isinstance(r_data, list):
for r in r_data:
dn = r[0]
output.append(
ObjectNode(
self.server, dn, self.__bind_dn, self.__bind_pw
)
)
else:
dn = r_data[0]
output.append(
ObjectNode(self.server, dn, self.__bind_dn, self.__bind_pw)
)
self.__unbind()
return output
def get_by_dn(self, dn):
return ObjectNode(self.server, dn, self.__bind_dn, self.__bind_pw)
def add_child(self, dn, attrs):
"""Add a child-node to this object-node
:param dn: either dn or rdn relative to self.dn
:param attrs: attributes dictionary
:returns obj: instance of ObjectNode
"""
if self.dn not in dn:
dn = "%s,%s" % (dn, self.dn)
ldif = addModlist(attrs)
self.__initialize()
self.__session.add_s(dn, ldif)
self.__unbind()
return ObjectNode(self.server, dn, self.__bind_dn, self.__bind_pw)
def del_child(self, dn):
"""Delete a child-node of this object-node
:param dn: either dn or rdn relative to self.dn
:returns None: or passes python-ldap exception
"""
if self.dn not in dn:
dn = "%s,%s" % (dn, self.dn)
self.__initialize()
self.__session.delete_s(dn)
self.__unbind()
def search(self, attribute, value, scope=None):
"""Search from this node as search-base
:param attribute: name of the attribute to look-up
:param value: value of the attribute to look-up
:param scope: search_scope, e.g. ldap.SCOPE_SUBTREE
(defaults to ldap.SCOPE_ONELEVEL)
"""
if scope is None:
scope = ldap.SCOPE_ONELEVEL
search_filter = "%s=%s" % (attribute, value)
self.__initialize()
result_id = self.__session.search(self.dn, scope, search_filter)
output = []
while 1:
r_type, r_data = self.__session.result(result_id, 0)
if r_data is []:
break
else:
if r_type == ldap.RES_SEARCH_ENTRY:
if isinstance(r_data, list):
for r in r_data:
dn = r[0]
output.append(
ObjectNode(
self.server, dn, self.__bind_dn, self.__bind_pw
)
)
else:
dn = r[0]
output.append(
ObjectNode(self.server, dn, self.__bind_dn, self.__bind_pw)
)
return output
def as_tuple(self):
"""Convenience method for obtaining a ldap result-like tuple
:returns tuple: ( str(dn), dict(attrs) )
"""
return self.dn, self.get_attrs()