lib/repo-finder: Add Avahi based OstreeRepoFinder implementation

This is a more complex implementation of OstreeRepoFinder which resolves
ref names to remote URIs by looking for refs advertised by peers on the
local network using DNS-SD records and mDNS (Avahi). The idea is to
allow OS and app updates to be propagated over local networks, without
the internet.

It requires an OSTree server and code to generate the DNS-SD adverts in
order to be fully functional — support for this will be added
separately.

Unit tests are included.

Includes fixes by Krzesimir Nowak <krzesimir@kinvolk.io>.

Signed-off-by: Philip Withnall <withnall@endlessm.com>

Closes: #924
Approved by: cgwalters

src/libostree/libostree-experimental.sym

@@ -47,6 +47,10 @@ global:
   ostree_collection_ref_new;
   ostree_repo_find_remotes_async;
   ostree_repo_find_remotes_finish;
+  ostree_repo_finder_avahi_get_type;
+  ostree_repo_finder_avahi_new;
+  ostree_repo_finder_avahi_start;
+  ostree_repo_finder_avahi_stop;
   ostree_repo_finder_config_get_type;
   ostree_repo_finder_config_new;
   ostree_repo_finder_get_type;

src/libostree/ostree-autocleanups.h

@@ -64,6 +64,7 @@ G_DEFINE_AUTOPTR_CLEANUP_FUNC (OstreeCollectionRef, ostree_collection_ref_free)
 G_DEFINE_AUTO_CLEANUP_FREE_FUNC (OstreeCollectionRefv, ostree_collection_ref_freev, NULL)
 G_DEFINE_AUTOPTR_CLEANUP_FUNC (OstreeRemote, ostree_remote_unref)
 G_DEFINE_AUTOPTR_CLEANUP_FUNC (OstreeRepoFinder, g_object_unref)
+G_DEFINE_AUTOPTR_CLEANUP_FUNC (OstreeRepoFinderAvahi, g_object_unref)
 G_DEFINE_AUTOPTR_CLEANUP_FUNC (OstreeRepoFinderConfig, g_object_unref)
 G_DEFINE_AUTOPTR_CLEANUP_FUNC (OstreeRepoFinderMount, g_object_unref)
 G_DEFINE_AUTOPTR_CLEANUP_FUNC (OstreeRepoFinderResult, ostree_repo_finder_result_free)

src/libostree/ostree-core-private.h

@@ -188,6 +188,9 @@ G_DEFINE_AUTOPTR_CLEANUP_FUNC (OstreeRepoFinder, g_object_unref)
 G_DEFINE_AUTOPTR_CLEANUP_FUNC (OstreeRepoFinderResult, ostree_repo_finder_result_free)
 G_DEFINE_AUTO_CLEANUP_FREE_FUNC (OstreeRepoFinderResultv, ostree_repo_finder_result_freev, NULL)
 
+#include "ostree-repo-finder-avahi.h"
+G_DEFINE_AUTOPTR_CLEANUP_FUNC (OstreeRepoFinderAvahi, g_object_unref)
+
 #include "ostree-repo-finder-config.h"
 G_DEFINE_AUTOPTR_CLEANUP_FUNC (OstreeRepoFinderConfig, g_object_unref)
 

src/libostree/ostree-repo-finder-avahi-parser.c

