ff-ltitoolkit 0.1.0__py3-none-any.whl

ltitoolkit/core/contrib/django/lti1p3_tool_config/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig  # type: ignore
+
+
+class PyLTI1p3ToolConfig(AppConfig):
+    name = "ltitoolkit.core.contrib.django.lti1p3_tool_config"
+    verbose_name = "PyLTI 1.3 Tool Config"

ltitoolkit/core/contrib/django/lti1p3_tool_config/migrations/0001_initial.py

@@ -0,0 +1,168 @@
+# mypy: ignore-errors
+import django.core.validators
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="LtiToolKey",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "name",
+                    models.CharField(help_text="Key name", max_length=255, unique=True),
+                ),
+                (
+                    "private_key",
+                    models.TextField(
+                        help_text="Tool's generated Private key. "
+                        "Keep this value in secret"
+                    ),
+                ),
+                (
+                    "public_key",
+                    models.TextField(
+                        blank=True, help_text="Tool's generated Public key", null=True
+                    ),
+                ),
+                (
+                    "public_jwk",
+                    models.TextField(
+                        blank=True,
+                        help_text="Tool's generated Public key (from the "
+                        "field above) presented as JWK.",
+                        null=True,
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "lti 1.3 tool key",
+                "verbose_name_plural": "lti 1.3 tool keys",
+                "db_table": "lti1p3_tool_key",
+            },
+        ),
+        migrations.CreateModel(
+            name="LtiTool",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("title", models.CharField(max_length=255)),
+                ("is_active", models.BooleanField(default=True)),
+                (
+                    "issuer",
+                    models.CharField(
+                        help_text="This will usually look something like 'http://example.com'. "
+                        "Value provided by LTI 1.3 Platform",
+                        max_length=255,
+                    ),
+                ),
+                (
+                    "client_id",
+                    models.CharField(
+                        help_text="Value provided by LTI 1.3 Platform", max_length=255
+                    ),
+                ),
+                (
+                    "use_by_default",
+                    models.BooleanField(
+                        default=False,
+                        help_text="This iss config will be used in case "
+                        "if client-id was not passed",
+                    ),
+                ),
+                (
+                    "auth_login_url",
+                    models.CharField(
+                        help_text="The platform's OIDC login endpoint. "
+                        "Value provided by LTI 1.3 Platform",
+                        max_length=1024,
+                        validators=[django.core.validators.URLValidator()],
+                    ),
+                ),
+                (
+                    "auth_token_url",
+                    models.CharField(
+                        help_text="The platform's service authorization endpoint. "
+                        "Value provided by LTI 1.3 Platform",
+                        max_length=1024,
+                        validators=[django.core.validators.URLValidator()],
+                    ),
+                ),
+                (
+                    "auth_audience",
+                    models.CharField(
+                        blank=True,
+                        help_text="The platform's OAuth2 Audience (aud). "
+                        "Usually could be skipped",
+                        max_length=1024,
+                        null=True,
+                    ),
+                ),
+                (
+                    "key_set_url",
+                    models.CharField(
+                        blank=True,
+                        help_text="The platform's JWKS endpoint. "
+                        "Value provided by LTI 1.3 Platform",
+                        max_length=1024,
+                        null=True,
+                        validators=[django.core.validators.URLValidator()],
+                    ),
+                ),
+                (
+                    "key_set",
+                    models.TextField(
+                        blank=True,
+                        help_text="In case if platform's JWKS endpoint somehow "
+                        "unavailable you may paste JWKS here. Value "
+                        "provided by LTI 1.3 Platform",
+                        null=True,
+                    ),
+                ),
+                (
+                    "deployment_ids",
+                    models.TextField(
+                        help_text="List of Deployment IDs. Example: "
+                        '["test-id-1", "test-id-2", ...] Each value '
+                        "is provided by LTI 1.3 Platform. "
+                    ),
+                ),
+                (
+                    "tool_key",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="lti_tools",
+                        to="lti1p3_tool_config.LtiToolKey",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "lti 1.3 tool",
+                "verbose_name_plural": "lti 1.3 tools",
+                "db_table": "lti1p3_tool",
+                "unique_together": {("issuer", "client_id")},
+            },
+        ),
+    ]

ltitoolkit/core/contrib/django/lti1p3_tool_config/models.py

