openssl_sign

    (PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8)

    openssl_sign — 署名を生成する

    説明

    openssl_sign(
        string $data,
        string &$signature,
        #[\SensitiveParameter] OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key,
        string|int $algorithm = OPENSSL_ALGO_SHA1
    ): bool

    openssl_sign() は、指定した data の署名を作ります。 private_key で指定した秘密鍵を使用して、暗号のデジタル署名を生成します。 data 自体は暗号化されないことに注意してください。

    パラメータ

    data

    署名したいデータの文字列。

    signature

    成功した場合、署名が signature に格納されます。

    private_key

    OpenSSLAsymmetricKey - openssl_get_privatekey() が返す鍵。

    string - PEM フォーマットの鍵。

    algorithm

    int - いずれかの 署名アルゴリズム。

    string - openssl_get_md_methods() が返す文字列 ("sha256WithRSAEncryption" や "sha384" など)。

    戻り値

    成功した場合に true を、失敗した場合に false を返します。

    変更履歴

    バージョン 説明
    8.0.0 private_key は、 OpenSSLAsymmetricKey または OpenSSLCertificate クラスのインスタンスを受け入れるようになりました。 これより前のバージョンでは、 OpenSSL key または OpenSSL X.509 型のリソースを受け入れていました。

    例

    例1 openssl_sign() の例

    <?php
    // $data に署名するデータが含まれていると仮定

    // ファイルから秘密鍵を取得して準備
    $pkeyid = openssl_pkey_get_private("file://src/openssl-0.9.6/demos/sign/key.pem");

    // 署名を計算
    openssl_sign($data, $signature, $pkeyid);

    // メモリからキーを開放する
    openssl_free_key($pkeyid);
    ?>

    例2 openssl_sign() の例

    <?php
    // 署名したいデータ
    $data = 'my data';

    // 新しい秘密鍵と公開鍵を作成
    $new_key_pair = openssl_pkey_new(array(
    "private_key_bits" => 2048,
    "private_key_type" => OPENSSL_KEYTYPE_RSA,
    ));
    openssl_pkey_export($new_key_pair, $private_key_pem);

    $details = openssl_pkey_get_details($new_key_pair);
    $public_key_pem = $details['key'];

    // 署名を作成
    openssl_sign($data, $signature, $private_key_pem, OPENSSL_ALGO_SHA256);

    // それらを保存
    file_put_contents('private_key.pem', $private_key_pem);
    file_put_contents('public_key.pem', $public_key_pem);
    file_put_contents('signature.dat', $signature);

    // 署名を検証
    $r = openssl_verify($data, $signature, $public_key_pem, "sha256WithRSAEncryption");
    var_dump($r);
    ?>

    参考

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 2 notes

    up
    11
    edmarw at yahoo dot com
    17 years ago
    This may help if you just want a real-simple private/public key pair:<?php$data = "Beeeeer is really good.. hic...";// You can get a simple private/public key pair using:// openssl genrsa 512 >private_key.txt// openssl rsa -pubout <private_key.txt >public_key.txt// IMPORTANT: The key pair below is provided for testing only. // For security reasons you must get a new key pair// for production use, obviously.$private_key = <<<EOD-----BEGIN RSA PRIVATE KEY-----MIIBOgIBAAJBANDiE2+Xi/WnO+s120NiiJhNyIButVu6zxqlVzz0wy2j4kQVUC4ZRZD80IY+4wIiX2YxKBZKGnd2TtPkcJ/ljkUCAwEAAQJAL151ZeMKHEU2c1qdRKS9sTxCcc2pVwoAGVzRccNX16tfmCf8FjxuM3WmLdsPxYoHrwb1LFNxiNk1MXrxjH3R6QIhAPB7edmcjH4bhMaJBztcbNE1VRCEi/bisAwiPPMq9/2nAiEA3lyc5+f6DEIJh1y6BWkdVULDSM+jpi1XiV/DevxuijMCIQCAEPGqHsF+4v7Jj+3HAgh9PU6otj2nY79nJtCYmvhoHwIgNDePaS4inApN7omp7WdXyhPZhBmulnGDYvEoGJN66d0CIHraI2SvDkQ5CmrzkW5qPaE2oO7BSqAhRZxiYpZFb5CI-----END RSA PRIVATE KEY-----EOD;$public_key = <<<EOD-----BEGIN PUBLIC KEY-----MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBANDiE2+Xi/WnO+s120NiiJhNyIButVu6zxqlVzz0wy2j4kQVUC4ZRZD80IY+4wIiX2YxKBZKGnd2TtPkcJ/ljkUCAwEAAQ==-----END PUBLIC KEY-----EOD;$binary_signature = "";// At least with PHP 5.2.2 / OpenSSL 0.9.8b (Fedora 7)// there seems to be no need to call openssl_get_privatekey or similar.// Just pass the key as defined aboveopenssl_sign($data, $binary_signature, $private_key, OPENSSL_ALGO_SHA1);// Check signature$ok = openssl_verify($data, $binary_signature, $public_key, OPENSSL_ALGO_SHA1);echo "check #1: ";if ($ok == 1) {    echo "signature ok (as it should be)\n";} elseif ($ok == 0) {    echo "bad (there's something wrong)\n";} else {    echo "ugly, error checking signature\n";}$ok = openssl_verify('tampered'.$data, $binary_signature, $public_key, OPENSSL_ALGO_SHA1);echo "check #2: ";if ($ok == 1) {    echo "ERROR: Data has been tampered, but signature is still valid! Argh!\n";} elseif ($ok == 0) {    echo "bad signature (as it should be, since data has beent tampered)\n";} else {    echo "ugly, error checking signature\n";}?>
    up
    4
    tim at remitone dot com
    2 years ago
    It should be noted that the default signature algorithm used by openssl_sign() and openssl_verify (OPENSSL_ALGO_SHA1) is no longer supported by default in OpenSSL Version 3 series.With an up to date OpenSSL library, one has to run"update-crypto-policies --set LEGACY"on the server where the library resides in order to allow these functions to work without the optional alternative algorithm argument.
    ＋add a note
    To Top