From 1718cc91baab5f84fbeef453045e9e3e6733df53 Mon Sep 17 00:00:00 2001 From: Robert Raposa Date: Thu, 13 Feb 2020 10:16:33 -0500 Subject: [PATCH] remove hard line breaks --- .../djangoapps/oauth_dispatch/docs/README.rst | 59 ++++++------------- 1 file changed, 17 insertions(+), 42 deletions(-) diff --git a/openedx/core/djangoapps/oauth_dispatch/docs/README.rst b/openedx/core/djangoapps/oauth_dispatch/docs/README.rst index 245bda3337..c0a1784ddc 100644 --- a/openedx/core/djangoapps/oauth_dispatch/docs/README.rst +++ b/openedx/core/djangoapps/oauth_dispatch/docs/README.rst @@ -1,8 +1,7 @@ OAuth Dispatch App (OAuth2 Provider Interface) ---------------------------------------------- -The OAuth Dispatch app is the topmost interface to `OAuth2`_ provider -functionality. See decisions_ for its historical journey. +The OAuth Dispatch app is the topmost interface to `OAuth2`_ provider functionality. See decisions_ for its historical journey. .. _OAuth2: https://tools.ietf.org/html/rfc6749 .. _decisions: decisions/ @@ -10,28 +9,22 @@ functionality. See decisions_ for its historical journey. Background ---------- -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`_. +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`_. .. _Open edX Authentication: https://openedx.atlassian.net/wiki/spaces/PLAT/pages/160912480/Open+edX+Authentication Provider code ~~~~~~~~~~~~~ -* The oauth_dispatch_ app provides the top-most entry points to the OAuth2 - Provider views. +* The oauth_dispatch_ app provides the top-most entry points to the OAuth2 Provider views. - * Its `validator module`_ ensures Restricted Applications only receive expired - tokens. + * Its `validator module`_ ensures Restricted Applications only receive expired tokens. - * Its `Access Token View`_ returns JWTs as access tokens when a JWT token_type - is requested. + * Its `Access Token View`_ returns JWTs as access tokens when a JWT token_type is requested. * It uses an edX custom JwtBuilder_ implementation to create the JWT. -* The JwtBuilder_ uses the pyjwkest_ library for implementation of `JSON Web - Signature (JWS)`_ and other crypto to build and sign JWT tokens. +* The JwtBuilder_ uses the pyjwkest_ library for implementation of `JSON Web 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 .. _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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* edX services, including LMS, use the edx-rest-api-client_ library - to make OAuth2 client requests and REST API calls. +* edX services, including LMS, use the edx-rest-api-client_ library to make OAuth2 client requests and REST API calls. - * 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. + * 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. - * It makes use of the PyJWT_ library for cryptographically creating - 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. + * It makes use of the PyJWT_ library for cryptographically creating 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. .. _edx-rest-api-client: https://github.com/edx/edx-rest-api-client .. _slumber: https://github.com/samgiles/slumber @@ -66,30 +52,19 @@ Clients & REST API Clients code Authentication by REST endpoints ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* 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. +* 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. -* edX REST endpoints that support JWTs as access tokens declare the custom - edX JwtAuthentication_ class in its DRF authentication_classes_ scheme. +* edX REST endpoints that support JWTs as access tokens declare the custom edX JwtAuthentication_ class in its DRF authentication_classes_ scheme. * JwtAuthentication_ is implemented in the edx-drf-extensions_ library. - * JwtAuthentication_ extends the JSONWebTokenAuthentication_ class - implemented in the django-rest-framework-jwt_ library. + * JwtAuthentication_ extends the JSONWebTokenAuthentication_ class implemented in the django-rest-framework-jwt_ library. - * 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". + * 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". - * **Note:** The Credentials service has its own implementation of - JwtAuthentication_ and should be converted to use the common - implementation in edx-drf-extensions_. + * **Note:** The Credentials service has its own implementation of 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 - go away once Open ID Connect is no longer used. The only remaining - user of its EdXOpenIdConnect_ class is the edx-analytics-dashboard_. +* **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_. .. _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