2014-09-23 12:08:23 +00:00
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns= "http://docbook.org/ns/docbook" xml:id= "function.openssl-x509-fingerprint" >
<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 > bool</type> <methodname > openssl_x509_fingerprint</methodname>
<methodparam > <type > mixed</type> <parameter > x509</parameter> </methodparam>
<methodparam choice= "opt" > <type > string</type> <parameter > hash_algorithm</parameter> <initializer > "sha1"</initializer> </methodparam>
<methodparam choice= "opt" > <type > bool</type> <parameter > raw_output</parameter> <initializer > &false; </initializer> </methodparam>
</methodsynopsis>
<para >
<function > openssl_x509_fingerprint</function> returns the digest of
<parameter > x509</parameter> as a string.
</para>
</refsect1>
<refsect1 role= "parameters" >
&reftitle.parameters;
<para >
<variablelist >
&openssl.param.x509;
<varlistentry >
<term > <parameter > hash_algorithm</parameter> </term>
<listitem >
<para >
The hash algorithm to use, e.g. "md5" or "sha1"
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > raw_output</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 > raw_output</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>
</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
-->
