Files
doc-fr/reference/openssl/functions/openssl-verify.xml
2021-03-03 16:28:39 +00:00

206 lines
6.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d1e3ea622e5d4f542cd36eca59a9f22aa0142633 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.openssl-verify" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>openssl_verify</refname>
<refpurpose>Vérifie une signature</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>
<function>openssl_verify</function> vérifie que la signature
<parameter>signature</parameter> est correcte pour les données
<parameter>data</parameter>, et avec la clé publique
<parameter>public_key</parameter>. Cette clé doit être la clé
publique correspondant à la clé privée utilisée lors de la signature.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
La chaîne de données utilisé pour générer la signature
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>signature</parameter></term>
<listitem>
<para>
Une chaîne brute binaire, générée par la fonction
<function>openssl_sign</function> ou signification similaire
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>public_key</parameter></term>
<listitem>
<para>
<classname>OpenSSLAsymmetricKey</classname> - une clé, retourné par la fonction
<function>openssl_get_publickey</function>
</para>
<para>
<type>string</type> - une clé au format PEM, par exemple : "-----BEGIN PUBLIC KEY-----
MIIBCgK..."
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>algorithm</parameter></term>
<listitem>
<para>
<type>int</type> - une des <link linkend="openssl.signature-algos">signatures d'algorithmes</link>.
</para>
<para>
<type>string</type> - une chaîne valide retournée par la fonction <function>openssl_get_md_methods</function>,
par exemple : "sha1WithRSAEncryption" ou "sha512". Algorithme par défaut: "OPENSSL_ALGO_SHA1".
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne 1 si la signature est correcte, 0 si elle
est incorrecte et -1 ou &false; si une erreur survient.
</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> accepte désormais une instance de
<classname>OpenSSLAsymmetricKey</classname> ou <classname>OpenSSLCertificate</classname> ;
auparavant, une &resource; de type <literal>OpenSSL key</literal> ou <literal>OpenSSL X.509</literal>
était acceptée.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>openssl_verify</function></title>
<programlisting role="php">
<![CDATA[
<?php
// On suppose que $data et $signature contiennent les données à signer et
// la signature.
// Lecture de la clé publique depuis le certificat
$pubkeyid = openssl_pkey_get_public("file://src/openssl-0.9.6/demos/sign/cert.pem");
// indique si la signature est correcte
$ok = openssl_verify($data, $signature, $pubkeyid);
if ($ok == 1) {
echo "Signature valide";
} elseif ($ok == 0) {
echo "Signature erronée";
} else {
echo "Erreur de vérification de la signature";
}
// libère les clés de la mémoire
openssl_free_key($pubkeyid);
?>
]]>
</programlisting>
</example>
<example>
<title>Exemple avec <function>openssl_verify</function></title>
<programlisting role="php">
<![CDATA[
<?php
//Données que vous souhaitez signer
$data = 'my data';
//Crée une nouvelle clé privée et publique
$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']);
//Crée une signature
openssl_sign($data, $signature, $private_key_res, "sha256WithRSAEncryption");
//Vérifie la signature
$ok = openssl_verify($data, $signature, $public_key_res, OPENSSL_ALGO_SHA256);
if ($ok == 1) {
echo "valid";
} elseif ($ok == 0) {
echo "invalide";
} else {
echo "erreur : ".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
-->