fastapi-verified-permissions 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.
- fastapi_verified_permissions-0.1.0/.github/workflows/publish.yml +40 -0
- fastapi_verified_permissions-0.1.0/.github/workflows/test.yml +47 -0
- fastapi_verified_permissions-0.1.0/.gitignore +6 -0
- fastapi_verified_permissions-0.1.0/LICENSE +202 -0
- fastapi_verified_permissions-0.1.0/PKG-INFO +107 -0
- fastapi_verified_permissions-0.1.0/README.ja.md +95 -0
- fastapi_verified_permissions-0.1.0/README.md +95 -0
- fastapi_verified_permissions-0.1.0/docs/aws-architecture.drawio +100 -0
- fastapi_verified_permissions-0.1.0/docs/aws-architecture.png +0 -0
- fastapi_verified_permissions-0.1.0/examples/documents.py +25 -0
- fastapi_verified_permissions-0.1.0/integration/test_emulator.py +153 -0
- fastapi_verified_permissions-0.1.0/pyproject.toml +22 -0
- fastapi_verified_permissions-0.1.0/src/fastapi_verified_permissions/__init__.py +5 -0
- fastapi_verified_permissions-0.1.0/src/fastapi_verified_permissions/authorization.py +142 -0
- fastapi_verified_permissions-0.1.0/src/fastapi_verified_permissions/py.typed +0 -0
- fastapi_verified_permissions-0.1.0/tests/test_dependencies.py +138 -0
- fastapi_verified_permissions-0.1.0/uv.lock +486 -0
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
name: Publish to PyPI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
workflow_dispatch:
|
|
5
|
+
|
|
6
|
+
permissions: {}
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
build:
|
|
10
|
+
if: startsWith(github.ref, 'refs/tags/v')
|
|
11
|
+
runs-on: ubuntu-24.04
|
|
12
|
+
permissions:
|
|
13
|
+
contents: read
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v6
|
|
16
|
+
- uses: actions/setup-python@v6
|
|
17
|
+
with:
|
|
18
|
+
python-version: '3.13'
|
|
19
|
+
- run: python -m pip install uv==0.13.6
|
|
20
|
+
- name: Check tag against package version
|
|
21
|
+
run: python -c 'import os, tomllib; assert "v" + tomllib.load(open("pyproject.toml", "rb"))["project"]["version"] == os.environ["GITHUB_REF_NAME"]'
|
|
22
|
+
- run: uv sync --locked
|
|
23
|
+
- run: uv run --frozen pytest -q
|
|
24
|
+
- run: uv build
|
|
25
|
+
- uses: actions/upload-artifact@v4
|
|
26
|
+
with:
|
|
27
|
+
name: distributions
|
|
28
|
+
path: dist/
|
|
29
|
+
publish:
|
|
30
|
+
needs: build
|
|
31
|
+
runs-on: ubuntu-24.04
|
|
32
|
+
environment: pypi
|
|
33
|
+
permissions:
|
|
34
|
+
id-token: write
|
|
35
|
+
steps:
|
|
36
|
+
- uses: actions/download-artifact@v4
|
|
37
|
+
with:
|
|
38
|
+
name: distributions
|
|
39
|
+
path: dist/
|
|
40
|
+
- uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
name: Test
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
|
|
8
|
+
permissions:
|
|
9
|
+
contents: read
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
test:
|
|
13
|
+
strategy:
|
|
14
|
+
matrix:
|
|
15
|
+
python: ['3.11', '3.13']
|
|
16
|
+
runs-on: ubuntu-24.04
|
|
17
|
+
timeout-minutes: 10
|
|
18
|
+
steps:
|
|
19
|
+
- uses: actions/checkout@v6
|
|
20
|
+
- uses: actions/setup-python@v6
|
|
21
|
+
with:
|
|
22
|
+
python-version: ${{ matrix.python }}
|
|
23
|
+
- run: python -m pip install uv==0.13.6
|
|
24
|
+
- run: uv sync --locked --python "${{ matrix.python }}"
|
|
25
|
+
- run: uv run --frozen pytest -q
|
|
26
|
+
- run: uv build
|
|
27
|
+
- name: Install AWS Emulator
|
|
28
|
+
run: |
|
|
29
|
+
curl --fail --silent --show-error --location --retry 3 \
|
|
30
|
+
https://downloads.aws.com/aws-emulator/packages/aws-emulator/LTS/aws-emulator_1.0.385-1_amd64.deb \
|
|
31
|
+
--output "$RUNNER_TEMP/aws-emulator.deb"
|
|
32
|
+
sudo dpkg -i "$RUNNER_TEMP/aws-emulator.deb"
|
|
33
|
+
- name: Run emulator integration tests
|
|
34
|
+
run: |
|
|
35
|
+
aws-emulator --telemetry off > "$RUNNER_TEMP/emulator.log" 2>&1 &
|
|
36
|
+
emulator_pid=$!
|
|
37
|
+
trap 'kill "$emulator_pid" 2>/dev/null || true' EXIT
|
|
38
|
+
for attempt in {1..30}; do
|
|
39
|
+
if curl -fsS --max-time 2 --cacert "$HOME/.aws/emulator/9297/ca.pem" \
|
|
40
|
+
https://127.0.0.1:9297/__admin/health > /dev/null 2>&1; then
|
|
41
|
+
uv run --frozen pytest -q integration/test_emulator.py
|
|
42
|
+
exit 0
|
|
43
|
+
fi
|
|
44
|
+
sleep 1
|
|
45
|
+
done
|
|
46
|
+
cat "$RUNNER_TEMP/emulator.log"
|
|
47
|
+
exit 1
|
|
@@ -0,0 +1,202 @@
|
|
|
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
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: fastapi-verified-permissions
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Route authorization for FastAPI with Amazon Verified Permissions
|
|
5
|
+
Project-URL: Repository, https://github.com/yuu551/fastapi-verified-permissions
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
License-File: LICENSE
|
|
8
|
+
Requires-Python: >=3.11
|
|
9
|
+
Requires-Dist: boto3<2,>=1.43
|
|
10
|
+
Requires-Dist: fastapi<1,>=0.121
|
|
11
|
+
Description-Content-Type: text/markdown
|
|
12
|
+
|
|
13
|
+
# fastapi-verified-permissions
|
|
14
|
+
|
|
15
|
+
English · [日本語](https://github.com/yuu551/fastapi-verified-permissions/blob/v0.1.0/README.ja.md)
|
|
16
|
+
|
|
17
|
+
Protect individual FastAPI routes with [Amazon Verified Permissions](https://aws.amazon.com/verified-permissions/). Declare an action and a resource dependency, then add the resulting dependency to a route with `Depends()`. Boto3 makes the authorization request in a synchronous FastAPI dependency, so an async route can use the same API.
|
|
18
|
+
|
|
19
|
+
## Install
|
|
20
|
+
|
|
21
|
+
Requires Python 3.11 or later. To install the GitHub release in a uv project, run
|
|
22
|
+
|
|
23
|
+
```sh
|
|
24
|
+
uv add "fastapi-verified-permissions @ git+https://github.com/yuu551/fastapi-verified-permissions.git@v0.1.0"
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
For pip, run
|
|
28
|
+
|
|
29
|
+
```sh
|
|
30
|
+
pip install "fastapi-verified-permissions @ git+https://github.com/yuu551/fastapi-verified-permissions.git@v0.1.0"
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Once the first release is available on PyPI, install by name with `uv add fastapi-verified-permissions` or `pip install fastapi-verified-permissions`.
|
|
34
|
+
|
|
35
|
+
## Protect a document endpoint
|
|
36
|
+
|
|
37
|
+
Register the Cognito user pool or OIDC provider as an identity source for your policy store. Set `POLICY_STORE_ID`, configure the AWS region and credentials for Boto3, and grant the application role `verifiedpermissions:IsAuthorizedWithToken` on the store.
|
|
38
|
+
|
|
39
|
+
```python
|
|
40
|
+
import os
|
|
41
|
+
|
|
42
|
+
from fastapi import Depends, FastAPI
|
|
43
|
+
from fastapi_verified_permissions import Authorization, Entity, VerifiedPermissions
|
|
44
|
+
|
|
45
|
+
app = FastAPI()
|
|
46
|
+
avp = VerifiedPermissions(os.environ["POLICY_STORE_ID"])
|
|
47
|
+
|
|
48
|
+
def document(document_id: str) -> Entity:
|
|
49
|
+
return Entity("Demo::Document", document_id)
|
|
50
|
+
|
|
51
|
+
can_read = avp.require(
|
|
52
|
+
action=Entity("Demo::Action", "view"),
|
|
53
|
+
resource=document,
|
|
54
|
+
token="accessToken",
|
|
55
|
+
)
|
|
56
|
+
|
|
57
|
+
@app.get("/documents/{document_id}")
|
|
58
|
+
async def read_document(document_id: str, permit: Authorization = Depends(can_read)):
|
|
59
|
+
return {"document": document_id, "reader": permit.principal.id}
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
The client sends `Authorization: Bearer <token>`. Verified Permissions checks the token and returns the principal. To use ID tokens, set `token="identityToken"`. A Cedar policy for a Cognito user can refer to the user pool ID and the user's `sub`:
|
|
63
|
+
|
|
64
|
+
```cedar
|
|
65
|
+
permit(
|
|
66
|
+
principal == Demo::User::"<user-pool-id>|<sub>",
|
|
67
|
+
action == Demo::Action::"view",
|
|
68
|
+
resource == Demo::Document::"guide"
|
|
69
|
+
);
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
If the application already authenticates the caller, pass `principal=current_user` instead of a token mode. The dependency must return an `Entity` from the verified session or `None` for an anonymous request. This mode calls `IsAuthorized` and requires `verifiedpermissions:IsAuthorized`. The optional `context` and `entities` dependencies return a Cedar JSON object and an array of Cedar entities. FastAPI resolves synchronous and asynchronous dependencies in all modes.
|
|
73
|
+
|
|
74
|
+
| Result | Route behavior |
|
|
75
|
+
| --- | --- |
|
|
76
|
+
| Allowed | Handler receives `Authorization(principal, determining_policies)`. |
|
|
77
|
+
| Missing principal or malformed bearer header | Returns 401. |
|
|
78
|
+
| Explicit or default deny | Returns 403. |
|
|
79
|
+
| AWS SDK or service error, including a service-rejected token, or missing decision | Returns 503. |
|
|
80
|
+
|
|
81
|
+
Errors raised by application dependencies follow FastAPI's normal exception handling. An existing Boto3 client can be passed as `VerifiedPermissions(store_id, client=client)`.
|
|
82
|
+
|
|
83
|
+
## AWS reference architecture
|
|
84
|
+
|
|
85
|
+

|
|
86
|
+
|
|
87
|
+
API Gateway verifies the Cognito JWT before invoking Lambda. The FastAPI dependency maps the document ID in the request path to a Cedar resource and asks Verified Permissions whether the caller can read it. [Editable diagram](https://github.com/yuu551/fastapi-verified-permissions/blob/v0.1.0/docs/aws-architecture.drawio)
|
|
88
|
+
|
|
89
|
+
In a live deployment in `us-east-1`, 14 HTTPS checks covered all three identity modes. Alice could read `guide`. Requests for `draft` from Alice and for `guide` from Bob returned 403 in every mode. An explicit Cedar forbid blocked Alice in every mode, and the gateway rejected an anonymous request.
|
|
90
|
+
|
|
91
|
+
## Development
|
|
92
|
+
|
|
93
|
+
```sh
|
|
94
|
+
uv sync --locked
|
|
95
|
+
uv run pytest
|
|
96
|
+
uv build
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
With [AWS Emulator](https://docs.aws.amazon.com/emulator/latest/userguide/getting-started.html) running, execute the integration test separately:
|
|
100
|
+
|
|
101
|
+
```sh
|
|
102
|
+
uv run pytest integration/test_emulator.py
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
It connects to `https://127.0.0.1:9297` using the emulator's credentials and CA. Set `AWS_EMULATOR_PORT` for another port. The test creates a policy store and a Cognito user pool, signs two users in, and checks entity, access-token and ID-token requests. It verifies document-level access and explicit forbids, then deletes the test resources.
|
|
106
|
+
|
|
107
|
+
[Route example](https://github.com/yuu551/fastapi-verified-permissions/blob/v0.1.0/examples/documents.py) · [Hono version](https://github.com/yuu551/hono-verified-permissions) · [Apache License 2.0](https://github.com/yuu551/fastapi-verified-permissions/blob/v0.1.0/LICENSE)
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# fastapi-verified-permissions
|
|
2
|
+
|
|
3
|
+
[English](./README.md) · 日本語
|
|
4
|
+
|
|
5
|
+
FastAPI のルートに Amazon Verified Permissions の認可を追加する Python パッケージです。アクションとリソースを指定し、ルートに `Depends()` で認可を組み込みます。Boto3 の呼び出しは FastAPI の同期依存関数で実行するため、`async def` のルートでも利用できます。
|
|
6
|
+
|
|
7
|
+
## インストール
|
|
8
|
+
|
|
9
|
+
Python 3.11 以降に対応しています。uv を使う場合は、プロジェクトのディレクトリで次のコマンドを実行します。
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
uv add "fastapi-verified-permissions @ git+https://github.com/yuu551/fastapi-verified-permissions.git@v0.1.0"
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
pip を使う場合はこちらです。
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
pip install "fastapi-verified-permissions @ git+https://github.com/yuu551/fastapi-verified-permissions.git@v0.1.0"
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
PyPI での初回公開後は、`uv add fastapi-verified-permissions` または `pip install fastapi-verified-permissions` でインストールできます。
|
|
22
|
+
|
|
23
|
+
## 文書の閲覧を制御する
|
|
24
|
+
|
|
25
|
+
ポリシーストアに Cognito ユーザープールまたは OIDC プロバイダーを ID ソースとして登録します。環境変数 `POLICY_STORE_ID` にストア ID を設定し、Boto3 のリージョンと認証情報を用意してください。実行ロールには対象ストアの `verifiedpermissions:IsAuthorizedWithToken` 権限が必要です。
|
|
26
|
+
|
|
27
|
+
```python
|
|
28
|
+
import os
|
|
29
|
+
|
|
30
|
+
from fastapi import Depends, FastAPI
|
|
31
|
+
from fastapi_verified_permissions import Authorization, Entity, VerifiedPermissions
|
|
32
|
+
|
|
33
|
+
app = FastAPI()
|
|
34
|
+
avp = VerifiedPermissions(os.environ["POLICY_STORE_ID"])
|
|
35
|
+
|
|
36
|
+
def document(document_id: str) -> Entity:
|
|
37
|
+
return Entity("Demo::Document", document_id)
|
|
38
|
+
|
|
39
|
+
can_read = avp.require(
|
|
40
|
+
action=Entity("Demo::Action", "view"),
|
|
41
|
+
resource=document,
|
|
42
|
+
token="accessToken",
|
|
43
|
+
)
|
|
44
|
+
|
|
45
|
+
@app.get("/documents/{document_id}")
|
|
46
|
+
async def read_document(document_id: str, permit: Authorization = Depends(can_read)):
|
|
47
|
+
return {"document": document_id, "reader": permit.principal.id}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
クライアントは `Authorization: Bearer <token>` でトークンを送ります。Verified Permissions がトークンを検証して principal を特定します。ID トークンの場合は `token="identityToken"` を指定します。次の Cedar ポリシーは、指定した Cognito ユーザーにだけ `guide` の閲覧を許可します。
|
|
51
|
+
|
|
52
|
+
```cedar
|
|
53
|
+
permit(
|
|
54
|
+
principal == Demo::User::"<user-pool-id>|<sub>",
|
|
55
|
+
action == Demo::Action::"view",
|
|
56
|
+
resource == Demo::Document::"guide"
|
|
57
|
+
);
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
アプリケーション側でセッションを検証している場合は `principal=current_user` を指定します。依存関数は、認証済みセッションから作った `Entity` を返します。未認証なら `None` を返してください。この方式では `IsAuthorized` を呼ぶため、実行ロールに `verifiedpermissions:IsAuthorized` が必要です。認可判定に追加の情報が必要なら、`context` で Cedar JSON のオブジェクトを、`entities` でエンティティの配列を返す依存関数を指定してください。依存関数は同期・非同期のどちらでも書けます。
|
|
61
|
+
|
|
62
|
+
| 判定 | FastAPI の動作 |
|
|
63
|
+
| --- | --- |
|
|
64
|
+
| 許可 | ハンドラーが `Authorization(principal, determining_policies)` を受け取る |
|
|
65
|
+
| principal がない、または Bearer ヘッダーが不正 | 401 を返す |
|
|
66
|
+
| 明示的な拒否、または許可ポリシーに一致しない | 403 を返す |
|
|
67
|
+
| トークンの検証エラーを含む AWS サービスエラー、SDK のエラー、判定の欠落 | 503 を返す |
|
|
68
|
+
|
|
69
|
+
アプリケーションの依存関数が投げた例外は FastAPI が通常どおり処理します。既存の Boto3 クライアントを使う場合は `VerifiedPermissions(store_id, client=client)` と指定します。
|
|
70
|
+
|
|
71
|
+
## AWS の構成例
|
|
72
|
+
|
|
73
|
+

|
|
74
|
+
|
|
75
|
+
クライアントは Cognito でサインインし、発行された JWT を API Gateway に送ります。API Gateway が JWT を検証して Lambda を呼び出すと、FastAPI はリクエストされた文書をそのユーザーが読めるかどうかを Verified Permissions に問い合わせます。[編集用の構成図](./docs/aws-architecture.drawio)
|
|
76
|
+
|
|
77
|
+
この構成を `us-east-1` にデプロイし、HTTPS 経由で14件の判定を確認しました。3方式とも Alice は `guide` を読めましたが、`draft` は拒否され、Bob は `guide` を読めませんでした。Cedar の `forbid` を追加すると Alice の閲覧も拒否されました。トークンを付けずに送ったリクエストには API Gateway が `401` を返しました。
|
|
78
|
+
|
|
79
|
+
## 開発とテスト
|
|
80
|
+
|
|
81
|
+
```sh
|
|
82
|
+
uv sync --locked
|
|
83
|
+
uv run pytest
|
|
84
|
+
uv build
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
[AWS Emulator](https://docs.aws.amazon.com/emulator/latest/userguide/getting-started.html) を起動してから、統合テストを実行します。
|
|
88
|
+
|
|
89
|
+
```sh
|
|
90
|
+
uv run pytest integration/test_emulator.py
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
テストの接続先は `https://127.0.0.1:9297` です。別ポートは `AWS_EMULATOR_PORT` で指定します。Emulator が発行した認証情報と CA を使い、テスト用のポリシーストアと Cognito ユーザープールを作成します。2人のユーザーでサインインし、エンティティ、アクセストークン、ID トークンの3方式で文書ごとの許可・拒否と `forbid` の動作を確認してから、リソースを削除します。
|
|
94
|
+
|
|
95
|
+
[ルートの実装例](./examples/documents.py) · [Hono 版](https://github.com/yuu551/hono-verified-permissions) · [Apache License 2.0](./LICENSE)
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# fastapi-verified-permissions
|
|
2
|
+
|
|
3
|
+
English · [日本語](https://github.com/yuu551/fastapi-verified-permissions/blob/v0.1.0/README.ja.md)
|
|
4
|
+
|
|
5
|
+
Protect individual FastAPI routes with [Amazon Verified Permissions](https://aws.amazon.com/verified-permissions/). Declare an action and a resource dependency, then add the resulting dependency to a route with `Depends()`. Boto3 makes the authorization request in a synchronous FastAPI dependency, so an async route can use the same API.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
Requires Python 3.11 or later. To install the GitHub release in a uv project, run
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
uv add "fastapi-verified-permissions @ git+https://github.com/yuu551/fastapi-verified-permissions.git@v0.1.0"
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
For pip, run
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
pip install "fastapi-verified-permissions @ git+https://github.com/yuu551/fastapi-verified-permissions.git@v0.1.0"
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Once the first release is available on PyPI, install by name with `uv add fastapi-verified-permissions` or `pip install fastapi-verified-permissions`.
|
|
22
|
+
|
|
23
|
+
## Protect a document endpoint
|
|
24
|
+
|
|
25
|
+
Register the Cognito user pool or OIDC provider as an identity source for your policy store. Set `POLICY_STORE_ID`, configure the AWS region and credentials for Boto3, and grant the application role `verifiedpermissions:IsAuthorizedWithToken` on the store.
|
|
26
|
+
|
|
27
|
+
```python
|
|
28
|
+
import os
|
|
29
|
+
|
|
30
|
+
from fastapi import Depends, FastAPI
|
|
31
|
+
from fastapi_verified_permissions import Authorization, Entity, VerifiedPermissions
|
|
32
|
+
|
|
33
|
+
app = FastAPI()
|
|
34
|
+
avp = VerifiedPermissions(os.environ["POLICY_STORE_ID"])
|
|
35
|
+
|
|
36
|
+
def document(document_id: str) -> Entity:
|
|
37
|
+
return Entity("Demo::Document", document_id)
|
|
38
|
+
|
|
39
|
+
can_read = avp.require(
|
|
40
|
+
action=Entity("Demo::Action", "view"),
|
|
41
|
+
resource=document,
|
|
42
|
+
token="accessToken",
|
|
43
|
+
)
|
|
44
|
+
|
|
45
|
+
@app.get("/documents/{document_id}")
|
|
46
|
+
async def read_document(document_id: str, permit: Authorization = Depends(can_read)):
|
|
47
|
+
return {"document": document_id, "reader": permit.principal.id}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
The client sends `Authorization: Bearer <token>`. Verified Permissions checks the token and returns the principal. To use ID tokens, set `token="identityToken"`. A Cedar policy for a Cognito user can refer to the user pool ID and the user's `sub`:
|
|
51
|
+
|
|
52
|
+
```cedar
|
|
53
|
+
permit(
|
|
54
|
+
principal == Demo::User::"<user-pool-id>|<sub>",
|
|
55
|
+
action == Demo::Action::"view",
|
|
56
|
+
resource == Demo::Document::"guide"
|
|
57
|
+
);
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
If the application already authenticates the caller, pass `principal=current_user` instead of a token mode. The dependency must return an `Entity` from the verified session or `None` for an anonymous request. This mode calls `IsAuthorized` and requires `verifiedpermissions:IsAuthorized`. The optional `context` and `entities` dependencies return a Cedar JSON object and an array of Cedar entities. FastAPI resolves synchronous and asynchronous dependencies in all modes.
|
|
61
|
+
|
|
62
|
+
| Result | Route behavior |
|
|
63
|
+
| --- | --- |
|
|
64
|
+
| Allowed | Handler receives `Authorization(principal, determining_policies)`. |
|
|
65
|
+
| Missing principal or malformed bearer header | Returns 401. |
|
|
66
|
+
| Explicit or default deny | Returns 403. |
|
|
67
|
+
| AWS SDK or service error, including a service-rejected token, or missing decision | Returns 503. |
|
|
68
|
+
|
|
69
|
+
Errors raised by application dependencies follow FastAPI's normal exception handling. An existing Boto3 client can be passed as `VerifiedPermissions(store_id, client=client)`.
|
|
70
|
+
|
|
71
|
+
## AWS reference architecture
|
|
72
|
+
|
|
73
|
+

|
|
74
|
+
|
|
75
|
+
API Gateway verifies the Cognito JWT before invoking Lambda. The FastAPI dependency maps the document ID in the request path to a Cedar resource and asks Verified Permissions whether the caller can read it. [Editable diagram](https://github.com/yuu551/fastapi-verified-permissions/blob/v0.1.0/docs/aws-architecture.drawio)
|
|
76
|
+
|
|
77
|
+
In a live deployment in `us-east-1`, 14 HTTPS checks covered all three identity modes. Alice could read `guide`. Requests for `draft` from Alice and for `guide` from Bob returned 403 in every mode. An explicit Cedar forbid blocked Alice in every mode, and the gateway rejected an anonymous request.
|
|
78
|
+
|
|
79
|
+
## Development
|
|
80
|
+
|
|
81
|
+
```sh
|
|
82
|
+
uv sync --locked
|
|
83
|
+
uv run pytest
|
|
84
|
+
uv build
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
With [AWS Emulator](https://docs.aws.amazon.com/emulator/latest/userguide/getting-started.html) running, execute the integration test separately:
|
|
88
|
+
|
|
89
|
+
```sh
|
|
90
|
+
uv run pytest integration/test_emulator.py
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
It connects to `https://127.0.0.1:9297` using the emulator's credentials and CA. Set `AWS_EMULATOR_PORT` for another port. The test creates a policy store and a Cognito user pool, signs two users in, and checks entity, access-token and ID-token requests. It verifies document-level access and explicit forbids, then deletes the test resources.
|
|
94
|
+
|
|
95
|
+
[Route example](https://github.com/yuu551/fastapi-verified-permissions/blob/v0.1.0/examples/documents.py) · [Hono version](https://github.com/yuu551/hono-verified-permissions) · [Apache License 2.0](https://github.com/yuu551/fastapi-verified-permissions/blob/v0.1.0/LICENSE)
|