README 2.7 KB

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