php-doc-en/reference/openssl/functions/openssl-x509-check-private-key.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-x509-check-private-key">
 <refnamediv>
  <refname>openssl_x509_check_private_key</refname>
  <refpurpose>Checks if a private key corresponds to a certificate</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>openssl_x509_check_private_key</methodname>
   <methodparam><type>mixed</type><parameter>cert</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>key</parameter></methodparam>
  </methodsynopsis>
  <para>
   Checks whether the given <parameter>key</parameter> is the private key
   that corresponds to <parameter>cert</parameter>.
  </para>
  <warning>
    <para>
     The function does not check if <parameter>key</parameter> is indeed a private key or not.
     It merely compares the public materials (e.g. exponent and modulus of an RSA key)
     and/or key parameters (e.g. EC params of an EC key) of a key pair.
    </para>
    <para>
     This means, for example, that a public key could be given for <parameter>key</parameter>
     and the function may return &true;.
    </para>
  </warning>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>cert</parameter></term>
     <listitem>
      <para>
       The certificate.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       The private key.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns &true; if <parameter>key</parameter> is the private key that
   corresponds to <parameter>cert</parameter>, or &false; otherwise.
  </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
-->