Skip to content
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

Update protocol spec: Clients and servers must not attempt to decompress zero-length HTTP content #92

Merged
merged 2 commits into from
Nov 1, 2023
Merged

Update protocol spec: Clients and servers must not attempt to decompress zero-length HTTP content #92

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec5eca1
Update protocol spec: Clients and servers must not attempt to decompr…
timostamm Nov 1, 2023
c84c1dc
Merge branch 'main' into tstamm/do-not-attempt-to-decompress-zero-length
timostamm Nov 1, 2023
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
15 changes: 9 additions & 6 deletions docs/protocol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,8 @@ Connect protocol.
**Bare-Message** is the RPC request payload, serialized using the codec
indicated by **Unary-Content-Type** and possibly compressed using
**Content-Encoding**. It's sent on the wire as the HTTP request content (often
called the body).
called the body). Servers must not attempt to decompress zero-length HTTP request
content.

### Unary-Get-Request

Expand Down Expand Up @@ -280,6 +281,7 @@ sending the easy-to-parse subset outlined above. Servers should treat
encoding first and least preferred encoding last. If the client uses an
unsupported **Compression-Query** value, servers should return an error with
code "unimplemented" and a message listing the supported encodings.
Servers must not attempt to decompress zero-length **Message-Query**.

If **Timeout** is omitted, the server should assume an infinite timeout. The
protocol accommodates timeouts of more than 100 days. Client implementations
Expand Down Expand Up @@ -322,16 +324,17 @@ Successful responses have an **HTTP-Status** of 200. In those cases,
**Bare-Message** is the RPC response payload, serialized using the codec indicated
by **Unary-Content-Type** and possibly compressed using **Content-Encoding**.
It's sent on the wire as the HTTP response content (often called the body).
Clients must not attempt to decompress zero-length HTTP response content.

Errors are sent with a non-200 **HTTP-Status**. In those cases,
**Unary-Content-Type** _must_ be "application/json". **Bare-Message** is either
omitted or a JSON-serialized [Error](#error-end-stream), possibly compressed
using **Content-Encoding** and sent on the wire as the HTTP response content.
If **Bare-Message** is an Error, **HTTP-Status** must match Error.code as
specified in [the table below](#error-codes). When reading data from the wire,
client implementations must use the [HTTP-to-Connect
mapping](#http-to-error-code) to infer a Connect error code if **Bare-Message**
is missing or malformed.
Clients must not attempt to decompress zero-length HTTP response content. If
**Bare-Message** is an Error, **HTTP-Status** must match Error.code as specified
in [the table below](#error-codes). When reading data from the wire, client
implementations must use the [HTTP-to-Connect mapping](#http-to-error-code) to infer a Connect
error code if **Bare-Message** is missing or malformed.

### Examples {#unary-examples}

Expand Down