Skip to content

Commit 2ac7932

Browse files
Document encoded base URL path safety checks
Co-authored-by: Shri Sukhani <shrisukhani@users.noreply.github.com>
1 parent a91e8e3 commit 2ac7932

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ export HYPERBROWSER_HEADERS='{"X-Correlation-Id":"req-123"}' # optional JSON obj
3030
`base_url` must start with `https://` (or `http://` for local testing), include a host,
3131
and not contain query parameters, URL fragments, backslashes, control characters,
3232
or whitespace/newline characters.
33+
Unsafe encoded path forms (for example encoded traversal segments) are also rejected.
3334
The SDK normalizes trailing slashes automatically.
3435
If `base_url` already ends with `/api`, the SDK avoids adding a duplicate `/api` prefix.
3536
If `HYPERBROWSER_BASE_URL` is set, it must be non-empty.

0 commit comments

Comments
 (0)