chore(http): Delete "Digest" and "Want-Digest", improve digest pages #36879
+104
−258
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
Content:HTTP
| The HTTP **`Content-Digest`** header provides a {{Glossary("digest")}} of the message content in an HTTP message. | ||
| As such, `Content-Digest` is dependent on among other things {{HTTPHeader("Content-Encoding")}} and {{HTTPHeader("Content-Range")}}, but not dependent on, for example, HTTP/1.1's {{HTTPHeader("Transfer-Encoding")}}. | ||
| `Content-Digest` may coincide with {{HTTPHeader("Repr-Digest")}} if a representation was sent in a single message. | ||
| The HTTP **`Content-Digest`** {{Glossary("request header", "request")}} and {{Glossary("response header")}} provides a {{Glossary("digest")}} calculated using a hashing algorithm applied to the message content. |
There was a problem hiding this comment.
Not going to block merging, but given this is request and response, perhaps we should have an example or explanation of the case where the browser sends a digest?
| ```plain | ||
| Content-Digest: unixcksum=916142062 | ||
| Content-Digest: md5=:+thA//8pGVGk2VYuJkFNvA==:, unixsum=26869 | ||
| ### Client requests a SHA-256 Content-Digest |
There was a problem hiding this comment.
Client? User-Agent, Browser?
|
|
||
| ### Identical Content-Digest and Repr-Digest values | ||
|
|
||
| A client requests a resource without a `Want-Content-Digest` field: |
There was a problem hiding this comment.
For client, I prefer browser if it is always a browser, and user-agent if it could reasonably mean a script. Obviously if you agree, change everywhere.
| ``` | ||
|
|
||
| In this case, the server is configured to send unsolicited digest headers in responses. | ||
| Both the `Repr-Digest` and `Content-Digest` fields have matching values: |
There was a problem hiding this comment.
Perhaps
Suggested change
| Both the `Repr-Digest` and `Content-Digest` fields have matching values: | |
| The `Repr-Digest` and `Content-Digest` fields have matching values because they are using the same algorithm, and in this case the whole resource is sent in just one message. |
| @@ -8,12 +8,14 @@ spec-urls: https://datatracker.ietf.org/doc/html/rfc9530 | |||
| {{HTTPSidebar}} | |||
|
|
|||
| The HTTP **`Repr-Digest`** {{Glossary("Request header", "request")}} and {{Glossary("Response header", "response header")}} provides a {{Glossary("digest")}} of the selected representation of the target resource. | |||
| A `Repr-Digest` is most suited to validate the integrity of partial or multipart messages against the full selected representation. | |||
There was a problem hiding this comment.
So, I wanted to change it like this:
Suggested change
| A `Repr-Digest` is most suited to validate the integrity of partial or multipart messages against the full selected representation. | |
| A `Repr-Digest` can be used to validate the integrity of partial or multipart messages against the full selected representation. |
Now I'd like you to tell me what that means ? :-). How can you validate a partial message using this information. The answer is probably you can't. My take is that this is only really useful once you have the whole message, and then it tells you that all the parts were OK.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR removes the Digest and Want-Digest pages which are deprecated. They are also confusing, given the pages are mixed in with newer alternatives. I'm proposing we redirect to content-related digest headers.
Deletions:
Digestheader, redirected toContent-DigestWant-Digestheader, redirected toWant-Content-DigestChanges:
Repr-DigestandContent-Digestpages for clarityspec_urlsfront matter should bespec-urlsAdditions:
Content-Digestbased on specsMotivation
The remaining pages were touched recently, but I think there's room for improvement in the language used so that it's easier to understand when/why to use
Repr-Digestinstead ofContent-Digest.Related issues and pull requests