|
| 1 | +# Security Policy |
| 2 | + |
| 3 | +litehtml-rs wraps a C++ HTML/CSS rendering engine and is often pointed at |
| 4 | +untrusted input (email HTML, arbitrary web pages), so I take reports about it |
| 5 | +seriously. Thanks for taking the time to look. |
| 6 | + |
| 7 | +## Supported versions |
| 8 | + |
| 9 | +This is pre-1.0 software and moves fast. Only the latest tagged release and the |
| 10 | +`master` branch get security fixes. There are no backports to older `0.x` tags, |
| 11 | +so if you're running an older build, the fix is to upgrade. |
| 12 | + |
| 13 | +| Version | Supported | |
| 14 | +| -------------- | --------- | |
| 15 | +| latest release | yes | |
| 16 | +| `master` | yes | |
| 17 | +| older `0.x` | no | |
| 18 | + |
| 19 | +## Reporting a vulnerability |
| 20 | + |
| 21 | +Please report privately, not through a public issue or pull request. |
| 22 | + |
| 23 | +- Email: mail@gofranz.com |
| 24 | +- If you use GitHub, you can also open a private advisory via the repository's |
| 25 | + Security tab ("Report a vulnerability"). |
| 26 | + |
| 27 | +Useful things to include, as far as you have them: |
| 28 | + |
| 29 | +- what the issue is and the impact you think it has |
| 30 | +- the affected version or commit |
| 31 | +- steps to reproduce, or a proof of concept (a minimal HTML/CSS input that |
| 32 | + triggers the issue is ideal) |
| 33 | +- any logs or backtraces that help me confirm it |
| 34 | + |
| 35 | +## What to expect |
| 36 | + |
| 37 | +I'll acknowledge your report, confirm whether I can reproduce it, and keep you |
| 38 | +updated as I work on a fix. Once it's resolved I'm happy to credit you in the |
| 39 | +release notes, or keep you anonymous if you'd rather. Please give me a chance to |
| 40 | +ship a fix before disclosing publicly. |
| 41 | + |
| 42 | +## Scope |
| 43 | + |
| 44 | +The Rust code in this repository (the `litehtml` and `litehtml-sys` crates) is |
| 45 | +in scope, including the FFI boundary and the C wrapper. Bugs in upstream |
| 46 | +litehtml itself are better reported to |
| 47 | +[litehtml/litehtml](https://github.com/litehtml/litehtml), though I do want to |
| 48 | +hear about it if such a bug is reachable through how these bindings use it (for |
| 49 | +example a crash or memory-safety issue exposed across the safe Rust API). |
0 commit comments