"""Login/settings regression tests. Google responses are mocked; no real keys.
Run: python -m unittest discover -s tests -v
The deployment helper can load a staged hub via OWRT_RECAPTCHA_HUB_SOURCE.
"""
import importlib.util
import json
import os
from pathlib import Path
import re
import sys
import tempfile
import threading
import unittest
import urllib.error
import urllib.request
from unittest import mock
SOURCE = Path(os.environ.get("OWRT_RECAPTCHA_HUB_SOURCE", Path(__file__).resolve().parents[1] / "vps" / "owrt-remote-hub.py"))
STATE = tempfile.TemporaryDirectory(prefix="owrt-recaptcha-tests-")
spec = importlib.util.spec_from_file_location("recaptcha_test_hub", SOURCE)
hub = importlib.util.module_from_spec(spec)
sys.modules[spec.name] = hub
with mock.patch.dict(os.environ, {"OWRT_REMOTE_STATE_DIR": STATE.name}):
spec.loader.exec_module(hub)
def configured_auth(mode=hub.CAPTCHA_MODE_RECAPTCHA_V3, score=0.5):
return hub.normalize_auth_state({
"username": "test-owner",
"captcha": {"mode": mode, "site_key": "test-site", "secret_key": "test-secret", "min_score": score},
})
class RecaptchaTests(unittest.TestCase):
def verify(self, result, **kwargs):
with mock.patch.object(hub, "oauth_fetch_json", return_value=result) as google:
answer = hub.verify_recaptcha_token("test-secret", "test-token", expected_hostname="hub.example", expected_action="login", **kwargs)
return answer, google
def test_modes_and_old_v2_settings_are_preserved(self):
self.assertEqual(hub.sanitize_captcha_mode("recaptcha"), hub.CAPTCHA_MODE_RECAPTCHA)
self.assertEqual(hub.sanitize_captcha_mode("recaptcha_v3"), hub.CAPTCHA_MODE_RECAPTCHA_V3)
self.assertEqual(hub.sanitize_captcha_mode("unknown"), hub.CAPTCHA_MODE_DIGITS)
old = hub.sanitize_captcha_state({"mode": "recaptcha", "site_key": "old-site", "secret_key": "old-secret"})
self.assertEqual(old["mode"], "recaptcha")
self.assertEqual(old["min_score"], 0.5)
self.assertEqual(hub.effective_captcha_state({"captcha": {"mode": "recaptcha_v3"}})["effective_mode"], "digits")
def test_invalid_thresholds_are_rejected(self):
for value in (True, None, "", "nan", "inf", -0.1, 1.1):
with self.subTest(value=value), self.assertRaises(ValueError):
hub.parse_recaptcha_score(value)
self.assertEqual(hub.parse_recaptcha_score("0"), 0)
self.assertEqual(hub.parse_recaptcha_score("1"), 1)
self.assertEqual(hub.sanitize_captcha_state({"min_score": "nan"})["min_score"], 0.5)
def test_v3_checks_success_action_hostname_and_score(self):
good = {"success": True, "hostname": "hub.example", "action": "login", "score": 0.5}
self.assertTrue(self.verify(good)[0][0])
for patch in ({"score": 0.49}, {"score": None}, {"score": True}, {"score": "0.9"}, {"score": float("nan")},
{"score": 1.1}, {"action": "other"}, {"action": ""}, {"hostname": "other.example"},
{"hostname": ""}, {"success": False}, {"success": "true"}):
with self.subTest(patch=patch):
self.assertFalse(self.verify({**good, **patch})[0][0])
self.assertFalse(self.verify({k: v for k, v in good.items() if k != "score"})[0][0])
self.assertFalse(self.verify(good, min_score=0.6)[0][0])
self.assertFalse(self.verify([])[0][0])
def test_v2_does_not_require_v3_fields(self):
with mock.patch.object(hub, "oauth_fetch_json", return_value={"success": True, "hostname": "hub.example"}):
self.assertTrue(hub.verify_recaptcha_token("secret", "token", expected_hostname="hub.example")[0])
def test_empty_expired_and_network_error_fail_closed(self):
with mock.patch.object(hub, "oauth_fetch_json") as google:
self.assertFalse(hub.verify_recaptcha_token("secret", "")[0])
google.assert_not_called()
self.assertFalse(self.verify({"success": False, "error-codes": ["timeout-or-duplicate"]})[0][0])
with mock.patch.object(hub, "oauth_fetch_json", side_effect=TimeoutError("unavailable")):
self.assertFalse(hub.verify_recaptcha_token("secret", "token")[0])
def test_google_receives_secret_token_and_optional_ip(self):
with mock.patch.object(hub, "oauth_fetch_json", return_value={"success": True}) as google:
hub.verify_recaptcha_token("secret", "token", remote_ip="192.0.2.1")
google.assert_called_once_with(hub.RECAPTCHA_VERIFY_URL, method="POST", data={"secret": "secret", "response": "token", "remoteip": "192.0.2.1"})
def test_handler_uses_server_action_and_threshold(self):
handler = object.__new__(hub.Handler)
handler.client_ip = lambda: "192.0.2.1"
handler.request_host_name = lambda: "hub.example"
with mock.patch.object(hub, "verify_recaptcha_token", return_value=(True, "")) as verify:
self.assertTrue(handler.verify_login_captcha({"g-recaptcha-response": "token", "action": "evil", "score": 1}, configured_auth(score=0.7))[0])
self.assertEqual(verify.call_args.kwargs["expected_action"], "login")
self.assertEqual(verify.call_args.kwargs["min_score"], 0.7)
def test_digits_still_work(self):
handler = object.__new__(hub.Handler)
with mock.patch.object(hub, "verify_captcha", return_value=True) as verify:
self.assertTrue(handler.verify_login_captcha({"captcha_token": "token", "captcha_answer": "12345"}, configured_auth("digits"))[0])
verify.assert_called_once_with("token", "12345")
def test_login_pages_and_public_meta_hide_secret(self):
auth = configured_auth()
self.assertNotIn("secret_key", hub.public_auth_meta(auth)["captcha"])
self.assertEqual(hub.admin_auth_meta(auth)["captcha"]["min_score"], 0.5)
with mock.patch.object(hub, "load_auth", return_value=auth):
page = hub.login_html()
self.assertIn("api.js?render=test-site", page)
self.assertIn('data-recaptcha-action="login"', page)
self.assertIn('name="g-recaptcha-response"', page)
self.assertNotIn('name="captcha_answer"', page)
self.assertNotIn('class="g-recaptcha"', page)
self.assertNotIn("test-secret", page)
self.assertNotIn("test-secret", hub.modern_login_captcha_html(auth))
for mode in ("digits", "recaptcha"):
with mock.patch.object(hub, "load_auth", return_value=configured_auth(mode)):
page = hub.login_html()
if mode == "digits":
self.assertIn('name="captcha_answer"', page)
self.assertNotIn('src="https://www.google.com/recaptcha', page)
else:
self.assertIn('class="g-recaptcha"', page)
self.assertNotIn("api.js?render=", page)
def test_untrusted_site_key_is_escaped_in_markup_and_url(self):
auth = configured_auth()
auth["captcha"]["site_key"] = '">'
self.assertNotIn('">", page, re.S)), encoding="utf-8")
print(f"JavaScript exported to {output}")
else:
unittest.main()