update documentation

dbarzin · May 20, 2024 · 28d44e2 · 28d44e2
1 parent 5c0d333
commit 28d44e2
Show file tree

Hide file tree

Showing 18 changed files with 200 additions and 21 deletions.
diff --git a/INSTALL.fr.md b/INSTALL.fr.md
@@ -35,7 +35,7 @@ Créer les répertoires temporaires
     mkdir -p storage/framework/sessions
     mkdir -p bootstrap/cache
 
-Installer les packages avec composer 
+Installer les packages avec composer
 
     composer install
 
@@ -197,6 +197,8 @@ Envoyer un mail de test avec
 
     echo "Test mail body" | mailx -r "deming@yourdomain.local" -s "Subject Test" yourname@yourdomain.local
 
+N'oubliez pas de (configurer)[https://dbarzin.github.io/deming/config.fr/#notifications] le contenu et la fréquence d'envoi des mails.
+
 ## Sheduler
 
 Modifier le crontab

diff --git a/INSTALL.md b/INSTALL.md
@@ -194,6 +194,8 @@ Send a test mail with
 
     echo "Test mail body" | mailx -r "deming@yourdomain.local" -s "Subject Test" yourname@yourdomain.local
 
+Don't forget to (configure)[https://dbarzin.github.io/deming/config/#notifications] the content and frequency of your emails.
+
 ## Sheduler
 
 Modify crontab

diff --git a/docs/config.fr.md b/docs/config.fr.md
@@ -2,7 +2,7 @@
 
 ### Attributs <a name="tags"></a>
 
-Cet écran permet de gérer les attributs associés aux mesures de sécurité. 
+Cet écran permet de gérer les attributs associés aux mesures de sécurité.
 Il contient la liste des attributs et permet de créer, supprimer ou modifier des listes d’attributs.
 
 [<img src="/deming/images/tags.png" width="600">](/deming/images/tags.png)
@@ -21,12 +21,14 @@ Les utilisateurs sont définits dans l’application.
 
 [<img src="/deming/images/users.png" width="600">](/deming/images/users.png)
 
-Il existe trois roles :
+Il existe quatres roles différents :
 
 * RSSI : le RSSI est l’adminsitrateur de l’application. Il peut créer de nouvelles mesures, de nouveaux attributs, modifier des contrôles déjà réalisés...
 
 * Utilisateurs : les utilisateur peuvent utiliser l’application sans pouvoir modifier les mesures, les attributs et les contrôles déjà réalisés.
-
+
+* Audité : les audités ne peuvent réaliser et voir que les contrôles qui leur sont assignés ou qu'ils ont réalisé précédement.
+
 * Auditeur : l’auditeur a un accès en lecture à l’ensemble des informations de l’application.
 
 
@@ -37,7 +39,7 @@ L’application permet de générer le rapport de pilotage du SMSI et d’export
 [<img src="/deming/images/reports.png" width="500">](/deming/images/reports.png)
 
 
-Voici le rapport de pilotage du SMSI : 
+Voici le rapport de pilotage du SMSI :
 
 [<img src="/deming/images/report1.png" width="600">](/deming/images/report1.png)
 
@@ -81,4 +83,3 @@ Lorsque vous cliquer sur :
 * "Test" - un mail de test est envoyé à l'utilisateur courant ;
 
 * "Cancel" - vous revenez à la page principale.
-
diff --git a/docs/config.md b/docs/config.md
@@ -21,12 +21,14 @@ Users are directly defined in the application.
 
 [<img src="/deming/images/users.png" width="600">](/deming/images/users.png)
 
-There are three roles:
+There are four different roles:
 
 * RSSI: the RSSI is the administrator of the application. He can create new measurements, new attributes, modify controls already carried out...
 
 * Users: users can use the application without being able to modify the measurements, attributes and controls already carried out.
-
+
+* Auditee: Auditees can only carry out and see the mesurements that have been assigned to them or that they have carried out previously.
+
 * Auditor: the auditor has read access to all the information in the application.
 
 
@@ -79,5 +81,3 @@ When you click on:
 * "Test" - a test mail is sent to the current user;
 
 * "Cancel" - you return to the main page.
