django-modshib-CERTIC 0.2.7__tar.gz

django_modshib_certic-0.2.7/LICENSE.txt

@@ -0,0 +1,81 @@
+Copyright Université de Caen Normandie
+Esplanade de la paix
+CS 14032
+14032 Caen CEDEX 5
+
+Auteur : CERTIC Université de Caen Normandie
+
+Contributeurs :
+- Mickaël Desfrênes <mickael.desfrenes@unicaen.fr> 2023
+- Arnaud Daret <arnaud.daret@unicaen.fr> 2023
+
+Ce logiciel est un programme informatique servant à faciliter la gestion
+de l'authentification avec le module Apache mod_shib depuis Django.
+
+Ce logiciel est régi par la licence CeCILL-C soumise au droit français et
+respectant les principes de diffusion des logiciels libres. Vous pouvez
+utiliser, modifier et/ou redistribuer ce programme sous les conditions
+de la licence CeCILL-C telle que diffusée par le CEA, le CNRS et l'INRIA
+sur le site "http://www.cecill.info".
+
+En contrepartie de l'accessibilité au code source et des droits de copie,
+de modification et de redistribution accordés par cette licence, il n'est
+offert aux utilisateurs qu'une garantie limitée. Pour les mêmes raisons,
+seule une responsabilité restreinte pèse sur l'auteur du programme, le
+titulaire des droits patrimoniaux et les concédants successifs.
+
+A cet égard l'attention de l'utilisateur est attirée sur les risques
+associés au chargement, à l'utilisation, à la modification et/ou au
+développement et à la reproduction du logiciel par l'utilisateur étant
+donné sa spécificité de logiciel libre, qui peut le rendre complexe à
+manipuler et qui le réserve donc à des développeurs et des professionnels
+avertis possédant des connaissances informatiques approfondies. Les
+utilisateurs sont donc invités à charger et tester l'adéquation du
+logiciel à leurs besoins dans des conditions permettant d'assurer la
+sécurité de leurs systèmes et ou de leurs données et, plus généralement,
+à l'utiliser et l'exploiter dans les mêmes conditions de sécurité.
+
+Le fait que vous puissiez accéder à cet en-tête signifie que vous avez
+pris connaissance de la licence CeCILL-C, et que vous en avez accepté les
+termes.
+
+=========================================================================
+Copyright Université de Caen Normandie
+Esplanade de la paix
+CS 14032
+14032 Caen CEDEX 5
+
+Author: CERTIC Université de Caen Normandie
+
+Contributors:
+- Mickaël Desfrênes <mickael.desfrenes@unicaen.fr> 2023
+- Arnaud Daret <arnaud.daret@unicaen.fr> 2023
+
+This software is a computer program whose purpose is to facilitate
+authentication with Apache mod_shib from Django.
+
+This software is governed by the CeCILL-C license under French law and
+abiding by the rules of distribution of free software. You can use, 
+modify and/ or redistribute the software under the terms of the CeCILL-C
+license as circulated by CEA, CNRS and INRIA at the following URL
+"http://www.cecill.info". 
+
+As a counterpart to the access to the source code and rights to copy,
+modify and redistribute granted by the license, users are provided only
+with a limited warranty and the software's author, the holder of the
+economic rights, and the successive licensors have only limited
+liability. 
+
+In this respect, the user's attention is drawn to the risks associated
+with loading, using, modifying and/or developing or reproducing the
+software by the user in light of its specific status of free software,
+that may mean that it is complicated to manipulate, and that also
+therefore means that it is reserved for developers and experienced
+professionals having in-depth computer knowledge. Users are therefore
+encouraged to load and test the software's suitability as regards their
+requirements in conditions enabling the security of their systems and/or 
+data to be ensured and, more generally, to use and operate it in the 
+same conditions as regards security. 
+
+The fact that you are presently reading this means that you have had
+knowledge of the CeCILL-C license and that you accept its terms.

