.. _f-authapp:

module ``apps.common.auth_app``
===============================





.. inheritance-diagram:: mathenjeu.apps.common.auth_app


Short summary
+++++++++++++

module ``mathenjeu.apps.common.auth_app``

Starts an application.


:githublink:`%|py|6`




Classes
+++++++

+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| class                                                                                     | truncated documentation                                                                                               |
+===========================================================================================+=======================================================================================================================+
| :class:`AuthentificationAnswers <mathenjeu.apps.common.auth_app.AuthentificationAnswers>` | Defines answers for an application with authentification. It stores a cookie with only the user alias. The method ... |
+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+










Methods
+++++++

+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| method                                                                                           | truncated documentation                                                                                        |
+==================================================================================================+================================================================================================================+
| :py:meth:`__init__ <mathenjeu.apps.common.auth_app.AuthentificationAnswers.__init__>`            |                                                                                                                |
+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :meth:`authenticate <mathenjeu.apps.common.auth_app.AuthentificationAnswers.authenticate>`       | Authentification.                                                                                              |
+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :meth:`authentify_user <mathenjeu.apps.common.auth_app.AuthentificationAnswers.authentify_user>` | Overwrites this method to allow or reject users.                                                               |
+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :meth:`get_session <mathenjeu.apps.common.auth_app.AuthentificationAnswers.get_session>`         | Retrieves the session.                                                                                         |
+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :meth:`hash_pwd <mathenjeu.apps.common.auth_app.AuthentificationAnswers.hash_pwd>`               | Hashes a password.                                                                                             |
+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :meth:`is_allowed <mathenjeu.apps.common.auth_app.AuthentificationAnswers.is_allowed>`           | Checks that a user is allowed. Returns None if it is allowed, otherwise an page with an error message.         |
+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :meth:`login <mathenjeu.apps.common.auth_app.AuthentificationAnswers.login>`                     | Login page. If paramater *returnto* is specified in the url, the user will go to this page after being logged. |
+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :meth:`logout <mathenjeu.apps.common.auth_app.AuthentificationAnswers.logout>`                   | Logout page.                                                                                                   |
+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :meth:`save_session <mathenjeu.apps.common.auth_app.AuthentificationAnswers.save_session>`       | Saves the session to the response in a secure cookie.                                                          |
+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: mathenjeu.apps.common.auth_app
    :members:
    :special-members: __init__
    :show-inheritance: