thunderbird_accounts.authentication.utils

Functions

create_login_code(client_environment[, state])	Create a login code for login requests
delete_cache_allow_list_entry(email)
delete_cache_session(user_session)	Delete the cache session associated with a user session
get_cache_allow_list_entry(email)
get_cache_session(session_key)
handle_auth_callback_response(client_env[, ...])	Handles the return response for logins.
is_already_authenticated(request)	Check if the user is already logged in, and if we're using fxa then ensure the token exists and is valid.
is_email_in_allow_list(email)
logout_user(user[, client])	Log out a user by: 1. Telling FXA to delete their access token 2. Removing the access token from the user object (and saving) 3. Looping through each user session associated with the user - Deleting the Django Session via saved UserSession.session_key (Django Auth) - Deleting the User Session (Our Auth / DB) - Deleting the User Session object in our cache (Our Auth / Redis) 4. Fin!.
save_cache_session(user_session)	Create and save a cache session associated with a user session
set_cache_allow_list_entry(email, result)
validate_login_code(token)

thunderbird_accounts.authentication.utils.create_login_code(client_environment: ClientEnvironment, state: str | None = None)

Create a login code for login requests

thunderbird_accounts.authentication.utils.is_already_authenticated(request)

Check if the user is already logged in, and if we’re using fxa then ensure the token exists and is valid.

thunderbird_accounts.authentication.utils.handle_auth_callback_response(client_env: ClientEnvironment, redirect_to: str | None = None, state: str | None = None, user_session_id: str | None = None) → HttpResponseRedirect

Handles the return response for logins. Used in callback, and also if the user is authenticated already to skip the fxa oauth path.

thunderbird_accounts.authentication.utils.delete_cache_session(user_session: UserSession)

Delete the cache session associated with a user session

thunderbird_accounts.authentication.utils.save_cache_session(user_session: UserSession)

Create and save a cache session associated with a user session

thunderbird_accounts.authentication.utils.logout_user(user: User, client: Client | None = None) → bool

Log out a user by: 1. Telling FXA to delete their access token 2. Removing the access token from the user object (and saving) 3. Looping through each user session associated with the user

• Deleting the Django Session via saved UserSession.session_key (Django Auth)

• Deleting the User Session (Our Auth / DB)

• Deleting the User Session object in our cache (Our Auth / Redis)

4. Fin!