README 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. === AUTONAMING FOR TOR ===
  2. Tor directory authorities may maintain a binding of server identities
  3. (their long term identity key) and nicknames. In their status documents
  4. they may for each router they know tell if this is indeed the owner of
  5. that nickname or not.
  6. This toolset allows automatic maintaining of a binding list of nicknames
  7. to identity keys, implementing Tor proposal 123[1].
  8. The rules are simple:
  9. - A router claiming to be Bob is named (i.e. added to the binding list)
  10. if there currently does not exist a different binding for that
  11. nickname, the router has been around for a bit (2 weeks), no other
  12. router has used that nickname in a while (1 month).
  13. - A binding is removed if the server that owns it has not been seen
  14. in a long time (6 months).
  15. === REQUIREMENTS ===
  16. * ruby, and its postgres DBI interface (Debian packages: ruby, ruby1.8, libdbi-ruby1.8, libdbd-pg-ruby1.8)
  17. * postgres (tested with >= 8.1)
  18. * cron
  19. === SETUP ===
  20. * copy this tree some place, like into a 'auto-naming' directory in your Tor's
  21. data directory
  22. * create a database and a user, modifying db-config.rb accordingly
  23. * initialize the database by executing the sql statements in create-db.sql
  24. * setup a cronjob that feeds the current consensus to the process-consensus
  25. script regularly.
  26. * once the database is sufficiently populated, maybe a month or so after the
  27. previous step, setup a cronjob to regularly build the binding list using
  28. the build-approved-routers script. You probably want to append a manually
  29. manged list of rejections to that file and give it to tor as its
  30. "approved-routers" file.
  31. The Sample-Makefile and Sample-crontab demonstrate the method used at tor26.
  32. 1. https://tor-svn.freehaven.net/svn/tor/trunk/doc/spec/proposals/123-autonaming.txt
  33. Copyright (c) 2007 Peter Palfrader
  34. Permission is hereby granted, free of charge, to any person obtaining a copy
  35. of this software and associated documentation files (the "Software"), to deal
  36. in the Software without restriction, including without limitation the rights
  37. to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  38. copies of the Software, and to permit persons to whom the Software is
  39. furnished to do so, subject to the following conditions:
  40. The above copyright notice and this permission notice shall be included in
  41. all copies or substantial portions of the Software.
  42. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  43. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  44. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  45. AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  46. LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  47. OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  48. SOFTWARE.