Tor Specifications

https://spec.torproject.org
Admin
These specifications describe how the Tor network and its protocols work, providing enough detail...
Tokens:1,619,840
Snippets:11,784
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example CMETHOD Line

Source: https://spec.torproject.org/proposals/180-pluggable-transport.txt

An example of a configured CMETHOD line.

```text
CMETHOD trebuchet socks5 127.0.0.1:19999 ARGS=rocks,height \
           OPT-ARGS=tensile-strength
```

--------------------------------

### HSPOST command example

Source: https://spec.torproject.org/control-spec/commands.html

An example of the HSPOST command usage and the corresponding server response.

```text
__
     C: +HSPOST SERVER=9695DFC35FFEB861329B9F1AB04C46397020CE31
        [DESCRIPTOR]
        .
     S: 250 OK
```

--------------------------------

### SMETHOD message examples

Source: https://spec.torproject.org/pt-spec/ipc.html

Examples of the SMETHOD message used to signal that a requested PT transport has been launched, including an example with optional ARGS.

```text
SMETHOD trebuchet 198.51.100.1:19999
SMETHOD rot_by_N 198.51.100.1:2323 ARGS:N=13
```

--------------------------------

### CLIENTS_SEEN Event Syntax and Examples

Source: https://spec.torproject.org/print.html

Syntax and example output for client country and IP version summaries.

```text
     "650" SP "CLIENTS_SEEN" SP TimeStarted SP CountrySummary SP
     IPVersions CRLF
```

```text
    650-CLIENTS_SEEN TimeStarted="2008-12-25 23:50:43"
    CountrySummary=us=16,de=8,uk=8
```

```text
    IPVersions=v4=16,v6=40
```

--------------------------------

### Examples of .exit notation

Source: https://spec.torproject.org/print.html

Examples showing how to connect to a specific hostname via a specific exit node or connect to the exit node itself.

```text
__
  EXAMPLES:
     www.example.com.exampletornode.exit

        Connect to www.example.com from the node called "exampletornode".

     exampletornode.exit

        Connect to the published IP address of "exampletornode" using
        "exampletornode" as the exit.
```

--------------------------------

### Example SMETHOD Error

Source: https://spec.torproject.org/proposals/180-pluggable-transport.txt

An example of an SMETHOD error message.

```text
SMETHOD-ERROR trebuchet could not setup 'trebuchet' method
```

--------------------------------

### ESTABLISH_INTRO Authentication Key Types

Source: https://spec.torproject.org/proposals/224-rend-spec-ng.txt

Lists the recognized authentication key types for the introduction point.

```text
[00, 01] -- Reserved for legacy introduction cells; see
            [LEGACY_EST_INTRO below]
[02] -- Ed25519; SHA3-256.
```

--------------------------------

### Phase 0: Starting

Source: https://spec.torproject.org/control-spec/implementation-notes.html

The initial phase when Tor starts.

```text
Phase 0: tag=starting summary=“Starting”
Tor starts out in this phase.
```

--------------------------------

### ADD_ONION Command Examples

Source: https://spec.torproject.org/control-spec/commands.html

Various examples of creating Onion Services with different key types, port mappings, and client authorization configurations.

```text
     C: ADD_ONION NEW:BEST Flags=DiscardPK Port=80
     S: 250-ServiceID=exampleoniont2pqglbny66wpovyvao3ylc23eileodtevc4b75ikpad
     S: 250 OK

     C: ADD_ONION RSA1024:[Blob Redacted] Port=80,192.168.1.1:8080
     S: 250-ServiceID=sampleonion12456
     S: 250 OK

     C: ADD_ONION NEW:BEST Port=22 Port=80,8080
     S: 250-ServiceID=sampleonion4t2pqglbny66wpovyvao3ylc23eileodtevc4b75ikpad
     S: 250-PrivateKey=ED25519-V3:[Blob Redacted]
     S: 250 OK

     C: ADD_ONION NEW:RSA1024 Flags=DiscardPK,BasicAuth Port=22
        ClientAuth=alice:[Blob Redacted] ClientAuth=bob
     S: 250-ServiceID=testonion1234567
     S: 250-ClientAuth=bob:[Blob Redacted]
     S: 250 OK

     C: ADD_ONION NEW:ED25519-V3 ClientAuthV3=[Blob Redacted] Port=22
     S: 250-ServiceID=n35etu3yjxrqjpntmfziom5sjwspoydchmelc4xleoy4jk2u4lziz2yd
     S: 250-ClientAuthV3=[Blob Redacted]
     S: 250 OK
```

