ayes 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.
- ayes-0.0.1/.github/workflows/ci.yml +27 -0
- ayes-0.0.1/.gitignore +15 -0
- ayes-0.0.1/.python-version +1 -0
- ayes-0.0.1/CHANGELOG.md +5 -0
- ayes-0.0.1/LICENSE +202 -0
- ayes-0.0.1/NOTICE +4 -0
- ayes-0.0.1/PKG-INFO +184 -0
- ayes-0.0.1/README.md +159 -0
- ayes-0.0.1/pyproject.toml +63 -0
- ayes-0.0.1/src/ayes/__init__.py +8 -0
- ayes-0.0.1/src/ayes/py.typed +0 -0
- ayes-0.0.1/tests/test_package.py +5 -0
- ayes-0.0.1/uv.lock +695 -0
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
|
|
8
|
+
permissions:
|
|
9
|
+
contents: read
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
check:
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
strategy:
|
|
15
|
+
fail-fast: false
|
|
16
|
+
matrix:
|
|
17
|
+
python: ["3.11", "3.12", "3.13", "3.14"]
|
|
18
|
+
steps:
|
|
19
|
+
- uses: actions/checkout@v4
|
|
20
|
+
- uses: astral-sh/setup-uv@v5
|
|
21
|
+
with:
|
|
22
|
+
python-version: ${{ matrix.python }}
|
|
23
|
+
- run: uv sync --group dev
|
|
24
|
+
- run: uv run ruff check .
|
|
25
|
+
- run: uv run ruff format --check .
|
|
26
|
+
- run: uv run mypy
|
|
27
|
+
- run: uv run pytest
|
ayes-0.0.1/.gitignore
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
3.14
|
ayes-0.0.1/CHANGELOG.md
ADDED
ayes-0.0.1/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
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 [yyyy] [name of copyright owner]
|
|
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.
|
|
202
|
+
|
ayes-0.0.1/NOTICE
ADDED
ayes-0.0.1/PKG-INFO
ADDED
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: ayes
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: Pundit-style authorization policies for Python web apps.
|
|
5
|
+
Author: API-Air
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
License-File: LICENSE
|
|
8
|
+
License-File: NOTICE
|
|
9
|
+
Keywords: authorization,fastapi,multi-tenant,permissions,policy,pundit
|
|
10
|
+
Classifier: Development Status :: 1 - Planning
|
|
11
|
+
Classifier: Framework :: FastAPI
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Operating System :: OS Independent
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
19
|
+
Classifier: Topic :: Security
|
|
20
|
+
Classifier: Typing :: Typed
|
|
21
|
+
Requires-Python: >=3.11
|
|
22
|
+
Provides-Extra: fastapi
|
|
23
|
+
Requires-Dist: fastapi>=0.115; extra == 'fastapi'
|
|
24
|
+
Description-Content-Type: text/markdown
|
|
25
|
+
|
|
26
|
+
# Ayes
|
|
27
|
+
|
|
28
|
+
**Pundit-style authorization policies for Python web apps.** FastAPI first.
|
|
29
|
+
|
|
30
|
+
*The ayes have it:* every action your app allows has been voted through by a policy.
|
|
31
|
+
|
|
32
|
+
> Status: **pre-alpha, design phase.** Nothing below is implemented yet. The API sketched here is a
|
|
33
|
+
> proposal, open to change.
|
|
34
|
+
|
|
35
|
+
Ayes answers one question, everywhere in your app, the same way:
|
|
36
|
+
|
|
37
|
+
> *May this user do this action on this object?*
|
|
38
|
+
|
|
39
|
+
Authentication tells you **who** is calling. Ayes decides **what they may do**. It does this with
|
|
40
|
+
plain Python policy classes, one per kind of object, the way Ruby's Pundit does. Then it checks
|
|
41
|
+
that every route actually asks.
|
|
42
|
+
|
|
43
|
+
## Why
|
|
44
|
+
|
|
45
|
+
FastAPI deliberately ships no authorization layer. OAuth2 scopes answer "may this token write
|
|
46
|
+
invoices?", not "may this user edit *this* invoice?". So most apps grow access checks inline,
|
|
47
|
+
route by route. Each route recombines the rules a little differently, and the gaps look alike:
|
|
48
|
+
|
|
49
|
+
- an object reachable from another tenant because two checks were made separately and never
|
|
50
|
+
compared;
|
|
51
|
+
- three code paths for the same action, and only two of them apply the rule;
|
|
52
|
+
- the same refusal answered 403 here, 404 there, 422 elsewhere, leaking whether an object exists.
|
|
53
|
+
|
|
54
|
+
Ayes' goal is to make those mistakes hard to write and easy to catch.
|
|
55
|
+
|
|
56
|
+
## Principles
|
|
57
|
+
|
|
58
|
+
1. **One policy per object, plain Python.** A class with one method per action. No DSL to learn.
|
|
59
|
+
2. **Explicit, not magic.** The route names its policy and its action. Nothing is inferred from
|
|
60
|
+
class or function names.
|
|
61
|
+
3. **Authorize the object, then hand it over.** The FastAPI dependency loads the object, checks it,
|
|
62
|
+
and gives the route the *authorized* object. The route can't load a different one by mistake.
|
|
63
|
+
4. **Tenancy is an invariant, not a rule you remember.** If your app is multi-tenant, "same tenant"
|
|
64
|
+
is checked once, before any policy runs.
|
|
65
|
+
5. **Normalized refusals.** Out of scope → 404 (never confirm an object exists). In scope, not
|
|
66
|
+
allowed → 403. Allowed, but the object's state forbids it → 409.
|
|
67
|
+
6. **Scopes for lists.** A policy also says which rows a user may list, as a query filter.
|
|
68
|
+
7. **Async first.** Policies often need the database. The user's context (tenants, roles) is loaded
|
|
69
|
+
once per request, not once per check.
|
|
70
|
+
8. **The rules are a table, and the table is tested.** You declare who may do what. Ayes generates
|
|
71
|
+
the test cases from that declaration.
|
|
72
|
+
9. **No route left behind.** A test inspects every route and fails if one doesn't go through a
|
|
73
|
+
policy (with an explicit allow-list for public routes).
|
|
74
|
+
|
|
75
|
+
## API sketch (draft)
|
|
76
|
+
|
|
77
|
+
A multi-tenant publishing tool: each workspace is a tenant, and holds articles. In a workspace, a
|
|
78
|
+
person is an `admin`, an `editor` or a `user`. Users write drafts; editors edit and publish;
|
|
79
|
+
admins can also delete.
|
|
80
|
+
|
|
81
|
+
```python
|
|
82
|
+
from ayes import Policy, Refused
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
class ArticlePolicy(Policy[Article]):
|
|
86
|
+
def tenant_of(self, article: Article) -> UUID:
|
|
87
|
+
return article.workspace_id
|
|
88
|
+
|
|
89
|
+
async def view(self) -> bool:
|
|
90
|
+
return (
|
|
91
|
+
self.obj.is_published or self.role in {"admin", "editor"} or self.is_author
|
|
92
|
+
)
|
|
93
|
+
|
|
94
|
+
async def update(self) -> bool:
|
|
95
|
+
return self.role in {"admin", "editor"} or (
|
|
96
|
+
self.is_author and self.obj.is_draft
|
|
97
|
+
)
|
|
98
|
+
|
|
99
|
+
async def publish(self) -> bool:
|
|
100
|
+
return self.role in {"admin", "editor"}
|
|
101
|
+
|
|
102
|
+
async def delete(self) -> bool:
|
|
103
|
+
if self.obj.is_under_legal_hold:
|
|
104
|
+
raise Refused.state("article_under_legal_hold") # → 409
|
|
105
|
+
return self.role == "admin"
|
|
106
|
+
|
|
107
|
+
@property
|
|
108
|
+
def is_author(self) -> bool:
|
|
109
|
+
return self.obj.author_id == self.user.id
|
|
110
|
+
|
|
111
|
+
@classmethod
|
|
112
|
+
def scope(cls, user: Context) -> ColumnElement[bool]:
|
|
113
|
+
return Article.workspace_id.in_(user.workspace_ids)
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
In a FastAPI route:
|
|
117
|
+
|
|
118
|
+
```python
|
|
119
|
+
from ayes.fastapi import authorize
|
|
120
|
+
|
|
121
|
+
CanUpdate = Depends(authorize(ArticlePolicy, "update", load=get_article))
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
@router.patch("/articles/{article_id}")
|
|
125
|
+
async def update_article(
|
|
126
|
+
article: Annotated[Article, CanUpdate],
|
|
127
|
+
payload: ArticleUpdate,
|
|
128
|
+
):
|
|
129
|
+
# No access checks here: `article` is already authorized.
|
|
130
|
+
...
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
Declaring the rules, and getting the tests:
|
|
134
|
+
|
|
135
|
+
```python
|
|
136
|
+
from ayes.testing import Matrix
|
|
137
|
+
|
|
138
|
+
matrix = Matrix(
|
|
139
|
+
ArticlePolicy,
|
|
140
|
+
roles=["admin", "editor", "user", "outsider"],
|
|
141
|
+
rules={
|
|
142
|
+
"update": ["admin", "editor"],
|
|
143
|
+
"publish": ["admin", "editor"],
|
|
144
|
+
"delete": ["admin"],
|
|
145
|
+
},
|
|
146
|
+
)
|
|
147
|
+
|
|
148
|
+
# One test per role × action, plus the cross-tenant case.
|
|
149
|
+
test_article_policy = matrix.pytest()
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
Checking coverage:
|
|
153
|
+
|
|
154
|
+
```python
|
|
155
|
+
from ayes.testing import assert_all_routes_authorized
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
def test_every_route_is_authorized():
|
|
159
|
+
assert_all_routes_authorized(app, public={"/health", "/auth/login"})
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
## Coming from Pundit
|
|
163
|
+
|
|
164
|
+
| Pundit (Rails) | Ayes |
|
|
165
|
+
|---|---|
|
|
166
|
+
| `PostPolicy#update?` | `PostPolicy.update()`, async |
|
|
167
|
+
| `authorize @post` | `Depends(authorize(PostPolicy, "update", load=...))`, returns the post |
|
|
168
|
+
| `policy_scope(Post)` | `PostPolicy.scope(user)`, a SQL filter |
|
|
169
|
+
| `verify_authorized` | `assert_all_routes_authorized(app)`, in CI rather than at runtime |
|
|
170
|
+
| `rescue_from Pundit::NotAuthorizedError` | one exception handler mapping refusals to 404 / 403 / 409 |
|
|
171
|
+
| `permitted_attributes` | fields allowed per action, checked against the request model |
|
|
172
|
+
|
|
173
|
+
## Roadmap
|
|
174
|
+
|
|
175
|
+
- **0.1** — core: `Policy`, request context, tenant invariant, normalized refusals, FastAPI
|
|
176
|
+
`authorize` dependency, list scopes.
|
|
177
|
+
- **0.2** — testing: declared rule matrix → generated tests; route coverage check (report mode,
|
|
178
|
+
then blocking).
|
|
179
|
+
- **0.3** — permitted fields; SQLAlchemy helpers.
|
|
180
|
+
- Later — Django and Flask integrations, if the core holds up.
|
|
181
|
+
|
|
182
|
+
## License
|
|
183
|
+
|
|
184
|
+
Apache-2.0. See `LICENSE` and `NOTICE`.
|
ayes-0.0.1/README.md
ADDED
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
# Ayes
|
|
2
|
+
|
|
3
|
+
**Pundit-style authorization policies for Python web apps.** FastAPI first.
|
|
4
|
+
|
|
5
|
+
*The ayes have it:* every action your app allows has been voted through by a policy.
|
|
6
|
+
|
|
7
|
+
> Status: **pre-alpha, design phase.** Nothing below is implemented yet. The API sketched here is a
|
|
8
|
+
> proposal, open to change.
|
|
9
|
+
|
|
10
|
+
Ayes answers one question, everywhere in your app, the same way:
|
|
11
|
+
|
|
12
|
+
> *May this user do this action on this object?*
|
|
13
|
+
|
|
14
|
+
Authentication tells you **who** is calling. Ayes decides **what they may do**. It does this with
|
|
15
|
+
plain Python policy classes, one per kind of object, the way Ruby's Pundit does. Then it checks
|
|
16
|
+
that every route actually asks.
|
|
17
|
+
|
|
18
|
+
## Why
|
|
19
|
+
|
|
20
|
+
FastAPI deliberately ships no authorization layer. OAuth2 scopes answer "may this token write
|
|
21
|
+
invoices?", not "may this user edit *this* invoice?". So most apps grow access checks inline,
|
|
22
|
+
route by route. Each route recombines the rules a little differently, and the gaps look alike:
|
|
23
|
+
|
|
24
|
+
- an object reachable from another tenant because two checks were made separately and never
|
|
25
|
+
compared;
|
|
26
|
+
- three code paths for the same action, and only two of them apply the rule;
|
|
27
|
+
- the same refusal answered 403 here, 404 there, 422 elsewhere, leaking whether an object exists.
|
|
28
|
+
|
|
29
|
+
Ayes' goal is to make those mistakes hard to write and easy to catch.
|
|
30
|
+
|
|
31
|
+
## Principles
|
|
32
|
+
|
|
33
|
+
1. **One policy per object, plain Python.** A class with one method per action. No DSL to learn.
|
|
34
|
+
2. **Explicit, not magic.** The route names its policy and its action. Nothing is inferred from
|
|
35
|
+
class or function names.
|
|
36
|
+
3. **Authorize the object, then hand it over.** The FastAPI dependency loads the object, checks it,
|
|
37
|
+
and gives the route the *authorized* object. The route can't load a different one by mistake.
|
|
38
|
+
4. **Tenancy is an invariant, not a rule you remember.** If your app is multi-tenant, "same tenant"
|
|
39
|
+
is checked once, before any policy runs.
|
|
40
|
+
5. **Normalized refusals.** Out of scope → 404 (never confirm an object exists). In scope, not
|
|
41
|
+
allowed → 403. Allowed, but the object's state forbids it → 409.
|
|
42
|
+
6. **Scopes for lists.** A policy also says which rows a user may list, as a query filter.
|
|
43
|
+
7. **Async first.** Policies often need the database. The user's context (tenants, roles) is loaded
|
|
44
|
+
once per request, not once per check.
|
|
45
|
+
8. **The rules are a table, and the table is tested.** You declare who may do what. Ayes generates
|
|
46
|
+
the test cases from that declaration.
|
|
47
|
+
9. **No route left behind.** A test inspects every route and fails if one doesn't go through a
|
|
48
|
+
policy (with an explicit allow-list for public routes).
|
|
49
|
+
|
|
50
|
+
## API sketch (draft)
|
|
51
|
+
|
|
52
|
+
A multi-tenant publishing tool: each workspace is a tenant, and holds articles. In a workspace, a
|
|
53
|
+
person is an `admin`, an `editor` or a `user`. Users write drafts; editors edit and publish;
|
|
54
|
+
admins can also delete.
|
|
55
|
+
|
|
56
|
+
```python
|
|
57
|
+
from ayes import Policy, Refused
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
class ArticlePolicy(Policy[Article]):
|
|
61
|
+
def tenant_of(self, article: Article) -> UUID:
|
|
62
|
+
return article.workspace_id
|
|
63
|
+
|
|
64
|
+
async def view(self) -> bool:
|
|
65
|
+
return (
|
|
66
|
+
self.obj.is_published or self.role in {"admin", "editor"} or self.is_author
|
|
67
|
+
)
|
|
68
|
+
|
|
69
|
+
async def update(self) -> bool:
|
|
70
|
+
return self.role in {"admin", "editor"} or (
|
|
71
|
+
self.is_author and self.obj.is_draft
|
|
72
|
+
)
|
|
73
|
+
|
|
74
|
+
async def publish(self) -> bool:
|
|
75
|
+
return self.role in {"admin", "editor"}
|
|
76
|
+
|
|
77
|
+
async def delete(self) -> bool:
|
|
78
|
+
if self.obj.is_under_legal_hold:
|
|
79
|
+
raise Refused.state("article_under_legal_hold") # → 409
|
|
80
|
+
return self.role == "admin"
|
|
81
|
+
|
|
82
|
+
@property
|
|
83
|
+
def is_author(self) -> bool:
|
|
84
|
+
return self.obj.author_id == self.user.id
|
|
85
|
+
|
|
86
|
+
@classmethod
|
|
87
|
+
def scope(cls, user: Context) -> ColumnElement[bool]:
|
|
88
|
+
return Article.workspace_id.in_(user.workspace_ids)
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
In a FastAPI route:
|
|
92
|
+
|
|
93
|
+
```python
|
|
94
|
+
from ayes.fastapi import authorize
|
|
95
|
+
|
|
96
|
+
CanUpdate = Depends(authorize(ArticlePolicy, "update", load=get_article))
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
@router.patch("/articles/{article_id}")
|
|
100
|
+
async def update_article(
|
|
101
|
+
article: Annotated[Article, CanUpdate],
|
|
102
|
+
payload: ArticleUpdate,
|
|
103
|
+
):
|
|
104
|
+
# No access checks here: `article` is already authorized.
|
|
105
|
+
...
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Declaring the rules, and getting the tests:
|
|
109
|
+
|
|
110
|
+
```python
|
|
111
|
+
from ayes.testing import Matrix
|
|
112
|
+
|
|
113
|
+
matrix = Matrix(
|
|
114
|
+
ArticlePolicy,
|
|
115
|
+
roles=["admin", "editor", "user", "outsider"],
|
|
116
|
+
rules={
|
|
117
|
+
"update": ["admin", "editor"],
|
|
118
|
+
"publish": ["admin", "editor"],
|
|
119
|
+
"delete": ["admin"],
|
|
120
|
+
},
|
|
121
|
+
)
|
|
122
|
+
|
|
123
|
+
# One test per role × action, plus the cross-tenant case.
|
|
124
|
+
test_article_policy = matrix.pytest()
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
Checking coverage:
|
|
128
|
+
|
|
129
|
+
```python
|
|
130
|
+
from ayes.testing import assert_all_routes_authorized
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
def test_every_route_is_authorized():
|
|
134
|
+
assert_all_routes_authorized(app, public={"/health", "/auth/login"})
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
## Coming from Pundit
|
|
138
|
+
|
|
139
|
+
| Pundit (Rails) | Ayes |
|
|
140
|
+
|---|---|
|
|
141
|
+
| `PostPolicy#update?` | `PostPolicy.update()`, async |
|
|
142
|
+
| `authorize @post` | `Depends(authorize(PostPolicy, "update", load=...))`, returns the post |
|
|
143
|
+
| `policy_scope(Post)` | `PostPolicy.scope(user)`, a SQL filter |
|
|
144
|
+
| `verify_authorized` | `assert_all_routes_authorized(app)`, in CI rather than at runtime |
|
|
145
|
+
| `rescue_from Pundit::NotAuthorizedError` | one exception handler mapping refusals to 404 / 403 / 409 |
|
|
146
|
+
| `permitted_attributes` | fields allowed per action, checked against the request model |
|
|
147
|
+
|
|
148
|
+
## Roadmap
|
|
149
|
+
|
|
150
|
+
- **0.1** — core: `Policy`, request context, tenant invariant, normalized refusals, FastAPI
|
|
151
|
+
`authorize` dependency, list scopes.
|
|
152
|
+
- **0.2** — testing: declared rule matrix → generated tests; route coverage check (report mode,
|
|
153
|
+
then blocking).
|
|
154
|
+
- **0.3** — permitted fields; SQLAlchemy helpers.
|
|
155
|
+
- Later — Django and Flask integrations, if the core holds up.
|
|
156
|
+
|
|
157
|
+
## License
|
|
158
|
+
|
|
159
|
+
Apache-2.0. See `LICENSE` and `NOTICE`.
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling>=1.25"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "ayes"
|
|
7
|
+
version = "0.0.1"
|
|
8
|
+
description = "Pundit-style authorization policies for Python web apps."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = "Apache-2.0"
|
|
11
|
+
license-files = ["LICENSE", "NOTICE"]
|
|
12
|
+
requires-python = ">=3.11"
|
|
13
|
+
authors = [{ name = "API-Air" }]
|
|
14
|
+
keywords = ["authorization", "policy", "permissions", "fastapi", "multi-tenant", "pundit"]
|
|
15
|
+
classifiers = [
|
|
16
|
+
"Development Status :: 1 - Planning",
|
|
17
|
+
"Framework :: FastAPI",
|
|
18
|
+
"Intended Audience :: Developers",
|
|
19
|
+
"Operating System :: OS Independent",
|
|
20
|
+
"Programming Language :: Python :: 3",
|
|
21
|
+
"Programming Language :: Python :: 3.11",
|
|
22
|
+
"Programming Language :: Python :: 3.12",
|
|
23
|
+
"Programming Language :: Python :: 3.13",
|
|
24
|
+
"Programming Language :: Python :: 3.14",
|
|
25
|
+
"Topic :: Security",
|
|
26
|
+
"Typing :: Typed",
|
|
27
|
+
]
|
|
28
|
+
# The core has no runtime dependency. Framework integrations are optional extras.
|
|
29
|
+
dependencies = []
|
|
30
|
+
|
|
31
|
+
[project.optional-dependencies]
|
|
32
|
+
fastapi = ["fastapi>=0.115"]
|
|
33
|
+
|
|
34
|
+
[dependency-groups]
|
|
35
|
+
dev = [
|
|
36
|
+
"pytest>=8.3",
|
|
37
|
+
"pytest-asyncio>=0.25",
|
|
38
|
+
"httpx>=0.28",
|
|
39
|
+
"fastapi>=0.115",
|
|
40
|
+
"ruff>=0.11",
|
|
41
|
+
"mypy>=1.15",
|
|
42
|
+
]
|
|
43
|
+
|
|
44
|
+
[tool.hatch.build.targets.wheel]
|
|
45
|
+
packages = ["src/ayes"]
|
|
46
|
+
|
|
47
|
+
[tool.pytest.ini_options]
|
|
48
|
+
testpaths = ["tests"]
|
|
49
|
+
asyncio_mode = "auto"
|
|
50
|
+
asyncio_default_fixture_loop_scope = "function"
|
|
51
|
+
|
|
52
|
+
[tool.ruff]
|
|
53
|
+
line-length = 88
|
|
54
|
+
target-version = "py311"
|
|
55
|
+
|
|
56
|
+
[tool.ruff.lint]
|
|
57
|
+
select = ["E", "F", "I", "B", "UP", "SIM", "RUF"]
|
|
58
|
+
|
|
59
|
+
[tool.mypy]
|
|
60
|
+
python_version = "3.11"
|
|
61
|
+
strict = true
|
|
62
|
+
packages = ["ayes"]
|
|
63
|
+
mypy_path = "src"
|
|
File without changes
|