-
-
diff --git a/docs/delegation.fr.md b/docs/delegation.fr.md
@@ -0,0 +1,67 @@
+## Délégation
+
+Deming permet de déléguer la réalisation des contrôles de sécurité à des utilisateurs qui ont le rôle *audité*.
+L'assignation du rôle audité à un utilisateur se fait via l'écran de [gestion des utilisateurs](/deming/config/#users).
+
+Cette délégation respecte les règles suivantes :
+
+- Les audités sont informés régulièrement par mail des contrôles à réaliser ;
+- Les audités ne voient que les contrôles à réaliser et les contrôles qu'ils ont réalisés précédemment ;
+- Les utilisateurs peuvent accepter ou refuser un contrôle réalisé par un audité ;
+- Lorsqu'un contrôle est refusé, il retourne dans la liste des contrôles à réaliser de l'audité.
+
+
+### Liste des contrôles à réaliser
+
+Du point de revu de l'audité, la page principale de l'application contient la liste des contrôles qui sont assignés à l'utilisateur.
+
+[<img src="/deming/images/d1.fr.png" width="600">](/deming/images/d1.fr.png)
+
+L'audité peut :
+
+- Effectuer des recherches dans la liste des contrôles
+- Filtrer les contrôles par domaine, périmètre, attribut, période.
+- trier la liste par chacune des colonnes
+- sélectionner un contrôle à réaliser
+
+### Réaliser un contrôle
+
+Lorsqu'un audité réalise un contrôle, il peut :
+
+- sauver le contrôle
+
+- faire le contrôle
+
+[<img src="/deming/images/d2.fr.png" width="300">](/deming/images/d2.fr.png)
+
+Lorsqu'il clique sur :
+
+- "sauver", les modifications qu'il a faites sont sauvées, le contrôle reste dans la liste des contrôles à réaliser
+
+- "faire", les modifications qu'il a faite sont sauvées et le contrôle passe dans l'état à valider. Du point de vue de l'audité, le contrôle se trouve dans la liste des contrôles réalisés.
+
+- "annuler", les modifications ne sont pas sauvée, lutilisateur retourne vers la vue du contrôle.
+
+### Accepter / Refuser un contrôle
+
+Une fois qu'un contrôle a été réalisé par un audité, il passe dans l'état "à valider".
+
+Cela se matérialise par un sablier à côté de la date de réalisation dans la liste des contrôles à réaliser :
+
+[<img src="/deming/images/d3.fr.png" width="600">](/deming/images/d3.fr.png)
+'
+Lorsque l'utilisateur clique sur la date de réalisation à côté du sablier, il arrive sur le contrôle réalisé par l'audité.
+
+Il peut alors accepter ou refuser le contrôle en ajoutant une note dans les observations du contrôle et, selon les résultats du contrôle, proposer un plan d'action et une date de revue du contrôle.
+
+[<img src="/deming/images/d4.fr.png" width="600">](/deming/images/d4.fr.png)
+
+Si l'utilisateur clique sur :
+
+- "Accepter" : les données modifiées sont sauvées et un nouveau contrôle est créé à la date de planification introduite.
+
+- "Rejeté" : les données modifiées sont sauvées et le contrôle est renvoyé dans la liste des contrôles à réaliser de l'audité.
+
+- "Sauvé" : les données sont sauvées et l'utilisateur revient à la vue du contrôle.
+
+- "Annuler" : l'utilisateur revient à la vue du contrôle.
diff --git a/docs/delegation.md b/docs/delegation.md
@@ -0,0 +1,67 @@
+## Delegation
+
+Deming allows you to delegate the realisation of measurements to users who have the *auditee* role.
+The auditee role is assigned to a user via the [user management screen](/deming/config/#users).
+
+This delegation complies with the following rules:
+
+- Auditees are regularly informed by email of the measurements to be carried out;
+- Auditees only see the measurements to be carried out and the measurements they have previously carried out;
+- Users can accept or reject a measurement performed by an auditee;
+- When a measurement is rejected, it returns to the list of measurements to be carried out by the auditee.
+
+
+### List of measurements to be performed
+
+From the auditee's point of view, the application's main page contains the list of measurements that are assigned to the user.
+
+[<img src="/deming/images/d1.png" width="600">](/deming/images/d1.png)
+
+Tha auditee can :
+
+- Search the list of measurements
+- Filter measurements by domain, scope, attribute or period.
+- sort the list by each column
+- select a measurement to perform
+
+### Performing an measurement
+
+When an auditee performs an mesurement, they can :
+
+- "Save" the measurement
+
+- "Make" the mesurement
+
+[<img src="/deming/images/d2.png" width="300">](/deming/images/d2.png)
+
+When the auditee clicks on :
+
+- "Save", the changes made are saved and the measurement remains in the list of measurements to be performed
+
+- "Make", the changes made are saved and the measurement changes to the status to be validated. From the auditee's point of view, the measurement is in the list of measurements performed.
+
+- If the auditee selects "Cancel", the changes are not saved and the auditee returns to the measuremet view.
+
+### Accepting / Rejecting a measurement
+
+Once an measurement has been carried out by an auditee, it changes status to "to be validated".
+
+This is shown by an hourglass next to the completion date in the list of measurements to be carried out:
+
+[<img src="/deming/images/d3.png" width="600">](/deming/images/d3.png)
+
+When the user clicks on the date next to the hourglass, they are taken to the measurement performed by the auditee.
+
+They can then accept or reject the measurement, adding a note in the measurement observations and, depending on the measurement score, propose an action plan and anmeasurement review date.
+
+[<img src="/deming/images/d4.png" width="600">](/deming/images/d4.png)
+
+If the user clicks on :
+
+- "Accept": the modified data is saved and a new measurement is created on the planning date entered.
+
+- "Reject": the modified data is saved and the measurement is returned to the auditee list of controls to be performed.
+
+- "Save": the data is saved and the user returns to the measurement view.
+
+- "Cancel": the user returns to the measurement view.
diff --git a/docs/images/d1.fr.png b/docs/images/d1.fr.png
diff --git a/docs/images/d1.png b/docs/images/d1.png
diff --git a/docs/images/d2.fr.png b/docs/images/d2.fr.png
diff --git a/docs/images/d2.png b/docs/images/d2.png
diff --git a/docs/images/d3.fr.png b/docs/images/d3.fr.png
diff --git a/docs/images/d3.png b/docs/images/d3.png
diff --git a/docs/images/d4.fr.png b/docs/images/d4.fr.png
diff --git a/docs/images/d4.png b/docs/images/d4.png
diff --git a/docs/index.fr.md b/docs/index.fr.md
@@ -6,9 +6,9 @@
 Deming est un outil Open Source conçu pour aider les RSSI à mettre en place et à maintenir leur système de management de la sécurité de l'information. Grâce à cette application, les RSSI peuvent facilement planifier et suivre la mise en œuvre des contrôles de sécurité et le cycle d'amélioration continue requis par la norme ISO 27001. L'application est conçue pour être facile à utiliser et à personnaliser, avec une interface utilisateur intuitive.
 
 
-Deming offre des fonctionnalités telles que la [gestion des mesures de sécurité](/deming/measures.fr/), 
-la [planification des contrôles](/deming/plan.fr/), la création des [fiches de contrôle](/deming/controls.fr/#sheet), l’enregistrement des preuves, 
-le suivi [des plans d’action](/deming/actions.fr/) ainsi que des [tableaux de bord](/deming/dashboards.fr/) et 
+Deming offre des fonctionnalités telles que la [gestion des mesures de sécurité](/deming/measures.fr/),
+la [planification des contrôles](/deming/plan.fr/), la création des [fiches de contrôle](/deming/controls.fr/#sheet), l’enregistrement des preuves,
+le suivi [des plans d’action](/deming/actions.fr/) ainsi que des [tableaux de bord](/deming/dashboards.fr/) et
 des [rapports de pilotage du SMSI](/deming/config.fr/#report) pour aider les RSSI à suivre le maintient des mesures de sécurité de l'information.
 
 
@@ -19,11 +19,25 @@ Elle est également conçue pour aider les RSSI à préparer leur organisation a
 Cette application est publiée sous la licence [GPL](https://www.gnu.org/licenses/licenses.fr.html), permettant aux utilisateurs de l'utiliser, de la modifier et de la distribuer librement. Cette approche open source permet aux utilisateurs de contribuer au développement de l'application en soumettant des demandes de changement, des rapports de bogues ou des fonctionnalités supplémentaires.
 
 
-Cette application de gestion de la sécurité de l'information est un outil puissant et personnalisable pour les RSSI qui cherchent à mettre en place et à maintenir un système de management de la sécurité de l'information conforme à la norme ISO 27001. 
+Cette application de gestion de la sécurité de l'information est un outil puissant et personnalisable pour les RSSI qui cherchent à mettre en place et à maintenir un système de management de la sécurité de l'information conforme à la norme ISO 27001.
 
 
 Avec son interface utilisateur intuitive, la possibilité de définir de nouveaux contrôles et sa compatibilité ISO 27001:2022, elle offre aux RSSI une grande flexibilité pour adapter l'application à leurs besoins spécifiques.
 
+### Qu'est-ce qui n'est pas Deming ? <a name="notDeming"></a>
+
+Deming n'est pas une solution miracle qui réalise l'analyse des risques, importe toutes les normes existantes, gère automatiquement votre documentation, fournit des procédures par défaut ou utilise de l'intelligence artificielle de manière autonome...
+
+Mais :
+
+- elle n'est pas dans le nuage;
+
+- vous n'avez pas besoin de 5 jours de formation pour l'utiliser;
+
+- vous n'êtes pas contacté par une société de conseil et
+
+- elle est gratuite.
+
 
 ### Pourquoi contrôler ?
 

diff --git a/docs/index.md b/docs/index.md
@@ -25,6 +25,21 @@ This information security management application is a powerful and customizable
 With its intuitive user interface, the ability to define new controls and its ISO 27001:2022 compatibility, it offers CISOs great flexibility to adapt the application to their specific needs.
 
 
+### What is not Deming? <a name="notDeming"></a>
+
+Deming is not a miracle solution that performs risk analysis, imports all existing standards, automatically manages your documentation, provides default procedures or uses artificial intelligence autonomously...
+
+But :
+
+- it's not in the cloud ;
+
+- you don't need 5 days' training to use it ;
+
+- you are not contacted by a consultancy firm and
+
+- it's free.
+
+
 ### Why control?
 
 To manage the security of the information system, it is necessary to put in place a set of security measures and regularly check that these measures are effective and efficient. These regular checks make it possible to guarantee that the security measures put in place achieve their security objectives.
@@ -67,12 +82,11 @@ Deming helps meet these requirements and retain appropriate documented informati
 
 **Controls** : set of provisions to be implemented. These are the controls to be taken to implement the security policy.
 
-**Measurement**: process of obtaining relative to the effectiveness of an ISMS and security measures, using an evaluation method, 
+**Measurement**: process of obtaining relative to the effectiveness of an ISMS and security measures, using an evaluation method,
 a function assessment, analytical model, and decision criteria [ISO/IEC 27004].
 
-**Indicator**: result of the application of an analytical model to one or more variables in relation to the decision criteria or 
+**Indicator**: result of the application of an analytical model to one or more variables in relation to the decision criteria or
 an information need [ISO/IEC 27004].
 
-**Attribute**: property or characteristic of an object that can be quantitatively or qualitatively distinguished by human or 
+**Attribute**: property or characteristic of an object that can be quantitatively or qualitatively distinguished by human or
 automatic means [ISO/IEC 15939:2007].
-
diff --git a/docs/roles.fr.md b/docs/roles.fr.md
@@ -0,0 +1,11 @@
+## Roles
+
+Les utilisateurs peuvent avoir plusieurs rôles.
+
+| Rôles | Permissions   |
+| ---   | ----------- |
+| Administrateur |  |
+| Utilisateur | Peut effetuer des contrôles, créer de noue |
+| Audité | Peut |
+| Auditeur | Peut voir |
+| API | Peut accéder à l'API |
diff --git a/mkdocs.yaml b/mkdocs.yaml
@@ -11,12 +11,12 @@ edit_uri: edit/main/docs
 # Copyright
 copyright: Copyright <a href="https://www.gnu.org/licenses/licenses.en.html">GPL</a>.
 
-theme: 
+theme:
   name: readthedocs
 
 extra_css:
     - css/extra.css
-    
+
 plugins:
   - search
   - i18n:
@@ -46,6 +46,8 @@ nav:
 - Mesures : measures.fr.md
 - Measures : controls.md
 - Contrôles : controls.fr.md
+- Delegation : delegation.md
+- Délégation : delegation.fr.md
 - Planning : plan.md
 - Planning : plan.fr.md
 - Dashboards : dashboards.md
@@ -72,4 +74,3 @@ extra:
     - name: Français
       link: index.fr/
       lang: fr
-