【PHP8.x】hex2bin関数の使い方
hex2bin関数の使い方について、初心者にもわかりやすく解説します。
基本的な使い方
hex2bin関数は、16進数で表現された文字列を、元のバイナリデータに変換する処理を実行する関数です。この関数は、引数として受け取った16進数文字列を2文字ずつ解釈し、それぞれに対応する1バイトのバイナリデータに変換します。変換に成功した場合、結果として得られたバイナリデータを文字列として返します。しかし、入力文字列の文字数が奇数であったり、16進数として不正な文字(0-9、a-f、A-F以外)が含まれていたりすると、変換は失敗し、falseを返します。なお、入力文字列に含まれる空白文字(スペース、タブ、改行など)は、変換処理の前に無視されるため、整形された16進数文字列もそのまま扱うことが可能です。この関数は、バイナリデータを16進数文字列に変換するbin2hex()関数と対になるもので、エンコードされたデータを元に戻すといった用途で広く利用されます。例えば、"48656c6c6f20576f726c64" という文字列を渡すと、"Hello World" という結果が得られます。
構文(syntax)
1<?php 2 3// 16進数で表現された文字列 4$hex_string = "48656c6c6f20576f726c64"; 5 6// 16進数文字列をバイナリデータ(通常の文字列)に変換する 7$binary_data = hex2bin($hex_string); 8 9// 変換後のバイナリデータを出力する 10// 出力結果: string(11) "Hello World" 11var_dump($binary_data); 12 13?>
引数(parameters)
string $string
- string $string: 16進数表現された文字列
戻り値(return)
string|false
16進数形式の文字列をバイナリ形式の文字列に変換した結果、または変換に失敗した場合はfalseを返します。
サンプルコード
PHP hex2bin オンラインコンバーター
1<?php 2declare(strict_types=1); 3 4/** 5 * このスクリプトは、Webフォーム経由で送信された16進数文字列を 6 * PHPの `hex2bin` 関数を使用して通常の文字列に変換するオンラインツールです。 7 * 8 * 使い方: 9 * 1. このファイルをWebサーバーのドキュメントルートに配置します。 10 * 2. Webブラウザでこのファイルにアクセスします。 11 * 3. フォームに16進数文字列を入力して「変換」ボタンを押します。 12 * 13 * 例: 14 * 入力: 706870206865783262696e206f6e6c696e65 15 * 出力: php hex2bin online 16 */ 17 18// 出力する結果、エラーメッセージ、およびユーザーの入力値を初期化 19$convertedString = ''; 20$errorMessage = ''; 21$inputHex = ''; 22 23// HTTPリクエストがPOSTメソッドの場合のみ処理を実行 24if ($_SERVER['REQUEST_METHOD'] === 'POST') { 25 // POSTされた16進数文字列を取得 26 $inputHex = $_POST['hex_string'] ?? ''; 27 28 // 入力文字列の前後の空白を削除 29 $trimmedHex = trim($inputHex); 30 31 if ($trimmedHex !== '') { 32 // hex2bin()は不正な入力(奇数長の文字列、16進数以外の文字)で警告を発生させます。 33 // @演算子で警告を抑制し、戻り値がfalseかどうかで成否を判断するのが一般的です。 34 $binaryData = @hex2bin($trimmedHex); 35 36 if ($binaryData === false) { 37 // 変換に失敗した場合 38 $errorMessage = '無効な16進数文字列です。文字列の長さが偶数であること、0-9とa-fの文字のみで構成されていることを確認してください。'; 39 } else { 40 // 変換に成功した場合、XSS対策のためHTMLエンティティに変換して格納 41 $convertedString = htmlspecialchars($binaryData, ENT_QUOTES, 'UTF-8'); 42 } 43 } else { 44 // 入力が空の場合 45 $errorMessage = '16進数文字列が入力されていません。'; 46 } 47} 48?> 49<!DOCTYPE html> 50<html lang="ja"> 51<head> 52 <meta charset="UTF-8"> 53 <title>PHP hex2bin Online Converter</title> 54 <style> 55 body { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif; background-color: #f4f4f9; color: #333; margin: 0; padding: 2rem; } 56 .container { max-width: 700px; margin: auto; background-color: #fff; padding: 2rem; border-radius: 8px; box-shadow: 0 2px 10px rgba(0,0,0,0.1); } 57 h1 { color: #333; } 58 form { margin-top: 1.5rem; } 59 label { display: block; font-weight: bold; margin-bottom: 0.5rem; } 60 input[type="text"] { width: 100%; padding: 0.75rem; border: 1px solid #ddd; border-radius: 4px; font-size: 1rem; box-sizing: border-box; } 61 input[type="submit"] { display: block; width: 100%; padding: 0.75rem; margin-top: 1rem; background-color: #007bff; color: white; border: none; border-radius: 4px; font-size: 1rem; cursor: pointer; } 62 input[type="submit"]:hover { background-color: #0056b3; } 63 .output { margin-top: 1.5rem; } 64 .error { background-color: #f8d7da; color: #721c24; padding: 1rem; border: 1px solid #f5c6cb; border-radius: 4px; } 65 .result { background-color: #e2e3e5; padding: 1rem; border-radius: 4px; white-space: pre-wrap; word-wrap: break-word; font-family: "Courier New", Courier, monospace; } 66 </style> 67</head> 68<body> 69 <div class="container"> 70 <h1>PHP <code>hex2bin()</code> オンラインコンバーター</h1> 71 <p>16進数でエンコードされた文字列を、元のバイナリデータ(文字列)に変換します。</p> 72 73 <form action="<?= htmlspecialchars($_SERVER['PHP_SELF'], ENT_QUOTES, 'UTF-8') ?>" method="POST"> 74 <div> 75 <label for="hex_string">16進数文字列:</label> 76 <input type="text" id="hex_string" name="hex_string" value="<?= htmlspecialchars($inputHex, ENT_QUOTES, 'UTF-8') ?>" placeholder="例: 706870206865783262696e206f6e6c696e65"> 77 </div> 78 <input type="submit" value="変換する"> 79 </form> 80 81 <div class="output"> 82 <?php if ($errorMessage !== ''): ?> 83 <p class="error"><?= $errorMessage ?></p> 84 <?php endif; ?> 85 86 <?php if ($convertedString !== ''): ?> 87 <h2>変換結果:</h2> 88 <pre class="result"><?= $convertedString ?></pre> 89 <?php endif; ?> 90 </div> 91 </div> 92</body> 93</html>
PHPのhex2bin関数は、16進数で表現された文字列を、元のバイナリデータ(通常の文字列)に変換するために使用されます。この関数は、string $stringという引数を受け取り、変換したい16進数文字列を指定します。例えば、「706870」という16進数文字列を渡すと、「php」という通常の文字列に変換されるといった具合です。関数の実行が成功した場合、string型の変換済み文字列が戻り値として返されますが、入力が不正である(例えば、文字列の長さが奇数である、または16進数以外の文字が含まれる)場合には、falseが戻り値として返されます。
提供されたサンプルコードは、このhex2bin関数を利用したオンラインコンバーターの例です。Webフォームを通じてユーザーが入力した16進数文字列をhex2binで変換し、その結果を表示します。POSTメソッドで送信された入力を受け取り、入力値が空でないことを確認した後、hex2bin関数で変換を試みます。変換に失敗しfalseが返された場合には、エラーメッセージを表示してユーザーに適切な入力を促すよう処理されています。また、変換された結果を出力する際には、htmlspecialchars関数を用いてXSS(クロスサイトスクリプティング)などのセキュリティ上のリスクを低減する処理も行っています。このように、hex2bin関数はデータのエンコード解除に広く利用され、セキュリティも考慮した実践的なプログラミングの例として理解できます。
hex2bin関数は、引数の文字列長が奇数であったり、16進数以外の文字が含まれていたりすると変換に失敗します。その際、この関数は警告を発生させfalseを返すため、サンプルコードのように@演算子で警告を抑制し、戻り値がfalseかどうかを厳密な比較===で判定するのが安全なエラー処理の方法です。最も重要な点はセキュリティ対策です。ユーザーの入力を元に変換した文字列には、悪意のあるスクリプトが含まれている可能性があります。これをそのままHTMLに出力するとXSS脆弱性となるため、htmlspecialchars()関数で必ずエスケープ処理を行ってください。
PHP hex2bin 失敗例と挙動を理解する
1<?php 2 3/** 4 * hex2bin関数が「使えない」状況、つまり失敗するケースを実演します。 5 * 6 * hex2binは、引数として渡された文字列が有効な16進数でない場合に false を返します。 7 * このサンプルでは、どのような場合に変換が失敗するのかを示します。 8 */ 9function checkHex2binBehavior(): void 10{ 11 // --- 失敗例1: 16進数ではない文字('G')が含まれている --- 12 // 'G'は16進数(0-9, a-f, A-F)ではないため、変換に失敗します。 13 $invalidHexString1 = '48656c6c6f20576f726c4G'; 14 15 echo '--- 失敗例1: 不正な文字を含む ---' . PHP_EOL; 16 echo '入力値: ' . $invalidHexString1 . PHP_EOL; 17 18 $result1 = hex2bin($invalidHexString1); 19 20 if ($result1 === false) { 21 echo '結果: 変換に失敗し、falseが返されました。' . PHP_EOL; 22 echo '理由: 16進数として不正な文字が含まれています。' . PHP_EOL; 23 } 24 25 echo PHP_EOL; 26 27 28 // --- 失敗例2: 文字列の長さが奇数 --- 29 // 16進数文字列は2文字で1バイトを表すため、文字列長は偶数である必要があります。 30 $invalidHexString2 = '48656c6c6f'; // 最後の1文字が欠けている 31 32 echo '--- 失敗例2: 文字列長が奇数 ---' . PHP_EOL; 33 echo '入力値: ' . $invalidHexString2 . PHP_EOL; 34 35 $result2 = hex2bin($invalidHexString2); 36 37 if ($result2 === false) { 38 echo '結果: 変換に失敗し、falseが返されました。' . PHP_EOL; 39 echo '理由: 文字列の長さが奇数です。' . PHP_EOL; 40 } 41 42 echo PHP_EOL; 43 44 45 // --- 成功例(比較のため) --- 46 // 有効な16進数文字列 "Hello World" 47 $validHexString = '48656c6c6f20576f726c64'; 48 49 echo '--- 成功例 ---' . PHP_EOL; 50 echo '入力値: ' . $validHexString . PHP_EOL; 51 52 $binaryData = hex2bin($validHexString); 53 54 // 戻り値が false でないことを確認してから使用するのが安全な実装です。 55 if ($binaryData !== false) { 56 echo '結果: ' . $binaryData . PHP_EOL; 57 } 58} 59 60// 関数を実行します 61checkHex2binBehavior();
PHPのhex2bin関数は、16進数文字列をバイナリデータに変換する関数です。引数には16進数文字列$stringを指定します。正常に変換できた場合は変換後のバイナリデータが文字列として返され、変換に失敗した場合はfalseが返されます。
このサンプルコードでは、hex2bin関数が失敗するケースを具体的に示しています。1つ目の失敗例は、引数に16進数として無効な文字(0-9, a-f, A-F以外)が含まれている場合です。この場合、hex2bin関数はfalseを返します。2つ目の失敗例は、引数として渡された文字列の長さが奇数の場合です。16進数文字列は2文字で1バイトを表すため、文字列長は偶数でなければなりません。奇数の場合はfalseが返されます。
対照的に、成功例では、有効な16進数文字列をhex2bin関数に渡しています。この場合は、対応するバイナリデータが文字列として返されます。hex2bin関数の戻り値を使用する際は、falseでないことを確認してから利用することで、エラーを回避できます。このように、hex2bin関数を使う際には、入力文字列が有効な16進数文字列であること、そして文字列の長さが偶数であることを確認することが重要です。
hex2bin()関数を使う際の注意点です。引数の文字列は、有効な16進数(0-9, a-f, A-F)のみで構成されている必要があります。これ以外の文字が含まれていると、falseが返されます。また、16進数文字列は2文字で1バイトを表すため、文字列の長さは偶数である必要があります。奇数の場合もfalseが返されます。hex2bin()の戻り値がfalseでないことを確認してから、変換後の値を利用するようにしてください。これにより、エラーを未然に防ぎ、安全なコードを作成できます。