square-authentication 6.2.2__tar.gz → 8.0.0__tar.gz

{square_authentication-6.2.2 → square_authentication-8.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: square_authentication
-Version: 6.2.2
+Version: 8.0.0
 Summary: authentication layer for my personal server.
 Home-page: https://github.com/thepmsquare/square_authentication
 Author: thePmSquare
@@ -19,13 +19,14 @@ Requires-Dist: bcrypt>=4.1.2
 Requires-Dist: pyjwt>=2.8.0
 Requires-Dist: requests>=2.32.3
 Requires-Dist: cryptography>=42.0.7
-Requires-Dist: square_commons>=2.1.0
+Requires-Dist: square_commons>=3.0.0
 Requires-Dist: square_logger>=2.0.0
 Requires-Dist: square_database_helper>=2.0.0
 Requires-Dist: square_database_structure>=2.3.1
 Requires-Dist: square_file_store_helper>=3.0.0
 Requires-Dist: pytest>=8.0.0
 Requires-Dist: httpx>=0.27.2
+Requires-Dist: google-auth>=2.40.3
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -53,6 +54,59 @@ pip install square_authentication
 
 ## changelog
 
+### v8.0.0
+
+- env
+    - add GOOGLE section and GOOGLE_AUTH_PLATFORM_CLIENT_ID variable.
+    - add LOGIC section with NUMBER_OF_RECOVERY_CODES, EXPIRY_TIME_FOR_EMAIL_VERIFICATION_CODE_IN_SECONDS,
+      NUMBER_OF_DIGITS_IN_EMAIL_VERIFICATION_CODE, EXPIRY_TIME_FOR_EMAIL_PASSWORD_RESET_CODE_IN_SECONDS,
+      NUMBER_OF_DIGITS_IN_EMAIL_PASSWORD_RESET_CODE variables.
+- dependencies
+    - add google-auth>=2.40.3.
+    - update square_commons to >=3.0.0.
+- core
+    - add reset_password_and_login_using_reset_email_code_v0.
+    - **breaking change**: remove app_id from send_reset_password_email_v0.
+    - implement deletion of existing backup codes before generating new ones (generate_account_backup_codes_v0).
+    - implement deletion of existing backup codes before removing recovery method (update_user_recovery_methods_v0).
+    - implement logout_other_sessions in update_password_v0, reset_password_and_login_using_backup_code_v0 and
+      reset_password_and_login_using_reset_email_code_v0
+        - in update_password_v0, it will log out all other sessions except the current one if valid (optional)
+          refresh_token is passed in.
+    - add register_login_google_v0, **finally**.
+    - add validation in update_password_v0, reset_password_and_login_using_backup_code_v0, send_reset_password_email_v0,
+      reset_password_and_login_using_reset_email_code_v0 to check if user has credentials and has self as auth provider.
+    - remove profile_photo from file_store when user is deleted in delete_user_v0.
+- utils
+    - add new core file with generate_default_username_for_google_users function.
+- tests
+    - add test_login_fail_v0.
+
+### v7.0.0
+
+- internal support for UserAuthProvider.
+- internal support for username shifted from UserProfile to User.
+- internal support for phone number country code in UserProfile.
+- core
+    - register_username_v0 fixed to account for changes mentioned above and creates empty profile.
+    - login_username_v0 fixed to account for changes mentioned above.
+    - update_username_v0 fixed to account for changes mentioned above.
+    - **breaking change**: delete_user_v0 is now a POST method instead of DELETE.
+    - add generate_account_backup_codes_v0.
+    - add reset_password_and_login_using_backup_code_v0.
+    - add validation for email verification when adding email as recovery method in update_user_recovery_methods_v0.
+    - add send_reset_password_email_v0.
+- profile
+    - add update_profile_details_v0.
+    - add send_verification_email_v0.
+    - add validate_email_verification_code_v0.
+- tests
+    - add test cases and fixtures for login_username_v0.
+    - add test cases and fixtures for delete_user_v0.
+    - add test cases and fixtures for update_profile_details_v0.
+- env
+    - add EMAIL section and MAIL_GUN_API_KEY variable.
+
 ### v6.2.2
 
 - remove config.ini and config.testing.ini from version control.

{square_authentication-6.2.2 → square_authentication-8.0.0}/README.md

@@ -16,6 +16,59 @@ pip install square_authentication
 
 ## changelog
 
+### v8.0.0
+
+- env
+    - add GOOGLE section and GOOGLE_AUTH_PLATFORM_CLIENT_ID variable.
+    - add LOGIC section with NUMBER_OF_RECOVERY_CODES, EXPIRY_TIME_FOR_EMAIL_VERIFICATION_CODE_IN_SECONDS,
+      NUMBER_OF_DIGITS_IN_EMAIL_VERIFICATION_CODE, EXPIRY_TIME_FOR_EMAIL_PASSWORD_RESET_CODE_IN_SECONDS,
+      NUMBER_OF_DIGITS_IN_EMAIL_PASSWORD_RESET_CODE variables.
+- dependencies
+    - add google-auth>=2.40.3.
+    - update square_commons to >=3.0.0.
+- core
+    - add reset_password_and_login_using_reset_email_code_v0.
+    - **breaking change**: remove app_id from send_reset_password_email_v0.
+    - implement deletion of existing backup codes before generating new ones (generate_account_backup_codes_v0).
+    - implement deletion of existing backup codes before removing recovery method (update_user_recovery_methods_v0).
+    - implement logout_other_sessions in update_password_v0, reset_password_and_login_using_backup_code_v0 and
+      reset_password_and_login_using_reset_email_code_v0
+        - in update_password_v0, it will log out all other sessions except the current one if valid (optional)
+          refresh_token is passed in.
+    - add register_login_google_v0, **finally**.
+    - add validation in update_password_v0, reset_password_and_login_using_backup_code_v0, send_reset_password_email_v0,
+      reset_password_and_login_using_reset_email_code_v0 to check if user has credentials and has self as auth provider.
+    - remove profile_photo from file_store when user is deleted in delete_user_v0.
+- utils
+    - add new core file with generate_default_username_for_google_users function.
+- tests
+    - add test_login_fail_v0.
+
+### v7.0.0
+
+- internal support for UserAuthProvider.
+- internal support for username shifted from UserProfile to User.
+- internal support for phone number country code in UserProfile.
+- core
+    - register_username_v0 fixed to account for changes mentioned above and creates empty profile.
+    - login_username_v0 fixed to account for changes mentioned above.
+    - update_username_v0 fixed to account for changes mentioned above.
+    - **breaking change**: delete_user_v0 is now a POST method instead of DELETE.
+    - add generate_account_backup_codes_v0.
+    - add reset_password_and_login_using_backup_code_v0.
+    - add validation for email verification when adding email as recovery method in update_user_recovery_methods_v0.
+    - add send_reset_password_email_v0.
+- profile
+    - add update_profile_details_v0.
+    - add send_verification_email_v0.
+    - add validate_email_verification_code_v0.
+- tests
+    - add test cases and fixtures for login_username_v0.
+    - add test cases and fixtures for delete_user_v0.
+    - add test cases and fixtures for update_profile_details_v0.
+- env
+    - add EMAIL section and MAIL_GUN_API_KEY variable.
+
 ### v6.2.2
 
 - remove config.ini and config.testing.ini from version control.

square_authentication-8.0.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=75.3.0", "wheel"]
+build-backend = "setuptools.build_meta"

{square_authentication-6.2.2 → square_authentication-8.0.0}/setup.py

@@ -4,7 +4,7 @@ package_name = "square_authentication"
 
 setup(
     name=package_name,
-    version="6.2.2",
+    version="8.0.0",
     packages=find_packages(),
     package_data={
         package_name: ["data/*"],
@@ -18,13 +18,14 @@ setup(
         "pyjwt>=2.8.0",
         "requests>=2.32.3",
         "cryptography>=42.0.7",
-        "square_commons>=2.1.0",
+        "square_commons>=3.0.0",
         "square_logger>=2.0.0",
         "square_database_helper>=2.0.0",
         "square_database_structure>=2.3.1",
         "square_file_store_helper>=3.0.0",
         "pytest>=8.0.0",
         "httpx>=0.27.2",
+        "google-auth>=2.40.3",
     ],
     extras_require={},
     author="thePmSquare",

{square_authentication-6.2.2 → square_authentication-8.0.0}/square_authentication/configuration.py

@@ -94,6 +94,43 @@ try:
         ldict_configuration["SQUARE_FILE_STORE_HELPER"]["SQUARE_FILE_STORE_PORT"]
     )
     # ===========================================
+
+    # ===========================================
+    # EMAIL
+
+    MAIL_GUN_API_KEY = ldict_configuration["EMAIL"]["MAIL_GUN_API_KEY"]
+    # ===========================================
+    # ===========================================
+    # GOOGLE
+
+    GOOGLE_AUTH_PLATFORM_CLIENT_ID = ldict_configuration["GOOGLE"][
+        "GOOGLE_AUTH_PLATFORM_CLIENT_ID"
+    ]
+    # ===========================================
+    # ===========================================
+    # GOOGLE
+
+    NUMBER_OF_RECOVERY_CODES = int(
+        ldict_configuration["LOGIC"]["NUMBER_OF_RECOVERY_CODES"]
+    )
+    EXPIRY_TIME_FOR_EMAIL_VERIFICATION_CODE_IN_SECONDS = int(
+        ldict_configuration["LOGIC"][
+            "EXPIRY_TIME_FOR_EMAIL_VERIFICATION_CODE_IN_SECONDS"
+        ]
+    )
+    NUMBER_OF_DIGITS_IN_EMAIL_VERIFICATION_CODE = int(
+        ldict_configuration["LOGIC"]["NUMBER_OF_DIGITS_IN_EMAIL_VERIFICATION_CODE"]
+    )
+    EXPIRY_TIME_FOR_EMAIL_PASSWORD_RESET_CODE_IN_SECONDS = int(
+        ldict_configuration["LOGIC"][
+            "EXPIRY_TIME_FOR_EMAIL_PASSWORD_RESET_CODE_IN_SECONDS"
+        ]
+    )
+    NUMBER_OF_DIGITS_IN_EMAIL_PASSWORD_RESET_CODE = int(
+        ldict_configuration["LOGIC"]["NUMBER_OF_DIGITS_IN_EMAIL_PASSWORD_RESET_CODE"]
+    )
+    # ===========================================
+
     # Initialize logger
     global_object_square_logger = SquareLogger(
         pstr_log_file_name=config_str_log_file_name,

{square_authentication-6.2.2 → square_authentication-8.0.0}/square_authentication/data/config.sample.ini

@@ -51,4 +51,17 @@ SQUARE_DATABASE_PORT = 10010
 
 SQUARE_FILE_STORE_PROTOCOL = http
 SQUARE_FILE_STORE_IP = localhost
-SQUARE_FILE_STORE_PORT = 10100
+SQUARE_FILE_STORE_PORT = 10100
+
+[EMAIL]
+MAIL_GUN_API_KEY = dummy_mailgun_api_key
+
+[GOOGLE]
+GOOGLE_AUTH_PLATFORM_CLIENT_ID = dummy_google_client_id
+
+[LOGIC]
+NUMBER_OF_RECOVERY_CODES = 10
+EXPIRY_TIME_FOR_EMAIL_VERIFICATION_CODE_IN_SECONDS = 600
+NUMBER_OF_DIGITS_IN_EMAIL_VERIFICATION_CODE = 6
+EXPIRY_TIME_FOR_EMAIL_PASSWORD_RESET_CODE_IN_SECONDS = 600
+NUMBER_OF_DIGITS_IN_EMAIL_PASSWORD_RESET_CODE = 6

{square_authentication-6.2.2 → square_authentication-8.0.0}/square_authentication/data/config.testing.sample.ini

@@ -51,4 +51,17 @@ SQUARE_DATABASE_PORT = 20010
 
 SQUARE_FILE_STORE_PROTOCOL = http
 SQUARE_FILE_STORE_IP = raspi.thepmsquare.com
-SQUARE_FILE_STORE_PORT = 20010
+SQUARE_FILE_STORE_PORT = 20010
+
+[EMAIL]
+MAIL_GUN_API_KEY = dummy_mailgun_api_key
+
+[GOOGLE]
+GOOGLE_AUTH_PLATFORM_CLIENT_ID = dummy_google_client_id
+
+[LOGIC]
+NUMBER_OF_RECOVERY_CODES = 10
+EXPIRY_TIME_FOR_EMAIL_VERIFICATION_CODE_IN_SECONDS = 600
+NUMBER_OF_DIGITS_IN_EMAIL_VERIFICATION_CODE = 6
+EXPIRY_TIME_FOR_EMAIL_PASSWORD_RESET_CODE_IN_SECONDS = 600
+NUMBER_OF_DIGITS_IN_EMAIL_PASSWORD_RESET_CODE = 6

{square_authentication-6.2.2 → square_authentication-8.0.0}/square_authentication/messages.py

@@ -13,8 +13,20 @@ messages = {
     "GENERIC_READ_SUCCESSFUL": "data retrieved successfully.",
     "GENERIC_UPDATE_SUCCESSFUL": "your information has been updated successfully.",
     "GENERIC_DELETE_SUCCESSFUL": "your records have been deleted successfully.",
+    "GENERIC_ACTION_SUCCESSFUL": "the action was completed successfully.",
     "GENERIC_400": "the request is invalid or cannot be processed.",
     "GENERIC_500": "an internal server error occurred. please try again later.",
     "INVALID_FILE_FORMAT": "the file format is not supported. please upload a valid file.",
     "FILE_SIZE_EXCEEDS_LIMIT": "the file size exceeds the limit. please upload a smaller file.",
+    "INCORRECT_AUTH_PROVIDER": "you have not linked this authentication provider to your account. please link it first.",
+    "INVALID_EMAIL_FORMAT": "the email address is invalid. please provide a valid email address.",
+    "INVALID_PHONE_NUMBER_FORMAT": "the phone number is invalid. please provide a valid phone number.",
+    "GENERIC_MISSING_REQUIRED_FIELD": "a required field is missing. please check your input and try again.",
+    "RECOVERY_METHOD_NOT_ENABLED": "the recovery method you are trying to use is not enabled for your account.",
+    "INCORRECT_BACKUP_CODE": "the backup code you provided is incorrect or has already been used. please try again with a valid code.",
+    "EMAIL_ALREADY_VERIFIED": "your email address has already been verified.",
+    "INCORRECT_VERIFICATION_CODE": "the verification code you entered is incorrect or has expired. please request a new code.",
+    "EMAIL_NOT_VERIFIED": "your email address has not been verified. please verify your email to continue.",
+    "ACCOUNT_WITH_EMAIL_ALREADY_EXISTS": "an account with this email address already exists.",
+    "MALFORMED_USER": " the user data is malformed or incomplete.",
 }

square_authentication-8.0.0/square_authentication/pydantic_models/core.py

@@ -0,0 +1,63 @@
+from enum import Enum
+from typing import Optional, List
+
+from pydantic import BaseModel
+
+
+class RegisterUsernameV0(BaseModel):
+    username: str
+    password: str
+    app_id: Optional[int] = None
+
+
+class RegisterLoginGoogleV0(BaseModel):
+    google_id: str
+    app_id: Optional[int] = None
+    assign_app_id_if_missing: bool = False
+
+
+class LoginUsernameV0(BaseModel):
+    username: str
+    password: str
+    app_id: int
+    assign_app_id_if_missing: bool = False
+
+
+class DeleteUserV0(BaseModel):
+    password: str
+
+
+class UpdatePasswordV0(BaseModel):
+    old_password: str
+    new_password: str
+    logout_other_sessions: bool = False
+    preserve_session_refresh_token: Optional[str] = None
+
+
+class TokenType(Enum):
+    access_token = "access_token"
+    refresh_token = "refresh_token"
+
+
+class LogoutAppsV0(BaseModel):
+    app_ids: List[int]
+
+
+class ResetPasswordAndLoginUsingBackupCodeV0(BaseModel):
+    backup_code: str
+    username: str
+    new_password: str
+    app_id: int
+    logout_other_sessions: bool = False
+
+
+class SendResetPasswordEmailV0(BaseModel):
+    username: str
+
+
+class ResetPasswordAndLoginUsingResetEmailCodeV0(BaseModel):
+    reset_email_code: str
+    username: str
+    new_password: str
+    app_id: int
+    logout_other_sessions: bool = False

square_authentication-8.0.0/square_authentication/pydantic_models/profile.py

@@ -0,0 +1,5 @@
+from pydantic import BaseModel
+
+
+class ValidateEmailVerificationCodeV0(BaseModel):
+    verification_code: str