Module Flask (Python) permettant de gérer l'authentification suivant le modèle de UsersHub.
Prévu pour être utilisé comme un submodule git.
Nécessite le schéma utilisateurs de UsersHub dans la BDD de l'application l'utilisant. Pour cela installez UsersHub dans la même BDD ou uniquement son schéma : https://github.com/PnX-SI/UsersHub/blob/master/data/usershub.sql
Par défaut le sous-module utilise le mot de passe "pass_plus" (méthode de hashage bcrypt) pour s'authentifier. Si vous souhaitez utiliser le champ "pass" (en md5), il faut passer le paramètre PASS_METHOD = 'md5' à la configuration Flask de l'application parent qui utilise le sous-module.
Le sous-module utilise la librairie Flask-Login pour la gestion de l'authentification (https://flask-login.readthedocs.io/en/latest/).
Cette librairie offre une méthode standard de gestion de l'authentification via un cookie de session. Le sous-module ajoute la possibilité de s'authentifier via un JWT si notre application utilise une API.
Il est possible de surcoucher les vues de redirection ainsi que les callbacks renvoyés suite à une erreur 401. Voir https://flask-login.readthedocs.io/en/latest/#customizing-the-login-process.
- login :
- parametres : login, password, id_application
- return : token
- check_auth
- parametres : level = niveau de droit
- utilise le token passé en cookie de la requête
Pour disposer des routes de login/logout dans votre application Flask, ajoutez dans votre fichier de lancement de l'application (server.py par exemple) :
from pypnusershub.routes import routes
app.register_blueprint(routes, url_prefix='/auth')
Pour protéger une route :
#Import de la librairie
from pypnusershub.routes import routes as fnauth
#Ajout d'un test d'authentification avec niveau de droit
@adresses.route('/', methods=['POST', 'PUT'])
@fnauth.check_auth(4)
def insertUpdate_bibtaxons(id_taxon=None):
...
- create_tmp_user :
- in : {données sur l'utilisateur}
- return : {token}
- Création d'un utilisateur temporaire en base
- valid_temp_user :
- in : {token, application_id}
- return : {role}
- Création utilisateur en base dans la table t_role et ajout d'un profil avec code 1 pour une l’application donnée
- create_cor_role_token:
- in : {email}
- return : {role}
- Génère un token pour utilisateur ayant l’email indiqué et stoque le token dans cor_role_token
- change_password
- in: {token, password, password_confirmation}
- return : {role}
- Mise à jour du mot de passe de l’utilisateur et suppression du token en base
- change_application_right
- in : {id_application, id_profil, id_role}
- return : {id_role, id_profil, id_application, role}
- Modifie le profil de l’utilisateur pour l’application
- update_user
- in : {id_role, données utilisateur}
- return : {role}
- Mise à jour d'un rôle
- connect_admin : décorateur pour la connexion d’un utilisateur type admin a une appli ici usershub. Paramètres à renseigner dans config.py
- post_usershub :
- route générique pour appeler les route usershub en tant qu'administrateur de l'appli en cours
- lance l’action spécifié
- si une post request est définie pour l’action exécute la fonction
Paramètres à rajouter dans le fichier de configuration (config.py)
Les paramètre concernant la gestion du cookie sont gérés par flask-admin : https://flask-login.readthedocs.io/en/latest/#cookie-settings
REDIRECT_ON_FORBIDDEN : paramètre de redirection utilisé par le décorateur check_auth lorsque les droits d'accès à une ressource/page sont insuffisants (par défaut lève une erreur 403)
URL_USERSHUB="http://usershub-url.ext"
# Administrateur de mon application
ADMIN_APPLICATION_LOGIN="admin-monapplication"
ADMIN_APPLICATION_PASSWORD="monpassword"
ADMIN_APPLICATION_MAIL="[email protected]"
Pour disposer des routes dans votre application Flask, ajoutez dans votre fichier de lancement de l'application (server.py par exemple) :
from pypnusershub import routes_register
app.register_blueprint(routes_register.bp, url_prefix='/pypn/register')
Rajouter le paramètre after_USERSHUB_request à la configuration. Ce paramètre est un tableau qui définit, pour chaque action, un ensemble d'opérations à réaliser ensuite. Comme par exemple envoyer un email.
function_dict = {
'create_cor_role_token': create_cor_role_token,
'create_temp_user': create_temp_user,
'valid_temp_user': valid_temp_user,
'change_application_right': change_application_right
}
Chaque fonction prend un paramètre en argument qui correspond aux données retournées par la route de UsersHub.
Cloner le repository ou télécharger une archive, puis dans le dossier :
python setup.py install
Le driver PostgreSQL Python, "psycopg2", peut avoir besoin d'être compilé. Si à l'installation vous obtenez un message d'erreur décrivant un fichier de header manquant (xxxx.h), comme par exemple :
fatal error: Python.h: Aucun fichier ou dossier de ce type
Alors il faudra installer au préalable les headers de votre version de Python, votre version de PostgreSQL et un compilateur.
Par exemple, sur Ubuntu avec Python 3.5 et PostgreSQL 9.5 :
sudo apt install python3.5-dev build-essential postgresql-server-dev-9.5
Il faut ensuite configurer la base de données en étant super-utilisateur.
La manière la plus courante pour se connecter à la base de données en ayant les droits super-utilisateur est de se logger avec l'utilisateur 'postgres'. Par exemple sous Ubuntu :
sudo su postgres
Assurez-vous d'avoir au moins créé une base de données. Par exemple sous Ubuntu :
createdb ma_db
Il faut ensuite créer un utilisateur. Par exemple :
createuser -P parcnational
Puis donner les droits à cet utilisateur sur la base de données :
$ psql
postgres=# GRANT ALL PRIVILEGES ON DATABASE ma_db TO parcnational;
SQLAlchemy vous permettra de vous connecter à la base de données avec une URL de type :
postgresql://nom_utilisateur:mot_de_passe@host:port/db_name
Par exemple :
postgresql://parcnational:[email protected]:5432/ma_db
Il vous faudra créer un schema nommé utilisateurs qui contient toutes les tables nécessaires.
Utilisez le SQL maintenu dans le dépôt de UsersHub : https://github.com/PnX-SI/UsersHub/blob/master/data/usershub.sql
Pour l'éxécuter, il faut avoir ajouter l'extension UUID à votre base de données. Pour le faire en ligne de commande en tant que super-utilisateur de PotsgreSQL : sudo -n -u postgres -s psql -d $db_name -c 'CREATE EXTENSION IF NOT EXISTS "uuid-ossp";'.
Attention, les commandes qui suivent sont obsolètes, car le script SQL local a été supprimé du dépôt pour utiliser celui de UsersHub.
Ce module contient le SQL pour le faire dans le fichier db/schema.sql. Néanmoins une commande vous permet de le faire automatiquement :
python -m pypnusershub init_schema url_de_la_db
Exemple :
python -m pypnusershub init_schema postgresql://parcnational:[email protected]:5432/ma_db
python -m pypnusershub permet aussi de supprimer le schema (delete_schema), remettre à zéro (reset_schema) et charger des données de test (load_fixtures). Pour plus d'informations :
python -m pypnusershub --help
Please note that you can only load the fixtures once, as they have UNIQUE constraints.