mirror of
https://github.com/fabriziosalmi/patterns.git
synced 2025-12-17 09:45:34 +00:00
docs: Add prerequisites, improve bug template, enhance security policy
Co-authored-by: fabriziosalmi <1569108+fabriziosalmi@users.noreply.github.com>
This commit is contained in:
parent
1fe6802ffe
commit
0e9d13cb5e
28
.github/ISSUE_TEMPLATE/bug_report.md
vendored
28
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -12,27 +12,25 @@ A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
1. Run command '...'
|
||||
2. With configuration '...'
|
||||
3. See error
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
**Error messages/logs**
|
||||
If applicable, add error messages or log output to help explain your problem.
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
- OS: [e.g. iOS]
|
||||
- Browser [e.g. chrome, safari]
|
||||
- Version [e.g. 22]
|
||||
```
|
||||
Paste error messages or logs here
|
||||
```
|
||||
|
||||
**Smartphone (please complete the following information):**
|
||||
- Device: [e.g. iPhone6]
|
||||
- OS: [e.g. iOS8.1]
|
||||
- Browser [e.g. stock browser, safari]
|
||||
- Version [e.g. 22]
|
||||
**Environment (please complete the following information):**
|
||||
- OS: [e.g. Ubuntu 22.04, macOS 13, Windows 11]
|
||||
- Python Version: [e.g. 3.11.0]
|
||||
- Web Server: [e.g. Nginx 1.22, Apache 2.4, Traefik 2.9, HAProxy 2.6]
|
||||
- Installation Method: [e.g. built from source, downloaded pre-generated configs]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
|
||||
@ -72,6 +72,13 @@ patterns/
|
||||
|
||||
## ⚙️ Installation
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before installing, ensure you have the following:
|
||||
- **Python 3.11 or higher** (the project uses Python 3.11 as specified in the GitHub Actions workflow)
|
||||
- **pip** (Python package installer)
|
||||
- **git** (for cloning the repository)
|
||||
|
||||
### Option 1: Download Pre-Generated Configurations
|
||||
You can download the latest pre-generated WAF configurations directly from the [GitHub Releases](https://github.com/fabriziosalmi/patterns/releases) page.
|
||||
|
||||
|
||||
63
SECURITY.md
63
SECURITY.md
@ -2,12 +2,71 @@
|
||||
|
||||
## Supported Versions
|
||||
|
||||
We actively support the current version of this project. The WAF patterns are updated daily via automated GitHub Actions.
|
||||
|
||||
| Version | Supported |
|
||||
| ------- | ------------------ |
|
||||
| current | :white_check_mark: |
|
||||
| current (main branch) | :white_check_mark: |
|
||||
| latest release | :white_check_mark: |
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
Please open an issue to report a vulnerability.
|
||||
We take security vulnerabilities seriously. If you discover a security issue, please follow these steps:
|
||||
|
||||
### For Non-Critical Issues
|
||||
For general security concerns or minor issues:
|
||||
1. Open an issue in the [Issues](https://github.com/fabriziosalmi/patterns/issues) section
|
||||
2. Use the label "security" if available
|
||||
3. Provide a clear description of the issue
|
||||
|
||||
### For Critical Vulnerabilities
|
||||
For critical security vulnerabilities (e.g., in the WAF patterns themselves):
|
||||
1. **DO NOT** open a public issue
|
||||
2. Email the maintainer directly at: fabrizio.salmi@gmail.com
|
||||
3. Include:
|
||||
- Description of the vulnerability
|
||||
- Steps to reproduce
|
||||
- Potential impact
|
||||
- Suggested fix (if available)
|
||||
|
||||
### What to Include
|
||||
When reporting a vulnerability, please include:
|
||||
- Type of vulnerability (e.g., regex bypass, pattern detection issue)
|
||||
- Affected web server(s) (Nginx, Apache, Traefik, HAProxy)
|
||||
- Attack pattern that bypasses detection
|
||||
- Suggested regex or pattern improvement
|
||||
- Any proof-of-concept code (if applicable)
|
||||
|
||||
### Response Time
|
||||
- We aim to acknowledge vulnerability reports within **48 hours**
|
||||
- Critical vulnerabilities will be addressed in the next daily update
|
||||
- Less critical issues will be prioritized based on severity
|
||||
|
||||
### After Reporting
|
||||
Once you report a vulnerability:
|
||||
1. We will acknowledge receipt
|
||||
2. We will investigate and validate the issue
|
||||
3. We will work on a fix and test it
|
||||
4. We will deploy the fix in the next update
|
||||
5. We will credit you in the release notes (unless you prefer to remain anonymous)
|
||||
|
||||
## Security Best Practices
|
||||
|
||||
When using the WAF patterns from this project:
|
||||
- Always test new rules in a staging environment first
|
||||
- Monitor your logs for false positives
|
||||
- Keep your web server and WAF software up to date
|
||||
- Review the OWASP CRS documentation for additional hardening
|
||||
- Consider layering multiple security controls (WAF + rate limiting + IPS, etc.)
|
||||
|
||||
## Scope
|
||||
|
||||
This security policy covers:
|
||||
- WAF pattern generation logic
|
||||
- Regex patterns for attack detection
|
||||
- GitHub Actions workflow security
|
||||
- Dependencies listed in requirements.txt
|
||||
|
||||
Thank you for helping keep this project secure!
|
||||
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user