django_modshib_certic-0.2.7/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.1
+Name: django-modshib-CERTIC
+Version: 0.2.7
+Summary: Faciliter la gestion de l'authentification avec le module Apache mod_shib depuis Django
+Home-page: https://www.certic.unicaen.fr
+License: LICENSE.txt
+Author: Mickaël Desfrênes
+Author-email: mickael.desfrenes@unicaen.fr
+Requires-Python: >=3.9,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: Django (>=4.0)
+Requires-Dist: django-auth-cli-certic (>=0.1.3)
+Project-URL: Repository, https://git.unicaen.fr/certic/django-modshib
+Description-Content-Type: text/markdown
+
+# Django mod_shib
+
+Application Django destinée à faciliter la gestion de l'authentification avec mod_shib.
+Elle fournit une route (URL) devant être gérée par mod_shib, ainsi que des pages prêtes
+à l'emploi pour l'authentification.
+
+Distribué sous [Licence CeCILL-C](LICENSE.txt)
+
+## Avertissement
+
+Pour des raisons de sécurité, ne **jamais** installer cette application en production sans que la configuration du module
+Apache `mod_shib` n'ait été correctement réalisée en amont, particulièrement lorsque 
+les variables de configuration `MODSHIB_CREATE_ACCOUNT` et `MODSHIB_ACTIVATE_ACCOUNT` 
+valent vrai.
+
+## Pré-requis
+
+Cette application Django dépend de l'application `django.contrib.auth`. Il est également attendu que la variable
+`LOGIN_REDIRECT_URL` dans votre `settings.py` soit renseignée 
+(voir [documentation Django à ce sujet](https://docs.djangoproject.com/fr/4.2/ref/settings/#std-setting-LOGIN_REDIRECT_URL)).
+
+Un serveur Apache avec le module Shibboleth est requis. Voir à ce sujet [la documentation spécifique](https://git.unicaen.fr/certic/kics/-/blob/master/doc/INSTALL_shibboleth.md).
+
+## installation
+
+Installation via pip:
+
+    pip install django-modshib-certic
+
+Ou via poetry:
+
+    poetry add django-modshib-certic
+
+Puis ajouter `modshib.apps.ModshibConfig` dans le `settings.py` de votre projet Django:
+
+    INSTALLED_APPS = [
+        [...]
+        "modshib.apps.ModshibConfig",
+    ]
+
+Ainsi que la configuration des routes dans votre `urls.py`:
+
+    urlpatterns = [
+        [...]
+        path("modshib/", include("modshib.urls"))
+    ]
+
+L'URL pour modshib sera alors à `/modshib/sso`.
+
+Ajoutez également le contexte dans la configuration de vos gabarits :
+
+    TEMPLATES = [
+        {
+            [...]
+            "OPTIONS": {
+                "context_processors": [
+                    [...]
+                    "modshib.context_processors.modshib_context"
+                ],
+            },
+        },
+    ]
+
+## Configuration pour `settings.py`
+
+### `MODSHIB_CREATE_ACCOUNT`
+
+Valeur par défaut : `False`
+
+S'il n'existe pas déjà, crée un compte local (modèle `django.contrib.auth.models.User`)
+dont le `username` est l'EPPN fournit par `mod_shib`. 
+Le compte est créé sans mot de passe et est inactif par défaut.
+
+### `MODSHIB_ACTIVATE_ACCOUNT`
+
+Valeur par défaut : `False`
+
+Active le compte local s'il est trouvé (`User.is_active=True`).
+
+### `MODSHIB_EMAIL_IS_IDENTIFIER`
+
+Valeur par défaut : `False`
+
+L'email renvoyé par l'IDP est utilisé en remplacement de l'EPPN dans toutes les requêtes impliquant le `username` du
+modèle `django.contrib.auth.models.User`, ce qui inclut le login est la création de compte.
+
+### `MODSHIB_FORMS_TITLE`
+
+Valeur par défaut: `Authentification`
+
+Titre utilisé dans les formulaires de connexion/déconnexion.
+
+### `MODSHIB_STYLESHEET_URL`
+
+Valeur par défaut: `None`
+
+URL utilisée pour ajouter des styles CSS aux pages d'authentification
+
+### `MODSHIB_SHOW_SSO_LOGIN`
+
+Valeur par défaut: `True`
+
+Afficher ou non le formulaire de connexion via SSO
+
+### `MODSHIB_SHOW_LOCAL_LOGIN`
+
+Valeur par défaut: `True`
+
+Afficher ou non le formulaire de connexion locale
+
+### `MODSHIB_SSO_SUBMIT_LABEL`
+
+Valeur par défaut: `Connexion via SSO`
+
+Texte du bouton de connexion via SSO
+
+### `MODSHIB_LOCAL_SUBMIT_LABEL`
+
+Valeur par défaut: `Connexion avec mot de passe`
+
+Texte du bouton de connexion locale
+
+### `APP_URL_BASE_PATH`
+
+Valeur par défaut: `/`
+
+Préfixe utilisé pour déployer l'application

django_modshib_certic-0.2.7/README.md

@@ -0,0 +1,127 @@
+# Django mod_shib
+
+Application Django destinée à faciliter la gestion de l'authentification avec mod_shib.
+Elle fournit une route (URL) devant être gérée par mod_shib, ainsi que des pages prêtes
+à l'emploi pour l'authentification.
+
+Distribué sous [Licence CeCILL-C](LICENSE.txt)
+
+## Avertissement
+
+Pour des raisons de sécurité, ne **jamais** installer cette application en production sans que la configuration du module
+Apache `mod_shib` n'ait été correctement réalisée en amont, particulièrement lorsque 
+les variables de configuration `MODSHIB_CREATE_ACCOUNT` et `MODSHIB_ACTIVATE_ACCOUNT` 
+valent vrai.
+
+## Pré-requis
+
+Cette application Django dépend de l'application `django.contrib.auth`. Il est également attendu que la variable
+`LOGIN_REDIRECT_URL` dans votre `settings.py` soit renseignée 
+(voir [documentation Django à ce sujet](https://docs.djangoproject.com/fr/4.2/ref/settings/#std-setting-LOGIN_REDIRECT_URL)).
+
+Un serveur Apache avec le module Shibboleth est requis. Voir à ce sujet [la documentation spécifique](https://git.unicaen.fr/certic/kics/-/blob/master/doc/INSTALL_shibboleth.md).
+
+## installation
+
+Installation via pip:
+
+    pip install django-modshib-certic
+
+Ou via poetry:
+
+    poetry add django-modshib-certic
+
+Puis ajouter `modshib.apps.ModshibConfig` dans le `settings.py` de votre projet Django:
+
+    INSTALLED_APPS = [
+        [...]
+        "modshib.apps.ModshibConfig",
+    ]
+
+Ainsi que la configuration des routes dans votre `urls.py`:
+
+    urlpatterns = [
+        [...]
+        path("modshib/", include("modshib.urls"))
+    ]
+
+L'URL pour modshib sera alors à `/modshib/sso`.
+
+Ajoutez également le contexte dans la configuration de vos gabarits :
+
+    TEMPLATES = [
+        {
+            [...]
+            "OPTIONS": {
+                "context_processors": [
+                    [...]
+                    "modshib.context_processors.modshib_context"
+                ],
+            },
+        },
+    ]
+
+## Configuration pour `settings.py`
+
+### `MODSHIB_CREATE_ACCOUNT`
+
+Valeur par défaut : `False`
+
+S'il n'existe pas déjà, crée un compte local (modèle `django.contrib.auth.models.User`)
+dont le `username` est l'EPPN fournit par `mod_shib`. 
+Le compte est créé sans mot de passe et est inactif par défaut.
+
+### `MODSHIB_ACTIVATE_ACCOUNT`
+
+Valeur par défaut : `False`
+
+Active le compte local s'il est trouvé (`User.is_active=True`).
+
+### `MODSHIB_EMAIL_IS_IDENTIFIER`
+
+Valeur par défaut : `False`
+
+L'email renvoyé par l'IDP est utilisé en remplacement de l'EPPN dans toutes les requêtes impliquant le `username` du
+modèle `django.contrib.auth.models.User`, ce qui inclut le login est la création de compte.
+
+### `MODSHIB_FORMS_TITLE`
+
+Valeur par défaut: `Authentification`
+
+Titre utilisé dans les formulaires de connexion/déconnexion.
+
+### `MODSHIB_STYLESHEET_URL`
+
+Valeur par défaut: `None`
+
+URL utilisée pour ajouter des styles CSS aux pages d'authentification
+
+### `MODSHIB_SHOW_SSO_LOGIN`
+
+Valeur par défaut: `True`
+
+Afficher ou non le formulaire de connexion via SSO
+
+### `MODSHIB_SHOW_LOCAL_LOGIN`
+
+Valeur par défaut: `True`
+
+Afficher ou non le formulaire de connexion locale
+
+### `MODSHIB_SSO_SUBMIT_LABEL`
+
+Valeur par défaut: `Connexion via SSO`
+
+Texte du bouton de connexion via SSO
+
+### `MODSHIB_LOCAL_SUBMIT_LABEL`
+
+Valeur par défaut: `Connexion avec mot de passe`
+
+Texte du bouton de connexion locale
+
+### `APP_URL_BASE_PATH`
+
+Valeur par défaut: `/`
+
+Préfixe utilisé pour déployer l'application

django_modshib_certic-0.2.7/modshib/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

django_modshib_certic-0.2.7/modshib/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class ModshibConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "modshib"

django_modshib_certic-0.2.7/modshib/context_processors.py

@@ -0,0 +1,22 @@
+from django.conf import settings
+
+_default_conf = {
+    "MODSHIB_FORMS_TITLE": "Authentification",
+    "MODSHIB_STYLESHEET_URL": None,
+    "MODSHIB_SHOW_SSO_LOGIN": True,
+    "MODSHIB_SHOW_LOCAL_LOGIN": True,
+    "MODSHIB_SSO_SUBMIT_LABEL": "Connexion via SSO",
+    "MODSHIB_LOCAL_SUBMIT_LABEL": "Connexion avec mot de passe",
+    "APP_URL_BASE_PATH": "/",
+}
+
+for k in _default_conf.keys():
+    try:
+        val = getattr(settings, k)
+        _default_conf[k] = val
+    except AttributeError:
+        continue
+
+
+def modshib_context(request):
+    return _default_conf

django_modshib_certic-0.2.7/modshib/models.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.