README 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. Dependencies:
  2. You're going to need openssl (0.9.6 will work fine, possibly 0.9.5 also)
  3. and popt installed. If you're on Linux, everything will probably work
  4. fine. If you're not, you're on your own (but let us know how it goes).
  5. If you got the source from cvs:
  6. Run "./autogen.sh", which will run the various auto* programs and then
  7. run ./configure for you. From there, you should be able to run 'make'
  8. and you'll be on your way.
  9. If you got the source from a tarball:
  10. Run ./configure and make as usual. There isn't much point in
  11. 'make install' yet.
  12. If this doesn't work for you / troubleshooting:
  13. If you couldn't find popt (eg you're on BSD), try
  14. CPPFLAGS="-I/usr/local/include" LDFLAGS="-L/usr/local/lib" \
  15. ./configure
  16. rather than simply ./configure.
  17. Check out the list archives at http://archives.seul.org/or/dev/ and see
  18. if somebody else has reported your problem. If not, please subscribe
  19. and let us know what you did to fix it, or give us the details and
  20. we'll see what we can do.
  21. Once you've got it compiled:
  22. It's a bit hard to figure out what to do with the binaries. If you
  23. want to just run a local onion proxy, go into src/config and look at
  24. the oprc file. You can run an onion proxy by "../or/or -f oprc". In
  25. another window, run something like "../httpap/httpap -f httpaprc -p
  26. 9051". See below for how to use it.
  27. If you want to set up your own test network, go into src/config/ and
  28. look at the routers.or file. Also in that directory are public and
  29. private keys for various nodes (*-public, *-private) and configuration
  30. files for the nodes (*-orrc). You can generate your own keypairs with
  31. the orkeygen program, or use the provided ones for testing.
  32. Once you've got your config files ready, you're ready to start up your
  33. network. I recommend using a screen session (man screen), or some
  34. other way to handle many windows at once. I open a window for each
  35. onion router, go into the src/config directory, and run something like
  36. "../or/or -f moria2-orrc". In yet another window, I run something like
  37. "../httpap/httpap -f httpaprc -p 9051".
  38. How to use it:
  39. From here, you can point your browser/etc at localhost:9051 and treat
  40. it as a web proxy. As a first test, you might telnet to it and enter
  41. "GET http://seul.org/ HTTP/1.0" (without the quotes), followed by a pair
  42. of carriage returns (one to separate your request from the headers,
  43. and another to indicate that you're providing no headers). For more
  44. convenient command-line use, I recommend making a ~/.wgetrc with
  45. the line
  46. http_proxy=localhost:9051
  47. Then you can do things like "wget seul.org" and watch as it downloads
  48. from the onion routing network.
  49. For fun, you can wget a very large file (a megabyte or more), and
  50. then ^z the wget a little bit in. The onion routers will continue
  51. talking for a while, queueing around 500k in the kernel-level buffers.
  52. When the kernel buffers are full, and the outbuf for the AP connection
  53. also fills, the internal congestion control will kick in and the exit
  54. connection will stop reading from the webserver. The circuit will
  55. wait until you fg the wget -- and other circuits will work just fine
  56. throughout. Then try ^z'ing the onion routers, and watch how well it
  57. recovers. Then try ^z'ing several of them at once. :)