cargo-vet ガイドファーストパーティのコード
ファーストパーティのコード
cargo vet は実行されると、cargo metadata サブコマンドを呼び出してクレートの
グラフを調べます。グラフをたどるとき、cargo vet は crates.io からのすべての依存に
対して監査を強制します。
一般に、グラフ内のそれ以外のノードはすべて信頼できるものとみなされ、監査の対象に なりません。これには、ルートのクレート、パス依存、git 依存、独自の(crates.io では ない)レジストリからの依存が含まれます。
しかし、ファーストパーティのコードとサードパーティのコードの境目があいまいになる
状況もあります。たとえば、[patch] テーブルを使って、crates.io のパッケージの中身を
手元で変更した版に置き換える場合です。置き換えるものは、一から書き直されることも
ありますが、多くの場合は元のものから派生しており、ときには 1 か所を変更しただけと
いうこともあります。使っているパッケージが依然として主にサードパーティのコードで
あるかぎり、ほかのものと同じように監査したいはずです。しかし cargo-vet には、
置き換えたものが派生物かどうかを機械的に確実に見分ける方法がありません。
正しく処理されるように、cargo-vet はこうしたあいまいな状況を検出し、どう扱いたいのかを
利用者に指定させます。具体的には、あるファーストパーティのクレートと同じ名前・同じ
バージョンの公開クレートが存在する場合、cargo-vet はそのクレートのポリシーの
エントリで audit-as-crates-io を true か false のどちらかに指定することを
求めます1。true に設定すると、cargo-vet は監査を強制します。
git 依存に対して有効にした場合、この強制は厳密に行われます。crates.io 上にある、
基準となる公開バージョンの監査が必要になり、さらに、その基準となるバージョンから、
ビルドのグラフで使われている特定の git コミットまでの差分監査が 1 つ以上必要に
なります。git コミットは、x.y.z@git:SHA という拡張構文で識別します。この表記は
差分監査にだけ使うことができ、差分監査は最も近い公開バージョンを基準にして行って
ください。こうすることで、監査の情報ができるかぎり公開バージョンを単位として
記録され、ほかの人が再利用しやすくなります。
パス依存に対して有効にした場合、この強制は厳密ではありません。cargo-vet には、
パッケージの実際の中身を一意に識別するためのハッシュがないからです。この場合は、
基準となる公開バージョンの監査だけが必要になります。こうしたクレートに対する監査は、
常に crates.io 上の元のバージョンに対応する、という点に注意してください。inspect と
certify が表示するのもそれですし、認定する前にレビューすべきものもそれです。
エコシステムのほかの人たちが、あなたの加えた変更を含まない元のクレートを使う際に、
あなたの監査を頼りにするかもしれないからです。
crates.io に公開されていないバージョンを持つパス依存に対して audit-as-crates-io を
有効にした場合、cargo-vet は代わりに、ローカルのバージョンより前の、最新の公開
バージョンの監査を求めます。これにより、すべての監査が crates.io 上のクレートに
対応するようになります2。そのローカルのバージョンが後から公開された場合は、
cargo vet が警告を出すので、監査を更新できます。
脚注
パッケージについて audit-as-crates-io の値を推測しようとし、推測した値が true に
なったパッケージに対して免除を生成します。現時点では、Cargo.toml の description
フィールドか repository フィールドのどちらかが空ではなく、crates.io 上の現在の値と
一致する場合に、true と推測します。この動作は、新しく追加した依存に対しても
cargo vet regenerate audit-as-crates-io で実行できますが、結果は自分で確認して
ください。
これにより、新しいバージョンが公開されても cargo vet が通り続けるようになります。
古くなった unpublished エントリは、cargo vet を通すのに必要でなくなった時点で
prune によって片づけられます。cargo vet regenerate unpublished で再生成する
こともできますが、その場合は cargo vet が失敗し始めることがあります。