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…

这是什么?这是一组简洁、实用价值高的速查表,涵盖应用安全的具体主题,由 OWASP 维护。
这是工具,还是只是一组文档?这是一个文档集合,由纯 Markdown 文件编译成静态参考网站,不是需要你运行的应用或库。
我该如何阅读这些速查表?可以在 OWASP 官方的 Cheat Sheet Series 网站上阅读;如果想要离线副本,可以在本地或容器中构建网站。
在本地构建网站需要什么?需要 Node.js(用于基于 npm 的代码检查和构建脚本);如果想在容器中构建,可以选择安装 Docker 或 Podman。
我能直接把 Markdown 文件复制到自己的文档里吗?不能。这些 Markdown 源文件仅用于驱动项目自身的网站构建,并不打算原样供外部复用。
能获取整个网站的离线副本吗?可以,项目会自动生成离线网站的 ZIP 压缩包供下载。
我在哪里可以和维护者讨论这个项目?加入 OWASP Slack,进入 #cheatsheets 频道提问或分享想法。
Creator
OWASP
Size
2.7 GB
Stars
33.7K
Updated
CommitOct 17
Age
7y
Commits · 90 Days