-
-
Notifications
You must be signed in to change notification settings - Fork 7.7k
/
test_auth_backends.py
7528 lines (6715 loc) · 322 KB
/
test_auth_backends.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
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
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import base64
import copy
import datetime
import json
import os
import re
import secrets
import time
import urllib
from abc import ABC, abstractmethod
from contextlib import contextmanager
from email.headerregistry import Address
from typing import (
TYPE_CHECKING,
Any,
Callable,
Dict,
Iterable,
Iterator,
List,
Mapping,
Optional,
Sequence,
Tuple,
Type,
)
from unittest import mock
from urllib.parse import urlencode
import jwt
import ldap
import orjson
import requests
import responses
import time_machine
from bs4 import BeautifulSoup
from bs4.element import Tag
from cryptography.hazmat.primitives.ciphers.aead import AESGCM
from django.conf import settings
from django.contrib.auth import authenticate
from django.core import mail
from django.http import HttpRequest
from django.test import override_settings
from django.urls import reverse
from django.utils.timezone import now as timezone_now
from django_auth_ldap.backend import LDAPSearch, _LDAPUser
from jwt.exceptions import PyJWTError
from onelogin.saml2.auth import OneLogin_Saml2_Auth
from onelogin.saml2.logout_request import OneLogin_Saml2_Logout_Request
from onelogin.saml2.logout_response import OneLogin_Saml2_Logout_Response
from onelogin.saml2.response import OneLogin_Saml2_Response
from onelogin.saml2.utils import OneLogin_Saml2_Utils
from social_core.exceptions import AuthFailed, AuthStateForbidden
from social_django.storage import BaseDjangoStorage
from social_django.strategy import DjangoStrategy
from typing_extensions import override
from confirmation.models import Confirmation, create_confirmation_link
from zerver.actions.create_realm import do_create_realm
from zerver.actions.create_user import do_create_user, do_reactivate_user
from zerver.actions.invites import do_invite_users
from zerver.actions.realm_settings import (
do_deactivate_realm,
do_reactivate_realm,
do_set_realm_authentication_methods,
do_set_realm_property,
)
from zerver.actions.user_groups import (
bulk_add_members_to_user_groups,
create_user_group_in_database,
)
from zerver.actions.user_settings import do_change_password, do_change_user_setting
from zerver.actions.users import change_user_is_active, do_deactivate_user
from zerver.lib.avatar import avatar_url
from zerver.lib.avatar_hash import user_avatar_path
from zerver.lib.dev_ldap_directory import generate_dev_ldap_dir
from zerver.lib.email_validation import (
get_existing_user_errors,
get_realm_email_validator,
validate_email_is_valid,
)
from zerver.lib.exceptions import JsonableError, RateLimitedError
from zerver.lib.initial_password import initial_password
from zerver.lib.mobile_auth_otp import otp_decrypt_api_key
from zerver.lib.storage import static_path
from zerver.lib.streams import ensure_stream
from zerver.lib.test_classes import ZulipTestCase
from zerver.lib.test_helpers import (
HostRequestMock,
create_s3_buckets,
load_subdomain_token,
ratelimit_rule,
read_test_image_file,
use_s3_backend,
)
from zerver.lib.types import Validator
from zerver.lib.upload.base import DEFAULT_AVATAR_SIZE, MEDIUM_AVATAR_SIZE, resize_avatar
from zerver.lib.user_groups import is_user_in_group
from zerver.lib.users import get_all_api_keys, get_api_key, get_users_for_api
from zerver.lib.utils import assert_is_not_none
from zerver.lib.validator import (
check_bool,
check_dict_only,
check_int,
check_list,
check_none_or,
check_string,
validate_login_email,
)
from zerver.models import (
CustomProfileField,
CustomProfileFieldValue,
MultiuseInvite,
PasswordTooWeakError,
PreregistrationUser,
Realm,
RealmDomain,
Stream,
UserGroup,
UserProfile,
clear_supported_auth_backends_cache,
get_realm,
get_user_by_delivery_email,
)
from zerver.signals import JUST_CREATED_THRESHOLD
from zerver.views.auth import log_into_subdomain, maybe_send_to_registration
from zproject.backends import (
AUTH_BACKEND_NAME_MAP,
AppleAuthBackend,
AzureADAuthBackend,
DevAuthBackend,
EmailAuthBackend,
ExternalAuthDataDict,
ExternalAuthMethod,
ExternalAuthResult,
GenericOpenIdConnectBackend,
GitHubAuthBackend,
GitLabAuthBackend,
GoogleAuthBackend,
NoMatchingLDAPUserError,
OutsideLDAPDomainError,
PopulateUserLDAPError,
RateLimitedAuthenticationByUsername,
SAMLAuthBackend,
SAMLDocument,
SocialAuthMixin,
ZulipAuthMixin,
ZulipDummyBackend,
ZulipLDAPAuthBackend,
ZulipLDAPConfigurationError,
ZulipLDAPError,
ZulipLDAPUser,
ZulipLDAPUserPopulator,
ZulipRemoteUserBackend,
apple_auth_enabled,
check_password_strength,
dev_auth_enabled,
email_belongs_to_ldap,
get_external_method_dicts,
github_auth_enabled,
gitlab_auth_enabled,
google_auth_enabled,
password_auth_enabled,
query_ldap,
require_email_format_usernames,
saml_auth_enabled,
sync_user_from_ldap,
)
from zproject.config import get_from_file_if_exists
if TYPE_CHECKING:
from django.test.client import _MonkeyPatchedWSGIResponse as TestHttpResponse
APPLE_ID_TOKEN_GENERATION_KEY = get_from_file_if_exists(
"zerver/tests/fixtures/apple/token_gen_private_key"
)
EXAMPLE_JWK = get_from_file_if_exists("zerver/tests/fixtures/example_jwk")
class AuthBackendTest(ZulipTestCase):
def get_email(self) -> str:
return self.example_email("hamlet")
def verify_backend(
self,
backend: Any,
*,
good_kwargs: Dict[str, Any],
bad_kwargs: Optional[Dict[str, Any]] = None,
) -> None:
clear_supported_auth_backends_cache()
user_profile = self.example_user("hamlet")
# If bad_kwargs was specified, verify auth fails in that case
if bad_kwargs is not None:
self.assertIsNone(backend.authenticate(**bad_kwargs))
# Verify auth works
result = backend.authenticate(**good_kwargs)
self.assertEqual(user_profile, result)
# Verify auth fails with a deactivated user
do_deactivate_user(user_profile, acting_user=None)
result = backend.authenticate(**good_kwargs)
if isinstance(backend, SocialAuthMixin):
# Returns a redirect to login page with an error.
self.assertEqual(result.status_code, 302)
self.assertEqual(
result["Location"],
f"{user_profile.realm.uri}/login/?"
+ urlencode({"is_deactivated": user_profile.delivery_email}),
)
else:
# Just takes you back to the login page treating as
# invalid auth; this is correct because the form will
# provide the appropriate validation error for deactivated
# account.
self.assertIsNone(result)
# Reactivate the user and verify auth works again
do_reactivate_user(user_profile, acting_user=None)
result = backend.authenticate(**good_kwargs)
self.assertEqual(user_profile, result)
# Verify auth fails with a deactivated realm
do_deactivate_realm(user_profile.realm, acting_user=None)
result = backend.authenticate(**good_kwargs)
if isinstance(backend, SocialAuthMixin):
self.assertEqual(result.status_code, 302)
self.assertEqual(result["Location"], user_profile.realm.uri + "/login/")
else:
self.assertIsNone(result)
# Verify auth works again after reactivating the realm
do_reactivate_realm(user_profile.realm)
result = backend.authenticate(**good_kwargs)
self.assertEqual(user_profile, result)
# ZulipDummyBackend isn't a real backend so the remainder
# doesn't make sense for it
if isinstance(backend, ZulipDummyBackend):
return
# Verify auth fails if the auth backend is disabled on server
with self.settings(AUTHENTICATION_BACKENDS=("zproject.backends.ZulipDummyBackend",)):
clear_supported_auth_backends_cache()
result = backend.authenticate(**good_kwargs)
if isinstance(backend, SocialAuthMixin):
self.assertEqual(result.status_code, 302)
self.assertEqual(result["Location"], user_profile.realm.uri + "/login/")
else:
self.assertIsNone(result)
clear_supported_auth_backends_cache()
# Verify auth fails if the auth backend is disabled for the realm
for backend_name in AUTH_BACKEND_NAME_MAP:
if isinstance(backend, AUTH_BACKEND_NAME_MAP[backend_name]):
break
authentication_methods = user_profile.realm.authentication_methods_dict()
authentication_methods[backend_name] = False
do_set_realm_authentication_methods(
user_profile.realm, authentication_methods, acting_user=None
)
if "realm" in good_kwargs:
# Because this test is a little unfaithful to the ordering
# (i.e. we fetched the realm object before this function
# was called, when in fact it should be fetched after we
# changed the allowed authentication methods), we need to
# propagate the changes we just made to the actual realm
# object in good_kwargs.
good_kwargs["realm"] = user_profile.realm
if isinstance(backend, SocialAuthMixin):
self.assertEqual(result.status_code, 302)
self.assertEqual(result["Location"], user_profile.realm.uri + "/login/")
else:
self.assertIsNone(result)
authentication_methods[backend_name] = True
do_set_realm_authentication_methods(
user_profile.realm, authentication_methods, acting_user=None
)
def test_dummy_backend(self) -> None:
realm = get_realm("zulip")
username = self.get_email()
self.verify_backend(
ZulipDummyBackend(),
good_kwargs=dict(username=username, realm=realm, use_dummy_backend=True),
bad_kwargs=dict(username=username, realm=realm, use_dummy_backend=False),
)
def setup_subdomain(self, user_profile: UserProfile) -> None:
realm = user_profile.realm
realm.string_id = "zulip"
realm.save()
def test_email_auth_backend(self) -> None:
username = self.get_email()
user_profile = self.example_user("hamlet")
password = "testpassword"
user_profile.set_password(password)
user_profile.save()
with mock.patch("zproject.backends.email_auth_enabled", return_value=False), mock.patch(
"zproject.backends.password_auth_enabled", return_value=True
):
return_data: Dict[str, bool] = {}
user = EmailAuthBackend().authenticate(
request=mock.MagicMock(),
username=user_profile.delivery_email,
realm=get_realm("zulip"),
password=password,
return_data=return_data,
)
self.assertEqual(user, None)
self.assertTrue(return_data["email_auth_disabled"])
self.verify_backend(
EmailAuthBackend(),
good_kwargs=dict(
request=mock.MagicMock(),
password=password,
username=username,
realm=get_realm("zulip"),
return_data={},
),
bad_kwargs=dict(
request=mock.MagicMock(),
password=password,
username=username,
realm=get_realm("zephyr"),
return_data={},
),
)
def test_email_auth_backend_empty_password(self) -> None:
user_profile = self.example_user("hamlet")
password = "testpassword"
user_profile.set_password(password)
user_profile.save()
# First, verify authentication works with a nonempty
# password so we know we've set up the test correctly.
self.assertIsNotNone(
EmailAuthBackend().authenticate(
request=mock.MagicMock(),
username=self.example_email("hamlet"),
password=password,
realm=get_realm("zulip"),
)
)
# Now do the same test with the empty string as the password.
password = ""
with self.assertRaises(PasswordTooWeakError):
# UserProfile.set_password protects against setting an empty password.
user_profile.set_password(password)
# We do want to force an empty password for this test, so we bypass the protection
# by using Django's version of this method.
super(UserProfile, user_profile).set_password(password)
user_profile.save()
self.assertIsNone(
EmailAuthBackend().authenticate(
request=mock.MagicMock(),
username=self.example_email("hamlet"),
password=password,
realm=get_realm("zulip"),
)
)
def test_email_auth_backend_disabled_password_auth(self) -> None:
user_profile = self.example_user("hamlet")
password = "testpassword"
user_profile.set_password(password)
user_profile.save()
# Verify if a realm has password auth disabled, correct password is rejected
with mock.patch("zproject.backends.password_auth_enabled", return_value=False):
self.assertIsNone(
EmailAuthBackend().authenticate(
request=mock.MagicMock(),
username=self.example_email("hamlet"),
password=password,
realm=get_realm("zulip"),
)
)
def test_email_auth_backend_password_hasher_change(self) -> None:
user_profile = self.example_user("hamlet")
password = "a_password_of_22_chars"
with self.settings(PASSWORD_HASHERS=("django.contrib.auth.hashers.SHA1PasswordHasher",)):
user_profile.set_password(password)
user_profile.save()
with self.settings(
PASSWORD_HASHERS=(
"django.contrib.auth.hashers.MD5PasswordHasher",
"django.contrib.auth.hashers.SHA1PasswordHasher",
),
PASSWORD_MIN_LENGTH=30,
), self.assertLogs("zulip.auth.email", level="INFO"), self.assertRaises(JsonableError) as m:
EmailAuthBackend().authenticate(
request=mock.MagicMock(),
username=self.example_email("hamlet"),
password=password,
realm=get_realm("zulip"),
)
self.assertEqual(str(m.exception), "You need to reset your password.")
def test_login_preview(self) -> None:
# Test preview=true displays organization login page
# instead of redirecting to app
self.login("iago")
realm = get_realm("zulip")
result = self.client_get("/login/", {"preview": "true"})
self.assertEqual(result.status_code, 200)
self.assert_in_response(realm.description, result)
assert realm.name is not None
self.assert_in_response(realm.name, result)
self.assert_in_response("Log in to Zulip", result)
data = dict(
description=orjson.dumps("New realm description").decode(),
name=orjson.dumps("New Zulip").decode(),
)
result = self.client_patch("/json/realm", data)
self.assert_json_success(result)
result = self.client_get("/login/", {"preview": "true"})
self.assertEqual(result.status_code, 200)
self.assert_in_response("New realm description", result)
self.assert_in_response("New Zulip", result)
result = self.client_get("/login/")
self.assertEqual(result.status_code, 302)
self.assertEqual(result["Location"], "http://zulip.testserver/")
@override_settings(AUTHENTICATION_BACKENDS=("zproject.backends.ZulipDummyBackend",))
def test_no_backend_enabled(self) -> None:
result = self.client_get("/login/")
self.assert_in_success_response(["No authentication backends are enabled"], result)
result = self.client_get("/register/")
self.assert_in_success_response(["No authentication backends are enabled"], result)
@override_settings(AUTHENTICATION_BACKENDS=("zproject.backends.GoogleAuthBackend",))
def test_any_backend_enabled(self) -> None:
# testing to avoid false error messages.
result = self.client_get("/login/")
self.assert_not_in_success_response(["No authentication backends are enabled"], result)
result = self.client_get("/register/")
self.assert_not_in_success_response(["No authentication backends are enabled"], result)
@override_settings(
AUTHENTICATION_BACKENDS=("zproject.backends.ZulipLDAPAuthBackend",), LDAP_EMAIL_ATTR="mail"
)
def test_ldap_backend(self) -> None:
self.init_default_ldap_database()
user_profile = self.example_user("hamlet")
email = user_profile.delivery_email
password = self.ldap_password("hamlet")
self.setup_subdomain(user_profile)
username = self.get_email()
backend = ZulipLDAPAuthBackend()
# Test LDAP auth fails when LDAP server rejects password
self.assertIsNone(
backend.authenticate(
request=mock.MagicMock(),
username=email,
password="wrongpass",
realm=get_realm("zulip"),
)
)
self.verify_backend(
backend,
bad_kwargs=dict(
request=mock.MagicMock(),
username=username,
password=password,
realm=get_realm("zephyr"),
),
good_kwargs=dict(
request=mock.MagicMock(),
username=username,
password=password,
realm=get_realm("zulip"),
),
)
def test_devauth_backend(self) -> None:
self.verify_backend(
DevAuthBackend(),
good_kwargs=dict(dev_auth_username=self.get_email(), realm=get_realm("zulip")),
bad_kwargs=dict(dev_auth_username=self.get_email(), realm=get_realm("zephyr")),
)
@override_settings(AUTHENTICATION_BACKENDS=("zproject.backends.ZulipRemoteUserBackend",))
def test_remote_user_backend(self) -> None:
username = self.get_email()
self.verify_backend(
ZulipRemoteUserBackend(),
good_kwargs=dict(remote_user=username, realm=get_realm("zulip")),
bad_kwargs=dict(remote_user=username, realm=get_realm("zephyr")),
)
@override_settings(AUTHENTICATION_BACKENDS=("zproject.backends.ZulipRemoteUserBackend",))
def test_remote_user_backend_invalid_realm(self) -> None:
username = self.get_email()
self.verify_backend(
ZulipRemoteUserBackend(),
good_kwargs=dict(remote_user=username, realm=get_realm("zulip")),
bad_kwargs=dict(remote_user=username, realm=get_realm("zephyr")),
)
@override_settings(AUTHENTICATION_BACKENDS=("zproject.backends.ZulipRemoteUserBackend",))
@override_settings(SSO_APPEND_DOMAIN="zulip.com")
def test_remote_user_backend_sso_append_domain(self) -> None:
username = Address(addr_spec=self.get_email()).username
self.verify_backend(
ZulipRemoteUserBackend(),
good_kwargs=dict(remote_user=username, realm=get_realm("zulip")),
bad_kwargs=dict(remote_user=username, realm=get_realm("zephyr")),
)
@override_settings(
AUTHENTICATION_BACKENDS=(
"zproject.backends.GitHubAuthBackend",
"zproject.backends.GoogleAuthBackend",
)
)
def test_social_auth_backends(self) -> None:
user = self.example_user("hamlet")
token_data_dict = {
"access_token": "foobar",
"token_type": "bearer",
}
github_email_data = [
dict(email=user.delivery_email, verified=True, primary=True),
dict(email="nonprimary@zulip.com", verified=True),
dict(email="ignored@example.com", verified=False),
]
google_email_data = dict(
email=user.delivery_email, name=user.full_name, email_verified=True
)
backends_to_test: Dict[str, Any] = {
"google": {
"urls": [
# The limited process that we test here doesn't require mocking any urls.
],
"backend": GoogleAuthBackend,
},
"github": {
"urls": [
{
"url": "https://api.github.com/user/emails",
"method": responses.GET,
"status": 200,
"body": json.dumps(github_email_data),
},
],
"backend": GitHubAuthBackend,
},
}
def patched_authenticate(
request: Optional["TestHttpResponse"] = None,
**kwargs: Any,
) -> Any:
# This is how we pass the subdomain to the authentication
# backend in production code, so we need to do this setup
# here.
if "subdomain" in kwargs:
backend.strategy.session_set("subdomain", kwargs["subdomain"])
del kwargs["subdomain"]
# Because we're not simulating the full python-social-auth
# pipeline here, we need to provide the user's choice of
# which email to select in the partial phase of the
# pipeline when we display an email picker for the GitHub
# authentication backend. We do that here.
def return_email() -> Dict[str, str]:
return {"email": user.delivery_email}
backend.strategy.request_data = return_email
if request is None:
request = mock.MagicMock()
request.META = dict(REMOTE_ADDR="127.0.0.1")
backend.strategy.request = request
result = orig_authenticate(backend, request, **kwargs)
return result
def patched_get_verified_emails(*args: Any, **kwargs: Any) -> Any:
return google_email_data["email"]
for backend_name in backends_to_test:
with responses.RequestsMock(assert_all_requests_are_fired=True) as requests_mock:
urls: List[Dict[str, Any]] = backends_to_test[backend_name]["urls"]
for details in urls:
requests_mock.add(
details["method"],
details["url"],
status=details["status"],
body=details["body"],
)
backend_class = backends_to_test[backend_name]["backend"]
# We're creating a new class instance here, so the
# monkey-patching of the instance that we're about to
# do will be discarded at the end of this test.
backend = backend_class()
backend.strategy = DjangoStrategy(storage=BaseDjangoStorage())
orig_authenticate = backend_class.authenticate
backend.authenticate = patched_authenticate
if backend_name == "google":
backend.get_verified_emails = patched_get_verified_emails
good_kwargs = dict(
backend=backend,
strategy=backend.strategy,
storage=backend.strategy.storage,
response=token_data_dict,
subdomain="zulip",
)
bad_kwargs = dict(subdomain="acme")
logger_name = f"zulip.auth.{backend.name}"
with mock.patch(
"zerver.views.auth.redirect_and_log_into_subdomain", return_value=user
), self.assertLogs(logger_name, level="INFO") as info_log:
self.verify_backend(backend, good_kwargs=good_kwargs, bad_kwargs=bad_kwargs)
bad_kwargs["subdomain"] = "zephyr"
self.verify_backend(backend, good_kwargs=good_kwargs, bad_kwargs=bad_kwargs)
# Verify logging for deactivated users
self.assertEqual(
# Filter out noisy logs:
[
output
for output in info_log.output
if "Authentication attempt from 127.0.0.1" not in output
],
[
f"INFO:{logger_name}:Failed login attempt for deactivated account: {user.id}@{user.realm.string_id}",
f"INFO:{logger_name}:Failed login attempt for deactivated account: {user.id}@{user.realm.string_id}",
],
)
class RateLimitAuthenticationTests(ZulipTestCase):
@override_settings(RATE_LIMITING_AUTHENTICATE=True)
def do_test_auth_rate_limiting(
self,
attempt_authentication_func: Callable[[HttpRequest, str, str], Optional[UserProfile]],
username: str,
correct_password: str,
wrong_password: str,
expected_user_profile: UserProfile,
) -> None:
# We have to mock RateLimitedAuthenticationByUsername.key to avoid key collisions
# if tests run in parallel.
original_key_method = RateLimitedAuthenticationByUsername.key
salt = secrets.token_hex(16)
def _mock_key(self: RateLimitedAuthenticationByUsername) -> str:
return f"{salt}:{original_key_method(self)}"
def attempt_authentication(username: str, password: str) -> Optional[UserProfile]:
request = HttpRequest()
request.session = mock.MagicMock()
return attempt_authentication_func(request, username, password)
with mock.patch.object(
RateLimitedAuthenticationByUsername, "key", new=_mock_key
), ratelimit_rule(10, 2, domain="authenticate_by_username"):
try:
start_time = time.time()
with mock.patch("time.time", return_value=start_time):
self.assertIsNone(attempt_authentication(username, wrong_password))
self.assertIsNone(attempt_authentication(username, wrong_password))
# 2 failed attempts is the limit, so the next ones should get blocked,
# even with the correct password.
with self.assertRaises(RateLimitedError):
attempt_authentication(username, correct_password)
with self.assertRaises(RateLimitedError):
attempt_authentication(username, wrong_password)
# After enough time passes, more authentication attempts can be made:
with mock.patch("time.time", return_value=start_time + 11.0):
self.assertIsNone(attempt_authentication(username, wrong_password))
# Correct password
self.assertEqual(
attempt_authentication(username, correct_password), expected_user_profile
)
# A correct login attempt should reset the rate limits for this user profile,
# so the next two attempts shouldn't get limited:
self.assertIsNone(attempt_authentication(username, wrong_password))
self.assertIsNone(attempt_authentication(username, wrong_password))
# But the third attempt goes over the limit:
with self.assertRaises(RateLimitedError):
attempt_authentication(username, wrong_password)
# Resetting the password also clears the rate-limit
do_change_password(expected_user_profile, correct_password)
self.assertIsNone(attempt_authentication(username, wrong_password))
finally:
# Clean up to avoid affecting other tests.
RateLimitedAuthenticationByUsername(username).clear_history()
def test_email_auth_backend_user_based_rate_limiting(self) -> None:
user_profile = self.example_user("hamlet")
password = "testpassword"
user_profile.set_password(password)
user_profile.save()
def attempt_authentication(
request: HttpRequest, username: str, password: str
) -> Optional[UserProfile]:
return EmailAuthBackend().authenticate(
request=request,
username=username,
realm=get_realm("zulip"),
password=password,
return_data={},
)
self.do_test_auth_rate_limiting(
attempt_authentication,
user_profile.delivery_email,
password,
"wrong_password",
user_profile,
)
@override_settings(
AUTHENTICATION_BACKENDS=("zproject.backends.ZulipLDAPAuthBackend",), LDAP_EMAIL_ATTR="mail"
)
def test_ldap_backend_user_based_rate_limiting(self) -> None:
self.init_default_ldap_database()
user_profile = self.example_user("hamlet")
password = self.ldap_password("hamlet")
def attempt_authentication(
request: HttpRequest, username: str, password: str
) -> Optional[UserProfile]:
return ZulipLDAPAuthBackend().authenticate(
request=request,
username=username,
realm=get_realm("zulip"),
password=password,
return_data={},
)
self.do_test_auth_rate_limiting(
attempt_authentication,
user_profile.delivery_email,
password,
"wrong_password",
user_profile,
)
@override_settings(
AUTHENTICATION_BACKENDS=(
"zproject.backends.EmailAuthBackend",
"zproject.backends.ZulipLDAPAuthBackend",
),
LDAP_EMAIL_ATTR="mail",
)
def test_email_and_ldap_backends_user_based_rate_limiting(self) -> None:
self.init_default_ldap_database()
user_profile = self.example_user("hamlet")
ldap_password = self.ldap_password("hamlet")
email_password = "email_password"
user_profile.set_password(email_password)
user_profile.save()
def attempt_authentication(
request: HttpRequest, username: str, password: str
) -> Optional[UserProfile]:
user = authenticate(
request=request,
username=username,
realm=get_realm("zulip"),
password=password,
return_data={},
)
if user is not None:
assert isinstance(user, UserProfile)
return user
self.do_test_auth_rate_limiting(
attempt_authentication,
user_profile.delivery_email,
email_password,
"wrong_password",
user_profile,
)
self.do_test_auth_rate_limiting(
attempt_authentication,
user_profile.delivery_email,
ldap_password,
"wrong_password",
user_profile,
)
class CheckPasswordStrengthTest(ZulipTestCase):
def test_check_password_strength(self) -> None:
with self.settings(PASSWORD_MIN_LENGTH=0, PASSWORD_MIN_GUESSES=0):
# Never allow empty password.
self.assertFalse(check_password_strength(""))
with self.settings(PASSWORD_MIN_LENGTH=6, PASSWORD_MIN_GUESSES=1000):
self.assertFalse(check_password_strength(""))
self.assertFalse(check_password_strength("short"))
# Long enough, but too easy:
self.assertFalse(check_password_strength("longer"))
# Good password:
self.assertTrue(check_password_strength("f657gdGGk9"))
class DesktopFlowTestingLib(ZulipTestCase):
def verify_desktop_flow_app_page(self, response: "TestHttpResponse") -> None:
self.assertEqual(response.status_code, 200)
self.assertIn(b"<h1>Finish desktop login</h1>", response.content)
def verify_desktop_flow_end_page(
self, response: "TestHttpResponse", email: str, desktop_flow_otp: str
) -> None:
self.assertEqual(response.status_code, 200)
soup = BeautifulSoup(response.content, "html.parser")
input = soup.find("input", value=True)
assert isinstance(input, Tag)
desktop_data = input["value"]
assert isinstance(desktop_data, str)
a = soup.find("a", href=True)
assert isinstance(a, Tag)
browser_url = a["href"]
self.assertEqual(browser_url, "/login/")
decrypted_key = self.verify_desktop_data_and_return_key(desktop_data, desktop_flow_otp)
# Flush the session to have a clean slate - since up till now
# we were simulating the part of the flow that happens in the browser.
# Now we will simulating the last part of the flow, which gets executed
# in the desktop application - thus with a separate session.
self.client.session.flush()
result = self.client_get(
f"http://zulip.testserver/accounts/login/subdomain/{decrypted_key}"
)
self.assertEqual(result.status_code, 302)
realm = get_realm("zulip")
user_profile = get_user_by_delivery_email(email, realm)
self.assert_logged_in_user_id(user_profile.id)
def verify_desktop_data_and_return_key(self, desktop_data: str, desktop_flow_otp: str) -> str:
key = bytes.fromhex(desktop_flow_otp)
data = bytes.fromhex(desktop_data)
iv = data[:12]
ciphertext = data[12:]
return AESGCM(key).decrypt(iv, ciphertext, b"").decode()
class SocialAuthBase(DesktopFlowTestingLib, ZulipTestCase, ABC):
"""This is a base class for testing social-auth backends. These
methods are often overridden by subclasses:
register_extra_endpoints() - If the backend being tested calls some extra
endpoints then they can be added here.
get_account_data_dict() - Return the data returned by the user info endpoint
according to the respective backend.
"""
BACKEND_CLASS: "Type[SocialAuthMixin]"
LOGIN_URL: str
SIGNUP_URL: str
AUTHORIZATION_URL: str
AUTH_FINISH_URL: str
ACCESS_TOKEN_URL: str
USER_INFO_URL: str
CLIENT_KEY_SETTING: str
CLIENT_SECRET_SETTING: str
@abstractmethod
def get_account_data_dict(self, email: str, name: str) -> Dict[str, Any]:
raise NotImplementedError
@override
def setUp(self) -> None:
super().setUp()
self.user_profile = self.example_user("hamlet")
self.email = self.user_profile.delivery_email
self.name = self.user_profile.full_name
self.backend = self.BACKEND_CLASS
self.backend.strategy = DjangoStrategy(storage=BaseDjangoStorage())
self.logger_string = f"zulip.auth.{self.backend.name}"
# This is a workaround for the fact that Python social auth
# caches the set of authentication backends that are enabled
# the first time that `social_django.utils` is imported. See
# https://github.com/python-social-auth/social-app-django/pull/162
# for details.
from social_core.backends.utils import load_backends
load_backends(settings.AUTHENTICATION_BACKENDS, force_load=True)
def logger_output(self, output_string: str, type: str) -> str:
return f"{type.upper()}:zulip.auth.{self.backend.name}:{output_string}"
def register_extra_endpoints(
self,
requests_mock: responses.RequestsMock,
account_data_dict: Dict[str, str],
**extra_data: Any,
) -> None:
pass
def prepare_login_url_and_headers(
self,
subdomain: str,
mobile_flow_otp: Optional[str] = None,
desktop_flow_otp: Optional[str] = None,
is_signup: bool = False,
next: str = "",
multiuse_object_key: str = "",
alternative_start_url: Optional[str] = None,
*,
user_agent: Optional[str] = None,
) -> Tuple[str, Dict[str, Any]]:
url = self.LOGIN_URL
if alternative_start_url is not None:
url = alternative_start_url
params = {}
headers = {}
if subdomain == "":
# "testserver" may trip up some libraries' URL validation,
# so let's use the equivalent www. version.
headers["HTTP_HOST"] = "www.testserver"
else:
headers["HTTP_HOST"] = subdomain + ".testserver"
if mobile_flow_otp is not None:
params["mobile_flow_otp"] = mobile_flow_otp
headers["HTTP_USER_AGENT"] = "ZulipAndroid"
if desktop_flow_otp is not None:
params["desktop_flow_otp"] = desktop_flow_otp
if is_signup:
url = self.SIGNUP_URL
params["next"] = next
params["multiuse_object_key"] = multiuse_object_key
if len(params) > 0:
url += f"?{urlencode(params)}"
if user_agent is not None:
headers["HTTP_USER_AGENT"] = user_agent
return url, headers
def social_auth_test_finish(
self,
result: "TestHttpResponse",
account_data_dict: Dict[str, str],
expect_choose_email_screen: bool,
headers: Any,
**extra_data: Any,
) -> "TestHttpResponse":
parsed_url = urllib.parse.urlparse(result["Location"])
csrf_state = urllib.parse.parse_qs(parsed_url.query)["state"]
result = self.client_get(self.AUTH_FINISH_URL, dict(state=csrf_state), **headers)
return result
def generate_access_token_url_payload(self, account_data_dict: Dict[str, str]) -> str:
return json.dumps(
{
"access_token": "foobar",
"token_type": "bearer",
}
)
def social_auth_test(
self,
account_data_dict: Dict[str, str],
*,
subdomain: str,
mobile_flow_otp: Optional[str] = None,
desktop_flow_otp: Optional[str] = None,