~ubuntu-branches/ubuntu/lucid/gnutls26/lucid-security

« back to all changes in this revision

Viewing changes to doc/reference/html/gnutls-openpgp.html

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Metzler
  • Date: 2009-09-26 10:33:52 UTC
  • mfrom: (1.1.8 upstream) (12.1.6 sid)
  • Revision ID: james.westby@ubuntu.com-20090926103352-aqhy8avw3jyaf2n5
Tags: 2.8.4-1
* New upstream version.
  + Drop debian/patches/15_openpgp.diff.
* Sync priorities with override file, libgnutls26 has been bumped from
  important to standard.

Show diffs side-by-side

added added

removed removed

Lines of Context:
47
47
enum                <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-crt-fmt-t" title="enum gnutls_openpgp_crt_fmt_t">gnutls_openpgp_crt_fmt_t</a>;
48
48
typedef             <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-keyid-t" title="gnutls_openpgp_keyid_t">gnutls_openpgp_keyid_t</a>;
49
49
int                 <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-crt-init" title="gnutls_openpgp_crt_init ()">gnutls_openpgp_crt_init</a>             (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-crt-t" title="gnutls_openpgp_crt_t">gnutls_openpgp_crt_t</a> *key);
50
 
<a
51
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
52
 
>void</a>                <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-crt-deinit" title="gnutls_openpgp_crt_deinit ()">gnutls_openpgp_crt_deinit</a>           (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-crt-t" title="gnutls_openpgp_crt_t">gnutls_openpgp_crt_t</a> key);
 
50
void                <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-crt-deinit" title="gnutls_openpgp_crt_deinit ()">gnutls_openpgp_crt_deinit</a>           (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-crt-t" title="gnutls_openpgp_crt_t">gnutls_openpgp_crt_t</a> key);
53
51
int                 <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-crt-import" title="gnutls_openpgp_crt_import ()">gnutls_openpgp_crt_import</a>           (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-crt-t" title="gnutls_openpgp_crt_t">gnutls_openpgp_crt_t</a> key,
54
52
                                                         const gnutls_datum_t *data,
55
53
                                                         <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-crt-fmt-t" title="enum gnutls_openpgp_crt_fmt_t">gnutls_openpgp_crt_fmt_t</a> format);
56
54
int                 <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-crt-export" title="gnutls_openpgp_crt_export ()">gnutls_openpgp_crt_export</a>           (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-crt-t" title="gnutls_openpgp_crt_t">gnutls_openpgp_crt_t</a> key,
57
55
                                                         <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-crt-fmt-t" title="enum gnutls_openpgp_crt_fmt_t">gnutls_openpgp_crt_fmt_t</a> format,
58
 
                                                         <a
59
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
60
 
>void</a> *output_data,
 
56
                                                         void *output_data,
61
57
                                                         size_t *output_data_size);
62
58
int                 <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-crt-print" title="gnutls_openpgp_crt_print ()">gnutls_openpgp_crt_print</a>            (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-crt-t" title="gnutls_openpgp_crt_t">gnutls_openpgp_crt_t</a> cert,
63
59
                                                         <a class="link" href="gnutls-gnutls.html#gnutls-certificate-print-formats-t" title="enum gnutls_certificate_print_formats_t">gnutls_certificate_print_formats_t</a> format,
65
61
int                 <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-crt-get-key-usage" title="gnutls_openpgp_crt_get_key_usage ()">gnutls_openpgp_crt_get_key_usage</a>    (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-crt-t" title="gnutls_openpgp_crt_t">gnutls_openpgp_crt_t</a> key,
66
62
                                                         unsigned int *key_usage);
67
63
int                 <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-crt-get-fingerprint" title="gnutls_openpgp_crt_get_fingerprint ()">gnutls_openpgp_crt_get_fingerprint</a>  (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-crt-t" title="gnutls_openpgp_crt_t">gnutls_openpgp_crt_t</a> key,
68
 
                                                         <a
69
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
70
 
>void</a> *fpr,
 
64
                                                         void *fpr,
71
65
                                                         size_t *fprlen);
72
66
int                 <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-crt-get-subkey-fingerprint" title="gnutls_openpgp_crt_get_subkey_fingerprint ()">gnutls_openpgp_crt_get_subkey_fingerprint</a>
73
67
                                                        (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-crt-t" title="gnutls_openpgp_crt_t">gnutls_openpgp_crt_t</a> key,
74
68
                                                         unsigned int idx,
75
 
                                                         <a
76
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
77
 
>void</a> *fpr,
 
69
                                                         void *fpr,
78
70
                                                         size_t *fprlen);
