ipcpd: Update DHT for unicast layer

This is a rewrite of the DHT for name-to-address resolution in the
unicast layer. It is now integrated as a proper directory policy. The
dir_wait_running function is removed, instead the a DHT peer is passed
on during IPCP enrolment.

Each DHT request/response gets a random 64-bit ID ('cookie'). DHT
messages to the same peer are deduped, except in the case when the DHT
is low on contacts. In that case, it will contact the per it received
at enrolment for more contacts. To combat packet loss, these messages
are not deduped by means of a 'magic cookie', chosen at random when
the DHT starts.

The DHT parameters (Kademlia) can be set using the configfile or the
IRM command line tools:

if DIRECTORY_POLICY == DHT
        [dht_alpha <search factor> (default: 3)]
        [dht_k <replication factor> (default: 8)]
        [dht_t_expire <expiration (s)> (default: 86400)]
        [dht_t_refresh <contact refresh (s)> (default: 900)]
        [dht_t_replicate <replication (s)> (default: 900)]

This commit also adds support for a protocol debug level (PP).
Protocol debugging for the DHT can be enabled using the
DEBUG_PROTO_DHT build flag.

The DHT has the following message types:

DHT_STORE, sent to k peers. Not acknowledged.

    DHT_STORE --> [2861814146dbf9b5|ed:d9:e2:c4].
      key: bcc236ab6ec69e65 [32 bytes]
      val: 00000000c4e2d9ed [8 bytes]
      exp: 2025-08-03 17:29:44 (UTC).

DHT_FIND_NODE_REQ, sent to 'alpha' peers, with a corresponding
response. This is used to update the peer routing table to iteratively
look for the nodes with IDs closest to the requested key.

    DHT_FIND_NODE_REQ --> [a62f92abffb451c4|ed:d9:e2:c4].
      cookie: 2d4b7acef8308210
      key:    a62f92abffb451c4 [32 bytes]

    DHT_FIND_NODE_RSP <-- [2861814146dbf9b5|ed:d9:e2:c4].
      cookie: 2d4b7acef8308210
      key:    a62f92abffb451c4 [32 bytes]
      contacts: [1]
        [a62f92abffb451c4|9f:0d:c1:fb]

DHT_FIND_VALUE_REQ, sent to 'k' peers, with a corresponding
response. Used to find a value for a key. Will also send its closest
known peers in the response.

    DHT_FIND_VALUE_REQ --> [2861814146dbf9b5|ed:d9:e2:c4].
      cookie: 80a1adcb09a2ff0a
      key:    42dee3b0415b4f69 [32 bytes]

    DHT_FIND_VALUE_RSP <-- [2861814146dbf9b5|ed:d9:e2:c4].
      cookie: 80a1adcb09a2ff0a
      key:    42dee3b0415b4f69 [32 bytes]
        values: [1]
          00000000c4e2d9ed [8 bytes]
        contacts: [1]
          [a62f92abffb451c4|9f:0d:c1:fb]

Also removes ubuntu 20 from appveyor config as it is not supported anymore.

Signed-off-by: Dimitri Staessens <dimitri@ouroboros.rocks>
Signed-off-by: Sander Vrijders <sander@ouroboros.rocks>

1 files changed, 29 insertions, 22 deletions

diff --git a/src/ipcpd/unicast/dir.c b/src/ipcpd/unicast/dir.c
index e0cb09fc..2b305626 100644
--- a/src/ipcpd/unicast/dir.c
+++ b/src/ipcpd/unicast/dir.c
@@ -44,50 +44,57 @@
 
 struct {
         struct dir_ops * ops;
-        void *           dir;
-} dirmgr;
+} dir;
 
-int dir_init(void)
+int dir_init(struct dir_config * conf)
 {
-        dirmgr.ops = &dht_dir_ops;
+        void * cfg;
 
-        dirmgr.dir = dirmgr.ops->create();
-        if (dirmgr.dir == NULL) {
-                dirmgr.ops = NULL;
-                return -ENOMEM;
+        assert(conf != NULL);
+
+        switch (conf->pol) {
+        case DIR_DHT:
+                log_info("Using DHT policy.");
+                dir.ops = &dht_dir_ops;
+                cfg = &conf->dht;
+                break;
+        default: /* DIR_INVALID */
+                log_err("Invalid directory policy %d.", conf->pol);
+                return -EINVAL;
         }
 
-        return 0;
+        assert(dir.ops->init != NULL);
+
+        return dir.ops->init(cfg);
 }
 
 void dir_fini(void)
 {
-        dirmgr.ops->destroy(dirmgr.dir);
-        dirmgr.ops = NULL;
-        dirmgr.dir = NULL;
+        dir.ops->fini();
+        dir.ops = NULL;
 }
 
-int dir_bootstrap(void)
+int dir_start(void)
 {
-        return dirmgr.ops->bootstrap(dirmgr.dir);
+        return dir.ops->start();
 }
 
-int dir_reg(const uint8_t * hash)
+void dir_stop(void)
 {
-        return dirmgr.ops->reg(dirmgr.dir, hash);
+        dir.ops->stop();
 }
 
-int dir_unreg(const uint8_t * hash)
+int dir_reg(const uint8_t * hash)
 {
-        return dirmgr.ops->unreg(dirmgr.dir, hash);
+        return dir.ops->reg(hash);
 }
 
-uint64_t dir_query(const uint8_t * hash)
+int dir_unreg(const uint8_t * hash)
 {
-        return dirmgr.ops->query(dirmgr.dir, hash);
+        return dir.ops->unreg(hash);
 }
 
-int dir_wait_running(void)
+uint64_t dir_query(const uint8_t * hash)
 {
-        return dirmgr.ops->wait_running(dirmgr.dir);
+        return dir.ops->query(hash);
 }