openssl-x509-check-private-key.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 5bc68add3da3cd18c40f851e944b15095d3a26aa Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.openssl-x509-check-private-key" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>openssl_x509_check_private_key</refname>
  <refpurpose>Проверяет, относится ли закрытый ключ к сертификату</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>openssl_x509_check_private_key</methodname>
   <methodparam><type class="union"><type>OpenSSLCertificate</type><type>string</type></type><parameter>certificate</parameter></methodparam>
   <methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>private_key</parameter></methodparam>
  </methodsynopsis>
  <para>
   Функция проверяет, что ключ <parameter>private_key</parameter> — закрытый
   ключ, который соответствует сертификату <parameter>certificate</parameter>.
  </para>
  <warning>
   <para>
    Функция не проверяет, закрытый ли ключ <parameter>private_key</parameter>
    или нет. Функция просто сравнивает открытые данные (например, экспоненту и модуль ключа RSA)
    и (или) параметры ключа (например, параметры EC для EC-ключа) пары ключей.
   </para>
   <para>
    То есть, если передать в параметр <parameter>private_key</parameter> соответствующий открытый ключ,
    то функция может вернуть &true;.
   </para>
  </warning>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>certificate</parameter></term>
     <listitem>
      <para>
       Сертификат.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>private_key</parameter></term>
     <listitem>
      <para>
       Ключ.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает &true;, если закрытый ключ <parameter>private_key</parameter> — ключ, который
   соответствует сертификату <parameter>certificate</parameter>, иначе &false;.
  </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>certificate</parameter> теперь принимает экземпляр класса <classname>OpenSSLCertificate</classname>;
       раньше принимался ресурс (&resource;) с типом <literal>OpenSSL X.509</literal>.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       Параметр<parameter>private_key</parameter> теперь принимает экземпляр класса <classname>OpenSSLAsymmetricKey</classname>
       или <classname>OpenSSLCertificate</classname>;
       раньше принимался ресурс (&resource;) с типом <literal>OpenSSL key</literal> или <literal>OpenSSL X.509</literal>.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </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
-->