openedx.core.djangoapps.user_authn package

Subpackages

• openedx.core.djangoapps.user_authn.api package
  • Submodules
  • openedx.core.djangoapps.user_authn.api.constants module
  • openedx.core.djangoapps.user_authn.api.form_fields module
    • add_city_field()
    • add_company_field()
    • add_confirm_email_field()
    • add_country_field()
    • add_extension_form_field()
    • add_first_name_field()
    • add_gender_field()
    • add_goals_field()
    • add_honor_code_field()
    • add_job_title_field()
    • add_last_name_field()
    • add_level_of_education_field()
    • add_mailing_address_field()
    • add_profession_field()
    • add_specialty_field()
    • add_state_field()
    • add_terms_of_service_field()
    • add_title_field()
    • add_work_experience_field()
    • add_year_of_birth_field()
  • openedx.core.djangoapps.user_authn.api.helper module
    • RegistrationFieldsContext
      • RegistrationFieldsContext.EXTRA_FIELDS
      • RegistrationFieldsContext.get_fields()
      • RegistrationFieldsContext.user_profile_fields
  • openedx.core.djangoapps.user_authn.api.urls module
  • openedx.core.djangoapps.user_authn.api.views module
    • MFEContextThrottle
      • MFEContextThrottle.rate
    • MFEContextView
      • MFEContextView.get()
      • MFEContextView.throttle_classes
    • SendAccountActivationEmail
      • SendAccountActivationEmail.authentication_classes
      • SendAccountActivationEmail.permission_classes
      • SendAccountActivationEmail.post()
  • Module contents
• openedx.core.djangoapps.user_authn.config package
  • Submodules
  • openedx.core.djangoapps.user_authn.config.waffle module
  • Module contents
• openedx.core.djangoapps.user_authn.views package
  • Submodules
  • openedx.core.djangoapps.user_authn.views.auth module
    • get_public_signing_jwks()
  • openedx.core.djangoapps.user_authn.views.auto_auth module
    • auto_auth()
  • openedx.core.djangoapps.user_authn.views.login module
    • LoginSessionView
      • LoginSessionView.authentication_classes
      • LoginSessionView.dispatch()
      • LoginSessionView.get()
      • LoginSessionView.login_user_responses
      • LoginSessionView.post()
    • enterprise_selection_page()
    • finish_auth()
    • login_refresh()
    • login_user()
    • redirect_to_lms_login()
  • openedx.core.djangoapps.user_authn.views.login_form module
    • get_login_session_form()
    • login_and_registration_form()
  • openedx.core.djangoapps.user_authn.views.logout module
    • LogoutView
      • LogoutView.default_target
      • LogoutView.dispatch()
      • LogoutView.get_context_data()
      • LogoutView.oauth_client_ids
      • LogoutView.post()
      • LogoutView.target
      • LogoutView.template_name
      • LogoutView.tpa_logout_url
  • openedx.core.djangoapps.user_authn.views.password_reset module
    • LogistrationPasswordResetView
      • LogistrationPasswordResetView.post()
      • LogistrationPasswordResetView.throttle_classes
    • PasswordResetConfirmWrapper
      • PasswordResetConfirmWrapper.dispatch()
      • PasswordResetConfirmWrapper.post()
    • PasswordResetFormNoActive
      • PasswordResetFormNoActive.base_fields
      • PasswordResetFormNoActive.clean_email()
      • PasswordResetFormNoActive.declared_fields
      • PasswordResetFormNoActive.error_messages
      • PasswordResetFormNoActive.is_account_recovery
      • PasswordResetFormNoActive.media
      • PasswordResetFormNoActive.save()
      • PasswordResetFormNoActive.users_cache
    • PasswordResetThrottle
      • PasswordResetThrottle.parse_rate()
      • PasswordResetThrottle.rate
    • PasswordResetTokenValidation
      • PasswordResetTokenValidation.post()
      • PasswordResetTokenValidation.throttle_classes
    • PasswordResetView
      • PasswordResetView.authentication_classes
      • PasswordResetView.get()
    • ResetTokenValidationThrottle
      • ResetTokenValidationThrottle.parse_rate()
      • ResetTokenValidationThrottle.rate
    • get_password_reset_form()
    • get_user_default_email_params()
    • password_change_request_handler()
    • password_reset()
    • request_password_change()
    • send_password_reset_email_for_user()
    • send_password_reset_success_email()
  • openedx.core.djangoapps.user_authn.views.register module
    • RegistrationValidationView
      • RegistrationValidationView.authentication_classes
      • RegistrationValidationView.confirm_email_handler()
      • RegistrationValidationView.country_handler()
      • RegistrationValidationView.email_handler()
      • RegistrationValidationView.name_handler()
      • RegistrationValidationView.password_handler()
      • RegistrationValidationView.post()
      • RegistrationValidationView.username_handler()
      • RegistrationValidationView.username_suggestions
      • RegistrationValidationView.validation_handlers
    • RegistrationView
      • RegistrationView.authentication_classes
      • RegistrationView.dispatch()
      • RegistrationView.get()
      • RegistrationView.post()
    • create_account_with_params()
    • is_new_user()
  • openedx.core.djangoapps.user_authn.views.registration_form module
    • AccountCreationForm
      • AccountCreationForm.base_fields
      • AccountCreationForm.clean_country()
      • AccountCreationForm.clean_email()
      • AccountCreationForm.clean_password()
      • AccountCreationForm.clean_year_of_birth()
      • AccountCreationForm.cleaned_extended_profile
      • AccountCreationForm.declared_fields
      • AccountCreationForm.media
    • RegistrationFormFactory
      • RegistrationFormFactory.DEFAULT_FIELDS
      • RegistrationFormFactory.get_registration_form()
    • TrueCheckbox
      • TrueCheckbox.media
      • TrueCheckbox.value_from_datadict()
    • TrueField
      • TrueField.widget
    • UsernameField
      • UsernameField.clean()
      • UsernameField.default_validators
    • contains_html()
    • contains_url()
    • get_extended_profile_model()
    • get_registration_extension_form()
    • validate_name()
    • validate_username()
  • openedx.core.djangoapps.user_authn.views.utils module
    • get_auto_generated_username()
    • get_mfe_context()
    • remove_disabled_country_from_list()
    • third_party_auth_context()
  • Module contents

