cargo-vet ガイド監査エントリ
監査エントリ
この節では、監査のテーブルのエントリに指定できる各キーの意味を定義します。
version
この監査エントリが、ある 1 つの絶対的なバージョンに対応していて、そのバージョンの 全体が該当する基準について監査されたことを示します。
delta
この監査エントリが、2 つの絶対的なバージョンの間の差分について、該当する基準が 保たれていると認定するものであることを示します。差分は、バージョンの並びの中で 前向きにも後ろ向きにも取ることができます。
構文は version_a -> version_b で、version_a と version_b の間の差分が監査された
ことを表します。
なお、基準となるバージョンの一部も併せて調べなければ、差分がある性質を保っていると 結論づけられない場合があります。ここで求められる水準は、その性質が実際に保たれて いることであって、差分が明らかにはそれに違反していない、というだけでは足りません。 前者を認定できるだけの十分な文脈を把握することは、監査者の責任です。
violation
指定したバージョンが、関連づけられた基準を満たしていないことを示します。通常は バージョンの範囲を指定する必要があるので、このフィールドでは Cargo 標準の VersionReq 構文を使います。
あるクレートのバージョンに対して violation エントリが存在する場合、その依存が
exemptions テーブルに載っていても、cargo vet はその依存を拒否します。
criteria
この監査で対象とする基準を指定します。このフィールドは必須です。
who
監査者を識別する文字列です。cargo vet certify を実行すると、この値は git の設定を
もとに自動的に入力されます。
このフィールドは省略できますが、次の 2 つの理由から指定することをおすすめします。
- 誰が監査したのかがひと目で分かりやすくなります。リモートに置かれた監査ファイル では特に役立ちます。
- 監査を実施したことに自分が署名しているのだ、ということを、書いた本人に はっきり意識させます。
notes
監査者が記録しておきたい情報を書くための、自由形式の文字列です(省略可能)。