@@ -0,0 +1,137 @@
+/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
+ *
+ * Copyright © 2016 Kinvolk GmbH
+ * Copyright © 2017 Endless Mobile, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ *
+ * Authors:
+ *  - Krzesimir Nowak <krzesimir@kinvolk.io>
+ *  - Philip Withnall <withnall@endlessm.com>
+ */
+
+#include "config.h"
+
+#include <avahi-common/strlst.h>
+#include <glib.h>
+#include <glib-object.h>
+#include <string.h>
+
+#include "ostree-autocleanups.h"
+#include "ostree-repo-finder-avahi.h"
+#include "ostree-repo-finder-avahi-private.h"
+
+/* Reference: RFC 6763, §6. */
+static gboolean
+parse_txt_record (const guint8  *txt,
+                  gsize          txt_len,
+                  const gchar  **key,
+                  gsize         *key_len,
+                  const guint8 **value,
+                  gsize         *value_len)
+{
+  gsize i;
+
+  g_return_val_if_fail (key != NULL, FALSE);
+  g_return_val_if_fail (key_len != NULL, FALSE);
+  g_return_val_if_fail (value != NULL, FALSE);
+  g_return_val_if_fail (value_len != NULL, FALSE);
+
+  /* RFC 6763, §6.1. */
+  if (txt_len > 8900)
+    return FALSE;
+
+  *key = (const gchar *) txt;
+  *key_len = 0;
+  *value = NULL;
+  *value_len = 0;
+
+  for (i = 0; i < txt_len; i++)
+    {
+      if (txt[i] >= 0x20 && txt[i] <= 0x7e && txt[i] != '=')
+        {
+          /* Key character. */
+          *key_len = *key_len + 1;
+          continue;
+        }
+      else if (*key_len > 0 && txt[i] == '=')
+        {
+          /* Separator. */
+          *value = txt + (i + 1);
+          *value_len = txt_len - (i + 1);
+          return TRUE;
+        }
+      else
+        {
+          return FALSE;
+        }
+    }
+
+  /* The entire TXT record is the key; there is no ‘=’ or value. */
+  *value = NULL;
+  *value_len = 0;
+
+  return (*key_len > 0);
+}
+
+/* TODO: Docs. Return value is only valid as long as @txt is. Reference: RFC 6763, §6. */
+GHashTable *
+_ostree_txt_records_parse (AvahiStringList *txt)
+{
+  AvahiStringList *l;
+  g_autoptr(GHashTable) out = NULL;
+
+  out = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify) g_bytes_unref);
+
+  for (l = txt; l != NULL; l = avahi_string_list_get_next (l))
+    {
+      const guint8 *txt;
+      gsize txt_len;
+      const gchar *key;
+      const guint8 *value;
+      gsize key_len, value_len;
+      g_autofree gchar *key_allocated = NULL;
+      g_autoptr(GBytes) value_allocated = NULL;
+
+      txt = avahi_string_list_get_text (l);
+      txt_len = avahi_string_list_get_size (l);
+
+      if (!parse_txt_record (txt, txt_len, &key, &key_len, &value, &value_len))
+        {
+          g_debug ("Ignoring invalid TXT record of length %" G_GSIZE_FORMAT,
+                   txt_len);
+          continue;
+        }
+
+      key_allocated = g_ascii_strdown (key, key_len);
+
+      if (g_hash_table_lookup_extended (out, key_allocated, NULL, NULL))
+        {
+          g_debug ("Ignoring duplicate TXT record ‘%s’", key_allocated);
+          continue;
+        }
+
+      /* Distinguish between the case where the entire record is the key
+       * (value == NULL) and the case where the record is the key + ‘=’ and the
+       * value is empty (value != NULL && value_len == 0). */
+      if (value != NULL)
+        value_allocated = g_bytes_new_static (value, value_len);
+
+      g_hash_table_insert (out, g_steal_pointer (&key_allocated), g_steal_pointer (&value_allocated));
+    }
+
+  return g_steal_pointer (&out);
+}

src/libostree/ostree-repo-finder-avahi-private.h

@@ -0,0 +1,35 @@
+/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
+ *
+ * Copyright © 2017 Endless Mobile, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ *
+ * Authors:
+ *  - Philip Withnall <withnall@endlessm.com>
+ */
+
+#pragma once
+
+#include <avahi-common/strlst.h>
+#include <gio/gio.h>
+#include <glib.h>
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+GHashTable *_ostree_txt_records_parse (AvahiStringList *txt);
+
+G_END_DECLS

