Skip to content

docs: document the SSRF guard requirement and decode bounds (v0.4.3) #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tannevaled merged 1 commit into from
Oct 4, 2026
Merged

docs: document the SSRF guard requirement and decode bounds (v0.4.3) #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,17 @@ go run github.com/go-webengine/engine/cmd/render \
-url https://example.com/ -out out.png -w 1024 -h 768
```

## Security

The engine fetches every resource a page names: images, stylesheets, fonts,
scripts and modules, `fetch`/XHR targets and form posts. It does **not** filter
destinations itself, so rendering an untrusted page from a machine with access to
private networks can reach internal addresses. Embedding the engine directly means
adding a dial-time guard through `Engine.Client` that refuses loopback, private and
link-local addresses; the [browserproxy](https://github.com/go-webengine/browserproxy)
service ships one. Decoding is bounded: raster images declaring more than 25
megapixels are refused, and every fetch is size-capped.

## Where to next

- **[Architecture](architecture.md)** — the packages, the reuse-vs-build decision,
Expand Down
Loading