Skip to content

README: size the .NET binding field arrays to the limits (overflow-safe) #42

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
MDA2AV merged 1 commit into from
Jun 4, 2026
Merged

README: size the .NET binding field arrays to the limits (overflow-safe) #42

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
17 changes: 13 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,14 @@ using Glyph11.Native;
byte[] request = Encoding.ASCII.GetBytes(
"GET /api/users?page=1 HTTP/1.1\r\nHost: example.com\r\nAccept: */*\r\n\r\n");

Span<Glyph11Field> headers = stackalloc Glyph11Field[64];
Span<Glyph11Field> query = stackalloc Glyph11Field[32];

int status = Glyph11Parser.Parse(request, headers, query, Glyph11Limits.Default, out var r);
// Storage for the parsed fields — size it to the limits, so any request the policy
// accepts fits. A request with more headers is rejected (HTTP 431), never an
// overflow: the core bounds-checks every write.
var limits = Glyph11Limits.Default; // MaxHeaderCount = 100
Span<Glyph11Field> headers = stackalloc Glyph11Field[(int)limits.MaxHeaderCount];
Span<Glyph11Field> query = stackalloc Glyph11Field[(int)limits.MaxQueryParameterCount];

int status = Glyph11Parser.Parse(request, headers, query, limits, out var r);
if (status == Glyph11Parser.Ok)
{
string Slice(Glyph11Span s) => Encoding.ASCII.GetString(request, (int)s.Offset, (int)s.Length);
Expand All @@ -80,6 +84,11 @@ if (status == Glyph11Parser.Ok)
// status: 0 = OK, 1 = incomplete (read more), otherwise a protocol/limit error (→ HTTP 400 / 431).
```

Keep the header/query arrays at least `MaxHeaderCount` / `MaxQueryParameterCount` — a smaller
array silently lowers your effective limit (the parser returns `TOO_MANY_HEADERS` /
`TOO_MANY_QUERY_PARAMS` once it fills, never an overflow). For large limits, rent from
`ArrayPool<Glyph11Field>` instead of `stackalloc`.

Resolve the native library with the `GLYPH11_NATIVE_PATH` environment variable, or put
`libglyph11.{so,dll,dylib}` on the OS load path.

Expand Down
Loading