docs: add GitHub Actions Security Cheat Sheet#2090
Conversation
Signed-off-by: AlexB1986 <barabanov.iu8@gmail.com>
Signed-off-by: AlexB1986 <barabanov.iu8@gmail.com>
|
Rendered markdown is available https://github.com/AlexB1986/CheatSheetSeries/blob/master/cheatsheets/GitHub_Actions_Security_Cheat_Sheet.md |
There was a problem hiding this comment.
Pull request overview
Adds a new “GitHub Actions Security Cheat Sheet” to the OWASP Cheat Sheet Series to provide practical guidance on hardening GitHub Actions workflows against common CI/CD attack paths (secrets exfiltration, token misuse, cache poisoning, cost abuse).
Changes:
- Introduces a new cheat sheet with threat-focused intro and prioritized recommendations.
- Provides an annotated GitHub Actions workflow example covering triggers, permissions, pinning actions, secrets handling, and deployments.
- Adds a references section linking to GitHub Security Lab articles and cache poisoning research.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # GitHub Actions Security Cheat Sheet | ||
|
|
||
| ## Introduction |
There was a problem hiding this comment.
This PR adds a new cheat sheet file, which changes the generated cheat sheet index. Please regenerate and include the updated root Index.md (generated by scripts/Update_CheatSheets_Index.py) so the new cheat sheet is discoverable from the index.
|
I like this work but it's going to require an extensive review. Please be patient with us. |
|
Thanks, I am going to split "4. Write Secure GitHub Workflows" into subsections with smaller code snippets. |
|
Alex, I'm nervous about too many code snippets since these are in a security context. Maybe reduce those and focus on good architectural guidance? |
|
nice write-up, one thing i was missing was a mention about using will you expand on |
|
|
||
| ### 4. Write Secure GitHub Workflows | ||
|
|
||
| Below is a typical GitHub Actions workflow with some recommendations in comments. In general, a static code analyzer shall report such issues. |
There was a problem hiding this comment.
"a static code analyzer shall report such issues"
are you referring to zizmor or are there any additional recommendations?
There was a problem hiding this comment.
Zizmor and CodeQL which also has a dedicated rules for GitHub Actions and freely available for open-source public repositories.
Added details.
Signed-off-by: AlexB1986 <barabanov.iu8@gmail.com>
Signed-off-by: AlexB1986 <barabanov.iu8@gmail.com>
Signed-off-by: AlexB1986 <barabanov.iu8@gmail.com>
Signed-off-by: AlexB1986 <barabanov.iu8@gmail.com>
Signed-off-by: AlexB1986 <barabanov.iu8@gmail.com>
Signed-off-by: AlexB1986 <barabanov.iu8@gmail.com>
Signed-off-by: AlexB1986 <barabanov.iu8@gmail.com>
|
Hello! This PR is ready for review. Could you please take a look when you have a moment? Thank you! @jmanico @mackowski |
This PR adds GitHub Actions Security Cheat Sheet.
Checklist:
[TEXT](URL)AI Tool Usage Disclosure
the contents and I affirm the results. The LLM used is
[llm name and version]and the prompt used is
[your prompt here]. [Feel free to add more details if needed]LLM (Claude Haiku 4.5) has been used for proofreading.
This PR fixes issue #1306 .