doc/spec/address-spec.txt

   1 $Id$
   2
   3                           Special Hostnames in Tor
   4                                Nick Mathewson
   5
   6 1. Overview
   7
   8   Most of the time, Tor treats user-specified hostnames as opaque:  When the
   9   user connects to tor.eff.org, Tor picks an exit node and uses that node to
  10   connect to "tor.eff.org".  Some hostnames, however, can be used to override
  11   Tor's default behavior and circuit-building rules.
  12
  13   These hostnames can be passed to Tor as the address part of a SOCKS4a or
  14   SOCKS5 request.  If the application is connected to Tor using an IP-only
  15   method (such as SOCKS4, TransPort, or NatdPort), these hostnames can be
  16   substituted for certain IP addresses using the MapAddress configuration
  17   option or the MAPADDRESS control command.
  18
  19 2. .exit
  20
  21   SYNTAX:  [hostname].[name-or-digest].exit
  22            [name-or-digest].exit
  23
  24   Hostname is a valid hostname; [name-or-digest] is either the nickname of a
  25   Tor node or the hex-encoded digest of that node's public key.
  26
  27   When Tor sees an address in this format, it uses the specified hostname as
  28   the exit node.  If no "hostname" component is given, Tor defaults to the
  29   published IPv4 address of the exit node.
  30
  31   It is valid to try to resolve hostnames, and in fact upon success Tor
  32   will cache an internal mapaddress of the form
  33   "www.google.com.foo.exit=64.233.161.99.foo.exit" to speed subsequent
  34   lookups.
  35
  36   EXAMPLES:
  37      www.example.com.exampletornode.exit
  38
  39         Connect to www.example.com from the node called "exampletornode."
  40
  41      exampletornode.exit
  42
  43         Connect to the published IP address of "exampletornode" using
  44         "exampletornode" as the exit.
  45
  46 3. .onion
  47
  48   SYNTAX:  [digest].onion
  49
  50   The digest is the first eighty bits of a SHA1 hash of the identity key for
  51   a hidden service, encoded in base32.
  52
  53   When Tor sees an address in this format, it tries to look up and connect to
  54   the specified hidden service.  See rend-spec.txt for full details.
  55
  56 4. .noconnect
  57
  58   SYNTAX:  [string].noconnect
  59
  60   When Tor sees an address in this format, it immediately closes the
  61   connection without attaching it to any circuit.  This is useful for
  62   controllers that want to test whether a given application is indeed using
  63   the same instance of Tor that they're controlling.
  64