"""saml sp models""" from typing import Type from django.db import models from django.forms import ModelForm from django.http import HttpRequest from django.shortcuts import reverse from django.urls import reverse_lazy from django.utils.translation import gettext_lazy as _ from passbook.core.models import Source from passbook.core.types import UILoginButton from passbook.crypto.models import CertificateKeyPair from passbook.lib.utils.time import timedelta_string_validator from passbook.sources.saml.processors.constants import ( SAML_NAME_ID_FORMAT_EMAIL, SAML_NAME_ID_FORMAT_PERSISTENT, SAML_NAME_ID_FORMAT_TRANSIENT, SAML_NAME_ID_FORMAT_WINDOWS, SAML_NAME_ID_FORMAT_X509, ) class SAMLBindingTypes(models.TextChoices): """SAML Binding types""" Redirect = "REDIRECT", _("Redirect Binding") POST = "POST", _("POST Binding") POST_AUTO = "POST_AUTO", _("POST Binding with auto-confirmation") class SAMLNameIDPolicy(models.TextChoices): """SAML NameID Policies""" EMAIL = SAML_NAME_ID_FORMAT_EMAIL PERSISTENT = SAML_NAME_ID_FORMAT_PERSISTENT X509 = SAML_NAME_ID_FORMAT_X509 WINDOWS = SAML_NAME_ID_FORMAT_WINDOWS TRANSIENT = SAML_NAME_ID_FORMAT_TRANSIENT class SAMLSource(Source): """Authenticate using an external SAML Identity Provider.""" issuer = models.TextField( blank=True, default=None, verbose_name=_("Issuer"), help_text=_("Also known as Entity ID. Defaults the Metadata URL."), ) sso_url = models.URLField( verbose_name=_("SSO URL"), help_text=_("URL that the initial Login request is sent to."), ) slo_url = models.URLField( default=None, blank=True, null=True, verbose_name=_("SLO URL"), help_text=_("Optional URL if your IDP supports Single-Logout."), ) allow_idp_initiated = models.BooleanField( default=False, help_text=_( "Allows authentication flows initiated by the IdP. This can be a security risk, " "as no validation of the request ID is done." ), ) name_id_policy = models.TextField( choices=SAMLNameIDPolicy.choices, default=SAMLNameIDPolicy.TRANSIENT, help_text=_( "NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent." ), ) binding_type = models.CharField( max_length=100, choices=SAMLBindingTypes.choices, default=SAMLBindingTypes.Redirect, ) temporary_user_delete_after = models.TextField( default="days=1", verbose_name=_("Delete temporary users after"), validators=[timedelta_string_validator], help_text=_( ( "Time offset when temporary users should be deleted. This only applies if your IDP " "uses the NameID Format 'transient', and the user doesn't log out manually. " "(Format: hours=1;minutes=2;seconds=3)." ) ), ) signing_kp = models.ForeignKey( CertificateKeyPair, verbose_name=_("Singing Keypair"), help_text=_( "Certificate Key Pair of the IdP which Assertion's Signature is validated against." ), on_delete=models.PROTECT, ) @property def form(self) -> Type[ModelForm]: from passbook.sources.saml.forms import SAMLSourceForm return SAMLSourceForm def get_issuer(self, request: HttpRequest) -> str: """Get Source's Issuer, falling back to our Metadata URL if none is set""" if self.issuer is None: return self.build_full_url(request, view="metadata") return self.issuer def build_full_url(self, request: HttpRequest, view: str = "acs") -> str: """Build Full ACS URL to be used in IDP""" return request.build_absolute_uri( reverse(f"passbook_sources_saml:{view}", kwargs={"source_slug": self.slug}) ) @property def ui_login_button(self) -> UILoginButton: return UILoginButton( name=self.name, url=reverse_lazy( "passbook_sources_saml:login", kwargs={"source_slug": self.slug} ), icon_path="", ) @property def ui_additional_info(self) -> str: metadata_url = reverse_lazy( "passbook_sources_saml:metadata", kwargs={"source_slug": self.slug} ) return f'Metadata Download' def __str__(self): return f"SAML Source {self.name}" class Meta: verbose_name = _("SAML Source") verbose_name_plural = _("SAML Sources")