feat: [FC-0006] add Verifiable Credentials bare feature (openedx#1973)

credentials/apps/verifiable_credentials/admin.py

@@ -0,0 +1,3 @@
+"""
+Admin section configuration.
+"""

credentials/apps/verifiable_credentials/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class VerifiableCredentialsConfig(AppConfig):
+    name = "credentials.apps.verifiable_credentials"
+    verbose_name = "Verifiable Credentials"

credentials/apps/verifiable_credentials/checks.py

@@ -0,0 +1,3 @@
+"""
+Verifiable Credentials self-checks.
+"""

credentials/apps/verifiable_credentials/composition/__init__.py

@@ -0,0 +1,3 @@
+"""
+Verifiable Credentials different data models specifications.
+"""

credentials/apps/verifiable_credentials/composition/open_badges.py

@@ -0,0 +1,4 @@
+"""
+Open Badges 3.0.* data model.
+See specification: https://1edtech.github.io/openbadges-specification/ob_v3p0.html
+"""

credentials/apps/verifiable_credentials/composition/schemas.py

@@ -0,0 +1,3 @@
+"""
+Complementary schemas for verifiable credential composition.
+"""

credentials/apps/verifiable_credentials/composition/utils.py

@@ -0,0 +1,3 @@
+"""
+Composition utils.
+"""

credentials/apps/verifiable_credentials/composition/verifiable_credentials.py

@@ -0,0 +1,5 @@
+"""
+Verifiable Credentials v1.1 data model.
+
+See specification: https://www.w3.org/TR/vc-data-model/
+"""

credentials/apps/verifiable_credentials/issuance/__init__.py

@@ -0,0 +1,3 @@
+"""
+Issuance module.
+"""

credentials/apps/verifiable_credentials/issuance/main.py

@@ -0,0 +1,3 @@
+"""
+Issuance line processor.
+"""

credentials/apps/verifiable_credentials/issuance/models.py

@@ -0,0 +1,3 @@
+"""
+Verifiable Credentials DB models.
+"""

credentials/apps/verifiable_credentials/issuance/renderers.py

@@ -0,0 +1,3 @@
+"""
+Verifiable credentials renderers.
+"""

credentials/apps/verifiable_credentials/issuance/serializers.py

@@ -0,0 +1,3 @@
+"""
+Verifiable Credentials serializers.
+"""

credentials/apps/verifiable_credentials/issuance/status_list.py

@@ -0,0 +1,6 @@
+"""
+Status List issuance utils.
+
+Status list is managed for each Issuer separately.
+Status lists are verifiable credentials themselves, but with a specific shape.
+"""

credentials/apps/verifiable_credentials/issuance/utils.py

@@ -0,0 +1,3 @@
+"""
+Issuance utils.
+"""

credentials/apps/verifiable_credentials/permissions.py

@@ -0,0 +1,3 @@
+"""
+Verifiable credentials specific permissions.
+"""

credentials/apps/verifiable_credentials/rest_api/urls.py

@@ -0,0 +1,8 @@
+"""Root API URLs for verifiable_credentials."""
+from django.conf.urls import include
+from django.urls import re_path
+
+
+urlpatterns = [
+    re_path(r"^v1/", include(("credentials.apps.verifiable_credentials.rest_api.v1.urls", "v1"), namespace="v1")),
+]

credentials/apps/verifiable_credentials/rest_api/v1/urls.py

@@ -0,0 +1,11 @@
+"""
+Verifiable Credentials API v1 URLs.
+"""
+from rest_framework import routers
+
+
+router = routers.DefaultRouter()
+
+urlpatterns = []
+
+urlpatterns += router.urls

credentials/apps/verifiable_credentials/settings.py

@@ -0,0 +1,13 @@
+"""
+Settings for Verifiable Credentials are all namespaced in the VERIFIABLE_CREDENTIALS setting.
+This is pretty similar to what the DRF does, like this:
+
+VERIFIABLE_CREDENTIALS = {
+    'setting_1': 'value_1',
+    'setting_2': 'value_2',
+}
+
+This module provides the `vc_setting` object, that is used to access
+Verifiable Credentials settings, checking for explicit settings first, then falling
+back to the defaults.
+"""

credentials/apps/verifiable_credentials/signals.py

@@ -0,0 +1,3 @@
+"""
+Verifiable Credentials signal handlers.
+"""

credentials/apps/verifiable_credentials/storages/__init__.py

@@ -0,0 +1,3 @@
+"""
+Verifiable Credentials built-in storage backends.
+"""

credentials/apps/verifiable_credentials/storages/status_list.py

@@ -0,0 +1,3 @@
+"""
+Status List 2021 storage.
+"""

credentials/apps/verifiable_credentials/storages/utils.py

@@ -0,0 +1,3 @@
+"""
+Storages utils.
+"""

credentials/apps/verifiable_credentials/toggles.py

@@ -0,0 +1,21 @@
+"""
+Toggles for verifiable_credentials app.
+"""
+
+from edx_toggles.toggles import SettingToggle
+
+
+# .. toggle_name: ENABLE_VERIFIABLE_CREDENTIALS
+# .. toggle_implementation: DjangoSetting
+# .. toggle_default: False
+# .. toggle_description: Determines if the Credentials IDA uses digital credentials issuance.
+# .. toggle_warning: Requires the Learner Record MFE to be deployed and used in a given environment if toggled to true.
+# .. toggle_life_expectancy: permanent
+# .. toggle_permanent_justification: Digital Credentials are optional for usage.
+# .. toggle_creation_date: 2023-02-02
+# .. toggle_use_cases: open_edx
+ENABLE_VERIFIABLE_CREDENTIALS = SettingToggle("ENABLE_VERIFIABLE_CREDENTIALS", default=False, module_name=__name__)
+
+
+def is_verifiable_credentials_enabled():
+    return ENABLE_VERIFIABLE_CREDENTIALS.is_enabled()

credentials/apps/verifiable_credentials/urls.py

@@ -0,0 +1,10 @@
+"""
+URLs for verifiable_credentials.
+"""
+from django.conf.urls import include
+from django.urls import re_path
+
+
+urlpatterns = [
+    re_path(r"^api/", include(("credentials.apps.verifiable_credentials.rest_api.urls", "api"), namespace="api")),
+]

credentials/settings/base.py

@@ -74,6 +74,7 @@
     "credentials.apps.credentials_theme_openedx",
     "credentials.apps.records",
     "credentials.apps.plugins",
+    "credentials.apps.verifiable_credentials",
 ]
 
 INSTALLED_APPS += THIRD_PARTY_APPS

