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 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
// Copyright 2017 Marcus Heese // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. #![allow(non_camel_case_types, non_snake_case)] use types::*; /// `C_Initialize` initializes the Cryptoki library. /// /// # Function Parameters /// /// * `pInitArgs`: if this is not NULL_PTR, it gets cast to CK_C_INITIALIZE_ARGS_PTR and dereferenced /// pub type C_Initialize = extern "C" fn(pInitArgs: CK_C_INITIALIZE_ARGS_PTR) -> CK_RV; /// `C_Finalize` indicates that an application is done with the Cryptoki library. /// /// # Function Parameters /// /// * `pReserved`: reserved. Should be NULL_PTR /// pub type C_Finalize = extern "C" fn(pReserved: CK_VOID_PTR) -> CK_RV; /// `C_GetInfo` returns general information about Cryptoki. /// /// # Function Parameters /// /// * `pInfo`: location that receives information /// pub type C_GetInfo = extern "C" fn(pInfo: CK_INFO_PTR) -> CK_RV; /// `C_GetFunctionList` returns the function list. /// /// # Function Parameters /// /// * `ppFunctionList`: receives pointer to function list /// pub type C_GetFunctionList = extern "C" fn(ppFunctionList: CK_FUNCTION_LIST_PTR_PTR) -> CK_RV; /// `C_GetSlotList` obtains a list of slots in the system. /// /// # Function Parameters /// /// * `tokenPresent`: only slots with tokens /// * `pSlotList`: receives array of slot IDs /// * `pulCount`: receives number of slots /// pub type C_GetSlotList = extern "C" fn(tokenPresent: CK_BBOOL, pSlotList: CK_SLOT_ID_PTR, pulCount: CK_ULONG_PTR) -> CK_RV; /// `C_GetSlotInfo` obtains information about a particular slot in the system. /// /// # Function Parameters /// /// * `slotID`: the ID of the slot /// * `pInfo`: receives the slot information /// pub type C_GetSlotInfo = extern "C" fn(slotID: CK_SLOT_ID, pInfo: CK_SLOT_INFO_PTR) -> CK_RV; /// `C_GetTokenInfo` obtains information about a particular token in the system. /// /// # Function Parameters /// /// * `slotID`: ID of the token's slot /// * `pInfo`: receives the token information /// pub type C_GetTokenInfo = extern "C" fn(slotID: CK_SLOT_ID, pInfo: CK_TOKEN_INFO_PTR) -> CK_RV; /// `C_GetMechanismList` obtains a list of mechanism types supported by a token. /// /// # Function Parameters /// /// * `slotID`: ID of token's slot /// * `pMechanismList`: gets mech. array /// * `pulCount`: gets # of mechs. /// pub type C_GetMechanismList = extern "C" fn(slotID: CK_SLOT_ID, pMechanismList: CK_MECHANISM_TYPE_PTR, pulCount: CK_ULONG_PTR) -> CK_RV; /// `C_GetMechanismInfo` obtains information about a particular mechanism possibly supported by a token. /// /// # Function Parameters /// /// * `slotID`: ID of the token's slot /// * `mechType`: type of mechanism /// * `pInfo`: receives mechanism info /// pub type C_GetMechanismInfo = extern "C" fn(slotID: CK_SLOT_ID, mechType: CK_MECHANISM_TYPE, pInfo: CK_MECHANISM_INFO_PTR) -> CK_RV; /// `C_InitToken` initializes a token. /// /// # Function Parameters /// /// * `slotID`: ID of the token's slot /// * `pPin`: the SO's initial PIN /// * `ulPinLen`: length in bytes of the PIN /// * `pLabel`: 32-byte token label (blank padded) /// pub type C_InitToken = extern "C" fn(slotID: CK_SLOT_ID, pPin: CK_UTF8CHAR_PTR, ulPinLen: CK_ULONG, pLabel: CK_UTF8CHAR_PTR) -> CK_RV; /// `C_InitPIN` initializes the normal user's PIN. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pPin`: the normal user's PIN /// * `ulPinLen`: length in bytes of the PIN /// pub type C_InitPIN = extern "C" fn(hSession: CK_SESSION_HANDLE, pPin: CK_UTF8CHAR_PTR, ulPinLen: CK_ULONG) -> CK_RV; /// `C_SetPIN` modifies the PIN of the user who is logged in. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pOldPin`: the old PIN /// * `ulOldLen`: length of the old PIN /// * `pNewPin`: the new PIN /// * `ulNewLen`: length of the new PIN /// pub type C_SetPIN = extern "C" fn(hSession: CK_SESSION_HANDLE, pOldPin: CK_UTF8CHAR_PTR, ulOldLen: CK_ULONG, pNewPin: CK_UTF8CHAR_PTR, ulNewLen: CK_ULONG) -> CK_RV; /// `C_OpenSession` opens a session between an application and a token. /// /// # Function Parameters /// /// * `slotID`: the slot's ID /// * `flags`: from CK_SESSION_INFO /// * `pApplication`: passed to callback /// * `Notify`: callback function /// * `phSession`: gets session handle /// pub type C_OpenSession = extern "C" fn(slotID: CK_SLOT_ID, flags: CK_FLAGS, pApplication: CK_VOID_PTR, Notify: CK_NOTIFY, phSession: CK_SESSION_HANDLE_PTR) -> CK_RV; /// `C_CloseSession` closes a session between an application and a token. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// pub type C_CloseSession = extern "C" fn(hSession: CK_SESSION_HANDLE) -> CK_RV; /// `C_CloseAllSessions` closes all sessions with a token. /// /// # Function Parameters /// /// * `slotID`: the token's slot /// pub type C_CloseAllSessions = extern "C" fn(slotID: CK_SLOT_ID) -> CK_RV; /// `C_GetSessionInfo` obtains information about the session. /// /// # Function Paramters /// /// * `hSession`: the session's handle /// * `pInfo`: receives session info /// pub type C_GetSessionInfo = extern "C" fn(hSession: CK_SESSION_HANDLE, pInfo: CK_SESSION_INFO_PTR) -> CK_RV; /// `C_GetOperationState` obtains the state of the cryptographic operation in a session. /// /// # Function Paramters /// /// * `hSession`: session's handle /// * `pOperationState`: gets state /// * `pulOperationStateLen`: gets state length /// pub type C_GetOperationState = extern "C" fn(hSession: CK_SESSION_HANDLE, pOperationState: CK_BYTE_PTR, pulOperationStateLen: CK_ULONG_PTR) -> CK_RV; /// `C_SetOperationState` restores the state of the cryptographic operation in a session. /// /// # Function Paramters /// /// * `hSession`: session's handle /// * `pOperationState`: holds state /// * `ulOperationStateLen`: holds state length /// * `hEncryptionKey`: en/decryption key /// * `hAuthenticationKey`: sign/verify key /// pub type C_SetOperationState = extern "C" fn( hSession: CK_SESSION_HANDLE, pOperationState: CK_BYTE_PTR, ulOperationStateLen: CK_ULONG, hEncryptionKey: CK_OBJECT_HANDLE, hAuthenticationKey: CK_OBJECT_HANDLE, ) -> CK_RV; /// `C_Login` logs a user into a token. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `userType`: the user type /// * `pPin`: the user's PIN /// * `ulPinLen`: the length of the PIN /// pub type C_Login = extern "C" fn(hSession: CK_SESSION_HANDLE, userType: CK_USER_TYPE, pPin: CK_UTF8CHAR_PTR, ulPinLen: CK_ULONG) -> CK_RV; /// `C_Logout` logs a user out from a token. /// /// # Function Parameters /// /// * `hSession`: the session's handle pub type C_Logout = extern "C" fn(hSession: CK_SESSION_HANDLE) -> CK_RV; /// `C_CreateObject` creates a new object. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pTemplate`: the object's template /// * `ulCount`: attributes in template /// * `phObject`: gets new object's handle. /// pub type C_CreateObject = extern "C" fn(hSession: CK_SESSION_HANDLE, pTemplate: CK_ATTRIBUTE_PTR, ulCount: CK_ULONG, phObject: CK_OBJECT_HANDLE_PTR) -> CK_RV; /// `C_CopyObject` copies an object, creating a new object for the copy. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `hObject`: the object's handle /// * `pTemplate`: template for new object /// * `ulCount`: attributes in template /// * `phNewObject`: receives handle of copy /// pub type C_CopyObject = extern "C" fn(hSession: CK_SESSION_HANDLE, hObject: CK_OBJECT_HANDLE, pTemplate: CK_ATTRIBUTE_PTR, ulCount: CK_ULONG, phNewObject: CK_OBJECT_HANDLE_PTR) -> CK_RV; /// `C_DestroyObject` destroys an object. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `hObject`: the object's handle /// pub type C_DestroyObject = extern "C" fn(hSession: CK_SESSION_HANDLE, hObject: CK_OBJECT_HANDLE) -> CK_RV; /// `C_GetObjectSize` gets the size of an object in bytes. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `hObject`: the object's handle /// * `pulSize`: receives size of object /// pub type C_GetObjectSize = extern "C" fn(hSession: CK_SESSION_HANDLE, hObject: CK_OBJECT_HANDLE, pulSize: CK_ULONG_PTR) -> CK_RV; /// `C_GetAttributeValue` obtains the value of one or more object attributes. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `hObject`: the object's handle /// * `pTemplate`: specifies attrs; gets vals /// * `ulCount`: attributes in template /// pub type C_GetAttributeValue = extern "C" fn(hSession: CK_SESSION_HANDLE, hObject: CK_OBJECT_HANDLE, pTemplate: CK_ATTRIBUTE_PTR, ulCount: CK_ULONG) -> CK_RV; /// `C_SetAttributeValue` modifies the value of one or more object attributes. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `hObject`: the object's handle /// * `pTemplate`: specifies attrs and values /// * `ulCount`: attributes in template /// pub type C_SetAttributeValue = extern "C" fn(hSession: CK_SESSION_HANDLE, hObject: CK_OBJECT_HANDLE, pTemplate: CK_ATTRIBUTE_PTR, ulCount: CK_ULONG) -> CK_RV; /// `C_FindObjectsInit` initializes a search for token and session objects that match a template. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pTemplate`: attribute values to match /// * `ulCount`: attrs in search template /// pub type C_FindObjectsInit = extern "C" fn(hSession: CK_SESSION_HANDLE, pTemplate: CK_ATTRIBUTE_PTR, ulCount: CK_ULONG) -> CK_RV; /// `C_FindObjects` continues a search for token and session objects that match a template, obtaining additional object handles. /// /// # Function Parameters /// /// * `hSession`: session's handle /// * `phObject`: gets obj. handles /// * `ulMaxObjectCount`: max handles to get /// * `pulObjectCount`: actual # returned /// pub type C_FindObjects = extern "C" fn(hSession: CK_SESSION_HANDLE, phObject: CK_OBJECT_HANDLE_PTR, ulMaxObjectCount: CK_ULONG, pulObjectCount: CK_ULONG_PTR) -> CK_RV; /// `C_FindObjectsFinal` finishes a search for token and session objects. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// pub type C_FindObjectsFinal = extern "C" fn(hSession: CK_SESSION_HANDLE) -> CK_RV; /// `C_EncryptInit` initializes an encryption operation. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pMechanism`: the encryption mechanism /// * `hKey`: handle of encryption key /// pub type C_EncryptInit = extern "C" fn(hSession: CK_SESSION_HANDLE, pMechanism: CK_MECHANISM_PTR, hKey: CK_OBJECT_HANDLE) -> CK_RV; /// `C_Encrypt` encrypts single-part data. /// /// # Function Parameters /// /// * `hSession`: session's handle /// * `pData`: the plaintext data /// * `ulDataLen`: bytes of plaintext /// * `pEncryptedData`: gets ciphertext /// * `pulEncryptedDataLen`: gets c-text size /// pub type C_Encrypt = extern "C" fn(hSession: CK_SESSION_HANDLE, pData: CK_BYTE_PTR, ulDataLen: CK_ULONG, pEncryptedData: CK_BYTE_PTR, pulEncryptedDataLen: CK_ULONG_PTR) -> CK_RV; /// `C_EncryptUpdate` continues a multiple-part encryption operation. /// /// # Function Parameters /// /// * `hSession`: session's handle /// * `pPart`: the plaintext data /// * `ulPartLen`: plaintext data len /// * `pEncryptedPart`: gets ciphertext /// * `pulEncryptedPartLen`: gets c-text size /// pub type C_EncryptUpdate = extern "C" fn(hSession: CK_SESSION_HANDLE, pPart: CK_BYTE_PTR, ulPartLen: CK_ULONG, pEncryptedPart: CK_BYTE_PTR, pulEncryptedPartLen: CK_ULONG_PTR) -> CK_RV; /// `C_EncryptFinal` finishes a multiple-part encryption operation /// /// # Function Parameters /// /// * `hSession`: session handle /// * `pLastEncryptedPart` last c-text /// * `pulLastEncryptedPartLen`: gets last size /// pub type C_EncryptFinal = extern "C" fn(hSession: CK_SESSION_HANDLE, pLastEncryptedPart: CK_BYTE_PTR, pulLastEncryptedPartLen: CK_ULONG_PTR) -> CK_RV; /// `C_DecryptInit` initializes a decryption operation. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pMechanism`: the decryption mechanism /// * `hKey`: handle of decryption key /// pub type C_DecryptInit = extern "C" fn(hSession: CK_SESSION_HANDLE, pMechanism: CK_MECHANISM_PTR, hKey: CK_OBJECT_HANDLE) -> CK_RV; /// `C_Decrypt` decrypts encrypted data in a single part. /// /// # Function Parameters /// /// * `hSession`: session's handle /// * `pEncryptedData`: ciphertext /// * `ulEncryptedDataLen`: ciphertext length /// * `pData`: gets plaintext /// * `pulDataLen`: gets p-text size /// pub type C_Decrypt = extern "C" fn(hSession: CK_SESSION_HANDLE, pEncryptedData: CK_BYTE_PTR, ulEncryptedDataLen: CK_ULONG, pData: CK_BYTE_PTR, pulDataLen: CK_ULONG_PTR) -> CK_RV; /// `C_DecryptUpdate` continues a multiple-part decryption operation. /// /// # Function Parameters /// /// * `hSession`: session's handle /// * `pEncryptedPart`: encrypted data /// * `ulEncryptedPartLen`: input length /// * `pPart`: gets plaintext /// * `pulPartLen`: p-text size /// pub type C_DecryptUpdate = extern "C" fn(hSession: CK_SESSION_HANDLE, pEncryptedPart: CK_BYTE_PTR, ulEncryptedPartLen: CK_ULONG, pPart: CK_BYTE_PTR, pulPartLen: CK_ULONG_PTR) -> CK_RV; /// `C_DecryptFinal` finishes a multiple-part decryption operation. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pLastPart`: gets plaintext /// * `pulLastPartLen`: p-text size /// pub type C_DecryptFinal = extern "C" fn(hSession: CK_SESSION_HANDLE, pLastPart: CK_BYTE_PTR, pulLastPartLen: CK_ULONG_PTR) -> CK_RV; /// `C_DigestInit` initializes a message-digesting operation. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pMechanism`: the digesting mechanism /// pub type C_DigestInit = extern "C" fn(hSession: CK_SESSION_HANDLE, pMechanism: CK_MECHANISM_PTR) -> CK_RV; /// `C_Digest` digests data in a single part. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pData`: data to be digested /// * `ulDataLen`: bytes of data to digest /// * `pDigest`: gets the message digest /// * `pulDigestLen`: gets digest length /// pub type C_Digest = extern "C" fn(hSession: CK_SESSION_HANDLE, pData: CK_BYTE_PTR, ulDataLen: CK_ULONG, pDigest: CK_BYTE_PTR, pulDigestLen: CK_ULONG_PTR) -> CK_RV; /// `C_DigestUpdate` continues a multiple-part message-digesting operation. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pPart`: data to be digested /// * `ulPartLen`: bytes of data to be digested /// pub type C_DigestUpdate = extern "C" fn(hSession: CK_SESSION_HANDLE, pPart: CK_BYTE_PTR, ulPartLen: CK_ULONG) -> CK_RV; /// `C_DigestKey` continues a multi-part message-digesting operation, by digesting the value of a secret key as part of the data already digested. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `hKey`: secret key to digest pub type C_DigestKey = extern "C" fn(hSession: CK_SESSION_HANDLE, hKey: CK_OBJECT_HANDLE) -> CK_RV; /// `C_DigestFinal` finishes a multiple-part message-digesting operation. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pDigest`: gets the message digest /// * `pulDigestLen`: gets byte count of digest /// pub type C_DigestFinal = extern "C" fn(hSession: CK_SESSION_HANDLE, pDigest: CK_BYTE_PTR, pulDigestLen: CK_ULONG_PTR) -> CK_RV; /// `C_SignInit` initializes a signature (private key encryption) operation, where the signature is (will be) an appendix to the data, and plaintext cannot be recovered from the signature. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pMechanism`: the signature mechanism /// * `hKey`: handle of signature key /// pub type C_SignInit = extern "C" fn(hSession: CK_SESSION_HANDLE, pMechanism: CK_MECHANISM_PTR, hKey: CK_OBJECT_HANDLE) -> CK_RV; /// `C_Sign` signs (encrypts with private key) data in a single part, where the signature is (will be) an appendix to the data, and plaintext cannot be recovered from the signature. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pData`: the data to sign /// * `ulDataLen`: count of bytes to sign /// * `pSignature`: gets the signature /// * `pulSignatureLen`: gets signature length /// pub type C_Sign = extern "C" fn(hSession: CK_SESSION_HANDLE, pData: CK_BYTE_PTR, ulDataLen: CK_ULONG, pSignature: CK_BYTE_PTR, pulSignatureLen: CK_ULONG_PTR) -> CK_RV; /// `C_SignUpdate` continues a multiple-part signature operation, where the signature is (will be) an appendix to the data, and plaintext cannot be recovered from the signature. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pPart`: the data to sign /// * `ulPartLen`: count of bytes to sign /// pub type C_SignUpdate = extern "C" fn(hSession: CK_SESSION_HANDLE, pPart: CK_BYTE_PTR, ulPartLen: CK_ULONG) -> CK_RV; /// `C_SignFinal` finishes a multiple-part signature operation, returning the signature. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pSignature`: gets the signature /// * `pulSignatureLen`: gets signature length /// pub type C_SignFinal = extern "C" fn(hSession: CK_SESSION_HANDLE, pSignature: CK_BYTE_PTR, pulSignatureLen: CK_ULONG_PTR) -> CK_RV; /// `C_SignRecoverInit` initializes a signature operation, where the data can be recovered from the signature. /// `hSession`: the session's handle /// `pMechanism`: the signature mechanism /// `hKey`: handle of the signature key pub type C_SignRecoverInit = extern "C" fn(hSession: CK_SESSION_HANDLE, pMechanism: CK_MECHANISM_PTR, hKey: CK_OBJECT_HANDLE) -> CK_RV; /// `C_SignRecover` signs data in a single operation, where the data can be recovered from the signature. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pData`: the data to sign /// * `ulDataLen`: count of bytes to sign /// * `pSignature`: gets the signature /// * `pulSignatureLen`: gets signature length /// pub type C_SignRecover = extern "C" fn(hSession: CK_SESSION_HANDLE, pData: CK_BYTE_PTR, ulDataLen: CK_ULONG, pSignature: CK_BYTE_PTR, pulSignatureLen: CK_ULONG_PTR) -> CK_RV; /// `C_VerifyInit` initializes a verification operation, where the signature is an appendix to the data, and plaintext cannot cannot be recovered from the signature (e.g. DSA). /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pMechanism`: the verification mechanism /// * `hKey`: verification key /// pub type C_VerifyInit = extern "C" fn(hSession: CK_SESSION_HANDLE, pMechanism: CK_MECHANISM_PTR, hKey: CK_OBJECT_HANDLE) -> CK_RV; /// `C_Verify` verifies a signature in a single-part operation, where the signature is an appendix to the data, and plaintext cannot be recovered from the signature. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pData`: signed data /// * `ulDataLen`: length of signed data /// * `pSignature`: signature /// * `ulSignatureLen`: signature length /// pub type C_Verify = extern "C" fn(hSession: CK_SESSION_HANDLE, pData: CK_BYTE_PTR, ulDataLen: CK_ULONG, pSignature: CK_BYTE_PTR, ulSignatureLen: CK_ULONG) -> CK_RV; /// `C_VerifyUpdate` continues a multiple-part verification operation, where the signature is an appendix to the data, and plaintext cannot be recovered from the signature. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pPart`: signed data /// * `ulPartLen`: length of signed data /// pub type C_VerifyUpdate = extern "C" fn(hSession: CK_SESSION_HANDLE, pPart: CK_BYTE_PTR, ulPartLen: CK_ULONG) -> CK_RV; /// `C_VerifyFinal` finishes a multiple-part verification operation, checking the signature. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pSignature`: signature to verify /// * `ulSignatureLen`: signature length /// pub type C_VerifyFinal = extern "C" fn(hSession: CK_SESSION_HANDLE, pSignature: CK_BYTE_PTR, ulSignatureLen: CK_ULONG) -> CK_RV; /// `C_VerifyRecoverInit` initializes a signature verification operation, where the data is recovered from the signature. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pMechanism`: the verification mechanism /// * `hKey`: verification key /// pub type C_VerifyRecoverInit = extern "C" fn(hSession: CK_SESSION_HANDLE, pMechanism: CK_MECHANISM_PTR, hKey: CK_OBJECT_HANDLE) -> CK_RV; /// `C_VerifyRecover` verifies a signature in a single-part operation, where the data is recovered from the signature. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pSignature`: signature to verify /// * `ulSignatureLen`: signature length /// * `pData`: gets signed data /// * `pulDataLen`: gets signed data len /// pub type C_VerifyRecover = extern "C" fn(hSession: CK_SESSION_HANDLE, pSignature: CK_BYTE_PTR, ulSignatureLen: CK_ULONG, pData: CK_BYTE_PTR, pulDataLen: CK_ULONG_PTR) -> CK_RV; /// `C_DigestEncryptUpdate` continues a multiple-part digesting and encryption operation. /// /// # Function Parameters /// /// * `hSession`: session's handle /// * `pPart`: the plaintext data /// * `ulPartLen`: plaintext length /// * `pEncryptedPart`: gets ciphertext /// * `pulEncryptedPartLen`: gets c-text length /// pub type C_DigestEncryptUpdate = extern "C" fn(hSession: CK_SESSION_HANDLE, pPart: CK_BYTE_PTR, ulPartLen: CK_ULONG, pEncryptedPart: CK_BYTE_PTR, pulEncryptedPartLen: CK_ULONG_PTR) -> CK_RV; /// `C_DecryptDigestUpdate` continues a multiple-part decryption and digesting operation. /// /// # Function Parameters /// /// * `hSession`: session's handle /// * `pEncryptedPart`: ciphertext /// * `ulEncryptedPartLen`: ciphertext length /// * `pPart:`: gets plaintext /// * `pulPartLen`: gets plaintext len /// pub type C_DecryptDigestUpdate = extern "C" fn(hSession: CK_SESSION_HANDLE, pEncryptedPart: CK_BYTE_PTR, ulEncryptedPartLen: CK_ULONG, pPart: CK_BYTE_PTR, pulPartLen: CK_ULONG_PTR) -> CK_RV; /// `C_SignEncryptUpdate` continues a multiple-part signing and encryption operation. /// /// # Function Parameters /// /// * `hSession`: session's handle /// * `pPart`: the plaintext data /// * `ulPartLen`: plaintext length /// * `pEncryptedPart`: gets ciphertext /// * `pulEncryptedPartLen`: gets c-text length /// pub type C_SignEncryptUpdate = extern "C" fn(hSession: CK_SESSION_HANDLE, pPart: CK_BYTE_PTR, ulPartLen: CK_ULONG, pEncryptedPart: CK_BYTE_PTR, pulEncryptedPartLen: CK_ULONG_PTR) -> CK_RV; /// `C_DecryptVerifyUpdate` continues a multiple-part decryption and verify operation. /// /// # Function Parameters /// /// * `hSession`: session's handle /// * `pEncryptedPart`: ciphertext /// * `ulEncryptedPartLen`: ciphertext length /// * `pPart`: gets plaintext /// * `pulPartLen`: gets p-text length /// pub type C_DecryptVerifyUpdate = extern "C" fn(hSession: CK_SESSION_HANDLE, pEncryptedPart: CK_BYTE_PTR, ulEncryptedPartLen: CK_ULONG, pPart: CK_BYTE_PTR, pulPartLen: CK_ULONG_PTR) -> CK_RV; /// `C_GenerateKey` generates a secret key, creating a new key object. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pMechanism`: key generation mech. /// * `pTemplate`: template for new key /// * `ulCount`: # of attrs in template /// * `phKey`: gets handle of new key /// pub type C_GenerateKey = extern "C" fn(hSession: CK_SESSION_HANDLE, pMechanism: CK_MECHANISM_PTR, pTemplate: CK_ATTRIBUTE_PTR, ulCount: CK_ULONG, phKey: CK_OBJECT_HANDLE_PTR) -> CK_RV; /// `C_GenerateKeyPair` generates a public-key/private-key pair, creating new key objects. /// /// # Function Parameters /// /// * `hSession`: session handle /// * `pMechanism`: key-gen mech. /// * `pPublicKeyTemplate`: template for pub. key /// * `ulPublicKeyAttributeCount`: # pub. attrs. /// * `pPrivateKeyTemplate`: template for priv. key /// * `ulPrivateKeyAttributeCount`: # priv. attrs. /// * `phPublicKey`: gets pub. key handle /// * `phPrivateKey`: gets priv. key handle /// pub type C_GenerateKeyPair = extern "C" fn( hSession: CK_SESSION_HANDLE, pMechanism: CK_MECHANISM_PTR, pPublicKeyTemplate: CK_ATTRIBUTE_PTR, ulPublicKeyAttributeCount: CK_ULONG, pPrivateKeyTemplate: CK_ATTRIBUTE_PTR, ulPrivateKeyAttributeCount: CK_ULONG, phPublicKey: CK_OBJECT_HANDLE_PTR, phPrivateKey: CK_OBJECT_HANDLE_PTR, ) -> CK_RV; /// `C_WrapKey` wraps (i.e., encrypts) a key. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pMechanism`: the wrapping mechanism /// * `hWrappingKey`: wrapping key /// * `hKey`: key to be wrapped /// * `pWrappedKey`: gets wrapped key /// * `pulWrappedKeyLen`: gets wrapped key size /// pub type C_WrapKey = extern "C" fn( hSession: CK_SESSION_HANDLE, pMechanism: CK_MECHANISM_PTR, hWrappingKey: CK_OBJECT_HANDLE, hKey: CK_OBJECT_HANDLE, pWrappedKey: CK_BYTE_PTR, pulWrappedKeyLen: CK_ULONG_PTR, ) -> CK_RV; /// `C_UnwrapKey` unwraps (decrypts) a wrapped key, creating a new key object. /// /// # Function Parameters /// /// * `hSession`: session's handle /// * `pMechanism`: unwrapping mech. /// * `hUnwrappingKey`: unwrapping key /// * `pWrappedKey`: the wrapped key /// * `ulWrappedKeyLen`: wrapped key len /// * `pTemplate`: new key template /// * `ulAttributeCount`: template length /// * `phKey`: gets new handle /// pub type C_UnwrapKey = extern "C" fn( hSession: CK_SESSION_HANDLE, pMechanism: CK_MECHANISM_PTR, hUnwrappingKey: CK_OBJECT_HANDLE, pWrappedKey: CK_BYTE_PTR, ulWrappedKeyLen: CK_ULONG, pTemplate: CK_ATTRIBUTE_PTR, ulAttributeCount: CK_ULONG, phKey: CK_OBJECT_HANDLE_PTR, ) -> CK_RV; /// `C_DeriveKey` derives a key from a base key, creating a new key object. /// /// # Function Parameters /// /// * `hSession`: session's handle /// * `pMechanism`: key deriv. mech. /// * `hBaseKey`: base key /// * `pTemplate`: new key template /// * `ulAttributeCount`: template length /// * `phKey`: gets new handle /// pub type C_DeriveKey = extern "C" fn( hSession: CK_SESSION_HANDLE, pMechanism: CK_MECHANISM_PTR, hBaseKey: CK_OBJECT_HANDLE, pTemplate: CK_ATTRIBUTE_PTR, ulAttributeCount: CK_ULONG, phKey: CK_OBJECT_HANDLE_PTR, ) -> CK_RV; /// `C_SeedRandom` mixes additional seed material into the token's random number generator. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `pSeed`: the seed material /// * `ulSeedLen`: length of seed material /// pub type C_SeedRandom = extern "C" fn(hSession: CK_SESSION_HANDLE, pSeed: CK_BYTE_PTR, ulSeedLen: CK_ULONG) -> CK_RV; /// `C_GenerateRandom` generates random data. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// * `RandomData`: receives the random data /// * `ulRandomLen`: # of bytes to generate /// pub type C_GenerateRandom = extern "C" fn(hSession: CK_SESSION_HANDLE, RandomData: CK_BYTE_PTR, ulRandomLen: CK_ULONG) -> CK_RV; /// `C_GetFunctionStatus` is a legacy function; it obtains an updated status of a function running in parallel with an application. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// pub type C_GetFunctionStatus = extern "C" fn(hSession: CK_SESSION_HANDLE) -> CK_RV; /// `C_CancelFunction` is a legacy function; it cancels a function running in parallel. /// /// # Function Parameters /// /// * `hSession`: the session's handle /// pub type C_CancelFunction = extern "C" fn(hSession: CK_SESSION_HANDLE) -> CK_RV; /// `C_WaitForSlotEvent` waits for a slot event (token insertion, removal, etc.) to occur. /// /// # Function Parameters /// /// * `flags`: blocking/nonblocking flag /// * `pSlot`: location that receives the slot ID /// * `pRserved`: reserved. Should be NULL_PTR /// pub type C_WaitForSlotEvent = extern "C" fn(flags: CK_FLAGS, pSlot: CK_SLOT_ID_PTR, pRserved: CK_VOID_PTR) -> CK_RV;