Module supertokens_python.recipe.webauthn.types.config

Expand source code 
# Copyright (c) 2025, VRAI Labs and/or its affiliates. All rights reserved.
#
# This software is licensed under the Apache License, Version 2.0 (the
# "License") as published by the Apache Software Foundation.
#
# You may not use this file except in compliance with the License. You may
# obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.

from __future__ import annotations

from typing import Optional, Protocol, TypeVar, Union, runtime_checkable

from supertokens_python.framework import BaseRequest
from supertokens_python.ingredients.emaildelivery import EmailDeliveryIngredient
from supertokens_python.ingredients.emaildelivery.types import (
    EmailDeliveryConfig,
    EmailDeliveryConfigWithService,
)
from supertokens_python.recipe.webauthn.interfaces.api import (
    APIInterface,
    TypeWebauthnEmailDeliveryInput,
)
from supertokens_python.recipe.webauthn.interfaces.recipe import RecipeInterface
from supertokens_python.types.base import UserContext
from supertokens_python.types.config import (
    BaseConfig,
    BaseNormalisedConfig,
    BaseNormalisedOverrideConfig,
    BaseOverrideableConfig,
    BaseOverrideConfig,
)
from supertokens_python.types.response import CamelCaseBaseModel

InterfaceType = TypeVar("InterfaceType")
"""Generic Type for use in `InterfaceOverride`"""


@runtime_checkable
class GetRelyingPartyId(Protocol):
    """
    Callable signature for `WebauthnConfig.get_relying_party_id`.
    """

    async def __call__(
        self,
        *,
        tenant_id: str,
        request: Optional[BaseRequest],
        user_context: UserContext,
    ) -> str: ...


@runtime_checkable
class NormalisedGetRelyingPartyId(Protocol):
    """
    Callable signature for `WebauthnNormalisedConfig.get_relying_party_id`.
    """

    async def __call__(
        self,
        *,
        tenant_id: str,
        request: Optional[BaseRequest],
        user_context: UserContext,
    ) -> str: ...


@runtime_checkable
class GetRelyingPartyName(Protocol):
    """
    Callable signature for `WebauthnConfig.get_relying_party_name`.
    """

    async def __call__(
        self,
        *,
        tenant_id: str,
        user_context: UserContext,
    ) -> str: ...


@runtime_checkable
class NormalisedGetRelyingPartyName(Protocol):
    """
    Callable signature for `WebauthnNormalisedConfig.get_relying_party_name`.
    """

    async def __call__(
        self,
        *,
        tenant_id: str,
        request: Optional[BaseRequest],
        user_context: UserContext,
    ) -> str: ...


@runtime_checkable
class GetOrigin(Protocol):
    """
    Callable signature for `WebauthnConfig.get_origin`.
    """

    async def __call__(
        self,
        *,
        tenant_id: str,
        request: Optional[BaseRequest],
        user_context: UserContext,
    ) -> str: ...


@runtime_checkable
class NormalisedGetOrigin(Protocol):
    """
    Callable signature for `WebauthnNormalisedConfig.get_origin`.
    """

    async def __call__(
        self,
        *,
        tenant_id: str,
        request: Optional[BaseRequest],
        user_context: UserContext,
    ) -> str: ...


@runtime_checkable
class GetEmailDeliveryConfig(Protocol):
    """
    Callable signature for `WebauthnNormalisedConfig.get_email_delivery_config`.
    """

    async def __call__(self) -> EmailDeliveryConfig[TypeWebauthnEmailDeliveryInput]: ...


@runtime_checkable
class NormalisedGetEmailDeliveryConfig(Protocol):
    """
    Callable signature for `WebauthnNormalisedConfig.get_email_delivery_config`.
    """

    def __call__(
        self,
    ) -> EmailDeliveryConfigWithService[TypeWebauthnEmailDeliveryInput]: ...


@runtime_checkable
class ValidateEmailAddress(Protocol):
    """
    Callable signature for `WebauthnConfig.validate_email_address`.
    """

    async def __call__(
        self, *, email: str, tenant_id: str, user_context: UserContext
    ) -> Optional[str]: ...


