Module supertokens_python.recipe.openid.utils
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, Callable, Union
if TYPE_CHECKING:
from .interfaces import RecipeInterface, APIInterface
from supertokens_python import AppInfo
from supertokens_python.recipe.jwt import OverrideConfig as JWTOverrideConfig
from supertokens_python.normalised_url_domain import NormalisedURLDomain
from supertokens_python.normalised_url_path import NormalisedURLPath
class InputOverrideConfig:
def __init__(
self,
functions: Union[Callable[[RecipeInterface], RecipeInterface], None] = None,
apis: Union[Callable[[APIInterface], APIInterface], None] = None,
jwt_feature: Union[JWTOverrideConfig, None] = None,
):
self.functions = functions
self.apis = apis
self.jwt_feature = jwt_feature
class OverrideConfig:
def __init__(
self,
functions: Union[Callable[[RecipeInterface], RecipeInterface], None] = None,
apis: Union[Callable[[APIInterface], APIInterface], None] = None,
):
self.functions = functions
self.apis = apis
class OpenIdConfig:
def __init__(
self,
override: OverrideConfig,
issuer_domain: NormalisedURLDomain,
issuer_path: NormalisedURLPath,
):
self.override = override
self.issuer_domain = issuer_domain
self.issuer_path = issuer_path
def validate_and_normalise_user_input(
app_info: AppInfo,
issuer: Union[str, None] = None,
override: Union[InputOverrideConfig, None] = None,
):
if issuer is None:
issuer_domain = app_info.api_domain
issuer_path = app_info.api_base_path
else:
issuer_domain = NormalisedURLDomain(issuer)
issuer_path = NormalisedURLPath(issuer)
if not issuer_path.equals(app_info.api_base_path):
raise Exception(
"The path of the issuer URL must be equal to the apiBasePath. The default value is /auth"
)
if override is not None and not isinstance(override, InputOverrideConfig): # type: ignore
raise ValueError("override must be an instance of InputOverrideConfig or None")
if override is None:
override = InputOverrideConfig()
return OpenIdConfig(
OverrideConfig(functions=override.functions, apis=override.apis),
issuer_domain,
issuer_path,
)
Functions
def validate_and_normalise_user_input(app_info: AppInfo, issuer: Union[str, None] = None, override: Union[InputOverrideConfig, None] = None)
-
Expand source code
def validate_and_normalise_user_input( app_info: AppInfo, issuer: Union[str, None] = None, override: Union[InputOverrideConfig, None] = None, ): if issuer is None: issuer_domain = app_info.api_domain issuer_path = app_info.api_base_path else: issuer_domain = NormalisedURLDomain(issuer) issuer_path = NormalisedURLPath(issuer) if not issuer_path.equals(app_info.api_base_path): raise Exception( "The path of the issuer URL must be equal to the apiBasePath. The default value is /auth" ) if override is not None and not isinstance(override, InputOverrideConfig): # type: ignore raise ValueError("override must be an instance of InputOverrideConfig or None") if override is None: override = InputOverrideConfig() return OpenIdConfig( OverrideConfig(functions=override.functions, apis=override.apis), issuer_domain, issuer_path, )
Classes
class InputOverrideConfig (functions: Union[Callable[[RecipeInterface], RecipeInterface], None] = None, apis: Union[Callable[[APIInterface], APIInterface], None] = None, jwt_feature: Union[JWTOverrideConfig, None] = None)
-
Expand source code
class InputOverrideConfig: def __init__( self, functions: Union[Callable[[RecipeInterface], RecipeInterface], None] = None, apis: Union[Callable[[APIInterface], APIInterface], None] = None, jwt_feature: Union[JWTOverrideConfig, None] = None, ): self.functions = functions self.apis = apis self.jwt_feature = jwt_feature
class OpenIdConfig (override: OverrideConfig, issuer_domain: NormalisedURLDomain, issuer_path: NormalisedURLPath)
-
Expand source code
class OpenIdConfig: def __init__( self, override: OverrideConfig, issuer_domain: NormalisedURLDomain, issuer_path: NormalisedURLPath, ): self.override = override self.issuer_domain = issuer_domain self.issuer_path = issuer_path
class OverrideConfig (functions: Union[Callable[[RecipeInterface], RecipeInterface], None] = None, apis: Union[Callable[[APIInterface], APIInterface], None] = None)
-
Expand source code
class OverrideConfig: def __init__( self, functions: Union[Callable[[RecipeInterface], RecipeInterface], None] = None, apis: Union[Callable[[APIInterface], APIInterface], None] = None, ): self.functions = functions self.apis = apis