summaryrefslogtreecommitdiff
path: root/docs/faq.rst
diff options
context:
space:
mode:
authorIb Lundgren <ib.lundgren@gmail.com>2013-05-30 13:33:49 +0100
committerIb Lundgren <ib.lundgren@gmail.com>2013-05-30 13:33:49 +0100
commit99681d2b80619ba0cd17cccd08a6c63b9024421f (patch)
treee0f278fc8d7a56b3d9223c580a6c6eed6f95e268 /docs/faq.rst
parent6f1f4b660f8fcfbdc21a33c8df51485c2bb5725a (diff)
downloadoauthlib-99681d2b80619ba0cd17cccd08a6c63b9024421f.tar.gz
Begun documenting faq and features. Fix #119 and #117.
Diffstat (limited to 'docs/faq.rst')
-rw-r--r--docs/faq.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/faq.rst b/docs/faq.rst
new file mode 100644
index 0000000..561df15
--- /dev/null
+++ b/docs/faq.rst
@@ -0,0 +1,40 @@
+F.A.Q
+=====
+
+What parts of OAuth 1 & 2 is supported?
+ See :doc:`feature_matrix`.
+
+What is the difference between a client and a consumer?
+ None, they both refer to the third-party accessing protected resources
+ from an OAuth provider on behalf of a user. In order to do so they have
+ to obtain authorization from said user, which is what the `Auth` in `OAuth`
+ stands for.
+
+How do I use OAuthLib with Google, Twitter and other providers?
+ Most people will be using OAuthLib indirectly. Clients will want to look at
+ `requests-oauthlib`_.
+
+How do I use OAuthlib as a provider with Django, Flask and other web frameworks?
+ Providers using Django should seek out `django-oauth-toolkit`_
+ and those using Flask `flask-oauthlib`_. For other frameworks,
+ please get in touch by opening a `GitHub issue`_, on `G+`_ or
+ on IRC #oauthlib irc.freenode.net.
+
+What is the difference between authentication and authorization?
+ See `difference`_.
+
+Very briefly, what is the biggest difference between OAuth 1 and 2?
+ OAuth 2 is much simpler since it requires the use of TLS whereas OAuth 1
+ had the requirement to work securely without TLS. To be secure without TLS
+ OAuth 1 required each request to be signed which can be cumbersome.
+
+Some argue OAuth 2 is worse than 1, is that true?
+ Correctly implemented, OAuth 2 is better in many ways than OAuth 1. Getting
+ it right is not trivial and a task OAuthLib aims to help make simple.
+
+.. _`requests-oauthlib`: https://github.com/requests/requests-oauthlib
+.. _`django-oauth-toolkit`: https://github.com/evonove/django-oauth-toolkit
+.. _`flask-oauthlib`: https://github.com/lepture/flask-oauthlib
+.. _`GitHub issue`: https://github.com/idan/oauthlib/issues/new
+.. _`G+`: https://plus.google.com/communities/101889017375384052571
+.. _`difference`: http://www.cyberciti.biz/faq/authentication-vs-authorization/