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
|
##############################################################################
#
# ActiveDirectoryMultiPlugin Shim to use the LDAPUserFolder with the
# PluggableAuthenticationService w/ AD
#
##############################################################################
__doc__ = """ ActiveDirectoryUserFolder shim module """
__version__ = '$Revision: 1372 $'[11:-2]
# General Python imports
import logging
import os
from urllib import quote_plus
# Zope imports
from Acquisition import aq_base
from Globals import InitializeClass
from Globals import DTMLFile
from Globals import package_home
from AccessControl import ClassSecurityInfo
from Products.LDAPUserFolder import manage_addLDAPUserFolder
from Products.LDAPUserFolder.LDAPDelegate import filter_format
from Products.PluggableAuthService.interfaces.plugins import \
IUserEnumerationPlugin, IGroupsPlugin, IGroupEnumerationPlugin, \
IRoleEnumerationPlugin
from Products.PluggableAuthService.utils import classImplements
from Products.PluggableAuthService.utils import implementedBy
from LDAPPluginBase import LDAPPluginBase
logger = logging.getLogger('event.LDAPMultiPlugin')
_dtmldir = os.path.join(package_home(globals()), 'dtml')
addActiveDirectoryMultiPluginForm = DTMLFile('addActiveDirectoryMultiPlugin',
_dtmldir)
def manage_addActiveDirectoryMultiPlugin( self, id, title, LDAP_server
, login_attr
, uid_attr, users_base, users_scope, roles
, groups_base, groups_scope, binduid, bindpwd
, binduid_usage=1, rdn_attr='cn', local_groups=0
, use_ssl=0 , encryption='SHA', read_only=0
, REQUEST=None
):
""" Factory method to instantiate a ActiveDirectoryMultiPlugin """
# Make sure we really are working in our container (the
# PluggableAuthService object)
self = self.this()
# Value needs massaging, there's some magic transcending a simple true
# or false expeced by the LDAP delegate :(
if use_ssl:
use_ssl = 1
else:
use_ssl = 0
# Instantiate the folderish adapter object
lmp = ActiveDirectoryMultiPlugin(id, title=title)
self._setObject(id, lmp)
lmp = getattr(aq_base(self), id)
lmp_base = aq_base(lmp)
# Put the "real" LDAPUserFolder inside it
manage_addLDAPUserFolder(lmp)
luf = getattr(lmp_base, 'acl_users')
host_elems = LDAP_server.split(':')
host = host_elems[0]
if len(host_elems) > 1:
port = host_elems[1]
else:
if use_ssl:
port = '636'
else:
port = '389'
luf.manage_addServer(host, port=port, use_ssl=use_ssl)
luf.manage_edit( title
, login_attr
, uid_attr
, users_base
, users_scope
, roles
, groups_base
, groups_scope
, binduid
, bindpwd
, binduid_usage=binduid_usage
, rdn_attr=rdn_attr
, local_groups=local_groups
, encryption=encryption
, read_only=read_only
, REQUEST=None
)
# clean out the __allow_groups__ bit because it is not needed here
# and potentially harmful
if hasattr(lmp_base, '__allow_groups__'):
del lmp_base.__allow_groups__
uf = lmp.acl_users
uf._ldapschema = { 'cn' : { 'ldap_name' : 'cn'
, 'friendly_name' : 'Canonical Name'
, 'multivalued' : ''
, 'public_name' : ''
}
, 'sn' : { 'ldap_name' : 'sn'
, 'friendly_name' : 'Last Name'
, 'multivalued' : ''
, 'public_name' : 'last_name'
}
}
uf.manage_addLDAPSchemaItem('dn', 'Distinguished Name',
public_name='dn')
uf.manage_addLDAPSchemaItem('sAMAccountName', 'Windows Login Name',
public_name='windows_login_name')
uf.manage_addLDAPSchemaItem('objectGUID', 'AD Object GUID',
public_name='objectGUID')
uf.manage_addLDAPSchemaItem('givenName', 'First Name',
public_name='first_name')
uf.manage_addLDAPSchemaItem('sn', 'Last Name',
public_name='last_name')
uf.manage_addLDAPSchemaItem('memberOf',
'Group DNs',
public_name='memberOf',
multivalued=True)
if REQUEST is not None:
REQUEST.RESPONSE.redirect('%s/manage_main' % self.absolute_url())
class ActiveDirectoryMultiPlugin(LDAPPluginBase):
""" The adapter that mediates between the PAS and the LDAPUserFolder """
security = ClassSecurityInfo()
meta_type = 'ActiveDirectory Multi Plugin'
_properties = LDAPPluginBase._properties + (
{'id':'groupid_attr', 'type':'string', 'mode':'w'},
{'id':'grouptitle_attr', 'type':'string', 'mode':'w'},
{'id':'group_class', 'type':'string', 'mode':'w'},
{'id':'group_recurse', 'type':'int', 'mode':'w'},
{'id':'group_recurse_depth', 'type':'int', 'mode':'w'},
)
groupid_attr = 'objectGUID'
grouptitle_attr = 'cn'
group_class = 'group'
group_recurse = 1
group_recurse_depth = 1
def __init__(self, id, title='', groupid_attr='objectGUID',
grouptitle_attr='cn', group_class='group', group_recurse=1,
group_recurse_depth=1):
""" Initialize a new instance """
self.id = id
self.title = title
self.groupid_attr = groupid_attr
self.grouptitle_attr = grouptitle_attr
self.group_class = group_class
self.group_recurse = group_recurse
self.group_recurse_depth = group_recurse_depth
security.declarePublic('getGroupsForPrincipal')
def getGroupsForPrincipal(self, user, request=None, attr=None):
""" Fulfill GroupsPlugin requirements """
if attr is None:
attr = self.groupid_attr
acl = self._getLDAPUserFolder()
if acl is None:
return ()
view_name = self.getId() + '_getGroupsForPrincipal'
criteria = {'user_id':user.getId(), 'attr':attr}
cached_info = self.ZCacheable_get(view_name = view_name,
keywords = criteria,
default = None)
if cached_info is not None:
logger.debug('returning cached results from getGroupsForPrincipal')
return cached_info
unmangled_userid = self._demangle(user.getId())
if unmangled_userid is None:
return ()
ldap_user = acl.getUserById(unmangled_userid)
if ldap_user is None:
return ()
cns = [ x.split(',')[0] for x in (ldap_user.memberOf or []) ]
if not cns:
return ()
cns = [x.split('=')[1] for x in cns]
cn_flts = [filter_format('(cn=%s)', (cn,)) for cn in cns]
filt = '(&(objectClass=%s)(|%s))' % (self.group_class, ''.join(cn_flts))
delegate = acl._delegate
R = delegate.search(acl.groups_base, acl.groups_scope, filter=filt)
if R['exception']:
raise RuntimeError, R['exception']
if self.group_recurse:
groups = self._recurseGroups(R['results'])
else:
groups = R['results']
results = [ x[attr][0] for x in groups]
self.ZCacheable_set(results, view_name=view_name, keywords=criteria)
return results
def _recurseGroups(self, ldap_results, temp=None, seen=None, depth=0):
""" Given a set of LDAP result data for a group search, return
the recursive group memberships for each group: arbitrarily
expensive """
if seen is None:
seen = {}
if temp is None:
temp = []
# Build a single filter so we can do it with a single search.
filt_bits = []
for result in ldap_results:
dn = result['dn']
if seen.has_key(dn):
continue
temp.append(result)
seen[dn] = 1
if result.has_key('memberOf'):
for parent_dn in result['memberOf']:
filt = filter_format('(distinguishedName=%s)', (parent_dn,))
if filt in filt_bits:
continue
filt_bits.append(filt)
if filt_bits:
bits_s = ''.join(filt_bits)
filt = "(&(objectClass=%s)(|%s))" % (self.group_class, bits_s)
acl = self.acl_users
delegate = acl._delegate
R = delegate.search(acl.groups_base, acl.groups_scope, filter=filt)
if R['exception']:
raise RuntimeError, R['exception']
if depth < self.group_recurse_depth:
self._recurseGroups(R['results'], temp, seen, depth + 1)
return temp
security.declarePrivate('enumerateUsers')
def enumerateUsers( self
, id=None
, login=None
, exact_match=0
, sort_by=None
, max_results=None
, **kw
):
""" Fulfill the UserEnumerationPlugin requirements """
view_name = self.getId() + '_enumerateUsers'
criteria = {'id':id, 'login':login, 'exact_match':exact_match,
'sort_by':sort_by, 'max_results':max_results}
criteria.update(kw)
cached_info = self.ZCacheable_get(view_name = view_name,
keywords = criteria,
default = None)
if cached_info is not None:
logger.debug('returning cached results from enumerateUsers')
return cached_info
result = []
acl = self._getLDAPUserFolder()
login_attr = acl.getProperty('_login_attr')
uid_attr = acl.getProperty('_uid_attr')
plugin_id = self.getId()
edit_url = '%s/%s/manage_userrecords' % (plugin_id, acl.getId())
if login_attr in kw:
login = kw[login_attr]
del kw[login_attr]
if uid_attr in kw:
id = kw[uid_attr]
del kw[uid_attr]
if acl is None:
return ()
if exact_match:
if id:
ldap_user = acl.getUserById(id)
elif login:
ldap_user = acl.getUser(login)
else:
msg = 'Exact Match specified but no ID or Login given'
raise ValueError, msg
if ldap_user is not None:
qs = 'user_dn=%s' % quote_plus(ldap_user.getUserDN())
result.append( { 'id' : ldap_user.getId()
, 'login' : ldap_user.getProperty(login_attr)
, 'pluginid' : plugin_id
, 'title': ldap_user.getProperty(login_attr)
, 'editurl' : '%s?%s' % (edit_url, qs)
} )
elif id or login or kw:
l_results = []
seen = []
attrs = (uid_attr, login_attr)
if id:
l_results.extend(acl.findUser(uid_attr, id, attrs=attrs))
if login:
l_results.extend(acl.findUser(login_attr, login, attrs=attrs))
for key, val in kw.items():
l_results.extend(acl.findUser(key, val, attrs=attrs))
for l_res in l_results:
if l_res['dn'] not in seen and l_res.has_key(login_attr):
l_res['id'] = l_res[uid_attr]
l_res['login'] = l_res[login_attr]
l_res['pluginid'] = plugin_id
quoted_dn = quote_plus(l_res['dn'])
l_res['editurl'] = '%s?user_dn=%s' % (edit_url, quoted_dn)
result.append(l_res)
seen.append(l_res['dn'])
if sort_by is not None:
result.sort(lambda a, b: cmp( a.get(sort_by, '').lower()
, b.get(sort_by, '').lower()
) )
if isinstance(max_results, int) and len(result) > max_results:
result = result[:max_results-1]
else:
result = []
for uid, name in acl.getUserIdsAndNames():
tmp = {}
tmp['id'] = uid
tmp['login'] = name
tmp['pluginid'] = plugin_id
tmp['editurl'] = None
result.append(tmp)
if sort_by is not None:
result.sort(lambda a, b: cmp( a.get(sort_by, '').lower()
, b.get(sort_by, '').lower()
) )
if isinstance(max_results, int) and len(result) > max_results:
result = result[:max_results-1]
result = tuple(result)
self.ZCacheable_set(result, view_name=view_name, keywords=criteria)
return result
security.declarePrivate('enumerateGroups')
def enumerateGroups( self
, id=None
, exact_match=0
, sort_by=None
, max_results=None
, **kw
):
""" Fulfill the RoleEnumerationPlugin requirements """
view_name = self.getId() + '_enumerateGroups'
criteria = {'id':id, 'exact_match':exact_match,
'sort_by':sort_by, 'max_results':max_results}
criteria.update(kw)
cached_info = self.ZCacheable_get(view_name = view_name,
keywords = criteria,
default = None)
if cached_info is not None:
logger.debug('returning cached results from enumerateGroups')
return cached_info
acl = self._getLDAPUserFolder()
if acl is None:
return ()
if id is None and exact_match != 0:
raise ValueError, 'Exact Match requested but no id provided'
elif id is None:
id = ''
test_id = id.lower()
plugin_id = self.getId()
filt = ['(objectClass=%s)' % self.group_class]
if not test_id:
filt.append('(%s=*)' % self.groupid_attr)
elif exact_match:
filt.append(filter_format('(%s=%s)',(self.groupid_attr, test_id)))
elif test_id:
filt.append(filter_format('(%s=*%s*)',(self.groupid_attr, test_id)))
filt = '(&%s)' % ''.join(filt)
delegate = acl._delegate
R = delegate.search(acl.groups_base, acl.groups_scope, filter=filt)
if R['exception']:
raise RuntimeError, R['exception']
groups = R['results']
results = []
for group in groups:
tmp = {}
tmp['title'] = '(Group) ' + group[self.grouptitle_attr][0]
id = tmp['id'] = group[self.groupid_attr][0]
tmp['pluginid'] = plugin_id
results.append(tmp)
if sort_by is not None:
results.sort(lambda a, b: cmp( a.get(sort_by, '').lower()
, b.get(sort_by, '').lower()
) )
if isinstance(max_results, int) and len(results) > max_results:
results = results[:max_results+1]
results = tuple(results)
self.ZCacheable_set(results, view_name=view_name, keywords=criteria)
return results
security.declarePrivate('enumerateRoles')
def enumerateRoles( self
, id=None
, exact_match=0
, sort_by=None
, max_results=None
, **kw
):
""" Fulfill the RoleEnumerationPlugin requirements """
return []
classImplements( ActiveDirectoryMultiPlugin
, IUserEnumerationPlugin
, IGroupsPlugin
, IGroupEnumerationPlugin
, IRoleEnumerationPlugin
, *implementedBy(LDAPPluginBase)
)
InitializeClass(ActiveDirectoryMultiPlugin)
|