--------------------------------

### CMETHOD example

Source: https://spec.torproject.org/proposals/print.html

An example of a CMETHOD line reporting a trebuchet method.

```text
CMETHOD trebuchet socks5 127.0.0.1:19999 ARGS=rocks,height \
           OPT-ARGS=tensile-strength
```

--------------------------------

### MAPADDRESS Usage Example

Source: https://spec.torproject.org/control-spec/commands.html

Example showing how to map an IP to a hostname, verify the mapping with GETINFO, and remove the mapping.

```text
__
    C: MAPADDRESS 1.2.3.4=torproject.org
    S: 250 1.2.3.4=torproject.org

    C: GETINFO address-mappings/control
    S: 250-address-mappings/control=1.2.3.4 torproject.org NEVER
    S: 250 OK

    C: MAPADDRESS 1.2.3.4=1.2.3.4
    S: 250 1.2.3.4=1.2.3.4

    C: GETINFO address-mappings/control
    S: 250-address-mappings/control=
    S: 250 OK
```

--------------------------------

### TOR_PT_OUTBOUND_BIND_ADDRESS_V4 example

Source: https://spec.torproject.org/print.html

Example of specifying an IPv4 address for outgoing packets.

```bash
TOR_PT_OUTBOUND_BIND_ADDRESS_V4=203.0.113.4
```

--------------------------------

### TOR_PT_EXIT_ON_STDIN_CLOSE example

Source: https://spec.torproject.org/print.html

Example of enabling graceful termination on stdin closure.

```bash
TOR_PT_EXIT_ON_STDIN_CLOSE=1
```

--------------------------------

### GETINFO version response example

Source: https://spec.torproject.org/print.html

Example of a GETINFO request for version and descriptor information and the corresponding server response.

```text
     C: GETINFO version desc/name/moria1
     S: 250+desc/name/moria=
     S: [Descriptor for moria]
     S: .
     S: 250-version=Tor 0.1.1.0-alpha-cvs
     S: 250 OK
```

--------------------------------

### Example: Bind on 0.0.0.0:9001

Source: https://spec.torproject.org/proposals/186-multiple-orports.html

A basic configuration to bind the ORPort on all interfaces at port 9001.

```text
ORPort 9001
```

--------------------------------

### TOR_PT_MANAGED_TRANSPORT_VER example

Source: https://spec.torproject.org/print.html

Example of setting the supported Pluggable Transport specification versions.

```bash
TOR_PT_MANAGED_TRANSPORT_VER=1,1a,2b,this_is_a_valid_ver
```

--------------------------------

### Decimal effort calculation example

Source: https://spec.torproject.org/print.html

The decimal representation of the effort calculation example.

```text
__
effort(6317) = 1048575 / 6317 = 165.
```

--------------------------------

### PROTOCOLINFO command example

Source: https://spec.torproject.org/proposals/119-controlport-auth.html

A sample exchange showing a controller requesting protocol information and receiving authentication and version details from Tor.

```text
C: PROTOCOLINFO CRLF
S: "250+PROTOCOLINFO 1" CRLF
S: "250-AUTH Methods=HASHEDPASSWORD,COOKIE COOKIEFILE="/tor/cookie"" CRLF
S: "250-VERSION Tor=0.2.0.5-alpha" CRLF
S: "250 OK" CRLF
```
Tokens:
Raw