[tor-commits] [tor/master] Document some channel_matches_extend_info issues that confused me.

[nickm at torproject.org]

commit f64cf09eb2306ddb3afb8f92a08da3a4a94f333b
Author: Nick Mathewson <nickm at torproject.org>
Date:   Thu Jul 16 14:43:16 2020 -0400

    Document some channel_matches_extend_info issues that confused me.
---
 src/core/or/channel.c    | 3 +++
 src/core/or/channeltls.c | 3 +++
 2 files changed, 6 insertions(+)

diff --git a/src/core/or/channel.c b/src/core/or/channel.c
index 8390fc1ecc..b4386f969d 100644
--- a/src/core/or/channel.c
+++ b/src/core/or/channel.c
@@ -3255,6 +3255,9 @@ channel_when_last_xmit(channel_t *chan)
  *
  * This function calls the lower layer and asks if this channel matches a
  * given extend_info_t.
+ *
+ * NOTE that this function only checks for an address/port match, and should
+ * be used only when no identity is available.
  */
 int
 channel_matches_extend_info(channel_t *chan, extend_info_t *extend_info)
diff --git a/src/core/or/channeltls.c b/src/core/or/channeltls.c
index 7ec977be3c..ae60038c34 100644
--- a/src/core/or/channeltls.c
+++ b/src/core/or/channeltls.c
@@ -667,6 +667,9 @@ channel_tls_is_canonical_method(channel_t *chan, int req)
  *
  * This implements the matches_extend_info method for channel_tls_t; the upper
  * layer wants to know if this channel matches an extend_info_t.
+ *
+ * NOTE that this function only checks for an address/port match, and should
+ * be used only when no identify is available.
  */
 static int
 channel_tls_matches_extend_info_method(channel_t *chan,