Repository navigation
Expand file tree
/
Copy pathtest_session.py
More file actions
970 lines (860 loc) · 37 KB
/
Copy pathtest_session.py
File metadata and controls
970 lines (860 loc) · 37 KB
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
import time
from unittest.mock import MagicMock
import jwt as pyjwt
import pytest
from cryptography.fernet import Fernet, InvalidToken
from cryptography.hazmat.primitives.asymmetric import rsa
from workos import AsyncWorkOSClient, WorkOSClient
from workos._errors import (
AuthenticationError,
AuthenticationMethodNotAllowedError,
EmailVerificationRequiredError,
MfaChallengeError,
MfaEnrollmentError,
OrganizationAuthMethodsRequiredError,
OrganizationSelectionRequiredError,
RadarChallengeError,
SsoRequiredError,
WorkOSConnectionError,
WorkOSTimeoutError,
)
from workos.session import (
AsyncSession,
AuthenticateWithSessionCookieErrorResponse,
AuthenticateWithSessionCookieFailureReason,
AuthenticateWithSessionCookieSuccessResponse,
RefreshWithSessionCookieErrorResponse,
RefreshWithSessionCookieSuccessResponse,
Session,
_map_refresh_exception_to_reason,
seal_data,
seal_session_from_auth_response,
unseal_data,
)
def _generate_rsa_key_pair():
private_key = rsa.generate_private_key(public_exponent=65537, key_size=2048)
public_key = private_key.public_key()
return private_key, public_key
def _make_jwt(private_key, claims=None, expired=False):
now = time.time()
payload = {
"sid": "session_01",
"org_id": "org_01",
"role": "admin",
"roles": ["admin"],
"permissions": ["read", "write"],
"entitlements": ["premium"],
"feature_flags": ["beta"],
"iat": int(now),
"exp": int(now - 300) if expired else int(now + 3600),
}
if claims:
payload.update(claims)
return pyjwt.encode(payload, private_key, algorithm="RS256")
COOKIE_PASSWORD = Fernet.generate_key().decode("utf-8")
class TestSealUnseal:
def test_seal_unseal_roundtrip(self):
data = {"access_token": "abc", "user": {"id": "user_01"}}
sealed = seal_data(data, COOKIE_PASSWORD)
assert isinstance(sealed, str)
result = unseal_data(sealed, COOKIE_PASSWORD)
assert result == data
def test_seal_data_returns_string(self):
sealed = seal_data({"key": "value"}, COOKIE_PASSWORD)
assert isinstance(sealed, str)
def test_unseal_wrong_key(self):
other_key = Fernet.generate_key().decode("utf-8")
sealed = seal_data({"key": "value"}, COOKIE_PASSWORD)
with pytest.raises(InvalidToken):
unseal_data(sealed, other_key)
def test_unseal_corrupted_data(self):
with pytest.raises(Exception):
unseal_data("not-valid-fernet-data", COOKIE_PASSWORD)
class TestSealSessionFromAuthResponse:
def test_seal_and_unseal(self):
sealed = seal_session_from_auth_response(
access_token="at_123",
refresh_token="rt_456",
user={"id": "user_01", "email": "test@example.com"},
cookie_password=COOKIE_PASSWORD,
)
data = unseal_data(sealed, COOKIE_PASSWORD)
assert data["access_token"] == "at_123"
assert data["user"]["id"] == "user_01"
def test_seal_without_impersonator(self):
sealed = seal_session_from_auth_response(
access_token="at_123",
refresh_token="rt_456",
user={"id": "user_01", "email": "test@example.com"},
cookie_password=COOKIE_PASSWORD,
)
data = unseal_data(sealed, COOKIE_PASSWORD)
assert "impersonator" not in data
def test_seal_with_impersonator(self):
sealed = seal_session_from_auth_response(
access_token="at_123",
refresh_token="rt_456",
user={"id": "user_01", "email": "test@example.com"},
impersonator={"email": "admin@example.com"},
cookie_password=COOKIE_PASSWORD,
)
data = unseal_data(sealed, COOKIE_PASSWORD)
assert data["impersonator"]["email"] == "admin@example.com"
class TestSession:
def setup_method(self):
self.private_key, self.public_key = _generate_rsa_key_pair()
self.workos = WorkOSClient(
api_key="sk_test_123", client_id="client_test_123", max_retries=0
)
def teardown_method(self):
self.workos.close()
def _make_sealed_session(self, access_token, refresh_token="rt_123", user=None):
data = {"access_token": access_token, "refresh_token": refresh_token}
if user:
data["user"] = user
return seal_data(data, COOKIE_PASSWORD)
def _mock_jwks(self):
mock_jwks = MagicMock()
mock_signing_key = MagicMock()
mock_signing_key.key = self.public_key
mock_jwks.get_signing_key_from_jwt.return_value = mock_signing_key
return mock_jwks
def test_session_cookie_password_required(self):
with pytest.raises(ValueError, match="cookie_password is required"):
Session(client=self.workos, session_data="anything", cookie_password="")
def test_session_authenticate_no_session_data(self):
session = Session(
client=self.workos, session_data="", cookie_password=COOKIE_PASSWORD
)
result = session.authenticate()
assert isinstance(result, AuthenticateWithSessionCookieErrorResponse)
assert (
result.reason
== AuthenticateWithSessionCookieFailureReason.NO_SESSION_COOKIE_PROVIDED
)
def test_session_authenticate_invalid_sealed_data(self):
session = Session(
client=self.workos,
session_data="garbage-data",
cookie_password=COOKIE_PASSWORD,
)
result = session.authenticate()
assert isinstance(result, AuthenticateWithSessionCookieErrorResponse)
assert (
result.reason
== AuthenticateWithSessionCookieFailureReason.INVALID_SESSION_COOKIE
)
def test_session_authenticate_no_access_token(self):
sealed = seal_data({"refresh_token": "rt"}, COOKIE_PASSWORD)
session = Session(
client=self.workos, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
result = session.authenticate()
assert isinstance(result, AuthenticateWithSessionCookieErrorResponse)
assert (
result.reason
== AuthenticateWithSessionCookieFailureReason.INVALID_SESSION_COOKIE
)
def test_session_authenticate_success(self):
token = _make_jwt(self.private_key)
sealed = self._make_sealed_session(
access_token=token, user={"id": "user_01", "email": "test@example.com"}
)
session = Session(
client=self.workos, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
session.jwks = self._mock_jwks()
result = session.authenticate()
assert isinstance(result, AuthenticateWithSessionCookieSuccessResponse)
assert result.authenticated
assert result.session_id == "session_01"
assert result.organization_id == "org_01"
assert result.role == "admin"
assert result.permissions == ["read", "write"]
def test_session_authenticate_expired_jwt(self):
token = _make_jwt(self.private_key, expired=True)
sealed = self._make_sealed_session(access_token=token)
session = Session(
client=self.workos, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
session.jwks = self._mock_jwks()
result = session.authenticate()
assert isinstance(result, AuthenticateWithSessionCookieErrorResponse)
assert result.reason == AuthenticateWithSessionCookieFailureReason.INVALID_JWT
def _authenticate_with_client(self, client, claims=None):
token = _make_jwt(self.private_key, claims=claims)
sealed = self._make_sealed_session(access_token=token)
session = Session(
client=client, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
session.jwks = self._mock_jwks()
return session.authenticate()
def test_session_authenticate_ignores_issuer_when_not_configured(self):
result = self._authenticate_with_client(
self.workos, claims={"iss": "https://other.example.com"}
)
assert isinstance(result, AuthenticateWithSessionCookieSuccessResponse)
def test_session_authenticate_accepts_configured_issuer(self):
client = WorkOSClient(
api_key="sk_test_123",
client_id="client_test_123",
jwt_issuer="https://api.workos.com/user_management/client_test_123",
max_retries=0,
)
try:
result = self._authenticate_with_client(
client,
claims={
"iss": "https://api.workos.com/user_management/client_test_123"
},
)
finally:
client.close()
assert isinstance(result, AuthenticateWithSessionCookieSuccessResponse)
def test_session_authenticate_rejects_mismatched_issuer(self):
client = WorkOSClient(
api_key="sk_test_123",
client_id="client_test_123",
jwt_issuer="https://api.workos.com",
max_retries=0,
)
try:
result = self._authenticate_with_client(
client, claims={"iss": "https://other.example.com"}
)
finally:
client.close()
assert isinstance(result, AuthenticateWithSessionCookieErrorResponse)
assert result.reason == AuthenticateWithSessionCookieFailureReason.INVALID_JWT
def test_session_authenticate_accepts_any_listed_issuer(self):
client = WorkOSClient(
api_key="sk_test_123",
client_id="client_test_123",
jwt_issuer=["https://api.workos.com", "https://auth.example.com"],
max_retries=0,
)
try:
result = self._authenticate_with_client(
client, claims={"iss": "https://auth.example.com"}
)
finally:
client.close()
assert isinstance(result, AuthenticateWithSessionCookieSuccessResponse)
def test_session_authenticate_reads_issuer_list_from_env(self, monkeypatch):
monkeypatch.setenv(
"WORKOS_ISSUER", "https://api.workos.com, https://auth.example.com,"
)
client = WorkOSClient(
api_key="sk_test_123", client_id="client_test_123", max_retries=0
)
try:
assert client._jwt_issuer == [
"https://api.workos.com",
"https://auth.example.com",
]
result = self._authenticate_with_client(
client, claims={"iss": "https://auth.example.com"}
)
finally:
client.close()
assert isinstance(result, AuthenticateWithSessionCookieSuccessResponse)
def test_session_empty_issuer_list_rejects_all_tokens(self):
client = WorkOSClient(
api_key="sk_test_123",
client_id="client_test_123",
jwt_issuer=[],
max_retries=0,
)
try:
assert client._jwt_issuer == []
result = self._authenticate_with_client(
client, claims={"iss": "https://api.workos.com"}
)
finally:
client.close()
assert isinstance(result, AuthenticateWithSessionCookieErrorResponse)
assert result.reason == AuthenticateWithSessionCookieFailureReason.INVALID_JWT
def _refresh_with_client(self, client, claims=None):
new_token = _make_jwt(self.private_key, claims=claims)
sealed = seal_data(
{"refresh_token": "rt_old", "user": {"id": "user_01"}}, COOKIE_PASSWORD
)
session = Session(
client=client, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
session.jwks = self._mock_jwks()
session._client.request_raw = MagicMock(
return_value={
"access_token": new_token,
"refresh_token": "rt_new",
"user": {"id": "user_01"},
}
)
return session.refresh()
def test_session_refresh_accepts_configured_issuer(self):
client = WorkOSClient(
api_key="sk_test_123",
client_id="client_test_123",
jwt_issuer="https://api.workos.com",
max_retries=0,
)
try:
result = self._refresh_with_client(
client, claims={"iss": "https://api.workos.com"}
)
finally:
client.close()
assert isinstance(result, RefreshWithSessionCookieSuccessResponse)
def test_session_refresh_rejects_mismatched_issuer(self):
client = WorkOSClient(
api_key="sk_test_123",
client_id="client_test_123",
jwt_issuer="https://api.workos.com",
max_retries=0,
)
try:
result = self._refresh_with_client(
client, claims={"iss": "https://other.example.com"}
)
finally:
client.close()
assert isinstance(result, RefreshWithSessionCookieErrorResponse)
assert result.reason == AuthenticateWithSessionCookieFailureReason.INVALID_JWT
def test_session_single_env_issuer_stays_string(self, monkeypatch):
monkeypatch.setenv("WORKOS_ISSUER", "https://api.workos.com")
client = WorkOSClient(
api_key="sk_test_123", client_id="client_test_123", max_retries=0
)
try:
assert client._jwt_issuer == "https://api.workos.com"
finally:
client.close()
def test_session_refresh_invalid_session(self):
session = Session(
client=self.workos, session_data="garbage", cookie_password=COOKIE_PASSWORD
)
result = session.refresh()
assert isinstance(result, RefreshWithSessionCookieErrorResponse)
assert not result.authenticated
def test_session_refresh_missing_refresh_token(self):
sealed = seal_data({"access_token": "at"}, COOKIE_PASSWORD)
session = Session(
client=self.workos, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
result = session.refresh()
assert isinstance(result, RefreshWithSessionCookieErrorResponse)
def test_session_refresh_success(self):
new_token = _make_jwt(self.private_key)
sealed = seal_data(
{"refresh_token": "rt_old", "user": {"id": "user_01"}}, COOKIE_PASSWORD
)
session = Session(
client=self.workos, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
session.jwks = self._mock_jwks()
api_response = {
"access_token": new_token,
"refresh_token": "rt_new",
"user": {"id": "user_01", "email": "test@example.com"},
"authentication_method": "Password",
}
session._client.request_raw = MagicMock(return_value=api_response)
result = session.refresh()
assert isinstance(result, RefreshWithSessionCookieSuccessResponse)
assert result.authenticated
assert result.session_id == "session_01"
assert result.organization_id == "org_01"
assert result.user == {"id": "user_01", "email": "test@example.com"}
unsealed = unseal_data(result.sealed_session, COOKIE_PASSWORD)
assert unsealed["access_token"] == new_token
assert unsealed["refresh_token"] == "rt_new"
assert unsealed["user"]["id"] == "user_01"
assert session.session_data == result.sealed_session
def test_session_refresh_seals_client_side_without_sealed_session_in_response(self):
"""Regression: API response never contains sealed_session; the SDK must seal locally."""
new_token = _make_jwt(self.private_key)
sealed = seal_data(
{"refresh_token": "rt_old", "user": {"id": "user_01"}}, COOKIE_PASSWORD
)
session = Session(
client=self.workos, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
session.jwks = self._mock_jwks()
api_response = {
"access_token": new_token,
"refresh_token": "rt_new",
"user": {"id": "user_01"},
"authentication_method": "Password",
}
session._client.request_raw = MagicMock(return_value=api_response)
result = session.refresh()
assert isinstance(result, RefreshWithSessionCookieSuccessResponse)
assert result.sealed_session
unsealed = unseal_data(result.sealed_session, COOKIE_PASSWORD)
assert unsealed["access_token"] == new_token
assert unsealed["refresh_token"] == "rt_new"
def test_session_refresh_with_impersonator(self):
new_token = _make_jwt(self.private_key)
sealed = seal_data(
{"refresh_token": "rt_old", "user": {"id": "user_01"}}, COOKIE_PASSWORD
)
session = Session(
client=self.workos, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
session.jwks = self._mock_jwks()
api_response = {
"access_token": new_token,
"refresh_token": "rt_new",
"user": {"id": "user_01"},
"impersonator": {"email": "admin@example.com"},
"authentication_method": "Password",
}
session._client.request_raw = MagicMock(return_value=api_response)
result = session.refresh()
assert isinstance(result, RefreshWithSessionCookieSuccessResponse)
assert result.impersonator == {"email": "admin@example.com"}
unsealed = unseal_data(result.sealed_session, COOKIE_PASSWORD)
assert unsealed["impersonator"]["email"] == "admin@example.com"
def test_session_refresh_does_not_send_session_param(self):
"""The session/seal_session param should not be sent to the API."""
new_token = _make_jwt(self.private_key)
sealed = seal_data(
{"refresh_token": "rt_old", "user": {"id": "user_01"}}, COOKIE_PASSWORD
)
session = Session(
client=self.workos, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
session.jwks = self._mock_jwks()
api_response = {
"access_token": new_token,
"refresh_token": "rt_new",
"user": {"id": "user_01"},
"authentication_method": "Password",
}
session._client.request_raw = MagicMock(return_value=api_response)
session.refresh()
call_kwargs = session._client.request_raw.call_args
sent_body = call_kwargs.kwargs.get("body") or call_kwargs[1].get("body")
assert "session" not in sent_body
def test_session_refresh_round_trip_authenticate(self):
"""The sealed cookie produced by refresh() must be re-authenticatable."""
new_token = _make_jwt(self.private_key)
sealed = seal_data(
{"refresh_token": "rt_old", "user": {"id": "user_01"}}, COOKIE_PASSWORD
)
session = Session(
client=self.workos, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
session.jwks = self._mock_jwks()
api_response = {
"access_token": new_token,
"refresh_token": "rt_new",
"user": {"id": "user_01", "email": "test@example.com"},
"authentication_method": "Password",
}
session._client.request_raw = MagicMock(return_value=api_response)
refresh_result = session.refresh()
assert isinstance(refresh_result, RefreshWithSessionCookieSuccessResponse)
new_session = Session(
client=self.workos,
session_data=refresh_result.sealed_session,
cookie_password=COOKIE_PASSWORD,
)
new_session.jwks = self._mock_jwks()
auth_result = new_session.authenticate()
assert isinstance(auth_result, AuthenticateWithSessionCookieSuccessResponse)
assert auth_result.authenticated
assert auth_result.session_id == "session_01"
assert auth_result.user == {"id": "user_01", "email": "test@example.com"}
def test_session_refresh_maps_auth_error_to_refresh_denied(self):
"""AuthenticationError from request_raw maps to REFRESH_DENIED via except."""
sealed = seal_data(
{"refresh_token": "rt_old", "user": {"id": "user_01"}}, COOKIE_PASSWORD
)
session = Session(
client=self.workos, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
session._client.request_raw = MagicMock(
side_effect=AuthenticationError("unauthorized")
)
result = session.refresh()
assert isinstance(result, RefreshWithSessionCookieErrorResponse)
assert not result.authenticated
assert (
result.reason == AuthenticateWithSessionCookieFailureReason.REFRESH_DENIED
)
def test_session_refresh_missing_access_token_returns_refresh_denied(self):
"""A malformed 2xx response missing access_token returns REFRESH_DENIED."""
sealed = seal_data(
{"refresh_token": "rt_old", "user": {"id": "user_01"}}, COOKIE_PASSWORD
)
session = Session(
client=self.workos, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
session._client.request_raw = MagicMock(return_value={})
result = session.refresh()
assert isinstance(result, RefreshWithSessionCookieErrorResponse)
assert not result.authenticated
assert (
result.reason == AuthenticateWithSessionCookieFailureReason.REFRESH_DENIED
)
def test_session_refresh_missing_sid_returns_invalid_jwt(self):
"""A JWT without sid returns INVALID_JWT and preserves prior session."""
no_sid_token = _make_jwt(self.private_key, claims={"sid": ""})
original_sealed = seal_data(
{"refresh_token": "rt_old", "user": {"id": "user_01"}}, COOKIE_PASSWORD
)
session = Session(
client=self.workos,
session_data=original_sealed,
cookie_password=COOKIE_PASSWORD,
)
session.jwks = self._mock_jwks()
api_response = {
"access_token": no_sid_token,
"refresh_token": "rt_new",
"user": {"id": "user_01"},
}
session._client.request_raw = MagicMock(return_value=api_response)
result = session.refresh()
assert isinstance(result, RefreshWithSessionCookieErrorResponse)
assert result.reason == AuthenticateWithSessionCookieFailureReason.INVALID_JWT
assert session.session_data == original_sealed
def test_session_refresh_invalid_jwt_returns_invalid_jwt(self):
"""A JWT with bad signature maps to INVALID_JWT via the decode guard."""
_, other_public_key = _generate_rsa_key_pair()
wrong_key_private, _ = _generate_rsa_key_pair()
bad_token = _make_jwt(wrong_key_private)
sealed = seal_data(
{"refresh_token": "rt_old", "user": {"id": "user_01"}}, COOKIE_PASSWORD
)
original_sealed = sealed
session = Session(
client=self.workos, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
mock_jwks = MagicMock()
mock_signing_key = MagicMock()
mock_signing_key.key = other_public_key
mock_jwks.get_signing_key_from_jwt.return_value = mock_signing_key
session.jwks = mock_jwks
api_response = {
"access_token": bad_token,
"refresh_token": "rt_new",
"user": {"id": "user_01"},
}
session._client.request_raw = MagicMock(return_value=api_response)
result = session.refresh()
assert isinstance(result, RefreshWithSessionCookieErrorResponse)
assert result.reason == AuthenticateWithSessionCookieFailureReason.INVALID_JWT
assert session.session_data == original_sealed
def test_session_refresh_jwks_error_returns_invalid_jwt(self):
"""A JWKS lookup failure maps to INVALID_JWT, not a raw string."""
import jwt as pyjwt_lib
new_token = _make_jwt(self.private_key)
original_sealed = seal_data(
{"refresh_token": "rt_old", "user": {"id": "user_01"}}, COOKIE_PASSWORD
)
session = Session(
client=self.workos,
session_data=original_sealed,
cookie_password=COOKIE_PASSWORD,
)
mock_jwks = MagicMock()
mock_jwks.get_signing_key_from_jwt.side_effect = (
pyjwt_lib.exceptions.PyJWKClientError("Unable to find a signing key")
)
session.jwks = mock_jwks
api_response = {
"access_token": new_token,
"refresh_token": "rt_new",
"user": {"id": "user_01"},
}
session._client.request_raw = MagicMock(return_value=api_response)
result = session.refresh()
assert isinstance(result, RefreshWithSessionCookieErrorResponse)
assert result.reason == AuthenticateWithSessionCookieFailureReason.INVALID_JWT
assert session.session_data == original_sealed
class TestMapRefreshExceptionToReason:
@pytest.mark.parametrize(
"exc, expected",
[
(
MfaChallengeError("mfa challenge"),
AuthenticateWithSessionCookieFailureReason.MFA_CHALLENGE_REQUIRED,
),
(
MfaEnrollmentError("mfa enrollment"),
AuthenticateWithSessionCookieFailureReason.MFA_ENROLLMENT_REQUIRED,
),
(
SsoRequiredError("sso required"),
AuthenticateWithSessionCookieFailureReason.SSO_REQUIRED,
),
(
EmailVerificationRequiredError("email verification required"),
AuthenticateWithSessionCookieFailureReason.EMAIL_VERIFICATION_REQUIRED,
),
(
OrganizationSelectionRequiredError("org selection required"),
AuthenticateWithSessionCookieFailureReason.ORGANIZATION_SELECTION_REQUIRED,
),
(
OrganizationAuthMethodsRequiredError("org auth methods required"),
AuthenticateWithSessionCookieFailureReason.ORGANIZATION_AUTH_METHODS_REQUIRED,
),
(
AuthenticationMethodNotAllowedError("method not allowed"),
AuthenticateWithSessionCookieFailureReason.AUTHENTICATION_METHOD_NOT_ALLOWED,
),
(
RadarChallengeError("radar challenge"),
AuthenticateWithSessionCookieFailureReason.RADAR_CHALLENGE_REQUIRED,
),
(
AuthenticationError("unauthorized"),
AuthenticateWithSessionCookieFailureReason.REFRESH_DENIED,
),
(
WorkOSConnectionError("connection failed"),
AuthenticateWithSessionCookieFailureReason.REFRESH_NETWORK_ERROR,
),
(
WorkOSTimeoutError("timeout"),
AuthenticateWithSessionCookieFailureReason.REFRESH_NETWORK_ERROR,
),
],
)
def test_known_exceptions_map_to_reason(self, exc, expected):
assert _map_refresh_exception_to_reason(exc) == expected
def test_unknown_exception_falls_back_to_string(self):
result = _map_refresh_exception_to_reason(RuntimeError("boom"))
assert result == "boom"
@pytest.mark.asyncio
class TestAsyncSession:
def _mock_jwks(self, public_key):
mock_jwks = MagicMock()
mock_signing_key = MagicMock()
mock_signing_key.key = public_key
mock_jwks.get_signing_key_from_jwt.return_value = mock_signing_key
return mock_jwks
async def test_async_session_authenticate_no_data(self, async_workos):
session = AsyncSession(
client=async_workos, session_data="", cookie_password=COOKIE_PASSWORD
)
result = session.authenticate()
assert isinstance(result, AuthenticateWithSessionCookieErrorResponse)
async def test_async_session_authenticate_success(self, async_workos):
private_key, public_key = _generate_rsa_key_pair()
token = _make_jwt(private_key)
sealed = seal_data(
{"access_token": token, "refresh_token": "rt", "user": {"id": "u1"}},
COOKIE_PASSWORD,
)
session = AsyncSession(
client=async_workos, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
session.jwks = self._mock_jwks(public_key)
result = session.authenticate()
assert isinstance(result, AuthenticateWithSessionCookieSuccessResponse)
assert result.session_id == "session_01"
async def test_async_session_authenticate_rejects_mismatched_issuer(self):
private_key, public_key = _generate_rsa_key_pair()
token = _make_jwt(private_key, claims={"iss": "https://other.example.com"})
sealed = seal_data(
{"access_token": token, "refresh_token": "rt", "user": {"id": "u1"}},
COOKIE_PASSWORD,
)
client = AsyncWorkOSClient(
api_key="sk_test_123",
client_id="client_test_123",
jwt_issuer=["https://api.workos.com", "https://auth.example.com"],
)
try:
session = AsyncSession(
client=client, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
session.jwks = self._mock_jwks(public_key)
result = session.authenticate()
finally:
await client.close()
assert isinstance(result, AuthenticateWithSessionCookieErrorResponse)
assert result.reason == AuthenticateWithSessionCookieFailureReason.INVALID_JWT
async def _refresh_with_issuer(self, jwt_issuer, iss):
from unittest.mock import AsyncMock
private_key, public_key = _generate_rsa_key_pair()
new_token = _make_jwt(private_key, claims={"iss": iss})
sealed = seal_data(
{"refresh_token": "rt_old", "user": {"id": "user_01"}}, COOKIE_PASSWORD
)
client = AsyncWorkOSClient(
api_key="sk_test_123", client_id="client_test_123", jwt_issuer=jwt_issuer
)
try:
session = AsyncSession(
client=client, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
session.jwks = self._mock_jwks(public_key)
session._client.request_raw = AsyncMock(
return_value={
"access_token": new_token,
"refresh_token": "rt_new",
"user": {"id": "user_01"},
}
)
return await session.refresh()
finally:
await client.close()
async def test_async_session_refresh_accepts_configured_issuer(self):
result = await self._refresh_with_issuer(
["https://api.workos.com", "https://auth.example.com"],
"https://auth.example.com",
)
assert isinstance(result, RefreshWithSessionCookieSuccessResponse)
async def test_async_session_refresh_rejects_mismatched_issuer(self):
result = await self._refresh_with_issuer(
"https://api.workos.com", "https://other.example.com"
)
assert isinstance(result, RefreshWithSessionCookieErrorResponse)
assert result.reason == AuthenticateWithSessionCookieFailureReason.INVALID_JWT
async def test_async_session_refresh_success(self, async_workos):
from unittest.mock import AsyncMock
private_key, public_key = _generate_rsa_key_pair()
new_token = _make_jwt(private_key)
sealed = seal_data(
{"refresh_token": "rt_old", "user": {"id": "user_01"}}, COOKIE_PASSWORD
)
session = AsyncSession(
client=async_workos, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
session.jwks = self._mock_jwks(public_key)
api_response = {
"access_token": new_token,
"refresh_token": "rt_new",
"user": {"id": "user_01", "email": "test@example.com"},
"authentication_method": "Password",
}
session._client.request_raw = AsyncMock(return_value=api_response)
result = await session.refresh()
assert isinstance(result, RefreshWithSessionCookieSuccessResponse)
assert result.authenticated
assert result.session_id == "session_01"
unsealed = unseal_data(result.sealed_session, COOKIE_PASSWORD)
assert unsealed["access_token"] == new_token
assert unsealed["refresh_token"] == "rt_new"
async def test_async_session_refresh_maps_auth_error_to_refresh_denied(
self, async_workos
):
from unittest.mock import AsyncMock
sealed = seal_data(
{"refresh_token": "rt_old", "user": {"id": "user_01"}}, COOKIE_PASSWORD
)
session = AsyncSession(
client=async_workos, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
session._client.request_raw = AsyncMock(
side_effect=AuthenticationError("unauthorized")
)
result = await session.refresh()
assert isinstance(result, RefreshWithSessionCookieErrorResponse)
assert not result.authenticated
assert (
result.reason == AuthenticateWithSessionCookieFailureReason.REFRESH_DENIED
)
async def test_async_session_refresh_missing_access_token_returns_refresh_denied(
self, async_workos
):
from unittest.mock import AsyncMock
sealed = seal_data(
{"refresh_token": "rt_old", "user": {"id": "user_01"}}, COOKIE_PASSWORD
)
session = AsyncSession(
client=async_workos, session_data=sealed, cookie_password=COOKIE_PASSWORD
)
session._client.request_raw = AsyncMock(return_value={})
result = await session.refresh()
assert isinstance(result, RefreshWithSessionCookieErrorResponse)
assert not result.authenticated
assert (
result.reason == AuthenticateWithSessionCookieFailureReason.REFRESH_DENIED
)
async def test_async_session_refresh_missing_sid_returns_invalid_jwt(
self, async_workos
):
from unittest.mock import AsyncMock
private_key, public_key = _generate_rsa_key_pair()
no_sid_token = _make_jwt(private_key, claims={"sid": ""})
original_sealed = seal_data(
{"refresh_token": "rt_old", "user": {"id": "user_01"}}, COOKIE_PASSWORD
)
session = AsyncSession(
client=async_workos,
session_data=original_sealed,
cookie_password=COOKIE_PASSWORD,
)
session.jwks = self._mock_jwks(public_key)
api_response = {
"access_token": no_sid_token,
"refresh_token": "rt_new",
"user": {"id": "user_01"},
}
session._client.request_raw = AsyncMock(return_value=api_response)
result = await session.refresh()
assert isinstance(result, RefreshWithSessionCookieErrorResponse)
assert result.reason == AuthenticateWithSessionCookieFailureReason.INVALID_JWT
assert session.session_data == original_sealed
async def test_async_session_refresh_invalid_jwt_returns_invalid_jwt(
self, async_workos
):
from unittest.mock import AsyncMock
sign_private, _ = _generate_rsa_key_pair()
_, verify_public = _generate_rsa_key_pair()
bad_token = _make_jwt(sign_private)
original_sealed = seal_data(
{"refresh_token": "rt_old", "user": {"id": "user_01"}}, COOKIE_PASSWORD
)
session = AsyncSession(
client=async_workos,
session_data=original_sealed,
cookie_password=COOKIE_PASSWORD,
)
session.jwks = self._mock_jwks(verify_public)
api_response = {
"access_token": bad_token,
"refresh_token": "rt_new",
"user": {"id": "user_01"},
}
session._client.request_raw = AsyncMock(return_value=api_response)
result = await session.refresh()
assert isinstance(result, RefreshWithSessionCookieErrorResponse)
assert result.reason == AuthenticateWithSessionCookieFailureReason.INVALID_JWT
assert session.session_data == original_sealed
async def test_async_session_refresh_jwks_error_returns_invalid_jwt(
self, async_workos
):
import jwt as pyjwt_lib
from unittest.mock import AsyncMock
private_key, _ = _generate_rsa_key_pair()
new_token = _make_jwt(private_key)
original_sealed = seal_data(
{"refresh_token": "rt_old", "user": {"id": "user_01"}}, COOKIE_PASSWORD
)
session = AsyncSession(
client=async_workos,
session_data=original_sealed,
cookie_password=COOKIE_PASSWORD,
)
mock_jwks = MagicMock()
mock_jwks.get_signing_key_from_jwt.side_effect = (
pyjwt_lib.exceptions.PyJWKClientError("Unable to find a signing key")
)
session.jwks = mock_jwks
api_response = {
"access_token": new_token,
"refresh_token": "rt_new",
"user": {"id": "user_01"},
}
session._client.request_raw = AsyncMock(return_value=api_response)
result = await session.refresh()
assert isinstance(result, RefreshWithSessionCookieErrorResponse)
assert result.reason == AuthenticateWithSessionCookieFailureReason.INVALID_JWT
assert session.session_data == original_sealed