@runtime_checkable
class NormalisedValidateEmailAddress(Protocol):
    """
    Callable signature for `WebauthnNormalisedConfig.validate_email_address`.
    """

    async def __call__(
        self, *, email: str, tenant_id: str, user_context: UserContext
    ) -> Optional[str]: ...


@runtime_checkable
class InterfaceOverride(Protocol[InterfaceType]):
    """
    Callable signature for `WebauthnConfig.override.*`.
    """

    def __call__(
        self,
        original_implementation: InterfaceType,
    ) -> InterfaceType: ...


WebauthnOverrideConfig = BaseOverrideConfig[RecipeInterface, APIInterface]
NormalisedWebauthnOverrideConfig = BaseNormalisedOverrideConfig[
    RecipeInterface, APIInterface
]


class WebauthnOverrideableConfig(BaseOverrideableConfig):
    """Input config properties overrideable using the plugin config overrides"""

    get_relying_party_id: Optional[Union[str, GetRelyingPartyId]] = None
    get_relying_party_name: Optional[Union[str, GetRelyingPartyName]] = None
    get_origin: Optional[GetOrigin] = None
    email_delivery: Optional[EmailDeliveryConfig[TypeWebauthnEmailDeliveryInput]] = None
    validate_email_address: Optional[ValidateEmailAddress] = None


class WebauthnConfig(
    WebauthnOverrideableConfig,
    BaseConfig[RecipeInterface, APIInterface, WebauthnOverrideableConfig],
):
    def to_overrideable_config(self) -> WebauthnOverrideableConfig:
        """Create a `WebauthnOverrideableConfig` from the current config."""
        return WebauthnOverrideableConfig(**self.model_dump())

    def from_overrideable_config(
        self,
        overrideable_config: WebauthnOverrideableConfig,
    ) -> "WebauthnConfig":
        """
        Create a `WebauthnConfig` from a `WebauthnOverrideableConfig`.
        Not a classmethod since it needs to be used in a dynamic context within plugins.
        """
        return WebauthnConfig(
            **overrideable_config.model_dump(),
            override=self.override,
        )


class NormalisedWebauthnConfig(BaseNormalisedConfig[RecipeInterface, APIInterface]):
    get_relying_party_id: NormalisedGetRelyingPartyId
    get_relying_party_name: NormalisedGetRelyingPartyName
    get_origin: NormalisedGetOrigin
    get_email_delivery_config: NormalisedGetEmailDeliveryConfig
    validate_email_address: NormalisedValidateEmailAddress


class WebauthnIngredients(CamelCaseBaseModel):
    email_delivery: Optional[
        EmailDeliveryIngredient[TypeWebauthnEmailDeliveryInput]
    ] = None

Global variables

var InterfaceType

Generic Type for use in InterfaceOverride

Classes

class GetEmailDeliveryConfig (*args, **kwargs)

Callable signature for WebauthnNormalisedConfig.get_email_delivery_config.

Expand source code 
@runtime_checkable
class GetEmailDeliveryConfig(Protocol):
    """
    Callable signature for `WebauthnNormalisedConfig.get_email_delivery_config`.
    """

    async def __call__(self) -> EmailDeliveryConfig[TypeWebauthnEmailDeliveryInput]: ...

Ancestors

  • typing.Protocol
  • typing.Generic
class GetOrigin (*args, **kwargs)

Callable signature for WebauthnConfig.get_origin.

Expand source code 
@runtime_checkable
class GetOrigin(Protocol):
    """
    Callable signature for `WebauthnConfig.get_origin`.
    """

    async def __call__(
        self,
        *,
        tenant_id: str,
        request: Optional[BaseRequest],
        user_context: UserContext,
    ) -> str: ...

Ancestors

  • typing.Protocol
  • typing.Generic
class GetRelyingPartyId (*args, **kwargs)

Callable signature for WebauthnConfig.get_relying_party_id.

Expand source code 
@runtime_checkable
class GetRelyingPartyId(Protocol):
    """
    Callable signature for `WebauthnConfig.get_relying_party_id`.
    """

    async def __call__(
        self,
        *,
        tenant_id: str,
        request: Optional[BaseRequest],
        user_context: UserContext,
    ) -> str: ...

