Partage de cookbooks au sein d'une équipe

Partager des cookbooks au sein d'une équipe

Lorsqu'un membre de l'équipe crée une recette Sensei pour améliorer la qualité du code ou la productivité, tout le monde peut en bénéficier si les cookbooks sont partagés.

Sensei propose plusieurs mécanismes pour partager les cookbooks :

• Stocker les cookbooks dans le projet sous contrôle de version
• Stocker les cookbooks dans un dossier partagé
• Stocker les cookbooks sur GitHub
• Fichiers compressés via HTTP(s)

En partageant les cookbooks, Sensei aide les équipes à collaborer et à partager leurs connaissances. Cette collaboration favorise la communication et permet d'ancrer les méthodes de qualité de code convenues.

Par exemple, le partage d'un cookbook :

• aide les membres de l'équipe à partager des recettes utiles entre eux.
• permet aux chefs d'équipe de codifier les pratiques de développement convenues, afin que les collaborateurs juniors puissent identifier les violations courantes et appliquer une correction rapide.
• favorise la coopération inter-équipes : par exemple, une équipe de sécurité applicative peut créer des recettes pour mettre en évidence un problème dans le code, tandis que l'équipe de développement peut rédiger la correction rapide.

Les sections suivantes expliquent comment mettre en œuvre chacun de ces mécanismes de partage.

Stocker les cookbooks dans le projet sous contrôle de version

Le dossier .sensei du projet est l'option par défaut lors de la création d'un fichier de cookbook.

• `project://.sensei`

Tous les cookbooks et recettes sont stockés dans un dossier .sensei au sein de votre projet.

L'approche la plus simple pour le partage consiste à ajouter le dossier .sensei du projet au contrôle de version.

Le dossier .sensei peut alors être géré comme n'importe quel autre artefact de code partagé associé au projet. Les cookbooks sont stockés sous forme de configuration YAML, ce qui facilite leur fusion lors des processus de commit et de revue.

C'est l'approche adoptée pour le projet public sensei-blog-examples.

• https://github.com/SecureCodeWarrior/sensei-blog-examples

Le dossier .sensei contient le cookbook avec toutes les recettes, lesquelles sont accessibles à toute personne clonant le dépôt.

Enregistrer les livres de recettes dans n'importe quel dossier

Les équipes peuvent également utiliser des livres de recettes stockés dans des emplacements centraux.

Enregistrer le livre de recettes dans un dossier disposant d'autorisations d'écriture partagées permettra à toute l'équipe de mettre à jour les recettes et de les importer dans n'importe quel projet sur lequel elle travaille.

L'emplacement doit être défini sur le chemin du répertoire.

Stocker les recettes sur Github

Sensei peut également accéder aux recettes stockées dans un dépôt Github. Les dépôts privés et publics sont pris en charge.

Github via SSH

L'accès au dépôt SSH est configuré en utilisant la syntaxe suivante pour l'emplacement

git@github.com:SecureCodeWarrior/acookbook.git

Pour que cela fonctionne, le dépôt doit contenir le contenu d'un dossier de livre de recettes.

Il est également possible de configurer la branche et le sous-dossier pour le livre de recettes, par exemple dans la branche master du sous-dossier cookbook

ex.

• git@github.com:SecureCodeWarrior/sensei-blog-examples.git|master|.sensei

Une clé SSH doit être configurée pour les dépôts privés.

• https://github.com/settings/keys

Et la clé ne doit pas avoir de phrase secrète.

Github via HTTPS

Il est également possible d'accéder aux dépôts publics via HTTPS, en utilisant la même syntaxe repo.git|branche|dossier, par exemple :

Pour notre projet d'exemples de blog :

• https://github.com/SecureCodeWarrior/sensei-blog-examples.git|master|.sensei

Pour notre ensemble d'exemples de protection de base, nous pouvons ignorer la branche et le sous-dossier car nous obtiendrons la branche master par défaut, et le fichier `rules.sensei` se trouve dans le dossier racine :

• https://github.com/SecureCodeWarrior/cookbook-basic-protection-set

Fichiers compressés via HTTP(s)

Sensei peut également accéder à des cookbooks compressés via HTTP ou HTTPS.

par exemple, si un serveur HTTP écoute localement sur le port 8000

• http://localhost:8000/rules.sensei.zip

Le fichier zip du cookbook doit contenir le contenu d'un dossier de cookbook, par exemple le fichier rules.sensei.

Résumé du partage

Sensei prend en charge l'utilisation de plusieurs cookbooks afin que chaque développeur puisse disposer de recettes favorisant son apprentissage et sa productivité.

Plus important encore, nous savons que les équipes sont plus efficaces lorsque les connaissances sont partagées. L'utilisation de dépôts d'équipe partagés, par exemple pour un projet spécifique, une bibliothèque particulière ou un ensemble de modèles de migration, permet d'accroître la productivité et de formaliser l'expérience de l'équipe.

Lorsqu'un cookbook est partagé, plusieurs équipes peuvent l'utiliser, ce qui améliore la collaboration entre les différentes disciplines, par exemple entre la sécurité applicative (AppSec) et le développement.

Avec quatre mécanismes de partage principaux, Sensei propose au moins une approche adaptée pour renforcer la collaboration et le partage des connaissances.

---

Vous pouvez installer Sensei depuis IntelliJ via « Préférences > Plugins » (Mac) ou « Paramètres > Plugins » (Windows), puis recherchez simplement « sensei secure code ».

Tout le code et les recettes des articles de blog Sensei sont disponibles sur Github à l'adresse suivante :

• https://github.com/SecureCodeWarrior/sensei-blog-examples