[tor-commits] [tor/master] hs: Log the intro point when we clean it up

[nickm at torproject.org]

commit 9b4513c5d112fdeb630141fefa48da4c1907f8d0
Author: David Goulet <dgoulet at torproject.org>
Date:   Wed Sep 20 12:47:09 2017 -0400

    hs: Log the intro point when we clean it up
    
    When we remove an intro point from the service list, log info about it and
    some useful data.
    
    Signed-off-by: David Goulet <dgoulet at torproject.org>
---
 changes/ticket23604 |  5 +++++
 src/or/hs_service.c | 38 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+)

diff --git a/changes/ticket23604 b/changes/ticket23604
new file mode 100644
index 000000000..e65f63e31
--- /dev/null
+++ b/changes/ticket23604
@@ -0,0 +1,5 @@
+  o Minor bugfixes (hidden service, circuit):
+    - Improve logging of many callsite in the circuit subsystem to print the
+      circuit identifier(s).
+    - Log when we cleanup an intro point from a service so we know when and
+      for what reason it happened. Closes ticket 23604.
diff --git a/src/or/hs_service.c b/src/or/hs_service.c
index f905a688b..50c231788 100644
--- a/src/or/hs_service.c
+++ b/src/or/hs_service.c
@@ -214,6 +214,37 @@ service_clear_config(hs_service_config_t *config)
   memset(config, 0, sizeof(*config));
 }
 
+/* Helper function to return a human readable description of the given intro
+ * point object.
+ *
+ * This function is not thread-safe. Each call to this invalidates the
+ * previous values returned by it. */
+static const char *
+describe_intro_point(const hs_service_intro_point_t *ip)
+{
+  /* Hex identity digest of the IP prefixed by the $ sign and ends with NUL
+   * byte hence the plus two. */
+  static char buf[HEX_DIGEST_LEN + 2];
+  const char *legacy_id = NULL;
+
+  SMARTLIST_FOREACH_BEGIN(ip->base.link_specifiers,
+                          const hs_desc_link_specifier_t *, lspec) {
+    if (lspec->type == LS_LEGACY_ID) {
+      legacy_id = (const char *) lspec->u.legacy_id;
+      break;
+    }
+  } SMARTLIST_FOREACH_END(lspec);
+
+  /* For now, we only print the identity digest but we could improve this with
+   * much more information such as the ed25519 identity has well. */
+  buf[0] = '$';
+  if (legacy_id) {
+    base16_encode(buf + 1, HEX_DIGEST_LEN + 1, legacy_id, DIGEST_LEN);
+  }
+
+  return buf;
+}
+
 /* Return the lower bound of maximum INTRODUCE2 cells per circuit before we
  * rotate intro point (defined by a consensus parameter or the default
  * value). */
@@ -1783,6 +1814,13 @@ cleanup_intro_points(hs_service_t *service, time_t now)
        * reached the maximum number of retry with a non existing circuit. */
       if (has_expired || node == NULL ||
           ip->circuit_retries > MAX_INTRO_POINT_CIRCUIT_RETRIES) {
+        log_info(LD_REND, "Intro point %s%s (retried: %u times). "
+                          "Removing it.",
+                 describe_intro_point(ip),
+                 has_expired ? " has expired" :
+                    (node == NULL) ?  " fell off the consensus" : "",
+                 ip->circuit_retries);
+
         /* Remove intro point from descriptor map. We'll add it to the failed
          * map if we retried it too many times. */
         MAP_DEL_CURRENT(key);