79
71
int                 <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-crt-get-name" title="gnutls_openpgp_crt_get_name ()">gnutls_openpgp_crt_get_name</a>         (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-crt-t" title="gnutls_openpgp_crt_t">gnutls_openpgp_crt_t</a> key,
80
72
                                                         int idx,
143
135
                                                        (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-crt-t" title="gnutls_openpgp_crt_t">gnutls_openpgp_crt_t</a> key,
144
136
                                                         const <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-keyid-t" title="gnutls_openpgp_keyid_t">gnutls_openpgp_keyid_t</a> keyid);
145
137
int                 <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-privkey-init" title="gnutls_openpgp_privkey_init ()">gnutls_openpgp_privkey_init</a>         (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-privkey-t" title="gnutls_openpgp_privkey_t">gnutls_openpgp_privkey_t</a> *key);
146
 
<a
147
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
148
 
>void</a>                <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-privkey-deinit" title="gnutls_openpgp_privkey_deinit ()">gnutls_openpgp_privkey_deinit</a>       (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-privkey-t" title="gnutls_openpgp_privkey_t">gnutls_openpgp_privkey_t</a> key);
 
138
void                <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-privkey-deinit" title="gnutls_openpgp_privkey_deinit ()">gnutls_openpgp_privkey_deinit</a>       (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-privkey-t" title="gnutls_openpgp_privkey_t">gnutls_openpgp_privkey_t</a> key);
149
139
<a class="link" href="gnutls-gnutls.html#gnutls-pk-algorithm-t" title="enum gnutls_pk_algorithm_t">gnutls_pk_algorithm_t</a>  <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-privkey-get-pk-algorithm" title="gnutls_openpgp_privkey_get_pk_algorithm ()">gnutls_openpgp_privkey_get_pk_algorithm</a>
150
140
                                                        (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-privkey-t" title="gnutls_openpgp_privkey_t">gnutls_openpgp_privkey_t</a> key,
151
141
                                                         unsigned int *bits);
159
149
                                                         gnutls_datum_t *signature);
160
150
int                 <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-privkey-get-fingerprint" title="gnutls_openpgp_privkey_get_fingerprint ()">gnutls_openpgp_privkey_get_fingerprint</a>
161
151
                                                        (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-privkey-t" title="gnutls_openpgp_privkey_t">gnutls_openpgp_privkey_t</a> key,
162
 
                                                         <a
163
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
164
 
>void</a> *fpr,
 
152
                                                         void *fpr,
165
153
                                                         size_t *fprlen);
166
154
int                 <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-privkey-get-subkey-fingerprint" title="gnutls_openpgp_privkey_get_subkey_fingerprint ()">gnutls_openpgp_privkey_get_subkey_fingerprint</a>
167
155
                                                        (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-privkey-t" title="gnutls_openpgp_privkey_t">gnutls_openpgp_privkey_t</a> key,
168
156
                                                         unsigned int idx,
169
 
                                                         <a
170
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
171
 
>void</a> *fpr,
 
157
                                                         void *fpr,
172
158
                                                         size_t *fprlen);
173
159
int                 <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-privkey-get-key-id" title="gnutls_openpgp_privkey_get_key_id ()">gnutls_openpgp_privkey_get_key_id</a>   (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-privkey-t" title="gnutls_openpgp_privkey_t">gnutls_openpgp_privkey_t</a> key,
174
160
                                                         <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-keyid-t" title="gnutls_openpgp_keyid_t">gnutls_openpgp_keyid_t</a> keyid);
232
218
                                                         <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-crt-fmt-t" title="enum gnutls_openpgp_crt_fmt_t">gnutls_openpgp_crt_fmt_t</a> format,
233
219
                                                         const char *password,
234
220
                                                         unsigned int flags,
235
 
                                                         <a
236
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
237
 
>void</a> *output_data,
 
221
                                                         void *output_data,
238
222
                                                         size_t *output_data_size);
239
223
int                 <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-privkey-set-preferred-key-id" title="gnutls_openpgp_privkey_set_preferred_key_id ()">gnutls_openpgp_privkey_set_preferred_key_id</a>
240
224
                                                        (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-privkey-t" title="gnutls_openpgp_privkey_t">gnutls_openpgp_privkey_t</a> key,
246
230
                                                         <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-keyid-t" title="gnutls_openpgp_keyid_t">gnutls_openpgp_keyid_t</a> keyid,
247
231
                                                         unsigned int flag);
248
232
int                 <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-keyring-init" title="gnutls_openpgp_keyring_init ()">gnutls_openpgp_keyring_init</a>         (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-keyring-t" title="gnutls_openpgp_keyring_t">gnutls_openpgp_keyring_t</a> *keyring);
249
 
<a
250
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
251
 
