@theonly1me/vigilante 0.0.0-stage → 0.1.1
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.
- package/LICENSE-APACHE +176 -0
- package/LICENSE-MIT +21 -0
- package/README.md +178 -2
- package/bin/vigilante.js +42 -0
- package/package.json +33 -4
package/LICENSE-APACHE
ADDED
|
@@ -0,0 +1,176 @@
|
|
|
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
|
package/LICENSE-MIT
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Atchyut Preetham Pulavarthi
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,179 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
|
+
<img src="https://raw.githubusercontent.com/theonly1me/vigilante/v0.1.1/assets/vigilante-wordmark-white-bg.webp" alt="Vigilante" width="360">
|
|
3
|
+
<p><b>See what a pull request lets your code, your CI, and your AI agents do, before you merge it.</b></p>
|
|
4
|
+
<p>
|
|
5
|
+
<a href="https://github.com/theonly1me/vigilante/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/theonly1me/vigilante/ci.yml?branch=main&label=CI&logo=github" alt="CI"></a>
|
|
6
|
+
<a href="https://github.com/theonly1me/vigilante/releases/latest"><img src="https://img.shields.io/github/v/release/theonly1me/vigilante?label=release" alt="Latest release"></a>
|
|
7
|
+
<a href="https://crates.io/crates/vigilante"><img src="https://img.shields.io/crates/v/vigilante?logo=rust" alt="crates.io"></a>
|
|
8
|
+
<a href="https://www.npmjs.com/package/@theonly1me/vigilante"><img src="https://img.shields.io/npm/v/@theonly1me/vigilante?logo=npm" alt="npm"></a>
|
|
9
|
+
<a href="https://pypi.org/project/vigilante-scan/"><img src="https://img.shields.io/pypi/v/vigilante-scan?logo=pypi&logoColor=white" alt="PyPI"></a>
|
|
10
|
+
<a href="#license"><img src="https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue" alt="License: MIT OR Apache-2.0"></a>
|
|
11
|
+
<a href="https://github.com/theonly1me/vigilante/blob/main/Cargo.toml"><img src="https://img.shields.io/badge/rust-1.88%2B-orange?logo=rust" alt="Rust 1.88 or later"></a>
|
|
12
|
+
</p>
|
|
13
|
+
</div>
|
|
2
14
|
|
|
3
|
-
|
|
15
|
+
Vigilante reads a pull request and lists the new powers that the pull request adds. A power is an action that a change lets code, CI, a build, or an AI agent do. Examples are the first `subprocess` call in a package, a CI token that can push, a new MCP server, and a new install script.
|
|
16
|
+
|
|
17
|
+
Your security team approves powers in a `vigilante.lock` file. If a pull request adds a power that is not in the lock, the check fails.
|
|
18
|
+
|
|
19
|
+
By default, Vigilante does not run code from the repository that it checks. It reads the files and resolves calls by type. It uses [Capslock](https://github.com/google/capslock) for Go, the TypeScript type checker for JavaScript and TypeScript, and Pyright for Python. These tools read code, and they do not run it. Vigilante also downloads the locked packages from their public registries and reads them. If you set `[engines] rust = "typed"`, Vigilante builds the Rust code in a Docker container that has no network access ([docs/dependencies.md](https://github.com/theonly1me/vigilante/blob/v0.1.1/docs/dependencies.md#calls-resolved-by-type)).
|
|
20
|
+
|
|
21
|
+
## Why
|
|
22
|
+
|
|
23
|
+
AI agents open more pull requests than people can read line by line. A one-line change can change what each later agent run and CI job can do. Examples are a change to `.mcp.json`, `.claude/settings.json`, a workflow, or a `postinstall` script. Vigilante shows these changes at the top of the pull request. It uses the same format for each language and each type of file.
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
An agent opens a pull request that exports invoices. Vigilante gives this report:
|
|
28
|
+
|
|
29
|
+
> ## Vigilante: this pull request adds 6 new powers
|
|
30
|
+
>
|
|
31
|
+
> | Severity | Scope | Power | What it means | Evidence | Status |
|
|
32
|
+
> | --- | --- | --- | --- | --- | --- |
|
|
33
|
+
> | HIGH | `services/billing` (code) | `exec` | Can run other programs | `services/billing/billing/export.py:5 via export.export → subprocess.run` | **not in lock** |
|
|
34
|
+
> | HIGH | `.mcp.json` (agent) | `mcp_server:fs-tools: npx -y fs-tools-mcp` | The agent connects to an MCP server | `.mcp.json:3` | **not in lock** |
|
|
35
|
+
> | MEDIUM | `.github/workflows` (ci) | `third_party_action:acme-tools/publish-action` | The workflow runs a third-party action | `.github/workflows/release.yml:12` | **not in lock** |
|
|
36
|
+
> | MEDIUM | `.github/workflows/release.yml` (ci) | `token_write:contents` | The CI token can write to the repository | `.github/workflows/release.yml:6` | **not in lock** |
|
|
37
|
+
> | MEDIUM | `.github/workflows/release.yml` (ci) | `secret:PYPI_TOKEN` | The workflow reads a secret | `.github/workflows/release.yml:14` | **not in lock** |
|
|
38
|
+
> | MEDIUM | `.claude/settings.json` (agent) | `tool_allow:Bash(curl:*)` | The agent can use a tool without asking | `.claude/settings.json:3` | **not in lock** |
|
|
39
|
+
>
|
|
40
|
+
> **Result: fail.** 6 powers are not in vigilante.lock. Run `vigilante lock` and commit the file.
|
|
41
|
+
|
|
42
|
+
The same pull request also added a second network call to `services/billing`, the allow rules `Bash(pytest:*)` and `Read`, and a call to `actions/checkout`. Vigilante does not report them, for these reasons:
|
|
43
|
+
|
|
44
|
+
- The package already used the network.
|
|
45
|
+
- An allow rule for a test runner has a low risk.
|
|
46
|
+
- `Read` only reads files.
|
|
47
|
+
- The `actions/` actions are first party.
|
|
48
|
+
|
|
49
|
+
## What it checks
|
|
50
|
+
|
|
51
|
+
| Surface | Files | Powers |
|
|
52
|
+
| --- | --- | --- |
|
|
53
|
+
| Code | Rust, JavaScript, TypeScript, Python, Ruby, C#, Java, and Go | `exec`, `network`, `files`, `native`, `dynamic_code`, `read_system_state`, `modify_system_state`, `system_calls` |
|
|
54
|
+
| Code, through dependencies | Go with [Capslock](https://github.com/google/capslock). JavaScript, TypeScript, Python, Java, Rust, C#, and Ruby with the call graph of Vigilante over the locked packages. Calls resolve by type in JavaScript, TypeScript, and Python, and through the class hierarchy in Java and C#. | Each code power, with the call path. For Go, all 13 Capslock capabilities, for example `operating_system`, `runtime`, `arbitrary_execution`, and `unanalyzed`. |
|
|
55
|
+
| CI | `.github/workflows/*.yml` | `token_write`, `oidc`, `untrusted_trigger`, `third_party_action`, `secret` |
|
|
56
|
+
| AI agents | `.claude/settings.json`, `.mcp.json`, `.cursor/mcp.json`, `.vscode/mcp.json`, `.codex/config.toml`, `.gemini/settings.json` | `tool_allow`, `hook`, `mcp_server`, `skip_permissions` |
|
|
57
|
+
| Build | `package.json` install scripts, `build.rs`, `setup.py`, `.husky/`, `.pre-commit-config.yaml` | `install_hook`, `git_hook` |
|
|
58
|
+
|
|
59
|
+
Vigilante reports a power only the first time that it appears in a scope. For code, a scope is the nearest package root. For Go, a scope is the Go package. Vigilante skips tests, fixtures, and vendored code. [docs/powers.md](https://github.com/theonly1me/vigilante/blob/v0.1.1/docs/powers.md) tells you about each power and the rules that keep the report short.
|
|
60
|
+
|
|
61
|
+
A finding is `exec`, `network`, or `native` that your package reaches through its own code. This rule is the same in each language. All other results are notes:
|
|
62
|
+
|
|
63
|
+
- another power that your own code reaches;
|
|
64
|
+
- a power that your package reaches only through a dependency, or through another package of the same repository;
|
|
65
|
+
- a new package on a call path to a power.
|
|
66
|
+
|
|
67
|
+
Notes do not make the check fail. For example, a new dependency that reaches the network is a note. [docs/dependencies.md](https://github.com/theonly1me/vigilante/blob/v0.1.1/docs/dependencies.md) tells you how Vigilante reads packages.
|
|
68
|
+
|
|
69
|
+
## Install
|
|
70
|
+
|
|
71
|
+
Vigilante is one static binary for Linux and macOS, on x86_64 and arm64. Use the package manager that your team uses. The command is always `vigilante`.
|
|
72
|
+
|
|
73
|
+
| Package manager | Command |
|
|
74
|
+
| --- | --- |
|
|
75
|
+
| npm | `npm install --save-dev @theonly1me/vigilante` or `npx @theonly1me/vigilante` |
|
|
76
|
+
| PyPI | `pip install vigilante-scan` or `uvx --from vigilante-scan vigilante` |
|
|
77
|
+
| Homebrew | `brew install theonly1me/tap/vigilante` |
|
|
78
|
+
| Cargo | `cargo install vigilante --locked` |
|
|
79
|
+
| GitHub Releases | Download `vigilante-<target>.tar.gz` from the [releases page](https://github.com/theonly1me/vigilante/releases). |
|
|
80
|
+
|
|
81
|
+
Each release file has a build attestation. To make sure that an archive comes from the release workflow of this repository, run this command:
|
|
82
|
+
|
|
83
|
+
```sh
|
|
84
|
+
gh attestation verify vigilante-x86_64-unknown-linux-musl.tar.gz --repo theonly1me/vigilante
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Vigilante does not support Windows. To check Go code, Vigilante needs `go` and `capslock`. To install Capslock, run `go install github.com/google/capslock/cmd/capslock@v0.3.3`. The GitHub Action installs both.
|
|
88
|
+
|
|
89
|
+
## Quick start
|
|
90
|
+
|
|
91
|
+
Run these commands in the root of your repository.
|
|
92
|
+
|
|
93
|
+
| Command | What it does |
|
|
94
|
+
| --- | --- |
|
|
95
|
+
| `vigilante scan` | Shows each power in the repository. |
|
|
96
|
+
| `vigilante lock` | Writes `vigilante.lock`. Commit this file. |
|
|
97
|
+
| `vigilante diff --base origin/main` | Shows the powers that your branch adds, compared with its merge base. |
|
|
98
|
+
| `vigilante check` | Fails if `vigilante.lock` does not agree with the repository. |
|
|
99
|
+
|
|
100
|
+
`diff` and `check` write Markdown. For other tools, add `--format json` or `--format sarif`.
|
|
101
|
+
|
|
102
|
+
| Exit code | Meaning |
|
|
103
|
+
| --- | --- |
|
|
104
|
+
| 0 | Pass |
|
|
105
|
+
| 1 | A power is not in the lock, the lock is not current, or a `deny` rule matches. |
|
|
106
|
+
| 2 | Error, for example a file that Vigilante cannot read. |
|
|
107
|
+
|
|
108
|
+
## Run it on each pull request
|
|
109
|
+
|
|
110
|
+
Add `.github/workflows/vigilante.yml`:
|
|
111
|
+
|
|
112
|
+
<!-- x-release-please-start-version -->
|
|
113
|
+
```yaml
|
|
114
|
+
name: Vigilante
|
|
115
|
+
on:
|
|
116
|
+
pull_request:
|
|
117
|
+
push:
|
|
118
|
+
branches: [main]
|
|
119
|
+
permissions:
|
|
120
|
+
contents: read
|
|
121
|
+
jobs:
|
|
122
|
+
vigilante:
|
|
123
|
+
runs-on: ubuntu-latest
|
|
124
|
+
steps:
|
|
125
|
+
- uses: actions/checkout@v7
|
|
126
|
+
with:
|
|
127
|
+
fetch-depth: 0
|
|
128
|
+
persist-credentials: false
|
|
129
|
+
- uses: theonly1me/vigilante@v0.1.1
|
|
130
|
+
```
|
|
131
|
+
<!-- x-release-please-end -->
|
|
132
|
+
|
|
133
|
+
On a pull request, the action runs `vigilante diff` against the base branch. On a push, it runs `vigilante check`. The action writes the report to the job summary. The job needs no secrets, so it also works on pull requests from forks.
|
|
134
|
+
|
|
135
|
+
Then make your security team the owner of the lock in `CODEOWNERS`. Also turn on "Require review from Code Owners".
|
|
136
|
+
|
|
137
|
+
```text
|
|
138
|
+
vigilante.lock @your-org/security
|
|
139
|
+
vigilante.toml @your-org/security
|
|
140
|
+
.github/ @your-org/security
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
After this change, each pull request that adds a power must change `vigilante.lock`. The security team must approve that change. [docs/github-action.md](https://github.com/theonly1me/vigilante/blob/v0.1.1/docs/github-action.md) gives the full setup. It also tells you how to protect the check and how to use Vigilante in other CI systems.
|
|
144
|
+
|
|
145
|
+
## Use it with AI agents
|
|
146
|
+
|
|
147
|
+
Tell your agents to run `vigilante diff --base origin/main` before they open a pull request. If an agent adds a power on purpose, tell it to run `vigilante lock`. The pull request then shows the new powers, and the change to the lock asks for the correct review.
|
|
148
|
+
|
|
149
|
+
## Configuration
|
|
150
|
+
|
|
151
|
+
Vigilante works with no configuration. To change what it reports, add `vigilante.toml`:
|
|
152
|
+
|
|
153
|
+
```toml
|
|
154
|
+
[scan]
|
|
155
|
+
exclude = ["examples/**"]
|
|
156
|
+
|
|
157
|
+
[policy]
|
|
158
|
+
deny = [{ scope = "services/**", capability = "exec" }]
|
|
159
|
+
|
|
160
|
+
[ci]
|
|
161
|
+
trusted_owners = ["your-org"]
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
In a pull request, Vigilante reads `vigilante.toml` from the merge base. So a pull request cannot change the rules that check it. [docs/configuration.md](https://github.com/theonly1me/vigilante/blob/v0.1.1/docs/configuration.md) lists each key and the lock format. It also tells you how to add rules for your own wrappers.
|
|
165
|
+
|
|
166
|
+
## What Vigilante is not
|
|
167
|
+
|
|
168
|
+
- It is not a malware detector. It shows what changed, and a person decides if the change is safe.
|
|
169
|
+
- It does not follow calls that the code makes at run time, such as reflection, `eval`, or metaprogramming.
|
|
170
|
+
- It uses no AI to find or sort powers. The same input gives the same output.
|
|
171
|
+
- It downloads packages only from public registries and from the registries that you allow. It keeps them in a cache.
|
|
172
|
+
|
|
173
|
+
## Contribute
|
|
174
|
+
|
|
175
|
+
Read [CONTRIBUTING.md](https://github.com/theonly1me/vigilante/blob/v0.1.1/CONTRIBUTING.md). To report a security problem, read [SECURITY.md](https://github.com/theonly1me/vigilante/blob/v0.1.1/SECURITY.md). [docs/README.md](https://github.com/theonly1me/vigilante/blob/v0.1.1/docs/README.md) lists all the documentation.
|
|
176
|
+
|
|
177
|
+
## License
|
|
178
|
+
|
|
179
|
+
You can use Vigilante under the [Apache License 2.0](https://github.com/theonly1me/vigilante/blob/v0.1.1/LICENSE-APACHE) or the [MIT license](https://github.com/theonly1me/vigilante/blob/v0.1.1/LICENSE-MIT).
|
package/bin/vigilante.js
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
"use strict";
|
|
3
|
+
|
|
4
|
+
const { spawnSync } = require("node:child_process");
|
|
5
|
+
|
|
6
|
+
const PLATFORM_PACKAGES = {
|
|
7
|
+
"darwin arm64": "@theonly1me/vigilante-darwin-arm64",
|
|
8
|
+
"darwin x64": "@theonly1me/vigilante-darwin-x64",
|
|
9
|
+
"linux arm64": "@theonly1me/vigilante-linux-arm64",
|
|
10
|
+
"linux x64": "@theonly1me/vigilante-linux-x64",
|
|
11
|
+
};
|
|
12
|
+
const ERROR_EXIT_CODE = 2;
|
|
13
|
+
|
|
14
|
+
function findBinary() {
|
|
15
|
+
const platform = `${process.platform} ${process.arch}`;
|
|
16
|
+
const platformPackage = PLATFORM_PACKAGES[platform];
|
|
17
|
+
if (!platformPackage) {
|
|
18
|
+
return { error: `there is no Vigilante binary for ${platform}` };
|
|
19
|
+
}
|
|
20
|
+
try {
|
|
21
|
+
return { path: require.resolve(`${platformPackage}/vigilante`) };
|
|
22
|
+
} catch {
|
|
23
|
+
return {
|
|
24
|
+
error: `${platformPackage} is not installed. Install @theonly1me/vigilante again, with optional dependencies.`,
|
|
25
|
+
};
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
function exitWithError(message) {
|
|
30
|
+
console.error(`vigilante: ${message}`);
|
|
31
|
+
process.exit(ERROR_EXIT_CODE);
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
const binary = findBinary();
|
|
35
|
+
if (binary.error) {
|
|
36
|
+
exitWithError(binary.error);
|
|
37
|
+
}
|
|
38
|
+
const run = spawnSync(binary.path, process.argv.slice(2), { stdio: "inherit" });
|
|
39
|
+
if (run.error) {
|
|
40
|
+
exitWithError(run.error.message);
|
|
41
|
+
}
|
|
42
|
+
process.exit(run.status ?? ERROR_EXIT_CODE);
|
package/package.json
CHANGED
|
@@ -1,6 +1,35 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@theonly1me/vigilante",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "0.1.1",
|
|
4
|
+
"description": "Shows the new powers that a pull request gives to code, CI, build, and AI agents",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"security",
|
|
7
|
+
"capabilities",
|
|
8
|
+
"ci",
|
|
9
|
+
"agents",
|
|
10
|
+
"supply-chain"
|
|
11
|
+
],
|
|
12
|
+
"license": "MIT OR Apache-2.0",
|
|
13
|
+
"repository": {
|
|
14
|
+
"type": "git",
|
|
15
|
+
"url": "git+https://github.com/theonly1me/vigilante.git",
|
|
16
|
+
"directory": "npm/vigilante"
|
|
17
|
+
},
|
|
18
|
+
"bin": {
|
|
19
|
+
"vigilante": "bin/vigilante.js"
|
|
20
|
+
},
|
|
21
|
+
"files": [
|
|
22
|
+
"bin",
|
|
23
|
+
"LICENSE-MIT",
|
|
24
|
+
"LICENSE-APACHE"
|
|
25
|
+
],
|
|
26
|
+
"engines": {
|
|
27
|
+
"node": ">=18"
|
|
28
|
+
},
|
|
29
|
+
"optionalDependencies": {
|
|
30
|
+
"@theonly1me/vigilante-darwin-arm64": "0.1.1",
|
|
31
|
+
"@theonly1me/vigilante-darwin-x64": "0.1.1",
|
|
32
|
+
"@theonly1me/vigilante-linux-arm64": "0.1.1",
|
|
33
|
+
"@theonly1me/vigilante-linux-x64": "0.1.1"
|
|
34
|
+
}
|
|
35
|
+
}
|