added functions and updateed interface for email-pasword-login

Author: iresharma

supertokens_python/recipe/dashboard/api/__init__.py

@@ -13,10 +13,13 @@
 # under the License.
 from .api_key_protector import api_key_protector
 from .dashboard import handle_dashboard_api
+from .signin import handle_sign_in_api
+from .signout import handle_signout
 from .userdetails.user_delete import handle_user_delete
 from .userdetails.user_email_verify_get import handle_user_email_verify_get
 from .userdetails.user_email_verify_put import handle_user_email_verify_put
-from .userdetails.user_email_verify_token_post import handle_email_verify_token_post
+from .userdetails.user_email_verify_token_post import \
+    handle_email_verify_token_post
 from .userdetails.user_get import handle_user_get
 from .userdetails.user_metadata_get import handle_metadata_get
 from .userdetails.user_metadata_put import handle_metadata_put
@@ -45,4 +48,6 @@
     "handle_user_sessions_post",
     "handle_user_password_put",
     "handle_email_verify_token_post",
+    "handle_sign_in_api",
+    "handle_signout"
 ]

supertokens_python/recipe/dashboard/api/signin.py

@@ -0,0 +1,24 @@
+# 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
+
+if TYPE_CHECKING:
+    from supertokens_python.recipe.dashboard.interfaces import (APIInterface,
+                                                                APIOptions)
+
+
+async def handle_sign_in_api(api_implementation: APIInterface, api_options: APIOptions):
+    pass

supertokens_python/recipe/dashboard/api/signout.py

@@ -0,0 +1,26 @@
+# 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
+
+if TYPE_CHECKING:
+    from supertokens_python.recipe.dashboard.interfaces import (APIInterface,
+                                                                APIOptions)
+
+from ..interfaces import SignOutOK
+
+
+async def handle_signout(api_implementation: APIInterface, api_options: APIOptions) -> SignOutOK:
+    pass

supertokens_python/recipe/dashboard/constants.py

@@ -8,3 +8,5 @@
 USER_SESSION_API = "/api/user/sessions"
 USER_PASSWORD_API = "/api/user/password"
 USER_EMAIL_VERIFY_TOKEN_API = "/api/user/email/verify/token"
+EMAIL_PASSWORD_SIGN_IN = "/api/signin"
+EMAIL_PASSSWORD_SIGNOUT = "/api/signout"

supertokens_python/recipe/dashboard/interfaces.py

@@ -14,9 +14,11 @@
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
-from typing import TYPE_CHECKING, Any, Awaitable, Callable, Dict, List, Optional, Union
+from typing import (TYPE_CHECKING, Any, Awaitable, Callable, Dict, List,
+                    Optional, Union)
 
-from supertokens_python.recipe.session.interfaces import SessionInformationResult
+from supertokens_python.recipe.session.interfaces import \
+    SessionInformationResult
 from supertokens_python.types import User
 
 from ...supertokens import AppInfo
@@ -285,3 +287,7 @@ def __init__(self, error: str) -> None:
 
     def to_json(self) -> Dict[str, Any]:
         return {"status": self.status, "error": self.error}
+
+class SignOutOK(APIResponse):
+    def to_json(self):
+        return {"status": "OK"}

supertokens_python/recipe/dashboard/recipe.py

@@ -19,24 +19,14 @@
 from supertokens_python.normalised_url_path import NormalisedURLPath
 from supertokens_python.recipe_module import APIHandled, RecipeModule
 
