authentik.brands.models

  1"""brand models"""
  2
  3from uuid import uuid4
  4
  5from django.db import models
  6from django.http import HttpRequest
  7from django.utils.translation import gettext_lazy as _
  8from rest_framework.serializers import Serializer
  9from structlog.stdlib import get_logger
 10
 11from authentik.admin.files.fields import FileField
 12from authentik.admin.files.manager import get_file_manager
 13from authentik.admin.files.usage import FileUsage
 14from authentik.crypto.models import CertificateKeyPair
 15from authentik.flows.models import Flow
 16from authentik.lib.models import SerializerModel
 17
 18LOGGER = get_logger()
 19
 20
 21class Brand(SerializerModel):
 22    """Single brand"""
 23
 24    brand_uuid = models.UUIDField(primary_key=True, editable=False, default=uuid4)
 25    domain = models.TextField(
 26        help_text=_(
 27            "Domain that activates this brand. Can be a superset, i.e. `a.b` for `aa.b` and `ba.b`"
 28        )
 29    )
 30    default = models.BooleanField(
 31        default=False,
 32    )
 33
 34    branding_title = models.TextField(default="authentik")
 35
 36    branding_logo = FileField(default="/static/dist/assets/icons/icon_left_brand.svg")
 37    branding_favicon = FileField(default="/static/dist/assets/icons/icon.png")
 38    branding_custom_css = models.TextField(default="", blank=True)
 39    branding_default_flow_background = FileField(
 40        default="/static/dist/assets/images/flow_background.jpg",
 41    )
 42
 43    flow_authentication = models.ForeignKey(
 44        Flow, null=True, on_delete=models.SET_NULL, related_name="brand_authentication"
 45    )
 46    flow_invalidation = models.ForeignKey(
 47        Flow, null=True, on_delete=models.SET_NULL, related_name="brand_invalidation"
 48    )
 49    flow_recovery = models.ForeignKey(
 50        Flow, null=True, on_delete=models.SET_NULL, related_name="brand_recovery"
 51    )
 52    flow_unenrollment = models.ForeignKey(
 53        Flow, null=True, on_delete=models.SET_NULL, related_name="brand_unenrollment"
 54    )
 55    flow_user_settings = models.ForeignKey(
 56        Flow, null=True, on_delete=models.SET_NULL, related_name="brand_user_settings"
 57    )
 58    flow_device_code = models.ForeignKey(
 59        Flow, null=True, on_delete=models.SET_NULL, related_name="brand_device_code"
 60    )
 61
 62    default_application = models.ForeignKey(
 63        "authentik_core.Application",
 64        null=True,
 65        default=None,
 66        on_delete=models.SET_DEFAULT,
 67        help_text=_(
 68            "When set, external users will be redirected to this application after authenticating."
 69        ),
 70    )
 71
 72    web_certificate = models.ForeignKey(
 73        CertificateKeyPair,
 74        null=True,
 75        default=None,
 76        on_delete=models.SET_DEFAULT,
 77        help_text=_("Web Certificate used by the authentik Core webserver."),
 78        related_name="+",
 79    )
 80    client_certificates = models.ManyToManyField(
 81        CertificateKeyPair,
 82        default=None,
 83        blank=True,
 84        help_text=_("Certificates used for client authentication."),
 85    )
 86    attributes = models.JSONField(default=dict, blank=True)
 87
 88    def branding_logo_url(self) -> str:
 89        """Get branding_logo URL"""
 90        return get_file_manager(FileUsage.MEDIA).file_url(self.branding_logo)
 91
 92    def branding_logo_themed_urls(self) -> dict[str, str] | None:
 93        """Get themed URLs for branding_logo if it contains %(theme)s"""
 94        return get_file_manager(FileUsage.MEDIA).themed_urls(self.branding_logo)
 95
 96    def branding_favicon_url(self) -> str:
 97        """Get branding_favicon URL"""
 98        return get_file_manager(FileUsage.MEDIA).file_url(self.branding_favicon)
 99
100    def branding_favicon_themed_urls(self) -> dict[str, str] | None:
101        """Get themed URLs for branding_favicon if it contains %(theme)s"""
102        return get_file_manager(FileUsage.MEDIA).themed_urls(self.branding_favicon)
103
104    def branding_default_flow_background_url(self) -> str:
105        """Get branding_default_flow_background URL"""
106        return get_file_manager(FileUsage.MEDIA).file_url(self.branding_default_flow_background)
107
108    def branding_default_flow_background_themed_urls(self) -> dict[str, str] | None:
109        """Get themed URLs for branding_default_flow_background if it contains %(theme)s"""
110        return get_file_manager(FileUsage.MEDIA).themed_urls(self.branding_default_flow_background)
111
112    @property
113    def serializer(self) -> type[Serializer]:
114        from authentik.brands.api import BrandSerializer
115
116        return BrandSerializer
117
118    @property
119    def default_locale(self) -> str:
120        """Get default locale"""
121        try:
122            return self.attributes.get("settings", {}).get("locale", "")
123
124        except Exception as exc:  # noqa
125            LOGGER.warning("Failed to get default locale", exc=exc)
126            return ""
127
128    def __str__(self) -> str:
129        if self.default:
130            return "Default brand"
131        return f"Brand {self.domain}"
132
133    class Meta:
134        verbose_name = _("Brand")
135        verbose_name_plural = _("Brands")
136        indexes = [
137            models.Index(fields=["domain"]),
138            models.Index(fields=["default"]),
139        ]
140
141
142class WebfingerProvider(models.Model):
143    """Provider which supports webfinger discovery"""
144
145    class Meta:
146        abstract = True
147
148    def webfinger(self, resource: str, request: HttpRequest) -> dict:
149        raise NotImplementedError()