aboutsummaryrefslogtreecommitdiff
path: root/spec/gettor-spec.md
diff options
context:
space:
mode:
Diffstat (limited to 'spec/gettor-spec.md')
-rw-r--r--spec/gettor-spec.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/spec/gettor-spec.md b/spec/gettor-spec.md
index 274d658..6895a1f 100644
--- a/spec/gettor-spec.md
+++ b/spec/gettor-spec.md
@@ -16,11 +16,13 @@ Table of Contents
```
<a id="gettor-spec.txt-0"></a>
+
# Preface
This document describes GetTor and how to properly implementation GetTor.
<a id="gettor-spec.txt-1"></a>
+
# Overview
GetTor was created to resolve direct and indirect censorship of Tor's
@@ -34,6 +36,7 @@ to fetch Tor. We discovered that it is feasible to use alternate transport
methods such as SMTP between a non-trusted third party or with IRC and XDCC.
<a id="gettor-spec.txt-2"></a>
+
# Implementation
Any compliant GetTor implementation will implement at least a single transport
@@ -47,11 +50,13 @@ GetTor instance. Security and privacy considerations should be described on a
per transport basis.
<a id="gettor-spec.txt-2.1"></a>
+
## Reference implementation
We have implemented[0] a compliant GetTor that supports SMTP as a transport.
<a id="gettor-spec.txt-3"></a>
+
# SMTP transport
The SMTP transport for GetTor should allow users to send any RFC822 compliant
@@ -62,6 +67,7 @@ it should offer the software as a list of packages and their subsequent
descriptions.
<a id="gettor-spec.txt-3.1"></a>
+
## SMTP transport security considerations
Any GetTor instance that offers SMTP as a transport should optionally
@@ -70,6 +76,7 @@ Optionally GetTor should take an OpenPGP key from the user and encrypt the
response with a blinded message.
<a id="gettor-spec.txt-3.2"></a>
+
## SMTP transport privacy considerations
Any GetTor instance that offers SMTP as a transport must at least store the
@@ -83,17 +90,18 @@ how GetTor[1] is in use. This must not include any personally identifying
information about any of the requester beyond language selection.
<a id="gettor-spec.txt-4"></a>
+
# Other transports
At this time no other transports have been specified. IRC XDCC is a likely
useful system as is XMPP/Jabber with the newest OTR file sharing transport.
<a id="gettor-spec.txt-5"></a>
+
# Implementation suggestions
It is suggested that any compliant GetTor instance should be written in a so
called "safe" language such as Python.
-[0] https://gitweb.torproject.org/gettor.git
-[1] https://metrics.torproject.org/packages.html
-
+[0] <https://gitweb.torproject.org/gettor.git>
+[1] <https://metrics.torproject.org/packages.html>