credentials/settings/private.py.example

@@ -15,3 +15,7 @@ PROGRAMS_CACHE_TTL = 60
 # USER API CONFIGURATION
 # Specified in seconds. Enable caching by setting this to a value greater than 0.
 USER_CACHE_TTL = 60
+
+# Verifiable Credentials
+USE_LEARNER_RECORD_MFE = True
+ENABLE_VERIFIABLE_CREDENTIALS = True

credentials/settings/test.py

@@ -50,3 +50,13 @@
 )
 STATICFILES_STORAGE = None
 add_plugins(__name__, PROJECT_TYPE, SettingsType.TEST)
+
+# Verifiable Credentials
+ENABLE_VERIFIABLE_CREDENTIALS = True
+VERIFIABLE_CREDENTIALS = {
+    "DEFAULT_ISSUER": {
+        "ID": "test-issuer-did",
+        "KEY": "test-issuer-key",
+        "NAME": "test-issuer-name",
+    }
+}

credentials/urls.py

@@ -31,6 +31,7 @@
 from credentials.apps.core import views as core_views
 from credentials.apps.plugins.constants import PROJECT_TYPE
 from credentials.apps.records.views import ProgramListingView
+from credentials.apps.verifiable_credentials.toggles import is_verifiable_credentials_enabled
 from credentials.views import FaviconView, MockToggleStateView
 
 
@@ -66,6 +67,17 @@
     re_path(r"^hijack/", include("hijack.urls", namespace="hijack")),
 ]
 
+if is_verifiable_credentials_enabled():
+    urlpatterns += [
+        re_path(
+            r"^verifiable_credentials/",
+            include(
+                ("credentials.apps.verifiable_credentials.urls", "verifiable_credentials"),
+                namespace="verifiable_credentials",
+            ),
+        ),
+    ]
+
 # edx-drf-extensions csrf app
 urlpatterns += [
     path("", include("csrf.urls")),