Manage the list of available authentification methods.
>>> # Get the list of available authentication method names
>>> auth_methods = Authentication()
>>> auth_methods.get_method_names()
> ["ldap", "certificate", "token", "code"]
>>> # Instantiate an authentication method.
>>> ldap_auth = auth_methods.get_auth_class(LdapAuthentication().method_name)("here.org")
>>> jwt_auth = auth_methods.get_auth_class("jwt")("token_secret")
Create the list of available authentication methods.
def __init__(self):
"""Create the list of available authentication methods.
"""
self.__methods = dict()
for auth in (LdapAuthentication, JwtAuthentication):
name = auth.name()
self.__methods[name] = auth
Return the list of known authentication method names.
def get_method_names(self) -> tuple:
"""Return the list of known authentication method names."""
return tuple(self.__methods.keys())
Return the list of known and available authentication method names.
def get_available_method_names(self) -> tuple:
"""Return the list of known and available authentication method names."""
return tuple([m for m in self.__methods.keys() if self.__methods[m].available is True])
Return the authentication class matching the given method name.
(KeyError) Unknown given authentication method name
def get_auth_class(self, name: str) -> object:
"""Return the authentication class matching the given method name.
:param name: (str) Name of an authentication method among the known ones.
:return: (class) The class to be instantiated.
:raises: (KeyError) Unknown given authentication method name
"""
method_name = str(name).strip()
if method_name not in self.__methods:
raise KeyError('{:s} is not a valid key for authentication. Must be one of: {:s}'.format(method_name, str(self.__methods.keys())))
return self.__methods[method_name]
def __str__(self):
return str(tuple(self.__methods.keys()))
def __repr__(self):
return 'Authentication({})'.format(', '.join(['{:s}: {:s}'.format(k, self.__methods[k]) for k in self.__methods]))