パッケージ

どのようなものか

パッケージは、ソフトウェアを作る人から実行するマシンへ届けるための形
です。アーカイブやディレクトリーにしたコードに、名前、バージョン、動
作に必要なものを記したマニフェストを添えます。英語の複数形はpackages
で、システムのドキュメントではソフトウェアパッケージとも呼びます。そ
の範囲はエコシステムごとに違います。npmでは、package.jsonで記述され
るファイルやディレクトリーがパッケージです。npmのドキュメントは、
Node.jsがrequire()かimportで読み込めるものをモジュールと呼んで区別
し、package.jsonを持つモジュールだけをパッケージとします。Pythonでは
同じ語を二つの意味で使い、Python
Packaging User
Guideはそれを区別します。インポートパッケージはコードがインポートす
るモジュールのディレクトリーで、配布パッケージは利用者がダウンロード
してインストールする、バージョン付きのアーカイブです。Rustでは、一つ
以上のcrateと、そのビルド方法を記したCargo.tomlをまとめます。Debian
では、システムがインストールして管理する.debファイル、バイナリーパッ
ケージが単位です。

パッケージは配布の単位であり、近い概念と比べると分かりやすくなりま
す。ライブラリーはコード、パッケージはその配り方です。一つのライブラ
リーを、npmパッケージ、Pythonのwheel、Debianパッケージとして同時に届
けられます。パッケージマネージャーは、マニフェストを読み、そこに挙げ
たものを取得して、全体が動作するような順序ですべてインストールするプ
ログラムです。npm、pip、Cargo、aptなどがあります。レジストリーやアー
カイブは、取得を待つパッケージの置き場所です。npmレジストリー、
PyPI、crates.io、Debianのミラーなどが該当します。言語用のパッケージ
マネージャーは、一つのプロジェクトのためにコードをインストールし、通
常はその隣のディレクトリーに置きます。システム用のものはマシン全体に
ソフトウェアを導入し、どのパッケージがどのファイルをどこに置いたかを
記録します。

なぜ重要なのか

第三者のコードをプロジェクトに取り込む方法は三つあります。パッケージ
マネージャーを使う、ライセンスとチェックサムを添えてリポジトリーにコ
ピーするvendoringを行う、ソースからビルドする、という方法です。通常
パッケージマネージャーが選ばれるのには理由があります。依存関係のツ
リー全体を解決し、一つのコマンドで更新し、インストールしたものを記録
します。代償は信頼です。プロジェクトは、そのツリーのすべてのマニフェ
ストと、取得元のすべてのレジストリーに依存します。vendoringは、その
信頼を作業に置き換えます。誰かが意図して新しい版をコピーしたときだ
け、取り込んだコードが変わるためです。ソースからのビルドは最も細かく
制御できますが、保守の手間も最大になります。

その得失の多くがマニフェストに表れます。通常は一つの版ではなく、バー
ジョンの範囲を指定します。npmの^10.0.1のようなキャレット付きの範囲
は、メジャーバージョンが同じ、それ以降のリリースを認めます。ファイル
を編集せず修正を受け取れる一方、一週間離れた二回のインストールで、異
なる依存関係ツリーができることもあります。この差を埋めるのがロック
ファイルです。npmは、後で同じツリーを再現できるよう、構築した正確な
ツリーをpackage-lock.jsonに書きます。Cargoは、全依存関係の正確なバー
ジョンをCargo.lockに書き、どちらもファイルをバージョン管理にコミット
することを前提とします。マニフェストは受け入れられるもの、ロックファ
イルは実際に受け取ったものを記録します。

マニフェストは、あるパッケージが別のものをどの程度必要とするかも示し
ます。Debian Policy
Manualは、その段階を定義します。Dependsは絶対的で、依存先のすべてが
設定されるまで、そのパッケージも設定されません。Recommendsは強い依存
ですが絶対ではなく、特殊な場合を除き、どのインストールでも一緒に使う
パッケージを指します。Suggestsは、あると便利になるパッケージを挙げ、
なくてもインストールとしては十分妥当です。推奨パッケージを省いたイン
ストールは有効でも、中のソフトウェアが、ある仕事にそれを必要とする場
合があります。

パッケージを分析するツールは、どれもメタデータを信頼します。ライセン
ス検査は宣言されたライセンスを読み、MIT OR
Apache-2.0のようなSPDX式を使うこともよくあります。ORは選択を認め、
ANDはすべてのライセンスを同時に満たすことを求めます。脆弱性スキャ
ナーは、宣言された名前と版を、公開された勧告と照合します。宣言が間違
うと、それを読むツールも同じように間違います。配布パッケージ内のライ
センスファイルを、別途読む価値があるのはそのためです。

実際の活用例

