RustSec Advisory Database の文書保守されていない crate の助言
手引き: 保守されていない crate の助言
この文書は、保守されていない(unmaintained)crate についての助言を RustSec Advisory Database に追加するときの方針を説明します。
これらの助言は、あるプロジェクトの中に保守されていない crate があることを Rust のコミュニティに知らせるとともに、保守されている代替への乗り換えを案内する役目を持ちます。
保守されていないかもしれない crate に向き合うときは、オープンソースのメンテナに対して無礼にふるまわないでください。保守されていない crate について RUSTSEC の助言を出すことを、オープンソースのメンテナに何かを強いるための武器として扱うべきではありません。
「保守されていない」crate の定義
次のどちらかに当てはまる crate を、保守されていないものと見なします。
- 明示的に保守されていない: crate の作者が、その crate をもう保守していないと宣言している。
- 暗黙的に保守されていない: 作者と長期間にわたって連絡が取れず、crate の状態について作者から話を聞けない。
保守されていない crate の助言を作る
方針
迷ったときは、連絡が取れる限り、保守されていない crate の助言を出してほしいかどうかについて、つねに crate の作者の判断に従います。
何よりもまず、作者に尋ねてください。できれば、プロジェクトのソースコードのリポジトリで、公開の issue として尋ねます。その crate の作者やメンテナが、保守されていない crate の助言を出すのは良い考えだと言うなら、それで結構です。進めてください。
作者から返答があり、プロジェクトは保守されていると宣言した場合、RustSec の組織はそれを保守されているものと見なし、保守状況についての助言は受け付けません。繰り返しますが、迷ったときは作者の判断に従います。作者から返答があり、crate は保守されていると明言している限り、その言葉を信じます。最近のコミット、未解決の issue、最新のリリースなどのリポジトリの指標は、crate の作者の直接の言葉に逆らう理由にはなりません。
一方で、crate の作者への連絡を試みて失敗した場合は、最近のコミット、未解決の issue、最後のリリースからの期間などの指標が、crate が保守されていないことを裏づける重要な証拠になります。crate への作業が続いている証拠があるなら、作者と連絡が取れないことは問題になりません。
crate の作者に連絡が取れない場合の「暗黙的に保守されていない」という状態を裏づけるには、次の基準を満たさなければなりません。
- 動きの無いリポジトリ: 最近の保守活動が無いこと。最近のコミット、未解決の issue への作者の返答、crate のリリース、そのほか作者による公に見える活動のいずれも無いことを含みます。1 年以上の不活動が、望ましい目安です。
- 作者への連絡を試み、返答が無かったこと。これらの連絡は、公開の GitHub issue で行うのが理想です。必要なときに、その issue を保守されていない crate の助言で引用できるからです。crate が保守されていないと見なされるには、最低でも、作者が 270 日間(脆弱性を知らされた後なら 60 日間)返答しないことが必要です。
手順
保守されていない crate の助言は、RustSec のセキュリティ助言と同じ構造を使いますが、TOML の助言に informational = "unmaintained" という属性を含めます。
助言を作るときは、助言の url = "..." フィールドに、保守状況が話し合われた上流プロジェクトのリポジトリの issue へのリンクを含めてください。
上流プロジェクトのリポジトリで issue が無効になっている場合や、上流の issue が事情を十分に説明していない場合は、advisory-db プロジェクトの issue にリンクする url = "..." を含めてください。
RustSec のデータベースに助言を追加する方法について、詳しくは助言を作るを見てください。
質問
GitHub の issue を開いてください。