reference/openssl/functions/openssl-x509-fingerprint.xml
d1e3ea622e5d4f542cd36eca59a9f22aa0142633
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-x509-fingerprint">
3
+
<refentry xml:id="function.openssl-x509-fingerprint" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>openssl_x509_fingerprint</refname>
6
6
<refpurpose>Calculates the fingerprint, or digest, of a given X.509 certificate</refpurpose>
...
...
@@ -9,14 +9,14 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>string</type><methodname>openssl_x509_fingerprint</methodname>
13
-
<methodparam><type>mixed</type><parameter>x509</parameter></methodparam>
14
-
<methodparam choice="opt"><type>string</type><parameter>hash_algorithm</parameter><initializer>"sha1"</initializer></methodparam>
15
-
<methodparam choice="opt"><type>bool</type><parameter>raw_output</parameter><initializer>&false;</initializer></methodparam>
12
+
<type class="union"><type>string</type><type>false</type></type><methodname>openssl_x509_fingerprint</methodname>
13
+
<methodparam><type class="union"><type>OpenSSLCertificate</type><type>string</type></type><parameter>certificate</parameter></methodparam>
14
+
<methodparam choice="opt"><type>string</type><parameter>digest_algo</parameter><initializer>"sha1"</initializer></methodparam>
15
+
<methodparam choice="opt"><type>bool</type><parameter>binary</parameter><initializer>&false;</initializer></methodparam>
16
16
</methodsynopsis>
17
17
<para>
18
18
<function>openssl_x509_fingerprint</function> returns the digest of
19
-
<parameter>x509</parameter> as a string.
19
+
<parameter>certificate</parameter> as a string.
20
20
</para>
21
21
</refsect1>
22
22

...
...
@@ -26,7 +26,7 @@
26
26
<variablelist>
27
27
&openssl.param.x509;
28
28
<varlistentry>
29
-
<term><parameter>hash_algorithm</parameter></term>
29
+
<term><parameter>digest_algo</parameter></term>
30
30
<listitem>
31
31
<para>
32
32
The digest method or hash algorithm to use, e.g. "sha256", one of <function>openssl_get_md_methods</function>.
...
...
@@ -34,7 +34,7 @@
34
34
</listitem>
35
35
</varlistentry>
36
36
<varlistentry>
37
-
<term><parameter>raw_output</parameter></term>
37
+
<term><parameter>binary</parameter></term>
38
38
<listitem>
39
39
<para>
40
40
When set to &true;, outputs raw binary data. &false; outputs lowercase hexits.
...
...
@@ -48,15 +48,36 @@
48
48
<refsect1 role="returnvalues">
49
49
&reftitle.returnvalues;
50
50
<para>
51
-
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.
51
+
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.
52
52
</para>
53
53
<para>
54
54
Returns &false; on failure.
55
55
</para>
56
56
</refsect1>
57
57

58
+
<refsect1 role="changelog">
59
+
&reftitle.changelog;
60
+
<informaltable>
61
+
<tgroup cols="2">
62
+
<thead>
63
+
<row>
64
+
<entry>&Version;</entry>
65
+
<entry>&Description;</entry>
66
+
</row>
67
+
</thead>
68
+
<tbody>
69
+
<row>
70
+
<entry>8.0.0</entry>
71
+
<entry>
72
+
<parameter>certificate</parameter> accepts an <classname>OpenSSLCertificate</classname> instance now;
73
+
previously, a &resource; of type <literal>OpenSSL X.509</literal> was accepted.
74
+
</entry>
75
+
</row>
76
+
</tbody>
77
+
</tgroup>
78
+
</informaltable>
79
+
</refsect1>
58
80
</refentry>
59
-

60
81
<!-- Keep this comment at the end of the file
61
82
Local variables:
62
83
mode: sgml
63
84