-from .api import (
-    api_key_protector,
-    handle_dashboard_api,
-    handle_email_verify_token_post,
-    handle_metadata_get,
-    handle_metadata_put,
-    handle_sessions_get,
-    handle_user_delete,
-    handle_user_email_verify_get,
-    handle_user_email_verify_put,
-    handle_user_get,
-    handle_user_password_put,
-    handle_user_put,
-    handle_user_sessions_post,
-    handle_users_count_get_api,
-    handle_users_get_api,
-    handle_validate_key_api,
-)
+from .api import (api_key_protector, handle_dashboard_api,
+                  handle_email_verify_token_post, handle_metadata_get,
+                  handle_metadata_put, handle_sessions_get, handle_sign_in_api,
+                  handle_signout, handle_user_delete,
+                  handle_user_email_verify_get, handle_user_email_verify_put,
+                  handle_user_get, handle_user_password_put, handle_user_put,
+                  handle_user_sessions_post, handle_users_count_get_api,
+                  handle_users_get_api, handle_validate_key_api)
 from .api.implementation import APIImplementation
 from .exceptions import SuperTokensDashboardError
 from .interfaces import APIInterface, APIOptions
@@ -48,26 +38,16 @@
     from supertokens_python.supertokens import AppInfo
     from supertokens_python.types import APIResponse
 
-from supertokens_python.exceptions import SuperTokensError, raise_general_exception
-
-from .constants import (
-    DASHBOARD_API,
-    USER_API,
-    USER_EMAIL_VERIFY_API,
-    USER_EMAIL_VERIFY_TOKEN_API,
-    USER_METADATA_API,
-    USER_PASSWORD_API,
-    USER_SESSION_API,
-    USERS_COUNT_API,
-    USERS_LIST_GET_API,
-    VALIDATE_KEY_API,
-)
-from .utils import (
-    InputOverrideConfig,
-    get_api_if_matched,
-    is_api_path,
-    validate_and_normalise_user_input,
-)
+from supertokens_python.exceptions import (SuperTokensError,
+                                           raise_general_exception)
+
+from .constants import (DASHBOARD_API, EMAIL_PASSSWORD_SIGNOUT,
+                        EMAIL_PASSWORD_SIGN_IN, USER_API,
+                        USER_EMAIL_VERIFY_API, USER_EMAIL_VERIFY_TOKEN_API,
+                        USER_METADATA_API, USER_PASSWORD_API, USER_SESSION_API,
+                        USERS_COUNT_API, USERS_LIST_GET_API, VALIDATE_KEY_API)
+from .utils import (InputOverrideConfig, get_api_if_matched, is_api_path,
+                    validate_and_normalise_user_input)
 
 
 class DashboardRecipe(RecipeModule):