@@ -0,0 +1,185 @@
+# mypy: ignore-errors
+import json
+
+from django.core.exceptions import ValidationError
+from django.core.validators import URLValidator
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+from ltitoolkit.core.registration import Registration
+
+
+class LtiToolKey(models.Model):
+    name = models.CharField(
+        max_length=255, null=False, blank=False, unique=True, help_text=_("Key name")
+    )
+    private_key = models.TextField(
+        null=False,
+        blank=False,
+        help_text=_("Tool's generated Private key. Keep this value in secret"),
+    )
+    public_key = models.TextField(
+        null=True, blank=True, help_text=_("Tool's generated Public key")
+    )
+    public_jwk = models.TextField(
+        null=True,
+        blank=True,
+        help_text=_(
+            "Tool's generated Public key (from the field above) presented as JWK."
+        ),
+    )
+
+    def save(
+        self, *args, **kwargs
+    ):  # pylint: disable=arguments-differ,signature-differs
+        if self.public_key:
+            public_jwk_dict = Registration.get_jwk(self.public_key)
+            self.public_jwk = json.dumps(public_jwk_dict)
+        else:
+            self.public_key = None
+            self.public_jwk = None
+        super().save(*args, **kwargs)
+
+    def __str__(self):
+        # pylint: disable=no-member
+        return f"<LtiToolKey id={self.id}, name={self.name}>"
+
+    class Meta:
+        db_table = "lti1p3_tool_key"
+        verbose_name = "lti 1.3 tool key"
+        verbose_name_plural = "lti 1.3 tool keys"
+
+
+class LtiTool(models.Model):
+    title = models.CharField(max_length=255)
+    is_active = models.BooleanField(default=True)
+    issuer = models.CharField(
+        max_length=255,
+        help_text=_(
+            "This will usually look something like 'http://example.com'. "
+            "Value provided by LTI 1.3 Platform"
+        ),
+    )
+    client_id = models.CharField(
+        max_length=255,
+        null=False,
+        blank=False,
+        help_text=_("Value provided by LTI 1.3 Platform"),
+    )
+    use_by_default = models.BooleanField(
+        default=False,
+        help_text=_("This iss config will be used in case if client-id was not passed"),
+    )
+    auth_login_url = models.CharField(
+        max_length=1024,
+        null=False,
+        blank=False,
+        help_text=_(
+            "The platform's OIDC login endpoint. Value provided by LTI 1.3 Platform"
+        ),
+        validators=[URLValidator()],
+    )
+    auth_token_url = models.CharField(
+        max_length=1024,
+        null=False,
+        blank=False,
+        help_text=_(
+            "The platform's service authorization "
+            "endpoint. Value provided by "
+            "LTI 1.3 Platform"
+        ),
+        validators=[URLValidator()],
+    )
+    auth_audience = models.CharField(
+        max_length=1024,
+        null=True,
+        blank=True,
+        help_text=_("The platform's OAuth2 Audience (aud). Usually could be skipped"),
+    )
+    key_set_url = models.CharField(
+        max_length=1024,
+        null=True,
+        blank=True,
+        help_text=_("The platform's JWKS endpoint. Value provided by LTI 1.3 Platform"),
+        validators=[URLValidator()],
+    )
+    key_set = models.TextField(
+        null=True,
+        blank=True,
+        help_text=_(
+            "In case if platform's JWKS endpoint somehow "
+            "unavailable you may paste JWKS here. "
+            "Value provided by LTI 1.3 Platform"
+        ),
+    )
+    tool_key = models.ForeignKey(
+        LtiToolKey, on_delete=models.PROTECT, related_name="lti_tools"
+    )
+    deployment_ids = models.TextField(
+        null=False,
+        blank=False,
+        help_text=_(
+            "List of Deployment IDs. "
+            'Example: ["test-id-1", "test-id-2", ...] '
+            "Each value is provided by LTI 1.3 Platform. "
+        ),
+    )
+
+    def clean(self):
+        if not self.key_set_url and not self.key_set:
+            raise ValidationError(
+                {
+                    "key_set_url": _(
+                        'Even one of "key_set_url" or "key_set" should be set'
+                    )
+                }
+            )
+
+        if self.key_set:
+            key_set_valid = False
+            try:
+                key_set_data = json.loads(self.key_set)
+                if isinstance(key_set_data, dict):
+                    key_set_valid = True
+            except ValueError:
+                pass
+            if not key_set_valid:
+                raise ValidationError({"key_set": _("Should be a dict")})
+
+        deployment_ids_valid = False
+        try:
+            deployment_ids_data = json.loads(self.deployment_ids)
+            if isinstance(deployment_ids_data, list):
+                deployment_ids_valid = True
+        except ValueError:
+            pass
+        if not deployment_ids_valid:
+            raise ValidationError(
+                {
+                    "deployment_ids": _(
+                        'Should be a list. Example: ["test-id-1", "test-id-2", ...]'
+                    )
+                }
+            )
+
+    def to_dict(self):
+        data = {
+            "issuer": self.issuer,
+            "client_id": self.client_id,
+            "auth_login_url": self.auth_login_url,
+            "auth_token_url": self.auth_token_url,
+            "auth_audience": self.auth_audience,
+            "key_set_url": self.key_set_url,
+            "key_set": json.loads(self.key_set) if self.key_set else None,
+            "deployment_ids": json.loads(self.deployment_ids)
+            if self.deployment_ids
+            else [],
+        }
+        return data
+
+    class Meta:
+        unique_together = [
+            ["issuer", "client_id"],
+        ]
+        db_table = "lti1p3_tool"
+        verbose_name = "lti 1.3 tool"
+        verbose_name_plural = "lti 1.3 tools"

