forked from educloudalliance/eca-auth-data
-
Notifications
You must be signed in to change notification settings - Fork 0
/
external_sources.py
354 lines (315 loc) · 11.5 KB
/
external_sources.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
# -*- coding: utf-8 -*-
# The MIT License (MIT)
#
# Copyright (c) 2014-2015 Haltu Oy, http://haltu.fi
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
"""
External data source implementations
"""
import hashlib
import ldap
from external_ldap.source import LDAPDataSource
class TestLDAPDataSource(LDAPDataSource):
"""
Example result from test_ldap
('cn=bar,ou=Opettajat,ou=People,ou=LdapKoulu1,ou=KuntaYksi,dc=mpass-test,dc=csc,dc=fi',
{'cn': ['bar'],
'givenName': ['Ldap'],
'mail': ['bar@mpass-test.invalid'],
'objectClass': ['top', 'inetOrgPerson'],
'sn': ['Opettaja10013'],
'title': ['Opettaja'],
'uid': ['bar'],
'userPassword': ['foo']})
('cn=bar,ou=Oppilaat,ou=People,ou=LdapKoulu1,ou=KuntaYksi,dc=mpass-test,dc=csc,dc=fi',
{'cn': ['bar'],
'departmentNumber': ['6C'],
'givenName': ['Ldap'],
'mail': ['bar@mpass-test.invalid'],
'objectClass': ['top', 'inetOrgPerson'],
'sn': ['Oppilas352'],
'title': ['Oppilas'],
'uid': ['bar'],
'userPassword': ['foo']}),
"""
municipality_id_map = {
'KuntaYksi': '1234567-8'
}
class _schoolid_generator():
"""
generator for fake school ids
"""
@classmethod
def get(cls, name, default=None):
import string
num = name.strip(string.ascii_letters)
num = int(num)
return '%05d' % num
school_id_map = _schoolid_generator
#'LdapKoulu1': '00001',
#'LdapKoulu2': '00002',
#'LdapKoulu3': '00003',
#'LdapKoulu4': '00004',
#'LdapKoulu5': '00005',
#'LdapKoulu6': '00006',
#'LdapKoulu7': '00007',
#'LdapKoulu8': '00008',
#'LdapKoulu9': '00009',
#'LdapKoulu10': '00010',
#'LdapKoulu11': '00011',
# etc...
def __init__(self, *args, **kwargs):
self.ldap_base_dn = 'ou=KuntaYksi,dc=mpass-test,dc=csc,dc=fi'
self.ldap_filter = "(&(uid={value})(objectclass=inetOrgPerson))"
"""
ldap_filter = Filter for finding the required user in an LDAP query,
for example "(&(attribute={value})(objectclass=inetOrgPerson))"
Query will substitue {value} with Auth Proxy's attribute query value.
"""
super(TestLDAPDataSource, self).__init__(*args, **kwargs)
def get_oid(self, username):
"""
There is no OID information in this external source. Generate fake OID
from username.
"""
# TODO: OID is cut to 30 chars due to django username limitation
return 'MPASSOID.{user_hash}'.format(user_hash=hashlib.sha1('ldap_test' + username).hexdigest())[:30]
def get_data(self, attribute, value):
try:
query_result = self.query(self.ldap_filter.format(value=value))[0]
except IndexError:
return None
dn_parts = query_result[0].split(',')
username = query_result[1]['cn'][0]
first_name = query_result[1]['givenName'][0]
last_name = query_result[1]['sn'][0]
attributes = []
roles = [{
'school': dn_parts[3].strip("ou="),
'role': query_result[1]['title'][0],
'municipality': dn_parts[4].strip("ou="),
'group': query_result[1].get('departmentNumber', [''])[0]
}]
return {
'username': self.get_oid(username),
'first_name': first_name,
'last_name': last_name,
'roles': roles,
'attributes': attributes
}
def get_user_data(self, request):
ldap_filter = "objectclass=inetOrgPerson"
query_base = self.ldap_base_dn
if 'school' in request.GET:
self.ldap_base_dn = 'ou=%s,%s' % (request.GET['school'], query_base)
if 'group' in request.GET and request.GET['group'] != '':
ldap_filter = '(&(departmentNumber=%s)(%s))' % (request.GET['group'], ldap_filter)
query_results = self.query(ldap_filter)
response = []
for result in query_results:
dn_parts = result[0].split(',')
username = result[1]['cn'][0]
first_name = result[1]['givenName'][0]
last_name = result[1]['sn'][0]
attributes = [
# TODO: what attributes should be returned from LDAP?
]
roles = [{
'school': self.get_school_id(dn_parts[3].strip("ou=")),
'role': result[1]['title'][0],
'municipality': self.get_municipality_id(dn_parts[4].strip("ou=")),
'group': result[1].get('departmentNumber', [''])[0]
}]
response.append({
'username': self.get_oid(username),
'first_name': first_name,
'last_name': last_name,
'roles': roles,
'attributes': attributes
})
# TODO: support actual paging via SimplePagedResultsControl
return {
'count': len(response),
'next': None,
'previous': None,
'results': response,
}
class OuluLDAPDataSource(LDAPDataSource):
"""
Required configuration parameters:
host
username
password
base_dn
"""
municipality_id_map = {
'Oulu': '0187690-1'
}
school_id_map = {
u'Herukan koulu': '06347',
u'Hintan koulu': '06329',
u'Hönttämäen koulu': '03367',
u'Kaakkurin koulu': '03748',
u'Karjasillan yläaste': '06315',
u'Kastellin koulu': '06316',
u'Kaukovainion koulu': '06330',
u'Knuutilankankaan koulu': '03515',
u'Korvensuoran koulu': '06334',
u'Koskelan koulu': '06335',
u'Kuivasjärven ala-aste': '06336',
u'Laanilan yläaste': '06318',
u'Lintulammen koulu': '06339',
u'Madekosken ala-aste': '06337',
u'Maikkulan koulu': '03600',
u'Merikosken yläaste': '06320',
u'Metsokankaan koulu': '03780',
u'Myllyojan koulu': '03262',
u'Myllytullin koulu': '06322',
u'Nuottasaaren koulu': '06340',
u'Oulujoen koulu': '06341',
u'Oulun kansainvälinen koulu': '03735',
u'Oulunlahden koulu': '06332',
u'Pateniemen yläaste': '06323',
u'Paulaharjun koulu': '06344',
u'Pikkaralan ala-aste': '06345',
u'Pohjankartanon yläaste': '06847',
u'Pöllönkankaan koulu': '06319',
u'Rajakylän koulu': '06346',
u'Ritaharjun koulu': '03802',
u'Terva-Toppilan koulu': '06324',
u'Teuvo Pakkalan koulu': '06348',
u'Tuiran ala-aste': '06350',
u'Vesalan koulu': '06446',
u'Ylikiimingin koulu': '06437',
u'Heinätorin koulu': '06327',
u'Kajaanintullin koulu': '08858',
u'Karjasillan lukio': '00265',
u'Kastellin lukio': '00603',
u'Laanilan lukio': '00401',
u'Madetojan musiikkilukio': '00604',
u'Merikosken lukio': '00831',
u'Oulun Suom. Yhteiskoulun lukio': '00601',
u'Oulun aikuislukio': '00548',
u'Oulun lyseon lukio': '00598',
u'Pateniemen lukio': '00674',
u'Oulun konservatorio': '01968',
u'Oulu-opisto': '02246',
}
def __init__(self, base_dn, *args, **kwargs):
self.ldap_base_dn = base_dn
self.ldap_filter = "(sAMAccountName={value})"
"""
ldap_filter = Filter for finding the required user in an LDAP query,
for example "(&(attribute={value})(objectclass=inetOrgPerson))"
Query will substitue {value} with Auth Proxy's attribute query value.
"""
super(OuluLDAPDataSource, self).__init__(*args, **kwargs)
def connect(self):
"""
Initialize a secure connection the the LDAP server.
"""
ldap.set_option(ldap.OPT_X_TLS_CACERTFILE, 'oulu_certificate')
self.connection = ldap.initialize(self.ldap_server)
self.connection.set_option(ldap.OPT_REFERRALS, 0)
self.connection.set_option(ldap.OPT_PROTOCOL_VERSION, 3)
self.connection.set_option(ldap.OPT_X_TLS_DEMAND, True)
self.connection.set_option(ldap.OPT_X_TLS, ldap.OPT_X_TLS_DEMAND)
self.connection.start_tls_s()
self.connection.simple_bind_s(self.ldap_username, self.ldap_password)
def get_oid(self, username):
"""
There is no OID information in this external source. Generate fake OID
from username.
"""
# TODO: OID is cut to 30 chars due to django username limitation
return 'MPASSOID.{user_hash}'.format(user_hash=hashlib.sha1('ad_oulu' + username).hexdigest())[:30]
def get_username(self, query_result):
return query_result[1]['sAMAccountName'][0]
def get_first_name(self, query_result):
return query_result[1].get('givenName', [u''])[0]
def get_last_name(self, query_result):
return query_result[1].get('sn', [u''])[0]
def get_municipality(self):
return u'Oulu'
def get_school(self, query_result):
return query_result[1].get('physicalDeliveryOfficeName', [u''])[0]
def get_role(self, query_result):
return query_result[1].get('title', [u''])[0]
def get_group(self, query_result):
return query_result[1].get('department', [u''])[0]
def get_data(self, attribute, value):
try:
query_result = self.query(self.ldap_filter.format(value=value))[0]
except IndexError:
return None
username = self.get_username(query_result)
first_name = self.get_first_name(query_result)
last_name = self.get_last_name(query_result)
attributes = []
roles = [{
'school': self.get_school_id(self.get_school(query_result)),
'role': self.get_role(query_result),
'municipality': self.get_municipality_id(self.get_municipality()),
'group': self.get_group(query_result),
}]
return {
'username': self.get_oid(username),
'first_name': first_name,
'last_name': last_name,
'roles': roles,
'attributes': attributes
}
def get_user_data(self, request):
ldap_filter = "(&(objectCategory=person)(objectClass=user))"
if 'school' in request.GET:
ldap_filter = '(&(physicalDeliveryOfficeName={school}){filter_base})'.format(school=request.GET['school'], filter_base=ldap_filter)
if 'group' in request.GET and request.GET['group'] != '':
ldap_filter = '(&(department={group}){filter_base})'.format(group=request.GET['group'], filter_base=ldap_filter)
query_results = self.query(ldap_filter)
response = []
for query_result in query_results:
username = self.get_username(query_result)
first_name = self.get_first_name(query_result)
last_name = self.get_last_name(query_result)
attributes = [
# TODO: what attributes should be returned from LDAP?
]
roles = [{
'school': self.get_school_id(self.get_school(query_result)),
'role': self.get_role(query_result),
'municipality': self.get_municipality_id(self.get_municipality()),
'group': self.get_group(query_result),
}]
response.append({
'username': self.get_oid(username),
'first_name': first_name,
'last_name': last_name,
'roles': roles,
'attributes': attributes
})
# TODO: support actual paging via SimplePagedResultsControl
return {
'count': len(response),
'next': None,
'previous': None,
'results': response,
}
# vim: tabstop=2 expandtab shiftwidth=2 softtabstop=2