src/libostree/ostree-repo-finder-avahi.h

@@ -0,0 +1,62 @@
+/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
+ *
+ * Copyright © 2017 Endless Mobile, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ *
+ * Authors:
+ *  - Philip Withnall <withnall@endlessm.com>
+ */
+
+#pragma once
+
+#include <gio/gio.h>
+#include <glib.h>
+#include <glib-object.h>
+
+#include "ostree-repo-finder.h"
+#include "ostree-types.h"
+
+G_BEGIN_DECLS
+
+#define OSTREE_TYPE_REPO_FINDER_AVAHI (ostree_repo_finder_avahi_get_type ())
+
+/* Manually expanded version of the following, omitting autoptr support (for GLib < 2.44):
+_OSTREE_PUBLIC
+G_DECLARE_FINAL_TYPE (OstreeRepoFinderAvahi, ostree_repo_finder_avahi, OSTREE, REPO_FINDER_AVAHI, GObject) */
+
+_OSTREE_PUBLIC
+GType ostree_repo_finder_avahi_get_type (void);
+
+G_GNUC_BEGIN_IGNORE_DEPRECATIONS
+typedef struct _OstreeRepoFinderAvahi OstreeRepoFinderAvahi;
+typedef struct { GObjectClass parent_class; } OstreeRepoFinderAvahiClass;
+
+static inline OstreeRepoFinderAvahi *OSTREE_REPO_FINDER_AVAHI (gpointer ptr) { return G_TYPE_CHECK_INSTANCE_CAST (ptr, ostree_repo_finder_avahi_get_type (), OstreeRepoFinderAvahi); }
+static inline gboolean OSTREE_IS_REPO_FINDER_AVAHI (gpointer ptr) { return G_TYPE_CHECK_INSTANCE_TYPE (ptr, ostree_repo_finder_avahi_get_type ()); }
+G_GNUC_END_IGNORE_DEPRECATIONS
+
+_OSTREE_PUBLIC
+OstreeRepoFinderAvahi *ostree_repo_finder_avahi_new (GMainContext *context);
+
+_OSTREE_PUBLIC
+void ostree_repo_finder_avahi_start (OstreeRepoFinderAvahi  *self,
+                                     GError                **error);
+
+_OSTREE_PUBLIC
+void ostree_repo_finder_avahi_stop (OstreeRepoFinderAvahi  *self);
+
+G_END_DECLS

src/libostree/ostree-repo-pull.c

@@ -43,6 +43,9 @@
 #include "ostree-repo-finder.h"
 #include "ostree-repo-finder-config.h"
 #include "ostree-repo-finder-mount.h"
+#ifdef HAVE_AVAHI
+#include "ostree-repo-finder-avahi.h"
+#endif  /* HAVE_AVAHI */
 #endif /* OSTREE_ENABLE_EXPERIMENTAL_API */
 
 #include <gio/gunixinputstream.h>
@@ -3961,11 +3964,13 @@ typedef struct
   OstreeCollectionRef **refs;
   GVariant *options;
   OstreeAsyncProgress *progress;
