From 0f25975e796da6eff64c4caa4273503fb7457113 Mon Sep 17 00:00:00 2001 From: RG Date: Wed, 3 May 2023 12:38:09 +0300 Subject: [PATCH 1/2] feat: Add settings for Verifiable Credentials This changes allow to configure Verifiable Credentials settings for the "credentials" service. Related tickets: * [OeX_Cred-426](https://youtrack.raccoongang.com/issue/OeX_Cred-426) --- playbooks/roles/credentials/defaults/main.yml | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/playbooks/roles/credentials/defaults/main.yml b/playbooks/roles/credentials/defaults/main.yml index 937f3797dbc..d19f1f78e14 100644 --- a/playbooks/roles/credentials/defaults/main.yml +++ b/playbooks/roles/credentials/defaults/main.yml @@ -99,6 +99,7 @@ CREDENTIALS_FILE_STORAGE_BACKEND: {} CREDENTIALS_CORS_ORIGIN_ALLOW_ALL: false CREDENTIALS_CORS_ORIGIN_WHITELIST_DEFAULT: - '{{ CREDENTIALS_DOMAIN }}' + - '{{ CREDENTIALS_LEARNER_RECORD_MFE_HOSTNAME }}' CREDENTIALS_CORS_ORIGIN_WHITELIST_EXTRA: [] CREDENTIALS_CORS_ORIGIN_WHITELIST: '{{ CREDENTIALS_CORS_ORIGIN_WHITELIST_DEFAULT + CREDENTIALS_CORS_ORIGIN_WHITELIST_EXTRA }}' @@ -124,8 +125,12 @@ credentials_service_config_overrides: CREDENTIALS_SERVICE_USER: '{{ CREDENTIALS_SERVICE_USER }}' FILE_STORAGE_BACKEND: '{{ CREDENTIALS_FILE_STORAGE_BACKEND }}' LANGUAGE_COOKIE_NAME: '{{ CREDENTIALS_LANGUAGE_COOKIE_NAME }}' + USE_LEARNER_RECORD_MFE: '{{ CREDENTIALS_USE_LEARNER_RECORD_MFE }}' + LEARNER_RECORD_MFE_RECORDS_PAGE_URL: "https://{{ CREDENTIALS_LEARNER_RECORD_MFE_HOSTNAME }}/" CSRF_COOKIE_SECURE: "{{ CREDENTIALS_CSRF_COOKIE_SECURE }}" + CSRF_TRUSTED_ORIGINS: "{{ CREDENTIALS_CSRF_TRUSTED_ORIGINS }}" USERNAME_REPLACEMENT_WORKER: "{{ CREDENTIALS_USERNAME_REPLACEMENT_WORKER }}" + VERIFIABLE_CREDENTIALS: "{{ CREDENTIALS_VERIFIABLE_CREDENTIALS }}" # See edx_django_service_automated_users for an example of what this should be CREDENTIALS_AUTOMATED_USERS: {} @@ -137,6 +142,8 @@ CREDENTIALS_LMS_URL_ROOT: !!null CREDENTIALS_DISCOVERY_API_URL: !!null CREDENTIALS_CSRF_COOKIE_SECURE: false +CREDENTIALS_CSRF_TRUSTED_ORIGINS: + - "{{ CREDENTIALS_LEARNER_RECORD_MFE_HOSTNAME }}" CREDENTIALS_ENABLE_NEWRELIC_DISTRIBUTED_TRACING: false @@ -155,3 +162,26 @@ CREDENTIALS_COPY_CONFIG_ENABLED: "{{ COMMON_COPY_CONFIG_ENABLED }}" CREDENTIALS_ENABLE_ADMIN_URLS_RESTRICTION: false CREDENTIALS_ADMIN_URLS: - admin + +CREDENTIALS_USE_LEARNER_RECORD_MFE: false +CREDENTIALS_LEARNER_RECORD_MFE_HOSTNAME: "learner-record.mfe.CHANGE-ME" + +# TODO: Link to VC documentation +# +# TODO: Comment about adding wallet python module to CREDENTIALS_EXTRA_REQUIREMENTS variable +# +CREDENTIALS_VERIFIABLE_CREDENTIALS: + DEFAULT_DATA_MODELS: + - "credentials.apps.verifiable_credentials.composition.verifiable_credentials.VerifiableCredentialsDataModel" + - "credentials.apps.verifiable_credentials.composition.open_badges.OpenBadgesDataModel" + DEFAULT_STORAGES: + - "credentials.apps.verifiable_credentials.storages.learner_credential_wallet.LCWallet" + DEFAULT_ISSUER: + NAME: "Default (system-wide)" + ID: "generate-me-with-didkit-lib" + KEY: "generate-me-with-didkit-lib" + DEFAULT_ISSUANCE_REQUEST_SERIALIZER: "credentials.apps.verifiable_credentials.issuance.serializers.IssuanceLineSerializer" + DEFAULT_RENDERER: "credentials.apps.verifiable_credentials.issuance.renderers.JSONLDRenderer" + STATUS_LIST_STORAGE: "credentials.apps.verifiable_credentials.storages.status_list.StatusList2021" + STATUS_LIST_DATA_MODEL: "credentials.apps.verifiable_credentials.composition.status_list.StatusListDataModel" + STATUS_LIST_LENGTH: 10000 From 5faa2951f246dcc4ac498df8c6df79b498d39108 Mon Sep 17 00:00:00 2001 From: Kyrylo Kholodenko Date: Wed, 10 May 2023 19:40:39 +0300 Subject: [PATCH 2/2] docs: add reference to VC documentation * feat: [OeX_Cred-790] add comment about verifiable credentials documentation * docs: remove resolved TODO --------- Co-authored-by: Glib Glugovskiy --- playbooks/roles/credentials/defaults/main.yml | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/playbooks/roles/credentials/defaults/main.yml b/playbooks/roles/credentials/defaults/main.yml index d19f1f78e14..e965d975e03 100644 --- a/playbooks/roles/credentials/defaults/main.yml +++ b/playbooks/roles/credentials/defaults/main.yml @@ -166,10 +166,9 @@ CREDENTIALS_ADMIN_URLS: CREDENTIALS_USE_LEARNER_RECORD_MFE: false CREDENTIALS_LEARNER_RECORD_MFE_HOSTNAME: "learner-record.mfe.CHANGE-ME" -# TODO: Link to VC documentation -# -# TODO: Comment about adding wallet python module to CREDENTIALS_EXTRA_REQUIREMENTS variable -# +# NOTE: Optional Verifiable Credentials feature +# Documentation can be found at +# https://edx-credentials.readthedocs.io/en/latest/verifiable_credentials/overview.html CREDENTIALS_VERIFIABLE_CREDENTIALS: DEFAULT_DATA_MODELS: - "credentials.apps.verifiable_credentials.composition.verifiable_credentials.VerifiableCredentialsDataModel"