Ancestors

  • typing.Protocol
  • typing.Generic
class GetRelyingPartyName (*args, **kwargs)

Callable signature for WebauthnConfig.get_relying_party_name.

Expand source code 
@runtime_checkable
class GetRelyingPartyName(Protocol):
    """
    Callable signature for `WebauthnConfig.get_relying_party_name`.
    """

    async def __call__(
        self,
        *,
        tenant_id: str,
        user_context: UserContext,
    ) -> str: ...

Ancestors

  • typing.Protocol
  • typing.Generic
class InterfaceOverride (*args, **kwargs)

Callable signature for WebauthnConfig.override.*.

Expand source code 
@runtime_checkable
class InterfaceOverride(Protocol[InterfaceType]):
    """
    Callable signature for `WebauthnConfig.override.*`.
    """

    def __call__(
        self,
        original_implementation: InterfaceType,
    ) -> InterfaceType: ...

Ancestors

  • typing.Protocol
  • typing.Generic
class NormalisedGetEmailDeliveryConfig (*args, **kwargs)

Callable signature for WebauthnNormalisedConfig.get_email_delivery_config.

Expand source code 
@runtime_checkable
class NormalisedGetEmailDeliveryConfig(Protocol):
    """
    Callable signature for `WebauthnNormalisedConfig.get_email_delivery_config`.
    """

    def __call__(
        self,
    ) -> EmailDeliveryConfigWithService[TypeWebauthnEmailDeliveryInput]: ...

Ancestors

  • typing.Protocol
  • typing.Generic
class NormalisedGetOrigin (*args, **kwargs)

Callable signature for WebauthnNormalisedConfig.get_origin.

Expand source code 
@runtime_checkable
class NormalisedGetOrigin(Protocol):
    """
    Callable signature for `WebauthnNormalisedConfig.get_origin`.
    """

    async def __call__(
        self,
        *,
        tenant_id: str,
        request: Optional[BaseRequest],
        user_context: UserContext,
    ) -> str: ...

Ancestors

  • typing.Protocol
  • typing.Generic
class NormalisedGetRelyingPartyId (*args, **kwargs)

Callable signature for WebauthnNormalisedConfig.get_relying_party_id.

Expand source code 
@runtime_checkable
class NormalisedGetRelyingPartyId(Protocol):
    """
    Callable signature for `WebauthnNormalisedConfig.get_relying_party_id`.
    """

    async def __call__(
        self,
        *,
        tenant_id: str,
        request: Optional[BaseRequest],
        user_context: UserContext,
    ) -> str: ...

Ancestors

  • typing.Protocol
  • typing.Generic
class NormalisedGetRelyingPartyName (*args, **kwargs)

Callable signature for WebauthnNormalisedConfig.get_relying_party_name.

Expand source code 
@runtime_checkable
class NormalisedGetRelyingPartyName(Protocol):
    """
    Callable signature for `WebauthnNormalisedConfig.get_relying_party_name`.
    """

    async def __call__(
        self,
        *,
        tenant_id: str,
        request: Optional[BaseRequest],
        user_context: UserContext,
    ) -> str: ...

Ancestors

  • typing.Protocol
  • typing.Generic
class NormalisedValidateEmailAddress (*args, **kwargs)

Callable signature for WebauthnNormalisedConfig.validate_email_address.

Expand source code 
@runtime_checkable
class NormalisedValidateEmailAddress(Protocol):
    """
    Callable signature for `WebauthnNormalisedConfig.validate_email_address`.
    """

    async def __call__(
        self, *, email: str, tenant_id: str, user_context: UserContext
    ) -> Optional[str]: ...

Ancestors

  • typing.Protocol
  • typing.Generic
class NormalisedWebauthnConfig (**data: Any)

Base class for normalized config of a Recipe with API overrides.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code 
class NormalisedWebauthnConfig(BaseNormalisedConfig[RecipeInterface, APIInterface]):
    get_relying_party_id: NormalisedGetRelyingPartyId
    get_relying_party_name: NormalisedGetRelyingPartyName
    get_origin: NormalisedGetOrigin
    get_email_delivery_config: NormalisedGetEmailDeliveryConfig
    validate_email_address: NormalisedValidateEmailAddress

