cargo-vet 日本語訳 誤訳を知らせる
cargo-vet ガイド監査の集まりを整える
  1. 動機
  2. 仕組み
  3. チュートリアル
  4. インストール
  5. セットアップ
  6. 監査基準
  7. 監査のインポート
  8. 監査の記録
  9. 監査の実施
  10. 公開者を信頼する
  11. ポリシーの指定
  12. 複数のリポジトリ
  13. CI の設定
  14. 監査の集まりを整える
  15. リファレンス
  16. 設定
  17. 監査エントリ
  18. ワイルドカード監査エントリ
  19. 信頼エントリ
  20. 組み込みの基準
  21. ファーストパーティのコード
  22. よくある質問
  23. コマンド
  24. アルゴリズム

監査の集合を管理する

audits.toml のエントリは、どれも、あなたの組織のお墨付きを表します。それが何を意味するかは、最終的にはあなたが決めることです。ただし、ほかの人たちがあなたに寄せているかもしれない信頼と、その信頼が裏切られたときにあなたのブランドに及ぶ影響を、心に留めておくべきです。

この節では、cargo-vet のエコシステムに責任を持って参加するための、規範とベストプラクティスをいくつか紹介します。

監督と徹底

最も重要な手順は、supply-chain ディレクトリ(特に audits.toml)に、適切なアクセス制御をかけておくことです。少数のメンテナーがすべての変更をレビューする小さなプロジェクトであれば、リポジトリの通常の制御で十分かもしれません。しかし、メンテナーの数が増えるにつれて、audits.toml の重要性をよく知らない誰かが、適切な精査をせずに監査を承認してしまうリスクが高まります。

変更を承認できる人が 5 人を超えるプロジェクトでは、少人数のグループを指名して、監査の集合を監督させ、すべての提出が組織の基準を満たすようにすることをお勧めします(例)。 GitHub でホストされているプロジェクトでは、CODEOWNERS ファイルを使って、すべての提出がそのグループの一員によって承認されるようにできます。

提出を評価する

誰かが監査を提出したとき、その作業の中身を確かめる現実的な方法はありません。そのため、匿名のコントリビューターから提出されるコードがとても有益なことはよくありますが、監査のほうは、組織を代表する者として信頼できる、素性の分かっている個人からのものでなければなりません。そのような人は、問題を確実に見つけられる技術的な力量と、きちんと仕事をするプロ意識と、見つけたことを正直に伝える誠実さを備えているべきです。

よい判断の目安は、その人に、匿名のコントリビューターからのパッチを 1 人でレビューして受け入れることを任せられるかどうかです。最も単純な方法は、監査の提出を、そうした人たちだけに限ることです。ただし、その範囲を広げるのが妥当だと思える場合もあるでしょう。たとえば、円満に去った元メンテナーや、ほかの組織に所属していて、あなたと深い付き合いがあり、機会があれば迷わず仲間に迎えたいと思える人たちです。

自己認証

以上のことから自然に導かれるのは、組織が自分で公開したクレートを自分で認証することを、一律に禁じる決まりはないということです。監査の目的は、組織が自分で書いていないコードにまで、その組織のお墨付きを広げることです。自分で書いたコードは、既定でそのお墨付きを帯びており、そこにレビューの層をさらに重ねることは、監査の目的ではありません。

自己認証するクレートは、ファーストパーティのコードに対する組織自身の基準を満たしているべきです。それはたいてい、すべての行が適切なコードレビューを経ていることを意味します。この「別の人の目でも確かめる」という原則は重要ですが、この場面で cargo-vet が機械的に強制できるものではありません。将来、cargo-vet は、クレートが N 個の組織によって監査されていることを必須にする機能に対応するかもしれません。そうなれば、独立したレビューについて、より強い保証が得られるでしょう。

更新が頻繁なクレートでは、リリースを 1 つずつ自己認証するのは面倒な作業になりがちです。ワイルドカード監査の機能は、この問題に対処するために設計されたもので、組織は、指定した期間内に特定のアカウントが公開したクレートのリリースを、どれでも自己認証できるようになります。