-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_authforge.py
More file actions
1128 lines (988 loc) · 47.7 KB
/
Copy pathtest_authforge.py
File metadata and controls
1128 lines (988 loc) · 47.7 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
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
"""Unit tests for the AuthForge Python SDK."""
from __future__ import annotations
import base64
import io
import json
import re
import socket
import tempfile
import threading
import time
import unittest
import urllib.error
import warnings
from datetime import datetime
from pathlib import Path
from unittest.mock import MagicMock, patch
import pytest
import authforge
from authforge import AuthForgeClient, format_activation_request, parse_license_file, verify_license_file
def _load_test_vectors() -> dict:
path = Path(__file__).resolve().parent / "test_vectors.json"
with path.open(encoding="utf-8") as f:
return json.load(f)
class Ed25519VectorTests(unittest.TestCase):
@classmethod
def setUpClass(cls) -> None:
cls.vectors = _load_test_vectors()
cls.public_key = cls.vectors["publicKey"]
def _make_client(self) -> AuthForgeClient:
return AuthForgeClient(
"test-app-id",
"test-app-secret",
self.public_key,
heartbeat_interval=86400,
)
def test_valid_vectors_verify(self) -> None:
client = self._make_client()
for case in self.vectors["cases"]:
if not case["shouldVerify"]:
continue
with self.subTest(case=case["id"]):
client._verify_signature(case["payload"], case["signature"])
def test_invalid_vectors_fail(self) -> None:
client = self._make_client()
for case in self.vectors["cases"]:
if case["shouldVerify"]:
continue
with self.subTest(case=case["id"]):
with self.assertRaises(ValueError) as ctx:
client._verify_signature(case["payload"], case["signature"])
self.assertEqual(ctx.exception.args[0], "signature_mismatch")
class MultiKeyRotationTests(unittest.TestCase):
"""The SDK must verify against any public key in the configured trust
list, so a deployment can rotate the server-side key while clients are
still pinned to the old one."""
DECOY_KEY = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA="
def test_list_form_accepts_real_key(self) -> None:
vectors = _load_test_vectors()
case = next(c for c in vectors["cases"] if c["id"] == "validate_success")
client = AuthForgeClient(
"app",
"secret",
[self.DECOY_KEY, vectors["publicKey"]],
heartbeat_interval=86400,
)
# Bogus key is first; verification must walk to the second entry.
client._verify_signature(case["payload"], case["signature"])
self.assertEqual(client.public_keys[0], self.DECOY_KEY)
self.assertEqual(client.public_keys[1], vectors["publicKey"])
def test_comma_separated_form_accepts_real_key(self) -> None:
vectors = _load_test_vectors()
case = next(c for c in vectors["cases"] if c["id"] == "validate_success")
combined = f"{self.DECOY_KEY},{vectors['publicKey']}"
client = AuthForgeClient(
"app", "secret", combined, heartbeat_interval=86400
)
client._verify_signature(case["payload"], case["signature"])
def test_all_unknown_keys_still_fails(self) -> None:
vectors = _load_test_vectors()
case = next(c for c in vectors["cases"] if c["id"] == "validate_success")
client = AuthForgeClient(
"app",
"secret",
[self.DECOY_KEY],
heartbeat_interval=86400,
)
with self.assertRaises(ValueError) as ctx:
client._verify_signature(case["payload"], case["signature"])
self.assertEqual(ctx.exception.args[0], "signature_mismatch")
class ConstructorPolicyTests(unittest.TestCase):
"""Grace period is the default; online check-ins are opt-in; the legacy
heartbeat_mode argument still works behind a DeprecationWarning."""
PUBLIC_KEY = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA="
def test_default_is_grace_period(self) -> None:
with warnings.catch_warnings(record=True) as caught:
warnings.simplefilter("always")
client = AuthForgeClient("app", "secret", self.PUBLIC_KEY)
self.assertFalse(client.online_heartbeat)
self.assertEqual(client.heartbeat_mode, "LOCAL")
deprecations = [
w for w in caught if issubclass(w.category, DeprecationWarning)
]
self.assertEqual(deprecations, [])
def test_legacy_server_mode_maps_to_online_heartbeat(self) -> None:
with pytest.warns(DeprecationWarning):
client = AuthForgeClient(
"app", "secret", self.PUBLIC_KEY, heartbeat_mode="SERVER"
)
self.assertTrue(client.online_heartbeat)
self.assertEqual(client.heartbeat_mode, "SERVER")
def test_legacy_local_mode_maps_to_grace_period(self) -> None:
with pytest.warns(DeprecationWarning):
client = AuthForgeClient(
"app", "secret", self.PUBLIC_KEY, heartbeat_mode="LOCAL"
)
self.assertFalse(client.online_heartbeat)
self.assertEqual(client.heartbeat_mode, "LOCAL")
def test_online_heartbeat_flag_without_legacy_mode(self) -> None:
with warnings.catch_warnings(record=True) as caught:
warnings.simplefilter("always")
client = AuthForgeClient(
"app", "secret", self.PUBLIC_KEY, online_heartbeat=True
)
self.assertTrue(client.online_heartbeat)
self.assertEqual(client.heartbeat_mode, "SERVER")
deprecations = [
w for w in caught if issubclass(w.category, DeprecationWarning)
]
self.assertEqual(deprecations, [])
def test_invalid_legacy_mode_still_raises(self) -> None:
with pytest.raises(ValueError, match="heartbeat_mode must be LOCAL or SERVER"):
AuthForgeClient(
"app", "secret", self.PUBLIC_KEY, heartbeat_mode="SOMETIMES"
)
class ValidateLicenseTests(unittest.TestCase):
def test_validate_license_success_no_heartbeat(self) -> None:
vectors = _load_test_vectors()
success_case = next(
case for case in vectors["cases"] if case["id"] == "validate_success"
)
nonce = "nonce-validate-001"
mock_resp = MagicMock()
mock_resp.status = 200
mock_resp.read.return_value = json.dumps(
{
"status": "ok",
"payload": success_case["payload"],
"signature": success_case["signature"],
"keyId": "signing-key-1",
},
separators=(",", ":"),
).encode("utf-8")
urlopen_cm = MagicMock()
urlopen_cm.__enter__.return_value = mock_resp
urlopen_cm.__exit__.return_value = None
with (
patch("authforge.urllib.request.urlopen", return_value=urlopen_cm),
patch.object(AuthForgeClient, "_generate_nonce", return_value=nonce),
):
client = AuthForgeClient(
"app-id",
"app-secret",
vectors["publicKey"],
heartbeat_interval=86400,
)
result = client.validate_license("license-key")
self.assertTrue(result["valid"])
self.assertFalse(client._heartbeat_started)
self.assertFalse(client.is_authenticated())
self.assertEqual(result["session_token"], "session.validate.token")
self.assertEqual(result["app_variables"], {"tier": "pro"})
def test_validate_license_failure_no_heartbeat(self) -> None:
vectors = _load_test_vectors()
mock_resp = MagicMock()
mock_resp.status = 200
mock_resp.read.return_value = json.dumps(
{"status": "invalid_key", "error": "invalid_key"},
separators=(",", ":"),
).encode("utf-8")
urlopen_cm = MagicMock()
urlopen_cm.__enter__.return_value = mock_resp
urlopen_cm.__exit__.return_value = None
with patch("authforge.urllib.request.urlopen", return_value=urlopen_cm):
client = AuthForgeClient(
"app-id",
"app-secret",
vectors["publicKey"],
heartbeat_interval=86400,
)
result = client.validate_license("bad")
self.assertFalse(result["valid"])
self.assertEqual(result["code"], "invalid_key")
self.assertFalse(client._heartbeat_started)
class LoginFlowTests(unittest.TestCase):
def test_login_parses_and_stores_signed_payload(self) -> None:
vectors = _load_test_vectors()
success_case = next(case for case in vectors["cases"] if case["id"] == "validate_success")
payload = json.loads(base64.b64decode(success_case["payload"]).decode("utf-8"))
nonce = "nonce-validate-001"
mock_resp = MagicMock()
mock_resp.status = 200
mock_resp.read.return_value = json.dumps(
{
"status": "ok",
"payload": success_case["payload"],
"signature": success_case["signature"],
"keyId": "signing-key-1",
},
separators=(",", ":"),
).encode("utf-8")
urlopen_cm = MagicMock()
urlopen_cm.__enter__.return_value = mock_resp
urlopen_cm.__exit__.return_value = None
with (
patch("authforge.urllib.request.urlopen", return_value=urlopen_cm),
patch.object(AuthForgeClient, "_generate_nonce", return_value=nonce),
):
client = AuthForgeClient(
"app-id",
"app-secret",
vectors["publicKey"],
heartbeat_interval=86400,
)
self.assertTrue(client.login("license-key"))
self.assertTrue(client.is_authenticated())
self.assertEqual(client._key_id, "signing-key-1")
self.assertEqual(client._last_nonce, nonce)
self.assertIsNotNone(client.get_session_data())
self.assertEqual(client.get_app_variables(), {"tier": "pro"})
self.assertEqual(client.get_license_variables(), {"region": "us-east-1"})
self.assertEqual(payload["nonce"], nonce)
# Grace period check: re-verifies the stored signed session locally
# and must not touch the network before the session TTL expires.
with patch(
"authforge.urllib.request.urlopen",
side_effect=AssertionError("grace period check must not use the network"),
):
client._grace_period_check()
def _urlopen_ok(body: dict) -> MagicMock:
resp = MagicMock()
resp.status = 200
resp.read.return_value = json.dumps(body).encode("utf-8")
cm = MagicMock()
cm.__enter__.return_value = resp
cm.__exit__.return_value = None
return cm
def _http_error(status: int, raw: bytes) -> urllib.error.HTTPError:
return urllib.error.HTTPError("https://auth.test/auth/heartbeat", status, "err", {}, io.BytesIO(raw))
def _failed_response(status: int, code: str):
"""urlopen side effect: every call fails with a fresh HTTPError."""
return _http_error_response(status, json.dumps({"status": "failed", "error": code}).encode("utf-8"))
def _http_error_response(status: int, raw: bytes):
def side_effect(*_args, **_kwargs):
raise _http_error(status, raw)
return side_effect
def _ok_response(raw: bytes):
"""urlopen side effect: every call returns HTTP 200 with ``raw``."""
def side_effect(*_args, **_kwargs):
resp = MagicMock()
resp.status = 200
resp.read.return_value = raw
cm = MagicMock()
cm.__enter__.return_value = resp
cm.__exit__.return_value = None
return cm
return side_effect
def _run_in_thread(target) -> None:
"""Run ``target`` on a worker thread; fail instead of hanging on a deadlock."""
errors: list = []
def run() -> None:
try:
target()
except BaseException as exc:
errors.append(exc)
worker = threading.Thread(target=run, daemon=True)
worker.start()
worker.join(5)
if worker.is_alive():
raise AssertionError("heartbeat tick deadlocked")
if errors:
raise errors[0]
class HeartbeatFailureTests(unittest.TestCase):
"""Every /auth/heartbeat failure reaches on_failure with its code and
classification; definitive failures drop the stored session."""
DEFINITIVE = [
("revoked", 410),
("expired", 410),
("hwid_mismatch", 403),
("blocked", 403),
("app_disabled", 403),
("session_expired", 401),
("invalid_app", 401),
("malformed_request", 400),
]
TRANSIENT = [
("rate_limited", 429),
("system_error", 500),
("server_error", 500),
("no_credits", 429),
("demo_quota_exceeded", 429),
("app_burn_cap_reached", 429),
("bad_request", 400),
("invalid_key", 401),
("some_future_code", 400),
]
NOT_RETRIED_429 = ("no_credits", "demo_quota_exceeded", "app_burn_cap_reached")
def setUp(self) -> None:
self.vectors = _load_test_vectors()
sleep_patch = patch("authforge.time.sleep")
self.sleep = sleep_patch.start()
self.addCleanup(sleep_patch.stop)
self._fresh_client()
def _fresh_client(self) -> None:
self.sleep.reset_mock()
self.failures: list = []
self.client = AuthForgeClient(
"app-id",
"app-secret",
self.vectors["publicKey"],
heartbeat_interval=86400,
online_heartbeat=True,
on_failure=lambda reason, exc: self.failures.append((reason, exc)),
)
validate = next(c for c in self.vectors["cases"] if c["id"] == "validate_success")
c = self.client
c._license_key = "license-key"
c._session_token = "session.validate.token"
c._session_kind = "online"
c._session_expires_in = int(time.time()) + 3600
c._raw_payload_b64 = validate["payload"]
c._signature = validate["signature"]
c._session_data = {"tier": "pro"}
c._authenticated = True
def _tick(self, urlopen_side_effect) -> bool:
with patch("authforge.urllib.request.urlopen", side_effect=urlopen_side_effect) as urlopen:
keep_running = self.client._heartbeat_tick()
self.urlopen_calls = urlopen.call_count
return keep_running
def _only_failure(self) -> authforge.AuthForgeError:
self.assertEqual(len(self.failures), 1, self.failures)
reason, exc = self.failures[0]
self.assertEqual(reason, "heartbeat_failed")
self.assertIsInstance(exc, authforge.AuthForgeError)
self.assertIsInstance(exc, ValueError)
return exc
def _assert_invalidated(self) -> None:
self.assertFalse(self.client.is_authenticated())
self.assertIsNone(self.client.get_session_kind())
self.assertIsNone(self.client.get_session_data())
self.assertIsNone(self.client._raw_payload_b64)
self.assertFalse(self.client._heartbeat_started)
self.assertTrue(self.client._heartbeat_stop.is_set())
with self.assertRaises(RuntimeError):
self.client._grace_period_check()
def _assert_session_kept(self) -> None:
self.assertTrue(self.client.is_authenticated())
self.assertEqual(self.client._session_token, "session.validate.token")
self.assertFalse(self.client._heartbeat_stop.is_set())
def _assert_definitive(self, code: str) -> None:
exc = self._only_failure()
self.assertEqual(exc.code, code)
self.assertEqual(str(exc), code)
self.assertTrue(exc.fatal)
self.assertFalse(exc.transient)
self.assertFalse(authforge.is_transient_error(exc))
self.assertEqual(self.urlopen_calls, 1, "definitive codes are not retried")
self.sleep.assert_not_called()
self._assert_invalidated()
def _assert_transient(self, code: str) -> authforge.AuthForgeError:
exc = self._only_failure()
self.assertEqual(exc.code, code)
self.assertTrue(exc.transient)
self.assertFalse(exc.fatal)
self._assert_session_kept()
return exc
def test_definitive_codes_from_non_2xx_invalidate_session(self) -> None:
for code, status in self.DEFINITIVE:
with self.subTest(code=code, status=status):
self._fresh_client()
self.assertFalse(self._tick(_failed_response(status, code)))
self._assert_definitive(code)
def test_definitive_codes_in_200_body_invalidate_session(self) -> None:
for code, _status in self.DEFINITIVE:
with self.subTest(code=code):
self._fresh_client()
body = json.dumps({"status": "failed", "error": code}).encode("utf-8")
self.assertFalse(self._tick(_ok_response(body)))
self._assert_definitive(code)
def test_verdict_status_and_code_are_normalized(self) -> None:
body = json.dumps({"status": " FAILED ", "error": " Revoked "}).encode("utf-8")
self.assertFalse(self._tick(_ok_response(body)))
self._assert_definitive("revoked")
def test_tampered_signature_is_definitive(self) -> None:
heartbeat = next(c for c in self.vectors["cases"] if c["id"] == "heartbeat_success")
forged = json.loads(base64.b64decode(heartbeat["payload"]))
forged["sessionToken"] = "session.forged.token"
wrong_key = next(c for c in self.vectors["cases"] if c["id"] == "wrong_app_key")
cases = [
("tampered", base64.b64encode(json.dumps(forged).encode("utf-8")).decode("ascii"),
heartbeat["signature"], "nonce-heartbeat-001"),
("wrong_app_key", wrong_key["payload"], wrong_key["signature"], "nonce-validate-001"),
]
for label, payload, signature, nonce in cases:
with self.subTest(case=label):
self._fresh_client()
body = json.dumps({"status": "ok", "payload": payload, "signature": signature}).encode("utf-8")
with patch.object(AuthForgeClient, "_generate_nonce", return_value=nonce):
self.assertFalse(self._tick(_ok_response(body)))
self._assert_definitive("signature_mismatch")
def test_transient_codes_keep_session_and_loop(self) -> None:
for code, status in self.TRANSIENT:
for label, side_effect in (
("non-2xx", _failed_response(status, code)),
("200 body", _ok_response(json.dumps({"status": "failed", "error": code}).encode("utf-8"))),
):
with self.subTest(code=code, response=label):
self._fresh_client()
self.assertTrue(self._tick(side_effect))
exc = self._assert_transient(code)
self.assertEqual(str(exc), code)
def test_rate_limited_is_retried_before_reporting(self) -> None:
self.assertTrue(self._tick(_failed_response(429, "rate_limited")))
self.assertEqual(self.urlopen_calls, 3)
self.assertEqual([c.args[0] for c in self.sleep.call_args_list], [2, 5])
self._assert_transient("rate_limited")
def test_bare_429_is_retried_as_rate_limit(self) -> None:
self.assertTrue(self._tick(_http_error_response(429, b'{"status":"failed"}')))
self.assertEqual(self.urlopen_calls, 3)
self.assertEqual([c.args[0] for c in self.sleep.call_args_list], [2, 5])
self._assert_transient("unexpected_response")
def test_credit_429s_are_not_retried(self) -> None:
for code in self.NOT_RETRIED_429:
with self.subTest(code=code):
self._fresh_client()
self.assertTrue(self._tick(_failed_response(429, code)))
self.assertEqual(self.urlopen_calls, 1)
self.sleep.assert_not_called()
self._assert_transient(code)
def test_non_json_error_responses_are_transient(self) -> None:
for status in (403, 500, 502):
with self.subTest(status=status):
self._fresh_client()
self.assertTrue(self._tick(_http_error_response(status, b"<html>error</html>")))
self.assertEqual(self.urlopen_calls, 1)
self._assert_transient(f"http_error_{status}")
def test_unparseable_200_bodies_are_transient(self) -> None:
cases = [
(b"", "invalid_json_response"),
(b"<html>ok</html>", "invalid_json_response"),
(b'["failed","revoked"]', "response_not_json_object"),
(b'"revoked"', "response_not_json_object"),
]
for raw, code in cases:
with self.subTest(raw=raw):
self._fresh_client()
self.assertTrue(self._tick(_ok_response(raw)))
self._assert_transient(code)
def test_malformed_failure_bodies_are_unexpected_response(self) -> None:
bodies = [
{"error": "revoked"},
{"status": "revoked"},
{"status": "failed"},
{"status": "failed", "error": ""},
{"status": "failed", "error": 7},
{"status": "denied", "error": "revoked"},
]
for body in bodies:
for label, side_effect in (
("200", _ok_response(json.dumps(body).encode("utf-8"))),
("403", _http_error_response(403, json.dumps(body).encode("utf-8"))),
):
with self.subTest(body=body, response=label):
self._fresh_client()
self.assertTrue(self._tick(side_effect))
exc = self._assert_transient("unexpected_response")
self.assertIn(f"status={body.get('status')!r}", str(exc))
self.assertIn(f"error={body.get('error')!r}", str(exc))
def test_network_error_is_transient_and_reported_once(self) -> None:
self.assertTrue(self._tick(urllib.error.URLError("connection refused")))
self.assertEqual(self.urlopen_calls, 2)
exc = self._assert_transient("network_error")
self.assertTrue(str(exc).startswith("url_error: "))
def test_timeout_is_transient_and_reported_once(self) -> None:
self.assertTrue(self._tick(socket.timeout("timed out")))
self.assertEqual(self.urlopen_calls, 2)
self._assert_transient("timeout")
def test_transient_failure_after_session_ttl_becomes_fatal(self) -> None:
for cause, side_effect in (
("network_error", urllib.error.URLError("offline")),
("no_credits", _failed_response(429, "no_credits")),
("unexpected_response", _ok_response(b'{"status":"revoked"}')),
):
with self.subTest(cause=cause):
self._fresh_client()
self.client._session_expires_in = int(time.time()) - 1
self.assertFalse(self._tick(side_effect))
exc = self._only_failure()
self.assertEqual(exc.code, "session_expired")
self.assertTrue(exc.fatal)
self.assertEqual(exc.__cause__.code, cause)
self._assert_invalidated()
def test_success_after_transient_failure_refreshes_session(self) -> None:
heartbeat = next(c for c in self.vectors["cases"] if c["id"] == "heartbeat_success")
with patch.object(AuthForgeClient, "_generate_nonce", return_value="nonce-heartbeat-001"):
self.assertTrue(self._tick(urllib.error.URLError("offline")))
self.assertTrue(
self._tick(
[_urlopen_ok({"status": "ok", "payload": heartbeat["payload"], "signature": heartbeat["signature"]})]
)
)
self.assertEqual(len(self.failures), 1)
self.assertTrue(self.client.is_authenticated())
self.assertEqual(self.client._session_token, "session.heartbeat.token")
def test_session_is_dropped_before_on_failure_runs(self) -> None:
seen = MagicMock()
self.client.on_failure = lambda reason, exc: seen(self.client.is_authenticated())
self._tick(_failed_response(410, "revoked"))
seen.assert_called_once_with(False)
def test_grace_period_expiry_invalidates_session(self) -> None:
self.client.online_heartbeat = False
self.client._session_expires_in = int(time.time()) - 1
self.assertFalse(self._tick(AssertionError("grace period must not use the network")))
exc = self._only_failure()
self.assertEqual(exc.code, "session_expired")
self.assertTrue(exc.fatal)
self._assert_invalidated()
def test_without_on_failure_transient_failure_warns_and_keeps_checking_in(self) -> None:
for code, side_effect in (
("network_error", urllib.error.URLError("offline")),
("system_error", _failed_response(500, "system_error")),
):
with self.subTest(code=code):
self._fresh_client()
self.client.on_failure = None
stderr = io.StringIO()
with patch("authforge.os._exit") as exit_mock, patch("authforge.sys.stderr", stderr):
self.assertTrue(self._tick(side_effect))
exit_mock.assert_not_called()
self.assertEqual(
stderr.getvalue(),
f"AuthForge: background check failed ({code}); retrying next interval\n",
)
self._assert_session_kept()
def test_without_on_failure_transient_warning_tolerates_missing_stderr(self) -> None:
self.client.on_failure = None
with patch("authforge.os._exit") as exit_mock, patch("authforge.sys.stderr", None):
self.assertTrue(self._tick(urllib.error.URLError("offline")))
exit_mock.assert_not_called()
self._assert_session_kept()
def test_without_on_failure_definitive_failure_exits(self) -> None:
for label, expires_in, side_effect in (
("revoked", None, _failed_response(410, "revoked")),
("ttl-promoted session_expired", int(time.time()) - 1, urllib.error.URLError("offline")),
):
with self.subTest(case=label):
self._fresh_client()
self.client.on_failure = None
if expires_in is not None:
self.client._session_expires_in = expires_in
stderr = io.StringIO()
with patch("authforge.os._exit") as exit_mock, patch("authforge.sys.stderr", stderr):
self.assertFalse(self._tick(side_effect))
exit_mock.assert_called_once_with(1)
self.assertEqual(stderr.getvalue(), "")
self._assert_invalidated()
def test_without_on_failure_login_failure_exits(self) -> None:
self.client.on_failure = None
with patch("authforge.os._exit") as exit_mock:
with patch("authforge.urllib.request.urlopen", side_effect=_failed_response(401, "invalid_key")):
self.assertFalse(self.client.login("license-key"))
exit_mock.assert_called_once_with(1)
def test_is_transient_error_classification(self) -> None:
definitive = {
"revoked",
"expired",
"hwid_mismatch",
"blocked",
"session_expired",
"malformed_request",
"app_disabled",
"invalid_app",
"signature_mismatch",
}
self.assertEqual(authforge.DEFINITIVE_ERROR_CODES, definitive)
self.assertEqual(authforge.TRANSIENT_ERROR_CODES & definitive, frozenset())
for code in definitive:
self.assertFalse(authforge.is_transient_error(code), code)
self.assertTrue(authforge.AuthForgeError(code).fatal, code)
for code in (
*authforge.TRANSIENT_ERROR_CODES,
"server_error",
"http_error_400",
"http_error_403",
"http_error_404",
"http_error_429",
"http_error_503",
"some_future_code",
"",
None,
):
self.assertTrue(authforge.is_transient_error(code), code)
self.assertFalse(authforge.is_transient_error(authforge.AuthForgeError("revoked")))
self.assertTrue(authforge.is_transient_error(authforge.AuthForgeError("no_credits")))
self.assertTrue(authforge.is_transient_error(RuntimeError("revoked")))
def test_on_failure_can_logout_and_query_state_without_deadlock(self) -> None:
for label, side_effect, fatal in (
("transient", _failed_response(500, "system_error"), False),
("fatal", _failed_response(410, "revoked"), True),
):
with self.subTest(failure=label):
self._fresh_client()
seen: list = []
def on_failure(reason, exc):
seen.append(("before", self.client.is_authenticated()))
self.client.logout()
seen.append(("after", self.client.is_authenticated()))
self.client.on_failure = on_failure
_run_in_thread(lambda: self._tick(side_effect))
self.assertEqual(seen, [("before", not fatal), ("after", False)])
self._assert_invalidated()
def test_logout_during_in_flight_heartbeat_stays_logged_out(self) -> None:
heartbeat = next(c for c in self.vectors["cases"] if c["id"] == "heartbeat_success")
success = _ok_response(
json.dumps(
{"status": "ok", "payload": heartbeat["payload"], "signature": heartbeat["signature"]}
).encode("utf-8")
)
for label, response in (("success", success), ("revoked", _failed_response(410, "revoked"))):
with self.subTest(response=label):
self._fresh_client()
entered = threading.Event()
release = threading.Event()
def blocking_urlopen(*args, **kwargs):
entered.set()
if not release.wait(5):
raise AssertionError("heartbeat was never released")
return response(*args, **kwargs)
results: list = []
def tick() -> None:
with patch.object(AuthForgeClient, "_generate_nonce", return_value="nonce-heartbeat-001"):
results.append(self._tick(blocking_urlopen))
worker = threading.Thread(target=tick, daemon=True)
worker.start()
self.assertTrue(entered.wait(5))
self.client.logout()
release.set()
worker.join(5)
self.assertFalse(worker.is_alive())
self.assertEqual(len(results), 1)
self.assertFalse(self.client.is_authenticated())
self.assertIsNone(self.client._session_token)
self.assertIsNone(self.client.get_session_kind())
self.assertEqual(self.failures, [], "a stale tick must not report")
def test_late_heartbeat_does_not_overwrite_a_new_login(self) -> None:
heartbeat = next(c for c in self.vectors["cases"] if c["id"] == "heartbeat_success")
validate = next(c for c in self.vectors["cases"] if c["id"] == "validate_success")
entered = threading.Event()
release = threading.Event()
success = _ok_response(
json.dumps(
{"status": "ok", "payload": heartbeat["payload"], "signature": heartbeat["signature"]}
).encode("utf-8")
)
def blocking_urlopen(*args, **kwargs):
entered.set()
release.wait(5)
return success(*args, **kwargs)
def tick() -> None:
with patch.object(AuthForgeClient, "_generate_nonce", return_value="nonce-heartbeat-001"):
self._tick(blocking_urlopen)
worker = threading.Thread(target=tick, daemon=True)
worker.start()
self.assertTrue(entered.wait(5))
self.client._apply_signed_response(
{"status": "ok", "payload": validate["payload"], "signature": validate["signature"]},
expected_nonce="nonce-validate-001",
license_key="new-license-key",
context="validate",
)
release.set()
worker.join(5)
self.assertFalse(worker.is_alive())
self.assertEqual(self.client._license_key, "new-license-key")
self.assertEqual(self.client._session_token, "session.validate.token")
def test_loop_keeps_checking_in_after_transient_failures(self) -> None:
self.client.heartbeat_interval = 0
def on_failure(reason, exc):
self.failures.append((reason, exc))
if len(self.failures) == 3:
self.client.logout()
self.client.on_failure = on_failure
with patch("authforge.urllib.request.urlopen", side_effect=_failed_response(503, "system_error")):
self.client._start_heartbeat_once()
thread = self.client._heartbeat_thread
assert thread is not None
thread.join(5)
self.assertFalse(thread.is_alive())
self.assertEqual([exc.code for _reason, exc in self.failures], ["system_error"] * 3)
self.assertFalse(self.client.is_authenticated())
def test_loop_stops_after_definitive_failure(self) -> None:
self.client.heartbeat_interval = 0
with patch("authforge.urllib.request.urlopen", side_effect=_failed_response(410, "revoked")) as urlopen:
self.client._start_heartbeat_once()
thread = self.client._heartbeat_thread
assert thread is not None
thread.join(5)
self.assertFalse(thread.is_alive())
self.assertEqual(urlopen.call_count, 1)
self.assertEqual([exc.code for _reason, exc in self.failures], ["revoked"])
self._assert_invalidated()
# ---------------------------------------------------------------------------
# Offline license files (`.authforge`)
# ---------------------------------------------------------------------------
def _load_offline_vectors() -> dict:
path = Path(__file__).resolve().parent / "offline_license_vectors.json"
with path.open(encoding="utf-8") as f:
return json.load(f)
def _iso(value: str) -> datetime:
return datetime.fromisoformat(value.replace("Z", "+00:00"))
class OfflineLicenseFileTests(unittest.TestCase):
@classmethod
def setUpClass(cls) -> None:
cls.vectors = _load_offline_vectors()
cls.by_name = {c["name"]: c for c in cls.vectors["cases"]}
cls.good = cls.by_name["good_bound"]
# Client-level tests run against the wall clock: use the lifetime vector
# (expiresAt null) so they never turn into "expired" in 2027.
cls.lifetime = cls.by_name["good_lifetime"]
def _make_client(self, **overrides) -> tuple[AuthForgeClient, list]:
failures: list = []
kwargs = dict(
app_id=self.good["appId"],
app_secret=None,
public_key=self.good["publicKey"],
hwid_override=self.good["hwid"],
on_failure=lambda reason, exc: failures.append((reason, str(exc) if exc else None)),
)
kwargs.update(overrides)
return AuthForgeClient(**kwargs), failures
def test_every_vector_case_matches(self) -> None:
self.assertGreaterEqual(len(self.vectors["cases"]), 15)
for case in self.vectors["cases"]:
with self.subTest(case=case["name"]):
result = verify_license_file(
case["file"],
case["appId"],
case["publicKey"],
case["hwid"],
now=_iso(case["now"]),
)
got = "ok" if result["ok"] else result["error"]
self.assertEqual(got, case["expect"])
if result["ok"] and "payload" in case:
self.assertEqual(result["license"]["payload"], case["payload"])
self.assertEqual(result["payload_base64"], case["payloadBase64"])
self.assertEqual(result["signature_base64"], case["signatureBase64"])
def test_parse_recovers_canonical_signed_string(self) -> None:
parsed = parse_license_file(self.good["file"])
assert parsed is not None
self.assertEqual(parsed["payload_base64"], self.good["payloadBase64"])
self.assertEqual(parsed["signature_base64"], self.good["signatureBase64"])
self.assertEqual(parsed["headers"]["Version"], "1")
self.assertEqual(parsed["headers"]["App-Id"], self.good["appId"])
self.assertIsNone(parse_license_file("nope"))
def test_good_file_exposes_entitlements(self) -> None:
result = verify_license_file(
self.good["file"], self.good["appId"], self.good["publicKey"], self.good["hwid"],
now=_iso(self.good["now"]),
)
assert result["ok"]
lic = result["license"]
self.assertEqual(lic["license_key"], "TEST-KEY0-0000-0000")
self.assertEqual(lic["key_id"], "kid-test-0001")
self.assertEqual(lic["hwid_policy"], {"mode": "bound", "hwids": ["testhwid", "second-machine"]})
self.assertEqual(lic["license_variables"], {"tier": "pro", "seats": 3, "beta": True})
self.assertEqual(lic["app_variables"], {"theme": "dark"})
self.assertEqual(lic["label"], "Vector license")
def test_login_from_file_is_offline_and_starts_no_heartbeat(self) -> None:
client, failures = self._make_client()
self.assertEqual(client.get_hwid(), self.good["hwid"])
with patch(
"authforge.urllib.request.urlopen",
side_effect=AssertionError("offline files must not use the network"),
):
self.assertTrue(client.login_from_file(self.lifetime["file"]))
self.assertTrue(client.is_authenticated())
self.assertEqual(client.get_session_kind(), "offline")
# No token sentinel: an offline session has no server session at all.
self.assertIsNone(client._session_token)
self.assertFalse(client._heartbeat_started)
self.assertIsNone(client._heartbeat_thread)
self.assertEqual(client.get_license_variables(), {"tier": "pro", "seats": 3, "beta": True})
self.assertEqual(client.get_app_variables(), {"theme": "dark"})
self.assertEqual(client.get_session_data()["licenseKey"], "TEST-KEY0-0000-0000")
offline = client.get_offline_license()
assert offline is not None
self.assertEqual(offline["jti"], "00000000-0000-4000-8000-000000000003")
self.assertIsNone(offline["expires_at"])
self.assertEqual(failures, [])
client.logout()
self.assertFalse(client.is_authenticated())
self.assertIsNone(client.get_session_kind())
self.assertIsNone(client.get_offline_license())
def test_login_from_file_does_not_need_app_secret(self) -> None:
client, failures = self._make_client(app_secret="")
self.assertEqual(client.app_secret, "")
self.assertTrue(client.login_from_file(self.lifetime["file"]))
self.assertTrue(client.is_authenticated())
self.assertEqual(failures, [])
def test_login_requires_app_secret(self) -> None:
client, _ = self._make_client(app_secret=None)
with self.assertRaises(ValueError) as ctx:
client.login("XXXX-XXXX-XXXX-XXXX")
self.assertIn("app_secret is required for online APIs", str(ctx.exception))
self.assertFalse(client.is_authenticated())
def test_offline_self_ban_is_local_error_and_never_posts(self) -> None:
# Closed port: any accidental network call fails loudly instead of hanging.
client, _ = self._make_client(
api_base_url="http://127.0.0.1:9",
# Explicit-license SelfBan is an online API; this test covers that
# dual-mode path. Offline-only clients omit the secret entirely.
app_secret="online-selfban",
)
self.assertTrue(client.login_from_file(self.lifetime["file"]))
posts: list = []
def fake_post(path, body, **_kwargs):
posts.append((path, body))
return {"status": "ok"}
with patch.object(client, "_post_json", side_effect=fake_post):
with self.assertRaises(ValueError) as ctx:
client.self_ban()
self.assertEqual(str(ctx.exception), "offline_session")
with self.assertRaises(ValueError) as ctx:
client.self_ban(revoke_license=False, blacklist_hwid=False)
self.assertEqual(str(ctx.exception), "offline_session")
self.assertEqual(posts, [])
# Still authenticated offline afterwards; nothing was torn down.
self.assertTrue(client.is_authenticated())
# An explicit license_key is a request about a different credential
# and legitimately takes the pre-session path with a fresh nonce.
client.self_ban(license_key="OTHER-KEY0-0000-0000")
self.assertEqual(len(posts), 1)
self.assertEqual(posts[0][0], "/auth/selfban")
self.assertEqual(posts[0][1]["licenseKey"], "OTHER-KEY0-0000-0000")
self.assertFalse(posts[0][1]["revokeLicense"])
self.assertTrue(posts[0][1]["nonce"])
self.assertNotIn("sessionToken", posts[0][1])
def test_offline_heartbeat_entry_points_are_no_ops(self) -> None:
client, failures = self._make_client(online_heartbeat=True)
self.assertTrue(client.login_from_file(self.lifetime["file"]))
# Make the loop's wait return immediately so the offline guard is what ends it.
client.heartbeat_interval = 0
with patch(
"authforge.urllib.request.urlopen",
side_effect=AssertionError("offline files must not use the network"),
):
# Even if something calls the internal entry points, an offline
# session never starts a thread, never checks in and never runs
# the grace check.
client._start_heartbeat_once()
self.assertFalse(client._heartbeat_started)
self.assertIsNone(client._heartbeat_thread)
client._heartbeat_loop()
self.assertTrue(client.is_authenticated())
self.assertEqual(client.get_session_kind(), "offline")
self.assertEqual(failures, [])
def test_unsupported_version_bool_vector_is_rejected(self) -> None:
case = self.by_name["unsupported_version_bool"]
result = verify_license_file(case["file"], case["appId"], case["publicKey"], case["hwid"], now=_iso(case["now"]))
self.assertEqual(result, {"ok": False, "error": "unsupported_version"})