[tor-commits] [torspec/master] control-spec: Add the PT_STATUS event

[nickm at torproject.org]

commit b38257efad09be1678f92a7184464fd3b5b9f560
Author: David Goulet <dgoulet at torproject.org>
Date:   Mon Jan 7 11:53:39 2019 -0500

    control-spec: Add the PT_STATUS event
    
    Once we add the STATUS message on the PT side, Tor will relay it to the
    control port through this event named PT_STATUS.
    
    This is to address #25502. Implemented in #28179.
    
    Closes #28182
    
    Signed-off-by: David Goulet <dgoulet at torproject.org>
---
 control-spec.txt | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/control-spec.txt b/control-spec.txt
index 4135add..c9c7d41 100644
--- a/control-spec.txt
+++ b/control-spec.txt
@@ -3283,6 +3283,29 @@
 
    [PT_LOG was added in Tor 0.4.0.1-alpha]
 
+4.1.29. Pluggable Transport Status
+
+   Syntax:
+      "650" SP "PT_STATUS" SP PT=Program SP Message
+
+      Program = The program path as defined in the *TransportPlugin
+                configuration option. Tor accepts relative and full path.
+      Message = The status message that the PT sends back to the tor parent
+                process minus the "STATUS" string prefix. Formatted as
+                specified in pt-spec.txt section 3.3.5.
+
+   This event is triggered when tor receives a log message from the PT.
+
+   Example:
+
+      PT (obfs4): STATUS TYPE=obfs4 CONNECT=Success
+
+   the resulting control port event would be:
+
+      Tor: 650 PT_STATUS PT=/usr/bin/obfs4proxy TYPE=obfs4 CONNECT=Success
+
+   [PT_STATUS was added in Tor 0.4.0.1-alpha]
+
 5. Implementation notes
 
 5.1. Authentication