django-oidc-provider/docs/index.rst

52 lines
2 KiB
ReStructuredText
Raw Normal View History

2016-02-11 20:24:34 +00:00
Welcome to Django OIDC Provider Documentation!
==============================================
2016-02-11 17:31:30 +00:00
This tiny (but powerful!) package can help you to provide out of the box all the endpoints, data and logic needed to add OpenID Connect capabilities to your Django projects. And as a side effect a fair implementation of OAuth2.0 too. Covers Authorization Code, Implicit and Hybrid flows.
2016-02-11 20:24:34 +00:00
2016-04-08 19:56:20 +00:00
Also implements the following specifications:
* `OpenID Connect Discovery 1.0 <https://openid.net/specs/openid-connect-discovery-1_0.html>`_
* `OpenID Connect Session Management 1.0 <https://openid.net/specs/openid-connect-session-1_0.html>`_
2016-04-08 19:56:20 +00:00
* `OAuth 2.0 for Native Apps <https://tools.ietf.org/html/draft-ietf-oauth-native-apps-01>`_
* `OAuth 2.0 Resource Owner Password Credentials Grant <https://tools.ietf.org/html/rfc6749#section-4.3>`_
2016-04-08 19:56:20 +00:00
* `Proof Key for Code Exchange by OAuth Public Clients <https://tools.ietf.org/html/rfc7636>`_
2016-02-12 19:22:47 +00:00
--------------------------------------------------------------------------------
2016-02-11 20:24:34 +00:00
Before getting started there are some important things that you should know:
* Despite that implementation MUST support TLS, you *can* make request without using SSL. There is no control on that.
* Supports only requesting Claims using Scope values, so you cannot request individual Claims.
* If you enable the Resource Owner Password Credentials Grant, you MUST implement protection against brute force attacks on the token endpoint
2016-02-11 17:31:30 +00:00
2016-02-12 19:22:47 +00:00
--------------------------------------------------------------------------------
2016-02-11 17:31:30 +00:00
Contents:
.. toctree::
:maxdepth: 2
2016-06-13 16:26:33 +00:00
2016-02-12 19:22:47 +00:00
sections/installation
2016-04-08 19:56:20 +00:00
sections/relyingparties
2016-02-12 19:22:47 +00:00
sections/serverkeys
sections/templates
2016-09-19 21:05:29 +00:00
sections/scopesclaims
2016-06-13 16:26:33 +00:00
sections/userconsent
2016-02-18 19:24:31 +00:00
sections/oauth2
2016-09-26 20:15:32 +00:00
sections/accesstokens
sections/sessionmanagement
sections/tokenintrospection
2016-02-12 19:22:47 +00:00
sections/settings
2016-12-01 19:20:53 +00:00
sections/signals
2016-09-06 18:38:52 +00:00
sections/examples
2016-02-12 19:22:47 +00:00
sections/contribute
2018-04-05 20:27:01 +00:00
sections/changelog
2016-02-11 20:24:34 +00:00
..
2016-02-11 17:31:30 +00:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`