ardguard 0.1.0b1__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.
- ardguard-0.1.0b1/.gitignore +13 -0
- ardguard-0.1.0b1/CHANGELOG.md +33 -0
- ardguard-0.1.0b1/CITATION.cff +19 -0
- ardguard-0.1.0b1/CONTRIBUTING.md +54 -0
- ardguard-0.1.0b1/LICENSE +201 -0
- ardguard-0.1.0b1/NOTICE +5 -0
- ardguard-0.1.0b1/PKG-INFO +215 -0
- ardguard-0.1.0b1/README.md +183 -0
- ardguard-0.1.0b1/ROADMAP.md +27 -0
- ardguard-0.1.0b1/SECURITY.md +49 -0
- ardguard-0.1.0b1/SUPPORT.md +21 -0
- ardguard-0.1.0b1/docs/ADOPTION_EXAMPLES.md +26 -0
- ardguard-0.1.0b1/docs/ARCHITECTURE.md +70 -0
- ardguard-0.1.0b1/docs/ARD_COMPATIBILITY.md +24 -0
- ardguard-0.1.0b1/docs/AUTHORITY.md +26 -0
- ardguard-0.1.0b1/docs/DECISIONS.md +40 -0
- ardguard-0.1.0b1/docs/EVIDENCE.md +40 -0
- ardguard-0.1.0b1/docs/FACT_PROVIDERS.md +47 -0
- ardguard-0.1.0b1/docs/HF_DISCOVER.md +27 -0
- ardguard-0.1.0b1/docs/INTEGRATION_GUIDE.md +71 -0
- ardguard-0.1.0b1/docs/RELEASE_NOTES_0.1.0b1.md +36 -0
- ardguard-0.1.0b1/docs/SECURITY_MODEL.md +85 -0
- ardguard-0.1.0b1/docs/SUPPORTED_SCOPE.md +23 -0
- ardguard-0.1.0b1/docs/support-matrix.json +12 -0
- ardguard-0.1.0b1/examples/ard_search_response/README.md +8 -0
- ardguard-0.1.0b1/examples/ard_search_response/search-response-v0.91.json +21 -0
- ardguard-0.1.0b1/examples/authority/README.md +13 -0
- ardguard-0.1.0b1/examples/authority/discovery.json +20 -0
- ardguard-0.1.0b1/examples/authority/facts.json +21 -0
- ardguard-0.1.0b1/examples/authority/policy.json +7 -0
- ardguard-0.1.0b1/examples/authority/task.json +17 -0
- ardguard-0.1.0b1/examples/basic/README.md +14 -0
- ardguard-0.1.0b1/examples/basic/discovery.json +12 -0
- ardguard-0.1.0b1/examples/basic/facts.json +13 -0
- ardguard-0.1.0b1/examples/basic/policy.json +7 -0
- ardguard-0.1.0b1/examples/basic/task.json +17 -0
- ardguard-0.1.0b1/examples/evidence/README.md +13 -0
- ardguard-0.1.0b1/examples/evidence/discovery.json +22 -0
- ardguard-0.1.0b1/examples/evidence/facts.json +41 -0
- ardguard-0.1.0b1/examples/evidence/policy.json +7 -0
- ardguard-0.1.0b1/examples/evidence/task.json +17 -0
- ardguard-0.1.0b1/examples/fallback/README.md +14 -0
- ardguard-0.1.0b1/examples/fallback/discovery.json +22 -0
- ardguard-0.1.0b1/examples/fallback/facts.json +73 -0
- ardguard-0.1.0b1/examples/fallback/policy.json +7 -0
- ardguard-0.1.0b1/examples/fallback/task.json +17 -0
- ardguard-0.1.0b1/examples/hf_discover/search-response-1.3.7.json +17 -0
- ardguard-0.1.0b1/pyproject.toml +107 -0
- ardguard-0.1.0b1/schemas/decision-v1.schema.json +58 -0
- ardguard-0.1.0b1/schemas/fact-set-v1.schema.json +92 -0
- ardguard-0.1.0b1/schemas/policy-v1.schema.json +20 -0
- ardguard-0.1.0b1/schemas/task-contract-v1.schema.json +40 -0
- ardguard-0.1.0b1/src/ardguard/__init__.py +37 -0
- ardguard-0.1.0b1/src/ardguard/__main__.py +3 -0
- ardguard-0.1.0b1/src/ardguard/adapters/__init__.py +6 -0
- ardguard-0.1.0b1/src/ardguard/adapters/ard.py +89 -0
- ardguard-0.1.0b1/src/ardguard/adapters/hf_discover.py +47 -0
- ardguard-0.1.0b1/src/ardguard/cli.py +392 -0
- ardguard-0.1.0b1/src/ardguard/decision.py +126 -0
- ardguard-0.1.0b1/src/ardguard/eligibility.py +143 -0
- ardguard-0.1.0b1/src/ardguard/models.py +611 -0
- ardguard-0.1.0b1/src/ardguard/providers/__init__.py +6 -0
- ardguard-0.1.0b1/src/ardguard/providers/authority.py +12 -0
- ardguard-0.1.0b1/src/ardguard/providers/base.py +17 -0
- ardguard-0.1.0b1/src/ardguard/providers/capability.py +9 -0
- ardguard-0.1.0b1/src/ardguard/providers/evidence.py +374 -0
- ardguard-0.1.0b1/src/ardguard/providers/static.py +20 -0
- ardguard-0.1.0b1/src/ardguard/py.typed +0 -0
- ardguard-0.1.0b1/src/ardguard/reasons.py +135 -0
- ardguard-0.1.0b1/src/ardguard/schema.py +44 -0
- ardguard-0.1.0b1/src/ardguard/selectors.py +26 -0
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes follow Keep a Changelog conventions. Versions follow semantic
|
|
4
|
+
versioning with Python prerelease identifiers.
|
|
5
|
+
|
|
6
|
+
## [0.1.0b1] - 2026-09-09
|
|
7
|
+
|
|
8
|
+
### Added
|
|
9
|
+
|
|
10
|
+
- Versioned Candidate, TaskContract, FactSet, Policy, CandidateVerdict, and Decision
|
|
11
|
+
contracts.
|
|
12
|
+
- Deterministic eligibility composition across capability, evidence applicability, and
|
|
13
|
+
operator-defined authority facts.
|
|
14
|
+
- Rank-preserving fallback with explicit `SELECT`, `DEFER`, `ABSTAIN`, and `ERROR`
|
|
15
|
+
outcomes.
|
|
16
|
+
- Stable reason codes and a deterministic decision body hash.
|
|
17
|
+
- ARD v0.91 and hf-discover 1.3.7 adapters pinned to exact upstream commits.
|
|
18
|
+
- Offline demo, doctor, validation, evaluation, explanation, support, and adapter CLI
|
|
19
|
+
commands.
|
|
20
|
+
- Experimental network-denied PyPI and Sigstore command-provider boundary with exact
|
|
21
|
+
artifact naming, explicit trust seeds, and typed operational errors.
|
|
22
|
+
- JSON Schemas, integration examples, security model, support matrix, contribution
|
|
23
|
+
policy, package hygiene checks, and Trusted Publishing workflow.
|
|
24
|
+
|
|
25
|
+
### Security
|
|
26
|
+
|
|
27
|
+
- Relevance scores cannot establish eligibility.
|
|
28
|
+
- Input observations cannot assert final eligibility.
|
|
29
|
+
- Missing facts and provider failures fail closed.
|
|
30
|
+
- Operational verifier errors cannot become cryptographic invalidity.
|
|
31
|
+
- Evidence subject, selected resource, artifact digest, signer, trust, and predicate
|
|
32
|
+
checks remain distinct.
|
|
33
|
+
- The package never installs or invokes a selected resource.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
cff-version: 1.2.0
|
|
2
|
+
message: "Citation metadata for the ARDGuard software release."
|
|
3
|
+
title: ARDGuard
|
|
4
|
+
authors:
|
|
5
|
+
- family-names: Chauhan
|
|
6
|
+
given-names: Lokesh
|
|
7
|
+
orcid: "https://orcid.org/0009-0004-1544-6424"
|
|
8
|
+
type: software
|
|
9
|
+
version: 0.1.0b1
|
|
10
|
+
license: Apache-2.0
|
|
11
|
+
repository-code: "https://github.com/lokesh0186/ardguard"
|
|
12
|
+
url: "https://github.com/lokesh0186/ardguard"
|
|
13
|
+
abstract: "ARDGuard is a deterministic eligibility and fallback layer between agentic resource discovery and final selection or invocation."
|
|
14
|
+
keywords:
|
|
15
|
+
- agentic-resource-discovery
|
|
16
|
+
- security
|
|
17
|
+
- eligibility
|
|
18
|
+
- policy
|
|
19
|
+
- fallback
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
ARDGuard welcomes small, reviewable improvements backed by deterministic tests.
|
|
4
|
+
|
|
5
|
+
## Useful contributions
|
|
6
|
+
|
|
7
|
+
- adapter compatibility fixes with pinned real wire fixtures;
|
|
8
|
+
- provider implementations with explicit observation and provenance contracts;
|
|
9
|
+
- reason-code and explanation improvements;
|
|
10
|
+
- malformed-input and fail-closed regressions;
|
|
11
|
+
- integration examples that preserve external ranking and caller-owned invocation;
|
|
12
|
+
- documentation and first-run ergonomics.
|
|
13
|
+
|
|
14
|
+
Open an issue before adding a new trust surface, network behavior, policy language,
|
|
15
|
+
registry, installer, or invocation mechanism.
|
|
16
|
+
|
|
17
|
+
## Development setup
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
python3.12 -m venv .venv
|
|
21
|
+
.venv/bin/pip install -e '.[dev]'
|
|
22
|
+
.venv/bin/ruff check .
|
|
23
|
+
.venv/bin/mypy src/ardguard
|
|
24
|
+
.venv/bin/pytest --cov=ardguard --cov-branch
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Run package checks before a pull request:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
.venv/bin/python -m build
|
|
31
|
+
.venv/bin/python scripts/check_package.py dist
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Required boundaries
|
|
35
|
+
|
|
36
|
+
- Do not add automatic resource installation or invocation.
|
|
37
|
+
- Do not convert relevance scores into trust or eligibility.
|
|
38
|
+
- Do not let callers or providers submit a final eligibility verdict.
|
|
39
|
+
- Do not turn absence, unavailability, or operational error into success.
|
|
40
|
+
- Do not collapse evidence authenticity and applicability.
|
|
41
|
+
- Do not add implicit network access or telemetry.
|
|
42
|
+
- Do not commit credentials, private evidence, local absolute paths, or generated
|
|
43
|
+
package artifacts.
|
|
44
|
+
|
|
45
|
+
Security-relevant changes need a failing-before and passing-after test. Changed
|
|
46
|
+
security-critical modules should retain at least 90 percent branch coverage. Do not
|
|
47
|
+
delete, skip, or weaken a regression to satisfy CI.
|
|
48
|
+
|
|
49
|
+
## Pull requests
|
|
50
|
+
|
|
51
|
+
Keep each pull request focused. State the exact contract or compatibility behavior,
|
|
52
|
+
include the pinned upstream version when applicable, and explain any public schema or
|
|
53
|
+
reason-code impact. Public claims should describe reproduced behavior without calling
|
|
54
|
+
an external project insecure.
|
ardguard-0.1.0b1/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Lokesh Chauhan
|
|
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.
|
ardguard-0.1.0b1/NOTICE
ADDED
|
@@ -0,0 +1,215 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ardguard
|
|
3
|
+
Version: 0.1.0b1
|
|
4
|
+
Summary: Eligibility-aware final selection and fallback for agentic resource discovery
|
|
5
|
+
Project-URL: Homepage, https://github.com/lokesh0186/ardguard
|
|
6
|
+
Project-URL: Repository, https://github.com/lokesh0186/ardguard
|
|
7
|
+
Project-URL: Documentation, https://github.com/lokesh0186/ardguard#readme
|
|
8
|
+
Project-URL: Changelog, https://github.com/lokesh0186/ardguard/blob/main/CHANGELOG.md
|
|
9
|
+
Project-URL: Security, https://github.com/lokesh0186/ardguard/security/policy
|
|
10
|
+
Author: Lokesh Chauhan
|
|
11
|
+
License-Expression: Apache-2.0
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
License-File: NOTICE
|
|
14
|
+
Keywords: agentic-resources,fallback,policy,resource-discovery,security
|
|
15
|
+
Classifier: Development Status :: 4 - Beta
|
|
16
|
+
Classifier: Intended Audience :: Developers
|
|
17
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
22
|
+
Classifier: Topic :: Security
|
|
23
|
+
Requires-Python: <3.14,>=3.10
|
|
24
|
+
Requires-Dist: jsonschema<5,>=4.23
|
|
25
|
+
Provides-Extra: dev
|
|
26
|
+
Requires-Dist: build<2,>=1.2; extra == 'dev'
|
|
27
|
+
Requires-Dist: mypy<3,>=1.15; extra == 'dev'
|
|
28
|
+
Requires-Dist: pytest-cov<8,>=5; extra == 'dev'
|
|
29
|
+
Requires-Dist: pytest<10,>=8; extra == 'dev'
|
|
30
|
+
Requires-Dist: ruff<1,>=0.11; extra == 'dev'
|
|
31
|
+
Description-Content-Type: text/markdown
|
|
32
|
+
|
|
33
|
+
# ARDGuard
|
|
34
|
+
|
|
35
|
+
[](https://pypi.org/project/ardguard/)
|
|
36
|
+
[](https://github.com/lokesh0186/ardguard/actions/workflows/python-compat.yml)
|
|
37
|
+
[](https://pypi.org/project/ardguard/)
|
|
38
|
+
[](LICENSE)
|
|
39
|
+
|
|
40
|
+
**ARDGuard adds an eligibility boundary between agentic resource discovery and final use.**
|
|
41
|
+
|
|
42
|
+
It consumes ranked discovery results, evaluates independently established task-specific
|
|
43
|
+
capability, evidence, and authority observations, and selects the highest-ranked
|
|
44
|
+
eligible resource or returns an explicit defer, abstain, or error decision. It never
|
|
45
|
+
installs or invokes the selected resource.
|
|
46
|
+
|
|
47
|
+
> **Status:** `0.1.0b1` Beta 1. The deterministic core and static observation path are
|
|
48
|
+
> supported. The sandboxed PyPI and Sigstore command provider is experimental. See the
|
|
49
|
+
> [support matrix](docs/SUPPORTED_SCOPE.md) before production use.
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
python -m pip install ardguard==0.1.0b1
|
|
53
|
+
ardguard demo
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
```text
|
|
57
|
+
ARDGuard offline demo (illustrative)
|
|
58
|
+
rank 1: relevant but capability-ineligible
|
|
59
|
+
rank 2: eligible
|
|
60
|
+
top-ranked-only validation: ABSTAIN
|
|
61
|
+
ARDGuard: SELECT urn:air:example.org:tool:rank-two
|
|
62
|
+
reason: selection.fallback_to_lower_ranked_eligible
|
|
63
|
+
invocation: NOT PERFORMED
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Relevance answers **which resource looks useful**. Eligibility answers **which resource
|
|
67
|
+
may this agent use for this task**.
|
|
68
|
+
|
|
69
|
+
## Put it after discovery
|
|
70
|
+
|
|
71
|
+
```text
|
|
72
|
+
ARD-compatible discovery backend
|
|
73
|
+
|
|
|
74
|
+
v
|
|
75
|
+
ranked candidates
|
|
76
|
+
|
|
|
77
|
+
v
|
|
78
|
+
ARDGuard
|
|
79
|
+
facts + policy + fallback
|
|
80
|
+
|
|
|
81
|
+
v
|
|
82
|
+
SELECT / DEFER / ABSTAIN / ERROR
|
|
83
|
+
|
|
|
84
|
+
v
|
|
85
|
+
caller owns invocation
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
ARDGuard does not replace ARD, hf-discover, relevance ranking, Sigstore, OAuth, or
|
|
89
|
+
Kubernetes RBAC. It makes the consumer's final eligibility decision explicit.
|
|
90
|
+
|
|
91
|
+
## JSON in, decision JSON out
|
|
92
|
+
|
|
93
|
+
Prepare a task contract, policy, and observations, then evaluate any supported ARD
|
|
94
|
+
SearchResponse:
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
hf-discover search "read customer records" --json > discovery.json
|
|
98
|
+
|
|
99
|
+
ardguard evaluate \
|
|
100
|
+
--adapter hf-discover \
|
|
101
|
+
--discovery-response discovery.json \
|
|
102
|
+
--task task.json \
|
|
103
|
+
--policy policy.json \
|
|
104
|
+
--facts facts.json \
|
|
105
|
+
--output decision.json
|
|
106
|
+
|
|
107
|
+
ardguard explain decision.json
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Example decision:
|
|
111
|
+
|
|
112
|
+
```json
|
|
113
|
+
{
|
|
114
|
+
"outcome": "SELECT",
|
|
115
|
+
"reason": "selection.fallback_to_lower_ranked_eligible",
|
|
116
|
+
"selected_candidate_id": "urn:air:example.org:tool:rank-two",
|
|
117
|
+
"selected_rank": 2
|
|
118
|
+
}
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
The actual decision document also contains every candidate verdict, stable reason
|
|
122
|
+
codes, provider identities, preserved backend scores, and a deterministic body hash.
|
|
123
|
+
|
|
124
|
+
## Python integration
|
|
125
|
+
|
|
126
|
+
```python
|
|
127
|
+
from ardguard import FactSet, Policy, TaskContract, evaluate
|
|
128
|
+
from ardguard.adapters import parse_search_response
|
|
129
|
+
|
|
130
|
+
candidates = parse_search_response(discovery_response)
|
|
131
|
+
decision = evaluate(
|
|
132
|
+
candidates=candidates,
|
|
133
|
+
task=TaskContract.from_mapping(task_document),
|
|
134
|
+
policy=Policy.from_mapping(policy_document),
|
|
135
|
+
facts=FactSet.from_mapping(fact_document),
|
|
136
|
+
)
|
|
137
|
+
|
|
138
|
+
if decision.outcome.value == "SELECT":
|
|
139
|
+
# The caller may now decide whether and how to invoke the resource.
|
|
140
|
+
print(decision.selected_candidate_id)
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
## Why fallback matters
|
|
144
|
+
|
|
145
|
+
A top-ranked-only validator can reject an ineligible first result, but it also abandons
|
|
146
|
+
the task when a lower-ranked candidate is eligible. ARDGuard evaluates the configured
|
|
147
|
+
candidate set, preserves the backend's rank among eligible candidates, and returns the
|
|
148
|
+
highest-ranked eligible candidate. It does not manufacture or reinterpret relevance
|
|
149
|
+
scores.
|
|
150
|
+
|
|
151
|
+
## Contracts, not self-asserted eligibility
|
|
152
|
+
|
|
153
|
+
Public callers supply observations, not `eligible: true`. ARDGuard derives candidate
|
|
154
|
+
verdicts from versioned contracts:
|
|
155
|
+
|
|
156
|
+
- `TaskContract` states required operations, evidence, and authority limits.
|
|
157
|
+
- `FactSet` binds typed observations to candidate and provider identities.
|
|
158
|
+
- `Policy` controls required checks, uncertainty, and fallback.
|
|
159
|
+
- `Decision` reports `SELECT`, `DEFER`, `ABSTAIN`, or `ERROR` with stable reasons.
|
|
160
|
+
|
|
161
|
+
Missing facts, unavailable verifiers, and operational errors fail closed. An
|
|
162
|
+
operational verifier failure is never reported as an invalid signature. Authentic
|
|
163
|
+
evidence for artifact A never makes candidate B eligible.
|
|
164
|
+
|
|
165
|
+
## Commands
|
|
166
|
+
|
|
167
|
+
| Command | Purpose |
|
|
168
|
+
| --- | --- |
|
|
169
|
+
| `ardguard demo` | Run the deterministic offline fallback example. |
|
|
170
|
+
| `ardguard doctor` | Report package, schema, adapter, and provider readiness. |
|
|
171
|
+
| `ardguard validate` | Validate task, fact, policy, decision, ARD, or hf-discover JSON. |
|
|
172
|
+
| `ardguard evaluate` | Produce a deterministic decision without invocation. |
|
|
173
|
+
| `ardguard explain` | Validate the decision hash and explain its reason. |
|
|
174
|
+
| `ardguard support` | Print the tested support matrix. |
|
|
175
|
+
| `ardguard adapters` | Print exact adapter compatibility records. |
|
|
176
|
+
|
|
177
|
+
## Documentation
|
|
178
|
+
|
|
179
|
+
- [Five-minute integration guide](docs/INTEGRATION_GUIDE.md)
|
|
180
|
+
- [Architecture](docs/ARCHITECTURE.md)
|
|
181
|
+
- [Security model](docs/SECURITY_MODEL.md)
|
|
182
|
+
- [Supported scope](docs/SUPPORTED_SCOPE.md)
|
|
183
|
+
- [Decision and reason codes](docs/DECISIONS.md)
|
|
184
|
+
- [Fact providers](docs/FACT_PROVIDERS.md)
|
|
185
|
+
- [ARD v0.91 compatibility](docs/ARD_COMPATIBILITY.md)
|
|
186
|
+
- [hf-discover integration](docs/HF_DISCOVER.md)
|
|
187
|
+
- [Evidence](docs/EVIDENCE.md)
|
|
188
|
+
- [Authority policy](docs/AUTHORITY.md)
|
|
189
|
+
|
|
190
|
+
## Examples
|
|
191
|
+
|
|
192
|
+
- [Basic capability decision](examples/basic/README.md)
|
|
193
|
+
- [Rank-preserving fallback](examples/fallback/README.md)
|
|
194
|
+
- [Authentic but non-applicable evidence](examples/evidence/README.md)
|
|
195
|
+
- [Authority-aware fallback](examples/authority/README.md)
|
|
196
|
+
- [ARD v0.91 SearchResponse](examples/ard_search_response/README.md)
|
|
197
|
+
- [Pinned hf-discover response](examples/hf_discover/search-response-1.3.7.json)
|
|
198
|
+
|
|
199
|
+
## Development
|
|
200
|
+
|
|
201
|
+
```bash
|
|
202
|
+
python3.12 -m venv .venv
|
|
203
|
+
.venv/bin/pip install -e '.[dev]'
|
|
204
|
+
.venv/bin/pytest
|
|
205
|
+
.venv/bin/ruff check .
|
|
206
|
+
.venv/bin/mypy src/ardguard
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
Small compatibility fixtures, provider implementations, reason-code improvements,
|
|
210
|
+
and reproducible interoperability reports are welcome. Read [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
211
|
+
and [SECURITY.md](SECURITY.md) first.
|
|
212
|
+
|
|
213
|
+
## License
|
|
214
|
+
|
|
215
|
+
Apache License 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
|