docs/reference/tmpl/gmime-cipher-context.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 gmime-cipher-context
   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 <!-- ##### USER_FUNCTION GMimePasswordRequestFunc ##### -->
  24 <para>
  25
  26 </para>
  27
  28 @ctx:
  29 @user_id:
  30 @prompt_ctx:
  31 @reprompt:
  32 @response:
  33 @err:
  34 @Returns:
  35
  36
  37 <!-- ##### ENUM GMimeCipherHash ##### -->
  38 <para>
  39
  40 </para>
  41
  42 @GMIME_CIPHER_HASH_DEFAULT:
  43 @GMIME_CIPHER_HASH_MD2:
  44 @GMIME_CIPHER_HASH_MD5:
  45 @GMIME_CIPHER_HASH_SHA1:
  46 @GMIME_CIPHER_HASH_SHA224:
  47 @GMIME_CIPHER_HASH_SHA256:
  48 @GMIME_CIPHER_HASH_SHA384:
  49 @GMIME_CIPHER_HASH_SHA512:
  50 @GMIME_CIPHER_HASH_RIPEMD160:
  51 @GMIME_CIPHER_HASH_TIGER192:
  52 @GMIME_CIPHER_HASH_HAVAL5160:
  53
  54 <!-- ##### STRUCT GMimeCipherContext ##### -->
  55 <para>
  56
  57 </para>
  58
  59
  60 <!-- ##### STRUCT GMimeSignatureValidity ##### -->
  61 <para>
  62
  63 </para>
  64
  65 @status:
  66 @signers:
  67 @details:
  68
  69 <!-- ##### ENUM GMimeSignatureStatus ##### -->
  70 <para>
  71
  72 </para>
  73
  74 @GMIME_SIGNATURE_STATUS_NONE:
  75 @GMIME_SIGNATURE_STATUS_GOOD:
  76 @GMIME_SIGNATURE_STATUS_BAD:
  77 @GMIME_SIGNATURE_STATUS_UNKNOWN:
  78
  79 <!-- ##### ENUM GMimeSignerStatus ##### -->
  80 <para>
  81
  82 </para>
  83
  84 @GMIME_SIGNER_STATUS_NONE:
  85 @GMIME_SIGNER_STATUS_GOOD:
  86 @GMIME_SIGNER_STATUS_BAD:
  87 @GMIME_SIGNER_STATUS_ERROR:
  88
  89 <!-- ##### ENUM GMimeSignerTrust ##### -->
  90 <para>
  91
  92 </para>
  93
  94 @GMIME_SIGNER_TRUST_NONE:
  95 @GMIME_SIGNER_TRUST_NEVER:
  96 @GMIME_SIGNER_TRUST_UNDEFINED:
  97 @GMIME_SIGNER_TRUST_MARGINAL:
  98 @GMIME_SIGNER_TRUST_FULLY:
  99 @GMIME_SIGNER_TRUST_ULTIMATE:
 100
 101 <!-- ##### ENUM GMimeSignerError ##### -->
 102 <para>
 103
 104 </para>
 105
 106 @GMIME_SIGNER_ERROR_NONE:
 107 @GMIME_SIGNER_ERROR_EXPSIG:
 108 @GMIME_SIGNER_ERROR_NO_PUBKEY:
 109 @GMIME_SIGNER_ERROR_EXPKEYSIG:
 110 @GMIME_SIGNER_ERROR_REVKEYSIG:
 111
 112 <!-- ##### STRUCT GMimeSigner ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @next:
 118 @status:
 119 @errors:
 120 @trust:
 121 @unused:
 122 @issuer_serial:
 123 @issuer_name:
 124 @fingerprint:
 125 @sig_created:
 126 @sig_expires:
 127 @key_created:
 128 @key_expires:
 129 @keyid:
 130 @email:
 131 @name:
 132
 133 <!-- ##### FUNCTION g_mime_cipher_context_set_request_password ##### -->
 134 <para>
 135
 136 </para>
 137
 138 @ctx:
 139 @request_passwd:
 140
 141
 142 <!-- ##### FUNCTION g_mime_cipher_context_hash_id ##### -->
 143 <para>
 144
 145 </para>
 146
 147 @ctx:
 148 @hash:
 149 @Returns:
 150
 151
 152 <!-- ##### FUNCTION g_mime_cipher_context_hash_name ##### -->
 153 <para>
 154
 155 </para>
 156
 157 @ctx:
 158 @hash:
 159 @Returns:
 160
 161
 162 <!-- ##### FUNCTION g_mime_cipher_context_sign ##### -->
 163 <para>
 164
 165 </para>
 166
 167 @ctx:
 168 @userid:
 169 @hash:
 170 @istream:
 171 @ostream:
 172 @err:
 173 @Returns:
 174
 175
 176 <!-- ##### FUNCTION g_mime_cipher_context_verify ##### -->
 177 <para>
 178
 179 </para>
 180
 181 @ctx:
 182 @hash:
 183 @istream:
 184 @sigstream:
 185 @err:
 186 @Returns:
 187
 188
 189 <!-- ##### FUNCTION g_mime_cipher_context_encrypt ##### -->
 190 <para>
 191
 192 </para>
 193
 194 @ctx:
 195 @sign:
 196 @userid:
 197 @recipients:
 198 @istream:
 199 @ostream:
 200 @err:
 201 @Returns:
 202
 203
 204 <!-- ##### FUNCTION g_mime_cipher_context_decrypt ##### -->
 205 <para>
 206
 207 </para>
 208
 209 @ctx:
 210 @istream:
 211 @ostream:
 212 @err:
 213 @Returns:
 214
 215
 216 <!-- ##### FUNCTION g_mime_cipher_context_import_keys ##### -->
 217 <para>
 218
 219 </para>
 220
 221 @ctx:
 222 @istream:
 223 @err:
 224 @Returns:
 225
 226
 227 <!-- ##### FUNCTION g_mime_cipher_context_export_keys ##### -->
 228 <para>
 229
 230 </para>
 231
 232 @ctx:
 233 @keys:
 234 @ostream:
 235 @err:
 236 @Returns:
 237
 238
 239 <!-- ##### FUNCTION g_mime_signer_new ##### -->
 240 <para>
 241
 242 </para>
 243
 244 @void:
 245 @Returns:
 246
 247
 248 <!-- ##### FUNCTION g_mime_signer_free ##### -->
 249 <para>
 250
 251 </para>
 252
 253 @signer:
 254
 255
 256 <!-- ##### FUNCTION g_mime_signer_next ##### -->
 257 <para>
 258
 259 </para>
 260
 261 @signer:
 262 @Returns:
 263
 264
 265 <!-- ##### FUNCTION g_mime_signer_get_status ##### -->
 266 <para>
 267
 268 </para>
 269
 270 @signer:
 271 @Returns:
 272
 273
 274 <!-- ##### FUNCTION g_mime_signer_set_status ##### -->
 275 <para>
 276
 277 </para>
 278
 279 @signer:
 280 @status:
 281
 282
 283 <!-- ##### FUNCTION g_mime_signer_get_errors ##### -->
 284 <para>
 285
 286 </para>
 287
 288 @signer:
 289 @Returns:
 290
 291
 292 <!-- ##### FUNCTION g_mime_signer_set_errors ##### -->
 293 <para>
 294
 295 </para>
 296
 297 @signer:
 298 @error:
 299
 300
 301 <!-- ##### FUNCTION g_mime_signer_get_trust ##### -->
 302 <para>
 303
 304 </para>
 305
 306 @signer:
 307 @Returns:
 308
 309
 310 <!-- ##### FUNCTION g_mime_signer_set_trust ##### -->
 311 <para>
 312
 313 </para>
 314
 315 @signer:
 316 @trust:
 317
 318
 319 <!-- ##### FUNCTION g_mime_signer_get_issuer_serial ##### -->
 320 <para>
 321
 322 </para>
 323
 324 @signer:
 325 @Returns:
 326
 327
 328 <!-- ##### FUNCTION g_mime_signer_set_issuer_serial ##### -->
 329 <para>
 330
 331 </para>
 332
 333 @signer:
 334 @issuer_serial:
 335
 336
 337 <!-- ##### FUNCTION g_mime_signer_get_issuer_name ##### -->
 338 <para>
 339
 340 </para>
 341
 342 @signer:
 343 @Returns:
 344
 345
 346 <!-- ##### FUNCTION g_mime_signer_set_issuer_name ##### -->
 347 <para>
 348
 349 </para>
 350
 351 @signer:
 352 @issuer_name:
 353
 354
 355 <!-- ##### FUNCTION g_mime_signer_get_fingerprint ##### -->
 356 <para>
 357
 358 </para>
 359
 360 @signer:
 361 @Returns:
 362
 363
 364 <!-- ##### FUNCTION g_mime_signer_set_fingerprint ##### -->
 365 <para>
 366
 367 </para>
 368
 369 @signer:
 370 @fingerprint:
 371
 372
 373 <!-- ##### FUNCTION g_mime_signer_get_sig_created ##### -->
 374 <para>
 375
 376 </para>
 377
 378 @signer:
 379 @Returns:
 380
 381
 382 <!-- ##### FUNCTION g_mime_signer_set_sig_created ##### -->
 383 <para>
 384
 385 </para>
 386
 387 @signer:
 388 @created:
 389
 390
 391 <!-- ##### FUNCTION g_mime_signer_get_sig_expires ##### -->
 392 <para>
 393
 394 </para>
 395
 396 @signer:
 397 @Returns:
 398
 399
 400 <!-- ##### FUNCTION g_mime_signer_set_sig_expires ##### -->
 401 <para>
 402
 403 </para>
 404
 405 @signer:
 406 @expires:
 407
 408
 409 <!-- ##### FUNCTION g_mime_signer_get_key_created ##### -->
 410 <para>
 411
 412 </para>
 413
 414 @signer:
 415 @Returns:
 416
 417
 418 <!-- ##### FUNCTION g_mime_signer_set_key_created ##### -->
 419 <para>
 420
 421 </para>
 422
 423 @signer:
 424 @created:
 425
 426
 427 <!-- ##### FUNCTION g_mime_signer_get_key_expires ##### -->
 428 <para>
 429
 430 </para>
 431
 432 @signer:
 433 @Returns:
 434
 435
 436 <!-- ##### FUNCTION g_mime_signer_set_key_expires ##### -->
 437 <para>
 438
 439 </para>
 440
 441 @signer:
 442 @expires:
 443
 444
 445 <!-- ##### FUNCTION g_mime_signer_get_key_id ##### -->
 446 <para>
 447
 448 </para>
 449
 450 @signer:
 451 @Returns:
 452
 453
 454 <!-- ##### FUNCTION g_mime_signer_set_key_id ##### -->
 455 <para>
 456
 457 </para>
 458
 459 @signer:
 460 @key_id:
 461
 462
 463 <!-- ##### FUNCTION g_mime_signer_get_email ##### -->
 464 <para>
 465
 466 </para>
 467
 468 @signer:
 469 @Returns:
 470
 471
 472 <!-- ##### FUNCTION g_mime_signer_set_email ##### -->
 473 <para>
 474
 475 </para>
 476
 477 @signer:
 478 @email:
 479
 480
 481 <!-- ##### FUNCTION g_mime_signer_get_name ##### -->
 482 <para>
 483
 484 </para>
 485
 486 @signer:
 487 @Returns:
 488
 489
 490 <!-- ##### FUNCTION g_mime_signer_set_name ##### -->
 491 <para>
 492
 493 </para>
 494
 495 @signer:
 496 @name:
 497
 498
 499 <!-- ##### FUNCTION g_mime_signature_validity_new ##### -->
 500 <para>
 501
 502 </para>
 503
 504 @void:
 505 @Returns:
 506
 507
 508 <!-- ##### FUNCTION g_mime_signature_validity_free ##### -->
 509 <para>
 510
 511 </para>
 512
 513 @validity:
 514
 515
 516 <!-- ##### FUNCTION g_mime_signature_validity_set_status ##### -->
 517 <para>
 518
 519 </para>
 520
 521 @validity:
 522 @status:
 523
 524
 525 <!-- ##### FUNCTION g_mime_signature_validity_get_status ##### -->
 526 <para>
 527
 528 </para>
 529
 530 @validity:
 531 @Returns:
 532
 533
 534 <!-- ##### FUNCTION g_mime_signature_validity_set_details ##### -->
 535 <para>
 536
 537 </para>
 538
 539 @validity:
 540 @details:
 541
 542
 543 <!-- ##### FUNCTION g_mime_signature_validity_get_details ##### -->
 544 <para>
 545
 546 </para>
 547
 548 @validity:
 549 @Returns:
 550
 551
 552 <!-- ##### FUNCTION g_mime_signature_validity_add_signer ##### -->
 553 <para>
 554
 555 </para>
 556
 557 @validity:
 558 @signer:
 559
 560
 561 <!-- ##### FUNCTION g_mime_signature_validity_get_signers ##### -->
 562 <para>
 563
 564 </para>
 565
 566 @validity:
 567 @Returns:
 568
 569