本番サーバーの強化レビューでは、侵入を遮断するjailが誰一人として遮断
していなかったことが分かり、独立した三つの原因の一つがパッケージ間の
関係でした。遮断処理が呼ぶパケットフィルタープログラムは、パッケージ
の定義では必須ではなく推奨で、サーバーには導入されていませんでした。
jailは起動し、ログイン失敗を数え、毎回遮断の判断に達しても、最後に遮
断を適用する段階で失敗していました。SSHの三つの防御を調べたレビュー
は、設定ファイルではなく稼働中のシステムを調べて発見しました。そし
て、すべてのセキュリティー制御を、コメントではなく自動化したアサー
ションで裏付ける規則を残しました。

出荷したアプリケーションにRustのコアをリンクすると、依存関係のグラフ
全体が製品に入ります。この例では644のcrateがあり、それぞれがライセン
スを宣言します。何層も下の依存先が、次の版でコピーレフトのライセンス
に変わっても、ほとんど読まれないロックファイルの一行だけが変化の痕跡
になるかもしれません。644のcrateのライセンス監査は、ビルドのたびに動
きます。各crateのライセンス式を許可リストに照らし、選択肢なら一つで
も許可されれば通し、組み合わせならすべてが許可されたときだけ通して、
合致しないものがあればビルドを止めます。検査が働くことを示すため、意
図的に二回失敗させました。一回はcrateのライセンス式を書き換え、もう
一回は監査を再生成せず、固定したコアのリビジョンを変えました。ページ
は限界も明記します。監査が読むのは間違うこともある宣言メタデータであ
り、法的助言ではありません。

自社のGitフォージは、OSが動かし続ける単一のプログラムとして、提供元
自身のパッケージ配布元からインストールしました。提供元のリポジトリー
をサーバーに加えること自体が、一つの判断です。それ以降、日常の更新
で、その提供元が公開して署名したものをインストールするからです。

このサイト自身は、動作にNodeを必要としません。package.jsonはprivate
にしてnpmに公開を拒否させ、キャレット付きのバージョン範囲で開発ツー
ルだけを列挙し、コミット済みのpackage-lock.jsonと並べています。
pyproject.tomlは、リンター、スペルチェッカー、型チェッカーを設定しま
すが、ビルドするパッケージを記述しないため、[project]や[build-
system]のテーブルもありません。アイコンはvendoringで取り込み、元のラ
イセンスと、各ファイルのSHA-256チェックサムを添えてコピーしていま
す。

問題が起きるところ

正常と報告する機能が、何もしていません

サービスは起動して稼働中とログに記録しながら、毎回、一つの仕事を黙っ
て省きます。呼び出すプログラムが推奨や提案のパッケージに属し、インス
トール時に省いてよいものだったためです。外部プログラムに依存する機能
では、起動時に存在を調べ、なければ明確なエラーで止めます。自分たちの
デプロイ定義では必須と宣言し、本番と同様に構築したサーバーで、機能を
エンドツーエンドで検査します。

同じマニフェストから、二台が違うコードをインストールします

プロジェクト自身のコードは変わらないのに、ノートパソコンではビルドが
通り、継続的インテグレーションでは失敗する、またはその逆が起きます。
マニフェストがバージョン範囲を指定し、ロックファイルをコミットしてお
らず、その二回の間に依存先が新しい版を公開したためです。ロックファイ
ルをコミットし、自動化ではnpm
ciやcargo build
i--lockedのように、ロックファイルの変更を拒むコマンドで、そこからイン		engineer.company	70
iストールします。更新は別の変更としてレビューします。		engineer.company	70

使い慣れた依存先のライセンスが変わります

去年ライセンスレビューを通った製品が、依存先の一覧は同じに見えるの
に、誰も同意していない条件でコードを出荷します。既存の依存先が版の間
でライセンスを変え、通常の更新がロックファイルを通じて新しい版を取り
込んだからです。ビルドのたびに、宣言されたライセンスを明示的な許可リ
ストで調べ、変化したその日に、ビルドを止めます。

参考資料

  * npmドキュメント：パッケージとモジュール —
npm自身によるパッケージの定義と、モジュールが必ずしもパッケージでは
ない理由です。

  * Debian Policy Manual：パッケージ間の関係の宣言 —
Depends、Recommends、Suggestsなどのフィールドと、それぞれに対する
パッケージマネージャーの処理です。

  * Python Packaging User Guide：pyproject.tomlの記述 —
pyproject.tomlの三つのテーブルと、Pythonの配布パッケージが宣言するメ
タデータです。

  * The Cargo Book：Cargo.tomlとCargo.lock —
マニフェストが受け入れ可能なものを記述し、ロックファイルが正確な版を
記録する理由と、コミットすべき時です。

  * SPDX仕様2.3.1：ライセンス式 — 一つのライセンス、複数からの選択、
同時に適用する組み合わせを宣言する構文です。

hこのページのウェブ版	URL:https://engineer.company/ja/glossary/package/	engineer.company	70
