doc/reference/tmpl/openpgp.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 openpgp
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### SECTION Stability_Level ##### -->
  18
  19
  20 <!-- ##### SECTION Image ##### -->
  21
  22
  23 <!-- ##### ENUM gnutls_openpgp_crt_fmt_t ##### -->
  24 <para>
  25
  26 </para>
  27
  28 @GNUTLS_OPENPGP_FMT_RAW:
  29 @GNUTLS_OPENPGP_FMT_BASE64:
  30
  31 <!-- ##### TYPEDEF gnutls_openpgp_keyid_t ##### -->
  32 <para>
  33
  34 </para>
  35
  36
  37 <!-- ##### FUNCTION gnutls_openpgp_crt_init ##### -->
  38 <para>
  39
  40 </para>
  41
  42 @key:
  43 @Returns:
  44
  45
  46 <!-- ##### FUNCTION gnutls_openpgp_crt_deinit ##### -->
  47 <para>
  48
  49 </para>
  50
  51 @key:
  52
  53
  54 <!-- ##### FUNCTION gnutls_openpgp_crt_import ##### -->
  55 <para>
  56
  57 </para>
  58
  59 @key:
  60 @data:
  61 @format:
  62 @Returns:
  63
  64
  65 <!-- ##### FUNCTION gnutls_openpgp_crt_export ##### -->
  66 <para>
  67
  68 </para>
  69
  70 @key:
  71 @format:
  72 @output_data:
  73 @output_data_size:
  74 @Returns:
  75
  76
  77 <!-- ##### FUNCTION gnutls_openpgp_crt_print ##### -->
  78 <para>
  79
  80 </para>
  81
  82 @cert:
  83 @format:
  84 @out:
  85 @Returns:
  86
  87
  88 <!-- ##### FUNCTION gnutls_openpgp_crt_get_key_usage ##### -->
  89 <para>
  90
  91 </para>
  92
  93 @key:
  94 @key_usage:
  95 @Returns:
  96
  97
  98 <!-- ##### FUNCTION gnutls_openpgp_crt_get_fingerprint ##### -->
  99 <para>
 100
 101 </para>
 102
 103 @key:
 104 @fpr:
 105 @fprlen:
 106 @Returns:
 107
 108
 109 <!-- ##### FUNCTION gnutls_openpgp_crt_get_subkey_fingerprint ##### -->
 110 <para>
 111
 112 </para>
 113
 114 @key:
 115 @idx:
 116 @fpr:
 117 @fprlen:
 118 @Returns:
 119
 120
 121 <!-- ##### FUNCTION gnutls_openpgp_crt_get_name ##### -->
 122 <para>
 123
 124 </para>
 125
 126 @key:
 127 @idx:
 128 @buf:
 129 @sizeof_buf:
 130 @Returns:
 131
 132
 133 <!-- ##### FUNCTION gnutls_openpgp_crt_get_pk_algorithm ##### -->
 134 <para>
 135
 136 </para>
 137
 138 @key:
 139 @bits:
 140 @Returns:
 141
 142
 143 <!-- ##### FUNCTION gnutls_openpgp_crt_get_version ##### -->
 144 <para>
 145
 146 </para>
 147
 148 @key:
 149 @Returns:
 150
 151
 152 <!-- ##### FUNCTION gnutls_openpgp_crt_get_creation_time ##### -->
 153 <para>
 154
 155 </para>
 156
 157 @key:
 158 @Returns:
 159
 160
 161 <!-- ##### FUNCTION gnutls_openpgp_crt_get_expiration_time ##### -->
 162 <para>
 163
 164 </para>
 165
 166 @key:
 167 @Returns:
 168
 169
 170 <!-- ##### FUNCTION gnutls_openpgp_crt_get_key_id ##### -->
 171 <para>
 172
 173 </para>
 174
 175 @key:
 176 @keyid:
 177 @Returns:
 178
 179
 180 <!-- ##### FUNCTION gnutls_openpgp_crt_check_hostname ##### -->
 181 <para>
 182
 183 </para>
 184
 185 @key:
 186 @hostname:
 187 @Returns:
 188
 189
 190 <!-- ##### FUNCTION gnutls_openpgp_crt_get_revoked_status ##### -->
 191 <para>
 192
 193 </para>
 194
 195 @key:
 196 @Returns:
 197
 198
 199 <!-- ##### FUNCTION gnutls_openpgp_crt_get_subkey_count ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @key:
 205 @Returns:
 206
 207
 208 <!-- ##### FUNCTION gnutls_openpgp_crt_get_subkey_idx ##### -->
 209 <para>
 210
 211 </para>
 212
 213 @key:
 214 @keyid:
 215 @Returns:
 216
 217
 218 <!-- ##### FUNCTION gnutls_openpgp_crt_get_subkey_revoked_status ##### -->
 219 <para>
 220
 221 </para>
 222
 223 @key:
 224 @idx:
 225 @Returns:
 226
 227
 228 <!-- ##### FUNCTION gnutls_openpgp_crt_get_subkey_pk_algorithm ##### -->
 229 <para>
 230
 231 </para>
 232
 233 @key:
 234 @idx:
 235 @bits:
 236 @Returns:
 237
 238
 239 <!-- ##### FUNCTION gnutls_openpgp_crt_get_subkey_creation_time ##### -->
 240 <para>
 241
 242 </para>
 243
 244 @key:
 245 @idx:
 246 @Returns:
 247
 248
 249 <!-- ##### FUNCTION gnutls_openpgp_crt_get_subkey_expiration_time ##### -->
 250 <para>
 251
 252 </para>
 253
 254 @key:
 255 @idx:
 256 @Returns:
 257
 258
 259 <!-- ##### FUNCTION gnutls_openpgp_crt_get_subkey_id ##### -->
 260 <para>
 261
 262 </para>
 263
 264 @key:
 265 @idx:
 266 @keyid:
 267 @Returns:
 268
 269
 270 <!-- ##### FUNCTION gnutls_openpgp_crt_get_subkey_usage ##### -->
 271 <para>
 272
 273 </para>
 274
 275 @key:
 276 @idx:
 277 @key_usage:
 278 @Returns:
 279
 280
 281 <!-- ##### FUNCTION gnutls_openpgp_crt_get_subkey_pk_dsa_raw ##### -->
 282 <para>
 283
 284 </para>
 285
 286 @crt:
 287 @idx:
 288 @p:
 289 @q:
 290 @g:
 291 @y:
 292 @Returns:
 293
 294
 295 <!-- ##### FUNCTION gnutls_openpgp_crt_get_subkey_pk_rsa_raw ##### -->
 296 <para>
 297
 298 </para>
 299
 300 @crt:
 301 @idx:
 302 @m:
 303 @e:
 304 @Returns:
 305
 306
 307 <!-- ##### FUNCTION gnutls_openpgp_crt_get_pk_dsa_raw ##### -->
 308 <para>
 309
 310 </para>
 311
 312 @crt:
 313 @p:
 314 @q:
 315 @g:
 316 @y:
 317 @Returns:
 318
 319
 320 <!-- ##### FUNCTION gnutls_openpgp_crt_get_pk_rsa_raw ##### -->
 321 <para>
 322
 323 </para>
 324
 325 @crt:
 326 @m:
 327 @e:
 328 @Returns:
 329
 330
 331 <!-- ##### FUNCTION gnutls_openpgp_crt_get_preferred_key_id ##### -->
 332 <para>
 333
 334 </para>
 335
 336 @key:
 337 @keyid:
 338 @Returns:
 339
 340
 341 <!-- ##### FUNCTION gnutls_openpgp_crt_set_preferred_key_id ##### -->
 342 <para>
 343
 344 </para>
 345
 346 @key:
 347 @keyid:
 348 @Returns:
 349
 350
 351 <!-- ##### FUNCTION gnutls_openpgp_privkey_init ##### -->
 352 <para>
 353
 354 </para>
 355
 356 @key:
 357 @Returns:
 358
 359
 360 <!-- ##### FUNCTION gnutls_openpgp_privkey_deinit ##### -->
 361 <para>
 362
 363 </para>
 364
 365 @key:
 366
 367
 368 <!-- ##### FUNCTION gnutls_openpgp_privkey_get_pk_algorithm ##### -->
 369 <para>
 370
 371 </para>
 372
 373 @key:
 374 @bits:
 375 @Returns:
 376
 377
 378 <!-- ##### FUNCTION gnutls_openpgp_privkey_sec_param ##### -->
 379 <para>
 380
 381 </para>
 382
 383 @key:
 384 @Returns:
 385
 386
 387 <!-- ##### FUNCTION gnutls_openpgp_privkey_import ##### -->
 388 <para>
 389
 390 </para>
 391
 392 @key:
 393 @data:
 394 @format:
 395 @password:
 396 @flags:
 397 @Returns:
 398
 399
 400 <!-- ##### FUNCTION gnutls_openpgp_privkey_get_fingerprint ##### -->
 401 <para>
 402
 403 </para>
 404
 405 @key:
 406 @fpr:
 407 @fprlen:
 408 @Returns:
 409
 410
 411 <!-- ##### FUNCTION gnutls_openpgp_privkey_get_subkey_fingerprint ##### -->
 412 <para>
 413
 414 </para>
 415
 416 @key:
 417 @idx:
 418 @fpr:
 419 @fprlen:
 420 @Returns:
 421
 422
 423 <!-- ##### FUNCTION gnutls_openpgp_privkey_get_key_id ##### -->
 424 <para>
 425
 426 </para>
 427
 428 @key:
 429 @keyid:
 430 @Returns:
 431
 432
 433 <!-- ##### FUNCTION gnutls_openpgp_privkey_get_subkey_count ##### -->
 434 <para>
 435
 436 </para>
 437
 438 @key:
 439 @Returns:
 440
 441
 442 <!-- ##### FUNCTION gnutls_openpgp_privkey_get_subkey_idx ##### -->
 443 <para>
 444
 445 </para>
 446
 447 @key:
 448 @keyid:
 449 @Returns:
 450
 451
 452 <!-- ##### FUNCTION gnutls_openpgp_privkey_get_subkey_revoked_status ##### -->
 453 <para>
 454
 455 </para>
 456
 457 @key:
 458 @idx:
 459 @Returns:
 460
 461
 462 <!-- ##### FUNCTION gnutls_openpgp_privkey_get_revoked_status ##### -->
 463 <para>
 464
 465 </para>
 466
 467 @key:
 468 @Returns:
 469
 470
 471 <!-- ##### FUNCTION gnutls_openpgp_privkey_get_subkey_pk_algorithm ##### -->
 472 <para>
 473
 474 </para>
 475
 476 @key:
 477 @idx:
 478 @bits:
 479 @Returns:
 480
 481
 482 <!-- ##### FUNCTION gnutls_openpgp_privkey_get_subkey_expiration_time ##### -->
 483 <para>
 484
 485 </para>
 486
 487 @key:
 488 @idx:
 489 @Returns:
 490
 491
 492 <!-- ##### FUNCTION gnutls_openpgp_privkey_get_subkey_id ##### -->
 493 <para>
 494
 495 </para>
 496
 497 @key:
 498 @idx:
 499 @keyid:
 500 @Returns:
 501
 502
 503 <!-- ##### FUNCTION gnutls_openpgp_privkey_get_subkey_creation_time ##### -->
 504 <para>
 505
 506 </para>
 507
 508 @key:
 509 @idx:
 510 @Returns:
 511
 512
 513 <!-- ##### FUNCTION gnutls_openpgp_privkey_export_subkey_dsa_raw ##### -->
 514 <para>
 515
 516 </para>
 517
 518 @pkey:
 519 @idx:
 520 @p:
 521 @q:
 522 @g:
 523 @y:
 524 @x:
 525 @Returns:
 526
 527
 528 <!-- ##### FUNCTION gnutls_openpgp_privkey_export_subkey_rsa_raw ##### -->
 529 <para>
 530
 531 </para>
 532
 533 @pkey:
 534 @idx:
 535 @m:
 536 @e:
 537 @d:
 538 @p:
 539 @q:
 540 @u:
 541 @Returns:
 542
 543
 544 <!-- ##### FUNCTION gnutls_openpgp_privkey_export_dsa_raw ##### -->
 545 <para>
 546
 547 </para>
 548
 549 @pkey:
 550 @p:
 551 @q:
 552 @g:
 553 @y:
 554 @x:
 555 @Returns:
 556
 557
 558 <!-- ##### FUNCTION gnutls_openpgp_privkey_export_rsa_raw ##### -->
 559 <para>
 560
 561 </para>
 562
 563 @pkey:
 564 @m:
 565 @e:
 566 @d:
 567 @p:
 568 @q:
 569 @u:
 570 @Returns:
 571
 572
 573 <!-- ##### FUNCTION gnutls_openpgp_privkey_export ##### -->
 574 <para>
 575
 576 </para>
 577
 578 @key:
 579 @format:
 580 @password:
 581 @flags:
 582 @output_data:
 583 @output_data_size:
 584 @Returns:
 585
 586
 587 <!-- ##### FUNCTION gnutls_openpgp_privkey_set_preferred_key_id ##### -->
 588 <para>
 589
 590 </para>
 591
 592 @key:
 593 @keyid:
 594 @Returns:
 595
 596
 597 <!-- ##### FUNCTION gnutls_openpgp_privkey_get_preferred_key_id ##### -->
 598 <para>
 599
 600 </para>
 601
 602 @key:
 603 @keyid:
 604 @Returns:
 605
 606
 607 <!-- ##### FUNCTION gnutls_openpgp_crt_get_auth_subkey ##### -->
 608 <para>
 609
 610 </para>
 611
 612 @crt:
 613 @keyid:
 614 @flag:
 615 @Returns:
 616
 617
 618 <!-- ##### FUNCTION gnutls_openpgp_keyring_init ##### -->
 619 <para>
 620
 621 </para>
 622
 623 @keyring:
 624 @Returns:
 625
 626
 627 <!-- ##### FUNCTION gnutls_openpgp_keyring_deinit ##### -->
 628 <para>
 629
 630 </para>
 631
 632 @keyring:
 633
 634
 635 <!-- ##### FUNCTION gnutls_openpgp_keyring_import ##### -->
 636 <para>
 637
 638 </para>
 639
 640 @keyring:
 641 @data:
 642 @format:
 643 @Returns:
 644
 645
 646 <!-- ##### FUNCTION gnutls_openpgp_keyring_check_id ##### -->
 647 <para>
 648
 649 </para>
 650
 651 @ring:
 652 @keyid:
 653 @flags:
 654 @Returns:
 655
 656
 657 <!-- ##### FUNCTION gnutls_openpgp_crt_verify_ring ##### -->
 658 <para>
 659
 660 </para>
 661
 662 @key:
 663 @keyring:
 664 @flags:
 665 @verify:
 666 @Returns:
 667
 668
 669 <!-- ##### FUNCTION gnutls_openpgp_crt_verify_self ##### -->
 670 <para>
 671
 672 </para>
 673
 674 @key:
 675 @flags:
 676 @verify:
 677 @Returns:
 678
 679
 680 <!-- ##### FUNCTION gnutls_openpgp_keyring_get_crt ##### -->
 681 <para>
 682
 683 </para>
 684
 685 @ring:
 686 @idx:
 687 @cert:
 688 @Returns:
 689
 690
 691 <!-- ##### FUNCTION gnutls_openpgp_keyring_get_crt_count ##### -->
 692 <para>
 693
 694 </para>
 695
 696 @ring:
 697 @Returns:
 698
 699
 700 <!-- ##### USER_FUNCTION gnutls_openpgp_recv_key_func ##### -->
 701 <para>
 702
 703 </para>
 704
 705 @session:
 706 @keyfpr:
 707 @keyfpr_length:
 708 @key:
 709 @Returns:
 710
 711
 712 <!-- ##### FUNCTION gnutls_openpgp_set_recv_key_function ##### -->
 713 <para>
 714
 715 </para>
 716
 717 @session:
 718 @func:
 719
 720
 721 <!-- ##### FUNCTION gnutls_certificate_set_openpgp_key ##### -->
 722 <para>
 723
 724 </para>
 725
 726 @res:
 727 @key:
 728 @pkey:
 729 @Returns:
 730
 731
 732 <!-- ##### FUNCTION gnutls_certificate_set_openpgp_key_file ##### -->
 733 <para>
 734
 735 </para>
 736
 737 @res:
 738 @certfile:
 739 @keyfile:
 740 @format:
 741 @Returns:
 742
 743
 744 <!-- ##### FUNCTION gnutls_certificate_set_openpgp_key_mem ##### -->
 745 <para>
 746
 747 </para>
 748
 749 @res:
 750 @cert:
 751 @key:
 752 @format:
 753 @Returns:
 754
 755
 756 <!-- ##### FUNCTION gnutls_certificate_set_openpgp_key_file2 ##### -->
 757 <para>
 758
 759 </para>
 760
 761 @res:
 762 @certfile:
 763 @keyfile:
 764 @subkey_id:
 765 @format:
 766 @Returns:
 767
 768
 769 <!-- ##### FUNCTION gnutls_certificate_set_openpgp_key_mem2 ##### -->
 770 <para>
 771
 772 </para>
 773
 774 @res:
 775 @cert:
 776 @key:
 777 @subkey_id:
 778 @format:
 779 @Returns:
 780
 781
 782 <!-- ##### FUNCTION gnutls_certificate_set_openpgp_keyring_mem ##### -->
 783 <para>
 784
 785 </para>
 786
 787 @c:
 788 @data:
 789 @dlen:
 790 @format:
 791 @Returns:
 792
 793
 794 <!-- ##### FUNCTION gnutls_certificate_set_openpgp_keyring_file ##### -->
 795 <para>
 796
 797 </para>
 798
 799 @c:
 800 @file:
 801 @format:
 802 @Returns:
 803
 804