diff options
author | F. Kooman <fkooman@tuxed.net> | 2012-10-28 21:49:23 +0400 |
---|---|---|
committer | F. Kooman <fkooman@tuxed.net> | 2012-10-28 21:49:23 +0400 |
commit | 978935772092e2a55e1bdbf35d14b798ac9d4687 (patch) | |
tree | fda766c353f37e1b80af2b0c3233c5d905dd6d3a /user_oauth | |
parent | d67eef5d61628ceeb4182ae78645d27e35165b46 (diff) |
add README
Diffstat (limited to 'user_oauth')
-rw-r--r-- | user_oauth/README.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/user_oauth/README.md b/user_oauth/README.md new file mode 100644 index 000000000..08bcb2edd --- /dev/null +++ b/user_oauth/README.md @@ -0,0 +1,43 @@ +# Introduction +This version implements the server side OAuth "Bearer" token verification +against an external authorization server. It aims at supporting both +the [php-oauth](https://github.com/fkooman/php-oauth) service and the +[Google](https://developers.google.com/accounts/docs/OAuth2Login#validatingtoken) service. + +# Configuration +There currently is only one configuration parameter: the Token Info Endpoint. +For quick tests, one can use the playground environment, installed using +[this](https://github.com/fkooman/oauth-install-all) script located at +https://frko.surfnetlabs.nl/workshop/. + +For the "workshop" installation the Token Info Endpoint would be + + https://frko.surfnetlabs.nl/workshop/php-oauth/tokeninfo.php + +For Google the Token Info Endpoint is: + + https://www.googleapis.com/oauth2/v1/tokeninfo + +# Applications +An application needs to use the OAuth service to retrieve an access token to +use this with the OAuth enabled WebDAV endpoint. The endpoint, assuming you +run the service on https://www.example.org/owncloud: + + https://www.example.org/owncloud/remote.php/odav/<FILE.EXT> + +So, in order for an application to work it needs to obtain an access token +from the OAuth authorization server that you configured as a Token Info +Endpoint in the OAuth app configuration in Owncloud. If you used the +playground mentioned above that would mean using the following URLs: + + https://frko.surfnetlabs.nl/workshop/php-oauth/authorize.php + https://frko.surfnetlabs.nl/workshop/php-oauth/token.php + +In the playground environment you can also register an OAuth client so you +can actually use the client with the OAuth service. + +Template applications for both [Android]() and [iOS]() are available that +implement OAuth 2.0 and can be used to modify the Owncloud Mobile Apps. + +So far, the Owncloud Mobie Apps have not been updated to support OAuth 2.0. + |