boundarycheck 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.
- boundarycheck-0.1.0/LICENSE +202 -0
- boundarycheck-0.1.0/NOTICE +7 -0
- boundarycheck-0.1.0/PKG-INFO +207 -0
- boundarycheck-0.1.0/README.md +180 -0
- boundarycheck-0.1.0/pyproject.toml +152 -0
- boundarycheck-0.1.0/pyproject.toml.orig +108 -0
- boundarycheck-0.1.0/src/boundarycheck/__init__.py +3 -0
- boundarycheck-0.1.0/src/boundarycheck/__main__.py +3 -0
- boundarycheck-0.1.0/src/boundarycheck/cli.py +261 -0
- boundarycheck-0.1.0/src/boundarycheck/comparator.py +297 -0
- boundarycheck-0.1.0/src/boundarycheck/config.py +409 -0
- boundarycheck-0.1.0/src/boundarycheck/engine.py +366 -0
- boundarycheck-0.1.0/src/boundarycheck/evidence.py +125 -0
- boundarycheck-0.1.0/src/boundarycheck/model.py +63 -0
- boundarycheck-0.1.0/src/boundarycheck/netcheck.py +48 -0
- boundarycheck-0.1.0/src/boundarycheck/oracle.py +100 -0
- boundarycheck-0.1.0/src/boundarycheck/planner.py +66 -0
- boundarycheck-0.1.0/src/boundarycheck/py.typed +0 -0
- boundarycheck-0.1.0/src/boundarycheck/redact.py +97 -0
- boundarycheck-0.1.0/src/boundarycheck/report.py +120 -0
- boundarycheck-0.1.0/src/boundarycheck/statediff.py +43 -0
- boundarycheck-0.1.0/src/boundarycheck/template.py +69 -0
- boundarycheck-0.1.0/src/boundarycheck/transports/__init__.py +1 -0
- boundarycheck-0.1.0/src/boundarycheck/transports/lab_fixture.py +213 -0
- boundarycheck-0.1.0/src/boundarycheck/transports/live.py +213 -0
- boundarycheck-0.1.0/src/boundarycheck/transports/sqlite_state.py +41 -0
|
@@ -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
|
+
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
boundarycheck
|
|
2
|
+
Copyright 2026 Mohammed Orunsolu
|
|
3
|
+
|
|
4
|
+
Licensed under the Apache License, Version 2.0 (see LICENSE).
|
|
5
|
+
|
|
6
|
+
boundarycheck is an authorization-testing tool. Use it only against systems you own or are
|
|
7
|
+
explicitly authorized to assess. It is provided "AS IS", without warranty of any kind.
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: boundarycheck
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Check that an API enforces the authorization boundaries you declare: tenant isolation, roles, hidden objects and field exposure, compared against an independent policy.
|
|
5
|
+
Keywords: security,authorization,BOLA,BFLA,OWASP,API security,testing
|
|
6
|
+
Author: Mohammed Orunsolu
|
|
7
|
+
License-Expression: Apache-2.0
|
|
8
|
+
License-File: LICENSE
|
|
9
|
+
License-File: NOTICE
|
|
10
|
+
Classifier: Development Status :: 3 - Alpha
|
|
11
|
+
Classifier: Environment :: Console
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Topic :: Security
|
|
14
|
+
Classifier: Topic :: Software Development :: Testing
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
16
|
+
Classifier: Typing :: Typed
|
|
17
|
+
Requires-Dist: httpx>=0.28.1,<1
|
|
18
|
+
Requires-Dist: pydantic>=2.14.4,<3
|
|
19
|
+
Requires-Dist: pyyaml>=6.0.3,<7
|
|
20
|
+
Requires-Dist: typer>=0.29.2,<1
|
|
21
|
+
Requires-Python: >=3.13, <3.14
|
|
22
|
+
Project-URL: Homepage, https://github.com/MDPorsch/boundarycheck
|
|
23
|
+
Project-URL: Source, https://github.com/MDPorsch/boundarycheck
|
|
24
|
+
Project-URL: Issues, https://github.com/MDPorsch/boundarycheck/issues
|
|
25
|
+
Project-URL: Security, https://github.com/MDPorsch/boundarycheck/security/policy
|
|
26
|
+
Description-Content-Type: text/markdown
|
|
27
|
+
|
|
28
|
+
# boundarycheck
|
|
29
|
+
|
|
30
|
+
[](https://github.com/MDPorsch/boundarycheck/actions/workflows/ci.yml)
|
|
31
|
+
[](https://github.com/MDPorsch/boundarycheck/actions/workflows/codeql.yml)
|
|
32
|
+
[](LICENSE)
|
|
33
|
+
|
|
34
|
+
Check that an API enforces the authorization boundaries **you declare**: tenant isolation, roles,
|
|
35
|
+
hidden objects and field exposure. You write down who is allowed to see what (the *policy*); the tool
|
|
36
|
+
replays read-only requests as each test user and compares what the API actually did with what your
|
|
37
|
+
policy says it should do. Every result is one of seven honest states, and a failed or partial run can
|
|
38
|
+
never look clean.
|
|
39
|
+
|
|
40
|
+
> **Status: v0.1.0, alpha.** Live targets are **loopback-only and read-only** (`GET`/`HEAD`): it tests the
|
|
41
|
+
> API you run on your own machine. Write checks exist only against the built-in in-process lab. Use it
|
|
42
|
+
> only against systems you own or are explicitly authorized to assess. See [SECURITY.md](SECURITY.md)
|
|
43
|
+
> and [LIMITATIONS.md](LIMITATIONS.md).
|
|
44
|
+
|
|
45
|
+
## What it does, and what it does not
|
|
46
|
+
|
|
47
|
+
| It checks | It does **not** |
|
|
48
|
+
|---|---|
|
|
49
|
+
| Cross-tenant reads (BOLA): can user A read tenant B's object? | Test writes on a **live** target: it sends `GET`/`HEAD` only, so a write-path flaw there is **not detected** |
|
|
50
|
+
| Role limits on read routes (BFLA): can a viewer reach an admin route? | Decide whether your policy is *right*: it judges the API against the policy you give it |
|
|
51
|
+
| Hidden objects: does a forbidden object answer exactly like a missing one? | Prove an API is secure: `no_issue_observed` means one request matched the policy, nothing more |
|
|
52
|
+
| Field exposure: does a response carry a field that role should not see? | Test timing channels, concurrency, rate limits or anything it was not told about |
|
|
53
|
+
| List routes: does a list name objects the user may not see, or count them in `total`? | Reach a remote host (planned for v0.2: a scoped, HTTPS-only, allow-listed design) |
|
|
54
|
+
| Refused writes (fixture only): does a request the policy says must be refused still **change a row**, whatever status it returns? | Send a write the policy allows: that would test functionality, and it would change state |
|
|
55
|
+
|
|
56
|
+
## Install
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
pipx install boundarycheck # once release 0.1.0 is on PyPI (see below)
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
PyPI publication goes through a protected release workflow that needs the owner's approval
|
|
63
|
+
([docs/releasing.md](docs/releasing.md)); until <https://pypi.org/project/boundarycheck/> shows 0.1.0,
|
|
64
|
+
install from source as in the next section. A wheel install validates configs, plans, and runs
|
|
65
|
+
`--transport live` against loopback; the `fixture` transport and the examples need a source checkout.
|
|
66
|
+
|
|
67
|
+
## Try it in two minutes (no network, no credentials)
|
|
68
|
+
|
|
69
|
+
The demo target is the [tenant-boundary-lab](https://github.com/MDPorsch/tenant-boundary-lab): a small
|
|
70
|
+
multi-tenant API with a *patched* and a *deliberately vulnerable* variant, served in process.
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
git clone --recurse-submodules https://github.com/MDPorsch/boundarycheck
|
|
74
|
+
cd boundarycheck
|
|
75
|
+
uv sync # needs uv (https://docs.astral.sh/uv/) and Python 3.13
|
|
76
|
+
uv run boundarycheck test --config examples/lab.yaml --transport fixture
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Real output on the patched lab (419 cases: 240 reads, 81 refused writes, 98 concealment comparisons):
|
|
80
|
+
|
|
81
|
+
```text
|
|
82
|
+
boundarycheck 0.1.0 | scope lab-demo | transport fixture:tenant-boundary-lab:patched
|
|
83
|
+
cases: no_issue_observed: 419, finding_candidate: 0, policy_denied: 0, not_run: 0, incomplete: 0, error: 0, inconclusive: 0 (total 419)
|
|
84
|
+
note: 7 write combination(s) that the policy allows were not exercised by design: write checks send only requests the policy says must be refused.
|
|
85
|
+
exit code 0. Note: no_issue_observed does not mean the target is secure.
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Now break one control on purpose and watch it get caught (flags: `TENANT_PREDICATE_OMITTED`,
|
|
89
|
+
`ROLE_CHECK_MISSING`, `PRIVATE_PROPERTY_SERIALIZED`, `MARKET_BOUNDARY_OMITTED`,
|
|
90
|
+
`WRITE_BEFORE_AUTHORIZATION`):
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
uv run boundarycheck test --config examples/lab-vulnerable.yaml --transport fixture --fixture-flaws ROLE_CHECK_MISSING
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
```text
|
|
97
|
+
cases: no_issue_observed: 281, finding_candidate: 5, ... (total 286)
|
|
98
|
+
FINDING BC-0067 BC-ROLE-01 [high] bob:contact.private.read:PA1: expected deny_forbidden (role_denied), observed allow (HTTP 200): access was granted where the policy denies it
|
|
99
|
+
FINDING BC-0076 BC-ROLE-01 [high] bob:project.write:PA1: expected deny_forbidden (role_denied), observed allow (HTTP 200): access was granted where the policy denies it; state changed: projects:... (modified)
|
|
100
|
+
...
|
|
101
|
+
exit code 1.
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
The fifth flaw is the interesting one: the lab **writes first and then refuses**, so every response is
|
|
105
|
+
the correct `403`/`404`. A status-only runner calls it clean (try `--reads-only`: 249 clean, exit 0).
|
|
106
|
+
The state diff finds it:
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
uv run boundarycheck test --config examples/lab-vulnerable.yaml --transport fixture --fixture-flaws WRITE_BEFORE_AUTHORIZATION
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
```text
|
|
113
|
+
cases: no_issue_observed: 265, finding_candidate: 21, ... (total 286)
|
|
114
|
+
FINDING BC-0076 BC-MUTATION-01 [high] bob:project.write:PA1: the request was not accepted (HTTP 403) but state changed: projects:... (modified)
|
|
115
|
+
...
|
|
116
|
+
exit code 1.
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
## Use it on your own API
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
uv run boundarycheck init --output boundarycheck.yaml # an annotated starter, safe by default
|
|
123
|
+
$EDITOR boundarycheck.yaml # your tenants, test users, objects, routes and policy
|
|
124
|
+
uv run boundarycheck validate --config boundarycheck.yaml # schema + references + policy completeness. No network
|
|
125
|
+
uv run boundarycheck plan --config boundarycheck.yaml # prints every request. Sends nothing
|
|
126
|
+
export BC_TOKEN_ALICE=... BC_TOKEN_BOB=... # TEST users' tokens, read from the environment only
|
|
127
|
+
uv run boundarycheck test --config boundarycheck.yaml --transport live
|
|
128
|
+
uv run boundarycheck list-runs ; uv run boundarycheck report --run RUN_ID --format md
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
The config holds **no secrets**: a principal names the environment variable its token comes from.
|
|
132
|
+
The policy is the heart of it, so write it from your requirements, not from the code under test.
|
|
133
|
+
[`examples/lab.yaml`](examples/lab.yaml) is a complete, commented example.
|
|
134
|
+
|
|
135
|
+
## Reading a result
|
|
136
|
+
|
|
137
|
+
| Status | Meaning |
|
|
138
|
+
|---|---|
|
|
139
|
+
| `no_issue_observed` | The response matched the declared policy. **Not** "secure". |
|
|
140
|
+
| `finding_candidate` | The response differed from the policy. A human reviews it (`review_state: needs_review`). |
|
|
141
|
+
| `inconclusive` | It ran but the answer cannot be mapped to a decision (for example HTTP 422, 429, 5xx, a non-JSON body). |
|
|
142
|
+
| `incomplete` | A timeout, connection failure or oversized response. |
|
|
143
|
+
| `policy_denied` | The tool refused to send it (budget exhausted, a redirect, a forbidden method or path). |
|
|
144
|
+
| `not_run` | Skipped for a stated reason, usually no credential for that user. |
|
|
145
|
+
| `error` | The tool itself failed (including a redaction failure). |
|
|
146
|
+
|
|
147
|
+
**Exit code:** `0` only if there is at least one case and *every* case is `no_issue_observed`; `1` if
|
|
148
|
+
any case is a `finding_candidate`; `2` for everything else (any other status, an unreadable config, a
|
|
149
|
+
usage error, a crash). Wire `0` into CI; treat `1` and `2` as red.
|
|
150
|
+
|
|
151
|
+
Two situations are worth knowing, and both are tested and documented rather than hidden:
|
|
152
|
+
|
|
153
|
+
* **A wrong policy looks like a vulnerable API.** The tool judges against the policy it was given.
|
|
154
|
+
Tell it that viewers may read private contacts and a *correct* API is reported as a (low-severity)
|
|
155
|
+
`finding_candidate`. That is why a finding is a candidate and, for a mismatch with the policy, confidence is
|
|
156
|
+
never `high`. The one exception is `BC-MUTATION-01` (a refused request that still changed state), which
|
|
157
|
+
does not depend on the policy being right (D-B18).
|
|
158
|
+
* **An answer the tool cannot map is `inconclusive`, never clean.** The lab answers `422` for an id
|
|
159
|
+
that is not a UUID; those cases are `inconclusive` and the run exits `2`.
|
|
160
|
+
|
|
161
|
+
## How it stays safe
|
|
162
|
+
|
|
163
|
+
* **Loopback-only and read-only on a live target.** Only `GET`/`HEAD`, and never a request body: a write
|
|
164
|
+
is sent only by the in-process fixture, only where the policy says it must be refused, and its effect
|
|
165
|
+
is judged by a raw-SQL snapshot diff. The base URL must be `http://` on `127.0.0.0/8`,
|
|
166
|
+
`::1` or `localhost`. A name is resolved once, every address must be loopback, and the connection
|
|
167
|
+
goes to the checked IP literal; the connected peer is verified again. Redirects are never followed,
|
|
168
|
+
proxy variables are ignored, bodies are capped *after* decompression, and there is a timeout, a rate
|
|
169
|
+
limit and a hard request budget. **These are properties of the tool's own sockets.** It cannot see
|
|
170
|
+
where a loopback listener forwards: an `ssh -L` tunnel or a local proxy on `127.0.0.1` can still
|
|
171
|
+
reach a remote host. Do not point it at one unless you are authorized for what is behind it.
|
|
172
|
+
* **A hostile config is parsed defensively.** Size cap, no YAML tags, aliases, anchors, merge keys or
|
|
173
|
+
duplicate keys, nesting cap, strict types, every identifier and path validated, only read methods.
|
|
174
|
+
* **Credentials never touch disk or output.** They are replaced in everything that is stored, and
|
|
175
|
+
before anything is written every credential used in the run is searched for in the report and the
|
|
176
|
+
evidence; if one is found nothing is written and the run exits `2`.
|
|
177
|
+
* **Reports contain no response bodies**: statuses, rule ids, the *names* of fields, and SHA-256
|
|
178
|
+
references to the redacted evidence. Run directories are `0700`, files `0600`, a world-writable runs
|
|
179
|
+
directory is refused, and `purge --older-than` bounds retention.
|
|
180
|
+
|
|
181
|
+
## Documentation
|
|
182
|
+
|
|
183
|
+
* [docs/contract.md](docs/contract.md): the behaviour the tests pin (oracle, comparator, transports, redaction).
|
|
184
|
+
* [LIMITATIONS.md](LIMITATIONS.md): what a clean run does **not** show. Read it before relying on a result.
|
|
185
|
+
* [DECISIONS.md](DECISIONS.md): choices and the reasons, including the ones awaiting the owner's confirmation.
|
|
186
|
+
* [SECURITY.md](SECURITY.md), [CONTRIBUTING.md](CONTRIBUTING.md), [CHANGELOG.md](CHANGELOG.md).
|
|
187
|
+
|
|
188
|
+
## Development
|
|
189
|
+
|
|
190
|
+
```bash
|
|
191
|
+
git clone --recurse-submodules https://github.com/MDPorsch/boundarycheck && cd boundarycheck
|
|
192
|
+
uv sync
|
|
193
|
+
uv run pytest -q # unit, negative, integration (against the lab) and packaging tests
|
|
194
|
+
uv run ruff check . && uv run ruff format --check . && uv run mypy
|
|
195
|
+
uv run python tools/mutation.py # optional, ~30 min: inject 145 security bugs, expect every one caught
|
|
196
|
+
uv run python tools/secret_scan.py # optional: gitleaks over all history + tree (brew install gitleaks)
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
The lab is a pinned git submodule at `lab/`, installed **editable and for development only**, so
|
|
200
|
+
installing `boundarycheck` never installs the lab and never installs the deliberately vulnerable variant.
|
|
201
|
+
A wheel install can validate configs, plan, and run `--transport live`; the `fixture` transport needs a
|
|
202
|
+
source checkout and says so clearly if it is missing.
|
|
203
|
+
|
|
204
|
+
## Licence
|
|
205
|
+
|
|
206
|
+
[Apache License 2.0](LICENSE) ([NOTICE](NOTICE)). The licence choice is recorded as D-B10 and was confirmed by the
|
|
207
|
+
owner.
|
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
# boundarycheck
|
|
2
|
+
|
|
3
|
+
[](https://github.com/MDPorsch/boundarycheck/actions/workflows/ci.yml)
|
|
4
|
+
[](https://github.com/MDPorsch/boundarycheck/actions/workflows/codeql.yml)
|
|
5
|
+
[](LICENSE)
|
|
6
|
+
|
|
7
|
+
Check that an API enforces the authorization boundaries **you declare**: tenant isolation, roles,
|
|
8
|
+
hidden objects and field exposure. You write down who is allowed to see what (the *policy*); the tool
|
|
9
|
+
replays read-only requests as each test user and compares what the API actually did with what your
|
|
10
|
+
policy says it should do. Every result is one of seven honest states, and a failed or partial run can
|
|
11
|
+
never look clean.
|
|
12
|
+
|
|
13
|
+
> **Status: v0.1.0, alpha.** Live targets are **loopback-only and read-only** (`GET`/`HEAD`): it tests the
|
|
14
|
+
> API you run on your own machine. Write checks exist only against the built-in in-process lab. Use it
|
|
15
|
+
> only against systems you own or are explicitly authorized to assess. See [SECURITY.md](SECURITY.md)
|
|
16
|
+
> and [LIMITATIONS.md](LIMITATIONS.md).
|
|
17
|
+
|
|
18
|
+
## What it does, and what it does not
|
|
19
|
+
|
|
20
|
+
| It checks | It does **not** |
|
|
21
|
+
|---|---|
|
|
22
|
+
| Cross-tenant reads (BOLA): can user A read tenant B's object? | Test writes on a **live** target: it sends `GET`/`HEAD` only, so a write-path flaw there is **not detected** |
|
|
23
|
+
| Role limits on read routes (BFLA): can a viewer reach an admin route? | Decide whether your policy is *right*: it judges the API against the policy you give it |
|
|
24
|
+
| Hidden objects: does a forbidden object answer exactly like a missing one? | Prove an API is secure: `no_issue_observed` means one request matched the policy, nothing more |
|
|
25
|
+
| Field exposure: does a response carry a field that role should not see? | Test timing channels, concurrency, rate limits or anything it was not told about |
|
|
26
|
+
| List routes: does a list name objects the user may not see, or count them in `total`? | Reach a remote host (planned for v0.2: a scoped, HTTPS-only, allow-listed design) |
|
|
27
|
+
| Refused writes (fixture only): does a request the policy says must be refused still **change a row**, whatever status it returns? | Send a write the policy allows: that would test functionality, and it would change state |
|
|
28
|
+
|
|
29
|
+
## Install
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
pipx install boundarycheck # once release 0.1.0 is on PyPI (see below)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
PyPI publication goes through a protected release workflow that needs the owner's approval
|
|
36
|
+
([docs/releasing.md](docs/releasing.md)); until <https://pypi.org/project/boundarycheck/> shows 0.1.0,
|
|
37
|
+
install from source as in the next section. A wheel install validates configs, plans, and runs
|
|
38
|
+
`--transport live` against loopback; the `fixture` transport and the examples need a source checkout.
|
|
39
|
+
|
|
40
|
+
## Try it in two minutes (no network, no credentials)
|
|
41
|
+
|
|
42
|
+
The demo target is the [tenant-boundary-lab](https://github.com/MDPorsch/tenant-boundary-lab): a small
|
|
43
|
+
multi-tenant API with a *patched* and a *deliberately vulnerable* variant, served in process.
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
git clone --recurse-submodules https://github.com/MDPorsch/boundarycheck
|
|
47
|
+
cd boundarycheck
|
|
48
|
+
uv sync # needs uv (https://docs.astral.sh/uv/) and Python 3.13
|
|
49
|
+
uv run boundarycheck test --config examples/lab.yaml --transport fixture
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Real output on the patched lab (419 cases: 240 reads, 81 refused writes, 98 concealment comparisons):
|
|
53
|
+
|
|
54
|
+
```text
|
|
55
|
+
boundarycheck 0.1.0 | scope lab-demo | transport fixture:tenant-boundary-lab:patched
|
|
56
|
+
cases: no_issue_observed: 419, finding_candidate: 0, policy_denied: 0, not_run: 0, incomplete: 0, error: 0, inconclusive: 0 (total 419)
|
|
57
|
+
note: 7 write combination(s) that the policy allows were not exercised by design: write checks send only requests the policy says must be refused.
|
|
58
|
+
exit code 0. Note: no_issue_observed does not mean the target is secure.
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Now break one control on purpose and watch it get caught (flags: `TENANT_PREDICATE_OMITTED`,
|
|
62
|
+
`ROLE_CHECK_MISSING`, `PRIVATE_PROPERTY_SERIALIZED`, `MARKET_BOUNDARY_OMITTED`,
|
|
63
|
+
`WRITE_BEFORE_AUTHORIZATION`):
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
uv run boundarycheck test --config examples/lab-vulnerable.yaml --transport fixture --fixture-flaws ROLE_CHECK_MISSING
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
```text
|
|
70
|
+
cases: no_issue_observed: 281, finding_candidate: 5, ... (total 286)
|
|
71
|
+
FINDING BC-0067 BC-ROLE-01 [high] bob:contact.private.read:PA1: expected deny_forbidden (role_denied), observed allow (HTTP 200): access was granted where the policy denies it
|
|
72
|
+
FINDING BC-0076 BC-ROLE-01 [high] bob:project.write:PA1: expected deny_forbidden (role_denied), observed allow (HTTP 200): access was granted where the policy denies it; state changed: projects:... (modified)
|
|
73
|
+
...
|
|
74
|
+
exit code 1.
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
The fifth flaw is the interesting one: the lab **writes first and then refuses**, so every response is
|
|
78
|
+
the correct `403`/`404`. A status-only runner calls it clean (try `--reads-only`: 249 clean, exit 0).
|
|
79
|
+
The state diff finds it:
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
uv run boundarycheck test --config examples/lab-vulnerable.yaml --transport fixture --fixture-flaws WRITE_BEFORE_AUTHORIZATION
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
```text
|
|
86
|
+
cases: no_issue_observed: 265, finding_candidate: 21, ... (total 286)
|
|
87
|
+
FINDING BC-0076 BC-MUTATION-01 [high] bob:project.write:PA1: the request was not accepted (HTTP 403) but state changed: projects:... (modified)
|
|
88
|
+
...
|
|
89
|
+
exit code 1.
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## Use it on your own API
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
uv run boundarycheck init --output boundarycheck.yaml # an annotated starter, safe by default
|
|
96
|
+
$EDITOR boundarycheck.yaml # your tenants, test users, objects, routes and policy
|
|
97
|
+
uv run boundarycheck validate --config boundarycheck.yaml # schema + references + policy completeness. No network
|
|
98
|
+
uv run boundarycheck plan --config boundarycheck.yaml # prints every request. Sends nothing
|
|
99
|
+
export BC_TOKEN_ALICE=... BC_TOKEN_BOB=... # TEST users' tokens, read from the environment only
|
|
100
|
+
uv run boundarycheck test --config boundarycheck.yaml --transport live
|
|
101
|
+
uv run boundarycheck list-runs ; uv run boundarycheck report --run RUN_ID --format md
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
The config holds **no secrets**: a principal names the environment variable its token comes from.
|
|
105
|
+
The policy is the heart of it, so write it from your requirements, not from the code under test.
|
|
106
|
+
[`examples/lab.yaml`](examples/lab.yaml) is a complete, commented example.
|
|
107
|
+
|
|
108
|
+
## Reading a result
|
|
109
|
+
|
|
110
|
+
| Status | Meaning |
|
|
111
|
+
|---|---|
|
|
112
|
+
| `no_issue_observed` | The response matched the declared policy. **Not** "secure". |
|
|
113
|
+
| `finding_candidate` | The response differed from the policy. A human reviews it (`review_state: needs_review`). |
|
|
114
|
+
| `inconclusive` | It ran but the answer cannot be mapped to a decision (for example HTTP 422, 429, 5xx, a non-JSON body). |
|
|
115
|
+
| `incomplete` | A timeout, connection failure or oversized response. |
|
|
116
|
+
| `policy_denied` | The tool refused to send it (budget exhausted, a redirect, a forbidden method or path). |
|
|
117
|
+
| `not_run` | Skipped for a stated reason, usually no credential for that user. |
|
|
118
|
+
| `error` | The tool itself failed (including a redaction failure). |
|
|
119
|
+
|
|
120
|
+
**Exit code:** `0` only if there is at least one case and *every* case is `no_issue_observed`; `1` if
|
|
121
|
+
any case is a `finding_candidate`; `2` for everything else (any other status, an unreadable config, a
|
|
122
|
+
usage error, a crash). Wire `0` into CI; treat `1` and `2` as red.
|
|
123
|
+
|
|
124
|
+
Two situations are worth knowing, and both are tested and documented rather than hidden:
|
|
125
|
+
|
|
126
|
+
* **A wrong policy looks like a vulnerable API.** The tool judges against the policy it was given.
|
|
127
|
+
Tell it that viewers may read private contacts and a *correct* API is reported as a (low-severity)
|
|
128
|
+
`finding_candidate`. That is why a finding is a candidate and, for a mismatch with the policy, confidence is
|
|
129
|
+
never `high`. The one exception is `BC-MUTATION-01` (a refused request that still changed state), which
|
|
130
|
+
does not depend on the policy being right (D-B18).
|
|
131
|
+
* **An answer the tool cannot map is `inconclusive`, never clean.** The lab answers `422` for an id
|
|
132
|
+
that is not a UUID; those cases are `inconclusive` and the run exits `2`.
|
|
133
|
+
|
|
134
|
+
## How it stays safe
|
|
135
|
+
|
|
136
|
+
* **Loopback-only and read-only on a live target.** Only `GET`/`HEAD`, and never a request body: a write
|
|
137
|
+
is sent only by the in-process fixture, only where the policy says it must be refused, and its effect
|
|
138
|
+
is judged by a raw-SQL snapshot diff. The base URL must be `http://` on `127.0.0.0/8`,
|
|
139
|
+
`::1` or `localhost`. A name is resolved once, every address must be loopback, and the connection
|
|
140
|
+
goes to the checked IP literal; the connected peer is verified again. Redirects are never followed,
|
|
141
|
+
proxy variables are ignored, bodies are capped *after* decompression, and there is a timeout, a rate
|
|
142
|
+
limit and a hard request budget. **These are properties of the tool's own sockets.** It cannot see
|
|
143
|
+
where a loopback listener forwards: an `ssh -L` tunnel or a local proxy on `127.0.0.1` can still
|
|
144
|
+
reach a remote host. Do not point it at one unless you are authorized for what is behind it.
|
|
145
|
+
* **A hostile config is parsed defensively.** Size cap, no YAML tags, aliases, anchors, merge keys or
|
|
146
|
+
duplicate keys, nesting cap, strict types, every identifier and path validated, only read methods.
|
|
147
|
+
* **Credentials never touch disk or output.** They are replaced in everything that is stored, and
|
|
148
|
+
before anything is written every credential used in the run is searched for in the report and the
|
|
149
|
+
evidence; if one is found nothing is written and the run exits `2`.
|
|
150
|
+
* **Reports contain no response bodies**: statuses, rule ids, the *names* of fields, and SHA-256
|
|
151
|
+
references to the redacted evidence. Run directories are `0700`, files `0600`, a world-writable runs
|
|
152
|
+
directory is refused, and `purge --older-than` bounds retention.
|
|
153
|
+
|
|
154
|
+
## Documentation
|
|
155
|
+
|
|
156
|
+
* [docs/contract.md](docs/contract.md): the behaviour the tests pin (oracle, comparator, transports, redaction).
|
|
157
|
+
* [LIMITATIONS.md](LIMITATIONS.md): what a clean run does **not** show. Read it before relying on a result.
|
|
158
|
+
* [DECISIONS.md](DECISIONS.md): choices and the reasons, including the ones awaiting the owner's confirmation.
|
|
159
|
+
* [SECURITY.md](SECURITY.md), [CONTRIBUTING.md](CONTRIBUTING.md), [CHANGELOG.md](CHANGELOG.md).
|
|
160
|
+
|
|
161
|
+
## Development
|
|
162
|
+
|
|
163
|
+
```bash
|
|
164
|
+
git clone --recurse-submodules https://github.com/MDPorsch/boundarycheck && cd boundarycheck
|
|
165
|
+
uv sync
|
|
166
|
+
uv run pytest -q # unit, negative, integration (against the lab) and packaging tests
|
|
167
|
+
uv run ruff check . && uv run ruff format --check . && uv run mypy
|
|
168
|
+
uv run python tools/mutation.py # optional, ~30 min: inject 145 security bugs, expect every one caught
|
|
169
|
+
uv run python tools/secret_scan.py # optional: gitleaks over all history + tree (brew install gitleaks)
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
The lab is a pinned git submodule at `lab/`, installed **editable and for development only**, so
|
|
173
|
+
installing `boundarycheck` never installs the lab and never installs the deliberately vulnerable variant.
|
|
174
|
+
A wheel install can validate configs, plan, and run `--transport live`; the `fixture` transport needs a
|
|
175
|
+
source checkout and says so clearly if it is missing.
|
|
176
|
+
|
|
177
|
+
## Licence
|
|
178
|
+
|
|
179
|
+
[Apache License 2.0](LICENSE) ([NOTICE](NOTICE)). The licence choice is recorded as D-B10 and was confirmed by the
|
|
180
|
+
owner.
|