>void</a>                <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-keyring-deinit" title="gnutls_openpgp_keyring_deinit ()">gnutls_openpgp_keyring_deinit</a>       (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-keyring-t" title="gnutls_openpgp_keyring_t">gnutls_openpgp_keyring_t</a> keyring);
 
233
void                <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-keyring-deinit" title="gnutls_openpgp_keyring_deinit ()">gnutls_openpgp_keyring_deinit</a>       (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-keyring-t" title="gnutls_openpgp_keyring_t">gnutls_openpgp_keyring_t</a> keyring);
252
234
int                 <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-keyring-import" title="gnutls_openpgp_keyring_import ()">gnutls_openpgp_keyring_import</a>       (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-keyring-t" title="gnutls_openpgp_keyring_t">gnutls_openpgp_keyring_t</a> keyring,
253
235
                                                         const gnutls_datum_t *data,
254
236
                                                         <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-crt-fmt-t" title="enum gnutls_openpgp_crt_fmt_t">gnutls_openpgp_crt_fmt_t</a> format);
271
253
                                                         unsigned char *keyfpr,
272
254
                                                         unsigned int keyfpr_length,
273
255
                                                         gnutls_datum_t *key);
274
 
<a
275
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
276
 
>void</a>                <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-set-recv-key-function" title="gnutls_openpgp_set_recv_key_function ()">gnutls_openpgp_set_recv_key_function</a>
 
