Skip to content

docs: note secure/httponly defaults and the replay rationale #22

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
sebdroid merged 1 commit into from
Jun 12, 2026
+4 −2
Merged

docs: note secure/httponly defaults and the replay rationale #22

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
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,15 @@ cookiecrypt {
allow_inbound <patterns...> # exceptions to block_unencrypted
allow_outbound <patterns...> # never encrypt these on responses
max_cookie_size 4096 # split threshold per Set-Cookie line (min 512)
secure # append Secure to encrypted Set-Cookies
httponly # append HttpOnly to encrypted Set-Cookies
secure # append Secure to encrypted Set-Cookies (default: off)
httponly # append HttpOnly to encrypted Set-Cookies (default: off)
}
```

JSON config uses the same names: `keys` (array), `cipher`, `prefix`, `block_unencrypted`, `allow_inbound`, `allow_outbound`, `max_cookie_size`, `secure`, `httponly`.

Enable `secure` whenever you serve over HTTPS: encryption stops a stolen cookie being *read*, but not *replayed*, so keeping cookies off plain HTTP still matters.

### Directional model

- **Outbound (responses):** every `Set-Cookie` is encrypted by default. Names matching `allow_outbound` pass through verbatim. Attributes (`Path`, `Max-Age`, `SameSite`, etc.) are preserved byte-for-byte.
Expand Down
Loading