mirror of
https://github.com/zizmorcore/zizmor.git
synced 2025-12-23 08:47:33 +00:00
de6ef65ba0
Some checks are pending
CI / Lint (push) Waiting to run
CI / Test (push) Waiting to run
CI / Test site build (push) Waiting to run
CI / All tests pass (push) Blocked by required conditions
zizmor wheel builds for PyPI 🐍 / Build Linux wheels (manylinux) (push) Waiting to run
zizmor wheel builds for PyPI 🐍 / Build Linux wheels (musllinux) (push) Waiting to run
zizmor wheel builds for PyPI 🐍 / Build Windows wheels (push) Waiting to run
zizmor wheel builds for PyPI 🐍 / Build macOS wheels (push) Waiting to run
zizmor wheel builds for PyPI 🐍 / Build source distribution (push) Waiting to run
zizmor wheel builds for PyPI 🐍 / Release (push) Blocked by required conditions
Deploy zizmor documentation site 🌐 / Deploy zizmor documentation to GitHub Pages 🌐 (push) Waiting to run
GitHub Actions Security Analysis with zizmor 🌈 / Run zizmor 🌈 (push) Waiting to run
Signed-off-by: William Woodruff <william@yossarian.net>
114 lines
3.7 KiB
Markdown
114 lines
3.7 KiB
Markdown
# 🌈 zizmor
|
|
|
|
[](https://zizmor.sh/)
|
|
[](https://github.com/zizmorcore/zizmor/actions/workflows/ci.yml)
|
|
[](https://crates.io/crates/zizmor)
|
|
[](https://repology.org/project/zizmor/versions)
|
|
[](https://github.com/sponsors/woodruffw)
|
|
[](https://discord.com/invite/PGU3zGZuGG)
|
|
|
|
`zizmor` is a static analysis tool for GitHub Actions.
|
|
|
|
It can find many common security issues in typical GitHub Actions CI/CD setups,
|
|
including:
|
|
|
|
* Template injection vulnerabilities, leading to attacker-controlled code execution
|
|
* Accidental credential persistence and leakage
|
|
* Excessive permission scopes and credential grants to runners
|
|
* Impostor commits and confusable `git` references
|
|
* ...[and much more]!
|
|
|
|
[and much more]: https://docs.zizmor.sh/audits/
|
|
|
|
|
|
|
|
See [`zizmor`'s documentation](https://docs.zizmor.sh/)
|
|
for [installation steps], as well as a [quickstart] and
|
|
[detailed usage recipes].
|
|
|
|
[please file them]: https://github.com/zizmorcore/zizmor/issues/new?assignees=&labels=bug%2Ctriage&projects=&template=bug-report.yml&title=%5BBUG%5D%3A+
|
|
|
|
[installation steps]: https://docs.zizmor.sh/installation/
|
|
|
|
[quickstart]: https://docs.zizmor.sh/quickstart/
|
|
|
|
[detailed usage recipes]: https://docs.zizmor.sh/usage/
|
|
|
|
## License
|
|
|
|
`zizmor` is licensed under the [MIT License](./LICENSE).
|
|
|
|
## Contributing
|
|
|
|
See [our contributing guide!](./CONTRIBUTING.md)
|
|
|
|
## The name?
|
|
|
|
*[Now you can have beautiful clean workflows!]*
|
|
|
|
[Now you can have beautiful clean workflows!]: https://www.youtube.com/watch?v=ol7rxFCvpy8
|
|
|
|
## Sponsors 💖
|
|
|
|
`zizmor`'s development is supported by these amazing sponsors!
|
|
|
|
<!-- @@begin-sponsors@@ -->
|
|
<table width="100%">
|
|
<caption>Logo-level sponsors</caption>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center" valign="top" width="15%">
|
|
<a href="https://grafana.com/">
|
|
<img src="https://avatars.githubusercontent.com/u/7195757?s=100&v=4" width="100px">
|
|
<br>
|
|
Grafana Labs
|
|
</a>
|
|
</td>
|
|
<td align="center" valign="top" width="15%">
|
|
<a href="https://trailofbits.com/">
|
|
<img src="https://avatars.githubusercontent.com/u/2314423?s=100&v=4" width="100px">
|
|
<br>
|
|
Trail of Bits
|
|
</a>
|
|
</td>
|
|
<td align="center" valign="top" width="15%">
|
|
<a href="https://www.shipfox.io">
|
|
<img src="https://avatars.githubusercontent.com/u/163036520?s=100&v=4" width="100px">
|
|
<br>
|
|
Shipfox
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr align="center">
|
|
<table width="100%">
|
|
<caption>Name-level sponsors</caption>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center" valign="top">
|
|
<a href="https://github.com/ariccio">
|
|
Alexander Riccio
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<!-- @@end-sponsors@@ -->
|
|
|
|
Want to see your name or logo above? Consider becoming a sponsor
|
|
through one of the following:
|
|
|
|
- [GitHub Sponsors](https://github.com/sponsors/woodruffw) (preferred)
|
|
- [thanks.dev](https://thanks.dev/u/gh/woodruffw)
|
|
- [ko-fi](https://ko-fi.com/woodruffw)
|
|
|
|
## Star History
|
|
|
|
<a href="https://star-history.com/#zizmorcore/zizmor&Date">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=zizmorcore/zizmor&type=Date&theme=dark" />
|
|
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=zizmorcore/zizmor&type=Date" />
|
|
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=zizmorcore/zizmor&type=Date" />
|
|
</picture>
|
|
</a>
|