aboutsummaryrefslogtreecommitdiff
path: root/spec/pt-spec
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2023-10-13 18:00:42 -0400
committerNick Mathewson <nickm@torproject.org>2023-10-13 18:00:42 -0400
commitf79272ef1f774b3788b74a3fe4fef75095dfae06 (patch)
tree8f47bebaa06c444f632bf8c4afbd793c4972a27d /spec/pt-spec
parentfa014ec90411fd754dd257d04afa1a953e15bf31 (diff)
downloadtorspec-f79272ef1f774b3788b74a3fe4fef75095dfae06.tar.gz
torspec-f79272ef1f774b3788b74a3fe4fef75095dfae06.zip
Run markdownlint --fix on spec.
Diffstat (limited to 'spec/pt-spec')
-rw-r--r--spec/pt-spec/acknowledgments.md2
-rw-r--r--spec/pt-spec/anonymity-considerations.md2
-rw-r--r--spec/pt-spec/architecture-overview.md2
-rw-r--r--spec/pt-spec/example-client-pluggable-transport-session.md2
-rw-r--r--spec/pt-spec/example-server-pluggable-transport-session.md2
-rw-r--r--spec/pt-spec/introduction.md3
-rw-r--r--spec/pt-spec/pluggable-transport-client-per-connection-arguments.md2
-rw-r--r--spec/pt-spec/pluggable-transport-configuration-environment.md5
-rw-r--r--spec/pt-spec/pluggable-transport-naming.md2
-rw-r--r--spec/pt-spec/pluggable-transport-shutdown.md2
-rw-r--r--spec/pt-spec/pluggable-transport-to-parent-process-communication.md6
-rw-r--r--spec/pt-spec/references.md2
-rw-r--r--spec/pt-spec/specification.md2
13 files changed, 22 insertions, 12 deletions
diff --git a/spec/pt-spec/acknowledgments.md b/spec/pt-spec/acknowledgments.md
index 8c12c83..92d373a 100644
--- a/spec/pt-spec/acknowledgments.md
+++ b/spec/pt-spec/acknowledgments.md
@@ -1,6 +1,6 @@
<a id="pt-spec.txt-6"></a>
+
# Acknowledgments
This specification draws heavily from prior versions done by Jacob
Appelbaum, Nick Mathewson, and George Kadianakis.
-
diff --git a/spec/pt-spec/anonymity-considerations.md b/spec/pt-spec/anonymity-considerations.md
index 80b3826..ce3a54e 100644
--- a/spec/pt-spec/anonymity-considerations.md
+++ b/spec/pt-spec/anonymity-considerations.md
@@ -1,4 +1,5 @@
<a id="pt-spec.txt-4"></a>
+
# Anonymity Considerations
When designing and implementing a Pluggable Transport, care
@@ -20,4 +21,3 @@ Additionally, certain obfuscation mechanisms rely on information
such as the server IP address/port being confidential, so clients
also need to take care to preserve server side information
confidential when applicable.
-
diff --git a/spec/pt-spec/architecture-overview.md b/spec/pt-spec/architecture-overview.md
index 44718b2..64a3eca 100644
--- a/spec/pt-spec/architecture-overview.md
+++ b/spec/pt-spec/architecture-overview.md
@@ -1,4 +1,5 @@
<a id="pt-spec.txt-2"></a>
+
# Architecture Overview
```text
@@ -34,4 +35,3 @@ Each invocation of a PT MUST be either a client OR a server.
All PT client forward proxies MUST support either SOCKS 4 or SOCKS 5,
and SHOULD prefer SOCKS 5 over SOCKS 4.
-
diff --git a/spec/pt-spec/example-client-pluggable-transport-session.md b/spec/pt-spec/example-client-pluggable-transport-session.md
index 017bcaf..2f20f5d 100644
--- a/spec/pt-spec/example-client-pluggable-transport-session.md
+++ b/spec/pt-spec/example-client-pluggable-transport-session.md
@@ -1,4 +1,5 @@
<a id="pt-spec.txt-A"></a>
+
# Appendix A: Example Client Pluggable Transport Session
Environment variables:
@@ -16,4 +17,3 @@ PROXY DONE
CMETHOD obfs3 socks5 127.0.0.1:32525
CMETHOD obfs4 socks5 127.0.0.1:37347
CMETHODS DONE
-
diff --git a/spec/pt-spec/example-server-pluggable-transport-session.md b/spec/pt-spec/example-server-pluggable-transport-session.md
index 15a9ab1..3fc3962 100644
--- a/spec/pt-spec/example-server-pluggable-transport-session.md
+++ b/spec/pt-spec/example-server-pluggable-transport-session.md
@@ -1,4 +1,5 @@
<a id="pt-spec.txt-B"></a>
+
# Appendix B: Example Server Pluggable Transport Session
Environment variables:
@@ -15,4 +16,3 @@ VERSION 1
SMETHOD obfs3 198.51.100.1:1984
SMETHOD obfs4 198.51.100.1:43734 ARGS:cert=HszPy3vWfjsESCEOo9ZBkRv6zQ/1mGHzc8arF0y2SpwFr3WhsMu8rK0zyaoyERfbz3ddFw,iat-mode=0
SMETHODS DONE
-
diff --git a/spec/pt-spec/introduction.md b/spec/pt-spec/introduction.md
index fae42bc..6db3ea5 100644
--- a/spec/pt-spec/introduction.md
+++ b/spec/pt-spec/introduction.md
@@ -1,4 +1,5 @@
<a id="pt-spec.txt-1"></a>
+
# Introduction
This specification describes a way to decouple protocol-level
@@ -17,10 +18,10 @@ in this document will be able to use all spec compliant Pluggable
Transports.
<a id="pt-spec.txt-1.1"></a>
+
## Requirements Notation
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].
-
diff --git a/spec/pt-spec/pluggable-transport-client-per-connection-arguments.md b/spec/pt-spec/pluggable-transport-client-per-connection-arguments.md
index cce6748..869fb59 100644
--- a/spec/pt-spec/pluggable-transport-client-per-connection-arguments.md
+++ b/spec/pt-spec/pluggable-transport-client-per-connection-arguments.md
@@ -1,4 +1,5 @@
<a id="pt-spec.txt-3.5"></a>
+
## Pluggable Transport Client Per-Connection Arguments
Certain PT transport protocols require that the client provides
@@ -35,4 +36,3 @@ SOCKS protocol version.
If the encoded argument list is less than 255 bytes in
length, the "PLEN" field must be set to "1" and the "PASSWD"
field must contain a single NUL character.
-
diff --git a/spec/pt-spec/pluggable-transport-configuration-environment.md b/spec/pt-spec/pluggable-transport-configuration-environment.md
index 3a201f8..0fd9571 100644
--- a/spec/pt-spec/pluggable-transport-configuration-environment.md
+++ b/spec/pt-spec/pluggable-transport-configuration-environment.md
@@ -1,4 +1,5 @@
<a id="pt-spec.txt-3.2"></a>
+
## Pluggable Transport Configuration Environment Variables
All Pluggable Transport proxy instances are configured by their
@@ -10,6 +11,7 @@ indicate any relations to Tor, except for the origins of this
specification.
<a id="pt-spec.txt-3.2.1"></a>
+
### Common Environment Variables
When launching either a client or server Pluggable Transport proxy,
@@ -99,6 +101,7 @@ Example::
TOR_PT_OUTBOUND_BIND_ADDRESS_V6=[2001:db8::4]
<a id="pt-spec.txt-3.2.2"></a>
+
### Pluggable Transport Client Environment Variables
Client-side Pluggable Transport forward proxies are configured
@@ -139,6 +142,7 @@ Examples:
```
<a id="pt-spec.txt-3.2.3"></a>
+
### Pluggable Transport Server Environment Variables
Server-side Pluggable Transport reverse proxies are configured
@@ -252,4 +256,3 @@ incoming traffic, "TOR_PT_AUTH_COOKIE_FILE" MUST be omitted.
Example:
TOR_PT_AUTH_COOKIE_FILE=/var/lib/tor/extended_orport_auth_cookie
-
diff --git a/spec/pt-spec/pluggable-transport-naming.md b/spec/pt-spec/pluggable-transport-naming.md
index 50ebcb3..339f89c 100644
--- a/spec/pt-spec/pluggable-transport-naming.md
+++ b/spec/pt-spec/pluggable-transport-naming.md
@@ -1,4 +1,5 @@
<a id="pt-spec.txt-3.1"></a>
+
## Pluggable Transport Naming
Pluggable Transport names serve as unique identifiers, and every
@@ -10,4 +11,3 @@ ASCII letters, numbers or underscores. No length limit is
imposted.
PT names MUST satisfy the regular expression "[a-zA-Z_][a-zA-Z0-9_]*".
-
diff --git a/spec/pt-spec/pluggable-transport-shutdown.md b/spec/pt-spec/pluggable-transport-shutdown.md
index b2c0fcc..cd826d9 100644
--- a/spec/pt-spec/pluggable-transport-shutdown.md
+++ b/spec/pt-spec/pluggable-transport-shutdown.md
@@ -1,4 +1,5 @@
<a id="pt-spec.txt-3.4"></a>
+
## Pluggable Transport Shutdown
The recommended way for Pluggable Transport using applications and
@@ -29,4 +30,3 @@ Pluggable Transports to handle graceful shutdown is as follows.
terminated (eg: via detecting that its parent process ID has
changed on U*IX systems), and gracefully terminate.
```
-
diff --git a/spec/pt-spec/pluggable-transport-to-parent-process-communication.md b/spec/pt-spec/pluggable-transport-to-parent-process-communication.md
index b7f8175..985bcb5 100644
--- a/spec/pt-spec/pluggable-transport-to-parent-process-communication.md
+++ b/spec/pt-spec/pluggable-transport-to-parent-process-communication.md
@@ -1,4 +1,5 @@
<a id="pt-spec.txt-3.3"></a>
+
## Pluggable Transport To Parent Process Communication
All Pluggable Transport Proxies communicate to the parent process
@@ -19,6 +20,7 @@ The parent process MUST ignore lines received from PT proxies with
unknown keywords.
<a id="pt-spec.txt-3.3.1"></a>
+
### Common Messages
When a PT proxy first starts up, it must determine which version
@@ -93,6 +95,7 @@ Example:
ENV-ERROR No TOR_PT_AUTH_COOKIE_FILE when TOR_PT_EXTENDED_SERVER_PORT set
<a id="pt-spec.txt-3.3.2"></a>
+
### Pluggable Transport Client Messages
After negotiating the Pluggable Transport Specification version,
@@ -174,6 +177,7 @@ Notes:
```
<a id="pt-spec.txt-3.3.3"></a>
+
### Pluggable Transport Server Messages
PT server reverse proxies iterate over the requested transports
@@ -240,6 +244,7 @@ Upon sending the "SMETHODS DONE" message, the PT proxy
initialization is complete.
<a id="pt-spec.txt-3.3.4"></a>
+
### Pluggable Transport Log Message
This message is for a client or server PT to be able to signal back to the
@@ -270,6 +275,7 @@ Example:
`LOG SEVERITY=debug MESSAGE="Connected to bridge A"`
<a id="pt-spec.txt-3.3.5"></a>
+
### Pluggable Transport Status Message
This message is for a client or server PT to be able to signal back to the
diff --git a/spec/pt-spec/references.md b/spec/pt-spec/references.md
index 6956c00..e94d41d 100644
--- a/spec/pt-spec/references.md
+++ b/spec/pt-spec/references.md
@@ -1,4 +1,5 @@
<a id="pt-spec.txt-5"></a>
+
# References
```text
@@ -19,4 +20,3 @@
[RFC1929] Leech, M., "Username/Password Authentication for
SOCKS V5", RFC 1929, March 1996.
```
-
diff --git a/spec/pt-spec/specification.md b/spec/pt-spec/specification.md
index 0c10377..7a8822b 100644
--- a/spec/pt-spec/specification.md
+++ b/spec/pt-spec/specification.md
@@ -1,4 +1,5 @@
<a id="pt-spec.txt-3"></a>
+
# Specification
Pluggable Transport proxies follow the following workflow
@@ -49,4 +50,3 @@ throughout their lifespan.
7) Upon being signaled to terminate by the parent process (3.4),
the PT Proxy gracefully shuts down.
```
-