File: openssl.xml

package info (click to toggle)
phpdoc 20020310-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 35,272 kB
  • ctags: 354
  • sloc: xml: 799,767; php: 1,395; cpp: 500; makefile: 200; sh: 140; awk: 51
file content (325 lines) | stat: -rw-r--r-- 11,087 bytes parent folder | download
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
<?xml version="1.0" encoding="iso-8859-2"?>
 <reference id="ref.openssl">
  <title>OpenSSL funkce</title>
  <titleabbrev>OpenSSL</titleabbrev>
  <partintro>
   &warn.experimental;
  <para>
   Tato extenze vyuv funkce <ulink url="&url.openssl;">OpenSSL</ulink> pro
   tvorbu a ovovn podpis a peetn (kdovn) a otvrn (dekdovn) dat.
   K prci s touto extenz potebujete OpenSSL >= 0.9.6.
  </para>
  <para>
   OpenSSL nabz mnoho vlastnost, kter tato extenze v souasnosti nepodporuje.
   Nkter z nich mohou bt v budoucnu pidny.
  </para>
  </partintro>

  <refentry id="function.openssl-free-key">
   <refnamediv>
    <refname>openssl_free_key</refname>
    <refpurpose>Uvolnit prostedky kle</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Popis</title>
     <methodsynopsis>
      <type>void</type><methodname>openssl_free_key</methodname>
      <methodparam><type>int</type><parameter>key_identifier</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>openssl_free_key</function> uvoln kl asociovan s pedanm
     <parameter>key_identifier</parameter> z pamti.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.openssl-get-privatekey">
   <refnamediv>
    <refname>openssl_get_privatekey</refname>
    <refpurpose>Pipravit soukrom PEM kl k pouit</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Popis</title>
     <methodsynopsis>
      <type>int</type><methodname>openssl_get_privatekey</methodname>
      <methodparam><type>string</type><parameter>key</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam>
     </methodsynopsis>
    <para>Pri spchu vrac kl, pi chyb &false;.
    </para>
    <para>
     <function>openssl_get_privatekey</function> rozparsuje sourkom PEM kl
     <parameter>key</parameter> a piprav ho k pouit v dalch funkcch.
     Voliteln argument <parameter>passphrase</parameter> mus bt pedn, pokud
     je tento kl zakdovn (chrnn heslem).
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.openssl-get-publickey">
   <refnamediv>
    <refname>openssl_get_publickey</refname>
    <refpurpose>
     Zskat z certifiktu veejn kl a pipravit ho k pouit
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Popis</title>
     <methodsynopsis>
      <type>int</type><methodname>openssl_get_publickey</methodname>
      <methodparam><type>string</type><parameter>certificate</parameter></methodparam>
     </methodsynopsis>
    <para>
     Pi spchu vrac identifiktor kle, pi chyb &false;.
    </para>
    <para>
     <function>openssl_get_publickey</function> z X.509 certifiktu
     <parameter>certificate</parameter> vyextrahuje veejn kl a piprav ho
     k pouit v dalch funkcch.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.openssl-open">
   <refnamediv>
    <refname>openssl_open</refname>
    <refpurpose>Otevt zapeetn data</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Popis</title>
     <methodsynopsis>
      <type>bool</type><methodname>openssl_open</methodname>
      <methodparam><type>string</type><parameter>sealed_data</parameter></methodparam>
      <methodparam><type>string</type><parameter>open_data</parameter></methodparam>
      <methodparam><type>string</type><parameter>env_key</parameter></methodparam>
      <methodparam><type>int</type><parameter>priv_key_id</parameter></methodparam>
     </methodsynopsis>
    <para>
     Pi spchu vrac &true;, pi chyb &false;.
     spn oteven data se umst do argumentu <parameter>open_data</parameter>.
    </para>
    <para>
     <function>openssl_open</function> oteve (dekduje)
     <parameter>sealed_data</parameter> pomoc soukromho kle asociovanho s
     identifiktorem <parameter>priv_key_id</parameter> a oblkou
     <parameter>env_key</parameter>. Tato oblka se generuje pi peetn dat a
     je pouiteln pouze s jednm utitm soukromm klem. Vce informac viz
     <function>openssl_seal</function>.
    </para>
    <para>
     <example>
      <title>Ukzka <function>openssl_open</function></title>
      <programlisting role="php">
// $sealed a $env_key obsahuj zapeetn data a oblku
// oboj nm bylo dno tm, kdo data zapeetil

// zskat ze souboru soukrom kl a pipravit ho
$fp = fopen("/src/openssl-0.9.6/demos/sign/key.pem", "r");
$priv_key = fread($fp, 8192);
fclose($fp);
$pkeyid = openssl_get_privatekey($priv_key);

// dekdovat data a uloit je v $open
if (openssl_open($sealed, $open, $env_key, $pkeyid))
    echo "tady jsou oteven data: ", $open;
else
    echo "nepodailo se otevt data";

