Andal.LND/edx-platform
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

remove hard line breaks

Browse Source
This commit is contained in:
Robert Raposa
2020-02-13 10:16:33 -05:00
parent 9d81f2a320
commit 1718cc91ba
1 changed files with 17 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
openedx/core/djangoapps/oauth_dispatch/docs/README.rst
View File

@@ -1,8 +1,7 @@
OAuth Dispatch App (OAuth2 Provider Interface) OAuth Dispatch App (OAuth2 Provider Interface)
---------------------------------------------- ----------------------------------------------
The OAuth Dispatch app is the topmost interface to `OAuth2`_ provider The OAuth Dispatch app is the topmost interface to `OAuth2`_ provider functionality. See decisions_ for its historical journey.
functionality. See decisions_ for its historical journey.
.. _OAuth2: https://tools.ietf.org/html/rfc6749 .. _OAuth2: https://tools.ietf.org/html/rfc6749
.. _decisions: decisions/ .. _decisions: decisions/
@@ -10,28 +9,22 @@ functionality. See decisions_ for its historical journey.
Background Background
---------- ----------
This section provides a few highlights on the code to provide a This section provides a few highlights on the code to provide a high-level perspective on where different aspects of the OAuth2 flow reside. For additional information, see `Open edX Authentication`_.
high-level perspective on where different aspects of the OAuth2 flow
reside. For additional information, see `Open edX Authentication`_.
.. _Open edX Authentication: https://openedx.atlassian.net/wiki/spaces/PLAT/pages/160912480/Open+edX+Authentication .. _Open edX Authentication: https://openedx.atlassian.net/wiki/spaces/PLAT/pages/160912480/Open+edX+Authentication
Provider code Provider code
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
* The oauth_dispatch_ app provides the top-most entry points to the OAuth2 * The oauth_dispatch_ app provides the top-most entry points to the OAuth2 Provider views.
Provider views.
* Its `validator module`_ ensures Restricted Applications only receive expired * Its `validator module`_ ensures Restricted Applications only receive expired tokens.
tokens.
* Its `Access Token View`_ returns JWTs as access tokens when a JWT token_type * Its `Access Token View`_ returns JWTs as access tokens when a JWT token_type is requested.
is requested.
* It uses an edX custom JwtBuilder_ implementation to create the JWT. * It uses an edX custom JwtBuilder_ implementation to create the JWT.
* The JwtBuilder_ uses the pyjwkest_ library for implementation of `JSON Web * The JwtBuilder_ uses the pyjwkest_ library for implementation of `JSON Web Signature (JWS)`_ and other crypto to build and sign JWT tokens.
Signature (JWS)`_ and other crypto to build and sign JWT tokens.
.. _oauth_dispatch: https://github.com/edx/edx-platform/tree/master/openedx/core/djangoapps/oauth_dispatch .. _oauth_dispatch: https://github.com/edx/edx-platform/tree/master/openedx/core/djangoapps/oauth_dispatch
.. _validator module: https://github.com/edx/edx-platform/blob/master/openedx/core/djangoapps/oauth_dispatch/dot_overrides/validators.py .. _validator module: https://github.com/edx/edx-platform/blob/master/openedx/core/djangoapps/oauth_dispatch/dot_overrides/validators.py
@@ -43,20 +36,13 @@ Provider code
Clients & REST API Clients code Clients & REST API Clients code
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* edX services, including LMS, use the edx-rest-api-client_ library * edX services, including LMS, use the edx-rest-api-client_ library to make OAuth2 client requests and REST API calls.
to make OAuth2 client requests and REST API calls.
* Built on top of slumber_, the edx-rest-api-client_ provides * Built on top of slumber_, the edx-rest-api-client_ provides a utility to retrieve an access token from the LMS. Its Auth_ classes create appropriate HTTP Authorization headers with *Bearer* or *JWT* insertions as needed.
a utility to retrieve an access token from the LMS. Its Auth_
classes create appropriate HTTP Authorization headers with
*Bearer* or *JWT* insertions as needed.
* It makes use of the PyJWT_ library for cryptographically creating * It makes use of the PyJWT_ library for cryptographically creating JWT tokens.
JWT tokens.
* **Note:** Creation of JWT tokens in our system should only be done by the OAuth Provider. This will break once we use *asymmetric* signing keys, for which remote services will not have the private keys.
* **Note:** Creation of JWT tokens in our system should only be done
by the OAuth Provider. This will break once we use *asymmetric* signing
keys, for which remote services will not have the private keys.
.. _edx-rest-api-client: https://github.com/edx/edx-rest-api-client .. _edx-rest-api-client: https://github.com/edx/edx-rest-api-client
.. _slumber: https://github.com/samgiles/slumber .. _slumber: https://github.com/samgiles/slumber
@@ -66,30 +52,19 @@ Clients & REST API Clients code
Authentication by REST endpoints Authentication by REST endpoints
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Recently created edX REST endpoints use the `Django Rest Framework (DRF)`_. * Recently created edX REST endpoints use the `Django Rest Framework (DRF)`_. The REST endpoint declares which type(s) of authentication it supports or defaults to the *DEFAULT_AUTHENTICATION_CLASSES* value in DRF's *REST_FRAMEWORK* Django setting.
The REST endpoint declares which type(s) of authentication it supports
or defaults to the *DEFAULT_AUTHENTICATION_CLASSES* value in DRF's
*REST_FRAMEWORK* Django setting.
* edX REST endpoints that support JWTs as access tokens declare the custom * edX REST endpoints that support JWTs as access tokens declare the custom edX JwtAuthentication_ class in its DRF authentication_classes_ scheme.
edX JwtAuthentication_ class in its DRF authentication_classes_ scheme.
* JwtAuthentication_ is implemented in the edx-drf-extensions_ library. * JwtAuthentication_ is implemented in the edx-drf-extensions_ library.
* JwtAuthentication_ extends the JSONWebTokenAuthentication_ class * JwtAuthentication_ extends the JSONWebTokenAuthentication_ class implemented in the django-rest-framework-jwt_ library.
implemented in the django-rest-framework-jwt_ library.
* JwtAuthentication_ is used to authenticate an API request only * JwtAuthentication_ is used to authenticate an API request only if it is listed in the endpoint's authentication_classes_ and the request's Authorization header specifies "JWT" instead of "Bearer".
if it is listed in the endpoint's authentication_classes_ and the
request's Authorization header specifies "JWT" instead of "Bearer".
* **Note:** The Credentials service has its own implementation of * **Note:** The Credentials service has its own implementation of JwtAuthentication_ and should be converted to use the common implementation in edx-drf-extensions_.
JwtAuthentication_ and should be converted to use the common
implementation in edx-drf-extensions_.
* **Note:** There is also an auth-backends_ repo that should eventually * **Note:** There is also an auth-backends_ repo that should eventually go away once Open ID Connect is no longer used. The only remaining user of its EdXOpenIdConnect_ class is the edx-analytics-dashboard_.
go away once Open ID Connect is no longer used. The only remaining
user of its EdXOpenIdConnect_ class is the edx-analytics-dashboard_.
.. _Django Rest Framework (DRF): https://github.com/encode/django-rest-framework .. _Django Rest Framework (DRF): https://github.com/encode/django-rest-framework
.. _JwtAuthentication: https://github.com/edx/edx-drf-extensions/blob/4569b9bf7e54a917d4acdd545b10c058c960dd1a/edx_rest_framework_extensions/auth/jwt/authentication.py#L17 .. _JwtAuthentication: https://github.com/edx/edx-drf-extensions/blob/4569b9bf7e54a917d4acdd545b10c058c960dd1a/edx_rest_framework_extensions/auth/jwt/authentication.py#L17