feat: Remove JWT_AUTH_REFRESH_COOKIE (#7042)

The setting JWT_AUTH_REFRESH_COOKIE is meaningless and unused and is being cleaned up to avoid confusion. See DEPR: openedx/public-engineering#190
openedx-unsupported · Oct 11, 2023 · 8da3ed0 · 8da3ed0
1 parent 0a7edaa
commit 8da3ed0
Show file tree

Hide file tree

Showing 8 changed files with 0 additions and 9 deletions.
diff --git a/docker/build/enterprise_catalog/enterprise_catalog.yml b/docker/build/enterprise_catalog/enterprise_catalog.yml
@@ -41,7 +41,6 @@ EXTRA_APPS: []
 JWT_AUTH:
     JWT_AUTH_COOKIE_HEADER_PAYLOAD: edx-jwt-cookie-header-payload
     JWT_AUTH_COOKIE_SIGNATURE: edx-jwt-cookie-signature
-    JWT_AUTH_REFRESH_COOKIE: edx-jwt-refresh-cookie
     JWT_ISSUERS:
     -   AUDIENCE: lms-key
         ISSUER: http://localhost:18000/oauth2

diff --git a/playbooks/roles/common_vars/defaults/main.yml b/playbooks/roles/common_vars/defaults/main.yml
@@ -272,7 +272,6 @@ COMMON_JWT_PUBLIC_SIGNING_JWK_SET: ''
 
 COMMON_JWT_AUTH_COOKIE_HEADER_PAYLOAD: 'edx-jwt-cookie-header-payload'
 COMMON_JWT_AUTH_COOKIE_SIGNATURE: 'edx-jwt-cookie-signature'
-COMMON_JWT_AUTH_REFRESH_COOKIE: 'edx-jwt-refresh-cookie'
 
 # To be deprecated, in favor of the above COMMON_JWT_PUBLIC_SIGNING_JWK_SET.
 COMMON_JWT_SECRET_KEY: 'SET-ME-PLEASE'

diff --git a/playbooks/roles/ecommerce/defaults/main.yml b/playbooks/roles/ecommerce/defaults/main.yml
@@ -226,7 +226,6 @@ ecommerce_config:
     JWT_PUBLIC_SIGNING_JWK_SET: '{{ COMMON_JWT_PUBLIC_SIGNING_JWK_SET|string }}'
     JWT_AUTH_COOKIE_HEADER_PAYLOAD: '{{ COMMON_JWT_AUTH_COOKIE_HEADER_PAYLOAD }}'
     JWT_AUTH_COOKIE_SIGNATURE: '{{ COMMON_JWT_AUTH_COOKIE_SIGNATURE }}'
-    JWT_AUTH_REFRESH_COOKIE: '{{ COMMON_JWT_AUTH_REFRESH_COOKIE }}'
 
   EDX_DRF_EXTENSIONS: '{{ ECOMMERCE_EDX_DRF_EXTENSIONS }}'
 

diff --git a/playbooks/roles/edx_django_service/defaults/main.yml b/playbooks/roles/edx_django_service/defaults/main.yml
@@ -183,7 +183,6 @@ edx_django_service_jwt_auth:
   JWT_PUBLIC_SIGNING_JWK_SET: '{{ COMMON_JWT_PUBLIC_SIGNING_JWK_SET|string }}'
   JWT_AUTH_COOKIE_HEADER_PAYLOAD: '{{ COMMON_JWT_AUTH_COOKIE_HEADER_PAYLOAD }}'
   JWT_AUTH_COOKIE_SIGNATURE: '{{ COMMON_JWT_AUTH_COOKIE_SIGNATURE }}'
-  JWT_AUTH_REFRESH_COOKIE: '{{ COMMON_JWT_AUTH_REFRESH_COOKIE }}'
 
 edx_django_service_extra_apps: []
 

diff --git a/playbooks/roles/edx_django_service_with_rendered_config/defaults/main.yml b/playbooks/roles/edx_django_service_with_rendered_config/defaults/main.yml
@@ -166,7 +166,6 @@ edx_django_service_with_rendered_config_jwt_auth:
   JWT_PUBLIC_SIGNING_JWK_SET: '{{ COMMON_JWT_PUBLIC_SIGNING_JWK_SET|string }}'
   JWT_AUTH_COOKIE_HEADER_PAYLOAD: '{{ COMMON_JWT_AUTH_COOKIE_HEADER_PAYLOAD }}'
   JWT_AUTH_COOKIE_SIGNATURE: '{{ COMMON_JWT_AUTH_COOKIE_SIGNATURE }}'
-  JWT_AUTH_REFRESH_COOKIE: '{{ COMMON_JWT_AUTH_REFRESH_COOKIE }}'
 
 edx_django_service_with_rendered_config_extra_apps: []
 

diff --git a/playbooks/roles/edx_notes_api/defaults/main.yml b/playbooks/roles/edx_notes_api/defaults/main.yml
@@ -101,7 +101,6 @@ edx_notes_api_service_config:
     JWT_PUBLIC_SIGNING_JWK_SET: '{{ COMMON_JWT_PUBLIC_SIGNING_JWK_SET|string }}'
     JWT_AUTH_COOKIE_HEADER_PAYLOAD: '{{ COMMON_JWT_AUTH_COOKIE_HEADER_PAYLOAD }}'
     JWT_AUTH_COOKIE_SIGNATURE: '{{ COMMON_JWT_AUTH_COOKIE_SIGNATURE }}'
-    JWT_AUTH_REFRESH_COOKIE: '{{ COMMON_JWT_AUTH_REFRESH_COOKIE }}'
   USERNAME_REPLACEMENT_WORKER: "{{ EDX_NOTES_USERNAME_REPLACEMENT_WORKER }}"
 
 #

diff --git a/playbooks/roles/edxapp/defaults/main.yml b/playbooks/roles/edxapp/defaults/main.yml
@@ -434,7 +434,6 @@ EDXAPP_JWT_SECRET_KEY: "{{ COMMON_JWT_SECRET_KEY }}"
 EDXAPP_JWT_PUBLIC_SIGNING_JWK_SET: "{{ COMMON_JWT_PUBLIC_SIGNING_JWK_SET|string }}"
 EDXAPP_JWT_AUTH_COOKIE_HEADER_PAYLOAD: '{{ COMMON_JWT_AUTH_COOKIE_HEADER_PAYLOAD }}'
 EDXAPP_JWT_AUTH_COOKIE_SIGNATURE: '{{ COMMON_JWT_AUTH_COOKIE_SIGNATURE }}'
-EDXAPP_JWT_AUTH_REFRESH_COOKIE: '{{ COMMON_JWT_AUTH_REFRESH_COOKIE }}'
 
 # See https://github.com/openedx/edx-platform/blob/master/openedx/core/djangoapps/oauth_dispatch/docs/decisions/0008-use-asymmetric-jwts.rst
 EDXAPP_JWT_SIGNING_ALGORITHM: !!null
@@ -1429,7 +1428,6 @@ generic_env_config:  &edxapp_generic_env
     JWT_PRIVATE_SIGNING_JWK: "{{ EDXAPP_JWT_PRIVATE_SIGNING_JWK|string }}"
     JWT_AUTH_COOKIE_HEADER_PAYLOAD: "{{ EDXAPP_JWT_AUTH_COOKIE_HEADER_PAYLOAD }}"
     JWT_AUTH_COOKIE_SIGNATURE: "{{ EDXAPP_JWT_AUTH_COOKIE_SIGNATURE }}"
-    JWT_AUTH_REFRESH_COOKIE: "{{ EDXAPP_JWT_AUTH_REFRESH_COOKIE }}"
 
   # edx-rbac Setting
   SYSTEM_WIDE_ROLE_CLASSES: "{{ EDXAPP_SYSTEM_WIDE_ROLE_CLASSES }}"

diff --git a/util/helm_values_to_rst_table_util/README.md b/util/helm_values_to_rst_table_util/README.md
@@ -40,7 +40,6 @@ Example:
 	app.config.HAYSTACK_CONNECTIONS.default.URL                                                          TODO                                                                                                 http://notes-elasticsearch-client:9200/
 	app.config.JWT_AUTH.JWT_AUTH_COOKIE_HEADER_PAYLOAD                                                   TODO                                                                                                 stage-edx-jwt-cookie-header-payload
 	app.config.JWT_AUTH.JWT_AUTH_COOKIE_SIGNATURE                                                        TODO                                                                                                 stage-edx-jwt-cookie-signature
-	app.config.JWT_AUTH.JWT_AUTH_REFRESH_COOKIE                                                          TODO                                                                                                 stage-edx-jwt-refresh-cookie
 	app.config.JWT_AUTH.JWT_ISSUERS                                                                      TODO                                                                                                 []
 	app.config.JWT_AUTH.JWT_PUBLIC_SIGNING_JWK_SET                                                       TODO                                                                                                 
 	app.config.RESULTS_DEFAULT_SIZE                                                                      TODO                                                                                                 25