openssl-verify.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 497c40ac164d5873fd87f622dfdeb5206392b446 Maintainer: jaenecke Status: ready -->
<refentry xml:id="function.openssl-verify" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>openssl_verify</refname>
  <refpurpose>Überprüft eine Signatur</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>openssl_verify</methodname>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam><type>string</type><parameter>signature</parameter></methodparam>
   <methodparam><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>public_key</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>int</type></type><parameter>algorithm</parameter><initializer><constant>OPENSSL_ALGO_SHA1</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   Die Funktion <function>openssl_verify</function> überprüft die Korrektheit
   der Signatur <parameter>signature</parameter> für die angegebenen Daten
   <parameter>data</parameter> mit Hilfe des öffentlichen Schlüssels
   <parameter>public_key</parameter>. Dieser muss der zum privaten Schlüssel
   passende öffentliche sein, der für die Signatur verwendet wurde.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       Die Zeichenkette der Daten, mit denen die Signatur zuvor erzeugt wurde.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>signature</parameter></term>
     <listitem>
      <para>
       Eine rohe binäre Zeichenkette, erzeugt durch
       <function>openssl_sign</function> oder ähnliche Mittel.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>public_key</parameter></term>
     <listitem>
      <para>
       <classname>OpenSSLAsymmetricKey</classname> - ein von
       <function>openssl_get_publickey</function> zurückgegebener Schlüssel.
      </para>
      <para>
       <type>string</type> - ein <acronym>PEM</acronym>-formatierter Schlüssel
       (&zb; <literal>-----BEGIN PUBLIC KEY----- MIIBCgK...</literal>).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>algorithm</parameter></term>
     <listitem>
      <para>
       <type>int</type> - einer dieser
       <link linkend="openssl.signature-algos">Signatur-Algorithmen</link>.
      </para>
      <para>
       <type>string</type> - eine von
       <function>openssl_get_md_methods</function> zurückgegebene gültige
       Zeichenkette, beispielsweise "sha1WithRSAEncryption" oder "sha512".
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt bei einer korrekten Signatur 1 zurück, 0 bei einer unkorrekten und -1
   oder &false;, falls ein Fehler aufgetreten ist.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>public_key</parameter> akzeptiert nun eine
       <classname>OpenSSLAsymmetricKey</classname>- oder
       <classname>OpenSSLCertificate</classname>-Instanz; vorher wurde eine
       &resource; vom Typ <literal>OpenSSL-Schlüssel</literal> oder
       <literal>OpenSSL X.509</literal> akzeptiert.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>openssl_verify</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
// Annahme: $data und $signature enthalten die Daten und die Signatur

// holen des öffentlichen Schlüssels aus dem Zertifikat und vorbereiten
$pubkeyid = openssl_pkey_get_public("file://src/openssl-0.9.6/demos/sign/cert.pem");

// feststellen, ob die Signatur ok ist oder nicht
$ok = openssl_verify($data, $signature, $pubkeyid);
if ($ok == 1) {
    echo "gut";
} elseif ($ok == 0) {
    echo "schlecht";
} else {
    echo "Mist, Fehler beim überprüfen der Signatur";
}

// Löschen des Schlüssels aus dem Speicher
openssl_free_key($pubkeyid);
?>
]]>
    </programlisting>
   </example>
   <example>
    <title><function>openssl_verify</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
// die zu signierenden Daten
$data = 'my data';

// erzeuge neuen privaten und öffentlichen Schlüssel
$private_key_res = openssl_pkey_new(array(
    "private_key_bits" => 2048,
    "private_key_type" => OPENSSL_KEYTYPE_RSA,
));
$details = openssl_pkey_get_details($private_key_res);
$public_key_res = openssl_pkey_get_public($details['key']);

// erzeuge Signatur
openssl_sign($data, $signature, $private_key_res, "sha256WithRSAEncryption");

// überprüfe Signatur
$ok = openssl_verify($data, $signature, $public_key_res, OPENSSL_ALGO_SHA256);
if ($ok == 1) {
    echo "gültig";
} elseif ($ok == 0) {
    echo "ungültig";
} else {
    echo "Fehler: ".openssl_error_string();
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>openssl_sign</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->