Cookbooks innerhalb eines Teams teilen

Cookbooks innerhalb eines Teams teilen

Wenn eine Person ein Sensei-Rezept zur Verbesserung der Codequalität oder Produktivität erstellt, kann das gesamte Team davon profitieren, sobald die Cookbooks geteilt werden.

Sensei bietet verschiedene Mechanismen zum Teilen von Cookbooks:

• Cookbooks im Projekt unter Versionskontrolle speichern
• Cookbooks in einem freigegebenen Ordner speichern
• Cookbooks in GitHub speichern
• Zipp-Dateien über HTTP(s)

Durch das Teilen von Cookbooks unterstützt Sensei Teams bei der gemeinsamen Wissensvermittlung. Diese Zusammenarbeit fördert die Kommunikation und verankert vereinbarte Ansätze zur Codequalität.

Das Teilen eines Cookbooks hilft zum Beispiel dabei:

• Teammitgliedern, nützliche Rezepte untereinander auszutauschen.
• Teamleitern, vereinbarte Programmierpraktiken für Junior-Mitarbeiter zu kodifizieren, um häufige Verstöße mit einer schnellen Lösung für die vereinbarte Version zu identifizieren.
• Die teamübergreifende Zusammenarbeit zu fördern, z. B. wenn ein AppSec-Team Rezepte erstellt, um ein Problem im Code aufzuzeigen, und das Entwicklungsteam die schnelle Lösung dazu schreibt.

Die nächsten Abschnitte erläutern, wie die einzelnen Freigabemechanismen implementiert werden.

Cookbooks im Projekt unter Versionskontrolle speichern

Der Projektordner .sensei ist die Standardoption beim Erstellen einer Cookbook-Datei.

• `project://.sensei`

Alle Cookbooks und Rezepte werden in einem .sensei-Ordner in Ihrem Projekt gespeichert.

Der einfachste Weg zum Teilen besteht darin, den .sensei-Projektordner zur Versionskontrolle hinzuzufügen.

Der .sensei-Ordner kann dann wie jedes andere gemeinsam genutzte Code-Artefakt des Projekts verwaltet werden. Die Cookbooks werden als YAML-Konfiguration gespeichert, wodurch sie bei jedem Commit- und Review-Prozess leicht zusammengeführt werden können.

Dies ist der Ansatz, der für das öffentliche Projekt sensei-blog-examples gewählt wurde.

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

Der .sensei-Ordner enthält das Cookbook mit allen Rezepten und ist für jeden verfügbar, der das Repository klont.

Cookbooks in beliebigen Ordnern speichern

Teams können auch Cookbooks verwenden, die an zentralen Orten gespeichert sind.

Wenn Sie das Cookbook in einem Ordner mit gemeinsamem Schreibzugriff speichern, kann das gesamte Team die Rezepte aktualisieren und in jedes beliebige Projekt importieren, an dem gerade gearbeitet wird.

Der Speicherort wird über den Verzeichnispfad festgelegt.

Rezepte in GitHub speichern

Sensei kann auch auf Rezepte zugreifen, die in einem GitHub-Repository gespeichert sind. Es werden sowohl private als auch öffentliche Repositories unterstützt.

GitHub über SSH

Der SSH-Repository-Zugriff wird für den Speicherort mit der folgenden Syntax konfiguriert:

git@github.com:SecureCodeWarrior/acookbook.git

Damit dies funktioniert, muss das Repository den Inhalt eines Cookbook-Ordners enthalten.

Es ist zudem möglich, den Branch und den Unterordner für das Cookbook zu konfigurieren, z. B. für den Master-Branch im Cookbook-Unterordner:

z. B.

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

Für private Repositories muss ein SSH-Schlüssel konfiguriert werden.

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

Der Schlüssel sollte zudem keine Passphrase besitzen.

GitHub über HTTPS

Es ist auch möglich, über HTTPS auf öffentliche Repositories zuzugreifen. Dabei wird dieselbe Syntax repo.git|branch|folder verwendet, z. B.:

Für unser Blog-Beispielprojekt:

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

Für unser Beispielset „Basic Protection“ können wir Branch und Unterordner ignorieren, da standardmäßig der Master-Branch verwendet wird und sich die Datei `rules.sensei` im Stammverzeichnis befindet:

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

Gezippt über HTTP(s)

Sensei kann auch auf gezippte Cookbooks zugreifen, die über HTTP oder HTTPS bereitgestellt werden.

z. B. wenn ein HTTP-Server lokal auf Port 8000 läuft

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

Die Zip-Datei des Cookbooks sollte den Inhalt eines Cookbook-Ordners enthalten, z. B. die Datei rules.sensei.

Zusammenfassung zur Freigabe

Sensei unterstützt die Verwendung mehrerer Cookbooks, sodass jeder Programmierer Rezepte nutzen kann, die das eigene Lernen und die Produktivität fördern.

Noch wichtiger ist, dass Teams am effektivsten arbeiten, wenn Wissen geteilt wird. Gemeinsam genutzte Team-Repositories, etwa für ein bestimmtes Projekt, eine Bibliothek oder für einheitliche Migrationsmuster, können die Produktivität steigern und die Erfahrung des Teams festigen.

Wenn ein Cookbook geteilt wird, können mehrere Teams dasselbe Cookbook verwenden, was auch die Zusammenarbeit zwischen verschiedenen Disziplinen, z. B. AppSec und Entwicklung, verbessern kann.

Mit vier verfügbaren Mechanismen zur Freigabe bietet Sensei hoffentlich mindestens einen Ansatz, mit dem Sie den Wissensaustausch in Ihrem Team fördern können.

---

Sie können Sensei direkt in IntelliJ installieren, indem Sie unter „Preferences \ Plugins“ (Mac) oder „Settings \ Plugins“ (Windows) einfach nach „sensei secure code“ suchen.

Sämtlicher Code und alle Rezepte aus den Sensei-Blogbeiträgen finden Sie auf Github unter:

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