+  OstreeRepoFinder *default_finder_avahi;
 } FindRemotesData;
 
 static void
 find_remotes_data_free (FindRemotesData *data)
 {
+  g_clear_object (&data->default_finder_avahi);
   g_clear_object (&data->progress);
   g_clear_pointer (&data->options, g_variant_unref);
   ostree_collection_ref_freev (data->refs);
@@ -3978,7 +3983,8 @@ G_DEFINE_AUTOPTR_CLEANUP_FUNC (FindRemotesData, find_remotes_data_free)
 static FindRemotesData *
 find_remotes_data_new (const OstreeCollectionRef * const *refs,
                        GVariant                      *options,
-                       OstreeAsyncProgress           *progress)
+                       OstreeAsyncProgress           *progress,
+                       OstreeRepoFinder              *default_finder_avahi)
 {
   g_autoptr(FindRemotesData) data = NULL;
 
@@ -3986,6 +3992,7 @@ find_remotes_data_new (const OstreeCollectionRef * const *refs,
   data->refs = ostree_collection_ref_dupv (refs);
   data->options = (options != NULL) ? g_variant_ref (options) : NULL;
   data->progress = (progress != NULL) ? g_object_ref (progress) : NULL;
+  data->default_finder_avahi = (default_finder_avahi != NULL) ? g_object_ref (default_finder_avahi) : NULL;
 
   return g_steal_pointer (&data);
 }
@@ -4085,10 +4092,10 @@ ostree_repo_find_remotes_async (OstreeRepo                     *self,
 {
   g_autoptr(GTask) task = NULL;
   g_autoptr(FindRemotesData) data = NULL;
-  GMainContext *context;
   OstreeRepoFinder *default_finders[4] = { NULL, };
   g_autoptr(OstreeRepoFinder) finder_config = NULL;
   g_autoptr(OstreeRepoFinder) finder_mount = NULL;
+  g_autoptr(OstreeRepoFinder) finder_avahi = NULL;
 
   g_return_if_fail (OSTREE_IS_REPO (self));
   g_return_if_fail (is_valid_collection_ref_array (refs));
@@ -4102,21 +4109,43 @@ ostree_repo_find_remotes_async (OstreeRepo                     *self,
   task = g_task_new (self, cancellable, callback, user_data);
   g_task_set_source_tag (task, ostree_repo_find_remotes_async);
 
-  context = g_main_context_get_thread_default ();
-
   /* Are we using #OstreeRepoFinders provided by the user, or the defaults? */
   if (finders == NULL)
     {
+#ifdef HAVE_AVAHI
+      GMainContext *context = g_main_context_get_thread_default ();
+      g_autoptr(GError) local_error = NULL;
+#endif  /* HAVE_AVAHI */
+
       finder_config = OSTREE_REPO_FINDER (ostree_repo_finder_config_new ());
       finder_mount = OSTREE_REPO_FINDER (ostree_repo_finder_mount_new (NULL));
+#ifdef HAVE_AVAHI
+      finder_avahi = OSTREE_REPO_FINDER (ostree_repo_finder_avahi_new (context));
+#endif  /* HAVE_AVAHI */
 
       default_finders[0] = finder_config;
       default_finders[1] = finder_mount;
+      default_finders[2] = finder_avahi;
 
       finders = default_finders;
+
+#ifdef HAVE_AVAHI
+      ostree_repo_finder_avahi_start (OSTREE_REPO_FINDER_AVAHI (finder_avahi),
+                                      &local_error);
+
+      if (local_error != NULL)
+        {
+          g_warning ("Avahi finder failed; removing it: %s", local_error->message);
+          default_finders[2] = NULL;
+          g_clear_object (&finder_avahi);
+        }
+#endif  /* HAVE_AVAHI */
     }
 
-  data = find_remotes_data_new (refs, options, progress);
+  /* We need to keep a pointer to the default Avahi finder so we can stop it
+   * again after the operation, which happens implicitly by dropping the final
+   * ref. */
+  data = find_remotes_data_new (refs, options, progress, finder_avahi);
   g_task_set_task_data (task, g_steal_pointer (&data), (GDestroyNotify) find_remotes_data_free);
 
   /* Asynchronously resolve all possible remotes for the given refs. */

src/libostree/ostree.h

@@ -38,6 +38,7 @@
 #ifdef OSTREE_ENABLE_EXPERIMENTAL_API
 #include <ostree-ref.h>
 #include <ostree-repo-finder.h>
+#include <ostree-repo-finder-avahi.h>
 #include <ostree-repo-finder-config.h>
 #include <ostree-repo-finder-mount.h>
 #endif /* OSTREE_ENABLE_EXPERIMENTAL_API */