cargo-vet ガイドワイルドカード監査エントリ
ワイルドカード監査エントリ
ワイルドカード監査は特別な種類の監査で、自分たちのクレートを
自己認定する組織のための
便利な仕組みとして用意されています。この機能を使うと、組織は、特定のアカウントが
公開したすべてのバージョンに適用される監査を公開できます。そのため、パッケージの
新しいバージョンが出るたびに audits.toml へ新しいエントリを追加する必要が
なくなります。
ワイルドカード監査は audits.toml の先頭に置かれ、次のような形をしています。
[[wildcard-audits.foo]]
who = ...
criteria = ...
user-id = ...
start = ...
end = ...
renew = ...
notes = ...
通常の監査は、クレートの中身が基準を満たしていることをその人が確認した、と認定する ものです。これに対してワイルドカード監査は、指定されたアカウントが公開するその クレートの どの バージョンも基準を満たす、と認定するものです。実質的には、 リリースの工程全体が健全であることを、書いた本人が保証していることになります。 つまり、リリースは必ず、基準を守らせる信頼できる人物がすべての変更を承認した ブランチから切り出される、ということです。
ワイルドカード監査は、cargo vet certify に --wildcard オプションを付けて追加
できます。既定では、end の日付は 1 年後に設定されます。いったん追加すれば
(手作業で追加した場合も、cargo vet certify --wildcard で追加した場合も)、
cargo vet renew CRATE コマンドで end の日付を 1 年後に更新できます。
cargo vet renew --expiring を使うと、今後 6 週間以内に期限が切れるか、すでに期限が
切れていて、かつ renew = false が指定されていない すべての 監査を自動的に
更新できます。
user-id
公開したバージョンを監査の対象とするユーザーの、crates.io のユーザー ID を
指定します。残念ながらこの ID は crates.io のウェブサイトには表示されませんが、
cargo vet certify --wildcard $USER コマンドを使えば、ユーザー名をもとに自動的に
入力されます。このフィールドは必須です。
start
ワイルドカード監査によって認定されたものとみなす、最も早い公開日です。この日付より 前にそのユーザーが公開したクレートは、認定されたものとはみなされません。この フィールドは必須です。
なお、公開日は現地時間ではなく UTC で扱われます。
end
ワイルドカード監査によって認定されたものとみなす、最も遅い公開日です。この日付より 後にそのユーザーが公開したクレートは、認定されたものとはみなされません。この日付は、 最大で 1 年先まで指定できます。このフィールドは必須です。
なお、公開日は現地時間ではなく UTC で扱われます。
renew
end の日付が今後 6 週間以内に期限切れになる(またはすでに期限が切れている)場合に、
cargo vet check がこの監査の更新を提案するかどうか、また
cargo vet renew --expiring がこの監査を更新するかどうかを指定します。
criteria
このワイルドカード監査で対象とする基準を指定します。このフィールドは必須です。
who
監査者を識別する文字列です。cargo vet certify を実行すると、この値は git の設定を
もとに自動的に入力されます。
詳しくは、監査エントリのドキュメントを参照してください。
なお、who のユーザーは、user-id で指定した crates.io のユーザーと違っていても
かまいませんが、基本的には同一人物であるか、近い関係にある人(たとえば、共有の
公開用アカウントを認定するチームリーダー)であるべきです。
notes
監査者が記録しておきたい情報を書くための、自由形式の文字列です(省略可能)。