Submodules

openedx.core.djangoapps.user_authn.apps module

User Authentication Configuration

class openedx.core.djangoapps.user_authn.apps.UserAuthnConfig(app_name, app_module)

Bases: AppConfig

Application Configuration for User Authentication.

name = 'openedx.core.djangoapps.user_authn'

plugin_app = {'signals_config': {'lms.djangoapp': {'receivers': [{'receiver_func_name': 'user_fields_changed', 'signal_path': 'common.djangoapps.util.model_utils.USER_FIELDS_CHANGED'}]}}, 'url_config': {'lms.djangoapp': {'app_name': 'openedx.core.djangoapps.user_authn', 'namespace': '', 'regex': '', 'relative_path': 'urls'}}}

openedx.core.djangoapps.user_authn.cookies module

Utility functions for setting “logged in” cookies used by subdomains.

openedx.core.djangoapps.user_authn.cookies.are_logged_in_cookies_set(request)

Check whether the request has logged in cookies set.

openedx.core.djangoapps.user_authn.cookies.delete_logged_in_cookies(response)

Delete cookies indicating that the user is logged in (except for session cookie.) :param response: The response sent to the client. :type response: HttpResponse

Returns:

HttpResponse

openedx.core.djangoapps.user_authn.cookies.get_response_with_refreshed_jwt_cookies(request, user)

Generates the response and resets the JWT related cookies in the response for the given user.

openedx.core.djangoapps.user_authn.cookies.set_logged_in_cookies(request, response, user)

Set cookies at the time of user login. See ALL_LOGGED_IN_COOKIE_NAMES to see which cookies are set.

Parameters:

• request (HttpRequest) – The request to the view, used to calculate the cookie’s expiration date based on the session expiration date.

• response (HttpResponse) – The response on which the cookie will be set.

• user (User) – The currently logged in user.

Returns:

HttpResponse

openedx.core.djangoapps.user_authn.cookies.standard_cookie_settings(request)

Returns the common cookie settings (e.g. expiration time).

openedx.core.djangoapps.user_authn.exceptions module

User Authn related Exceptions.

exception openedx.core.djangoapps.user_authn.exceptions.AuthFailedError(value=None, redirect=None, redirect_url=None, error_code=None, context={})

Bases: Exception

This is a helper for the login view, allowing the various sub-methods to error out with an appropriate failure message.

get_response()

Returns a dict representation of the error.

exception openedx.core.djangoapps.user_authn.exceptions.VulnerablePasswordError(value, error_code, redirect_url=None)

Bases: Exception

