Skip to content

Commit 3c324b3

Browse files
committed
Add documentation for instance digests
1 parent 3ce1c5e commit 3c324b3

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,18 @@ requests to `rosid_rosaceae.jpg` will include a link header pointing to the `ldp
2828
Similarly, the `ldp:RDFSource` will contain a link header (`rel="describes"`) pointing to the
2929
`ldp:NonRDFSource`.
3030

31+
## Support for instance digests
32+
33+
All resources support instance digests as defined in <a href="https://tools.ietf.org/html/rfc3230">RFC 3230</a>.
34+
What this means is that the response can include a `Digest` header so that it is possible to ensure end-to-end
35+
data integrity. Requests that include the header: `Want-Digest: md5` or `Want-Digest: sha1` will include responses
36+
that contain a digest corresponding to the response body. The only exception to this are range requests: `Want-Digest`
37+
headers will be ignored when a content range is requested.
38+
39+
Only `md5` and `sha1` algorithms are supported; other algorithms will be ignored. It should be noted that, for large
40+
files, `Want-Digest` requests may perform considerably slower, as the digest will need to be computed before a
41+
response is sent.
42+
3143
## Installation
3244

3345
To install `static-ldp`, follow these steps:

0 commit comments

Comments
 (0)