ltitoolkit/core/contrib/django/message_launch.py

@@ -0,0 +1,39 @@
+from ltitoolkit.core.message_launch import MessageLaunch
+from ltitoolkit.core.request import Request
+from .cookie import DjangoCookieService
+from .request import DjangoRequest
+from .session import DjangoSessionService
+
+
+class DjangoMessageLaunch(MessageLaunch):
+    def __init__(
+        self,
+        request,
+        tool_config,
+        session_service=None,
+        cookie_service=None,
+        launch_data_storage=None,
+        requests_session=None,
+    ):
+        django_request = (
+            request
+            if isinstance(request, Request)
+            else DjangoRequest(request, post_only=True)
+        )
+        cookie_service = (
+            cookie_service if cookie_service else DjangoCookieService(django_request)
+        )
+        session_service = (
+            session_service if session_service else DjangoSessionService(request)
+        )
+        super().__init__(
+            django_request,
+            tool_config,
+            session_service,
+            cookie_service,
+            launch_data_storage,
+            requests_session,
+        )
+
+    def _get_request_param(self, key):
+        return self._request.get_param(key)

ltitoolkit/core/contrib/django/oidc_login.py

@@ -0,0 +1,41 @@
+from django.http import HttpResponse  # type: ignore
+from ltitoolkit.core.oidc_login import OIDCLogin
+from ltitoolkit.core.request import Request
+
+from .cookie import DjangoCookieService
+from .redirect import DjangoRedirect
+from .request import DjangoRequest
+from .session import DjangoSessionService
+
+
+class DjangoOIDCLogin(OIDCLogin):
+    def __init__(
+        self,
+        request,
+        tool_config,
+        session_service=None,
+        cookie_service=None,
+        launch_data_storage=None,
+    ):
+        django_request = (
+            request if isinstance(request, Request) else DjangoRequest(request)
+        )
+        cookie_service = (
+            cookie_service if cookie_service else DjangoCookieService(django_request)
+        )
+        session_service = (
+            session_service if session_service else DjangoSessionService(request)
+        )
+        super().__init__(
+            django_request,
+            tool_config,
+            session_service,
+            cookie_service,
+            launch_data_storage,
+        )
+
+    def get_redirect(self, url):
+        return DjangoRedirect(url, self._cookie_service)
+
+    def get_response(self, html):
+        return HttpResponse(html)

ltitoolkit/core/contrib/django/redirect.py

@@ -0,0 +1,34 @@
+from django.http import HttpResponse  # type: ignore
+from django.shortcuts import redirect  # type: ignore
+from ltitoolkit.core.redirect import Redirect
+
+
+class DjangoRedirect(Redirect):
+    _location = None
+    _cookie_service = None
+
+    def __init__(self, location, cookie_service=None):
+        super().__init__()
+        self._location = location
+        self._cookie_service = cookie_service
+
+    def do_redirect(self):
+        return self._process_response(redirect(self._location))
+
+    def do_js_redirect(self):
+        return self._process_response(
+            HttpResponse(
+                f'<script type="text/javascript">window.location="{self._location}";</script>'
+            )
+        )
+
+    def set_redirect_url(self, location):
+        self._location = location
+
+    def get_redirect_url(self):
+        return self._location
+
+    def _process_response(self, response):
+        if self._cookie_service:
+            self._cookie_service.update_response(response)
+        return response

ltitoolkit/core/contrib/django/request.py

@@ -0,0 +1,32 @@
+from ltitoolkit.core.request import Request
+
+
+class DjangoRequest(Request):
+    _request = None
+    _post_only = False
+    _default_params = None
+
+    @property
+    def session(self):
+        return self._request.session
+
+    def __init__(self, request, post_only=False, default_params=None):
+        self.set_request(request)
+        self._post_only = post_only
+        self._default_params = default_params if default_params else {}
+
+    def set_request(self, request):
+        self._request = request
+
+    def get_param(self, key):
+        if self._post_only:
+            return self._request.POST.get(key, self._default_params.get(key))
+        return self._request.GET.get(
+            key, self._request.POST.get(key, self._default_params.get(key))
+        )
+
+    def get_cookie(self, key):
+        return self._request.COOKIES.get(key)
+
+    def is_secure(self):
+        return self._request.is_secure()

ltitoolkit/core/contrib/django/session.py

@@ -0,0 +1,5 @@
+from ltitoolkit.core.session import SessionService
+
+
+class DjangoSessionService(SessionService):
+    pass

