[XrdHttp] Added cksum documentation to be put in the official XRootD …

…documentation
xrootd · Mar 23, 2023 · 53a4dd3 · 53a4dd3
1 parent 7a4db03
commit 53a4dd3
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/src/XrdHttp/README-CKSUM.md b/src/XrdHttp/README-CKSUM.md
@@ -0,0 +1,14 @@
+In the case XrdHttp has been configured, it is important that the configuration contains at least one digest algorithm registered in the IANA database: https://www.iana.org/assignments/http-dig-alg/http-dig-alg.xhtml
+Otherwise the user will get a 403 error for each checksum request they will do.
+
+Here is a table summarizing the IANA-compliant checksum names:
+
+| Digest algorithm configured | HTTP digest | Will be base64 encoded |
+|-----------------------------|-------------|------------------------|
+| md5                         | md5         | true                   |
+| adler32                     | adler32     | false                  |
+| sha1                        | sha         | true                   |
+| sha256                      | sha-256     | true                   |
+| sha512                      | sha-512     | true                   |
+| cksum                       | UNIXcksum   | false                  |
+| crc32c                      | crc32c      | true                   |