-
Notifications
You must be signed in to change notification settings - Fork 510
/
server.py
683 lines (579 loc) · 25.4 KB
/
server.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
"""Admin server classes."""
import asyncio
import logging
import re
import warnings
import weakref
from typing import Callable, Coroutine, Optional, Pattern, Sequence, cast
import aiohttp_cors
import jwt
from aiohttp import web
from aiohttp_apispec import setup_aiohttp_apispec, validation_middleware
from uuid_utils import uuid4
from aries_cloudagent.wallet import singletons
from ..config.injection_context import InjectionContext
from ..config.logging import context_wallet_id
from ..core.event_bus import Event, EventBus
from ..core.plugin_registry import PluginRegistry
from ..core.profile import Profile
from ..ledger.error import LedgerConfigError, LedgerTransactionError
from ..messaging.responder import BaseResponder
from ..multitenant.base import BaseMultitenantManager, MultitenantManagerError
from ..storage.base import BaseStorage
from ..storage.error import StorageNotFoundError
from ..storage.type import RECORD_TYPE_ACAPY_UPGRADING
from ..transport.outbound.message import OutboundMessage
from ..transport.outbound.status import OutboundSendStatus
from ..transport.queue.basic import BasicMessageQueue
from ..utils import general as general_utils
from ..utils.stats import Collector
from ..utils.task_queue import TaskQueue
from ..version import __version__
from ..wallet.anoncreds_upgrade import check_upgrade_completion_loop
from .base_server import BaseAdminServer
from .error import AdminSetupError
from .request_context import AdminRequestContext
from .routes import (
config_handler,
liveliness_handler,
plugins_handler,
readiness_handler,
redirect_handler,
shutdown_handler,
status_handler,
status_reset_handler,
)
LOGGER = logging.getLogger(__name__)
EVENT_PATTERN_WEBHOOK = re.compile("^acapy::webhook::(.*)$")
EVENT_PATTERN_RECORD = re.compile("^acapy::record::([^:]*)(?:::.*)?$")
EVENT_WEBHOOK_MAPPING = {
"acapy::basicmessage::received": "basicmessages",
"acapy::problem_report": "problem_report",
"acapy::ping::received": "ping",
"acapy::ping::response_received": "ping",
"acapy::actionmenu::received": "actionmenu",
"acapy::actionmenu::get-active-menu": "get-active-menu",
"acapy::actionmenu::perform-menu-action": "perform-menu-action",
"acapy::keylist::updated": "keylist",
}
anoncreds_wallets = singletons.IsAnoncredsSingleton().wallets
in_progress_upgrades = singletons.UpgradeInProgressSingleton()
class AdminResponder(BaseResponder):
"""Handle outgoing messages from message handlers."""
def __init__(
self,
profile: Profile,
send: Coroutine,
**kwargs,
):
"""Initialize an instance of `AdminResponder`.
Args:
profile (Profile): The profile for this responder.
send (Coroutine): Function to send outbound message.
**kwargs: Additional keyword arguments.
"""
super().__init__(**kwargs)
# Weakly hold the profile so this reference doesn't prevent profiles
# from being cleaned up when appropriate.
# Binding this AdminResponder to the profile's context creates a circular
# reference.
self._profile = weakref.ref(profile)
self._send = send
async def send_outbound(
self, message: OutboundMessage, **kwargs
) -> OutboundSendStatus:
"""Send outbound message.
Args:
message: The `OutboundMessage` to be sent
**kwargs: Additional keyword arguments
"""
profile = self._profile()
if not profile:
raise RuntimeError("weakref to profile has expired")
return await self._send(profile, message)
async def send_webhook(self, topic: str, payload: dict):
"""Dispatch a webhook. DEPRECATED: use the event bus instead.
Args:
topic: the webhook topic identifier
payload: the webhook payload value
"""
warnings.warn(
"responder.send_webhook is deprecated; please use the event bus instead.",
DeprecationWarning,
)
profile = self._profile()
if not profile:
raise RuntimeError("weakref to profile has expired")
await profile.notify("acapy::webhook::" + topic, payload)
@property
def send_fn(self) -> Coroutine:
"""Accessor for async function to send outbound message."""
return self._send
@web.middleware
async def ready_middleware(request: web.BaseRequest, handler: Coroutine):
"""Only continue if application is ready to take work."""
if str(request.rel_url).rstrip("/") in (
"/status/live",
"/status/ready",
) or request.app._state.get("ready"):
try:
return await handler(request)
except (LedgerConfigError, LedgerTransactionError) as e:
# fatal, signal server shutdown
LOGGER.error("Shutdown with %s", str(e))
request.app._state["ready"] = False
request.app._state["alive"] = False
raise
except web.HTTPFound as e:
# redirect, typically / -> /api/doc
LOGGER.info("Handler redirect to: %s", e.location)
raise
except asyncio.CancelledError:
# redirection spawns new task and cancels old
LOGGER.debug("Task cancelled")
raise
except Exception as e:
# some other error?
LOGGER.error("Handler error with exception: %s", str(e))
import traceback
print("\n=================")
traceback.print_exc()
raise
raise web.HTTPServiceUnavailable(reason="Shutdown in progress")
@web.middleware
async def upgrade_middleware(request: web.BaseRequest, handler: Coroutine):
"""Blocking middleware for upgrades."""
context: AdminRequestContext = request["context"]
# Already upgraded
if context.profile.name in anoncreds_wallets:
return await handler(request)
# Upgrade in progress
if context.profile.name in in_progress_upgrades.wallets:
raise web.HTTPServiceUnavailable(reason="Upgrade in progress")
# Avoid try/except in middleware with find_all_records
upgrade_initiated = []
async with context.profile.session() as session:
storage = session.inject(BaseStorage)
upgrade_initiated = await storage.find_all_records(RECORD_TYPE_ACAPY_UPGRADING)
if upgrade_initiated:
# If we get here, than another instance started an upgrade
# We need to check for completion (or fail) in another process
in_progress_upgrades.set_wallet(context.profile.name)
is_subwallet = context.metadata and "wallet_id" in context.metadata
asyncio.create_task(
check_upgrade_completion_loop(
context.profile,
is_subwallet,
)
)
raise web.HTTPServiceUnavailable(reason="Upgrade in progress")
return await handler(request)
@web.middleware
async def debug_middleware(request: web.BaseRequest, handler: Coroutine):
"""Show request detail in debug log."""
if LOGGER.isEnabledFor(logging.DEBUG):
LOGGER.debug(f"Incoming request: {request.method} {request.path_qs}")
LOGGER.debug(f"Match info: {request.match_info}")
body = await request.text() if request.body_exists else None
LOGGER.debug(f"Body: {body}")
return await handler(request)
class AdminServer(BaseAdminServer):
"""Admin HTTP server class."""
def __init__(
self,
host: str,
port: int,
context: InjectionContext,
root_profile: Profile,
outbound_message_router: Coroutine,
webhook_router: Callable,
conductor_stop: Coroutine,
task_queue: Optional[TaskQueue] = None,
conductor_stats: Optional[Coroutine] = None,
):
"""Initialize an AdminServer instance.
Args:
host (str): The host to listen on.
port (int): The port to listen on.
context (InjectionContext): The application context instance.
root_profile (Profile): The root profile.
outbound_message_router (Coroutine): Coroutine for delivering
outbound messages.
webhook_router (Callable): Callable for delivering webhooks.
conductor_stop (Coroutine): Conductor (graceful) stop for shutdown API call.
task_queue (TaskQueue, optional): An optional task queue for handlers.
conductor_stats (Coroutine, optional): Conductor statistics API call.
"""
self.app = None
self.admin_api_key = context.settings.get("admin.admin_api_key")
self.admin_insecure_mode = bool(context.settings.get("admin.admin_insecure_mode"))
self.host = host
self.port = port
self.context = context
self.conductor_stop = conductor_stop
self.conductor_stats = conductor_stats
self.loaded_modules = []
self.outbound_message_router = outbound_message_router
self.root_profile = root_profile
self.task_queue = task_queue
self.webhook_router = webhook_router
self.websocket_queues = {}
self.site = None
self.multitenant_manager = context.inject_or(BaseMultitenantManager)
self._additional_route_pattern: Optional[Pattern] = None
@property
def additional_routes_pattern(self) -> Optional[Pattern]:
"""Pattern for configured additional routes to permit base wallet to access."""
if self._additional_route_pattern:
return self._additional_route_pattern
base_wallet_routes = self.context.settings.get("multitenant.base_wallet_routes")
base_wallet_routes = cast(Sequence[str], base_wallet_routes)
if base_wallet_routes:
self._additional_route_pattern = re.compile(
"^(?:" + "|".join(base_wallet_routes) + ")"
)
return None
def _matches_additional_routes(self, path: str) -> bool:
"""Path matches additional_routes_pattern."""
pattern = self.additional_routes_pattern
if pattern:
return bool(pattern.match(path))
return False
async def make_application(self) -> web.Application:
"""Get the aiohttp application instance."""
middlewares = [ready_middleware, debug_middleware]
# admin-token and admin-token are mutually exclusive and required.
# This should be enforced during parameter parsing but to be sure,
# we check here.
assert self.admin_insecure_mode ^ bool(self.admin_api_key)
collector = self.context.inject_or(Collector)
@web.middleware
async def setup_context(request: web.Request, handler):
authorization_header = request.headers.get("Authorization")
profile = self.root_profile
meta_data = {}
# Multitenancy context setup
if self.multitenant_manager and authorization_header:
try:
bearer, _, token = authorization_header.partition(" ")
if bearer != "Bearer":
raise web.HTTPUnauthorized(
reason="Invalid Authorization header structure"
)
profile = await self.multitenant_manager.get_profile_for_token(
self.context, token
)
(
walletid,
walletkey,
) = self.multitenant_manager.get_wallet_details_from_token(
token=token
)
wallet_id = profile.settings.get("wallet.id")
context_wallet_id.set(wallet_id)
meta_data = {
"wallet_id": walletid,
"wallet_key": walletkey,
}
except MultitenantManagerError as err:
raise web.HTTPUnauthorized(reason=err.roll_up)
except (jwt.InvalidTokenError, StorageNotFoundError):
raise web.HTTPUnauthorized()
# Create a responder with the request specific context
responder = AdminResponder(
profile,
self.outbound_message_router,
)
profile.context.injector.bind_instance(BaseResponder, responder)
# TODO may dynamically adjust the profile used here according to
# headers or other parameters
if self.multitenant_manager and authorization_header:
admin_context = AdminRequestContext(
profile=profile,
root_profile=self.root_profile,
metadata=meta_data,
)
else:
admin_context = AdminRequestContext(
profile=profile,
)
request["context"] = admin_context
request["outbound_message_router"] = responder.send
if collector:
handler = collector.wrap_coro(handler, [handler.__qualname__])
if self.task_queue:
task = await self.task_queue.put(handler(request))
return await task
return await handler(request)
middlewares.append(setup_context)
# Upgrade middleware needs the context setup
middlewares.append(upgrade_middleware)
# Register validation_middleware last avoiding unauthorized validations
middlewares.append(validation_middleware)
app = web.Application(
middlewares=middlewares,
client_max_size=(
self.context.settings.get("admin.admin_client_max_request_size", 1)
* 1024
* 1024
),
)
server_routes = [
web.get("/", redirect_handler, allow_head=True),
web.get("/plugins", plugins_handler, allow_head=False),
web.get("/status", status_handler, allow_head=False),
web.get("/status/config", config_handler, allow_head=False),
web.post("/status/reset", status_reset_handler),
web.get("/status/live", liveliness_handler, allow_head=False),
web.get("/status/ready", readiness_handler, allow_head=False),
web.get("/shutdown", shutdown_handler, allow_head=False),
web.get("/ws", self.websocket_handler, allow_head=False),
]
app.add_routes(server_routes)
plugin_registry = self.context.inject_or(PluginRegistry)
if plugin_registry:
await plugin_registry.register_admin_routes(app)
cors = aiohttp_cors.setup(
app,
defaults={
"*": aiohttp_cors.ResourceOptions(
allow_credentials=True,
expose_headers="*",
allow_headers="*",
allow_methods="*",
)
},
)
for route in app.router.routes():
cors.add(route)
# get agent label
agent_label = self.context.settings.get("default_label")
version_string = f"v{__version__}"
setup_aiohttp_apispec(
app=app, title=agent_label, version=version_string, swagger_path="/api/doc"
)
app.on_startup.append(self.on_startup)
# ensure we always have status values
app._state["ready"] = False
app._state["alive"] = False
# set global-like variables
app["context"] = self.context
app["conductor_stats"] = self.conductor_stats
app["conductor_stop"] = self.conductor_stop
return app
async def start(self) -> None:
"""Start the webserver.
Raises:
AdminSetupError: If there was an error starting the webserver
"""
def sort_dict(raw: dict) -> dict:
"""Order (JSON, string keys) dict asciibetically by key, recursively."""
for k, v in raw.items():
if isinstance(v, dict):
raw[k] = sort_dict(v)
return dict(sorted(raw.items(), key=lambda x: x[0]))
self.app = await self.make_application()
runner = web.AppRunner(self.app)
await runner.setup()
plugin_registry = self.context.inject_or(PluginRegistry)
if plugin_registry:
plugin_registry.post_process_routes(self.app)
event_bus = self.context.inject_or(EventBus)
if event_bus:
event_bus.subscribe(EVENT_PATTERN_WEBHOOK, self._on_webhook_event)
event_bus.subscribe(EVENT_PATTERN_RECORD, self._on_record_event)
# Only include forward webhook events if the option is enabled
if self.context.settings.get_bool("monitor_forward", False):
EVENT_WEBHOOK_MAPPING["acapy::forward::received"] = "forward"
for event_topic, webhook_topic in EVENT_WEBHOOK_MAPPING.items():
event_bus.subscribe(
re.compile(re.escape(event_topic)),
lambda profile, event, webhook_topic=webhook_topic: self.send_webhook(
profile, webhook_topic, event.payload
),
)
# order tags alphabetically, parameters deterministically and pythonically
swagger_dict = self.app._state["swagger_dict"]
swagger_dict.get("tags", []).sort(key=lambda t: t["name"])
# sort content per path and sort paths
for path_spec in swagger_dict["paths"].values():
for method_spec in path_spec.values():
method_spec["parameters"].sort(
key=lambda p: (p["in"], not p["required"], p["name"])
)
for path in sorted(swagger_dict["paths"]):
swagger_dict["paths"][path] = swagger_dict["paths"].pop(path)
# order definitions alphabetically by dict key
swagger_dict["definitions"] = sort_dict(swagger_dict["definitions"])
self.site = web.TCPSite(runner, host=self.host, port=self.port)
try:
await self.site.start()
self.app._state["ready"] = True
self.app._state["alive"] = True
except OSError:
raise AdminSetupError(
"Unable to start webserver with host "
+ f"'{self.host}' and port '{self.port}'\n"
)
async def stop(self) -> None:
"""Stop the webserver."""
# Stopped before admin server is created
if not self.app:
return
self.app._state["ready"] = False # in case call does not come through OpenAPI
for queue in self.websocket_queues.values():
queue.stop()
if self.site:
await self.site.stop()
self.site = None
async def on_startup(self, app: web.Application):
"""Perform webserver startup actions."""
security_definitions = {}
security = []
if self.admin_api_key:
security_definitions["ApiKeyHeader"] = {
"type": "apiKey",
"in": "header",
"name": "X-API-KEY",
}
security.append({"ApiKeyHeader": []})
if self.multitenant_manager:
security_definitions["AuthorizationHeader"] = {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"description": "Bearer token. Be sure to prepend token with 'Bearer '",
}
# If multitenancy is enabled we need Authorization header
multitenant_security = {"AuthorizationHeader": []}
# If admin api key is also enabled, we need both for subwallet requests
if self.admin_api_key:
multitenant_security["ApiKeyHeader"] = []
security.append(multitenant_security)
if self.admin_api_key or self.multitenant_manager:
swagger = app["swagger_dict"]
swagger["securityDefinitions"] = security_definitions
swagger["security"] = security
def notify_fatal_error(self):
"""Set our readiness flags to force a restart (openshift)."""
LOGGER.error("Received shutdown request notify_fatal_error()")
self.app._state["ready"] = False
self.app._state["alive"] = False
async def websocket_handler(self, request):
"""Send notifications to admin client over websocket."""
ws = web.WebSocketResponse()
await ws.prepare(request)
socket_id = str(uuid4())
queue = BasicMessageQueue()
loop = asyncio.get_event_loop()
if self.admin_insecure_mode:
# open to send websocket messages without api key auth
queue.authenticated = True
else:
header_admin_api_key = request.headers.get("x-api-key")
# authenticated via http header?
queue.authenticated = general_utils.const_compare(
header_admin_api_key, self.admin_api_key
)
try:
self.websocket_queues[socket_id] = queue
await queue.enqueue(
{
"topic": "settings",
"payload": {
"authenticated": queue.authenticated,
"label": self.context.settings.get("default_label"),
"endpoint": self.context.settings.get("default_endpoint"),
"no_receive_invites": self.context.settings.get(
"admin.no_receive_invites", False
),
"help_link": self.context.settings.get("admin.help_link"),
},
}
)
closed = False
receive = loop.create_task(ws.receive_json())
send = loop.create_task(queue.dequeue(timeout=5.0))
while not closed:
try:
await asyncio.wait(
(receive, send), return_when=asyncio.FIRST_COMPLETED
)
if ws.closed:
closed = True
if receive.done():
if not closed:
msg_received = None
msg_api_key = None
try:
# this call can re-raise exceptions from inside the task
msg_received = receive.result()
msg_api_key = msg_received.get("x-api-key")
except Exception:
LOGGER.exception("Exception in websocket receiving task:")
if self.admin_api_key and general_utils.const_compare(
self.admin_api_key, msg_api_key
):
# authenticated via websocket message
queue.authenticated = True
receive = loop.create_task(ws.receive_json())
if send.done():
try:
msg = send.result()
except asyncio.TimeoutError:
msg = None
if msg is None:
# we send fake pings because the JS client
# can't detect real ones
msg = {
"topic": "ping",
"authenticated": queue.authenticated,
}
if not closed:
if msg:
await ws.send_json(msg)
send = loop.create_task(queue.dequeue(timeout=5.0))
except asyncio.CancelledError:
closed = True
if not receive.done():
receive.cancel()
if not send.done():
send.cancel()
finally:
del self.websocket_queues[socket_id]
return ws
async def _on_webhook_event(self, profile: Profile, event: Event):
match = EVENT_PATTERN_WEBHOOK.search(event.topic)
webhook_topic = match.group(1) if match else None
if webhook_topic:
await self.send_webhook(profile, webhook_topic, event.payload)
async def _on_record_event(self, profile: Profile, event: Event):
match = EVENT_PATTERN_RECORD.search(event.topic)
webhook_topic = match.group(1) if match else None
if webhook_topic:
await self.send_webhook(profile, webhook_topic, event.payload)
async def send_webhook(
self, profile: Profile, topic: str, payload: Optional[dict] = None
):
"""Add a webhook to the queue, to send to all registered targets."""
wallet_id = profile.settings.get("wallet.id")
webhook_urls = profile.settings.get("admin.webhook_urls")
metadata = None
if wallet_id:
metadata = {"x-wallet-id": wallet_id}
if self.webhook_router:
for endpoint in webhook_urls:
self.webhook_router(
topic,
payload,
endpoint,
None,
metadata,
)
# set ws webhook body, optionally add wallet id for multitenant mode
webhook_body = {"topic": topic, "payload": payload}
if wallet_id:
webhook_body["wallet_id"] = wallet_id
for queue in self.websocket_queues.values():
if queue.authenticated or topic in ("ping", "settings"):
await queue.enqueue(webhook_body)