| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312 |
- """Same-user private bootstrap at the existing HTTP authentication boundary.
- This is not remote/exposure delegation. The daemon captures the actual socket
- peer before proxy middleware, and the private control channel is the credential
- issuer. A browser Origin (including an empty one) always disqualifies this path.
- """
- from __future__ import annotations
- from contextlib import contextmanager
- from pathlib import Path
- from fastapi import HTTPException
- from starlette.responses import JSONResponse
- HEADER = 'x-hermes-gateway-ticket'
- def native_profile_scope(request):
- """Resolve the request's implicit selectors (omitted / '' / 'current') in the TICKET's home.
- ``_own_profile`` lets those selectors through unbound; the routes then resolve
- ``get_hermes_home()`` / ``_default_db_path()``, which is the launch home unless the
- task-local override says otherwise. A secondary-profile ticket must read and write its
- own profile, never the launch profile's dashboard state. The launch profile's own ticket
- binds its home override too, so it never inherits a foreign override that happens to be
- ambient in the request context.
- """
- return grant_home_scope(getattr(request.state, 'native_http_principal', None))
- @contextmanager
- def grant_home_scope(grant):
- """Bind *grant*'s home as the task-local home override; no-op without a grant."""
- if grant is None:
- yield
- return
- from hermes_constants import reset_hermes_home_override, set_hermes_home_override
- home = Path(grant['profile_id'])
- token = set_hermes_home_override(str(home))
- try:
- yield
- finally:
- reset_hermes_home_override(token)
- def _own_profile(value, profile_id, *, current=True):
- from hermes_cli.web_server_profiles import _resolve_profile_dir
- if value is None or (isinstance(value, str) and current
- and (not value.strip() or value.strip().lower() == 'current')):
- return
- if not isinstance(value, str):
- raise PermissionError('profile_scope_mismatch')
- try:
- target = _resolve_profile_dir(value.strip()).resolve()
- except HTTPException:
- raise PermissionError('profile_scope_mismatch') from None
- if target != Path(profile_id):
- raise PermissionError('profile_scope_mismatch')
- async def _check_profile_scope(request, profile_id):
- # Existing handlers select body.profile OR query.profile. Check every value,
- # including repeated query keys, rather than normalizing away a disagreement.
- path = request.url.path.rstrip('/')
- current = not path.startswith(('/api/profiles/', '/api/cron/jobs', '/api/sessions',
- '/api/fs/download', '/api/fs/read-data-url'))
- for value in request.query_params.getlist('profile'):
- _own_profile(value, profile_id, current=current)
- content_type = request.headers.get('content-type', '').split(';', 1)[0].strip().lower()
- if not content_type or content_type == 'application/json' or (
- content_type.startswith('application/') and content_type.endswith('+json')):
- try:
- body = await request.json()
- except (ValueError, UnicodeError):
- body = None # Route validation still owns malformed JSON.
- if isinstance(body, dict) and 'profile' in body:
- _own_profile(body['profile'], profile_id, current=current)
- if path.startswith('/api/cron/jobs') and not request.query_params.get('profile'):
- # Job-id discovery and the default list scan other profiles. Require an
- # explicit, verified named profile instead of silently changing defaults.
- raise PermissionError('profile_scope_mismatch')
- if path == '/api/profiles':
- # GET is the existing discovery list, not authority to open their DBs.
- if request.method != 'GET':
- raise PermissionError('profile_scope_mismatch')
- elif path.startswith('/api/profiles/'):
- suffix = path.removeprefix('/api/profiles/')
- collection = profile_collection_route(path, request.method)
- aggregate_selector = {
- 'sessions': 'profile', 'sessions/sidebar': 'recents_profile',
- 'projects/tree': 'profile', 'sessions/pull-requests': 'profile',
- }.get(collection)
- if aggregate_selector:
- values = request.query_params.getlist(aggregate_selector)
- if not values:
- raise PermissionError('profile_scope_mismatch')
- for value in values:
- # These routes interpret absent/all differently from /api/config.
- _own_profile(value, profile_id, current=False)
- elif collection == 'active' and request.method == 'GET':
- return # Discovery of sticky defaults does not switch this daemon.
- elif collection in {'active', 'import'}:
- raise PermissionError('profile_scope_mismatch')
- else:
- _own_profile(suffix.split('/', 1)[0], profile_id, current=False)
- if request.method in {'PATCH', 'DELETE'}:
- # Moving/deleting a home is a registry operation, not a profile REST write: it
- # rides the dedicated ``native-profile-registry`` grant (_check_registry_scope).
- raise PermissionError('profile_scope_mismatch')
- # ``/api/profiles/<suffix>`` collection routes, by method (hermes_cli/web_routers/profiles.py). Every
- # other method on these paths is the per-profile ``/api/profiles/{name}`` route of a profile NAMED
- # ``active``/``import``/``sessions``/…: valid profile names (PROFILE_ID_RE, not reserved).
- # Desktop mirror: apps/desktop/electron/profile-routes.ts.
- PROFILE_COLLECTION_ROUTES = {
- 'active': frozenset({'GET', 'POST'}), 'import': frozenset({'POST'}),
- 'projects/tree': frozenset({'GET'}), 'sessions': frozenset({'GET'}),
- 'sessions/pull-requests': frozenset({'POST'}), 'sessions/sidebar': frozenset({'GET'}),
- }
- def profile_collection_route(path, method):
- """The collection suffix ``method path`` serves, or None when the path names a profile."""
- suffix = path.rstrip('/').removeprefix('/api/profiles/')
- if suffix == path.rstrip('/'):
- return None
- return suffix if method.upper() in PROFILE_COLLECTION_ROUTES.get(suffix, ()) else None
- def _registry_target(request):
- """The profile a ``PATCH``/``DELETE /api/profiles/<name>`` names, or None for any other route."""
- if request.method not in {'PATCH', 'DELETE'}:
- return None
- suffix = request.url.path.rstrip('/').removeprefix('/api/profiles/')
- if suffix == request.url.path.rstrip('/') or not suffix or '/' in suffix:
- return None
- return suffix
- def _check_registry_scope(request, profile_id, launch_home):
- """A registry grant renames or deletes exactly the profile it was minted for (#140345).
- Never the gateway's launch home, which this live process is running in: deleting it or moving
- its directory pulls the runtime out from under itself. The default root's rename stays allowed,
- because it only sets a presentation ``display_name`` and never moves the directory.
- """
- target = _registry_target(request)
- for value in request.query_params.getlist('profile'):
- _own_profile(value, profile_id, current=False)
- _own_profile(target, profile_id, current=False)
- if launch_home is None:
- # Fail closed: with no known launch home the guard below cannot tell it apart.
- raise PermissionError('profile_scope_mismatch')
- from hermes_constants import get_default_hermes_root, hermes_home_key
- # Compared by hermes_home_key, as SessionAuthorities keys homes (symlinks, case, separators).
- launch = hermes_home_key(launch_home)
- if hermes_home_key(profile_id) == launch and not (
- request.method == 'PATCH' and launch == hermes_home_key(get_default_hermes_root())):
- raise PermissionError('profile_scope_mismatch')
- def _redeem_http_ticket(store, ticket, request):
- from gateway.runtime_bootstrap import _PURPOSE_CAPABILITIES
- try:
- grant = store.redeem(ticket, profile_id=None, purpose='native-http')
- except PermissionError:
- # Only these host-management operations accept a dedicated same-user grant.
- # Wrong-purpose redemption does not consume a ticket; ordinary profile grants
- # still reach _check_profile_scope and remain unable to create, move or delete profiles.
- if request.method == 'POST' and request.url.path.rstrip('/') == '/api/profiles':
- grant = store.redeem(ticket, profile_id=None, purpose='native-profile-create')
- elif _registry_target(request) is not None:
- grant = store.redeem(ticket, profile_id=None, purpose='native-profile-registry')
- else:
- raise
- # The issuer's own purpose -> capability table, not a second copy of it.
- if grant['capabilities'] != _PURPOSE_CAPABILITIES[grant['purpose']]:
- raise PermissionError('invalid native grant')
- return grant
- def _launch_home(runner):
- from gateway.session_authorities import all_authorities
- registry = getattr(runner, 'session_authorities', None)
- launch = registry.launch if registry is not None else (all_authorities(runner) or [None])[0]
- return launch.profile_id if launch is not None else None
- def _native_store(conn, tickets):
- """The runner's ticket store when *conn* may redeem a private grant here, else None."""
- from gateway.drain_control import restart_wait_read
- from gateway.session_authorities import all_authorities
- runner = getattr(conn.app.state, 'gateway_runner', None)
- descriptor = getattr(runner, 'session_runtime_descriptor', {})
- authorities = all_authorities(runner)
- store = getattr(runner, 'session_ticket_store', None)
- peer = conn.scope.get('hermes.gateway_socket_peer')
- if (len(tickets) != 1 or 'origin' in conn.headers or not peer
- or peer[0] not in {'127.0.0.1', '::1'}
- or descriptor.get('state') != 'ready'
- # A restart's after-turn wait still serves the reads that open a parked prompt (#139041).
- # A websocket scope has no method, so a socket upgrade never matches that GET allowlist.
- or (getattr(runner, '_draining', True)
- and not restart_wait_read(runner, conn.scope.get('method'), conn.url.path))
- or not authorities or store is None
- or store.instance_id != descriptor.get('instance_id')
- or any(a is not None and a.instance_id != store.instance_id for a in authorities)
- # A profile being hot-served (just created: a reserved ``None`` slot, then an authority
- # not yet published to the descriptor and ticket store) is not served yet. It cannot
- # redeem a grant, and it must not refuse every already-served profile meanwhile.
- or descriptor.get('served_profiles') != [
- {'profile_id': a.profile_id, 'home': a.profile_id} for a in authorities
- if a is not None and not getattr(a, 'retiring', False) and a.profile_id in store.profile_ids]):
- return None
- return runner, store
- def redeem_native_ws(conn):
- """Redeem the ``native-http`` grant a Desktop plugin socket upgrade presents; None when refused.
- Same issuer, header, peer/Origin and served-profile rules as HTTP: a plugin socket is the
- live twin of the plugin REST call that already rides this grant on a local gateway. The
- upgrade's ``profile`` selectors must name the grant's home. Plugin sockets only: ``/api/ws``
- and other core streams keep their own purpose-bound credentials. Called once per upgrade, by
- ``PluginApiWebSocketGate`` ahead of routing, so the grant's profile decides consent and scope
- before any route dependency or plugin code runs.
- """
- tickets = conn.headers.getlist(HEADER)
- gate = _native_store(conn, tickets) if conn.url.path.startswith('/api/plugins/') else None
- if gate is None:
- return None
- runner, store = gate
- from gateway.session_authorities import authority_for_profile_id
- try:
- grant = store.redeem(tickets[0], profile_id=None, purpose='native-http')
- if (grant['capabilities'] != frozenset({'http:owner'})
- or authority_for_profile_id(runner, grant['profile_id']) is None):
- return None
- for value in conn.query_params.getlist('profile'):
- _own_profile(value, grant['profile_id'])
- except PermissionError:
- return None
- return grant
- AUDIO_STREAM_PATHS = frozenset({'/api/audio/speak-stream', '/api/audio/transcribe-stream'})
- def redeem_audio_ws(ws):
- """Redeem the ``interactive`` grant a local Desktop's audio stream upgrade presents; None when refused.
- The voice sockets are siblings of the Desktop's ``/api/ws`` dial and ride the same one-use
- grant in the same gateway subprotocol (``gateway/run_api.py``), under the HTTP seam's
- peer/Origin/served-profile rules. The upgrade's ``profile`` selectors must name the grant's home.
- """
- from hermes_cli.web_server_boundary import _gateway_ws_ticket_from_subprotocol
- ticket, reason = _gateway_ws_ticket_from_subprotocol(ws)
- gate = _native_store(ws, [ticket]) if reason == 'ok' and ws.url.path in AUDIO_STREAM_PATHS else None
- if gate is None:
- return None
- runner, store = gate
- from gateway.session_authorities import authority_for_profile_id
- try:
- grant = store.redeem(ticket, profile_id=None, purpose='interactive')
- if authority_for_profile_id(runner, grant['profile_id']) is None:
- return None
- for value in ws.query_params.getlist('profile'):
- _own_profile(value, grant['profile_id'])
- except PermissionError:
- return None
- return grant
- def authenticate_native_ws(ws):
- """The grant :func:`redeem_native_ws` admitted for this plugin socket, or None (refused).
- Never redeems: the gate already did, once, and bound the grant's home and secret scope for
- the whole connection.
- """
- if not ws.url.path.startswith('/api/plugins/'):
- return None
- return getattr(ws.state, 'native_http_principal', None)
- async def authenticate_native_http(request):
- """Return a rejection or stamp a one-request principal; absent header is inert."""
- tickets = request.headers.getlist(HEADER)
- if not tickets:
- return None
- from gateway.session_authorities import authority_for_profile_id
- gate = _native_store(request, tickets)
- if gate is None:
- return JSONResponse({'detail': 'Unauthorized'}, status_code=401)
- runner, store = gate
- try:
- # The ticket names the served profile it was minted for; that home's authority owns it.
- grant = _redeem_http_ticket(store, tickets[0], request)
- if authority_for_profile_id(runner, grant['profile_id']) is None:
- raise PermissionError('unserved native grant')
- except PermissionError:
- return JSONResponse({'detail': 'Unauthorized'}, status_code=401)
- try:
- if grant['purpose'] == 'native-profile-registry':
- _check_registry_scope(request, grant['profile_id'], _launch_home(runner))
- elif grant['purpose'] != 'native-profile-create':
- await _check_profile_scope(request, grant['profile_id'])
- except PermissionError:
- return JSONResponse({'detail': 'profile_scope_mismatch'}, status_code=403)
- request.state.native_http_principal = grant
- return None
|