Module supertokens_python.recipe.jwt

Expand source code 
# Copyright (c) 2021, 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 TYPE_CHECKING, Union

from .recipe import JWTRecipe
from .utils import JWTOverrideConfig, OverrideConfig

if TYPE_CHECKING:
    from supertokens_python.supertokens import RecipeInit


def init(
    jwt_validity_seconds: Union[int, None] = None,
    override: Union[JWTOverrideConfig, None] = None,
) -> RecipeInit:
    return JWTRecipe.init(jwt_validity_seconds, override)


__all__ = [
    "JWTOverrideConfig",
    "JWTRecipe",
    "OverrideConfig",  # deprecated, use JWTOverrideConfig instead
    "init",
]

Sub-modules

supertokens_python.recipe.jwt.api
supertokens_python.recipe.jwt.asyncio
supertokens_python.recipe.jwt.constants
supertokens_python.recipe.jwt.exceptions
supertokens_python.recipe.jwt.interfaces
supertokens_python.recipe.jwt.recipe
supertokens_python.recipe.jwt.recipe_implementation
supertokens_python.recipe.jwt.syncio
supertokens_python.recipe.jwt.utils

Functions

def init(jwt_validity_seconds: Union[int, None] = None, override: Union[BaseOverrideConfig[RecipeInterface, APIInterface], None] = None)

Classes

class JWTOverrideConfig (**data: Any)

Base class for input override config 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.

Ancestors

Class variables

var model_config

The type of the None singleton.

class OverrideConfig (**data: Any)

Base class for input override config 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.

Ancestors

Inherited members

class JWTRecipe (recipe_id: str, app_info: AppInfo, config: JWTConfig)

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

Expand source code 
class JWTRecipe(RecipeModule):
    recipe_id = "jwt"
    __instance = None

    def __init__(
        self,
        recipe_id: str,
        app_info: AppInfo,
        config: JWTConfig,
    ):
        super().__init__(recipe_id, app_info)
        self.config = validate_and_normalise_user_input(config=config)

        recipe_implementation = RecipeImplementation(
            Querier.get_instance(recipe_id), self.config, app_info
        )
        self.recipe_implementation = self.config.override.functions(
            recipe_implementation
        )
        api_implementation = APIImplementation()
        self.api_implementation = self.config.override.apis(api_implementation)

    def get_apis_handled(self) -> List[APIHandled]:
        return [
            APIHandled(
                method="get",
                path_without_api_base_path=NormalisedURLPath(GET_JWKS_API),
                request_id=GET_JWKS_API,
                disabled=self.api_implementation.disable_jwks_get,
            )
        ]

    async def handle_api_request(
        self,
        request_id: str,
        tenant_id: Optional[str],
        request: BaseRequest,
        path: NormalisedURLPath,
        method: str,
        response: BaseResponse,
        user_context: Dict[str, Any],
    ):
        options = APIOptions(
            request,
            response,
            self.get_recipe_id(),
            self.config,
            self.recipe_implementation,
        )

        if request_id == GET_JWKS_API:
            return await jwks_get(self.api_implementation, options, user_context)

        return None

    async def handle_error(
        self,
        request: BaseRequest,
        err: SuperTokensError,
        response: BaseResponse,
        user_context: Dict[str, Any],
    ):
        raise err

    def get_all_cors_headers(self) -> List[str]:
        return []

    def is_error_from_this_recipe_based_on_instance(self, err: Exception) -> bool:
        return isinstance(err, SuperTokensError) and isinstance(
            err, SuperTokensJWTError
        )

    @staticmethod
    def init(
        jwt_validity_seconds: Union[int, None] = None,
        override: Union[JWTOverrideConfig, None] = None,
    ):
        from supertokens_python.plugins import OverrideMap, apply_plugins

        config = JWTConfig(
            jwt_validity_seconds=jwt_validity_seconds,
            override=override,
        )

        def func(app_info: AppInfo, plugins: List[OverrideMap]):
            if JWTRecipe.__instance is None:
                JWTRecipe.__instance = JWTRecipe(
                    JWTRecipe.recipe_id,
                    app_info,
                    config=apply_plugins(
                        recipe_id=JWTRecipe.recipe_id,
                        config=config,
                        plugins=plugins,
                    ),
                )
                return JWTRecipe.__instance
            raise_general_exception(
                "JWT recipe has already been initialised. Please check your code for bugs."
            )

        return func

    @staticmethod
    def get_instance() -> JWTRecipe:
        if JWTRecipe.__instance is not None:
            return JWTRecipe.__instance
        raise_general_exception(
            "Initialisation not done. Did you forget to call the SuperTokens.init function?"
        )

    @staticmethod
    def reset():
        if ("SUPERTOKENS_ENV" not in environ) or (
            environ["SUPERTOKENS_ENV"] != "testing"
        ):
            raise_general_exception("calling testing function in non testing env")
        JWTRecipe.__instance = None

Ancestors

Class variables

var recipe_id

The type of the None singleton.

Static methods

def get_instance() ‑> JWTRecipe
def init(jwt_validity_seconds: Union[int, None] = None, override: Union[BaseOverrideConfig[RecipeInterface, APIInterface], None] = None)
def reset()

Methods

def get_all_cors_headers(self) ‑> List[str]
def get_apis_handled(self) ‑> List[APIHandled]
async def handle_api_request(self, request_id: str, tenant_id: Optional[str], request: BaseRequest, path: NormalisedURLPath, method: str, response: BaseResponse, user_context: Dict[str, Any])
async def handle_error(self, request: BaseRequest, err: SuperTokensError, response: BaseResponse, user_context: Dict[str, Any])
def is_error_from_this_recipe_based_on_instance(self, err: Exception) ‑> bool

Inherited members