@@ -1,4 +1,4 @@ -= OpenID::Proxy += Rack::OpenID::Proxy This is an OpenID Proxy application. @@ -27,7 +27,7 @@ If you want xml formatted responses ... ( or override the XML formatter to format responses however you want ) -== Usage +== Setup Rack::OpenID::Proxy can be used as a Rack middleware or as a standalone Rack app. @@ -51,7 +51,24 @@ If you run Rack::OpenID::Proxy as a standalone app, 404's will be returned for a If you run Rack::OpenID::Proxy as a middleware, all non-OpenID related requests will be passed along to the main application. -=== Configuration +== Usage + +Basically, OpenID::Proxy accepts requests to <tt>/openid?url=my.openid.url</tt>. + +When it gets a request like that it: +* Saves the REFERER (the URL the request came from) +* Redirects to the OpenID provider's login +* Gets a response from the OpenID provider (whether the login was valid/etc) +* Rediects back the the REFERER, adding a <tt>token</tt> variable to the URL: <tt>http://mysite.com/original_path?token=12345</tt> + +Now, your application can take this token and, to find out if the login was valid, make a request back to the proxy: <tt>/openid?token=12345</tt> and that'll return the OpenID response. You can get the OpenID response in many formats: +* <tt>/openid.yml?token=12345</tt> +* <tt>/openid.json?token=12345</tt> +* <tt>/openid.xml?token=12345</tt> + +By default, after a token has been requested once and the response has been returned, the token/response are deleted from the Proxy (so no one else can get the response). You can disable this by setting <tt>:delete_token_on_request => false</tt> when initializing the Rack::OpenID::Proxy + +== Configuration Rack::OpenID::Proxy takes a few configuration options, eg. README.rdoc 26ccece172aed68c93583b0353a01df5eb0072f9 remi remi@remitaylor.com http://github.com/devfu/rack-openid-proxy/commit/82af7005cca773380f29bdb49e2aa3e0521df861 82af7005cca773380f29bdb49e2aa3e0521df861 2009-06-30T19:09:06-07:00 2009-06-30T19:09:06-07:00 README header was wrong ... also added new Usage information ea0444c2a14b69c9bac59a894b084bd56e5aca99 remi remi@remitaylor.com