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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>pkcs12</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.70.1">
<link rel="start" href="index.html" title="GNU TLS API Reference Manual">
<link rel="up" href="ch01.html" title="GNU TLS API Reference Manual">
<link rel="prev" href="gnutls-x509.html" title="x509">
<link rel="next" href="gnutls-openpgp.html" title="openpgp">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="GNU TLS API Reference Manual">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gnutls-x509.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNU TLS API Reference Manual</th>
<td><a accesskey="n" href="gnutls-openpgp.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#top_of_page" class="shortcut">Top</a>
 | 
<a href="#desc" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="gnutls-pkcs12"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="top_of_page"></a>pkcs12</span></h2>
<p>pkcs12 — </p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
enum <a href="gnutls-pkcs12.html#gnutls-pkcs12-bag-type-t">gnutls_pkcs12_bag_type_t</a>;
#define <a href="gnutls-pkcs12.html#MAX-BAG-ELEMENTS:CAPS">MAX_BAG_ELEMENTS</a>
struct <a href="gnutls-pkcs12.html#bag-element">bag_element</a>;
#define <a href="gnutls-pkcs12.html#BAG-PKCS8-KEY:CAPS">BAG_PKCS8_KEY</a>
#define <a href="gnutls-pkcs12.html#BAG-PKCS8-ENCRYPTED-KEY:CAPS">BAG_PKCS8_ENCRYPTED_KEY</a>
#define <a href="gnutls-pkcs12.html#BAG-CERTIFICATE:CAPS">BAG_CERTIFICATE</a>
#define <a href="gnutls-pkcs12.html#BAG-CRL:CAPS">BAG_CRL</a>
#define <a href="gnutls-pkcs12.html#DATA-OID:CAPS">DATA_OID</a>
#define <a href="gnutls-pkcs12.html#ENC-DATA-OID:CAPS">ENC_DATA_OID</a>
#define <a href="gnutls-pkcs12.html#FRIENDLY-NAME-OID:CAPS">FRIENDLY_NAME_OID</a>
#define <a href="gnutls-pkcs12.html#KEY-ID-OID:CAPS">KEY_ID_OID</a>
typedef <a href="gnutls-pkcs12.html#gnutls-pkcs12-t">gnutls_pkcs12_t</a>;
typedef <a href="gnutls-pkcs12.html#gnutls-pkcs12-bag-t">gnutls_pkcs12_bag_t</a>;
int <a href="gnutls-pkcs12.html#gnutls-pkcs12-init">gnutls_pkcs12_init</a> (<a href="gnutls-pkcs12.html#gnutls-pkcs12-t">gnutls_pkcs12_t</a> *pkcs12);
<a
href="../shishi/shishi-shishi.html#void"
>void</a> <a href="gnutls-pkcs12.html#gnutls-pkcs12-deinit">gnutls_pkcs12_deinit</a> (<a href="gnutls-pkcs12.html#gnutls-pkcs12-t">gnutls_pkcs12_t</a> pkcs12);
int <a href="gnutls-pkcs12.html#gnutls-pkcs12-import">gnutls_pkcs12_import</a> (<a href="gnutls-pkcs12.html#gnutls-pkcs12-t">gnutls_pkcs12_t</a> pkcs12,
const gnutls_datum_t *data,
<a href="gnutls-gnutls.html#gnutls-x509-crt-fmt-t">gnutls_x509_crt_fmt_t</a> format,
unsigned int flags);
int <a href="gnutls-pkcs12.html#gnutls-pkcs12-get-bag">gnutls_pkcs12_get_bag</a> (<a href="gnutls-pkcs12.html#gnutls-pkcs12-t">gnutls_pkcs12_t</a> pkcs12,
int indx,
<a href="gnutls-pkcs12.html#gnutls-pkcs12-bag-t">gnutls_pkcs12_bag_t</a> bag);
int <a href="gnutls-pkcs12.html#gnutls-pkcs12-bag-init">gnutls_pkcs12_bag_init</a> (<a href="gnutls-pkcs12.html#gnutls-pkcs12-bag-t">gnutls_pkcs12_bag_t</a> *bag);
<a
href="../shishi/shishi-shishi.html#void"
>void</a> <a href="gnutls-pkcs12.html#gnutls-pkcs12-bag-deinit">gnutls_pkcs12_bag_deinit</a> (<a href="gnutls-pkcs12.html#gnutls-pkcs12-bag-t">gnutls_pkcs12_bag_t</a> bag);
enum <a href="gnutls-pkcs12.html#schema-id">schema_id</a>;
</pre>
</div>
<div class="refsect1" lang="en">
<a name="desc"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2618731"></a><h3>
<a name="gnutls-pkcs12-bag-type-t"></a>enum gnutls_pkcs12_bag_type_t</h3>
<a class="indexterm" name="id2618743"></a><pre class="programlisting">typedef enum gnutls_pkcs12_bag_type_t
{
GNUTLS_BAG_EMPTY = 0,
GNUTLS_BAG_PKCS8_ENCRYPTED_KEY = 1,
GNUTLS_BAG_PKCS8_KEY,
GNUTLS_BAG_CERTIFICATE,
GNUTLS_BAG_CRL,
GNUTLS_BAG_ENCRYPTED = 10,
GNUTLS_BAG_UNKNOWN = 20
} gnutls_pkcs12_bag_type_t;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2618762"></a><h3>
<a name="MAX-BAG-ELEMENTS:CAPS"></a>MAX_BAG_ELEMENTS</h3>
<a class="indexterm" name="id2618773"></a><pre class="programlisting">#define MAX_BAG_ELEMENTS</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2618788"></a><h3>
<a name="bag-element"></a>struct bag_element</h3>
<a class="indexterm" name="id2618800"></a><pre class="programlisting">struct bag_element {
gnutls_datum_t data;
gnutls_pkcs12_bag_type_t type;
gnutls_datum_t local_key_id;
char *friendly_name;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605027"></a><h3>
<a name="BAG-PKCS8-KEY:CAPS"></a>BAG_PKCS8_KEY</h3>
<a class="indexterm" name="id2605040"></a><pre class="programlisting">#define BAG_PKCS8_KEY</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605055"></a><h3>
<a name="BAG-PKCS8-ENCRYPTED-KEY:CAPS"></a>BAG_PKCS8_ENCRYPTED_KEY</h3>
<a class="indexterm" name="id2605066"></a><pre class="programlisting">#define BAG_PKCS8_ENCRYPTED_KEY</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605082"></a><h3>
<a name="BAG-CERTIFICATE:CAPS"></a>BAG_CERTIFICATE</h3>
<a class="indexterm" name="id2605093"></a><pre class="programlisting">#define BAG_CERTIFICATE</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605109"></a><h3>
<a name="BAG-CRL:CAPS"></a>BAG_CRL</h3>
<a class="indexterm" name="id2605121"></a><pre class="programlisting">#define BAG_CRL</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605137"></a><h3>
<a name="DATA-OID:CAPS"></a>DATA_OID</h3>
<a class="indexterm" name="id2605149"></a><pre class="programlisting">#define DATA_OID</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605164"></a><h3>
<a name="ENC-DATA-OID:CAPS"></a>ENC_DATA_OID</h3>
<a class="indexterm" name="id2609118"></a><pre class="programlisting">#define ENC_DATA_OID</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609133"></a><h3>
<a name="FRIENDLY-NAME-OID:CAPS"></a>FRIENDLY_NAME_OID</h3>
<a class="indexterm" name="id2609145"></a><pre class="programlisting">#define FRIENDLY_NAME_OID</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609160"></a><h3>
<a name="KEY-ID-OID:CAPS"></a>KEY_ID_OID</h3>
<a class="indexterm" name="id2609173"></a><pre class="programlisting">#define KEY_ID_OID</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609188"></a><h3>
<a name="gnutls-pkcs12-t"></a>gnutls_pkcs12_t</h3>
<a class="indexterm" name="id2609200"></a><p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609210"></a><h3>
<a name="gnutls-pkcs12-bag-t"></a>gnutls_pkcs12_bag_t</h3>
<a class="indexterm" name="id2609222"></a><p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609232"></a><h3>
<a name="gnutls-pkcs12-init"></a>gnutls_pkcs12_init ()</h3>
<a class="indexterm" name="id2609244"></a><pre class="programlisting">int gnutls_pkcs12_init (<a href="gnutls-pkcs12.html#gnutls-pkcs12-t">gnutls_pkcs12_t</a> *pkcs12);</pre>
<p>
This function will initialize a PKCS12 structure. PKCS12 structures
usually contain lists of X.509 Certificates and X.509 Certificate
revocation lists.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>pkcs12</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609306"></a><h3>
<a name="gnutls-pkcs12-deinit"></a>gnutls_pkcs12_deinit ()</h3>
<a class="indexterm" name="id2571057"></a><pre class="programlisting"><a
href="../shishi/shishi-shishi.html#void"
>void</a> gnutls_pkcs12_deinit (<a href="gnutls-pkcs12.html#gnutls-pkcs12-t">gnutls_pkcs12_t</a> pkcs12);</pre>
<p>
This function will deinitialize a PKCS12 structure.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>pkcs12</code></em> :</span></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2571106"></a><h3>
<a name="gnutls-pkcs12-import"></a>gnutls_pkcs12_import ()</h3>
<a class="indexterm" name="id2571118"></a><pre class="programlisting">int gnutls_pkcs12_import (<a href="gnutls-pkcs12.html#gnutls-pkcs12-t">gnutls_pkcs12_t</a> pkcs12,
const gnutls_datum_t *data,
<a href="gnutls-gnutls.html#gnutls-x509-crt-fmt-t">gnutls_x509_crt_fmt_t</a> format,
unsigned int flags);</pre>
<p>
This function will convert the given DER or PEM encoded PKCS12
to the native gnutls_pkcs12_t format. The output will be stored in 'pkcs12'.
</p>
<p>
If the PKCS12 is PEM encoded it should have a header of "PKCS12".</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>pkcs12</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>format</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>flags</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2571247"></a><h3>
<a name="gnutls-pkcs12-get-bag"></a>gnutls_pkcs12_get_bag ()</h3>
<a class="indexterm" name="id2571258"></a><pre class="programlisting">int gnutls_pkcs12_get_bag (<a href="gnutls-pkcs12.html#gnutls-pkcs12-t">gnutls_pkcs12_t</a> pkcs12,
int indx,
<a href="gnutls-pkcs12.html#gnutls-pkcs12-bag-t">gnutls_pkcs12_bag_t</a> bag);</pre>
<p>
This function will return a Bag from the PKCS12 structure.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>pkcs12</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>indx</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>bag</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2613620"></a><h3>
<a name="gnutls-pkcs12-bag-init"></a>gnutls_pkcs12_bag_init ()</h3>
<a class="indexterm" name="id2613631"></a><pre class="programlisting">int gnutls_pkcs12_bag_init (<a href="gnutls-pkcs12.html#gnutls-pkcs12-bag-t">gnutls_pkcs12_bag_t</a> *bag);</pre>
<p>
This function will initialize a PKCS12 bag structure. PKCS12 Bags
usually contain private keys, lists of X.509 Certificates and X.509 Certificate
revocation lists.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>bag</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2613693"></a><h3>
<a name="gnutls-pkcs12-bag-deinit"></a>gnutls_pkcs12_bag_deinit ()</h3>
<a class="indexterm" name="id2613704"></a><pre class="programlisting"><a
href="../shishi/shishi-shishi.html#void"
>void</a> gnutls_pkcs12_bag_deinit (<a href="gnutls-pkcs12.html#gnutls-pkcs12-bag-t">gnutls_pkcs12_bag_t</a> bag);</pre>
<p>
This function will deinitialize a PKCS12 Bag structure.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>bag</code></em> :</span></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2613753"></a><h3>
<a name="schema-id"></a>enum schema_id</h3>
<a class="indexterm" name="id2613766"></a><pre class="programlisting">typedef enum schema_id
{
PBES2, /* the stuff in PKCS #5 */
PKCS12_3DES_SHA1, /* the fucking stuff in PKCS #12 */
PKCS12_ARCFOUR_SHA1,
PKCS12_RC2_40_SHA1
} schema_id;
</pre>
<p>
</p>
</div>
</div>
</div>
</body>
</html>
|
