【PHP8.x】openssl_cipher_iv_length関数の使い方

<?php

declare(strict_types=1);

/**
 * 指定された暗号化アルゴリズムに必要なIV（初期化ベクトル）の長さを取得し、表示します。
 *
 * この関数は、暗号化処理を行う前に、適切な長さのIVを生成するために使用されます。
 *
 * @param string $cipherAlgo 確認したい暗号化アルゴリズム名。
 * @return void
 */
function showCipherIvLength(string $cipherAlgo): void
{
    // openssl_cipher_iv_length() を使用して、指定された暗号アルゴリズムのIV長を取得します。
    // サポートされていないアルゴリズムの場合、この関数は false を返します。
    $ivLength = openssl_cipher_iv_length($cipherAlgo);

    // 結果を整形して出力します。
    echo "アルゴリズム: '{$cipherAlgo}'" . PHP_EOL;

    if ($ivLength === false) {
        // IV長が取得できなかった場合（例: アルゴリズム名が不正）
        echo "-> 結果: サポートされていないか、無効なアルゴリズムです。" . PHP_EOL;
    } elseif ($ivLength === 0) {
        // IV長が0の場合（例: ECBモードなど、IVを必要としないアルゴリズム）
        echo "-> 結果: このアルゴリズムはIVを必要としません。" . PHP_EOL;
    } else {
        // IV長が取得できた場合
        echo "-> 結果: 必要なIVの長さは {$ivLength} バイトです。" . PHP_EOL;
    }
    echo "------------------------" . PHP_EOL;
}

// --- 関数の実行例 ---

// 一般的によく使われる暗号化アルゴリズム (成功例)
showCipherIvLength('aes-256-cbc');

// 別の暗号化アルゴリズム (成功例)
showCipherIvLength('aes-128-gcm');

// IVを必要としないアルゴリズムの例
showCipherIvLength('aes-256-ecb');

// 存在しない、または無効なアルゴリズム名 (失敗例)
showCipherIvLength('invalid-cipher-name');

?>

PHPの openssl_cipher_iv_length 関数は、指定した暗号化アルゴリズムで必要となるIV（初期化ベクトル）の長さをバイト単位で取得するための関数です。IVとは、同じデータを暗号化しても毎回異なる結果になるようにするための、使い捨てのランダムな値で、暗号化の安全性を高める重要な役割を担います。

この関数の引数 $cipher_algo には、長さを調べたい暗号化アルゴリズムの名前を 'aes-256-cbc' のような文字列で指定します。

戻り値は、成功した場合は必要なIVの長さを整数で返します。アルゴリズムがIVを必要としない場合は0を返します。引数に指定されたアルゴリズム名が無効な場合や、システムでサポートされていない場合は false を返します。

サンプルコードでは、いくつかの異なるアルゴリズム名をこの関数に渡し、その結果を表示しています。例えば、一般的に使われる 'aes-256-cbc' ではIVの長さ（16バイト）が、IVを必要としない 'aes-256-ecb' では0が表示されます。また、存在しないアルゴリズム名を渡すと false が返され、エラーメッセージが表示されることがわかります。このように、暗号化処理を行う前にこの関数でIVの長さを確認し、適切な長さのIVを生成することが重要です。