This is a helper for the login view, allowing the view to error out if password is vulnerable.

get_response()

openedx.core.djangoapps.user_authn.message_types module

ACE message types for user_authn-related emails.

class openedx.core.djangoapps.user_authn.message_types.PasswordReset(*args, **kwargs)

Bases: BaseMessageType

A message to the user with password reset link.

class openedx.core.djangoapps.user_authn.message_types.PasswordResetSuccess(*args, **kwargs)

Bases: BaseMessageType

A message to the user when the password rest was successful.

openedx.core.djangoapps.user_authn.serializers module

MFE Context API Serializers

class openedx.core.djangoapps.user_authn.serializers.ContextDataSerializer(*args, **kwargs)

Bases: Serializer

Context Data Serializers

get_pipelineUserDetails(obj)

class openedx.core.djangoapps.user_authn.serializers.MFEContextSerializer(*args, **kwargs)

Bases: Serializer

Serializer class to convert the keys of MFE Context Response dict object to camelCase format.

class openedx.core.djangoapps.user_authn.serializers.PipelineUserDetailsSerializer(*args, **kwargs)

Bases: Serializer

Pipeline User Details Serializers

class openedx.core.djangoapps.user_authn.serializers.ProvidersSerializer(*args, **kwargs)

Bases: Serializer

Providers Serializers

openedx.core.djangoapps.user_authn.signals module

Signals for user_authn

openedx.core.djangoapps.user_authn.signals.user_fields_changed(user=None, table=None, changed_fields: Dict[str, Tuple[Any, Any]] | None = None, **_kwargs)

Update a collection of user profile fields in segment when they change in the database

Parameters:

• user – The user object for the user being changed

• table – The name of the table being updated

• changed_fields – A mapping from changed field name to old and new values.

openedx.core.djangoapps.user_authn.tasks module

This file contains celery tasks for sending email

openedx.core.djangoapps.user_authn.toggles module

Toggles for user_authn

openedx.core.djangoapps.user_authn.toggles.is_auto_generated_username_enabled()

Checks if auto-generated username should be enabled.

openedx.core.djangoapps.user_authn.toggles.is_require_third_party_auth_enabled()

openedx.core.djangoapps.user_authn.toggles.should_redirect_to_authn_microfrontend()

Checks if login/registration should be done via MFE.

openedx.core.djangoapps.user_authn.urls module

URLs for User Authentication

openedx.core.djangoapps.user_authn.urls_common module

Common URLs for User Authentication

Note: The split between urls.py and urls_common.py is hopefully temporary. For now, this is needed because of difference in CMS and LMS that have not yet been cleaned up.

This is also home to urls for endpoints that have been consolidated from other djangoapps, which leads to inconsistent prefixing.

openedx.core.djangoapps.user_authn.utils module

Utility functions used during user authentication.

openedx.core.djangoapps.user_authn.utils.check_pwned_password(password)

Check the Pwned Databases for vulnerable passwords. check_pwned_password returns password hash suffix and a dictionary containing suffix of every SHA-1 password hash beginning with the specified prefix, followed by a count of how many times it appears in their data set.

openedx.core.djangoapps.user_authn.utils.generate_username_suggestions(name: str) → list[str]

Generate 3 available username suggestions based on the provided name.

Parameters:

name (str) – The full name to generate username suggestions from. Must contain only ASCII characters.

Returns:

A list of up to 3 available username suggestions,

or an empty list if name contains non-ASCII characters or if no valid suggestions could be generated.

Return type:

list[str]

Note

Generated usernames will be combinations of: - firstname + lastname - first initial + lastname - firstname + random number

openedx.core.djangoapps.user_authn.utils.is_registration_api_v1(request)

Checks if registration api is v1 :param request: :return: Bool

openedx.core.djangoapps.user_authn.utils.is_safe_login_or_logout_redirect(redirect_to, request_host, dot_client_id, require_https)

Determine if the given redirect URL/path is safe for redirection.

Parameters:

• redirect_to (str) – The URL in question.

• request_host (str) – Originating hostname of the request. This is always considered an acceptable redirect target.

• dot_client_id (str|None) – ID of Django OAuth Toolkit client. It is acceptable to redirect to any of the DOT client’s redirect URIs. This argument is ignored if it is None.

• require_https (str) – Whether HTTPs should be required in the redirect URL.

Returns: bool

openedx.core.djangoapps.user_authn.utils.remove_special_characters_from_name(name: str) → str

Module contents