[tor-commits] [tor/maint-0.4.3] hs-v2: Add deprecation warning for service

[nickm at torproject.org]

commit b404f085adb54f20c7a5084c2b92609dce422db1
Author: David Goulet <dgoulet at torproject.org>
Date:   Wed Jul 1 10:53:30 2020 -0400

    hs-v2: Add deprecation warning for service
    
    If at least one service is configured as a version 2, a log warning is emitted
    once and only once.
    
    Closes #40003
    
    Signed-off-by: David Goulet <dgoulet at torproject.org>
---
 changes/ticket40003            |  3 +++
 src/feature/rend/rendservice.c | 19 +++++++++++++++++++
 2 files changed, 22 insertions(+)

diff --git a/changes/ticket40003 b/changes/ticket40003
new file mode 100644
index 0000000000..240f464353
--- /dev/null
+++ b/changes/ticket40003
@@ -0,0 +1,3 @@
+  o Deprecated features (onion service v2):
+    - Add deprecation warning for onion service version 2. Tor now logs a
+      warning once if a version 2 service is configured. Closes ticket 40003.
diff --git a/src/feature/rend/rendservice.c b/src/feature/rend/rendservice.c
index c96ecec308..eaf0432a7d 100644
--- a/src/feature/rend/rendservice.c
+++ b/src/feature/rend/rendservice.c
@@ -130,6 +130,22 @@ static smartlist_t *rend_service_list = NULL;
  * service on config reload. */
 static smartlist_t *rend_service_staging_list = NULL;
 
+/** Helper: log the deprecation warning for version 2 only once. */
+static void
+log_once_deprecation_warning(void)
+{
+  static bool logged_once = false;
+  if (!logged_once) {
+    log_warn(LD_REND, "DEPRECATED: Onion service version 2 are deprecated. "
+             "Please use version 3 which is the default now. "
+             "Currently, version 2 is planned to be obsolete in "
+             "the Tor version 0.4.6 stable series.");
+    logged_once = true;
+  }
+}
+/** Macro to make it very explicit that we are warning about deprecation. */
+#define WARN_ONCE_DEPRECATION() log_once_deprecation_warning()
+
 /* Like rend_get_service_list_mutable, but returns a read-only list. */
 static const smartlist_t*
 rend_get_service_list(const smartlist_t* substitute_service_list)
@@ -731,6 +747,9 @@ rend_config_service(const config_line_t *line_,
   tor_assert(options);
   tor_assert(config);
 
+  /* We are about to configure a version 2 service. Warn of deprecation. */
+  WARN_ONCE_DEPRECATION();
+
   /* Use the staging service list so that we can check then do the pruning
    * process using the main list at the end. */
   if (rend_service_staging_list == NULL) {