README (2649B)
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 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 operator-tools/ -- Tools for Tor relay operators 36 ------------------------------------------------ 37 38 tor-exit-notice.html is an HTML file for use with the DirPortFrontPage 39 option. It tells visitors that your relay is a Tor exit node, and that they 40 shouldn't assume you're the origin for the traffic that you're delivering. 41 42 tor.logrotate is a configuration file for use with the logrotate tool. You 43 may need to edit it to work for you. 44 45 linux-tor-prio.sh uses Linux iptables tools to traffic-shape your Tor relay's 46 traffic. If it breaks, you get to keep both pieces. 47 48 or-tools/ -- Tools for interacting with relays 49 ---------------------------------------------- 50 51 checksocks.pl is a tool to scan relays to see if any of them have advertised 52 public SOCKS ports, so we can tell them not to. 53 54 check-tor is a quick shell script to try doing a TLS handshake with a router 55 or to try fetching a directory from it. 56 57 exitlist is a precursor of check.torproject.org: it parses a bunch of cached 58 server descriptors to determine which can connect to a given address:port. 59 60 win32build -- Old files for windows packaging 61 --------------------------------------------- 62 63 You shouldn't need these unless you're building some of the older Windows 64 packages.