edx-platform/common/djangoapps/third_party_auth/admin.py

"""
Admin site configuration for third party authentication
"""


from config_models.admin import KeyedConfigurationModelAdmin
from django import forms
from django.contrib import admin
from django.db import transaction
from django.urls import reverse
from django.utils.html import format_html
from django.utils.translation import gettext_lazy as _

from .models import (
    _PSA_OAUTH2_BACKENDS,
    _PSA_SAML_BACKENDS,
    LTIProviderConfig,
    OAuth2ProviderConfig,
    SAMLConfiguration,
    SAMLProviderConfig,
    SAMLProviderData
)
from .tasks import fetch_saml_metadata


class OAuth2ProviderConfigForm(forms.ModelForm):
    """ Django Admin form class for OAuth2ProviderConfig """
    backend_name = forms.ChoiceField(choices=((name, name) for name in _PSA_OAUTH2_BACKENDS))


class OAuth2ProviderConfigAdmin(KeyedConfigurationModelAdmin):
    """ Django Admin class for OAuth2ProviderConfig """
    form = OAuth2ProviderConfigForm

    def get_list_display(self, request):
        """ Don't show every single field in the admin change list """
        return (
            'name', 'enabled', 'slug', 'site', 'backend_name', 'secondary', 'skip_registration_form',
            'skip_email_verification', 'change_date', 'changed_by', 'edit_link',
        )

admin.site.register(OAuth2ProviderConfig, OAuth2ProviderConfigAdmin)


class SAMLProviderConfigForm(forms.ModelForm):
    """ Django Admin form class for SAMLProviderConfig """
    backend_name = forms.ChoiceField(choices=((name, name) for name in _PSA_SAML_BACKENDS))


class SAMLProviderConfigAdmin(KeyedConfigurationModelAdmin):
    """ Django Admin class for SAMLProviderConfig """
    form = SAMLProviderConfigForm

    def get_queryset(self, request):
        """
        Filter the queryset to exclude the archived records.
        """
        queryset = super().get_queryset(request).exclude(archived=True)
        return queryset

    def archive_provider_configuration(self, request, queryset):
        """
        Archived the selected provider configurations.
        """
        with transaction.atomic():
            for obj in queryset:
                self.model.objects.filter(pk=obj.pk).update(archived=True, enabled=False)
        self.message_user(request, _("Deleted the selected configuration(s)."))

    def get_list_display(self, request):
        """ Don't show every single field in the admin change list """
        return (
            'name_with_update_link', 'enabled', 'site', 'entity_id', 'metadata_source',
            'has_data', 'mode', 'saml_configuration', 'change_date', 'changed_by',
        )

    list_display_links = None

    def get_actions(self, request):
        """
        Get the actions.
        """
        actions = super().get_actions(request)
        action_delete = {
            'archive_provider_configuration': (
                SAMLProviderConfigAdmin.archive_provider_configuration,
                'archive_provider_configuration',
                _('Delete the selected configuration')
            )
        }
        actions.update(action_delete)
        return actions

    def name_with_update_link(self, instance):
        """
        Record name with link for the change view.
        """
        if not instance.is_active:
            return instance.name

        update_url = reverse(f'admin:{self.model._meta.app_label}_{self.model._meta.model_name}_add')
        update_url += f'?source={instance.pk}'
        return format_html('<a href="{}">{}</a>', update_url, instance.name)

    name_with_update_link.short_description = 'Name'

    def has_data(self, inst):
        """ Do we have cached metadata for this SAML provider? """
        if not inst.is_active:
            return None  # N/A
        records = SAMLProviderData.objects.filter(entity_id=inst.entity_id)
        for record in records:
            if record.is_valid():
                return True
        return False

    has_data.short_description = 'Metadata Ready'
    has_data.boolean = True

    def mode(self, inst):
        """ Indicate if debug_mode is enabled or not"""
        if inst.debug_mode:
            return format_html('<span style="color: red;">Debug</span>')
        return "Normal"

    def save_model(self, request, obj, form, change):
        """
        Post save: Queue an asynchronous metadata fetch to update SAMLProviderData.
        We only want to do this for manual edits done using the admin interface.

        Note: This only works if the celery worker and the app worker are using the
        same 'configuration' cache.
        """
        super().save_model(request, obj, form, change)
        fetch_saml_metadata.apply_async((), countdown=2)

admin.site.register(SAMLProviderConfig, SAMLProviderConfigAdmin)


class SAMLConfigurationAdmin(KeyedConfigurationModelAdmin):
    """ Django Admin class for SAMLConfiguration """
    def get_list_display(self, request):
        """ Shorten the public/private keys in the change view """
        return (
            'site', 'slug', 'change_date', 'changed_by', 'enabled', 'entity_id',
            'org_info_str', 'key_summary', 'edit_link',
        )

    def key_summary(self, inst):
        """ Short summary of the key pairs configured """
        public_key = inst.get_setting('SP_PUBLIC_CERT')
        private_key = inst.get_setting('SP_PRIVATE_KEY')
        if not public_key or not private_key:
            return format_html('<em>Key pair incomplete/missing</em>')
        pub1, pub2 = public_key[0:10], public_key[-10:]
        priv1, priv2 = private_key[0:10], private_key[-10:]
        return format_html('Public: {}…{}<br>Private: {}…{}', pub1, pub2, priv1, priv2)

admin.site.register(SAMLConfiguration, SAMLConfigurationAdmin)


class SAMLProviderDataAdmin(admin.ModelAdmin):
    """ Django Admin class for SAMLProviderData (Read Only) """
    list_display = ('entity_id', 'is_valid', 'fetched_at', 'expires_at', 'sso_url')
    readonly_fields = ('is_valid', )

    def get_readonly_fields(self, request, obj=None):
        if obj:  # editing an existing object
            return [field.name for field in self.model._meta.get_fields()]
        return self.readonly_fields


admin.site.register(SAMLProviderData, SAMLProviderDataAdmin)


class LTIProviderConfigAdmin(KeyedConfigurationModelAdmin):
    """ Django Admin class for LTIProviderConfig """

    exclude = (
        'icon_class',
        'icon_image',
        'secondary',
    )

    def get_list_display(self, request):
        """ Don't show every single field in the admin change list """
        return (
            'name',
            'enabled',
            'site',
            'lti_consumer_key',
            'lti_max_timestamp_age',
            'change_date',
            'changed_by',
            'edit_link',
        )

admin.site.register(LTIProviderConfig, LTIProviderConfigAdmin)