doc/reference/tmpl/pkcs11.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 pkcs11
   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 <!-- ##### MACRO GNUTLS_PKCS11_MAX_PIN_LEN ##### -->
  24 <para>
  25
  26 </para>
  27
  28
  29
  30 <!-- ##### USER_FUNCTION gnutls_pkcs11_token_callback_t ##### -->
  31 <para>
  32
  33 </para>
  34
  35 @global_data:
  36 @label:
  37 @Param3:
  38 @Returns:
  39
  40
  41 <!-- ##### ENUM gnutls_pkcs11_pin_flag_t ##### -->
  42 <para>
  43
  44 </para>
  45
  46 @GNUTLS_PKCS11_PIN_USER:
  47 @GNUTLS_PKCS11_PIN_SO:
  48 @GNUTLS_PKCS11_PIN_FINAL_TRY:
  49 @GNUTLS_PKCS11_PIN_COUNT_LOW:
  50 @GNUTLS_PKCS11_PIN_CONTEXT_SPECIFIC:
  51 @GNUTLS_PKCS11_PIN_WRONG:
  52
  53 <!-- ##### USER_FUNCTION gnutls_pkcs11_pin_callback_t ##### -->
  54 <para>
  55
  56 </para>
  57
  58 @userdata:
  59 @attempt:
  60 @token_url:
  61 @token_label:
  62 @flags:
  63 @Returns:
  64
  65
  66 <!-- ##### STRUCT gnutls_pkcs11_obj_st ##### -->
  67 <para>
  68
  69 </para>
  70
  71
  72 <!-- ##### TYPEDEF gnutls_pkcs11_obj_t ##### -->
  73 <para>
  74
  75 </para>
  76
  77
  78 <!-- ##### MACRO GNUTLS_PKCS11_FLAG_MANUAL ##### -->
  79 <para>
  80
  81 </para>
  82
  83
  84
  85 <!-- ##### MACRO GNUTLS_PKCS11_FLAG_AUTO ##### -->
  86 <para>
  87
  88 </para>
  89
  90
  91
  92 <!-- ##### FUNCTION gnutls_pkcs11_init ##### -->
  93 <para>
  94
  95 </para>
  96
  97 @flags:
  98 @deprecated_config_file:
  99 @Returns:
 100
 101
 102 <!-- ##### FUNCTION gnutls_pkcs11_deinit ##### -->
 103 <para>
 104
 105 </para>
 106
 107 @void:
 108
 109
 110 <!-- ##### FUNCTION gnutls_pkcs11_set_token_function ##### -->
 111 <para>
 112
 113 </para>
 114
 115 @fn:
 116 @userdata:
 117
 118
 119 <!-- ##### FUNCTION gnutls_pkcs11_set_pin_function ##### -->
 120 <para>
 121
 122 </para>
 123
 124 @fn:
 125 @userdata:
 126
 127
 128 <!-- ##### FUNCTION gnutls_pkcs11_add_provider ##### -->
 129 <para>
 130
 131 </para>
 132
 133 @name:
 134 @params:
 135 @Returns:
 136
 137
 138 <!-- ##### FUNCTION gnutls_pkcs11_obj_init ##### -->
 139 <para>
 140
 141 </para>
 142
 143 @obj:
 144 @Returns:
 145
 146
 147 <!-- ##### MACRO GNUTLS_PKCS11_OBJ_FLAG_LOGIN ##### -->
 148 <para>
 149
 150 </para>
 151
 152
 153
 154 <!-- ##### MACRO GNUTLS_PKCS11_OBJ_FLAG_MARK_TRUSTED ##### -->
 155 <para>
 156
 157 </para>
 158
 159
 160
 161 <!-- ##### MACRO GNUTLS_PKCS11_OBJ_FLAG_MARK_SENSITIVE ##### -->
 162 <para>
 163
 164 </para>
 165
 166
 167
 168 <!-- ##### ENUM gnutls_pkcs11_url_type_t ##### -->
 169 <para>
 170
 171 </para>
 172
 173 @GNUTLS_PKCS11_URL_GENERIC:
 174 @GNUTLS_PKCS11_URL_LIB:
 175 @GNUTLS_PKCS11_URL_LIB_VERSION:
 176
 177 <!-- ##### FUNCTION gnutls_pkcs11_obj_import_url ##### -->
 178 <para>
 179
 180 </para>
 181
 182 @Param1:
 183 @url:
 184 @flags:
 185 @Returns:
 186
 187
 188 <!-- ##### FUNCTION gnutls_pkcs11_obj_export_url ##### -->
 189 <para>
 190
 191 </para>
 192
 193 @obj:
 194 @detailed:
 195 @url:
 196 @Returns:
 197
 198
 199 <!-- ##### FUNCTION gnutls_pkcs11_obj_deinit ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @obj:
 205
 206
 207 <!-- ##### FUNCTION gnutls_pkcs11_obj_export ##### -->
 208 <para>
 209
 210 </para>
 211
 212 @obj:
 213 @output_data:
 214 @output_data_size:
 215 @Returns:
 216
 217
 218 <!-- ##### FUNCTION gnutls_pkcs11_copy_x509_crt ##### -->
 219 <para>
 220
 221 </para>
 222
 223 @token_url:
 224 @crt:
 225 @label:
 226 @flags:
 227 @Returns:
 228
 229
 230 <!-- ##### FUNCTION gnutls_pkcs11_copy_x509_privkey ##### -->
 231 <para>
 232
 233 </para>
 234
 235 @token_url:
 236 @key:
 237 @label:
 238 @key_usage:
 239 @flags:
 240 @Returns:
 241
 242
 243 <!-- ##### FUNCTION gnutls_pkcs11_delete_url ##### -->
 244 <para>
 245
 246 </para>
 247
 248 @object_url:
 249 @flags:
 250 @Returns:
 251
 252
 253 <!-- ##### FUNCTION gnutls_pkcs11_copy_secret_key ##### -->
 254 <para>
 255
 256 </para>
 257
 258 @token_url:
 259 @key:
 260 @label:
 261 @key_usage:
 262 @flags:
 263 @Returns:
 264
 265
 266 <!-- ##### ENUM gnutls_pkcs11_obj_info_t ##### -->
 267 <para>
 268
 269 </para>
 270
 271 @GNUTLS_PKCS11_OBJ_ID_HEX:
 272 @GNUTLS_PKCS11_OBJ_LABEL:
 273 @GNUTLS_PKCS11_OBJ_TOKEN_LABEL:
 274 @GNUTLS_PKCS11_OBJ_TOKEN_SERIAL:
 275 @GNUTLS_PKCS11_OBJ_TOKEN_MANUFACTURER:
 276 @GNUTLS_PKCS11_OBJ_TOKEN_MODEL:
 277 @GNUTLS_PKCS11_OBJ_ID:
 278 @GNUTLS_PKCS11_OBJ_LIBRARY_VERSION:
 279 @GNUTLS_PKCS11_OBJ_LIBRARY_DESCRIPTION:
 280 @GNUTLS_PKCS11_OBJ_LIBRARY_MANUFACTURER:
 281
 282 <!-- ##### FUNCTION gnutls_pkcs11_obj_get_info ##### -->
 283 <para>
 284
 285 </para>
 286
 287 @crt:
 288 @itype:
 289 @output:
 290 @output_size:
 291 @Returns:
 292
 293
 294 <!-- ##### ENUM gnutls_pkcs11_obj_attr_t ##### -->
 295 <para>
 296
 297 </para>
 298
 299 @GNUTLS_PKCS11_OBJ_ATTR_CRT_ALL:
 300 @GNUTLS_PKCS11_OBJ_ATTR_CRT_TRUSTED:
 301 @GNUTLS_PKCS11_OBJ_ATTR_CRT_WITH_PRIVKEY:
 302 @GNUTLS_PKCS11_OBJ_ATTR_PUBKEY:
 303 @GNUTLS_PKCS11_OBJ_ATTR_PRIVKEY:
 304 @GNUTLS_PKCS11_OBJ_ATTR_ALL:
 305
 306 <!-- ##### ENUM gnutls_pkcs11_token_info_t ##### -->
 307 <para>
 308
 309 </para>
 310
 311 @GNUTLS_PKCS11_TOKEN_LABEL:
 312 @GNUTLS_PKCS11_TOKEN_SERIAL:
 313 @GNUTLS_PKCS11_TOKEN_MANUFACTURER:
 314 @GNUTLS_PKCS11_TOKEN_MODEL:
 315
 316 <!-- ##### ENUM gnutls_pkcs11_obj_type_t ##### -->
 317 <para>
 318
 319 </para>
 320
 321 @GNUTLS_PKCS11_OBJ_UNKNOWN:
 322 @GNUTLS_PKCS11_OBJ_X509_CRT:
 323 @GNUTLS_PKCS11_OBJ_PUBKEY:
 324 @GNUTLS_PKCS11_OBJ_PRIVKEY:
 325 @GNUTLS_PKCS11_OBJ_SECRET_KEY:
 326 @GNUTLS_PKCS11_OBJ_DATA:
 327
 328 <!-- ##### FUNCTION gnutls_pkcs11_token_init ##### -->
 329 <para>
 330
 331 </para>
 332
 333 @token_url:
 334 @so_pin:
 335 @label:
 336 @Returns:
 337
 338
 339 <!-- ##### FUNCTION gnutls_pkcs11_token_get_mechanism ##### -->
 340 <para>
 341
 342 </para>
 343
 344 @url:
 345 @idx:
 346 @mechanism:
 347 @Returns:
 348
 349
 350 <!-- ##### FUNCTION gnutls_pkcs11_token_set_pin ##### -->
 351 <para>
 352
 353 </para>
 354
 355 @token_url:
 356 @oldpin:
 357 @newpin:
 358 @flags:
 359 @Returns:
 360
 361
 362 <!-- ##### FUNCTION gnutls_pkcs11_token_get_url ##### -->
 363 <para>
 364
 365 </para>
 366
 367 @seq:
 368 @detailed:
 369 @url:
 370 @Returns:
 371
 372
 373 <!-- ##### FUNCTION gnutls_pkcs11_token_get_info ##### -->
 374 <para>
 375
 376 </para>
 377
 378 @url:
 379 @ttype:
 380 @output:
 381 @output_size:
 382 @Returns:
 383
 384
 385 <!-- ##### MACRO GNUTLS_PKCS11_TOKEN_HW ##### -->
 386 <para>
 387
 388 </para>
 389
 390
 391
 392 <!-- ##### FUNCTION gnutls_pkcs11_token_get_flags ##### -->
 393 <para>
 394
 395 </para>
 396
 397 @url:
 398 @flags:
 399 @Returns:
 400
 401
 402 <!-- ##### FUNCTION gnutls_pkcs11_obj_list_import_url ##### -->
 403 <para>
 404
 405 </para>
 406
 407 @p_list:
 408 @n_list:
 409 @url:
 410 @attrs:
 411 @flags:
 412 @Returns:
 413
 414
 415 <!-- ##### FUNCTION gnutls_x509_crt_import_pkcs11 ##### -->
 416 <para>
 417
 418 </para>
 419
 420 @crt:
 421 @pkcs11_crt:
 422 @Returns:
 423
 424
 425 <!-- ##### FUNCTION gnutls_x509_crt_import_pkcs11_url ##### -->
 426 <para>
 427
 428 </para>
 429
 430 @crt:
 431 @url:
 432 @flags:
 433 @Returns:
 434
 435
 436 <!-- ##### FUNCTION gnutls_pkcs11_obj_get_type ##### -->
 437 <para>
 438
 439 </para>
 440
 441 @certificate:
 442 @Returns:
 443
 444
 445 <!-- ##### FUNCTION gnutls_pkcs11_type_get_name ##### -->
 446 <para>
 447
 448 </para>
 449
 450 @Param1:
 451 @Returns:
 452
 453
 454 <!-- ##### FUNCTION gnutls_x509_crt_list_import_pkcs11 ##### -->
 455 <para>
 456
 457 </para>
 458
 459 @certs:
 460 @cert_max:
 461 @objs:
 462 @flags:
 463 @Returns:
 464
 465
 466 <!-- ##### FUNCTION gnutls_pkcs11_privkey_init ##### -->
 467 <para>
 468
 469 </para>
 470
 471 @key:
 472 @Returns:
 473
 474
 475 <!-- ##### FUNCTION gnutls_pkcs11_privkey_deinit ##### -->
 476 <para>
 477
 478 </para>
 479
 480 @key:
 481
 482
 483 <!-- ##### FUNCTION gnutls_pkcs11_privkey_get_pk_algorithm ##### -->
 484 <para>
 485
 486 </para>
 487
 488 @key:
 489 @bits:
 490 @Returns:
 491
 492
 493 <!-- ##### FUNCTION gnutls_pkcs11_privkey_get_info ##### -->
 494 <para>
 495
 496 </para>
 497
 498 @pkey:
 499 @itype:
 500 @output:
 501 @output_size:
 502 @Returns:
 503
 504
 505 <!-- ##### FUNCTION gnutls_pkcs11_privkey_import_url ##### -->
 506 <para>
 507
 508 </para>
 509
 510 @pkey:
 511 @url:
 512 @flags:
 513 @Returns:
 514
 515
 516 <!-- ##### FUNCTION gnutls_pkcs11_privkey_export_url ##### -->
 517 <para>
 518
 519 </para>
 520
 521 @key:
 522 @detailed:
 523 @url:
 524 @Returns:
 525
 526