ltitoolkit/core/contrib/flask/__init__.py

@@ -0,0 +1,7 @@
+# flake8: noqa
+from .cookie import FlaskCookieService
+from .oidc_login import FlaskOIDCLogin
+from .message_launch import FlaskMessageLaunch
+from .request import FlaskRequest
+from .session import FlaskSessionService
+from .launch_data_storage.cache import FlaskCacheDataStorage

ltitoolkit/core/contrib/flask/cookie.py

@@ -0,0 +1,34 @@
+from ltitoolkit.core.cookie import CookieService
+
+
+class FlaskCookieService(CookieService):
+    _request = None
+    _cookie_data_to_set = None
+
+    def __init__(self, request):
+        self._request = request
+        self._cookie_data_to_set = {}
+
+    def _get_key(self, key):
+        return self._cookie_prefix + "-" + key
+
+    def get_cookie(self, name):
+        return self._request.get_cookie(self._get_key(name))
+
+    def set_cookie(self, name, value, exp=3600):
+        self._cookie_data_to_set[self._get_key(name)] = {"value": value, "exp": exp}
+
+    def update_response(self, response):
+        for key, cookie_data in self._cookie_data_to_set.items():
+            cookie_kwargs = dict(
+                key=key,
+                value=cookie_data["value"],
+                max_age=cookie_data["exp"],
+                secure=self._request.is_secure(),
+                path="/",
+                httponly=True,
+            )
+
+            if self._request.is_secure():
+                cookie_kwargs["samesite"] = "None"
+            response.set_cookie(**cookie_kwargs)

ltitoolkit/core/contrib/flask/launch_data_storage/cache.py

@@ -0,0 +1,9 @@
+from ltitoolkit.core.launch_data_storage.cache import CacheDataStorage
+
+
+class FlaskCacheDataStorage(CacheDataStorage):
+    _cache = None
+
+    def __init__(self, cache, **kwargs):
+        self._cache = cache
+        super().__init__(cache, **kwargs)

ltitoolkit/core/contrib/flask/message_launch.py

@@ -0,0 +1,32 @@
+from ltitoolkit.core.message_launch import MessageLaunch
+from .cookie import FlaskCookieService
+from .session import FlaskSessionService
+
+
+class FlaskMessageLaunch(MessageLaunch):
+    def __init__(
+        self,
+        request,
+        tool_config,
+        session_service=None,
+        cookie_service=None,
+        launch_data_storage=None,
+        requests_session=None,
+    ):
+        cookie_service = (
+            cookie_service if cookie_service else FlaskCookieService(request)
+        )
+        session_service = (
+            session_service if session_service else FlaskSessionService(request)
+        )
+        super().__init__(
+            request,
+            tool_config,
+            session_service,
+            cookie_service,
+            launch_data_storage,
+            requests_session,
+        )
+
+    def _get_request_param(self, key):
+        return self._request.get_param(key)

ltitoolkit/core/contrib/flask/oidc_login.py

@@ -0,0 +1,31 @@
+from flask import make_response  # type: ignore
+from ltitoolkit.core.oidc_login import OIDCLogin
+from .cookie import FlaskCookieService
+from .session import FlaskSessionService
+from .redirect import FlaskRedirect
+
+
+class FlaskOIDCLogin(OIDCLogin):
+    def __init__(
+        self,
+        request,
+        tool_config,
+        session_service=None,
+        cookie_service=None,
+        launch_data_storage=None,
+    ):
+        cookie_service = (
+            cookie_service if cookie_service else FlaskCookieService(request)
+        )
+        session_service = (
+            session_service if session_service else FlaskSessionService(request)
+        )
+        super().__init__(
+            request, tool_config, session_service, cookie_service, launch_data_storage
+        )
+
+    def get_redirect(self, url):
+        return FlaskRedirect(url, self._cookie_service)
+
+    def get_response(self, html):
+        return make_response(html)

ltitoolkit/core/contrib/flask/redirect.py

@@ -0,0 +1,34 @@
+from flask import make_response, redirect  # type: ignore
+
+from ltitoolkit.core.redirect import Redirect
+
+
+class FlaskRedirect(Redirect):
+    _location = None
+    _cookie_service = None
+
+    def __init__(self, location, cookie_service=None):
+        super().__init__()
+        self._location = location
+        self._cookie_service = cookie_service
+
+    def do_redirect(self):
+        return self._process_response(redirect(self._location))
+
+    def do_js_redirect(self):
+        return self._process_response(
+            make_response(
+                f'<script type="text/javascript">window.location="{self._location}";</script>'
+            )
+        )
+
+    def set_redirect_url(self, location):
+        self._location = location
+
+    def get_redirect_url(self):
+        return self._location
+
+    def _process_response(self, response):
+        if self._cookie_service:
+            self._cookie_service.update_response(response)
+        return response