Go と SHA256 によるファイルの整合性検証
Go でファイルを検証するには、sha256.New() に
io.Copy でバイト列をストリーミングし、信頼できるソースから取得したチェックサムとダイジェストを比較します。以下のコマンドラインプログラムは、ファイルのハッシュを出力することも、期待するハッシュと照合することもでき、検証に失敗すると非ゼロの終了ステータスを返します。
信頼できるチェックサムの取得
SHA256 は 256 ビット、つまり 32 バイトのダイジェストを生成します。通常は 64 文字の16進数で表記します。Go の標準ライブラリでは、crypto/sha256 から利用できます。ダイジェストが表すのはファイルのバイト列です。デジタル署名ではなく、ファイルを安全に実行できることを保証するものでもありません。
ダウンロードしたファイルの場合、期待するチェックサムは、配布元の信頼できる HTTPS ページ、または信頼できる鍵で署名を検証済みの署名付きマニフェストから取得します。ファイルと期待するチェックサムの両方を差し替えられる攻撃者は、照合を通過させられます。Apache のリリース検証ガイドでは、ハッシュの確認とリリースの真正性の確認との違いを説明しています。
SHA256 ファイル検証ツールの作成
Go のインストールとシェルが必要です。これらのコマンドは、Linux 上の Bash で Go 1.27.1 を使用してテストしました。プログラムは標準ライブラリのみを使うため、パッケージのダウンロードは不要です。単一ファイルのビルドなので、モジュールの設定も必要ありません。
新しい作業ディレクトリを作成します。このコマンドは既存のディレクトリの再利用を拒否するため、成功した場合にのみ先に進んでください。
mkdir sha256-example && cd sha256-example
そのディレクトリ内に、以下を main.go として保存します。
package main
import (
"bytes"
"crypto/sha256"
"encoding/hex"
"fmt"
"io"
"os"
)
func hashFile(path string) (sum []byte, err error) {
file, err := os.Open(path)
if err != nil {
return nil, err
}
defer func() {
if closeErr := file.Close(); closeErr != nil && err == nil {
sum, err = nil, closeErr
}
}()
hash := sha256.New()
if _, err := io.Copy(hash, file); err != nil {
return nil, err
}
return hash.Sum(nil), nil
}
func run(args []string) int {
if len(args) < 1 || len(args) > 2 {
fmt.Fprintln(os.Stderr, "Usage: sha256file FILE [EXPECTED_SHA256]")
return 2
}
var expected []byte
if len(args) == 2 {
var err error
expected, err = hex.DecodeString(args[1])
if err != nil || len(expected) != sha256.Size {
fmt.Fprintln(os.Stderr, "Expected SHA256 must be exactly 64 hexadecimal characters")
return 2
}
}
actual, err := hashFile(args[0])
if err != nil {
fmt.Fprintln(os.Stderr, "sha256file:", err)
return 2
}
if len(args) == 1 {
fmt.Printf("%x\n", actual)
return 0
}
if !bytes.Equal(actual, expected) {
fmt.Fprintf(os.Stderr, "FAIL: %q (SHA256 mismatch)\n", args[0])
return 1
}
fmt.Printf("OK: %q\n", args[0])
return 0
}
func main() {
os.Exit(run(os.Args[1:]))
}
os.Open は、入力を読み取り用に開きます。io.Copy は EOF またはエラーに達するまでファイルのバイト列をハッシュに渡し、hash.Sum(nil) はそのバイト列のダイジェストを返します。遅延実行されるクローズ処理は、読み取りエラーの場合も含め、hashFile が戻る前に実行されます。run が戻った後に初めて、main が os.Exit を呼び出します。そうしなければ、保留中の遅延呼び出しはスキップされてしまいます。
ファイルを読み取る前に、期待値をデコードし、必要な長さであることを確認します。デコードすることで、16進数チェックサムの大文字と小文字も同じ値として比較できます。この CLI は公開チェックサムを bytes.Equal で比較します。保護すべき秘密の比較値はありません。鍵付きメッセージ認証には、別途 HMAC を用いた設計と
hmac.Equal を使用してください。
同じディレクトリで実行ファイルをビルドします。再ビルドすると、sha256file という名前の既存の Go 実行ファイルが置き換えられます。そのパスが無関係なファイルに使われている場合は、別の出力名を選んでください。
go build -o sha256file main.go
ファイルの検証と終了ステータスの確認
末尾に改行を付けず、abc という三バイトだけを含む小さな入力を作成し、ハッシュを計算します。このコマンドは、作業ディレクトリ内の使い捨てファイル
example.txt を作成または上書きします。
printf 'abc' > example.txt && ./sha256file example.txt
出力は次のとおりです。
ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad
次に、その既知のチェックサムと照合します。
./sha256file example.txt ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad
プログラムはステータス 0 で終了し、次のように出力します。
OK: "example.txt"
この既知の入力は、仕組みを示すためのものです。実際のダウンロードでは、ファイルのパスと配布元の信頼できるチェックサムを渡してください。ダウンロードしたファイルから新たにチェックサムを計算し、それ自体と比較しても、整合性は確認できません。スペースを含むパスは引用符で囲んでください。第2引数に指定できるのは 64 文字のダイジェストだけです。ファイル名、sha256: 接頭辞、前後の空白は含めません。
サンプルの内容を置き換え、元のチェックサムと照合します。set -e を使用していない対話型 Bash シェルで、$? が検証ツールのステータスを直ちに取得できるよう、以下の行をまとめて実行してください。
printf 'changed\n' > example.txt &&
./sha256file example.txt ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad
printf 'Exit status: %s\n' "$?"
次のように表示されるはずです。
FAIL: "example.txt" (SHA256 mismatch)
Exit status: 1
検証ツールは失敗を標準エラー出力に、成功した結果を標準出力に送ります。終了コードに基づいて、スクリプトで処理を続けるかどうかを判断できます。
| ステータス | 意味 |
|---|---|
0 | ハッシュを出力、またはファイルが指定のチェックサムと一致 |
1 | ファイルの読み取りは成功したが、チェックサムが不一致 |
2 | 引数が無効、チェックサムの形式が不正、またはファイルのオープン・読み取り・クローズでエラー |
これらのコードを確認するときは、ビルド済みの実行ファイルを実行してください。go run は子プログラムの失敗を Go ツール経由で報告するため、正確な終了ステータスを保持しません。検証ツールは既存の入力を変更せずに開きます。ファイルが存在しない場合は、代わりのファイルを作成せずにその旨を報告します。
大容量ファイルのストリーミングと入力の固定
同じプログラムで、空のファイル、バイナリデータ、大容量アーカイブを扱えます。ファイルと同じ大きさのスライスを確保するのではなく、バイト列を順次処理します。ただし、すべてのバイトを読み取る必要はあるため、ストレージの速度とハッシュ計算のスループットが所要時間に影響します。この処理を常に最速にする万能なバッファーサイズはありません。io.Copy を独自のバッファリングに置き換える前に、実際のワークロードで測定してください。測定を繰り返す際は、ファイルシステムのキャッシュも考慮してください。
ハッシュを計算する前にファイルのダウンロードや書き込みを完了し、利用側が使用するまでは変更しないでください。このプログラムはファイルをロックせず、スナップショットも作成しません。照合の成功で確認できるのは、読み取ったバイト列です。その後に別のプロセスが変更することは防げません。
よくある落とし穴
不一致は破損を意味する場合もありますが、別のリリース、プラットフォーム、アーカイブ用のチェックサムを使った可能性もあります。配布元が指定するファイルそのもののハッシュを計算してください。アーカイブと展開後の内容では、ダイジェストが異なります。改行の追加や改行コードの変換でも、バイト列は変わります。
空のファイルにも有効な SHA256 ダイジェストがあり、読み取り失敗ではありません。ただし、空でないダウンロードファイルのチェックサムと照合すれば、検証は失敗します。途中で読み取りに失敗した場合、プログラムは部分的なダイジェストを比較せず、エラーを報告します。入力が存在しないかアクセスできない場合は、再試行の前にパスと権限を確認してください。I/O エラーからは、ファイルが一致するかどうかは判断できません。
