@@ -1,23 +1,61 @@ # OAuth Proxy -I am an OAuth proxy server. You can pass unsigned requests to me and I will sign them using [OAuth](http://oauth.net/ "OAuth") before sending them to their eventual destination. +I am an OAuth proxy server. You can pass unsigned requests to me and I will +sign them using [OAuth](http://oauth.net/ "OAuth") before sending them to +their eventual destination. -At the moment, tokens and consumer keys are configurable only at start-time, so individual proxies are limited to a single pair at a time. +At the moment, tokens and consumer keys are configurable only at start-time, +so individual proxies are limited to a single pair at a time. ## Running -Provided that "." is in your `PYTHONPATH`, you should be able to run the proxy with `twistd`: +Run the proxy with `twistd`: - twistd -n oauth_proxy --consumer-key <consumer key> --consumer-secret <consumer secret> [--token <token>] [--token-secret <token secret>] [-p <proxy port>] [--ssl] + twistd -n oauth_proxy \ + --consumer-key <consumer key> \ + --consumer-secret <consumer secret> \ + [--token <token>] \ + [--token-secret <token secret>] \ + [-p <proxy port>] \ + [--ssl] +"." may need to be in your `PYTHONPATH` in order for this to work. You'll also +need a relatively modern version of [Twisted](http://twistedmatrix.com/ +"Twisted") for this to work; OS X 10.5 comes with _2.5.0_, which is too old. +_8.2.0_ (installed via `easy_install twisted`) appears to work just fine. ## Running as a daemon -You may run the proxy with `twistd` directly (omitting the _-n_ argument) or you may generate a pre-configured tap, which can then be packaged and distributed. To generate a tap: +You may run the proxy with `twistd` directly (omitting the _-n_ argument) or +you may generate a pre-configured tap, which can then be packaged and +distributed. To generate a tap: - mktap oauth_proxy --consumer-key <consumer key> --consumer-secret <consumer secret> [--token <token>] [--token-secret <token secret>] [-p <proxy port>] [--ssl] + mktap oauth_proxy \ + --consumer-key <consumer key> \ + --consumer-secret <consumer secret> \ + [--token <token>] \ + [--token-secret <token secret>] \ + [-p <proxy port>] \ + [--ssl] To run the tap (using the settings that were provided when creating it): twistd -f oauth_proxy.tap + +## Using + +This proxy can be used with command-line tools and web browsers alike. + +To use it with `curl`: + + curl -x localhost:8001 http://host.name/path + +To use it with `ab` (ApacheBench): + + ab -X localhost:8001 http://host.name/path + +To use it with Firefox, open the Network settings panel, under Advanced, and +set a "Manual Proxy Configuration" after clicking the "Settings..." button. +Ensure that "No Proxy for" does *not* include the host that you are attempting +to explore. README.markdown 1254652769674919f1069b3fd44eccde795c7754 Seth Fitzsimmons seth@mojodna.net http://github.com/mojodna/oauth-proxy/commit/1c3c60019d72432c0a709fea26b9fa6d08efd371 1c3c60019d72432c0a709fea26b9fa6d08efd371 2009-05-07T01:56:10-07:00 2009-05-07T01:56:10-07:00 better docs Reflect that a recent version of Twisted (i.e. 8.2.0) is required and provide instructions for using with `curl`, `ab`, and Firefox. 9f1a57b3d557eab85492c4d2182b246b8073f361 Seth Fitzsimmons seth@mojodna.net