Ancestors

Class variables

var get_email_delivery_config : NormalisedGetEmailDeliveryConfig

The type of the None singleton.

var get_origin : NormalisedGetOrigin

The type of the None singleton.

var get_relying_party_id : NormalisedGetRelyingPartyId

The type of the None singleton.

var get_relying_party_name : NormalisedGetRelyingPartyName

The type of the None singleton.

var validate_email_address : NormalisedValidateEmailAddress

The type of the None singleton.

Inherited members

class ValidateEmailAddress (*args, **kwargs)

Callable signature for WebauthnConfig.validate_email_address.

Expand source code 
@runtime_checkable
class ValidateEmailAddress(Protocol):
    """
    Callable signature for `WebauthnConfig.validate_email_address`.
    """

    async def __call__(
        self, *, email: str, tenant_id: str, user_context: UserContext
    ) -> Optional[str]: ...

Ancestors

  • typing.Protocol
  • typing.Generic
class WebauthnConfig (**data: Any)

Input config properties overrideable using the plugin config overrides

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code 
class WebauthnConfig(
    WebauthnOverrideableConfig,
    BaseConfig[RecipeInterface, APIInterface, WebauthnOverrideableConfig],
):
    def to_overrideable_config(self) -> WebauthnOverrideableConfig:
        """Create a `WebauthnOverrideableConfig` from the current config."""
        return WebauthnOverrideableConfig(**self.model_dump())

    def from_overrideable_config(
        self,
        overrideable_config: WebauthnOverrideableConfig,
    ) -> "WebauthnConfig":
        """
        Create a `WebauthnConfig` from a `WebauthnOverrideableConfig`.
        Not a classmethod since it needs to be used in a dynamic context within plugins.
        """
        return WebauthnConfig(
            **overrideable_config.model_dump(),
            override=self.override,
        )

Ancestors

Methods

def from_overrideable_config(self, overrideable_config: WebauthnOverrideableConfig) ‑> WebauthnConfig

Create a WebauthnConfig from a WebauthnOverrideableConfig. Not a classmethod since it needs to be used in a dynamic context within plugins.

def to_overrideable_config(self) ‑> WebauthnOverrideableConfig

Create a WebauthnOverrideableConfig from the current config.

Inherited members

class WebauthnIngredients (**data: Any)

Helper class that provides a standard way to create an ABC using inheritance.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code 
class WebauthnIngredients(CamelCaseBaseModel):
    email_delivery: Optional[
        EmailDeliveryIngredient[TypeWebauthnEmailDeliveryInput]
    ] = None

Ancestors

Class variables

var email_delivery : Optional[EmailDeliveryIngredient[TypeWebauthnRecoverAccountEmailDeliveryInput]]

The type of the None singleton.

Inherited members

class WebauthnOverrideableConfig (**data: Any)

Input config properties overrideable using the plugin config overrides

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code 
class WebauthnOverrideableConfig(BaseOverrideableConfig):
    """Input config properties overrideable using the plugin config overrides"""

    get_relying_party_id: Optional[Union[str, GetRelyingPartyId]] = None
    get_relying_party_name: Optional[Union[str, GetRelyingPartyName]] = None
    get_origin: Optional[GetOrigin] = None
    email_delivery: Optional[EmailDeliveryConfig[TypeWebauthnEmailDeliveryInput]] = None
    validate_email_address: Optional[ValidateEmailAddress] = None

Ancestors

Subclasses

Class variables

var email_delivery : Optional[EmailDeliveryConfig[TypeWebauthnRecoverAccountEmailDeliveryInput]]

The type of the None singleton.

var get_origin : Optional[GetOrigin]

The type of the None singleton.

var get_relying_party_id : Union[str, GetRelyingPartyId, ForwardRef(None)]

The type of the None singleton.

var get_relying_party_name : Union[str, GetRelyingPartyName, ForwardRef(None)]

The type of the None singleton.

var validate_email_address : Optional[ValidateEmailAddress]

The type of the None singleton.

Inherited members