util.[ch]: Factor out hex encoding and decoding utilities.

[secnet.git] / util.h

diff --git a/util.h b/util.h
index 4e1f9d0adfc60ea88cd03d04fa48db337f14ae9a..62642fdb32696dce3b97653b5979ca594749502e 100644 (file)
--- a/util.h
+++ b/util.h
@@ -4,7 +4,7 @@
  *
  * secnet is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version d of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
  *
  * secnet is distributed in the hope that it will be useful, but
@@ -87,6 +87,24 @@ extern void buffer_readonly_clone(struct buffer_if *n, const struct buffer_if*);
 
 extern void buf_append_string(struct buffer_if *buf, cstring_t s);
 
+extern string_t hex_encode(const uint8_t *bin, int binsize);
+  /* Convert a byte array to hex, returning the result in a freshly allocated
+   * string.
+   */
+
+extern bool_t hex_decode(uint8_t *buffer, int32_t buflen, int32_t *outlen,
+                        cstring_t hb, bool_t allow_odd_nibble);
+  /* Convert a hex string to binary, storing the result in buffer.  If
+   * allow_odd_nibble then it is acceptable if the input is an odd number of
+   * digits, and an additional leading zero digit is assumed; otherwise, this
+   * is not acceptable and the conversion fails.
+   *
+   * The input is processed left to right until it is consumed, the buffer is
+   * full, or an error is encountered in the input.  The length of output
+   * produced is stored in *outlen.  Returns true if the entire input was
+   * processed without error; otherwise false.
+   */
+
 extern void read_mpbin(MP_INT *a, uint8_t *bin, int binsize);
 
 extern char *write_mpstring(MP_INT *a);