【PHP8.x】MHASH_CRC32C定数の使い方

Copy
1<?php
2
3/**
4 * 指定された文字列のCRC32チェックサムを計算します。
5 *
6 * この関数は、PHPの標準関数である crc32() を使用して、
7 * 入力文字列の32ビットCRC (Cyclic Redundancy Check) チェックサムを生成します。
8 *
9 * @param string $data チェックサムを計算する文字列
10 * @return int 計算されたCRC32チェックサム
11 */
12function calculateStringCrc32(string $data): int
13{
14    // crc32() 関数は、入力文字列からCRC32チェックサムを生成します。
15    // PHPの整数は符号付きとして扱われるため、大きなCRC値は負の数として表示されることがあります。
16    // 常に符号なしの形式で表示したい場合は、sprintf('%u', $checksum) などを使用してください。
17    return crc32($data);
18}
19
20// サンプル文字列
21$sampleString = "Hello, PHP 8 and CRC32!";
22
23// CRC32チェックサムの計算
24$crc32Result = calculateStringCrc32($sampleString);
25
26// 結果の表示
27echo "元の文字列: " . $sampleString . PHP_EOL;
28echo "CRC32チェックサム (符号付き): " . $crc32Result . PHP_EOL;
29// 符号なし整数として表示する例
30echo "CRC32チェックサム (符号なし): " . sprintf('%u', $crc32Result) . PHP_EOL;

このPHPコードは、与えられた文字列のCRC32チェックサムを計算する方法を示しています。calculateStringCrc32 関数は、引数としてチェックサムを計算したい string 型のデータを受け取ります。この関数は内部でPHPの標準関数である crc32() を使用しており、入力された文字列から32ビットのCRC（Cyclic Redundancy Check）チェックサムを生成し、int 型で返します。

CRC32チェックサムは、データの破損を検出するために利用される値です。例えば、ファイルがダウンロードされた後にCRC32値を計算し、元の値と比較することで、ファイルが転送中に破損していないかを確認できます。

PHPの整数型は通常符号付きで扱われるため、crc32() 関数が返す大きなチェックサム値は負の数として表示されることがあります。サンプルコードでは、sprintf('%u', $checksum) のように %u フォーマット指定子を使うことで、常に符号なしの非負整数としてCRC32チェックサムを表示する方法も紹介しています。

PHPには MHASH_CRC32C という定数も存在しますが、これはCRC32Cアルゴリズムを示すもので、このサンプルコードで利用されている crc32() 関数とは異なる文脈で使われます。このコードは、データの整合性確認など、システム開発の様々な場面で役立つ基本的な機能を提供します。

Copy
1<?php
2
3/**
4 * MHASH_CRC32C定数を使用してデータをハッシュ化するサンプルコード。
5 *
6 * このコードは、PHP 8でmhash拡張が利用可能であると仮定して書かれています。
7 * 実際には、mhash拡張はPHP 7.0で削除されています。
8 * 以下の実装は、MHASH_CRC32C定数とmhash()関数の想定される使用方法を示し、
9 * PHP 8環境で実行できるよう、ダミーのmhash()関数と定数を定義しています。
10 * 実際のCRC32Cハッシュ計算には、PHPの標準関数である hash('crc32c', ...) を使用しています。
11 */
12
13// mhash拡張が存在しないPHP 8環境でコードが動作するように、
14// MHASH_CRC32C定数とmhash()関数を定義します。
15if (!function_exists('mhash')) {
16    // MHASH_CRC32C定数を定義 (mhash_get_algo_id('crc32c') に相当する値を仮定)
17    if (!defined('MHASH_CRC32C')) {
18        define('MHASH_CRC32C', 0x0000000C); // CRC32CのアルゴリズムIDを示す値
19    }
20
21    /**
22     * mhash()関数のダミー実装。
23     * 実際のmhash()関数はPHP 7.0で削除されました。
24     * このダミー関数はhash('crc32c', ...) を使って動作を模倣します。
25     *
26     * @param int $algo ハッシュアルゴリズムを示す定数 (例: MHASH_CRC32C)。
27     * @param string $data ハッシュ化する文字列データ。
28     * @return string|false ハッシュ値のバイナリ文字列、または失敗時にfalse。
29     */
30    function mhash(int $algo, string $data): string|false
31    {
32        // MHASH_CRC32Cが渡された場合、hash('crc32c')でCRC32Cハッシュを計算
33        if ($algo === MHASH_CRC32C) {
34            return hash('crc32c', $data, true); // trueでバイナリ形式のハッシュを返す
35        }
36        // 未知のアルゴリズムの場合、エラーを返す
37        return false;
38    }
39}
40
41
42/**
43 * MHASH_CRC32C定数を使用して文字列のCRC32Cハッシュを計算します。
44 *
45 * @param string $data ハッシュ化する文字列。
46 * @return string ハッシュ値の16進数表現、またはエラーメッセージ。
47 */
48function calculateCrc32cHash(string $data): string
49{
50    // mhash()関数とMHASH_CRC32C定数を用いてハッシュを計算します。
51    // mhash()はバイナリ文字列を返すため、bin2hex()で16進数に変換します。
52    $hashedData = mhash(MHASH_CRC32C, $data);
53
54    if ($hashedData === false) {
55        return "ハッシュ計算に失敗しました。";
56    }
57
58    return bin2hex($hashedData);
59}
60
61// サンプルデータ
62$sampleString = "システムエンジニアを目指す初心者のためのPHPサンプル";
63
64// CRC32Cハッシュ値を計算して表示
65echo "元の文字列: " . $sampleString . PHP_EOL;
66echo "CRC32Cハッシュ値 (MHASH_CRC32Cを使用): " . calculateCrc32cHash($sampleString) . PHP_EOL;
67

MHASH_CRC32Cは、かつてPHPのmhash拡張で利用されていた定数で、特定のハッシュアルゴリズムであるCRC32Cを指定するために使われました。この定数は、データが改ざんされていないかを確認する目的などで利用されるCRC32Cハッシュ値を計算する際に、mhash()関数に渡す引数として機能するものでした。

しかし、mhash拡張はPHP 7.0で削除されており、現在のPHP 8環境ではこの定数や関連する関数は標準では提供されていません。そのため、本サンプルコードでは、PHP 8で動作するよう、MHASH_CRC32C定数とmhash()関数を内部的に「ダミー」として定義しています。実際のCRC32Cハッシュ計算には、PHPの標準関数であるhash('crc32c', ...)が利用されています。

サンプルコードのcalculateCrc32cHash関数は、引数として受け取った文字列データ（$data）を、このダミーのmhash()関数とMHASH_CRC32C定数を用いてハッシュ化します。mhash()関数はハッシュ値をバイナリ形式で返すため、結果はbin2hex()関数で可読性の高い16進数文字列に変換され、最終的なハッシュ値として戻り値で返されます。これにより、初心者の方にも、データがハッシュ化され、その結果が表示される様子を理解していただけます。