util: base32hex - explain distinction with base32
authorTom Gundersen <teg@jklm.no>
Thu, 23 Jul 2015 16:45:49 +0000 (18:45 +0200)
committerTom Gundersen <teg@jklm.no>
Mon, 27 Jul 2015 18:34:47 +0000 (20:34 +0200)
src/basic/util.c

index 7896be8..1c15fbc 100644 (file)
@@ -954,7 +954,12 @@ int unhexmem(const char *p, size_t l, void **mem, size_t *len) {
         return 0;
 }
 
-/* https://tools.ietf.org/html/rfc4648#section-6 */
+/* https://tools.ietf.org/html/rfc4648#section-6
+ * Notice that base32hex differs from base32 in the alphabet it uses.
+ * The distinction is that the base32hex representation preserves the
+ * order of the underlying data when compared as bytestrings, this is
+ * useful when representing NSEC3 hashes, as one can then verify the
+ * order of hashes directly from their representation. */
 char base32hexchar(int x) {
         static const char table[32] = "0123456789"
                                       "ABCDEFGHIJKLMNOPQRSTUV";