php-doc-en/reference/openssl/functions/openssl-x509-fingerprint.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.openssl-x509-fingerprint" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>openssl_x509_fingerprint</refname>
  <refpurpose>Calculates the fingerprint, or digest, of a given X.509 certificate</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>openssl_x509_fingerprint</methodname>
   <methodparam><type class="union"><type>OpenSSLCertificate</type><type>string</type></type><parameter>certificate</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>digest_algo</parameter><initializer>"sha1"</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>binary</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>openssl_x509_fingerprint</function> returns the digest of
   <parameter>certificate</parameter> as a string.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &openssl.param.x509;
    <varlistentry>
     <term><parameter>digest_algo</parameter></term>
     <listitem>
      <para>
       The digest method or hash algorithm to use, e.g. "sha256", one of <function>openssl_get_md_methods</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>binary</parameter></term>
     <listitem>
      <para>
      When set to &true;, outputs raw binary data. &false; outputs lowercase hexits.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
    Returns a string containing the calculated certificate fingerprint as lowercase hexits unless <parameter>binary</parameter> is set to &true; in which case the raw binary representation of the message digest is returned.
  </para>
  <para>
    Returns &false; on failure.
  </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> accepts an <classname>OpenSSLCertificate</classname> instance now;
       previously, a &resource; of type <literal>OpenSSL X.509</literal> was accepted.
      </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
-->