sak-guard 0.2.0a1__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.
- sak_guard-0.2.0a1/LICENSE +217 -0
- sak_guard-0.2.0a1/MANIFEST.in +6 -0
- sak_guard-0.2.0a1/PKG-INFO +220 -0
- sak_guard-0.2.0a1/README.md +185 -0
- sak_guard-0.2.0a1/docs/DETECTION_ENVELOPE.md +124 -0
- sak_guard-0.2.0a1/docs/M2_VERIFICATION_REPORT.md +196 -0
- sak_guard-0.2.0a1/docs/SOLANA_PATTERN_BANK_SPEC.md +172 -0
- sak_guard-0.2.0a1/pyproject.toml +72 -0
- sak_guard-0.2.0a1/sak_guard/__init__.py +4 -0
- sak_guard-0.2.0a1/sak_guard/analyzer.py +1362 -0
- sak_guard-0.2.0a1/sak_guard/cli.py +245 -0
- sak_guard-0.2.0a1/sak_guard/dataflow.py +1677 -0
- sak_guard-0.2.0a1/sak_guard/limits.py +50 -0
- sak_guard-0.2.0a1/sak_guard/py.typed +0 -0
- sak_guard-0.2.0a1/sak_guard/solana.py +1118 -0
- sak_guard-0.2.0a1/sak_guard/strategies.py +434 -0
- sak_guard-0.2.0a1/sak_guard/worker.py +39 -0
- sak_guard-0.2.0a1/sak_guard.egg-info/PKG-INFO +220 -0
- sak_guard-0.2.0a1/sak_guard.egg-info/SOURCES.txt +43 -0
- sak_guard-0.2.0a1/sak_guard.egg-info/dependency_links.txt +1 -0
- sak_guard-0.2.0a1/sak_guard.egg-info/entry_points.txt +2 -0
- sak_guard-0.2.0a1/sak_guard.egg-info/requires.txt +7 -0
- sak_guard-0.2.0a1/sak_guard.egg-info/top_level.txt +1 -0
- sak_guard-0.2.0a1/setup.cfg +4 -0
- sak_guard-0.2.0a1/tests/conftest.py +16 -0
- sak_guard-0.2.0a1/tests/fixtures/clean_api.py +13 -0
- sak_guard-0.2.0a1/tests/fixtures/clean_generic_swaps.py +13 -0
- sak_guard-0.2.0a1/tests/fixtures/clean_http_routes.py +10 -0
- sak_guard-0.2.0a1/tests/fixtures/clean_solana_amounts.py +21 -0
- sak_guard-0.2.0a1/tests/fixtures/clean_solana_keys.py +20 -0
- sak_guard-0.2.0a1/tests/fixtures/clean_solana_llm.py +23 -0
- sak_guard-0.2.0a1/tests/fixtures/clean_solana_rpc.py +21 -0
- sak_guard-0.2.0a1/tests/fixtures/clean_solana_signing.py +14 -0
- sak_guard-0.2.0a1/tests/fixtures/vulnerable_api.py +23 -0
- sak_guard-0.2.0a1/tests/fixtures/vulnerable_solana_amounts.py +16 -0
- sak_guard-0.2.0a1/tests/fixtures/vulnerable_solana_keys.py +13 -0
- sak_guard-0.2.0a1/tests/fixtures/vulnerable_solana_llm.py +14 -0
- sak_guard-0.2.0a1/tests/fixtures/vulnerable_solana_rpc.py +12 -0
- sak_guard-0.2.0a1/tests/fixtures/vulnerable_solana_signing.py +17 -0
- sak_guard-0.2.0a1/tests/test_audit_regressions.py +1802 -0
- sak_guard-0.2.0a1/tests/test_cli.py +160 -0
- sak_guard-0.2.0a1/tests/test_review_boundaries.py +302 -0
- sak_guard-0.2.0a1/tests/test_solana_patterns.py +139 -0
- sak_guard-0.2.0a1/tests/test_takeover_patterns.py +96 -0
- sak_guard-0.2.0a1/tests/test_takeover_security.py +262 -0
|
@@ -0,0 +1,217 @@
|
|
|
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
|
+
|
|
203
|
+
------------------------------------------------------------------------------
|
|
204
|
+
|
|
205
|
+
Copyright 2026 Pantronux Research (Lead: Irfan Achmad Firmansyah)
|
|
206
|
+
|
|
207
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
208
|
+
you may not use this file except in compliance with the License.
|
|
209
|
+
You may obtain a copy of the License at
|
|
210
|
+
|
|
211
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
212
|
+
|
|
213
|
+
Unless required by applicable law or agreed to in writing, software
|
|
214
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
215
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
216
|
+
See the License for the specific language governing permissions and
|
|
217
|
+
limitations under the License.
|
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: sak-guard
|
|
3
|
+
Version: 0.2.0a1
|
|
4
|
+
Summary: Static pre-commit security guardrail for Solana Agent Kit and agent-client code. The static complement to a runtime transaction firewall.
|
|
5
|
+
Author: Pantronux Research (Lead: Irfan Achmad Firmansyah)
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/Pantronux-Research/sak-guard
|
|
8
|
+
Project-URL: Repository, https://github.com/Pantronux-Research/sak-guard.git
|
|
9
|
+
Project-URL: Issues, https://github.com/Pantronux-Research/sak-guard/issues
|
|
10
|
+
Project-URL: Changelog, https://github.com/Pantronux-Research/sak-guard/releases
|
|
11
|
+
Project-URL: Security, https://github.com/Pantronux-Research/sak-guard/security/policy
|
|
12
|
+
Keywords: solana,security,static-analysis,solana-agent-kit,linter,guardrail,pre-commit,ai-agents
|
|
13
|
+
Classifier: Development Status :: 3 - Alpha
|
|
14
|
+
Classifier: Environment :: Console
|
|
15
|
+
Classifier: Intended Audience :: Developers
|
|
16
|
+
Classifier: Operating System :: OS Independent
|
|
17
|
+
Classifier: Programming Language :: Python :: 3
|
|
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: Programming Language :: Python :: 3.14
|
|
23
|
+
Classifier: Topic :: Security
|
|
24
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
25
|
+
Classifier: Typing :: Typed
|
|
26
|
+
Requires-Python: >=3.10
|
|
27
|
+
Description-Content-Type: text/markdown
|
|
28
|
+
License-File: LICENSE
|
|
29
|
+
Provides-Extra: llm
|
|
30
|
+
Requires-Dist: openai>=1.0; extra == "llm"
|
|
31
|
+
Provides-Extra: dev
|
|
32
|
+
Requires-Dist: pytest>=7; extra == "dev"
|
|
33
|
+
Requires-Dist: build>=1.0; extra == "dev"
|
|
34
|
+
Dynamic: license-file
|
|
35
|
+
|
|
36
|
+
# sak-guard
|
|
37
|
+
|
|
38
|
+
[](https://github.com/Pantronux-Research/sak-guard/actions/workflows/ci.yml)
|
|
39
|
+
[](https://github.com/Pantronux-Research/sak-guard/blob/main/LICENSE)
|
|
40
|
+
[](https://github.com/Pantronux-Research/sak-guard/blob/main/pyproject.toml)
|
|
41
|
+
[](https://pypi.org/project/sak-guard/)
|
|
42
|
+
[](#status)
|
|
43
|
+
|
|
44
|
+
**Static pre-commit security guardrail for Solana agent code.**
|
|
45
|
+
The static complement to a runtime transaction firewall.
|
|
46
|
+
|
|
47
|
+
> **Status: 0.2.0a1 release candidate.** Five Solana rule families are implemented.
|
|
48
|
+
> This is an alpha heuristic guardrail. Read the [detection envelope](docs/DETECTION_ENVELOPE.md)
|
|
49
|
+
> before using a passing result as a release decision.
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## Why this exists
|
|
54
|
+
|
|
55
|
+
Solana's agent ecosystem is adding transaction capability faster than safety tooling.
|
|
56
|
+
`solana-agent-kit` lets an agent construct and submit transactions, and the community is
|
|
57
|
+
patching the gap ad hoc — most visibly
|
|
58
|
+
[`sendaifun/solana-agent-kit#575`](https://github.com/sendaifun/solana-agent-kit/issues/575),
|
|
59
|
+
which proposes `@prflght/sak-plugin`, a plugin that wraps the SAK execution flow to
|
|
60
|
+
**intercept every transaction before it lands on-chain**.
|
|
61
|
+
|
|
62
|
+
That is a **runtime** control. It sees a transaction at the moment it is built. It does not
|
|
63
|
+
see, and cannot stop, the bad *code* that builds it — an agent-authored tool that sources a
|
|
64
|
+
keypair from the wrong place, leaks a seed into a prompt, or does something other than what
|
|
65
|
+
its description claims. By the time a runtime firewall has something to intercept, the
|
|
66
|
+
vulnerable code is already merged and running.
|
|
67
|
+
|
|
68
|
+
`sak-guard` asks a different question, earlier:
|
|
69
|
+
|
|
70
|
+
> Before this code is merged — does it do what it claims to do, and does it handle keys and
|
|
71
|
+
> transactions safely?
|
|
72
|
+
|
|
73
|
+
The two are **complements, not competitors**. Use both.
|
|
74
|
+
|
|
75
|
+
## Install
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
# Install this unpublished candidate from the reviewed checkout:
|
|
79
|
+
python -m pip install .
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Requires **Python >= 3.10** (see [why the floor is 3.10 rather than 3.9](https://github.com/Pantronux-Research/sak-guard/blob/main/pyproject.toml)).
|
|
83
|
+
|
|
84
|
+
No runtime dependencies — the engine is stdlib-only, so a pre-commit hook does not have to
|
|
85
|
+
touch your environment.
|
|
86
|
+
|
|
87
|
+
## Use
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
sak-guard FILE|DIR # audit a file or a tree
|
|
91
|
+
sak-guard - # Python source on stdin (not a git diff)
|
|
92
|
+
sak-guard F --json # machine-readable
|
|
93
|
+
sak-guard F --fail-on X # critical | high | medium | low | any | never
|
|
94
|
+
sak-guard F --strategy S # security-focused (default) | default | ast-heavy | intent-focused
|
|
95
|
+
sak-guard F --intent "..." # what the code is supposed to do
|
|
96
|
+
sak-guard F --use-llm # optional LLM intent pass (provider from LLM_* env)
|
|
97
|
+
sak-guard F --language python # source language (default: python)
|
|
98
|
+
sak-guard F --quiet # only print failing targets
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
Exit codes: **0** clean or below threshold · **1** findings at/above threshold · **2** usage,
|
|
102
|
+
IO, parse or incomplete-analysis error. Scan errors remain exit 2 with `--fail-on never`.
|
|
103
|
+
That option suppresses the failure status for completed findings only.
|
|
104
|
+
|
|
105
|
+
`reports[].passed` means there are no High/Critical findings; it is independent of
|
|
106
|
+
the selected CLI threshold. An incomplete report always has `passed: false`.
|
|
107
|
+
|
|
108
|
+
```console
|
|
109
|
+
$ sak-guard tests/fixtures/vulnerable_api.py
|
|
110
|
+
tests/fixtures/vulnerable_api.py: 3 issue(s) (confidence 0.95)
|
|
111
|
+
[critical]:13 security: Hardcoded secret/credential detected
|
|
112
|
+
fix: Use environment variables or a secrets manager
|
|
113
|
+
[critical]:23 security: Use of eval() is a security risk — allows arbitrary code execution
|
|
114
|
+
fix: Use ast.literal_eval() for safe evaluation or avoid eval entirely
|
|
115
|
+
[high]:9 security: subprocess with shell=True allows shell injection
|
|
116
|
+
fix: Use shell=False and pass args as a list
|
|
117
|
+
|
|
118
|
+
3 issue(s) across 1 target(s); fail-on=high
|
|
119
|
+
$ echo $?
|
|
120
|
+
1
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Why the default strategy is `security-focused`
|
|
124
|
+
|
|
125
|
+
The base analyzer bank covers hardcoded secrets and `eval()`. It does **not** look for shell
|
|
126
|
+
injection at all — no `os.system` or `shell=True` pattern exists in it. Those live in the
|
|
127
|
+
`security-focused` strategy's extra patterns. A security auditor defaulting to the base bank
|
|
128
|
+
reports **"clean" on `subprocess.call(cmd, shell=True)`**. So the CLI defaults to the bank
|
|
129
|
+
that actually looks for command injection.
|
|
130
|
+
|
|
131
|
+
Verify this yourself: run the same fixture with `--strategy default` and count.
|
|
132
|
+
|
|
133
|
+
## Pre-commit
|
|
134
|
+
|
|
135
|
+
```yaml
|
|
136
|
+
# .pre-commit-config.yaml
|
|
137
|
+
repos:
|
|
138
|
+
- repo: https://github.com/Pantronux-Research/sak-guard
|
|
139
|
+
rev: v0.2.0-alpha.1 # use the reviewed release tag once it exists
|
|
140
|
+
hooks:
|
|
141
|
+
- id: sak-guard
|
|
142
|
+
args: ["--fail-on", "high"]
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
Each pre-commit file scan uses its own isolated process. Budget roughly 0.1
|
|
146
|
+
seconds of process startup per small file on the review machine; 100 files can
|
|
147
|
+
add about 10 seconds before substantial analysis. Measure this on your runner.
|
|
148
|
+
For larger projects, scope the consumer hook to all key-handling and
|
|
149
|
+
transaction-building paths, for example:
|
|
150
|
+
|
|
151
|
+
```yaml
|
|
152
|
+
- id: sak-guard
|
|
153
|
+
files: ^(src/transaction_client/|src/agents/|tests/solana/)
|
|
154
|
+
require_serial: true
|
|
155
|
+
args: ["--fail-on", "high"]
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
Replace those example paths with your own complete set. Files outside the filter
|
|
159
|
+
receive no checks. `require_serial` avoids competing hook processes on a loaded
|
|
160
|
+
runner; it does not reuse workers. The 15-second deadline is a per-file analysis
|
|
161
|
+
budget, not a promise that every valid generated module fits it. A timeout exits
|
|
162
|
+
2 and requires investigation; it never becomes a passing verdict.
|
|
163
|
+
|
|
164
|
+
## GitHub Actions
|
|
165
|
+
|
|
166
|
+
```yaml
|
|
167
|
+
- run: python -m pip install .
|
|
168
|
+
- run: sak-guard src/ --fail-on high
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
## Three engines
|
|
172
|
+
|
|
173
|
+
1. **AST analysis** — structural inspection: where keypairs are sourced, whether transaction
|
|
174
|
+
construction is validated, whether signing is gated.
|
|
175
|
+
2. **Security pattern banks** — AST checks for hardcoded secrets, `eval`/`exec`,
|
|
176
|
+
`subprocess(..., shell=True)` and unsafe deserialization. Text heuristics supply
|
|
177
|
+
additional advisory diagnostics.
|
|
178
|
+
3. **Intent-mismatch verification** *(in progress)* — declare what a tool is *supposed* to
|
|
179
|
+
do; fail the build when the implementation diverges. No existing Solana safety tool does
|
|
180
|
+
this statically.
|
|
181
|
+
|
|
182
|
+
## Detection envelope
|
|
183
|
+
|
|
184
|
+
**Read this before treating a pass as proof.** `sak-guard` is static analysis. It will miss
|
|
185
|
+
whole vulnerability classes:
|
|
186
|
+
|
|
187
|
+
- anything depending on **runtime state**, **economic conditions**, or **on-chain state** —
|
|
188
|
+
none of which exist at commit time;
|
|
189
|
+
- logic errors that are syntactically safe;
|
|
190
|
+
- vulnerabilities in dependencies.
|
|
191
|
+
|
|
192
|
+
It is not a replacement for a runtime firewall, a fuzzer, or a formal audit. We publish our
|
|
193
|
+
detection gaps and false-positive rate rather than hide them, because a safety tool that
|
|
194
|
+
overstates its coverage **is itself a risk**. Current measured rates are in
|
|
195
|
+
[`VERIFICATION.md`](VERIFICATION.md).
|
|
196
|
+
|
|
197
|
+
The [current rule contract](docs/DETECTION_ENVELOPE.md) describes the signing and amount
|
|
198
|
+
proxies, conservative false positives, resource limits and unsupported flows. Historical
|
|
199
|
+
verification reports describe their own snapshots, not this release candidate.
|
|
200
|
+
|
|
201
|
+
Each CLI file scan has a 15-second worker deadline (60 seconds with explicit LLM use),
|
|
202
|
+
a 4 MiB source limit and a 200,000-node AST limit. Analysis never imports or executes
|
|
203
|
+
submitted code. Only `--use-llm` permits sending source to a configured provider.
|
|
204
|
+
|
|
205
|
+
## Roadmap
|
|
206
|
+
|
|
207
|
+
- [x] Decoupled CLI, stdlib-only, no server
|
|
208
|
+
- [x] AST + regex engines with verified pass/fail behaviour
|
|
209
|
+
- [x] Initial Solana banks: key handling, RPC, model provenance, signing and amount bounds
|
|
210
|
+
- [ ] GitHub Action with inline PR annotations
|
|
211
|
+
- [ ] Intent-mismatch verification, published fixtures
|
|
212
|
+
- [x] Documented detection envelope and regression fixtures
|
|
213
|
+
|
|
214
|
+
## License
|
|
215
|
+
|
|
216
|
+
Apache-2.0. See [LICENSE](LICENSE).
|
|
217
|
+
|
|
218
|
+
---
|
|
219
|
+
|
|
220
|
+
*Pantronux Research (Lead: Irfan Achmad Firmansyah) — Indonesia*
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
# sak-guard
|
|
2
|
+
|
|
3
|
+
[](https://github.com/Pantronux-Research/sak-guard/actions/workflows/ci.yml)
|
|
4
|
+
[](https://github.com/Pantronux-Research/sak-guard/blob/main/LICENSE)
|
|
5
|
+
[](https://github.com/Pantronux-Research/sak-guard/blob/main/pyproject.toml)
|
|
6
|
+
[](https://pypi.org/project/sak-guard/)
|
|
7
|
+
[](#status)
|
|
8
|
+
|
|
9
|
+
**Static pre-commit security guardrail for Solana agent code.**
|
|
10
|
+
The static complement to a runtime transaction firewall.
|
|
11
|
+
|
|
12
|
+
> **Status: 0.2.0a1 release candidate.** Five Solana rule families are implemented.
|
|
13
|
+
> This is an alpha heuristic guardrail. Read the [detection envelope](docs/DETECTION_ENVELOPE.md)
|
|
14
|
+
> before using a passing result as a release decision.
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## Why this exists
|
|
19
|
+
|
|
20
|
+
Solana's agent ecosystem is adding transaction capability faster than safety tooling.
|
|
21
|
+
`solana-agent-kit` lets an agent construct and submit transactions, and the community is
|
|
22
|
+
patching the gap ad hoc — most visibly
|
|
23
|
+
[`sendaifun/solana-agent-kit#575`](https://github.com/sendaifun/solana-agent-kit/issues/575),
|
|
24
|
+
which proposes `@prflght/sak-plugin`, a plugin that wraps the SAK execution flow to
|
|
25
|
+
**intercept every transaction before it lands on-chain**.
|
|
26
|
+
|
|
27
|
+
That is a **runtime** control. It sees a transaction at the moment it is built. It does not
|
|
28
|
+
see, and cannot stop, the bad *code* that builds it — an agent-authored tool that sources a
|
|
29
|
+
keypair from the wrong place, leaks a seed into a prompt, or does something other than what
|
|
30
|
+
its description claims. By the time a runtime firewall has something to intercept, the
|
|
31
|
+
vulnerable code is already merged and running.
|
|
32
|
+
|
|
33
|
+
`sak-guard` asks a different question, earlier:
|
|
34
|
+
|
|
35
|
+
> Before this code is merged — does it do what it claims to do, and does it handle keys and
|
|
36
|
+
> transactions safely?
|
|
37
|
+
|
|
38
|
+
The two are **complements, not competitors**. Use both.
|
|
39
|
+
|
|
40
|
+
## Install
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
# Install this unpublished candidate from the reviewed checkout:
|
|
44
|
+
python -m pip install .
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Requires **Python >= 3.10** (see [why the floor is 3.10 rather than 3.9](https://github.com/Pantronux-Research/sak-guard/blob/main/pyproject.toml)).
|
|
48
|
+
|
|
49
|
+
No runtime dependencies — the engine is stdlib-only, so a pre-commit hook does not have to
|
|
50
|
+
touch your environment.
|
|
51
|
+
|
|
52
|
+
## Use
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
sak-guard FILE|DIR # audit a file or a tree
|
|
56
|
+
sak-guard - # Python source on stdin (not a git diff)
|
|
57
|
+
sak-guard F --json # machine-readable
|
|
58
|
+
sak-guard F --fail-on X # critical | high | medium | low | any | never
|
|
59
|
+
sak-guard F --strategy S # security-focused (default) | default | ast-heavy | intent-focused
|
|
60
|
+
sak-guard F --intent "..." # what the code is supposed to do
|
|
61
|
+
sak-guard F --use-llm # optional LLM intent pass (provider from LLM_* env)
|
|
62
|
+
sak-guard F --language python # source language (default: python)
|
|
63
|
+
sak-guard F --quiet # only print failing targets
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Exit codes: **0** clean or below threshold · **1** findings at/above threshold · **2** usage,
|
|
67
|
+
IO, parse or incomplete-analysis error. Scan errors remain exit 2 with `--fail-on never`.
|
|
68
|
+
That option suppresses the failure status for completed findings only.
|
|
69
|
+
|
|
70
|
+
`reports[].passed` means there are no High/Critical findings; it is independent of
|
|
71
|
+
the selected CLI threshold. An incomplete report always has `passed: false`.
|
|
72
|
+
|
|
73
|
+
```console
|
|
74
|
+
$ sak-guard tests/fixtures/vulnerable_api.py
|
|
75
|
+
tests/fixtures/vulnerable_api.py: 3 issue(s) (confidence 0.95)
|
|
76
|
+
[critical]:13 security: Hardcoded secret/credential detected
|
|
77
|
+
fix: Use environment variables or a secrets manager
|
|
78
|
+
[critical]:23 security: Use of eval() is a security risk — allows arbitrary code execution
|
|
79
|
+
fix: Use ast.literal_eval() for safe evaluation or avoid eval entirely
|
|
80
|
+
[high]:9 security: subprocess with shell=True allows shell injection
|
|
81
|
+
fix: Use shell=False and pass args as a list
|
|
82
|
+
|
|
83
|
+
3 issue(s) across 1 target(s); fail-on=high
|
|
84
|
+
$ echo $?
|
|
85
|
+
1
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Why the default strategy is `security-focused`
|
|
89
|
+
|
|
90
|
+
The base analyzer bank covers hardcoded secrets and `eval()`. It does **not** look for shell
|
|
91
|
+
injection at all — no `os.system` or `shell=True` pattern exists in it. Those live in the
|
|
92
|
+
`security-focused` strategy's extra patterns. A security auditor defaulting to the base bank
|
|
93
|
+
reports **"clean" on `subprocess.call(cmd, shell=True)`**. So the CLI defaults to the bank
|
|
94
|
+
that actually looks for command injection.
|
|
95
|
+
|
|
96
|
+
Verify this yourself: run the same fixture with `--strategy default` and count.
|
|
97
|
+
|
|
98
|
+
## Pre-commit
|
|
99
|
+
|
|
100
|
+
```yaml
|
|
101
|
+
# .pre-commit-config.yaml
|
|
102
|
+
repos:
|
|
103
|
+
- repo: https://github.com/Pantronux-Research/sak-guard
|
|
104
|
+
rev: v0.2.0-alpha.1 # use the reviewed release tag once it exists
|
|
105
|
+
hooks:
|
|
106
|
+
- id: sak-guard
|
|
107
|
+
args: ["--fail-on", "high"]
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Each pre-commit file scan uses its own isolated process. Budget roughly 0.1
|
|
111
|
+
seconds of process startup per small file on the review machine; 100 files can
|
|
112
|
+
add about 10 seconds before substantial analysis. Measure this on your runner.
|
|
113
|
+
For larger projects, scope the consumer hook to all key-handling and
|
|
114
|
+
transaction-building paths, for example:
|
|
115
|
+
|
|
116
|
+
```yaml
|
|
117
|
+
- id: sak-guard
|
|
118
|
+
files: ^(src/transaction_client/|src/agents/|tests/solana/)
|
|
119
|
+
require_serial: true
|
|
120
|
+
args: ["--fail-on", "high"]
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
Replace those example paths with your own complete set. Files outside the filter
|
|
124
|
+
receive no checks. `require_serial` avoids competing hook processes on a loaded
|
|
125
|
+
runner; it does not reuse workers. The 15-second deadline is a per-file analysis
|
|
126
|
+
budget, not a promise that every valid generated module fits it. A timeout exits
|
|
127
|
+
2 and requires investigation; it never becomes a passing verdict.
|
|
128
|
+
|
|
129
|
+
## GitHub Actions
|
|
130
|
+
|
|
131
|
+
```yaml
|
|
132
|
+
- run: python -m pip install .
|
|
133
|
+
- run: sak-guard src/ --fail-on high
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
## Three engines
|
|
137
|
+
|
|
138
|
+
1. **AST analysis** — structural inspection: where keypairs are sourced, whether transaction
|
|
139
|
+
construction is validated, whether signing is gated.
|
|
140
|
+
2. **Security pattern banks** — AST checks for hardcoded secrets, `eval`/`exec`,
|
|
141
|
+
`subprocess(..., shell=True)` and unsafe deserialization. Text heuristics supply
|
|
142
|
+
additional advisory diagnostics.
|
|
143
|
+
3. **Intent-mismatch verification** *(in progress)* — declare what a tool is *supposed* to
|
|
144
|
+
do; fail the build when the implementation diverges. No existing Solana safety tool does
|
|
145
|
+
this statically.
|
|
146
|
+
|
|
147
|
+
## Detection envelope
|
|
148
|
+
|
|
149
|
+
**Read this before treating a pass as proof.** `sak-guard` is static analysis. It will miss
|
|
150
|
+
whole vulnerability classes:
|
|
151
|
+
|
|
152
|
+
- anything depending on **runtime state**, **economic conditions**, or **on-chain state** —
|
|
153
|
+
none of which exist at commit time;
|
|
154
|
+
- logic errors that are syntactically safe;
|
|
155
|
+
- vulnerabilities in dependencies.
|
|
156
|
+
|
|
157
|
+
It is not a replacement for a runtime firewall, a fuzzer, or a formal audit. We publish our
|
|
158
|
+
detection gaps and false-positive rate rather than hide them, because a safety tool that
|
|
159
|
+
overstates its coverage **is itself a risk**. Current measured rates are in
|
|
160
|
+
[`VERIFICATION.md`](VERIFICATION.md).
|
|
161
|
+
|
|
162
|
+
The [current rule contract](docs/DETECTION_ENVELOPE.md) describes the signing and amount
|
|
163
|
+
proxies, conservative false positives, resource limits and unsupported flows. Historical
|
|
164
|
+
verification reports describe their own snapshots, not this release candidate.
|
|
165
|
+
|
|
166
|
+
Each CLI file scan has a 15-second worker deadline (60 seconds with explicit LLM use),
|
|
167
|
+
a 4 MiB source limit and a 200,000-node AST limit. Analysis never imports or executes
|
|
168
|
+
submitted code. Only `--use-llm` permits sending source to a configured provider.
|
|
169
|
+
|
|
170
|
+
## Roadmap
|
|
171
|
+
|
|
172
|
+
- [x] Decoupled CLI, stdlib-only, no server
|
|
173
|
+
- [x] AST + regex engines with verified pass/fail behaviour
|
|
174
|
+
- [x] Initial Solana banks: key handling, RPC, model provenance, signing and amount bounds
|
|
175
|
+
- [ ] GitHub Action with inline PR annotations
|
|
176
|
+
- [ ] Intent-mismatch verification, published fixtures
|
|
177
|
+
- [x] Documented detection envelope and regression fixtures
|
|
178
|
+
|
|
179
|
+
## License
|
|
180
|
+
|
|
181
|
+
Apache-2.0. See [LICENSE](LICENSE).
|
|
182
|
+
|
|
183
|
+
---
|
|
184
|
+
|
|
185
|
+
*Pantronux Research (Lead: Irfan Achmad Firmansyah) — Indonesia*
|