Module supertokens_python.recipe.multitenancy.recipe
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 os import environ
from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union
from supertokens_python.exceptions import SuperTokensError, raise_general_exception
from supertokens_python.recipe.session.claim_base_classes.primitive_array_claim import (
PrimitiveArrayClaim,
)
from supertokens_python.recipe_module import APIHandled, RecipeModule
from ...post_init_callbacks import PostSTInitCallbacks
from .interfaces import (
APIOptions,
TypeGetAllowedDomainsForTenantId,
)
from .recipe_implementation import RecipeImplementation
if TYPE_CHECKING:
from supertokens_python.framework.request import BaseRequest
from supertokens_python.framework.response import BaseResponse
from supertokens_python.supertokens import AppInfo
from supertokens_python.recipe.thirdparty.provider import ProviderInput
from supertokens_python.normalised_url_path import NormalisedURLPath
from supertokens_python.querier import Querier
from supertokens_python.recipe.multitenancy.api.implementation import APIImplementation
from .api import handle_login_methods_api
from .constants import LOGIN_METHODS
from .exceptions import MultitenancyError
from .utils import (
InputOverrideConfig,
validate_and_normalise_user_input,
)
class MultitenancyRecipe(RecipeModule):
recipe_id = "multitenancy"
__instance = None
def __init__(
self,
recipe_id: str,
app_info: AppInfo,
get_allowed_domains_for_tenant_id: Optional[
TypeGetAllowedDomainsForTenantId
] = None,
override: Union[InputOverrideConfig, None] = None,
) -> None:
super().__init__(recipe_id, app_info)
self.config = validate_and_normalise_user_input(
get_allowed_domains_for_tenant_id,
override,
)
recipe_implementation = RecipeImplementation(
Querier.get_instance(recipe_id), self.config
)
self.recipe_implementation = (
recipe_implementation
if self.config.override.functions is None
else self.config.override.functions(recipe_implementation)
)
api_implementation = APIImplementation()
self.api_implementation = (
api_implementation
if self.config.override.apis is None
else self.config.override.apis(api_implementation)
)
self.static_third_party_providers: List[ProviderInput] = []
self.get_allowed_domains_for_tenant_id = (
self.config.get_allowed_domains_for_tenant_id
)
RecipeModule.get_tenant_id = recipe_implementation.get_tenant_id
def is_error_from_this_recipe_based_on_instance(self, err: Exception) -> bool:
return isinstance(err, MultitenancyError)
def get_apis_handled(self) -> List[APIHandled]:
return [
APIHandled(
NormalisedURLPath(LOGIN_METHODS),
"get",
LOGIN_METHODS,
self.api_implementation.disable_login_methods_get,
),
]
async def handle_api_request(
self,
request_id: str,
tenant_id: str,
request: BaseRequest,
path: NormalisedURLPath,
method: str,
response: BaseResponse,
user_context: Dict[str, Any],
) -> Union[BaseResponse, None]:
api_options = APIOptions(
request,
response,
self.recipe_id,
self.config,
self.recipe_implementation,
self.static_third_party_providers,
)
return await handle_login_methods_api(
self.api_implementation,
tenant_id,
api_options,
user_context,
)
async def handle_error(
self,
request: BaseRequest,
err: SuperTokensError,
response: BaseResponse,
user_context: Dict[str, Any],
) -> BaseResponse:
raise err
def get_all_cors_headers(self) -> List[str]:
return []
@staticmethod
def init(
get_allowed_domains_for_tenant_id: Union[
TypeGetAllowedDomainsForTenantId, None
] = None,
override: Union[InputOverrideConfig, None] = None,
):
def func(app_info: AppInfo):
if MultitenancyRecipe.__instance is None:
MultitenancyRecipe.__instance = MultitenancyRecipe(
MultitenancyRecipe.recipe_id,
app_info,
get_allowed_domains_for_tenant_id,
override,
)
def callback():
try:
from supertokens_python.recipe.session import SessionRecipe
SessionRecipe.get_instance().add_claim_from_other_recipe(
AllowedDomainsClaim
)
except Exception:
# Skip adding claims if session recipe is not initilised
pass
PostSTInitCallbacks.add_post_init_callback(callback)
return MultitenancyRecipe.__instance
raise_general_exception(
"Multitenancy recipe has already been initialised. Please check your code for bugs."
)
return func
@staticmethod
def get_instance() -> MultitenancyRecipe:
if MultitenancyRecipe.__instance is not None:
return MultitenancyRecipe.__instance
raise_general_exception(
"Initialisation not done. Did you forget to call the SuperTokens.init function?"
)
@staticmethod
def get_instance_optional() -> Optional[MultitenancyRecipe]:
return MultitenancyRecipe.__instance
@staticmethod
def reset():
if ("SUPERTOKENS_ENV" not in environ) or (
environ["SUPERTOKENS_ENV"] != "testing"
):
raise_general_exception("calling testing function in non testing env")
MultitenancyRecipe.__instance = None
class AllowedDomainsClaimClass(PrimitiveArrayClaim[List[str]]):
def __init__(self):
default_max_age_in_sec = 60 * 60
async def fetch_value(
_: str, tenant_id: str, user_context: Dict[str, Any]
) -> Optional[List[str]]:
recipe = MultitenancyRecipe.get_instance()
if recipe.get_allowed_domains_for_tenant_id is None:
# User did not provide a function to get allowed domains, but is using a validator. So we don't allow any domains by default
return None
return await recipe.get_allowed_domains_for_tenant_id(
tenant_id, user_context
)
super().__init__("st-t-dmns", fetch_value, default_max_age_in_sec)
AllowedDomainsClaim = AllowedDomainsClaimClass()
Classes
class AllowedDomainsClaimClass
-
Helper class that provides a standard way to create an ABC using inheritance.
Args
key
- The key to use when storing the claim in the payload.
fetch_value
- a method that fetches the current value of this claim for the user. A None return value signifies that we don't want to update the claim payload and or the claim value is not present in the database. For example, this can happen with a second factor auth claim, where we don't want to add the claim to the session automatically
Expand source code
class AllowedDomainsClaimClass(PrimitiveArrayClaim[List[str]]): def __init__(self): default_max_age_in_sec = 60 * 60 async def fetch_value( _: str, tenant_id: str, user_context: Dict[str, Any] ) -> Optional[List[str]]: recipe = MultitenancyRecipe.get_instance() if recipe.get_allowed_domains_for_tenant_id is None: # User did not provide a function to get allowed domains, but is using a validator. So we don't allow any domains by default return None return await recipe.get_allowed_domains_for_tenant_id( tenant_id, user_context ) super().__init__("st-t-dmns", fetch_value, default_max_age_in_sec)
Ancestors
- PrimitiveArrayClaim
- SessionClaim
- abc.ABC
- typing.Generic
Inherited members
class MultitenancyRecipe (recipe_id: str, app_info: AppInfo, get_allowed_domains_for_tenant_id: Optional[TypeGetAllowedDomainsForTenantId] = None, override: Union[InputOverrideConfig, None] = None)
-
Helper class that provides a standard way to create an ABC using inheritance.
Expand source code
class MultitenancyRecipe(RecipeModule): recipe_id = "multitenancy" __instance = None def __init__( self, recipe_id: str, app_info: AppInfo, get_allowed_domains_for_tenant_id: Optional[ TypeGetAllowedDomainsForTenantId ] = None, override: Union[InputOverrideConfig, None] = None, ) -> None: super().__init__(recipe_id, app_info) self.config = validate_and_normalise_user_input( get_allowed_domains_for_tenant_id, override, ) recipe_implementation = RecipeImplementation( Querier.get_instance(recipe_id), self.config ) self.recipe_implementation = ( recipe_implementation if self.config.override.functions is None else self.config.override.functions(recipe_implementation) ) api_implementation = APIImplementation() self.api_implementation = ( api_implementation if self.config.override.apis is None else self.config.override.apis(api_implementation) ) self.static_third_party_providers: List[ProviderInput] = [] self.get_allowed_domains_for_tenant_id = ( self.config.get_allowed_domains_for_tenant_id ) RecipeModule.get_tenant_id = recipe_implementation.get_tenant_id def is_error_from_this_recipe_based_on_instance(self, err: Exception) -> bool: return isinstance(err, MultitenancyError) def get_apis_handled(self) -> List[APIHandled]: return [ APIHandled( NormalisedURLPath(LOGIN_METHODS), "get", LOGIN_METHODS, self.api_implementation.disable_login_methods_get, ), ] async def handle_api_request( self, request_id: str, tenant_id: str, request: BaseRequest, path: NormalisedURLPath, method: str, response: BaseResponse, user_context: Dict[str, Any], ) -> Union[BaseResponse, None]: api_options = APIOptions( request, response, self.recipe_id, self.config, self.recipe_implementation, self.static_third_party_providers, ) return await handle_login_methods_api( self.api_implementation, tenant_id, api_options, user_context, ) async def handle_error( self, request: BaseRequest, err: SuperTokensError, response: BaseResponse, user_context: Dict[str, Any], ) -> BaseResponse: raise err def get_all_cors_headers(self) -> List[str]: return [] @staticmethod def init( get_allowed_domains_for_tenant_id: Union[ TypeGetAllowedDomainsForTenantId, None ] = None, override: Union[InputOverrideConfig, None] = None, ): def func(app_info: AppInfo): if MultitenancyRecipe.__instance is None: MultitenancyRecipe.__instance = MultitenancyRecipe( MultitenancyRecipe.recipe_id, app_info, get_allowed_domains_for_tenant_id, override, ) def callback(): try: from supertokens_python.recipe.session import SessionRecipe SessionRecipe.get_instance().add_claim_from_other_recipe( AllowedDomainsClaim ) except Exception: # Skip adding claims if session recipe is not initilised pass PostSTInitCallbacks.add_post_init_callback(callback) return MultitenancyRecipe.__instance raise_general_exception( "Multitenancy recipe has already been initialised. Please check your code for bugs." ) return func @staticmethod def get_instance() -> MultitenancyRecipe: if MultitenancyRecipe.__instance is not None: return MultitenancyRecipe.__instance raise_general_exception( "Initialisation not done. Did you forget to call the SuperTokens.init function?" ) @staticmethod def get_instance_optional() -> Optional[MultitenancyRecipe]: return MultitenancyRecipe.__instance @staticmethod def reset(): if ("SUPERTOKENS_ENV" not in environ) or ( environ["SUPERTOKENS_ENV"] != "testing" ): raise_general_exception("calling testing function in non testing env") MultitenancyRecipe.__instance = None
Ancestors
- RecipeModule
- abc.ABC
Class variables
var get_tenant_id : Optional[Callable[[str, Dict[str, Any]], Awaitable[str]]]
var recipe_id
Static methods
def get_instance() ‑> MultitenancyRecipe
-
Expand source code
@staticmethod def get_instance() -> MultitenancyRecipe: if MultitenancyRecipe.__instance is not None: return MultitenancyRecipe.__instance raise_general_exception( "Initialisation not done. Did you forget to call the SuperTokens.init function?" )
def get_instance_optional() ‑> Optional[MultitenancyRecipe]
-
Expand source code
@staticmethod def get_instance_optional() -> Optional[MultitenancyRecipe]: return MultitenancyRecipe.__instance
def init(get_allowed_domains_for_tenant_id: Union[TypeGetAllowedDomainsForTenantId, None] = None, override: Union[InputOverrideConfig, None] = None)
-
Expand source code
@staticmethod def init( get_allowed_domains_for_tenant_id: Union[ TypeGetAllowedDomainsForTenantId, None ] = None, override: Union[InputOverrideConfig, None] = None, ): def func(app_info: AppInfo): if MultitenancyRecipe.__instance is None: MultitenancyRecipe.__instance = MultitenancyRecipe( MultitenancyRecipe.recipe_id, app_info, get_allowed_domains_for_tenant_id, override, ) def callback(): try: from supertokens_python.recipe.session import SessionRecipe SessionRecipe.get_instance().add_claim_from_other_recipe( AllowedDomainsClaim ) except Exception: # Skip adding claims if session recipe is not initilised pass PostSTInitCallbacks.add_post_init_callback(callback) return MultitenancyRecipe.__instance raise_general_exception( "Multitenancy recipe has already been initialised. Please check your code for bugs." ) return func
def reset()
-
Expand source code
@staticmethod def reset(): if ("SUPERTOKENS_ENV" not in environ) or ( environ["SUPERTOKENS_ENV"] != "testing" ): raise_general_exception("calling testing function in non testing env") MultitenancyRecipe.__instance = None
Methods
def get_all_cors_headers(self) ‑> List[str]
-
Expand source code
def get_all_cors_headers(self) -> List[str]: return []
def get_apis_handled(self) ‑> List[APIHandled]
-
Expand source code
def get_apis_handled(self) -> List[APIHandled]: return [ APIHandled( NormalisedURLPath(LOGIN_METHODS), "get", LOGIN_METHODS, self.api_implementation.disable_login_methods_get, ), ]
async def handle_api_request(self, request_id: str, tenant_id: str, request: BaseRequest, path: NormalisedURLPath, method: str, response: BaseResponse, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
-
Expand source code
async def handle_api_request( self, request_id: str, tenant_id: str, request: BaseRequest, path: NormalisedURLPath, method: str, response: BaseResponse, user_context: Dict[str, Any], ) -> Union[BaseResponse, None]: api_options = APIOptions( request, response, self.recipe_id, self.config, self.recipe_implementation, self.static_third_party_providers, ) return await handle_login_methods_api( self.api_implementation, tenant_id, api_options, user_context, )
async def handle_error(self, request: BaseRequest, err: SuperTokensError, response: BaseResponse, user_context: Dict[str, Any]) ‑> BaseResponse
-
Expand source code
async def handle_error( self, request: BaseRequest, err: SuperTokensError, response: BaseResponse, user_context: Dict[str, Any], ) -> BaseResponse: raise err
def is_error_from_this_recipe_based_on_instance(self, err: Exception) ‑> bool
-
Expand source code
def is_error_from_this_recipe_based_on_instance(self, err: Exception) -> bool: return isinstance(err, MultitenancyError)