diff options
author | George Kadianakis <desnacked@riseup.net> | 2013-06-12 12:59:35 +0300 |
---|---|---|
committer | Nick Mathewson <nickm@torproject.org> | 2013-09-07 13:44:05 -0400 |
commit | 178c4cc058c5ce5c0bc07ee0fb76f0ea6ea03d14 (patch) | |
tree | 180922bd6a47f4126ccdeeb145321d5450629bca /pt-spec.txt | |
parent | 14f3c671b4ba3c7eba10e3960ac4aa7a8a294355 (diff) | |
download | torspec-178c4cc058c5ce5c0bc07ee0fb76f0ea6ea03d14.tar.gz torspec-178c4cc058c5ce5c0bc07ee0fb76f0ea6ea03d14.zip |
Specify how to pass configuration parameters to server transports.
Also, add an example of the SOCKS parameters.
Diffstat (limited to 'pt-spec.txt')
-rw-r--r-- | pt-spec.txt | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/pt-spec.txt b/pt-spec.txt index b61e7c2..4cefcfe 100644 --- a/pt-spec.txt +++ b/pt-spec.txt @@ -37,6 +37,8 @@ Specifications: Client behavior password fields of the request, splitting them across the fields as necessary. If a key or value value must contain a semicolon or a backslash, it is escaped with a backslash. + Example of SOCKS parameters encoding: + shared-secret=rahasia;secrets-file=/tmp/blob Method names MUST be C identifiers. That is, method names must begin with a letter or underscore and the rest of the characters can be @@ -151,6 +153,16 @@ Server behavior trasport before, it will instruct the managed proxy to bind to the same TCP port that the transport used last time. + Further configuration parameters (like the k=v values passed to + client-transports using the Bridge line) can be passed to + server-transports using the ServerTransportOptions option. + + The format of the ServerTransportOptions line is: + ServerTransportOptions <method> <k=v> ... + + For example, a valid instance of this line would be: + ServerTransportOptions trebuchet secret=nou cache=/tmp/cache + Managed proxy interface When the Tor client or relay launches a managed proxy, it communicates @@ -221,6 +233,20 @@ Managed proxy interface TOR_PT_AUTH_COOKIE_FILE is optional and might not be present in the environment of the proxy. + "TOR_PT_SERVER_TRANSPORT_OPTIONS" -- A comma seperated list + of <key>:<value> pairs, where <key> is a transport name and + <value> is a k=v string value with options that are to be + passed to the transport. Colons, semicolons, equal signs and + backslashes must be escaped with a backslash. + The TOR_PT_SERVER_TRANSPORT_OPTIONS is optional and might not + be present in the environment of the proxy if no options need + to be passed to transports. + Example: + TOR_PT_SERVER_TRANSPORT_OPTIONS=trebuchet:secret=nou;trebuchet:cache=/tmp/cache;ballista:secret=yes + will pass to 'trebuchet' the arguments "secret=nou" and + "cache=/tmp/cache" and will pass to 'ballista' the argument + "secret=yes". + The transport proxy replies by writing NL-terminated lines to stdout. The line metaformat is |