-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathclient.py
More file actions
286 lines (242 loc) · 10.7 KB
/
Copy pathclient.py
File metadata and controls
286 lines (242 loc) · 10.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
"""Buyer-side ergonomic preset for adapters that don't use ``ADCPClient``.
When you build on :class:`ADCPClient` / :class:`ADCPMultiAgentClient`,
passing ``signing=SigningConfig(...)`` is enough — the client wires the
RFC 9421 signing event hook for you. This module is the equivalent for
adapters integrating against a seller via raw ``httpx`` (custom
orchestrators, edge proxies, anything the higher-level client doesn't
fit).
Two pieces:
* :func:`install_signing_event_hook` — installs a request event hook on
an existing :class:`httpx.AsyncClient` that signs outbound requests
per the seller's advertised ``request_signing`` policy.
* :func:`signing_operation` — context manager that sets the AdCP
operation name on the shared :data:`current_operation` ContextVar so
the hook knows which capability list to consult on each request.
Usage::
import httpx
from adcp.signing import (
SigningConfig,
VerifierCapability, # if you mirror the seller's advertisement locally
install_signing_event_hook,
signing_operation,
)
signing = SigningConfig(private_key=..., key_id="my-agent-2026")
seller_capability = await fetch_seller_request_signing_capability()
client = httpx.AsyncClient()
install_signing_event_hook(
client,
signing=signing,
seller_capability=seller_capability,
adcp_version="3.2",
)
async with client:
with signing_operation("create_media_buy"):
resp = await client.post("https://seller.example.com/mcp", json=payload)
The ``ADCPClient(signing=...)`` path remains the right shape when you
are using the SDK's high-level client — its built-in hook does the same
work plus capability prefetching, and you should not double-install.
"""
from __future__ import annotations
import inspect
import logging
from collections.abc import Awaitable, Callable, Iterator
from contextlib import contextmanager
from typing import TYPE_CHECKING, Any
from urllib.parse import urlsplit
from adcp.signing._idna_canonicalize import canonicalize_host
from adcp.signing.autosign import (
SigningConfig,
current_operation,
operation_needs_signing,
signing_profile_for_adcp_version,
)
from adcp.signing.signer import sign_request
if TYPE_CHECKING:
import httpx
from adcp.types.generated_poc.protocol.get_adcp_capabilities_response import (
RequestSigning,
)
logger = logging.getLogger(__name__)
CapabilityProvider = Callable[[], "RequestSigning | None | Awaitable[RequestSigning | None]"]
"""Returns the seller's ``request_signing`` capability block.
May be sync (``-> RequestSigning | None``) or async
(``-> Awaitable[RequestSigning | None]``). The hook awaits an
awaitable result so callers can plug in a capability fetcher backed by
a network call.
"""
def _origin(url: Any) -> tuple[str, str, int] | None:
parsed = urlsplit(str(url))
if not parsed.scheme or not parsed.hostname:
return None
try:
port = parsed.port
except ValueError as exc:
raise ValueError(f"invalid signing origin: {url!s}") from exc
if port is None:
port = 443 if parsed.scheme.lower() == "https" else 80
return parsed.scheme.lower(), canonicalize_host(parsed.hostname), port
def install_signing_event_hook(
client: httpx.AsyncClient,
*,
signing: SigningConfig,
seller_capability: RequestSigning | None = None,
capability_provider: CapabilityProvider | None = None,
expected_origin: str | None = None,
adcp_version: str | None = None,
) -> None:
"""Install an RFC 9421 request-signing event hook on ``client``.
The hook reads the AdCP operation name from
:data:`adcp.signing.current_operation` (set by
:func:`signing_operation`), consults the seller's advertised
``request_signing`` policy, and attaches ``Signature`` /
``Signature-Input`` / ``Content-Digest`` headers when the operation
is in ``required_for`` / ``warn_for`` / ``supported_for``.
Pass exactly one of ``seller_capability`` or ``capability_provider``.
Parameters
----------
client:
An :class:`httpx.AsyncClient`. The hook is appended to its
existing ``event_hooks["request"]`` list.
signing:
Buyer credentials. Same shape used by ``ADCPClient(signing=...)``.
seller_capability:
The seller's ``request_signing`` block. Use this when the value
is known up front (you've already called ``get_adcp_capabilities``
once at boot and you're caching it).
capability_provider:
Callable returning the capability per request. Use when the
capability needs lazy / re-resolved lookup. Sync and async are
both supported. Returning ``None`` means "seller doesn't sign;
skip every operation."
expected_origin:
Seller origin that signed requests are allowed to target. If omitted,
the client's ``base_url`` origin is used when available; otherwise the
first request inside :func:`signing_operation` binds the hook to its
origin. Cross-origin redirects and later cross-origin requests fail
before signing.
adcp_version:
Trusted negotiated AdCP version used to select the signing profile
when ``SigningConfig.signing_profile_version`` is not explicit.
Notes
-----
Operations not yet bracketed in :func:`signing_operation` (e.g.
health-check probes, metrics scrapes that share the client) pass
through unsigned — same carve-out as ``ADCPClient``.
"""
if (seller_capability is None) == (capability_provider is None):
raise ValueError(
"install_signing_event_hook requires exactly one of "
"`seller_capability` or `capability_provider`."
)
if signing.signing_profile_version is not None:
signing_profile_version = signing.signing_profile_version
elif adcp_version is not None:
signing_profile_version = signing_profile_for_adcp_version(adcp_version)
else:
raise ValueError(
"install_signing_event_hook requires adcp_version when "
"SigningConfig.signing_profile_version is not explicit"
)
bound_origin = (
_origin(expected_origin) if expected_origin is not None else _origin(client.base_url)
)
if expected_origin is not None and bound_origin is None:
raise ValueError("expected_origin must be an absolute URL origin")
async def _hook(request: httpx.Request) -> None:
nonlocal bound_origin
operation = current_operation.get()
# Unset ContextVar → out-of-band call (health check, manual
# probe). Skip without consulting capability.
# ``get_adcp_capabilities`` is the bootstrap carve-out: signing
# it would require capabilities we don't have yet. Mirrors
# ADCPClient._sign_outgoing_request.
if operation is None or operation == "get_adcp_capabilities":
return
request_origin = _origin(request.url)
if request_origin is None: # pragma: no cover - httpx requests are absolute here
raise ValueError("cannot sign a request without an absolute origin")
if bound_origin is None:
# Bind before awaiting a dynamic provider so concurrent first-use
# requests cannot each establish a different signing origin.
bound_origin = request_origin
elif request_origin != bound_origin:
raise ValueError(
"refusing to sign a cross-origin request; redirects must be "
"handled and re-authorized outside signing_operation"
)
capability: RequestSigning | None
if seller_capability is not None:
capability = seller_capability
else:
assert capability_provider is not None
result = capability_provider()
# `inspect.isawaitable` covers coroutines, futures, and any
# `__await__`-defining object — and unlike `hasattr(result,
# "__await__")` it doesn't treat a Mock() as awaitable just
# because Mock synthesizes any attribute access.
if inspect.isawaitable(result):
capability = await result
else:
capability = result
decision = operation_needs_signing(capability, operation)
if decision == "skip":
return
covers_policy: str | None = None
if capability is not None and capability.covers_content_digest is not None:
covers_policy = capability.covers_content_digest.value
if covers_policy == "forbidden":
cover_digest = False
elif covers_policy == "required":
cover_digest = True
else:
# "either" / absent — signer's choice; pick the stricter
# body-bound option so the seller's content-digest verify
# never rejects on a "missing optional component" path.
cover_digest = True
signed = sign_request(
method=request.method,
url=str(request.url),
headers=dict(request.headers),
body=request.content,
private_key=signing.private_key,
key_id=signing.key_id,
alg=signing.alg,
cover_content_digest=cover_digest,
tag=signing.tag,
signing_profile_version=signing_profile_version,
)
# pop-then-set so our values are authoritative even if an
# earlier layer set the same header in a different case.
for header_name, header_value in signed.as_dict().items():
request.headers.pop(header_name, None)
request.headers[header_name] = header_value
hooks = client.event_hooks
request_hooks: list[Any] = list(hooks.get("request") or [])
request_hooks.append(_hook)
hooks["request"] = request_hooks
client.event_hooks = hooks
@contextmanager
def signing_operation(name: str) -> Iterator[None]:
"""Set :data:`adcp.signing.current_operation` for the duration of the block.
``install_signing_event_hook`` reads this ContextVar to decide
whether an outbound request should be signed and what the signing
policy is for that operation.
::
with signing_operation("create_media_buy"):
resp = await client.post(url, json=payload)
ContextVar values copy into ``asyncio.create_task`` children, so a
background task spawned inside this block inherits the operation
name. Don't spawn unrelated network calls inside a signing scope —
they'd be classified under whichever operation is on the
ContextVar at the moment they fire.
"""
token = current_operation.set(name)
try:
yield
finally:
current_operation.reset(token)
__all__ = [
"CapabilityProvider",
"install_signing_event_hook",
"signing_operation",
]