CheatSheetSeries README

The project's README from github.com/OWASP/CheatSheetSeries. As one markdown file: README.md.

Welcome to the OWASP Cheat Sheet Series

OWASP Flagship Creative Commons License

Welcome to the official repository for the Open Worldwide Application Security Project® (OWASP) Cheat Sheet Series project. The project focuses on providing good security practices for builders in order to secure their applications.

In order to read the cheat sheets and reference them, use the project official website. The project details can be viewed on the OWASP main website without the cheat sheets.

:triangular_flag_on_post: Markdown files are the working sources and aren't intended to be referenced in any external documentation, books or websites.

Cheat Sheet Series Team

Project Leaders

Core team

Chat With Us

We're easy to find on Slack:

  1. Join the OWASP Group Slack with this invitation link.
  2. Join the #cheatsheets channel.

Feel free to ask questions, suggest ideas, or share your best recipes.

Contributions, Feature Requests, and Feedback

We are actively inviting new contributors! To start, please read the contribution guide and our How To Make A Cheatsheet guide.

This project is only possible thanks to the work of many dedicated volunteers. Everyone is encouraged to help in ways large and small. Here are a few ways you can help:

Automated Build

This link allows you to download a build (ZIP archive) of the offline website.

Local Build pyVersion3x

The OWASP Cheat Sheet Series website can be built and tested locally by issuing the following commands:

make install-python-requirements
make generate-site
make serve  # Binds port 8000

Linting

To check markdown and terminology:

npm run lint-markdown
npm run lint-terminology

To auto-fix linting issues:

npm run lint-markdown-fix
npm run lint-terminology-fix

Container Build

The OWASP Cheat Sheet Series website can be built and tested locally inside a container by issuing the following commands:

Docker

docker build -t cheatsheetseries .
docker run --name cheatsheetseries -p 8000:8000 cheatsheetseries

Podman

podman build -t cheatsheetseries .
podman run --name cheatsheetseries -p 8000:8000 localhost/cheatsheetseries

Contributors

Special thanks

A special thank you to the following people for their help provided during the migration:

Open Worldwide Application Security Project and OWASP are registered trademarks of the OWASP Foundation, Inc.

CheatSheetSeries (OWASP/CheatSheetSeries)

Searching Database…

33.7K ·GitHub
CheatSheetSeries
What is this?A collection of concise, high-value cheat sheets covering specific application security topics, maintained by OWASP.
Is this a tool or just a collection of documents?It is a documentation collection — plain Markdown files compiled into a static reference website, not an app or library you run.
How do I read these cheat sheets?Read them on the official OWASP Cheat Sheet Series website, or build the site locally/in a container if you want an offline copy.
What do I need to build the site locally?Node.js (for the npm-based lint/build scripts) and optionally Docker or Podman if you want to build inside a container.
Can I just copy the Markdown files into my own docs?No, the Markdown sources are only meant to drive the project's own site build and aren't intended for external reuse as-is.
Can I get an offline copy of the whole site?Yes, there is a downloadable ZIP archive build of the offline website generated automatically.
Where can I discuss the project with the maintainers?Join the OWASP Slack and the #cheatsheets channel to ask questions or share ideas.
What are similar projects?juice-shop, bug-bounty-hunting-prompts, security-guide-for-developers, secguide, DVWA, shannon, 0, Awesome-Hacking-Resources
Which topics is it in?cheatsheets, code, appsec, owasp, application-security, web-security, penetration-testing, best-practices, knowledge-base, cybersecurity, security-tools, reference
Creator
OWASP
Size
2.7 GB
Stars
33.7K
Updated
CommitOct 16
Age
7y
Commits · 90 Days