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
|
# encoding=utf-8
from __future__ import unicode_literals
from unittest import skipUnless, skip
from io import StringIO
from django.test import TestCase, override_settings
from django.contrib.auth import authenticate
from django.contrib.auth.models import User
from django.conf import settings as django_settings
from django.core.management import call_command, CommandError
from django_python3_ldap.conf import settings
from django_python3_ldap.ldap import connection
from django_python3_ldap.utils import clean_ldap_name, import_func
@skipUnless(settings.LDAP_AUTH_TEST_USER_USERNAME, "No settings.LDAP_AUTH_TEST_USER_USERNAME supplied.")
@skipUnless(settings.LDAP_AUTH_TEST_USER_PASSWORD, "No settings.LDAP_AUTH_TEST_USER_PASSWORD supplied.")
@skipUnless(settings.LDAP_AUTH_USER_LOOKUP_FIELDS == ("username",), "Cannot test using custom lookup fields.")
@skipUnless(django_settings.AUTH_USER_MODEL == "auth.User", "Cannot test using a custom user model.")
class TestLdap(TestCase):
def setUp(self):
super(TestLdap, self).setUp()
User.objects.all().delete()
# Lazy settings tests.
def testLazySettingsInstanceLookup(self):
self.assertTrue(settings.LDAP_AUTH_TEST_USER_USERNAME)
def testLazySettingsClassLookup(self):
self.assertEqual(settings.__class__.LDAP_AUTH_TEST_USER_USERNAME.name, "LDAP_AUTH_TEST_USER_USERNAME")
self.assertEqual(settings.__class__.LDAP_AUTH_TEST_USER_USERNAME.default, "")
# Utils tests.
def testCleanLdapName(self):
self.assertEqual(clean_ldap_name("foo@bar.com"), r'foo@bar.com')
self.assertEqual(clean_ldap_name("café"), r'caf\E9')
# LDAP tests.
def testGetUserKwargsSuccess(self):
with connection() as c:
user = c.get_user(
username=settings.LDAP_AUTH_TEST_USER_USERNAME,
)
self.assertIsInstance(user, User)
self.assertEqual(user.username, settings.LDAP_AUTH_TEST_USER_USERNAME)
def testGetUserKwargsIncorrectUsername(self):
with connection() as c:
user = c.get_user(
username="bad" + settings.LDAP_AUTH_TEST_USER_USERNAME,
)
self.assertEqual(user, None)
def testHasUserKwargsSuccess(self):
with connection() as c:
exist = c.has_user(
username=settings.LDAP_AUTH_TEST_USER_USERNAME,
)
self.assertEqual(exist, True)
def testHasUserKwargsIncorrectUsername(self):
with connection() as c:
exist = c.has_user(
username="bad" + settings.LDAP_AUTH_TEST_USER_USERNAME,
)
self.assertEqual(exist, False)
# Authentication tests.
def testAuthenticateUserSuccess(self):
user = authenticate(
username=settings.LDAP_AUTH_TEST_USER_USERNAME,
password=settings.LDAP_AUTH_TEST_USER_PASSWORD,
)
self.assertIsInstance(user, User)
self.assertEqual(user.username, settings.LDAP_AUTH_TEST_USER_USERNAME)
def testAuthenticateUserBadUsername(self):
user = authenticate(
username="bad" + settings.LDAP_AUTH_TEST_USER_USERNAME,
password=settings.LDAP_AUTH_TEST_USER_PASSWORD,
)
self.assertEqual(user, None)
def testAuthenticateUserBadPassword(self):
user = authenticate(
username=settings.LDAP_AUTH_TEST_USER_USERNAME,
password="bad" + settings.LDAP_AUTH_TEST_USER_PASSWORD,
)
self.assertEqual(user, None)
def testAuthenticateWithAdditonalKwargsUserSuccess(self):
user = authenticate(
username=settings.LDAP_AUTH_TEST_USER_USERNAME,
password=settings.LDAP_AUTH_TEST_USER_PASSWORD,
another_kwarg="whatever",
)
self.assertIsInstance(user, User)
self.assertEqual(user.username, settings.LDAP_AUTH_TEST_USER_USERNAME)
def testRepeatedUserAuthenticationDoestRecreateUsers(self):
user_1 = authenticate(
username=settings.LDAP_AUTH_TEST_USER_USERNAME,
password=settings.LDAP_AUTH_TEST_USER_PASSWORD,
)
user_2 = authenticate(
username=settings.LDAP_AUTH_TEST_USER_USERNAME,
password=settings.LDAP_AUTH_TEST_USER_PASSWORD,
)
# Ensure that the user isn't recreated on second access.
self.assertEqual(user_1.pk, user_2.pk)
@skip("FIXME: test server currently uses outdated TLS cyphers")
def testAuthenticateWithTLS(self):
with self.settings(LDAP_AUTH_USE_TLS=True):
user = authenticate(
username=settings.LDAP_AUTH_TEST_USER_USERNAME,
password=settings.LDAP_AUTH_TEST_USER_PASSWORD,
)
self.assertIsInstance(user, User)
self.assertEqual(user.username, settings.LDAP_AUTH_TEST_USER_USERNAME)
def testAuthenticateWithRebind(self):
with self.settings(
LDAP_AUTH_CONNECTION_USERNAME=settings.LDAP_AUTH_TEST_USER_USERNAME,
LDAP_AUTH_CONNECTION_PASSWORD=settings.LDAP_AUTH_TEST_USER_PASSWORD,
):
user = authenticate(
username=settings.LDAP_AUTH_TEST_USER_USERNAME,
password=settings.LDAP_AUTH_TEST_USER_PASSWORD,
)
self.assertIsInstance(user, User)
self.assertEqual(user.username, settings.LDAP_AUTH_TEST_USER_USERNAME)
def testAuthenticateWithFailedRebind(self):
with self.settings(
LDAP_AUTH_CONNECTION_USERNAME="bad" + settings.LDAP_AUTH_TEST_USER_USERNAME,
LDAP_AUTH_CONNECTION_PASSWORD=settings.LDAP_AUTH_TEST_USER_PASSWORD,
):
user = authenticate(
username=settings.LDAP_AUTH_TEST_USER_USERNAME,
password=settings.LDAP_AUTH_TEST_USER_PASSWORD,
)
self.assertIs(user, None)
def testAuthenticateWithLimitedRetries(self):
# simulate offline server
with self.settings(
LDAP_AUTH_URL=["ldap://example.com:389"],
LDAP_AUTH_POOL_ACTIVE=1,
):
user = authenticate(
username=settings.LDAP_AUTH_TEST_USER_USERNAME,
password=settings.LDAP_AUTH_TEST_USER_PASSWORD,
)
self.assertEqual(user, None)
# User synchronisation.
def testSyncUsersCreatesUsers(self):
call_command("ldap_sync_users", verbosity=0)
self.assertGreater(User.objects.count(), 0)
def testSyncUserWithLookup(self):
call_command("ldap_sync_users", settings.LDAP_AUTH_TEST_USER_USERNAME, verbosity=0)
self.assertEqual(User.objects.filter(username=settings.LDAP_AUTH_TEST_USER_USERNAME).count(), 1)
@override_settings(LDAP_AUTH_USER_LOOKUP_FIELDS=('username', 'email'))
def testSyncUserWithMultipleLookups(self):
call_command(
"ldap_sync_users",
settings.LDAP_AUTH_TEST_USER_USERNAME,
settings.LDAP_AUTH_TEST_USER_EMAIL,
verbosity=0
)
self.assertEqual(User.objects.filter(username=settings.LDAP_AUTH_TEST_USER_USERNAME).count(), 1)
def testSyncUsersCommandOutput(self):
out = StringIO()
call_command("ldap_sync_users", verbosity=1, stdout=out)
rows = out.getvalue().split("\n")[:-1]
self.assertEqual(len(rows), User.objects.count())
for row in rows:
self.assertRegex(row, r'^Synced ')
def testReSyncUsersDoesntRecreateUsers(self):
call_command("ldap_sync_users", verbosity=0)
user_count_1 = User.objects.count()
call_command("ldap_sync_users", verbosity=0)
user_count_2 = User.objects.count()
self.assertEqual(user_count_1, user_count_2)
# User promotion.
def testPromoteUser(self):
user = User.objects.create(
username="test",
)
self.assertFalse(user.is_staff)
self.assertFalse(user.is_superuser)
# Promote the user.
call_command("ldap_promote", "test", stdout=StringIO())
user = User.objects.get(username="test")
self.assertTrue(user.is_staff)
self.assertTrue(user.is_superuser)
def testPromoteMissingUser(self):
with self.assertRaises(CommandError, msg="User with username missing_user does not exist"):
call_command("ldap_promote", "missing_user", verbosity=0)
def testSyncUserRelations(self):
def check_sync_user_relation(user, data, *, connection=None, dn=None):
# id have been created
self.assertIsNotNone(user.id)
# connection was passed
self.assertIsNotNone(connection)
# dn was passed
self.assertIsNotNone(dn)
# model is saved
self.assertEqual(user.username, User.objects.get(pk=user.id).username)
# save all groups
self.assertIn('cn', data)
ldap_groups = list(data.get('memberOf', ()))
ldap_groups.append('default_group')
for group in ldap_groups:
user.groups.create(name=group)
with self.settings(LDAP_AUTH_SYNC_USER_RELATIONS=check_sync_user_relation):
user = authenticate(
username=settings.LDAP_AUTH_TEST_USER_USERNAME,
password=settings.LDAP_AUTH_TEST_USER_PASSWORD,
)
self.assertIsInstance(user, User)
self.assertGreaterEqual(user.groups.count(), 1)
self.assertEqual(user.groups.filter(name='default_group').count(), 1)
def testOldSyncUserRelations(self):
def check_sync_user_relation(user, data):
# id have been created
self.assertIsNotNone(user.id)
# model is saved
self.assertEqual(user.username, User.objects.get(pk=user.id).username)
# save all groups
self.assertIn('cn', data)
ldap_groups = list(data.get('memberOf', ()))
ldap_groups.append('default_group')
for group in ldap_groups:
user.groups.create(name=group)
with self.settings(LDAP_AUTH_SYNC_USER_RELATIONS=check_sync_user_relation):
user = authenticate(
username=settings.LDAP_AUTH_TEST_USER_USERNAME,
password=settings.LDAP_AUTH_TEST_USER_PASSWORD,
)
self.assertIsInstance(user, User)
self.assertGreaterEqual(user.groups.count(), 1)
self.assertEqual(user.groups.filter(name='default_group').count(), 1)
def testImportFunc(self):
self.assertIs(clean_ldap_name, import_func(clean_ldap_name))
self.assertIs(clean_ldap_name, import_func('django_python3_ldap.utils.clean_ldap_name'))
self.assertTrue(callable(import_func('django.contrib.auth.get_user_model')))
self.assertRaises(AttributeError, import_func, 123)
self.assertTrue(callable(import_func(settings.LDAP_AUTH_SYNC_USER_RELATIONS)))
with self.settings(LDAP_AUTH_SYNC_USER_RELATIONS='django.contrib.auth.get_user_model'):
self.assertTrue(callable(import_func(settings.LDAP_AUTH_SYNC_USER_RELATIONS)))
def testCleanUsersDeactivate(self):
"""
ldap_clean_users management command test
"""
from django.contrib.auth import get_user_model
User = get_user_model()
_username = "nonldap{user}".format(user=settings.LDAP_AUTH_TEST_USER_USERNAME)
user = User.objects.create_user(
_username,
"nonldap{mail}".format(mail=settings.LDAP_AUTH_TEST_USER_EMAIL),
settings.LDAP_AUTH_TEST_USER_PASSWORD)
user.save()
user_count_1 = User.objects.count()
self.assertEqual(User.objects.get(username=_username).is_active, True)
call_command("ldap_clean_users", verbosity=0)
user_count_2 = User.objects.count()
self.assertEqual(user_count_1, user_count_2)
self.assertEqual(User.objects.get(username=_username).is_active, False)
"""
Test with lookup
"""
# Reactivate user
user = User.objects.get(username=_username)
user.is_active = True
user.save()
# Create second user
_usernameLookup = "nonldaplookup{user}".format(user=settings.LDAP_AUTH_TEST_USER_USERNAME)
user = User.objects.create_user(
_usernameLookup,
"nonldaplookup{mail}".format(mail=settings.LDAP_AUTH_TEST_USER_EMAIL),
settings.LDAP_AUTH_TEST_USER_PASSWORD)
user.save()
user_count_1 = User.objects.count()
self.assertEqual(User.objects.get(username=_usernameLookup).is_active, True)
# Clean second user
call_command("ldap_clean_users", _usernameLookup, verbosity=0)
user_count_2 = User.objects.count()
self.assertEqual(user_count_1, user_count_2)
self.assertEqual(User.objects.get(username=_usernameLookup).is_active, False)
self.assertEqual(User.objects.get(username=_username).is_active, True)
# Reactivate second user
user = User.objects.get(username=_usernameLookup)
user.is_active = True
user.save()
# Clean first user
call_command("ldap_clean_users", _username, verbosity=0)
self.assertEqual(User.objects.get(username=_username).is_active, False)
self.assertEqual(User.objects.get(username=_usernameLookup).is_active, True)
# Lookup a non existing user (raise a CommandError)
with self.assertRaises(CommandError):
call_command("ldap_clean_users", 'doesnonexist', verbosity=0)
"""
Test with superuser
"""
# Reactivate first user and promote to superuser
user = User.objects.get(username=_username)
user.is_active = True
user.is_superuser = True
user.save()
# Reactivate second user
user = User.objects.get(username=_usernameLookup)
user.is_active = True
user.save()
call_command("ldap_clean_users", superuser=False, verbosity=0)
self.assertEqual(User.objects.get(username=_username).is_active, True)
self.assertEqual(User.objects.get(username=_usernameLookup).is_active, False)
call_command("ldap_clean_users", superuser=True, verbosity=0)
self.assertEqual(User.objects.get(username=_username).is_active, False)
"""
Test with staff user
"""
# Reactivate first user and promote to staff
user = User.objects.get(username=_username)
user.is_active = True
user.is_superuser = False
user.is_staff = True
user.save()
# Reactivate second user
user = User.objects.get(username=_usernameLookup)
user.is_active = True
user.save()
call_command("ldap_clean_users", staff=False, verbosity=0)
self.assertEqual(User.objects.get(username=_username).is_active, True)
self.assertEqual(User.objects.get(username=_usernameLookup).is_active, False)
call_command("ldap_clean_users", staff=True, verbosity=0)
self.assertEqual(User.objects.get(username=_username).is_active, False)
def testCleanUsersPurge(self):
"""
ldap_clean_users management command test with purge argument
"""
from django.contrib.auth import get_user_model
User = get_user_model()
user = User.objects.create_user(
"nonldap{user}".format(user=settings.LDAP_AUTH_TEST_USER_USERNAME),
"nonldap{mail}".format(mail=settings.LDAP_AUTH_TEST_USER_EMAIL),
settings.LDAP_AUTH_TEST_USER_PASSWORD)
user.save()
user_count_1 = User.objects.count()
call_command("ldap_clean_users", verbosity=0, purge=True)
user_count_2 = User.objects.count()
self.assertGreater(user_count_1, user_count_2)
def testCleanUsersCommandOutput(self):
# Test without purge
out = StringIO()
from django.contrib.auth import get_user_model
User = get_user_model()
user = User.objects.create_user(
"nonldap{user}".format(user=settings.LDAP_AUTH_TEST_USER_USERNAME),
"nonldap{mail}".format(mail=settings.LDAP_AUTH_TEST_USER_EMAIL),
settings.LDAP_AUTH_TEST_USER_PASSWORD)
user.save()
call_command("ldap_clean_users", stdout=out, verbosity=1)
rows = out.getvalue().split("\n")[:-1]
self.assertEqual(len(rows), 1)
for row in rows:
self.assertRegex(row, r'^Deactivated ')
# Reset for next test
user.delete()
out.truncate(0)
out.seek(0)
# Test with purge
user = User.objects.create_user(
"nonldap{user}".format(user=settings.LDAP_AUTH_TEST_USER_USERNAME),
"nonldap{mail}".format(mail=settings.LDAP_AUTH_TEST_USER_EMAIL),
settings.LDAP_AUTH_TEST_USER_PASSWORD)
user.save()
call_command("ldap_clean_users", stdout=out, verbosity=1, purge=True)
rows = out.getvalue().split("\n")[:-1]
self.assertEqual(len(rows), 1)
for row in rows:
self.assertRegex(row, r'^Purged ')
def testReCleanUsersDoesntRecreateUsers(self):
from django.contrib.auth import get_user_model
User = get_user_model()
user = User.objects.create_user(
"nonldap{user}".format(user=settings.LDAP_AUTH_TEST_USER_USERNAME),
"nonldap{mail}".format(mail=settings.LDAP_AUTH_TEST_USER_EMAIL),
settings.LDAP_AUTH_TEST_USER_PASSWORD)
user.save()
call_command("ldap_clean_users", verbosity=0, purge=True)
user_count_1 = User.objects.count()
call_command("ldap_clean_users", verbosity=0, purge=True)
user_count_2 = User.objects.count()
self.assertEqual(user_count_1, user_count_2)
|
