在团队内共享 Cookbook

在团队内共享食谱

当团队成员创建 Sensei 配方以提升代码质量或工作效率时，通过共享食谱，团队中的每个人都能从中受益。

Sensei 提供了多种共享食谱的机制：

• 将食谱存储在版本控制下的项目中
• 将食谱存储在共享文件夹中
• 将食谱存储在 Github 中
• 通过 HTTP(s) 传输压缩文件

通过共享食谱，Sensei 能够帮助团队协作共享知识。这种协作有助于加强沟通，并落实团队商定的代码质量标准。

例如，共享食谱可以：

• 帮助团队成员相互分享实用的配方。
• 支持团队负责人将商定的编码规范标准化，帮助初级员工识别常见违规行为，并提供针对性的快速修复方案。
• 促进跨团队合作，例如应用安全团队可以创建配方来突出代码中的问题，而开发团队则可以编写相应的快速修复程序。

接下来的几个部分将介绍如何实现每种共享机制。

将食谱存储在版本控制下的项目中

创建食谱文件时，项目中的 .sensei 文件夹是默认选项。

• `project://.sensei`

所有食谱和配方都将存储在项目中的 .sensei 文件夹内。

最简单的共享方法是将项目中的 .sensei 文件夹添加到版本控制中。

这样，.sensei 文件夹就可以像项目中任何其他共享代码工件一样进行管理。食谱以 YAML 配置格式存储，便于在提交和审查过程中进行合并。

公开的 sensei-blog-examples 项目就采用了这种方法。

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

.sensei 文件夹中包含了带有所有配方的食谱，任何克隆该仓库的人都可以使用它们。

将 Cookbook 存储在任意文件夹中

团队也可以使用存储在中央位置的 Cookbook。

将 Cookbook 保存到具有共享写入权限的任意文件夹中，整个团队便可以更新其中的方案，并将其导入到他们正在处理的任何项目中。

该位置应设置为目录路径。

将方案存储在 Github 中

Sensei 还可以访问存储在 Github 仓库中的方案。支持私有和公共仓库。

通过 SSH 使用 Github

SSH 仓库访问权限通过以下“位置”语法进行配置

git@github.com:SecureCodeWarrior/acookbook.git

要使其生效，仓库中必须包含 Cookbook 文件夹的内容。

也可以为 Cookbook 配置分支和子文件夹，例如在 master 分支的 cookbook 子文件夹中

例如：

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

私有仓库需要配置 SSH 密钥。

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

且该密钥不应设置密码短语。

通过 HTTPS 使用 Github

也可以通过 HTTPS 访问公共仓库，并使用相同的 repo.git|branch|folder 语法，例如：

对于我们的博客示例项目：

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

对于我们的基础保护示例集，我们可以忽略分支和子文件夹，因为默认会获取 master 分支，且 `rules.sensei` 文件位于根文件夹中：

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

通过 HTTP(s) 传输的压缩包

Sensei 也可以访问通过 HTTP 或 HTTPS 传输的压缩格式的 cookbook。

例如，如果我在本地 8000 端口运行了一个 HTTP 服务器

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

压缩后的 cookbook 文件应包含 cookbook 文件夹的内容，例如 rules.sensei 文件。

共享总结

Sensei 支持使用多个 cookbook，以便程序员能够拥有辅助个人学习和提升工作效率的配方。

更重要的是，我们深知团队在知识共享时效率最高。拥有共享的团队存储库（例如针对特定项目、特定库或一组共享的迁移模式）有助于提高团队生产力并固化团队经验。

当共享 cookbook 时，多个团队可以使用同一个 cookbook，这也有助于改善不同职能部门（如应用安全团队与开发团队）之间的协作。

Sensei 提供了四种核心共享机制，希望能为您提供至少一种能够加强知识共享协作的方法。

---

您可以在 IntelliJ 中安装 Sensei：Mac 用户请进入“Preferences \ Plugins”，Windows 用户请进入“Settings \ Plugins”，然后搜索“sensei secure code”即可。

所有 Sensei 博客文章的代码和配方均可在 Github 上找到：

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