aboutsummaryrefslogtreecommitdiff
path: root/control-spec.txt
diff options
context:
space:
mode:
authorDavid Goulet <dgoulet@torproject.org>2018-10-25 12:08:41 -0400
committerDavid Goulet <dgoulet@torproject.org>2019-01-07 11:54:21 -0500
commit3028cf166067cd688683bdf674d462869f7565ec (patch)
tree9141d90d892c40f52bb508d08373a2de4ce2d727 /control-spec.txt
parentecbde01aaeda6e06e5736158100e7dfcf3c8887d (diff)
downloadtorspec-3028cf166067cd688683bdf674d462869f7565ec.tar.gz
torspec-3028cf166067cd688683bdf674d462869f7565ec.zip
control-spec: Add the PT_LOG event
Once we add the LOG message on the PT side, Tor will relay it to the control port through this event named PT_LOG. This is to address #25502. Implemented in #28179. Closes #28182 Signed-off-by: David Goulet <dgoulet@torproject.org>
Diffstat (limited to 'control-spec.txt')
-rw-r--r--control-spec.txt23
1 files changed, 23 insertions, 0 deletions
diff --git a/control-spec.txt b/control-spec.txt
index fb4cb3e..4135add 100644
--- a/control-spec.txt
+++ b/control-spec.txt
@@ -3260,6 +3260,29 @@
[NETWORK_LIVENESS was added in Tor 0.2.7.2-alpha]
+4.1.28. Pluggable Transport Logs
+
+ Syntax:
+ "650" SP "PT_LOG" SP PT=Program SP Message
+
+ Program = The program path as defined in the *TransportPlugin
+ configuration option. Tor accepts relative and full path.
+ Message = The log message that the PT sends back to the tor parent
+ process minus the "LOG" string prefix. Formatted as
+ specified in pt-spec.txt section 3.3.4.
+
+ This event is triggered when tor receives a log message from the PT.
+
+ Example:
+
+ PT (obfs4): LOG SEVERITY=debug MESSAGE="Connected to bridge A"
+
+ the resulting control port event would be:
+
+ Tor: 650 PT_LOG PT=/usr/bin/obfs4proxy SEVERITY=debug MESSAGE="Connected to bridge A"
+
+ [PT_LOG was added in Tor 0.4.0.1-alpha]
+
5. Implementation notes
5.1. Authentication