[tor-commits] [tor/maint-0.4.0] hs-v3: Remove a BUG() caused by an acceptable race

[teor at torproject.org]

commit ed57a04a65a59ee744910a9db22a81359dac3491
Author: David Goulet <dgoulet at torproject.org>
Date:   Wed Oct 23 10:20:09 2019 -0400

    hs-v3: Remove a BUG() caused by an acceptable race
    
    hs_client_purge_state() and hs_cache_clean_as_client() can remove a descriptor
    from the client cache with a NEWNYM or simply when the descriptor expires.
    
    Which means that for an INTRO circuit being established during that time, once
    it opens, we lookup the descriptor to get the IP object but hey surprised, no
    more descriptor.
    
    The approach here is minimalist that is accept the race and close the circuit
    since we can not continue. Before that, the circuit would stay opened and the
    client wait the SockTimeout.
    
    Fixers #28970.
    
    Signed-off-by: David Goulet <dgoulet at torproject.org>
---
 changes/ticket28970        | 6 ++++++
 src/feature/hs/hs_client.c | 8 ++++++--
 2 files changed, 12 insertions(+), 2 deletions(-)

diff --git a/changes/ticket28970 b/changes/ticket28970
new file mode 100644
index 000000000..138c575fc
--- /dev/null
+++ b/changes/ticket28970
@@ -0,0 +1,6 @@
+  o Minor bugfixes (clietn, hidden service v3):
+    - Fix a BUG() assertion that occurs within a very small race window between
+      a client intro circuit opens and its descriptor that gets cleaned up from
+      the cache. The circuit is now closed which will trigger a re-fetch of the
+      descriptor and continue the HS connection. Fixes bug 28970; bugfix on
+      0.3.2.1-alpha.
diff --git a/src/feature/hs/hs_client.c b/src/feature/hs/hs_client.c
index 2a5765aec..fd2d26645 100644
--- a/src/feature/hs/hs_client.c
+++ b/src/feature/hs/hs_client.c
@@ -672,8 +672,12 @@ setup_intro_circ_auth_key(origin_circuit_t *circ)
   tor_assert(circ);
 
   desc = hs_cache_lookup_as_client(&circ->hs_ident->identity_pk);
-  if (BUG(desc == NULL)) {
-    /* Opening intro circuit without the descriptor is no good... */
+  if (desc == NULL) {
+    /* There is a very small race window between the opening of this circuit
+     * and the client descriptor cache that gets purged (NEWNYM) or the
+     * cleaned up because it expired. Mark the circuit for close so a new
+     * descriptor fetch can occur. */
+    circuit_mark_for_close(TO_CIRCUIT(circ), END_CIRC_REASON_INTERNAL);
     goto end;
   }