Skip to content

Commit 5c5f327

Browse files
committed
docs: release v0.1.4 preparation (changelog, security, readme)
1 parent 0a96f22 commit 5c5f327

File tree

3 files changed

+63
-4
lines changed

3 files changed

+63
-4
lines changed

CHANGELOG.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [v0.1.4] - 2025-12-06
9+
10+
### Security
11+
- Fixed Panic vulnerability in `quic-go` by upgrading to `v0.54.0` (requires Caddy v2.10.x and Go 1.25).
12+
- Addressed Dependabot Alert #7.
13+
14+
### Changed
15+
- Upgraded Caddy dependency to `v2.10.2`.
16+
- Upgraded Go requirement to `1.25`.
17+
- Improved CI workflows to use Go 1.25 for build and release.
18+
19+
## [v0.1.3] - 2025-12-06
20+
### Fixed
21+
- Downgraded `quic-go` to `v0.48.2` and Caddy to `v2.9.1` to temporarily resolve Go version conflicts (superseded by v0.1.4).
22+
- Fixed import grouping for `gci` linter compliance.
23+
- Fixed GitHub Actions release workflow.
24+
25+
## [v0.1.2] - 2025-12-06
26+
### Added
27+
- SOTA Engineering patterns (Zero-Copy headers, Wait-Free Ring Buffer, Circuit Breaker).
28+
- ASN Blocking support.
29+
- Configurable Request Body size limit.
30+
- GeoIP Fail Open configuration.

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,12 @@ curl -fsSL -H "Pragma: no-cache" https://raw.githubusercontent.com/fabriziosalmi
6262

6363
## 🚀 Installation
6464

65+
### Prerequisites
66+
67+
- [Go](https://golang.org/dl/) **1.25** or higher
68+
- [Caddy](https://caddyserver.com/docs/install) **v2.10.x** or higher (for building with this plugin)
69+
- [xcaddy](https://github.com/caddyserver/xcaddy) (for building Caddy with plugins)
70+
6571
```bash
6672
# Step 1: Clone the caddy-waf repository from GitHub
6773
git clone https://github.com/fabriziosalmi/caddy-waf.git

SECURITY.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,35 @@
44

55
| Version | Supported |
66
| ------- | ------------------ |
7-
| current | :white_check_mark: |
8-
7+
| v0.1.x | :white_check_mark: |
8+
| < 0.1.0 | :x: |
99

1010
## Reporting a Vulnerability
1111

12-
There is automated security code scanning in place provided by GitHub.
12+
We take the security of `caddy-waf` seriously. If you find a vulnerability, please report it!
13+
14+
### How to Report
15+
16+
Please do **NOT** open a public issue on GitHub. Instead, report the vulnerability via:
17+
18+
1. **Email**: Send the details to the maintainer (fabrizio.salmi@gmail.com).
19+
2. **GitHub Private Advisory**: Open a private advisory draft on this repository if you have permissions, or contact the maintainer to enable it.
20+
21+
### Required Information
22+
23+
When reporting a vulnerability, please include:
24+
25+
- A description of the vulnerability.
26+
- Steps to reproduce the issue (PoC code is helpful).
27+
- Impact of the vulnerability.
28+
- Affected versions.
29+
30+
### Response Timeline
31+
32+
- We will acknowledge your report within 48 hours.
33+
- We will provide an estimated timeline for the fix within 1 week.
34+
- We will release a patch as soon as possible.
1335

14-
Please open an issue to report a vulnerability.
36+
### Credit
1537

38+
We will credit you in the release notes and changelog for responsibly disclosing vulnerabilities, unless you prefer to remain anonymous.

0 commit comments

Comments
 (0)