Private
Public Access
Bot accounts (User rows with is_bot=True), scoped API tokens (read:messages, write:messages, manage:rooms) authenticated via Authorization: Bearer on both REST and the WS handshake, live bot WebSocket access on the same /ws/chat endpoint humans use, message editing (WS "edit" envelope -> message_update broadcast, fans out cross-instance for free via the existing broadcaster), incoming webhooks (room-scoped, no auth beyond the URL token), and outgoing webhooks/event subscriptions (HMAC-SHA256 signed, backgrounded delivery, creation-time SSRF validation against private/loopback/link-local targets). Token auth is additive, not a parallel system: a bearer-token-authenticated bot goes through the exact same room-membership/role checks a session- authenticated human does everywhere; only read:messages/write:messages are separately scope-gated (the two message endpoints). manage:rooms scope enforcement, full per-delivery SSRF re-validation, and bot API rate limiting were explicitly scoped out (confirmed with the repo owner) as disproportionate to this phase -- documented as known gaps in backend/README.md rather than silently skipped. Admin portal gains a Bots tab (create bots, issue/revoke scoped tokens, cross-room webhook visibility); RoomInfoPanel gains room-scoped webhook/ subscription management, mirroring how invites already work there. The chat UI also gets a minimal "edit your own message" affordance -- not asked for by the issue, but the only practical way to exercise the edit pipeline by hand instead of only via a scripted bot client. Along the way: fixed a real bug caught while writing the incoming-webhook test -- offline-push notification relied on the sender being "connected" to exclude themselves, true for WS-originated messages but not for the new webhook path, which has no WS connection for the attributed sender at all. Now explicitly excluded. Also discovered the REST-only test fixture never triggered ASGI lifespan, so app.state.broadcaster/presence didn't exist for it; moved their construction out of the lifespan into create_app() itself (Redis client construction is synchronous/lazy) so both the WS and REST-only paths always have them. New tests/test_bots.py, test_message_edit.py, test_webhooks.py (full suite now 78/78, stable across repeated runs) plus a scripted end-to-end smoke test (bot WS join/post/edit, incoming webhook, SSRF rejection, outgoing delivery) and a full browser walkthrough of the new admin/room UI. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
165 lines
5.7 KiB
Python
165 lines
5.7 KiB
Python
import asyncio
|
|
import hashlib
|
|
import hmac
|
|
import json
|
|
import uuid
|
|
|
|
import pytest
|
|
|
|
from app.models import PushSubscription
|
|
from app.schemas.user import UserCreate
|
|
from app.services.auth_service import register_user
|
|
from app.services.room_service import join_room
|
|
from app.services.ssrf import UnsafeWebhookUrlError, validate_target_url
|
|
from tests.conftest import register_and_login
|
|
|
|
|
|
def test_validate_target_url_rejects_loopback():
|
|
with pytest.raises(UnsafeWebhookUrlError):
|
|
validate_target_url("http://127.0.0.1/hook")
|
|
|
|
|
|
def test_validate_target_url_rejects_private_range():
|
|
with pytest.raises(UnsafeWebhookUrlError):
|
|
validate_target_url("http://10.0.0.5/hook")
|
|
|
|
|
|
def test_validate_target_url_rejects_non_http_scheme():
|
|
with pytest.raises(UnsafeWebhookUrlError):
|
|
validate_target_url("ftp://8.8.8.8/hook")
|
|
|
|
|
|
def test_validate_target_url_accepts_public_address():
|
|
# 8.8.8.8 is a stable, well-known public IP (Google's public DNS
|
|
# resolver) -- a literal IP so this resolves without any real network
|
|
# access (getaddrinfo parses a literal IP without touching DNS/the
|
|
# network), and it isn't flagged by any of ipaddress's private/
|
|
# reserved/loopback/etc checks, so it exercises the "allowed" path.
|
|
# (203.0.113.0/24, the usual RFC 5737 documentation-only choice, is
|
|
# actually flagged is_private by Python's ipaddress module -- not
|
|
# usable here.)
|
|
validate_target_url("http://8.8.8.8/hook")
|
|
|
|
|
|
async def test_event_subscription_rejects_private_target(client, db_session):
|
|
await register_and_login(client, db_session, username="alice")
|
|
room = (await client.post("/api/rooms", json={"name": "general"})).json()
|
|
|
|
resp = await client.post(
|
|
f"/api/rooms/{room['id']}/event-subscriptions",
|
|
json={"event_types": ["message.created"], "target_url": "http://127.0.0.1/hook"},
|
|
)
|
|
assert resp.status_code == 400
|
|
|
|
|
|
async def test_incoming_webhook_unknown_token_404s(client, db_session):
|
|
await register_and_login(client, db_session, username="alice")
|
|
resp = await client.post("/api/webhooks/incoming/not-a-real-token", json={"content": "hi"})
|
|
assert resp.status_code == 404
|
|
|
|
|
|
async def test_incoming_webhook_posts_message_and_pushes_offline_members(
|
|
client, db_session, monkeypatch
|
|
):
|
|
calls = []
|
|
monkeypatch.setattr("app.services.push_service.webpush", lambda **kw: calls.append(kw))
|
|
|
|
alice = await register_and_login(client, db_session, username="alice")
|
|
room = (await client.post("/api/rooms", json={"name": "general"})).json()
|
|
|
|
webhook_resp = await client.post(
|
|
f"/api/rooms/{room['id']}/webhooks/incoming", json={"description": "CI bot"}
|
|
)
|
|
assert webhook_resp.status_code == 201
|
|
webhook = webhook_resp.json()
|
|
assert webhook["token"]
|
|
|
|
bob = await register_user(
|
|
db_session, UserCreate(username="bob", email="bob@example.com", password="password123")
|
|
)
|
|
await join_room(db_session, uuid.UUID(room["id"]), bob.id)
|
|
db_session.add(
|
|
PushSubscription(
|
|
user_id=bob.id,
|
|
endpoint="https://push.example.com/bob",
|
|
p256dh_key="p256dh",
|
|
auth_key="auth",
|
|
)
|
|
)
|
|
await db_session.commit()
|
|
|
|
post_resp = await client.post(
|
|
f"/api/webhooks/incoming/{webhook['token']}", json={"content": "deploy succeeded"}
|
|
)
|
|
assert post_resp.status_code == 204
|
|
|
|
history = (await client.get(f"/api/rooms/{room['id']}/messages")).json()
|
|
assert any(m["content"] == "deploy succeeded" for m in history)
|
|
|
|
# Exactly one push -- to bob. If the sender (webhook creator, alice) were
|
|
# incorrectly included in "offline members" (no WS connection exists for
|
|
# either party in this REST-only test), this would be 2.
|
|
assert len(calls) == 1
|
|
assert "deploy succeeded" in calls[0]["data"]
|
|
|
|
|
|
async def test_outgoing_webhook_delivers_signed_payload(client, db_session, monkeypatch):
|
|
captured_tasks: list[asyncio.Task] = []
|
|
real_create_task = asyncio.create_task
|
|
|
|
def fake_create_task(coro):
|
|
task = real_create_task(coro)
|
|
captured_tasks.append(task)
|
|
return task
|
|
|
|
monkeypatch.setattr("app.services.webhook_service.asyncio.create_task", fake_create_task)
|
|
|
|
posts = []
|
|
|
|
class FakeResponse:
|
|
status_code = 200
|
|
|
|
class FakeAsyncClient:
|
|
def __init__(self, *args, **kwargs):
|
|
pass
|
|
|
|
async def __aenter__(self):
|
|
return self
|
|
|
|
async def __aexit__(self, *args):
|
|
return False
|
|
|
|
async def post(self, url, content=None, headers=None):
|
|
posts.append({"url": url, "content": content, "headers": headers})
|
|
return FakeResponse()
|
|
|
|
monkeypatch.setattr("app.services.webhook_delivery.httpx.AsyncClient", FakeAsyncClient)
|
|
|
|
await register_and_login(client, db_session, username="alice")
|
|
room = (await client.post("/api/rooms", json={"name": "general"})).json()
|
|
|
|
sub_resp = await client.post(
|
|
f"/api/rooms/{room['id']}/event-subscriptions",
|
|
json={"event_types": ["message.created"], "target_url": "http://8.8.8.8/hook"},
|
|
)
|
|
assert sub_resp.status_code == 201
|
|
secret = sub_resp.json()["signing_secret"]
|
|
|
|
webhook = (
|
|
await client.post(f"/api/rooms/{room['id']}/webhooks/incoming", json={})
|
|
).json()
|
|
resp = await client.post(
|
|
f"/api/webhooks/incoming/{webhook['token']}", json={"content": "ping"}
|
|
)
|
|
assert resp.status_code == 204
|
|
|
|
await asyncio.gather(*captured_tasks)
|
|
|
|
assert len(posts) == 1
|
|
body = posts[0]["content"]
|
|
expected_signature = hmac.new(secret.encode(), body, hashlib.sha256).hexdigest()
|
|
assert posts[0]["headers"]["X-KeepItTalking-Signature"] == f"sha256={expected_signature}"
|
|
payload = json.loads(body)
|
|
assert payload["event"] == "message.created"
|
|
assert payload["data"]["content"] == "ping"
|