changelog: start 0.6.8

[secnet.git] / util.h

diff --git a/util.h b/util.h
index eb9e51f15465e20958e0371593c8453a68d8e3d0..f28a00da7c538823e22957cbf52f06cf121a811b 100644 (file)
--- a/util.h
+++ b/util.h
@@ -49,6 +49,41 @@ extern void *buf_prepend(struct buffer_if *buf, int32_t amount);
 extern void *buf_unappend(struct buffer_if *buf, int32_t amount);
 extern void *buf_unprepend(struct buffer_if *buf, int32_t amount);
 
+/* These construct a message in a buffer, truncating if necessary.
+ * _string is only safe for trusted input and *not* UTF-8 (sorry).
+ * _packet_string is safe for any input, including untrusted.
+ * _terminate arranges for the buffer to be null-terminated (and
+ * maybe for a trailing `...' to indicate truncation), and returns
+ * a pointer to the null-terminated string. */
+void truncmsg_add_string(struct buffer_if *buf, cstring_t s);
+void truncmsg_add_packet_string(struct buffer_if*, int32_t, const uint8_t*);
+const char *truncmsg_terminate(const struct buffer_if *buf);
+
+
+struct priomsg {
+    /* U: uninitialised
+     * F: initialised but free (no memory allocated), no leak if discarded
+     * Z: contains no message yet
+     * M: contains some message; you may call truncmsg_add_*
+     */
+    int prio;
+    struct buffer_if m;
+};
+
+void priomsg_new(struct priomsg *pm, int32_t maxlen);          /* UF -> Z */
+void priomsg_destroy(struct priomsg *pm, int32_t maxlen);     /* FZM -> F */
+void priomsg_reset(struct priomsg *pm);                       /* FZM -> Z */
+bool_t priomsg_update_p(struct priomsg *pm, int prio);         /* ZM -> M */
+  /* returns true iff message of priority prio ought to be added,
+   * caller should then call truncmsg_add_*.
+   * pm may be NULL, in which case it just returns false */
+const char *priomsg_getmessage(const struct priomsg *pm, const char *defmsg);
+  /* return value is null-terminated, valid until next call
+   * or until defmsg is no longer valid                                ZM */
+
+bool_t priomsg_update_fixed(struct priomsg *pm, int prio, const char *m);
+  /* convenience combination of _update_p and truncmsg_add_string */
+
 /*
  * void BUF_ADD_BYTES(append,    struct buffer_if*, const void*, int32_t size);
  * void BUF_ADD_BYTES(prepend,   struct buffer_if*, const void*, int32_t size);
@@ -113,9 +148,6 @@ extern void read_mpbin(MP_INT *a, uint8_t *bin, int binsize);
 extern char *write_mpstring(MP_INT *a);
   /* Convert a MP_INT into a hex string */
 
-extern int32_t write_mpbin(MP_INT *a, uint8_t *buffer, int32_t buflen);
-  /* Convert a MP_INT into a buffer; return length; truncate if necessary */
-
 extern struct log_if *init_log(list_t *loglist);
 
 extern void send_nak(const struct comm_addr *dest, uint32_t our_index,
@@ -124,6 +156,9 @@ extern void send_nak(const struct comm_addr *dest, uint32_t our_index,
 
 extern int consttime_memeq(const void *s1, const void *s2, size_t n);
 
+void hash_hash(const struct hash_if *hashi, const void *msg, int32_t len,
+              uint8_t *digest /* hi->hlen bytes */);
+
 const char *iaddr_to_string(const union iaddr *ia);
 int iaddr_socklen(const union iaddr *ia);
 
@@ -131,6 +166,20 @@ void string_item_to_iaddr(const item_t *item, uint16_t port, union iaddr *ia,
                          const char *desc);
 
 
+/*----- pathprefix_template -----*/
+
+struct pathprefix_template {
+    char *buffer;
+    char *write_here;
+};
+
+void pathprefix_template_init(struct pathprefix_template *out,
+                             const char *prefix, int maxsuffix);
+static inline void pathprefix_template_setsuffix
+   (struct pathprefix_template *upd, const char *suffix)
+   { strcpy(upd->write_here,suffix); }
+
+
 /*
  * SBUF_DEFINE(int nbufs, size_t size);
  *   // Generates a number of definitions and statements organising
@@ -213,6 +262,13 @@ async_linebuf_read(struct pollfd *pfd, struct buffer_if *buf,
 
 /*----- some handy macros -----*/
 
+#define CL_GET_STR_ARG(ix,vn,what)                                     \
+    item_t *vn##_i=list_elem(args,ix);                                 \
+    if (!vn##_i) cfgfatal(loc,"make-public","need " what);             \
+    if (vn##_i->type!=t_string) cfgfatal(vn##_i->loc,"make-public",    \
+                                   what "must be string");             \
+    const char *vn=vn##_i->data.string
+
 #define MINMAX(ae,be,op) ({                    \
        typeof((ae)) a=(ae);                    \
        typeof((be)) b=(be);                    \