@@ -136,6 +116,8 @@ async def handle_api_request(
             return await handle_dashboard_api(self.api_implementation, api_options)
         if request_id == VALIDATE_KEY_API:
             return await handle_validate_key_api(self.api_implementation, api_options)
+        if request_id == EMAIL_PASSWORD_SIGN_IN:
+            return await handle_sign_in_api(self.api_implementation, api_options)
 
         # Do API key validation for the remaining APIs
         api_function: Optional[
@@ -171,6 +153,8 @@ async def handle_api_request(
             api_function = handle_user_password_put
         elif request_id == USER_EMAIL_VERIFY_TOKEN_API:
             api_function = handle_email_verify_token_post
+        elif request_id == EMAIL_PASSSWORD_SIGNOUT:
+            api_function = handle_signout
 
         if api_function is not None:
             return await api_key_protector(
@@ -221,7 +205,8 @@ def reset():
         if ("SUPERTOKENS_ENV" not in environ) or (
             environ["SUPERTOKENS_ENV"] != "testing"
         ):
-            raise_general_exception("calling testing function in non testing env")
+            raise_general_exception(
+                "calling testing function in non testing env")
         DashboardRecipe.__instance = None
 
     def return_api_id_if_can_handle_request(

supertokens_python/recipe/dashboard/utils.py

@@ -15,47 +15,36 @@
 
 from typing import TYPE_CHECKING, Any, Callable, Dict, Optional, Union
 
+if TYPE_CHECKING:
+    from supertokens_python.framework.request import BaseRequest
+
 from supertokens_python.recipe.emailpassword import EmailPasswordRecipe
-from supertokens_python.recipe.emailpassword.asyncio import (
-    get_user_by_id as ep_get_user_by_id,
-)
+from supertokens_python.recipe.emailpassword.asyncio import \
+    get_user_by_id as ep_get_user_by_id
 from supertokens_python.recipe.passwordless import PasswordlessRecipe
-from supertokens_python.recipe.passwordless.asyncio import (
-    get_user_by_id as pless_get_user_by_id,
-)
+from supertokens_python.recipe.passwordless.asyncio import \
+    get_user_by_id as pless_get_user_by_id
 from supertokens_python.recipe.thirdparty import ThirdPartyRecipe
-from supertokens_python.recipe.thirdparty.asyncio import (
-    get_user_by_id as tp_get_user_by_idx,
-)
-from supertokens_python.recipe.thirdpartyemailpassword import (
-    ThirdPartyEmailPasswordRecipe,
-)
-from supertokens_python.recipe.thirdpartyemailpassword.asyncio import (
-    get_user_by_id as tpep_get_user_by_id,
-)
-from supertokens_python.recipe.thirdpartypasswordless import (
-    ThirdPartyPasswordlessRecipe,
-)
-from supertokens_python.recipe.thirdpartypasswordless.asyncio import (
-    get_user_by_id as tppless_get_user_by_id,
-)
+from supertokens_python.recipe.thirdparty.asyncio import \
+    get_user_by_id as tp_get_user_by_idx
+from supertokens_python.recipe.thirdpartyemailpassword import \
+    ThirdPartyEmailPasswordRecipe
+from supertokens_python.recipe.thirdpartyemailpassword.asyncio import \
+    get_user_by_id as tpep_get_user_by_id
+from supertokens_python.recipe.thirdpartypasswordless import \
+    ThirdPartyPasswordlessRecipe
+from supertokens_python.recipe.thirdpartypasswordless.asyncio import \
+    get_user_by_id as tppless_get_user_by_id
 from supertokens_python.types import User
 from supertokens_python.utils import Awaitable
 
 from ...normalised_url_path import NormalisedURLPath
 from ...supertokens import AppInfo
-from .constants import (
-    DASHBOARD_API,
-    USER_API,
-    USER_EMAIL_VERIFY_API,
-    USER_EMAIL_VERIFY_TOKEN_API,
-    USER_METADATA_API,
-    USER_PASSWORD_API,
-    USER_SESSION_API,
-    USERS_COUNT_API,
-    USERS_LIST_GET_API,
-    VALIDATE_KEY_API,
-)
+from .constants import (DASHBOARD_API, EMAIL_PASSSWORD_SIGNOUT,
+                        EMAIL_PASSWORD_SIGN_IN, USER_API,
+                        USER_EMAIL_VERIFY_API, USER_EMAIL_VERIFY_TOKEN_API,
+                        USER_METADATA_API, USER_PASSWORD_API, USER_SESSION_API,
+                        USERS_COUNT_API, USERS_LIST_GET_API, VALIDATE_KEY_API)
 
 if TYPE_CHECKING:
     from .interfaces import APIInterface, RecipeInterface
@@ -143,7 +132,8 @@ def to_json(self) -> Dict[str, Any]:
 class InputOverrideConfig:
     def __init__(
         self,
-        functions: Union[Callable[[RecipeInterface], RecipeInterface], None] = None,
+        functions: Union[Callable[[RecipeInterface],
+                                  RecipeInterface], None] = None,
         apis: Union[Callable[[APIInterface], APIInterface], None] = None,
     ):
         self.functions = functions
@@ -153,7 +143,8 @@ def __init__(
 class OverrideConfig:
     def __init__(
         self,
-        functions: Union[Callable[[RecipeInterface], RecipeInterface], None] = None,
+        functions: Union[Callable[[RecipeInterface],
+                                  RecipeInterface], None] = None,
         apis: Union[Callable[[APIInterface], APIInterface], None] = None,
     ):
         self.functions = functions
@@ -165,18 +156,18 @@ def __init__(
         self,
         api_key: str,
         override: OverrideConfig,
+        auth_mode: str
     ):
         self.api_key = api_key
         self.override = override
+        self.auth_mode = auth_mode
 
 
 def validate_and_normalise_user_input(
     # app_info: AppInfo,
     api_key: str,
     override: Optional[InputOverrideConfig] = None,
 ) -> DashboardConfig:
-    if api_key.strip() == "":
-        raise Exception("apiKey provided to Dashboard recipe cannot be empty")
 
     if override is None:
         override = InputOverrideConfig()
@@ -187,6 +178,7 @@ def validate_and_normalise_user_input(
             functions=override.functions,
             apis=override.apis,
         ),
+        "api-key" if api_key else "email-password"
     )
 
 
@@ -198,7 +190,8 @@ def is_api_path(path: NormalisedURLPath, app_info: AppInfo) -> bool:
     if not path.startswith(dashboard_recipe_base_path):
         return False
 
-    path_without_dashboard_path = path.get_as_string_dangerous().split(DASHBOARD_API)[1]
+    path_without_dashboard_path = path.get_as_string_dangerous().split(DASHBOARD_API)[
+        1]
 
     if len(path_without_dashboard_path) > 0 and path_without_dashboard_path[0] == "/":
         path_without_dashboard_path = path_without_dashboard_path[1:]
@@ -230,6 +223,10 @@ def get_api_if_matched(path: NormalisedURLPath, method: str) -> Optional[str]:
         return USER_PASSWORD_API
     if path_str.endswith(USER_EMAIL_VERIFY_TOKEN_API) and method == "post":
         return USER_EMAIL_VERIFY_TOKEN_API
+    if path_str.endswith(EMAIL_PASSWORD_SIGN_IN) and method == "post":
+        return EMAIL_PASSWORD_SIGN_IN
+    if path_str.endswith(EMAIL_PASSSWORD_SIGNOUT) and method == "post":
+        return EMAIL_PASSSWORD_SIGNOUT
 
     return None
 
@@ -245,15 +242,16 @@ def __init__(self, user: UserWithMetadata, recipe: str):
 
 
 if TYPE_CHECKING:
-    from supertokens_python.recipe.emailpassword.types import User as EmailPasswordUser
-    from supertokens_python.recipe.passwordless.types import User as PasswordlessUser
-    from supertokens_python.recipe.thirdparty.types import User as ThirdPartyUser
-    from supertokens_python.recipe.thirdpartyemailpassword.types import (
-        User as ThirdPartyEmailPasswordUser,
-    )
-    from supertokens_python.recipe.thirdpartypasswordless.types import (
-        User as ThirdPartyPasswordlessUser,
-    )
+    from supertokens_python.recipe.emailpassword.types import \
+        User as EmailPasswordUser
+    from supertokens_python.recipe.passwordless.types import \
+        User as PasswordlessUser
+    from supertokens_python.recipe.thirdparty.types import \
+        User as ThirdPartyUser
+    from supertokens_python.recipe.thirdpartyemailpassword.types import \
+        User as ThirdPartyEmailPasswordUser
+    from supertokens_python.recipe.thirdpartypasswordless.types import \
+        User as ThirdPartyPasswordlessUser
 
     GetUserResult = Union[
         EmailPasswordUser,
@@ -385,3 +383,10 @@ def is_recipe_initialised(recipeId: str) -> bool:
                 pass
 
     return isRecipeInitialised
+
+
+def validate_APIKey(req: BaseRequest, config: DashboardConfig) -> bool:
+    apiKeyHeaderValue = req.get_header("authorization")
+    if not apiKeyHeaderValue:
+        return False
+    return apiKeyHeaderValue == config.api_key