aboutsummaryrefslogtreecommitdiff
path: root/control-spec.txt
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2019-01-17 12:03:39 -0500
committerNick Mathewson <nickm@torproject.org>2019-01-17 12:03:39 -0500
commit795420240305a6d67c0f4322993a65da4c7b6f2f (patch)
treed229018e5e0b9f039b6a5766d5ee6c63aa7914dc /control-spec.txt
parente1cb6341f97a18d362fe024b823dbd08b4724988 (diff)
parent01f475a1ca0d8ece5550b35124b014b91fca3193 (diff)
downloadtorspec-795420240305a6d67c0f4322993a65da4c7b6f2f.tar.gz
torspec-795420240305a6d67c0f4322993a65da4c7b6f2f.zip
Merge remote-tracking branch 'dgoulet/ticket28182_04'
Diffstat (limited to 'control-spec.txt')
-rw-r--r--control-spec.txt48
1 files changed, 48 insertions, 0 deletions
diff --git a/control-spec.txt b/control-spec.txt
index 6b63679..5c8eaf4 100644
--- a/control-spec.txt
+++ b/control-spec.txt
@@ -3275,6 +3275,54 @@
[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/obs4proxy SEVERITY=debug MESSAGE="Connected to bridge A"
+
+ [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 TRANSPORT=Transport SP Message
+
+ Program = The program path as defined in the *TransportPlugin
+ configuration option. Tor accepts relative and full path.
+ Transport = This value indicate a hint on what the PT is such has the
+ name or the protocol used for instance.
+ 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 TRANSPORT=obfs4 CONNECT=Success
+
+ the resulting control port event would be:
+
+ Tor: 650 PT_STATUS PT=/usr/bin/obs4proxy TRANSPORT=obfs4 CONNECT=Success
+
+ [PT_STATUS was added in Tor 0.4.0.1-alpha]
+
5. Implementation notes
5.1. Authentication