opteryx-access 0.0.1__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.
Files changed (28) hide show
  1. opteryx_access-0.0.1/LICENSE +201 -0
  2. opteryx_access-0.0.1/PKG-INFO +401 -0
  3. opteryx_access-0.0.1/README.md +174 -0
  4. opteryx_access-0.0.1/opteryx_access/__init__.py +107 -0
  5. opteryx_access-0.0.1/opteryx_access/actions.py +55 -0
  6. opteryx_access-0.0.1/opteryx_access/adapters/__init__.py +1 -0
  7. opteryx_access-0.0.1/opteryx_access/adapters/firestore.py +82 -0
  8. opteryx_access-0.0.1/opteryx_access/checks.py +169 -0
  9. opteryx_access-0.0.1/opteryx_access/exceptions.py +44 -0
  10. opteryx_access-0.0.1/opteryx_access/models.py +69 -0
  11. opteryx_access-0.0.1/opteryx_access/patterns.py +121 -0
  12. opteryx_access-0.0.1/opteryx_access/roles.py +68 -0
  13. opteryx_access-0.0.1/opteryx_access/store.py +291 -0
  14. opteryx_access-0.0.1/opteryx_access.egg-info/PKG-INFO +401 -0
  15. opteryx_access-0.0.1/opteryx_access.egg-info/SOURCES.txt +26 -0
  16. opteryx_access-0.0.1/opteryx_access.egg-info/dependency_links.txt +1 -0
  17. opteryx_access-0.0.1/opteryx_access.egg-info/requires.txt +8 -0
  18. opteryx_access-0.0.1/opteryx_access.egg-info/top_level.txt +1 -0
  19. opteryx_access-0.0.1/pyproject.toml +55 -0
  20. opteryx_access-0.0.1/setup.cfg +4 -0
  21. opteryx_access-0.0.1/tests/test_actions.py +45 -0
  22. opteryx_access-0.0.1/tests/test_checks.py +118 -0
  23. opteryx_access-0.0.1/tests/test_firestore_adapter.py +107 -0
  24. opteryx_access-0.0.1/tests/test_models.py +91 -0
  25. opteryx_access-0.0.1/tests/test_patterns.py +66 -0
  26. opteryx_access-0.0.1/tests/test_roles.py +40 -0
  27. opteryx_access-0.0.1/tests/test_security.py +231 -0
  28. opteryx_access-0.0.1/tests/test_store.py +301 -0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 Justin Joyce (@joocer)
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,401 @@
1
+ Metadata-Version: 2.4
2
+ Name: opteryx_access
3
+ Version: 0.0.1
4
+ Summary: Permission checks and grant/revoke for the Opteryx platform
5
+ Author-email: joocer <justin.joyce@joocer.com>
6
+ License: Apache License
7
+ Version 2.0, January 2004
8
+ http://www.apache.org/licenses/
9
+
10
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
11
+
12
+ 1. Definitions.
13
+
14
+ "License" shall mean the terms and conditions for use, reproduction,
15
+ and distribution as defined by Sections 1 through 9 of this document.
16
+
17
+ "Licensor" shall mean the copyright owner or entity authorized by
18
+ the copyright owner that is granting the License.
19
+
20
+ "Legal Entity" shall mean the union of the acting entity and all
21
+ other entities that control, are controlled by, or are under common
22
+ control with that entity. For the purposes of this definition,
23
+ "control" means (i) the power, direct or indirect, to cause the
24
+ direction or management of such entity, whether by contract or
25
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
26
+ outstanding shares, or (iii) beneficial ownership of such entity.
27
+
28
+ "You" (or "Your") shall mean an individual or Legal Entity
29
+ exercising permissions granted by this License.
30
+
31
+ "Source" form shall mean the preferred form for making modifications,
32
+ including but not limited to software source code, documentation
33
+ source, and configuration files.
34
+
35
+ "Object" form shall mean any form resulting from mechanical
36
+ transformation or translation of a Source form, including but
37
+ not limited to compiled object code, generated documentation,
38
+ and conversions to other media types.
39
+
40
+ "Work" shall mean the work of authorship, whether in Source or
41
+ Object form, made available under the License, as indicated by a
42
+ copyright notice that is included in or attached to the work
43
+ (an example is provided in the Appendix below).
44
+
45
+ "Derivative Works" shall mean any work, whether in Source or Object
46
+ form, that is based on (or derived from) the Work and for which the
47
+ editorial revisions, annotations, elaborations, or other modifications
48
+ represent, as a whole, an original work of authorship. For the purposes
49
+ of this License, Derivative Works shall not include works that remain
50
+ separable from, or merely link (or bind by name) to the interfaces of,
51
+ the Work and Derivative Works thereof.
52
+
53
+ "Contribution" shall mean any work of authorship, including
54
+ the original version of the Work and any modifications or additions
55
+ to that Work or Derivative Works thereof, that is intentionally
56
+ submitted to Licensor for inclusion in the Work by the copyright owner
57
+ or by an individual or Legal Entity authorized to submit on behalf of
58
+ the copyright owner. For the purposes of this definition, "submitted"
59
+ means any form of electronic, verbal, or written communication sent
60
+ to the Licensor or its representatives, including but not limited to
61
+ communication on electronic mailing lists, source code control systems,
62
+ and issue tracking systems that are managed by, or on behalf of, the
63
+ Licensor for the purpose of discussing and improving the Work, but
64
+ excluding communication that is conspicuously marked or otherwise
65
+ designated in writing by the copyright owner as "Not a Contribution."
66
+
67
+ "Contributor" shall mean Licensor and any individual or Legal Entity
68
+ on behalf of whom a Contribution has been received by Licensor and
69
+ subsequently incorporated within the Work.
70
+
71
+ 2. Grant of Copyright License. Subject to the terms and conditions of
72
+ this License, each Contributor hereby grants to You a perpetual,
73
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
74
+ copyright license to reproduce, prepare Derivative Works of,
75
+ publicly display, publicly perform, sublicense, and distribute the
76
+ Work and such Derivative Works in Source or Object form.
77
+
78
+ 3. Grant of Patent License. Subject to the terms and conditions of
79
+ this License, each Contributor hereby grants to You a perpetual,
80
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
81
+ (except as stated in this section) patent license to make, have made,
82
+ use, offer to sell, sell, import, and otherwise transfer the Work,
83
+ where such license applies only to those patent claims licensable
84
+ by such Contributor that are necessarily infringed by their
85
+ Contribution(s) alone or by combination of their Contribution(s)
86
+ with the Work to which such Contribution(s) was submitted. If You
87
+ institute patent litigation against any entity (including a
88
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
89
+ or a Contribution incorporated within the Work constitutes direct
90
+ or contributory patent infringement, then any patent licenses
91
+ granted to You under this License for that Work shall terminate
92
+ as of the date such litigation is filed.
93
+
94
+ 4. Redistribution. You may reproduce and distribute copies of the
95
+ Work or Derivative Works thereof in any medium, with or without
96
+ modifications, and in Source or Object form, provided that You
97
+ meet the following conditions:
98
+
99
+ (a) You must give any other recipients of the Work or
100
+ Derivative Works a copy of this License; and
101
+
102
+ (b) You must cause any modified files to carry prominent notices
103
+ stating that You changed the files; and
104
+
105
+ (c) You must retain, in the Source form of any Derivative Works
106
+ that You distribute, all copyright, patent, trademark, and
107
+ attribution notices from the Source form of the Work,
108
+ excluding those notices that do not pertain to any part of
109
+ the Derivative Works; and
110
+
111
+ (d) If the Work includes a "NOTICE" text file as part of its
112
+ distribution, then any Derivative Works that You distribute must
113
+ include a readable copy of the attribution notices contained
114
+ within such NOTICE file, excluding those notices that do not
115
+ pertain to any part of the Derivative Works, in at least one
116
+ of the following places: within a NOTICE text file distributed
117
+ as part of the Derivative Works; within the Source form or
118
+ documentation, if provided along with the Derivative Works; or,
119
+ within a display generated by the Derivative Works, if and
120
+ wherever such third-party notices normally appear. The contents
121
+ of the NOTICE file are for informational purposes only and
122
+ do not modify the License. You may add Your own attribution
123
+ notices within Derivative Works that You distribute, alongside
124
+ or as an addendum to the NOTICE text from the Work, provided
125
+ that such additional attribution notices cannot be construed
126
+ as modifying the License.
127
+
128
+ You may add Your own copyright statement to Your modifications and
129
+ may provide additional or different license terms and conditions
130
+ for use, reproduction, or distribution of Your modifications, or
131
+ for any such Derivative Works as a whole, provided Your use,
132
+ reproduction, and distribution of the Work otherwise complies with
133
+ the conditions stated in this License.
134
+
135
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
136
+ any Contribution intentionally submitted for inclusion in the Work
137
+ by You to the Licensor shall be under the terms and conditions of
138
+ this License, without any additional terms or conditions.
139
+ Notwithstanding the above, nothing herein shall supersede or modify
140
+ the terms of any separate license agreement you may have executed
141
+ with Licensor regarding such Contributions.
142
+
143
+ 6. Trademarks. This License does not grant permission to use the trade
144
+ names, trademarks, service marks, or product names of the Licensor,
145
+ except as required for reasonable and customary use in describing the
146
+ origin of the Work and reproducing the content of the NOTICE file.
147
+
148
+ 7. Disclaimer of Warranty. Unless required by applicable law or
149
+ agreed to in writing, Licensor provides the Work (and each
150
+ Contributor provides its Contributions) on an "AS IS" BASIS,
151
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
152
+ implied, including, without limitation, any warranties or conditions
153
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
154
+ PARTICULAR PURPOSE. You are solely responsible for determining the
155
+ appropriateness of using or redistributing the Work and assume any
156
+ risks associated with Your exercise of permissions under this License.
157
+
158
+ 8. Limitation of Liability. In no event and under no legal theory,
159
+ whether in tort (including negligence), contract, or otherwise,
160
+ unless required by applicable law (such as deliberate and grossly
161
+ negligent acts) or agreed to in writing, shall any Contributor be
162
+ liable to You for damages, including any direct, indirect, special,
163
+ incidental, or consequential damages of any character arising as a
164
+ result of this License or out of the use or inability to use the
165
+ Work (including but not limited to damages for loss of goodwill,
166
+ work stoppage, computer failure or malfunction, or any and all
167
+ other commercial damages or losses), even if such Contributor
168
+ has been advised of the possibility of such damages.
169
+
170
+ 9. Accepting Warranty or Additional Liability. While redistributing
171
+ the Work or Derivative Works thereof, You may choose to offer,
172
+ and charge a fee for, acceptance of support, warranty, indemnity,
173
+ or other liability obligations and/or rights consistent with this
174
+ License. However, in accepting such obligations, You may act only
175
+ on Your own behalf and on Your sole responsibility, not on behalf
176
+ of any other Contributor, and only if You agree to indemnify,
177
+ defend, and hold each Contributor harmless for any liability
178
+ incurred by, or claims asserted against, such Contributor by reason
179
+ of your accepting any such warranty or additional liability.
180
+
181
+ END OF TERMS AND CONDITIONS
182
+
183
+ APPENDIX: How to apply the Apache License to your work.
184
+
185
+ To apply the Apache License to your work, attach the following
186
+ boilerplate notice, with the fields enclosed by brackets "[]"
187
+ replaced with your own identifying information. (Don't include
188
+ the brackets!) The text should be enclosed in the appropriate
189
+ comment syntax for the file format. We also recommend that a
190
+ file or class name and description of purpose be included on the
191
+ same "printed page" as the copyright notice for easier
192
+ identification within third-party archives.
193
+
194
+ Copyright 2026 Justin Joyce (@joocer)
195
+
196
+ Licensed under the Apache License, Version 2.0 (the "License");
197
+ you may not use this file except in compliance with the License.
198
+ You may obtain a copy of the License at
199
+
200
+ http://www.apache.org/licenses/LICENSE-2.0
201
+
202
+ Unless required by applicable law or agreed to in writing, software
203
+ distributed under the License is distributed on an "AS IS" BASIS,
204
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
205
+ See the License for the specific language governing permissions and
206
+ limitations under the License.
207
+
208
+ Project-URL: Homepage, https://github.com/mabel-dev/opteryx-access
209
+ Classifier: Development Status :: 4 - Beta
210
+ Classifier: Intended Audience :: Developers
211
+ Classifier: License :: OSI Approved :: Apache Software License
212
+ Classifier: Programming Language :: Python :: 3
213
+ Classifier: Programming Language :: Python :: 3 :: Only
214
+ Classifier: Programming Language :: Python :: 3.13
215
+ Classifier: Programming Language :: Python :: 3.14
216
+ Classifier: Operating System :: OS Independent
217
+ Requires-Python: >=3.13
218
+ Description-Content-Type: text/markdown
219
+ License-File: LICENSE
220
+ Provides-Extra: firestore
221
+ Requires-Dist: google-cloud-firestore==2.*; extra == "firestore"
222
+ Provides-Extra: dev
223
+ Requires-Dist: pytest>=8; extra == "dev"
224
+ Requires-Dist: pytest-cov>=5; extra == "dev"
225
+ Requires-Dist: opteryx_access[firestore]; extra == "dev"
226
+ Dynamic: license-file
227
+
228
+ # opteryx-access
229
+
230
+ Permission checks and grant/revoke for the Opteryx platform, as an installable
231
+ library rather than a service. Every consumer imports `opteryx_access` and
232
+ calls it in-process against policies it already has in hand -- a JWT's
233
+ `policies` claim, or a `PolicyStore` backed by whatever it uses for storage
234
+ (Firestore, today). There is no `opteryx-access` HTTP surface, and this
235
+ package makes no network calls of its own beyond what a storage adapter does.
236
+
237
+ ## Why this exists
238
+
239
+ Three independent, subtly incompatible implementations of "does this role
240
+ satisfy this requirement" already exist in the fleet:
241
+
242
+ - **policy.opteryx** / **control.opteryx** (`app/routes/v1/access.py`,
243
+ `app/models/policy.py` -- byte-for-byte duplicated between the two repos):
244
+ a rank-based `ROLES = ("owner", "admin", "writer", "reader")` used to
245
+ decide who may create/update/revoke a policy, and whether a new grant is
246
+ redundant against one the principal already holds.
247
+ - **opteryx-core** (`opteryx/managers/permissions/__init__.py`): a
248
+ set-based `ACTION_MAP` deciding which roles may `READ`/`DELETE`/`DROP`/etc.
249
+ a resource once a query actually runs. `admin` is deliberately absent from
250
+ every entry -- it never grants data access, only grant-management
251
+ authority. This is the piece the rank-based model above cannot replace: a
252
+ naive `owner > admin > writer > reader` comparison would silently hand
253
+ admins data-write access they've never had.
254
+ - **odata.opteryx** (`app/auth/permissions.py`): a binary
255
+ `role_allows_read` used for listing/visibility, plus its own
256
+ `fnmatch.fnmatchcase`-based pattern matcher -- deliberately case-sensitive,
257
+ unlike the plain `fnmatch.fnmatch` used elsewhere, which folds case per-OS.
258
+
259
+ On top of that, `policy.opteryx`/`control.opteryx`/`odata.opteryx`/
260
+ `register.opteryx` each carry their own copy of "parse the `policies` claim
261
+ out of a decoded JWT." Comments in several of these point at an
262
+ `authorize.opteryx` service (`app.routes.v1.evaluate`) as the semantics every
263
+ copy is meant to mirror -- but no such repo exists anywhere in this
264
+ workspace. Whether it's a real service in another org/remote or was never
265
+ built, every consumer today reimplements its own understanding of "role +
266
+ pattern -> allowed" independently, which is exactly the drift this package
267
+ is meant to stop.
268
+
269
+ ## What lives here
270
+
271
+ | Module | Ported from | Purpose |
272
+ |---|---|---|
273
+ | `roles.py` | `policy.opteryx/app/models/policy.py` | The canonical `ROLES` tuple. Two separate notions of "outranks": `ADMINISTRATIVE_ROLES` (owner/admin -- may manage grants) and rank (`ROLE_RANK`, used only for conflict detection). **Not** used to decide data actions. |
274
+ | `actions.py` | `opteryx-core/opteryx/managers/permissions/__init__.py` | `ACTION_ROLES`: which roles may perform `READ`/`WRITE`/`DELETE`/`CREATE`/`DROP`/`ALTER`/`REFRESH`/`MANIFEST`, plus `GRANT`/`REVOKE` (new -- makes policy-administration authority explicit in the same table instead of an implicit rule elsewhere). |
275
+ | `patterns.py` | `policy.opteryx/app/models/policy.py` + `app/routes/v1/access.py` | `resource_matches` (case-sensitive `fnmatchcase` -- see "Behavior changes" below), the wildcard-principal rule, and the reserved-workspace (`public`/`personal`/`information_schema`) rule. |
276
+ | `models.py` | `authenticate.opteryx/app/policies.py` | `Grant` (role+pattern, the JWT-carried shape) and `Policy` (principal+role+pattern+metadata, the stored shape), plus `parse_policy_claim` for the `[role, pattern]` pairs a token carries. |
277
+ | `checks.py` | `opteryx-core`'s `can_perform_action`/`can_perform_workspace_action` + `policy.opteryx`'s `_check_pattern_access`/`_check_workspace_access`/`_check_workspace_owner_access` | The evaluation layer: data-plane checks over `Grant`s, administrative-plane checks over `Policy` documents. |
278
+ | `store.py` | `policy.opteryx/app/routes/v1/access.py`'s `create_policy`/`update_policy`/`delete_policy`/`create_genesis_policies` | Where policies are actually granted, updated, and revoked: the `PolicyStore` protocol plus `grant()`/`update_grant()`/`revoke()`/`bootstrap_workspace()`, which enforce every invariant those routes did (self-grant prevention, pattern-authority, conflict detection, wildcard/reserved-resource validation) against any storage backend. |
279
+ | `adapters/firestore.py` | (new) | `FirestorePolicyStore`, matching the `{workspace}/$policies/access` layout policy.opteryx/control.opteryx already write to -- a drop-in for their inline Firestore calls. |
280
+ | `exceptions.py` | (new) | Plain exceptions (`SelfAccessError`, `AccessDeniedError`, `PolicyConflictError`, ...) instead of `HTTPException` -- each caller translates to its own transport. |
281
+
282
+ ## Two axes, not one rank
283
+
284
+ `admin` sits between `owner` and `writer` on the grant-management axis
285
+ (`ADMINISTRATIVE_ROLES`) but is excluded from every entry in `ACTION_ROLES`.
286
+ That split is real, existing platform behavior (see opteryx-core's
287
+ `ACTION_MAP`), not an oversight this library introduces -- an admin can grant
288
+ and revoke other people's access but cannot themselves `SELECT`/`INSERT`/
289
+ `DELETE` against a resource they don't separately hold `writer`/`owner` on.
290
+ Anything built on top of this package should keep asking the right one of
291
+ the two questions:
292
+
293
+ - "May this identity administer grants on this pattern?" -> `checks.can_administer_pattern`
294
+ - "May this role perform this SQL-shaped action on this resource?" -> `checks.can_perform_action`
295
+
296
+ ## Usage
297
+
298
+ ```python
299
+ from opteryx_access import Grant, can_perform_action
300
+
301
+ grants = [Grant(role="writer", pattern="analytics.sales.*")]
302
+ can_perform_action(grants, "analytics.sales.q1", "DELETE") # True
303
+ can_perform_action(grants, "analytics.sales.q1", "DROP") # False -- writer, not owner
304
+ ```
305
+
306
+ ```python
307
+ from opteryx_access import grant, revoke, AccessDeniedError
308
+ from opteryx_access.adapters.firestore import FirestorePolicyStore
309
+
310
+ store = FirestorePolicyStore(db) # db: google.cloud.firestore.Client
311
+ try:
312
+ policy_id = grant(
313
+ store, actor="alice", workspace="analytics",
314
+ principal="bob", role="writer", pattern="analytics.sales.*",
315
+ )
316
+ except AccessDeniedError:
317
+ ... # translate to a 403, same as the route used to do inline
318
+ ```
319
+
320
+ ## Behavior changes from the ported originals
321
+
322
+ Ported faithfully except for one deliberate fix, worth calling out before
323
+ anything is cut over:
324
+
325
+ - **`resource_matches` uses `fnmatch.fnmatchcase`, not `fnmatch.fnmatch`.**
326
+ `policy.opteryx`/`control.opteryx`/opteryx-core's data-action check all use
327
+ plain `fnmatch`, which folds case per the OS Python runs on -- the same
328
+ policy would decide differently on macOS versus Linux. opteryx-core's own
329
+ `can_perform_action` already avoids `fnmatch` for exactly this reason when
330
+ matching its hardcoded implicit policies. odata.opteryx already uses
331
+ `fnmatchcase` for its read check. This package standardizes on the
332
+ deterministic, already-precedented behavior. If any live policy pattern
333
+ relies on the OS case-folding today, cutting a service over to this
334
+ package will change what that specific pattern matches -- worth an audit
335
+ of stored patterns before cutover, not assumed to be a no-op.
336
+
337
+ ## Suggested migration (not yet done)
338
+
339
+ This repo is the library only -- nothing outside it has been changed yet.
340
+ Suggested order, each independently shippable:
341
+
342
+ 1. **opteryx-core**: replace `opteryx/managers/permissions/__init__.py`'s
343
+ `ACTION_MAP`/`can_perform_action`/`can_perform_workspace_action`/
344
+ `implicit_policies` with thin wrappers around `opteryx_access.actions`/
345
+ `opteryx_access.checks` (converting `ExecutionContext.access_policies`
346
+ dicts to `Grant`s at the boundary). Zero new dependencies -- this package
347
+ has none by default.
348
+ 2. **odata.opteryx**: replace `app/auth/permissions.py`'s
349
+ `role_allows_read`/`read_grant_for_relation`/pattern matching with
350
+ `opteryx_access.checks.can_perform_action` (action="READ"). Leaves
351
+ `entitlements_from_claims`/`billing_account_from_claims` alone -- those
352
+ are a different concern (entitlements/billing), not permissions.
353
+ 3. **policy.opteryx** and **control.opteryx**: thin `app/routes/v1/access.py`
354
+ down to request parsing, calling `opteryx_access.store.grant`/
355
+ `update_grant`/`revoke`/`bootstrap_workspace` via `FirestorePolicyStore`,
356
+ and mapping the typed exceptions to `HTTPException`. The
357
+ resource-existence check (`_resource_exists`), user-status lookup
358
+ (`_lookup_user_record`), age gate, and audit logging all stay where they
359
+ are -- see `store.py`'s module docstring for why those are out of scope
360
+ here. Given `control.opteryx` is the in-progress merge target for
361
+ `policy.opteryx` (see its `docs/design/consolidation.md`), do this once,
362
+ on `control.opteryx`, and let the `policy.opteryx` cutover carry it along
363
+ rather than porting both routes separately.
364
+ 4. **register.opteryx** and any other claims-parsing copy: swap to
365
+ `opteryx_access.models.parse_policy_claim` for the `policies` claim
366
+ specifically. Token *verification* (signature, issuer, JWKS) stays
367
+ service-specific -- this package has no opinion on how a JWT gets from
368
+ bytes to a trusted claims dict, only on what to do with the `policies`
369
+ claim once you have one.
370
+
371
+ ## Installing
372
+
373
+ ```
374
+ pip install opteryx_access
375
+ pip install "opteryx_access[firestore]" # for adapters.firestore
376
+ ```
377
+
378
+ No hard dependencies. `google-cloud-firestore` is an optional extra;
379
+ `adapters/firestore.py` never imports it at all (it's duck-typed against
380
+ whatever `db` object it's handed), so importing `opteryx_access` itself never
381
+ requires it -- consistent with opteryx-core's zero-dependency convention.
382
+
383
+ ## CI/CD
384
+
385
+ - `.github/workflows/tests.yaml` -- pytest (3.13, 3.14) + ruff lint/format,
386
+ on every push to `main` and every PR.
387
+ - `.github/workflows/release.yaml` -- on a pushed tag matching `version-*`:
388
+ runs the full test workflow, checks the tag matches `pyproject.toml`'s
389
+ `version` (exactly, or with a `.`-delimited suffix), then builds and
390
+ publishes to PyPI via
391
+ [trusted publishing](https://docs.pypi.org/trusted-publishers/) (OIDC --
392
+ no stored API token). The `opteryx_access` PyPI project needs this repo +
393
+ the `release.yaml` workflow registered as a trusted publisher before the
394
+ first tag push, or the publish step will fail with no valid credentials.
395
+
396
+ To cut a release: bump `version` in `pyproject.toml`, merge to `main`, then
397
+ `git tag version-X.Y.Z && git push origin version-X.Y.Z`.
398
+
399
+ ## License
400
+
401
+ Apache 2.0. See [LICENSE](LICENSE) for details.