// uvolnit kl z pamti
openssl_free_key($pkeyid);
      </programlisting>
     </example>
    </para>
    <simpara>
     Viz tak <function>openssl_seal</function>.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.openssl-seal">
   <refnamediv>
    <refname>openssl_seal</refname>
    <refpurpose>Zapeetit (zakdovat) data</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Popis</title>
     <methodsynopsis>
      <type>int</type><methodname>openssl_seal</methodname>
      <methodparam><type>string</type><parameter>data</parameter></methodparam>
      <methodparam><type>string</type><parameter>sealed_data</parameter></methodparam>
      <methodparam><type>array</type><parameter>env_keys</parameter></methodparam>
      <methodparam><type>array</type><parameter>pub_key_ids</parameter></methodparam>
     </methodsynopsis>
    <para>
     Pi spchu vrac dlku zapeetnch dat, pi chyb &false;.
     spn zapeetn data se umst do argumentu
     <parameter>sealed_data</parameter>, a oblka do
     <parameter>env_keys</parameter>.

    </para>
    <para>
     <function>openssl_seal</function> zapeet (zakduje)
     <parameter>data</parameter> pomoc RC4 s nhodn generovanm tajnm klem.
     Tento kl se zakduje vemi veejnmi kli asociovanmi s identifiktory
     v <parameter>pub_key_ids</parameter> a zakdovan kle se vrt v
     <parameter>env_keys</parameter>. To znamen, e lze poslat zapeetn data
     vce pjemcm (za pedpokladu, e mme jejch veejn kle). Kad z
     pjemc mus obdret zapeetn data a oblku, kter byla zakdovna
     jeho veejnm klem.
    </para>
    <para>
     <example>
      <title>Ukzka <function>openssl_seal</function></title>
      <programlisting role="php">
// $data obsahuje data uren k zapeetn

// zskat veejn kle naich pjemc a pipravit je
$fp = fopen("/src/openssl-0.9.6/demos/maurice/cert.pem", "r");
$cert = fread($fp, 8192);
fclose($fp);
$pk1 = openssl_get_publickey($cert);
// opakovat prodruhho pjemce
$fp = fopen("/src/openssl-0.9.6/demos/sign/cert.pem", "r");
$cert = fread($fp, 8192);
fclose($fp);
$pk2 = openssl_get_publickey($cert);

// zapeetit zprvu, pouze majitel $pk1 a $pk2 mohou dekdovat $sealed pomoc
// $ekeys[0] a $ekeys[1].
openssl_seal($data, $sealed, $ekeys, array($pk1,$pk2));

// uvolnit kle z pamti
openssl_free_key($pk1);
openssl_free_key($pk2);
      </programlisting>
     </example>
    </para>
    <simpara>
     Viz tak <function>openssl_open</function>.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.openssl-sign">
   <refnamediv>
    <refname>openssl_sign</refname>
    <refpurpose>Generate signature</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Popis</title>
     <methodsynopsis>
      <type>bool</type><methodname>openssl_sign</methodname>
      <methodparam><type>string</type><parameter>data</parameter></methodparam>
      <methodparam><type>string</type><parameter>signature</parameter></methodparam>
      <methodparam><type>int</type><parameter>priv_key_id</parameter></methodparam>
     </methodsynopsis>
    <para>
     Pi spchu vrac &true;, pi chyb &false;.
     spn vytvoen podpis se umst v <parameter>signature</parameter>.
    </para>
    <para>
     <function>openssl_sign</function> vypot podpis pro dan
     specified <parameter>data</parameter> pomoc SHA1 hashe a nsledn jej
     zakduje soukromm klem asociovanm s
     <parameter>priv_key_id</parameter>. Pozn.: samotn data nejsou kdovna.
    </para>
    <para>
     <example>
      <title><function>openssl_sign</function> example</title>
      <programlisting role="php">
// $data obsahuje data uren k podpisu

// zskat ze souboru soukrom kl a pipravit ho
$fp = fopen("/src/openssl-0.9.6/demos/sign/key.pem", "r");
$priv_key = fread($fp, 8192);
fclose($fp);
$pkeyid = openssl_get_privatekey($priv_key);

// vytvoit podpis
openssl_sign($data, $signature, $pkeyid);

// uvolnit kl z pamti
openssl_free_key($pkeyid);
      </programlisting>
     </example>
    </para>
    <simpara>
     Viz tak <function>openssl_verify</function>.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.openssl-verify">
   <refnamediv>
    <refname>openssl_verify</refname>
    <refpurpose>Ovit podpis</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Popis</title>
     <methodsynopsis>
      <type>int</type><methodname>openssl_verify</methodname>
      <methodparam><type>string</type><parameter>data</parameter></methodparam>
      <methodparam><type>string</type><parameter>signature</parameter></methodparam>
      <methodparam><type>int</type><parameter>pub_key_id</parameter></methodparam>
     </methodsynopsis>
    <para>
     Vrac 1, pokud je podpis sprvn, 0, pokud je nesprvn, a -1 pi chyb.
    </para>
    <para>
     <function>openssl_verify</function> ovuje, zda je
     <parameter>signature</parameter> sprvn pro
     <parameter>data</parameter> pomoc veejnho kle asociovanho s
     <parameter>pub_key_id</parameter>. Mus to bt veejn kl odpovdajc
     soukrommu kli pouitmu k podpisu.
    </para>
    <para>
     <example>
      <title>Ukzka <function>openssl_verify</function></title>
      <programlisting role="php">
// $data a $signature obsahuj data a podpis

// zskat z certifiktu veejn kl a pipravit ho
$fp = fopen("/src/openssl-0.9.6/demos/sign/cert.pem", "r");
$cert = fread($fp, 8192);
fclose($fp);
$pubkeyid = openssl_get_publickey($cert);

// zjistit, jestli je podpis v podku
$ok = openssl_verify($data, $signature, $pubkeyid);
if ($ok == 1)
    echo "dobe";
elseif ($ok == 0)
    echo "patn";
else
    echo "nejh, pi kontrole podpisu dolo k chyb";

// uvolnit kl z pamti
openssl_free_key($pubkeyid);
      </programlisting>
     </example>
    </para>
    <simpara>
     Viz tak <function>openssl_sign</function>.
    </simpara>
   </refsect1>
  </refentry>
 </reference>

<!-- 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:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->