256
void                <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-set-recv-key-function" title="gnutls_openpgp_set_recv_key_function ()">gnutls_openpgp_set_recv_key_function</a>
277
257
                                                        (<a class="link" href="gnutls-gnutls.html#gnutls-session-t" title="gnutls_session_t">gnutls_session_t</a> session,
278
258
                                                         <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-recv-key-func" title="gnutls_openpgp_recv_key_func ()">gnutls_openpgp_recv_key_func</a> func);
279
259
int                 <a class="link" href="gnutls-openpgp.html#gnutls-certificate-set-openpgp-key" title="gnutls_certificate_set_openpgp_key ()">gnutls_certificate_set_openpgp_key</a>  (gnutls_certificate_credentials_t res,
364
344
<hr>
365
345
<div class="refsect2" title="gnutls_openpgp_crt_deinit ()">
366
346
<a name="gnutls-openpgp-crt-deinit"></a><h3>gnutls_openpgp_crt_deinit ()</h3>
367
 
<pre class="programlisting"><a
368
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
369
 
>void</a>                gnutls_openpgp_crt_deinit           (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-crt-t" title="gnutls_openpgp_crt_t">gnutls_openpgp_crt_t</a> key);</pre>
 
347
<pre class="programlisting">void                gnutls_openpgp_crt_deinit           (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-crt-t" title="gnutls_openpgp_crt_t">gnutls_openpgp_crt_t</a> key);</pre>
370
348
<p>
371
349
This function will deinitialize a key structure.</p>
372
350
<p>
423
401
<a name="gnutls-openpgp-crt-export"></a><h3>gnutls_openpgp_crt_export ()</h3>
424
402
<pre class="programlisting">int                 gnutls_openpgp_crt_export           (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-crt-t" title="gnutls_openpgp_crt_t">gnutls_openpgp_crt_t</a> key,
425
403
                                                         <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-crt-fmt-t" title="enum gnutls_openpgp_crt_fmt_t">gnutls_openpgp_crt_fmt_t</a> format,
426
 
                                                         <a
427
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
428
 
>void</a> *output_data,
 
404
                                                         void *output_data,
429
405
                                                         size_t *output_data_size);</pre>
430
406
<p>
431
407
This function will convert the given key to RAW or Base64 format.
544
520
<div class="refsect2" title="gnutls_openpgp_crt_get_fingerprint ()">
545
521
<a name="gnutls-openpgp-crt-get-fingerprint"></a><h3>gnutls_openpgp_crt_get_fingerprint ()</h3>
546
522
<pre class="programlisting">int                 gnutls_openpgp_crt_get_fingerprint  (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-crt-t" title="gnutls_openpgp_crt_t">gnutls_openpgp_crt_t</a> key,
547
 
                                                         <a
548
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
549
 
>void</a> *fpr,
 
523
                                                         void *fpr,
550
524
                                                         size_t *fprlen);</pre>
551
525
<p>
552
526
Get key fingerprint.  Depending on the algorithm, the fingerprint
585
559
<pre class="programlisting">int                 gnutls_openpgp_crt_get_subkey_fingerprint
586
560
                                                        (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-crt-t" title="gnutls_openpgp_crt_t">gnutls_openpgp_crt_t</a> key,
587
561
                                                         unsigned int idx,
588
 
                                                         <a
589
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
590
 
>void</a> *fpr,
 
562
                                                         void *fpr,
591
563
                                                         size_t *fprlen);</pre>
592
564
<p>
593
565
Get key fingerprint of a subkey.  Depending on the algorithm, the
1452
1424
<hr>
1453
1425
<div class="refsect2" title="gnutls_openpgp_privkey_deinit ()">
1454
1426
<a name="gnutls-openpgp-privkey-deinit"></a><h3>gnutls_openpgp_privkey_deinit ()</h3>
1455
 
<pre class="programlisting"><a
1456
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
1457
 
>void</a>                gnutls_openpgp_privkey_deinit       (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-privkey-t" title="gnutls_openpgp_privkey_t">gnutls_openpgp_privkey_t</a> key);</pre>
 
1427
<pre class="programlisting">void                gnutls_openpgp_privkey_deinit       (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-privkey-t" title="gnutls_openpgp_privkey_t">gnutls_openpgp_privkey_t</a> key);</pre>
1458
1428
<p>
1459
1429
This function will deinitialize a key structure.</p>
1460
1430
<p>
1602
1572
<a name="gnutls-openpgp-privkey-get-fingerprint"></a><h3>gnutls_openpgp_privkey_get_fingerprint ()</h3>
1603
1573
<pre class="programlisting">int                 gnutls_openpgp_privkey_get_fingerprint
1604
1574
                                                        (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-privkey-t" title="gnutls_openpgp_privkey_t">gnutls_openpgp_privkey_t</a> key,
1605
 
                                                         <a
1606
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
1607
 
>void</a> *fpr,
 
1575
                                                         void *fpr,
1608
1576
                                                         size_t *fprlen);</pre>
1609
1577
<p>
1610
1578
Get the fingerprint of the OpenPGP key. Depends on the
1645
1613
<pre class="programlisting">int                 gnutls_openpgp_privkey_get_subkey_fingerprint
1646
1614
                                                        (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-privkey-t" title="gnutls_openpgp_privkey_t">gnutls_openpgp_privkey_t</a> key,
1647
1615
                                                         unsigned int idx,
1648
 
                                                         <a
1649
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
1650
 
>void</a> *fpr,
 
1616
                                                         void *fpr,
1651
1617
                                                         size_t *fprlen);</pre>
1652
1618
<p>
1653
1619
Get the fingerprint of an OpenPGP subkey.  Depends on the
2251
2217
                                                         <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-crt-fmt-t" title="enum gnutls_openpgp_crt_fmt_t">gnutls_openpgp_crt_fmt_t</a> format,
2252
2218
                                                         const char *password,
2253
2219
                                                         unsigned int flags,
2254
 
                                                         <a
2255
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
2256
 
>void</a> *output_data,
 
2220
                                                         void *output_data,
2257
2221
                                                         size_t *output_data_size);</pre>
2258
2222
<p>
2259
2223
This function will convert the given key to RAW or Base64 format.
2439
2403
<hr>
2440
2404
<div class="refsect2" title="gnutls_openpgp_keyring_deinit ()">
2441
2405
<a name="gnutls-openpgp-keyring-deinit"></a><h3>gnutls_openpgp_keyring_deinit ()</h3>
2442
 
<pre class="programlisting"><a
2443
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
2444
 
>void</a>                gnutls_openpgp_keyring_deinit       (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-keyring-t" title="gnutls_openpgp_keyring_t">gnutls_openpgp_keyring_t</a> keyring);</pre>
 
2406
<pre class="programlisting">void                gnutls_openpgp_keyring_deinit       (<a class="link" href="gnutls-gnutls.html#gnutls-openpgp-keyring-t" title="gnutls_openpgp_keyring_t">gnutls_openpgp_keyring_t</a> keyring);</pre>
2445
2407
<p>
2446
2408
This function will deinitialize a keyring structure.</p>
2447
2409
<p>
2744
2706
<hr>
2745
2707
<div class="refsect2" title="gnutls_openpgp_set_recv_key_function ()">
2746
2708
<a name="gnutls-openpgp-set-recv-key-function"></a><h3>gnutls_openpgp_set_recv_key_function ()</h3>
2747
 
<pre class="programlisting"><a
2748
 
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
2749
 
>void</a>                gnutls_openpgp_set_recv_key_function
 
2709
<pre class="programlisting">void                gnutls_openpgp_set_recv_key_function
2750
2710
                                                        (<a class="link" href="gnutls-gnutls.html#gnutls-session-t" title="gnutls_session_t">gnutls_session_t</a> session,
2751
2711
                                                         <a class="link" href="gnutls-openpgp.html#gnutls-openpgp-recv-key-func" title="gnutls_openpgp_recv_key_func ()">gnutls_openpgp_recv_key_func</a> func);</pre>
2752
2712
<p>