1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 304574 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-pkey-get-details">
<refnamediv>
<refname>openssl_pkey_get_details</refname>
<refpurpose>Returns an array with the key details</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>openssl_pkey_get_details</methodname>
<methodparam><type>resource</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
This function returns the key details (bits, key, type).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
Resource holding the key.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array with the key details in success or &false; in failure.
Returned array has indexes <literal>bits</literal> (number of bits),
<literal>key</literal> (string representation of the public key) and
<literal>type</literal> (type of the key which is one of
<constant>OPENSSL_KEYTYPE_RSA</constant>,
<constant>OPENSSL_KEYTYPE_DSA</constant>,
<constant>OPENSSL_KEYTYPE_DH</constant>,
<constant>OPENSSL_KEYTYPE_EC</constant> or -1 meaning unknown).
</para>
<para>
Depending on the key type used, additional details may be returned. Note that
some elements may not always be available.
</para>
<itemizedlist>
<listitem>
<simpara>
<constant>OPENSSL_KEYTYPE_RSA</constant>, an additional array key named <literal>"rsa"</literal>,
containing the key data is returned.
</simpara>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Key</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>"n"</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>"e"</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>"d"</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>"p"</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>"q"</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>"dmp1"</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>"dmq1"</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>"iqmp"</literal></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
<listitem>
<simpara>
<constant>OPENSSL_KEYTYPE_DSA</constant>, an additional array key named <literal>"dsa"</literal>,
containing the key data is returned.
</simpara>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Key</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>"p"</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>"q"</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>"g"</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>"priv_key"</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>"pub_key"</literal></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
<listitem>
<simpara>
<constant>OPENSSL_KEYTYPE_DH</constant>, an additional array key named <literal>"dh"</literal>,
containing the key data is returned.
</simpara>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Key</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>"p"</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>"g"</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>"priv_key"</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>"pub_key"</literal></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</itemizedlist>
</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
-->
|
