contrib/README

   1 The contrib/ directory contains small tools that might be useful for using
   2 with Tor.  A few of them are included in the Tor source distribution; you can
   3 find the others in the main Tor repository.  We don't guarantee that they're
   4 particularly useful.
   5
   6 dirauth-tools/ -- Tools useful for directory authority administrators
   7 ---------------------------------------------------------------------
   8
   9 add-tor is an old script to manipulate the approved-routers file.
  10
  11 nagios-check-tor-authority-cert is a nagios script to check when Tor
  12 authority certificates are expired or nearly expired.
  13
  14 clang/ -- Files for use with the clang compiler
  15 -----------------------------------------------
  16
  17 sanitize_blacklist.txt is used to build Tor with clang's dynamic
  18 AddressSanitizer and UndefinedBehaviorSanitizer. It contains detailed
  19 instructions on configuration, build, and testing with clang's sanitizers.
  20
  21 client-tools/ -- Tools for use with Tor clients
  22 -----------------------------------------------
  23
  24 torify is a small wrapper script around torsocks.
  25
  26 tor-resolve.py uses Tor's SOCKS port extensions to perform DNS lookups.  You
  27 should probably use src/tools/tor-resolve instead.
  28
  29 dist/ -- Scripts and files for use when packaging Tor
  30 -----------------------------------------------------
  31
  32 torctl, rc.subr, and tor.sh are init scripts for use with SysV-style init
  33 tools.  Everybody likes to write init scripts differently, it seems.
  34
  35 tor.service is a sample service file for use with systemd.
  36
  37 The suse/ subdirectory contains files used by the suse distribution.
  38
  39 operator-tools/ -- Tools for Tor relay operators
  40 ------------------------------------------------
  41
  42 tor-exit-notice.html is an HTML file for use with the DirPortFrontPage
  43 option.  It tells visitors that your relay is a Tor exit node, and that they
  44 shouldn't assume you're the origin for the traffic that you're delivering.
  45
  46 tor.logrotate is a configuration file for use with the logrotate tool.  You
  47 may need to edit it to work for you.
  48
  49 linux-tor-prio.sh uses Linux iptables tools to traffic-shape your Tor relay's
  50 traffic. If it breaks, you get to keep both pieces.
  51
  52 or-tools/ -- Tools for interacting with relays
  53 ----------------------------------------------
  54
  55 checksocks.pl is a tool to scan relays to see if any of them have advertised
  56 public SOCKS ports, so we can tell them not to.
  57
  58 check-tor is a quick shell script to try doing a TLS handshake with a router
  59 or to try fetching a directory from it.
  60
  61 exitlist is a precursor of check.torproject.org: it parses a bunch of cached
  62 server descriptors to determine which can connect to a given address:port.
  63
  64 win32build -- Old files for windows packaging
  65 ---------------------------------------------
  66
  67 You shouldn't need these unless you're building some of the older Windows
  68 packages.