aac-invoke-auth 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,177 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
@@ -0,0 +1,147 @@
1
+ Metadata-Version: 2.4
2
+ Name: aac-invoke-auth
3
+ Version: 0.1.0
4
+ Summary: AAC sidecar-to-agent invoke-push authentication (AAC1-HMAC-SHA256) — signing and verification core, with FastAPI mounting surfaces.
5
+ Author: Agent Authority Cloud Project
6
+ License-Expression: Apache-2.0
7
+ Keywords: aac,agent,authorization,hmac,middleware,fastapi,sidecar
8
+ Classifier: Development Status :: 3 - Alpha
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: Operating System :: OS Independent
11
+ Classifier: Programming Language :: Python :: 3
12
+ Classifier: Programming Language :: Python :: 3.10
13
+ Classifier: Programming Language :: Python :: 3.11
14
+ Classifier: Programming Language :: Python :: 3.12
15
+ Classifier: Programming Language :: Python :: 3.13
16
+ Classifier: Topic :: Security
17
+ Classifier: Framework :: FastAPI
18
+ Classifier: Typing :: Typed
19
+ Requires-Python: >=3.10
20
+ Description-Content-Type: text/markdown
21
+ License-File: LICENSE
22
+ Provides-Extra: fastapi
23
+ Requires-Dist: fastapi>=0.115; extra == "fastapi"
24
+ Provides-Extra: test
25
+ Requires-Dist: pytest>=8.0; extra == "test"
26
+ Requires-Dist: fastapi>=0.115; extra == "test"
27
+ Requires-Dist: httpx>=0.28; extra == "test"
28
+ Dynamic: license-file
29
+
30
+ # aac-invoke-auth
31
+
32
+ Authenticate `/invoke` pushes from your paired AAC sidecar.
33
+
34
+ When your agent runs behind an AAC sidecar, the sidecar verifies the
35
+ cross-organizational authority chain and then POSTs the verified context
36
+ to your agent's `/invoke` endpoint. The `X-AAC-*` headers on that push
37
+ are your agent's **entire view** of the verified chain — so your agent
38
+ must be able to tell a genuine sidecar push from a forged one. This
39
+ package is that check: the sidecar HMAC-signs every push with a pairing
40
+ secret shared with exactly one agent, and your agent verifies the
41
+ signature before trusting anything.
42
+
43
+ The verification core is standard-library only (`hmac`, `hashlib`) and
44
+ framework-agnostic. FastAPI mounting surfaces ship behind an extra:
45
+
46
+ ```bash
47
+ pip install aac-invoke-auth[fastapi]
48
+ ```
49
+
50
+ ## Quick start (FastAPI)
51
+
52
+ Generate the pairing secret once and share the file with your sidecar
53
+ (the sidecar's `sidecar.agent_invoke_auth.secret_file` points at the
54
+ same file; one secret per sidecar–agent pair, never shared across
55
+ pairs):
56
+
57
+ ```bash
58
+ openssl rand -hex 32 > /etc/aac/invoke-auth/invoke-auth.secret
59
+ ```
60
+
61
+ Point your agent at it and mount the middleware:
62
+
63
+ ```bash
64
+ export AAC_INVOKE_AUTH_SECRET_FILE=/etc/aac/invoke-auth/invoke-auth.secret
65
+ ```
66
+
67
+ ```python
68
+ from fastapi import FastAPI
69
+ from aac_invoke_auth.fastapi import InvokeAuthGuard, InvokeAuthMiddleware
70
+
71
+ app = FastAPI()
72
+ app.add_middleware(
73
+ InvokeAuthMiddleware,
74
+ guard=InvokeAuthGuard.from_env(),
75
+ protected_paths=("/invoke",), # required, exact-match
76
+ )
77
+ ```
78
+
79
+ That's the whole integration. Unsigned, tampered, replayed-stale, or
80
+ wrong-secret pushes get a `401` with a generic detail and never reach
81
+ your business logic; your handlers read `request.json()` unchanged.
82
+
83
+ Prefer route-scoped protection? The guard is also a plain FastAPI
84
+ dependency:
85
+
86
+ ```python
87
+ from fastapi import Depends
88
+
89
+ guard = InvokeAuthGuard.from_env()
90
+
91
+ @app.post("/invoke", dependencies=[Depends(guard)])
92
+ async def invoke(request: Request): ...
93
+ ```
94
+
95
+ Both surfaces call the same verifier — pick whichever fits your app.
96
+
97
+ ## Fail-fast startup, by design
98
+
99
+ `InvokeAuthGuard.from_env()` **refuses to start** when
100
+ `AAC_INVOKE_AUTH_SECRET_FILE` is unset. A missing secret is a security
101
+ downgrade; it should fail your deployment loudly at boot, not degrade
102
+ into a log line nobody reads.
103
+
104
+ The single escape hatch — for extraordinary cases only, such as tenant
105
+ test/pilot environments or debugging a suspected signing mismatch — is
106
+ setting
107
+
108
+ ```bash
109
+ export AAC_INVOKE_AUTH_ALLOW_UNAUTHENTICATED=true
110
+ ```
111
+
112
+ explicitly (only the exact value `true`; a typo still fails the boot).
113
+ An opted-out agent accepts every push unverified and logs a prominent
114
+ warning at startup so the posture is visible in your logs. Never run
115
+ this in production: the sidecar side has a symmetric `dev_mode`
116
+ interlock, and both exist to make "unauthenticated" impossible to reach
117
+ by accident.
118
+
119
+ ## Testing your agent
120
+
121
+ `aac_invoke_auth.testing` ships with the package:
122
+
123
+ ```python
124
+ from aac_invoke_auth.testing import signing_test_client
125
+
126
+ client = signing_test_client(app) # wraps FastAPI's TestClient
127
+ response = client.post("/invoke", headers=aac_headers, json=payload)
128
+ ```
129
+
130
+ `post()` calls to protected paths are signed exactly the way the paired
131
+ sidecar signs them (secret read from `AAC_INVOKE_AUTH_SECRET_FILE`);
132
+ everything else passes through. So your test suite exercises the real
133
+ production verification path instead of opting out of it.
134
+
135
+ ## Wire format
136
+
137
+ `AAC1-HMAC-SHA256` over method, path, timestamp, a SHA-256 body digest,
138
+ and every `X-AAC-*` header (derived by rule, so header
139
+ insertion/removal after signing fails verification). Freshness window
140
+ ±30s. The normative canonicalization text lives in the AAC Engineering
141
+ Specification §III.2.4a; frozen known-answer vectors live in this
142
+ package's test suite — a change that breaks a vector is a wire-format
143
+ break, not a refactor.
144
+
145
+ Ports of this middleware for other stacks (Express, Spring, Go
146
+ net/http) follow the same model; the core stays standard-library-only
147
+ in every language precisely to keep those ports mechanical.
@@ -0,0 +1,118 @@
1
+ # aac-invoke-auth
2
+
3
+ Authenticate `/invoke` pushes from your paired AAC sidecar.
4
+
5
+ When your agent runs behind an AAC sidecar, the sidecar verifies the
6
+ cross-organizational authority chain and then POSTs the verified context
7
+ to your agent's `/invoke` endpoint. The `X-AAC-*` headers on that push
8
+ are your agent's **entire view** of the verified chain — so your agent
9
+ must be able to tell a genuine sidecar push from a forged one. This
10
+ package is that check: the sidecar HMAC-signs every push with a pairing
11
+ secret shared with exactly one agent, and your agent verifies the
12
+ signature before trusting anything.
13
+
14
+ The verification core is standard-library only (`hmac`, `hashlib`) and
15
+ framework-agnostic. FastAPI mounting surfaces ship behind an extra:
16
+
17
+ ```bash
18
+ pip install aac-invoke-auth[fastapi]
19
+ ```
20
+
21
+ ## Quick start (FastAPI)
22
+
23
+ Generate the pairing secret once and share the file with your sidecar
24
+ (the sidecar's `sidecar.agent_invoke_auth.secret_file` points at the
25
+ same file; one secret per sidecar–agent pair, never shared across
26
+ pairs):
27
+
28
+ ```bash
29
+ openssl rand -hex 32 > /etc/aac/invoke-auth/invoke-auth.secret
30
+ ```
31
+
32
+ Point your agent at it and mount the middleware:
33
+
34
+ ```bash
35
+ export AAC_INVOKE_AUTH_SECRET_FILE=/etc/aac/invoke-auth/invoke-auth.secret
36
+ ```
37
+
38
+ ```python
39
+ from fastapi import FastAPI
40
+ from aac_invoke_auth.fastapi import InvokeAuthGuard, InvokeAuthMiddleware
41
+
42
+ app = FastAPI()
43
+ app.add_middleware(
44
+ InvokeAuthMiddleware,
45
+ guard=InvokeAuthGuard.from_env(),
46
+ protected_paths=("/invoke",), # required, exact-match
47
+ )
48
+ ```
49
+
50
+ That's the whole integration. Unsigned, tampered, replayed-stale, or
51
+ wrong-secret pushes get a `401` with a generic detail and never reach
52
+ your business logic; your handlers read `request.json()` unchanged.
53
+
54
+ Prefer route-scoped protection? The guard is also a plain FastAPI
55
+ dependency:
56
+
57
+ ```python
58
+ from fastapi import Depends
59
+
60
+ guard = InvokeAuthGuard.from_env()
61
+
62
+ @app.post("/invoke", dependencies=[Depends(guard)])
63
+ async def invoke(request: Request): ...
64
+ ```
65
+
66
+ Both surfaces call the same verifier — pick whichever fits your app.
67
+
68
+ ## Fail-fast startup, by design
69
+
70
+ `InvokeAuthGuard.from_env()` **refuses to start** when
71
+ `AAC_INVOKE_AUTH_SECRET_FILE` is unset. A missing secret is a security
72
+ downgrade; it should fail your deployment loudly at boot, not degrade
73
+ into a log line nobody reads.
74
+
75
+ The single escape hatch — for extraordinary cases only, such as tenant
76
+ test/pilot environments or debugging a suspected signing mismatch — is
77
+ setting
78
+
79
+ ```bash
80
+ export AAC_INVOKE_AUTH_ALLOW_UNAUTHENTICATED=true
81
+ ```
82
+
83
+ explicitly (only the exact value `true`; a typo still fails the boot).
84
+ An opted-out agent accepts every push unverified and logs a prominent
85
+ warning at startup so the posture is visible in your logs. Never run
86
+ this in production: the sidecar side has a symmetric `dev_mode`
87
+ interlock, and both exist to make "unauthenticated" impossible to reach
88
+ by accident.
89
+
90
+ ## Testing your agent
91
+
92
+ `aac_invoke_auth.testing` ships with the package:
93
+
94
+ ```python
95
+ from aac_invoke_auth.testing import signing_test_client
96
+
97
+ client = signing_test_client(app) # wraps FastAPI's TestClient
98
+ response = client.post("/invoke", headers=aac_headers, json=payload)
99
+ ```
100
+
101
+ `post()` calls to protected paths are signed exactly the way the paired
102
+ sidecar signs them (secret read from `AAC_INVOKE_AUTH_SECRET_FILE`);
103
+ everything else passes through. So your test suite exercises the real
104
+ production verification path instead of opting out of it.
105
+
106
+ ## Wire format
107
+
108
+ `AAC1-HMAC-SHA256` over method, path, timestamp, a SHA-256 body digest,
109
+ and every `X-AAC-*` header (derived by rule, so header
110
+ insertion/removal after signing fails verification). Freshness window
111
+ ±30s. The normative canonicalization text lives in the AAC Engineering
112
+ Specification §III.2.4a; frozen known-answer vectors live in this
113
+ package's test suite — a change that breaks a vector is a wire-format
114
+ break, not a refactor.
115
+
116
+ Ports of this middleware for other stacks (Express, Spring, Go
117
+ net/http) follow the same model; the core stays standard-library-only
118
+ in every language precisely to keep those ports mechanical.