diff options
author | Nick Mathewson <nickm@torproject.org> | 2023-10-14 14:07:40 -0400 |
---|---|---|
committer | Nick Mathewson <nickm@torproject.org> | 2023-10-14 14:07:40 -0400 |
commit | 4ba45dfd9afd08edeb46243127a480f1d23b9640 (patch) | |
tree | 4dcdb3b4ac378b255d8292693ef234100bf67ac5 /spec/pt-spec | |
parent | d4b9bcc71565e1c3b7b74ddfcd44730697c10c6b (diff) | |
download | torspec-4ba45dfd9afd08edeb46243127a480f1d23b9640.tar.gz torspec-4ba45dfd9afd08edeb46243127a480f1d23b9640.zip |
Run mdformat on the spec files.
Diffstat (limited to 'spec/pt-spec')
-rw-r--r-- | spec/pt-spec/architecture-overview.md | 4 | ||||
-rw-r--r-- | spec/pt-spec/introduction.md | 2 | ||||
-rw-r--r-- | spec/pt-spec/pluggable-transport-configuration-environment.md | 10 |
3 files changed, 8 insertions, 8 deletions
diff --git a/spec/pt-spec/architecture-overview.md b/spec/pt-spec/architecture-overview.md index 64a3eca..ef4a6a4 100644 --- a/spec/pt-spec/architecture-overview.md +++ b/spec/pt-spec/architecture-overview.md @@ -15,7 +15,7 @@ ``` On the client's host, the PT Client software exposes a SOCKS proxy -[RFC1928] to the client application, and obfuscates or otherwise +\[RFC1928\] to the client application, and obfuscates or otherwise transforms traffic before forwarding it to the server's host. On the server's host, the PT Server software exposes a reverse proxy @@ -24,7 +24,7 @@ obfuscation/transformation applied to traffic, before forwarding it to the actual server software. An optional lightweight protocol exists to facilitate communicating connection meta-data that would otherwise be lost such as the source IP address and port -[EXTORPORT]. +\[EXTORPORT\]. All PT instances are configured by the respective parent process via a set of standardized environment variables (3.2) that are set at diff --git a/spec/pt-spec/introduction.md b/spec/pt-spec/introduction.md index 6db3ea5..796468e 100644 --- a/spec/pt-spec/introduction.md +++ b/spec/pt-spec/introduction.md @@ -24,4 +24,4 @@ Transports. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in -[RFC2119]. +\[RFC2119\]. diff --git a/spec/pt-spec/pluggable-transport-configuration-environment.md b/spec/pt-spec/pluggable-transport-configuration-environment.md index 19bd351..79e9f67 100644 --- a/spec/pt-spec/pluggable-transport-configuration-environment.md +++ b/spec/pt-spec/pluggable-transport-configuration-environment.md @@ -6,7 +6,7 @@ All Pluggable Transport proxy instances are configured by their parent process at launch time via a set of well defined environment variables. -The "TOR_PT_" prefix is used for namespacing reasons and does not +The "TOR_PT\_" prefix is used for namespacing reasons and does not indicate any relations to Tor, except for the origins of this specification. @@ -92,13 +92,13 @@ use. If this value is unset or empty, the PT proxy MUST use the default source address for outgoing connections. -This setting MUST be ignored for connections to the loopback address ([::1]). +This setting MUST be ignored for connections to the loopback address (\[::1\]). IPv6 addresses MUST always be wrapped in square brackets. Example:: -TOR_PT_OUTBOUND_BIND_ADDRESS_V6=[2001:db8::4] +TOR_PT_OUTBOUND_BIND_ADDRESS_V6=\[2001:db8::4\] <a id="pt-spec.txt-3.2.2"></a> @@ -124,7 +124,7 @@ TOR_PT_CLIENT_TRANSPORTS=obfs2,obfs3,obfs4 "TOR_PT_PROXY" Specifies an upstream proxy that the PT MUST use when making -outgoing network connections. It is a URI [RFC3986] of the +outgoing network connections. It is a URI \[RFC3986\] of the format: `<proxy_type>://[<user_name>[:<password>][@]<ip>:<port>`. @@ -230,7 +230,7 @@ TOR_PT_ORPORT=127.0.0.1:9001 "TOR_PT_EXTENDED_SERVER_PORT" Specifies the destination that the PT reverse proxy should -forward traffic to, via the Extended ORPort protocol [EXTORPORT] +forward traffic to, via the Extended ORPort protocol \[EXTORPORT\] as an `<address>:<port>`. The Extended ORPort protocol allows the PT reverse proxy to |