Warning

This document is for an in-development version of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

galaxy.auth package

Contains implementations of the authentication logic.

class galaxy.auth.AuthManager(config)

Bases: object

__init__(config)

check_registration_allowed(email, username, password, request)

Checks if the provided email/username is allowed to register.

check_auto_registration(trans: GalaxyWebTransaction, login, password, no_password_check=False)

Checks the username/email & password using auth providers in order. If a match is found, returns the ‘auto-register’ option for that provider.

check_password(user, password, request)

Checks the username/email and password using auth providers.

check_change_password(user, current_password, request)

Checks that auth provider allows password changes and current_password matches.

active_authenticators(email, username, password)

Yields AuthProvider instances for the provided configfile that match the filters.

Subpackages

• galaxy.auth.providers package
  • AuthProvider
    • AuthProvider.plugin_type
    • AuthProvider.authenticate()
    • AuthProvider.authenticate_user()
  • Submodules
  • galaxy.auth.providers.alwaysreject module
    • AlwaysReject
      • AlwaysReject.plugin_type
      • AlwaysReject.authenticate()
      • AlwaysReject.authenticate_user()
  • galaxy.auth.providers.ldap_ad module
    • LDAP
      • LDAP.plugin_type
      • LDAP.role_search_option
      • LDAP.__init__()
      • LDAP.check_config()
      • LDAP.ldap_search()
      • LDAP.authenticate()
      • LDAP.authenticate_user()
    • LDAP3
      • LDAP3.plugin_type
      • LDAP3.__init__()
      • LDAP3.get_server()
      • LDAP3.ldap_search()
    • ActiveDirectory
      • ActiveDirectory.plugin_type
  • galaxy.auth.providers.localdb module
    • LocalDB
      • LocalDB.plugin_type
      • LocalDB.authenticate()
      • LocalDB.authenticate_user()
  • galaxy.auth.providers.pam_auth module
    • PAM
      • PAM.plugin_type
      • PAM.authenticate()
      • PAM.authenticate_user()

Submodules

galaxy.auth.util module

class galaxy.auth.util.Authenticator(plugin, filter_template, options)

Bases: tuple

filter_template

Alias for field number 1

options

Alias for field number 2

plugin

Alias for field number 0

galaxy.auth.util.get_authenticators(auth_config_file, auth_config_file_set)

galaxy.auth.util.parse_auth_results(trans: ProvidesAppContext, auth_results, options)