[tor-commits] [torspec/master] control-spec: Add CONFIGURED_ORPORT to SERVER_STATUS event

[dgoulet at torproject.org]

commit 493f1524a12821dbf8ab0c23c08275816f4d31c8
Author: David Goulet <dgoulet at torproject.org>
Date:   Tue Jul 7 10:51:36 2020 -0400

    control-spec: Add CONFIGURED_ORPORT to SERVER_STATUS event
    
    A tor relay now can discover its address using the ORPort address if one is
    specified.
    
    For that reason, we add a new method to the SERVER_STATUS event that is
    CONFIGURED_ORPORT in order to identify the configured address on the ORPort.
    
    Related to #33236
    
    Signed-off-by: David Goulet <dgoulet at torproject.org>
---
 control-spec.txt | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

diff --git a/control-spec.txt b/control-spec.txt
index 77cc01c..0334639 100644
--- a/control-spec.txt
+++ b/control-spec.txt
@@ -2900,16 +2900,18 @@
      EXTERNAL_ADDRESS
      "ADDRESS=IP"
      "HOSTNAME=NAME"
-     "METHOD=CONFIGURED/DIRSERV/RESOLVED/INTERFACE/GETHOSTNAME"
-       Our best idea for our externally visible IP has changed to 'IP'.
-       If 'HOSTNAME' is present, we got the new IP by resolving 'NAME'.  If the
-       method is 'CONFIGURED', the IP was given verbatim as a configuration
-       option.  If the method is 'RESOLVED', we resolved the Address
-       configuration option to get the IP.  If the method is 'GETHOSTNAME',
-       we resolved our hostname to get the IP.  If the method is 'INTERFACE',
-       we got the address of one of our network interfaces to get the IP.  If
-       the method is 'DIRSERV', a directory server told us a guess for what
-       our IP might be.
+     "METHOD=CONFIGURED/CONFIGURED_ORPORT/DIRSERV/RESOLVED/
+             INTERFACE/GETHOSTNAME"
+       Our best idea for our externally visible IP has changed to 'IP'.  If
+       'HOSTNAME' is present, we got the new IP by resolving 'NAME'.  If the
+       method is 'CONFIGURED', the IP was given verbatim as the Address
+       configuration option.  If the method is 'CONFIGURED_ORPORT', the IP was
+       given verbatim in the ORPort configuration option. If the method is
+       'RESOLVED', we resolved the Address configuration option to get the IP.
+       If the method is 'GETHOSTNAME', we resolved our hostname to get the IP.
+       If the method is 'INTERFACE', we got the address of one of our network
+       interfaces to get the IP.  If the method is 'DIRSERV', a directory
+       server told us a guess for what our IP might be.
 
        {Controllers may want to record this info and display it to the user.}