/usr/include/firefox/nssckmdt.h is in firefox-dev 11.0+build1-0ubuntu4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 | /* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Netscape security libraries.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1994-2000
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#ifndef NSSCKMDT_H
#define NSSCKMDT_H
#ifdef DEBUG
static const char NSSCKMDT_CVS_ID[] = "@(#) $RCSfile: nssckmdt.h,v $ $Revision: 1.6 $ $Date: 2005/12/16 00:48:01 $";
#endif /* DEBUG */
/*
* nssckmdt.h
*
* This file specifies the basic types that must be implemented by
* any Module using the NSS Cryptoki Framework.
*/
#ifndef NSSBASET_H
#include "nssbaset.h"
#endif /* NSSBASET_H */
#ifndef NSSCKT_H
#include "nssckt.h"
#endif /* NSSCKT_H */
#ifndef NSSCKFWT_H
#include "nssckfwt.h"
#endif /* NSSCKFWT_H */
typedef struct NSSCKMDInstanceStr NSSCKMDInstance;
typedef struct NSSCKMDSlotStr NSSCKMDSlot;
typedef struct NSSCKMDTokenStr NSSCKMDToken;
typedef struct NSSCKMDSessionStr NSSCKMDSession;
typedef struct NSSCKMDCryptoOperationStr NSSCKMDCryptoOperation;
typedef struct NSSCKMDFindObjectsStr NSSCKMDFindObjects;
typedef struct NSSCKMDMechanismStr NSSCKMDMechanism;
typedef struct NSSCKMDObjectStr NSSCKMDObject;
/*
* NSSCKFWItem
*
* This is a structure used by modules to return object attributes.
* The needsFreeing bit indicates whether the object needs to be freed.
* If so, the framework will call the FreeAttribute function on the item
* after it is done using it.
*
*/
typedef struct {
PRBool needsFreeing;
NSSItem* item;
} NSSCKFWItem ;
/*
* NSSCKMDInstance
*
* This is the basic handle for an instance of a PKCS#11 Module.
* It is returned by the Module's CreateInstance routine, and
* may be obtained from the corresponding NSSCKFWInstance object.
* It contains a pointer for use by the Module, to store any
* instance-related data, and it contains the EPV for a set of
* routines which the Module may implement for use by the Framework.
* Some of these routines are optional; others are mandatory.
*/
struct NSSCKMDInstanceStr {
/*
* The Module may use this pointer for its own purposes.
*/
void *etc;
/*
* This routine is called by the Framework to initialize
* the Module. This routine is optional; if unimplemented,
* it won't be called. If this routine returns an error,
* then the initialization will fail.
*/
CK_RV (PR_CALLBACK *Initialize)(
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSUTF8 *configurationData
);
/*
* This routine is called when the Framework is finalizing
* the PKCS#11 Module. It is the last thing called before
* the NSSCKFWInstance's NSSArena is destroyed. This routine
* is optional; if unimplemented, it merely won't be called.
*/
void (PR_CALLBACK *Finalize)(
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine gets the number of slots. This value must
* never change, once the instance is initialized. This
* routine must be implemented. It may return zero on error.
*/
CK_ULONG (PR_CALLBACK *GetNSlots)(
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_RV *pError
);
/*
* This routine returns the version of the Cryptoki standard
* to which this Module conforms. This routine is optional;
* if unimplemented, the Framework uses the version to which
* ~it~ was implemented.
*/
CK_VERSION (PR_CALLBACK *GetCryptokiVersion)(
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns a pointer to a UTF8-encoded string
* containing the manufacturer ID for this Module. Only
* the characters completely encoded in the first thirty-
* two bytes are significant. This routine is optional.
* The string returned is never freed; if dynamically generated,
* the space for it should be allocated from the NSSArena
* that may be obtained from the NSSCKFWInstance. This
* routine may return NULL upon error; however if *pError
* is CKR_OK, the NULL will be considered the valid response.
*/
NSSUTF8 *(PR_CALLBACK *GetManufacturerID)(
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_RV *pError
);
/*
* This routine returns a pointer to a UTF8-encoded string
* containing a description of this Module library. Only
* the characters completely encoded in the first thirty-
* two bytes are significant. This routine is optional.
* The string returned is never freed; if dynamically generated,
* the space for it should be allocated from the NSSArena
* that may be obtained from the NSSCKFWInstance. This
* routine may return NULL upon error; however if *pError
* is CKR_OK, the NULL will be considered the valid response.
*/
NSSUTF8 *(PR_CALLBACK *GetLibraryDescription)(
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_RV *pError
);
/*
* This routine returns the version of this Module library.
* This routine is optional; if unimplemented, the Framework
* will assume a Module library version of 0.1.
*/
CK_VERSION (PR_CALLBACK *GetLibraryVersion)(
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns CK_TRUE if the Module wishes to
* handle session objects. This routine is optional.
* If this routine is NULL, or if it exists but returns
* CK_FALSE, the Framework will assume responsibility
* for managing session objects.
*/
CK_BBOOL (PR_CALLBACK *ModuleHandlesSessionObjects)(
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine stuffs pointers to NSSCKMDSlot objects into
* the specified array; one for each slot supported by this
* instance. The Framework will determine the size needed
* for the array by calling GetNSlots. This routine is
* required.
*/
CK_RV (PR_CALLBACK *GetSlots)(
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSCKMDSlot *slots[]
);
/*
* This call returns a pointer to the slot in which an event
* has occurred. If the block argument is CK_TRUE, the call
* should block until a slot event occurs; if CK_FALSE, it
* should check to see if an event has occurred, occurred,
* but return NULL (and set *pError to CK_NO_EVENT) if one
* hasn't. This routine is optional; if unimplemented, the
* Framework will assume that no event has happened. This
* routine may return NULL upon error.
*/
NSSCKMDSlot *(PR_CALLBACK *WaitForSlotEvent)(
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_BBOOL block,
CK_RV *pError
);
/*
* This object may be extended in future versions of the
* NSS Cryptoki Framework. To allow for some flexibility
* in the area of binary compatibility, this field should
* be NULL.
*/
void *null;
};
/*
* NSSCKMDSlot
*
* This is the basic handle for a PKCS#11 Module Slot. It is
* created by the NSSCKMDInstance->GetSlots call, and may be
* obtained from the Framework's corresponding NSSCKFWSlot
* object. It contains a pointer for use by the Module, to
* store any slot-related data, and it contains the EPV for
* a set of routines which the Module may implement for use
* by the Framework. Some of these routines are optional.
*/
struct NSSCKMDSlotStr {
/*
* The Module may use this pointer for its own purposes.
*/
void *etc;
/*
* This routine is called during the Framework initialization
* step, after the Framework Instance has obtained the list
* of slots (by calling NSSCKMDInstance->GetSlots). Any slot-
* specific initialization can be done here. This routine is
* optional; if unimplemented, it won't be called. Note that
* if this routine returns an error, the entire Framework
* initialization for this Module will fail.
*/
CK_RV (PR_CALLBACK *Initialize)(
NSSCKMDSlot *mdSlot,
NSSCKFWSlot *fwSlot,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine is called when the Framework is finalizing
* the PKCS#11 Module. This call (for each of the slots)
* is the last thing called before NSSCKMDInstance->Finalize.
* This routine is optional; if unimplemented, it merely
* won't be called. Note: In the rare circumstance that
* the Framework initialization cannot complete (due to,
* for example, memory limitations), this can be called with
* a NULL value for fwSlot.
*/
void (PR_CALLBACK *Destroy)(
NSSCKMDSlot *mdSlot,
NSSCKFWSlot *fwSlot,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns a pointer to a UTF8-encoded string
* containing a description of this slot. Only the characters
* completely encoded in the first sixty-four bytes are
* significant. This routine is optional. The string
* returned is never freed; if dynamically generated,
* the space for it should be allocated from the NSSArena
* that may be obtained from the NSSCKFWInstance. This
* routine may return NULL upon error; however if *pError
* is CKR_OK, the NULL will be considered the valid response.
*/
NSSUTF8 *(PR_CALLBACK *GetSlotDescription)(
NSSCKMDSlot *mdSlot,
NSSCKFWSlot *fwSlot,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_RV *pError
);
/*
* This routine returns a pointer to a UTF8-encoded string
* containing a description of the manufacturer of this slot.
* Only the characters completely encoded in the first thirty-
* two bytes are significant. This routine is optional.
* The string returned is never freed; if dynamically generated,
* the space for it should be allocated from the NSSArena
* that may be obtained from the NSSCKFWInstance. This
* routine may return NULL upon error; however if *pError
* is CKR_OK, the NULL will be considered the valid response.
*/
NSSUTF8 *(PR_CALLBACK *GetManufacturerID)(
NSSCKMDSlot *mdSlot,
NSSCKFWSlot *fwSlot,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_RV *pError
);
/*
* This routine returns CK_TRUE if a token is present in this
* slot. This routine is optional; if unimplemented, CK_TRUE
* is assumed.
*/
CK_BBOOL (PR_CALLBACK *GetTokenPresent)(
NSSCKMDSlot *mdSlot,
NSSCKFWSlot *fwSlot,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns CK_TRUE if the slot supports removable
* tokens. This routine is optional; if unimplemented, CK_FALSE
* is assumed.
*/
CK_BBOOL (PR_CALLBACK *GetRemovableDevice)(
NSSCKMDSlot *mdSlot,
NSSCKFWSlot *fwSlot,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns CK_TRUE if this slot is a hardware
* device, or CK_FALSE if this slot is a software device. This
* routine is optional; if unimplemented, CK_FALSE is assumed.
*/
CK_BBOOL (PR_CALLBACK *GetHardwareSlot)(
NSSCKMDSlot *mdSlot,
NSSCKFWSlot *fwSlot,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns the version of this slot's hardware.
* This routine is optional; if unimplemented, the Framework
* will assume a hardware version of 0.1.
*/
CK_VERSION (PR_CALLBACK *GetHardwareVersion)(
NSSCKMDSlot *mdSlot,
NSSCKFWSlot *fwSlot,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns the version of this slot's firmware.
* This routine is optional; if unimplemented, the Framework
* will assume a hardware version of 0.1.
*/
CK_VERSION (PR_CALLBACK *GetFirmwareVersion)(
NSSCKMDSlot *mdSlot,
NSSCKFWSlot *fwSlot,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine should return a pointer to an NSSCKMDToken
* object corresponding to the token in the specified slot.
* The NSSCKFWToken object passed in has an NSSArena
* available which is dedicated for this token. This routine
* must be implemented. This routine may return NULL upon
* error.
*/
NSSCKMDToken *(PR_CALLBACK *GetToken)(
NSSCKMDSlot *mdSlot,
NSSCKFWSlot *fwSlot,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_RV *pError
);
/*
* This object may be extended in future versions of the
* NSS Cryptoki Framework. To allow for some flexibility
* in the area of binary compatibility, this field should
* be NULL.
*/
void *null;
};
/*
* NSSCKMDToken
*
* This is the basic handle for a PKCS#11 Token. It is created by
* the NSSCKMDSlot->GetToken call, and may be obtained from the
* Framework's corresponding NSSCKFWToken object. It contains a
* pointer for use by the Module, to store any token-related
* data, and it contains the EPV for a set of routines which the
* Module may implement for use by the Framework. Some of these
* routines are optional.
*/
struct NSSCKMDTokenStr {
/*
* The Module may use this pointer for its own purposes.
*/
void *etc;
/*
* This routine is used to prepare a Module token object for
* use. It is called after the NSSCKMDToken object is obtained
* from NSSCKMDSlot->GetToken. It is named "Setup" here because
* Cryptoki already defines "InitToken" to do the process of
* wiping out any existing state on a token and preparing it for
* a new use. This routine is optional; if unimplemented, it
* merely won't be called.
*/
CK_RV (PR_CALLBACK *Setup)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine is called by the Framework whenever it notices
* that the token object is invalid. (Typically this is when a
* routine indicates an error such as CKR_DEVICE_REMOVED). This
* call is the last thing called before the NSSArena in the
* corresponding NSSCKFWToken is destroyed. This routine is
* optional; if unimplemented, it merely won't be called.
*/
void (PR_CALLBACK *Invalidate)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine initialises the token in the specified slot.
* This routine is optional; if unimplemented, the Framework
* will fail this operation with an error of CKR_DEVICE_ERROR.
*/
CK_RV (PR_CALLBACK *InitToken)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSItem *pin,
NSSUTF8 *label
);
/*
* This routine returns a pointer to a UTF8-encoded string
* containing this token's label. Only the characters
* completely encoded in the first thirty-two bytes are
* significant. This routine is optional. The string
* returned is never freed; if dynamically generated,
* the space for it should be allocated from the NSSArena
* that may be obtained from the NSSCKFWInstance. This
* routine may return NULL upon error; however if *pError
* is CKR_OK, the NULL will be considered the valid response.
*/
NSSUTF8 *(PR_CALLBACK *GetLabel)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_RV *pError
);
/*
* This routine returns a pointer to a UTF8-encoded string
* containing this token's manufacturer ID. Only the characters
* completely encoded in the first thirty-two bytes are
* significant. This routine is optional. The string
* returned is never freed; if dynamically generated,
* the space for it should be allocated from the NSSArena
* that may be obtained from the NSSCKFWInstance. This
* routine may return NULL upon error; however if *pError
* is CKR_OK, the NULL will be considered the valid response.
*/
NSSUTF8 *(PR_CALLBACK *GetManufacturerID)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_RV *pError
);
/*
* This routine returns a pointer to a UTF8-encoded string
* containing this token's model name. Only the characters
* completely encoded in the first thirty-two bytes are
* significant. This routine is optional. The string
* returned is never freed; if dynamically generated,
* the space for it should be allocated from the NSSArena
* that may be obtained from the NSSCKFWInstance. This
* routine may return NULL upon error; however if *pError
* is CKR_OK, the NULL will be considered the valid response.
*/
NSSUTF8 *(PR_CALLBACK *GetModel)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_RV *pError
);
/*
* This routine returns a pointer to a UTF8-encoded string
* containing this token's serial number. Only the characters
* completely encoded in the first thirty-two bytes are
* significant. This routine is optional. The string
* returned is never freed; if dynamically generated,
* the space for it should be allocated from the NSSArena
* that may be obtained from the NSSCKFWInstance. This
* routine may return NULL upon error; however if *pError
* is CKR_OK, the NULL will be considered the valid response.
*/
NSSUTF8 *(PR_CALLBACK *GetSerialNumber)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_RV *pError
);
/*
* This routine returns CK_TRUE if the token has its own
* random number generator. This routine is optional; if
* unimplemented, CK_FALSE is assumed.
*/
CK_BBOOL (PR_CALLBACK *GetHasRNG)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns CK_TRUE if this token is write-protected.
* This routine is optional; if unimplemented, CK_FALSE is
* assumed.
*/
CK_BBOOL (PR_CALLBACK *GetIsWriteProtected)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns CK_TRUE if this token requires a login.
* This routine is optional; if unimplemented, CK_FALSE is
* assumed.
*/
CK_BBOOL (PR_CALLBACK *GetLoginRequired)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns CK_TRUE if the normal user's PIN on this
* token has been initialised. This routine is optional; if
* unimplemented, CK_FALSE is assumed.
*/
CK_BBOOL (PR_CALLBACK *GetUserPinInitialized)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns CK_TRUE if a successful save of a
* session's cryptographic operations state ~always~ contains
* all keys needed to restore the state of the session. This
* routine is optional; if unimplemented, CK_FALSE is assumed.
*/
CK_BBOOL (PR_CALLBACK *GetRestoreKeyNotNeeded)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns CK_TRUE if the token has its own
* hardware clock. This routine is optional; if unimplemented,
* CK_FALSE is assumed.
*/
CK_BBOOL (PR_CALLBACK *GetHasClockOnToken)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns CK_TRUE if the token has a protected
* authentication path. This routine is optional; if
* unimplemented, CK_FALSE is assumed.
*/
CK_BBOOL (PR_CALLBACK *GetHasProtectedAuthenticationPath)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns CK_TRUE if the token supports dual
* cryptographic operations within a single session. This
* routine is optional; if unimplemented, CK_FALSE is assumed.
*/
CK_BBOOL (PR_CALLBACK *GetSupportsDualCryptoOperations)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* XXX fgmr-- should we have a call to return all the flags
* at once, for folks who already know about Cryptoki?
*/
/*
* This routine returns the maximum number of sessions that
* may be opened on this token. This routine is optional;
* if unimplemented, the special value CK_UNAVAILABLE_INFORMATION
* is assumed. XXX fgmr-- or CK_EFFECTIVELY_INFINITE?
*/
CK_ULONG (PR_CALLBACK *GetMaxSessionCount)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns the maximum number of read/write
* sesisons that may be opened on this token. This routine
* is optional; if unimplemented, the special value
* CK_UNAVAILABLE_INFORMATION is assumed. XXX fgmr-- or
* CK_EFFECTIVELY_INFINITE?
*/
CK_ULONG (PR_CALLBACK *GetMaxRwSessionCount)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns the maximum PIN code length that is
* supported on this token. This routine is optional;
* if unimplemented, the special value CK_UNAVAILABLE_INFORMATION
* is assumed.
*/
CK_ULONG (PR_CALLBACK *GetMaxPinLen)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns the minimum PIN code length that is
* supported on this token. This routine is optional; if
* unimplemented, the special value CK_UNAVAILABLE_INFORMATION
* is assumed. XXX fgmr-- or 0?
*/
CK_ULONG (PR_CALLBACK *GetMinPinLen)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns the total amount of memory on the token
* in which public objects may be stored. This routine is
* optional; if unimplemented, the special value
* CK_UNAVAILABLE_INFORMATION is assumed.
*/
CK_ULONG (PR_CALLBACK *GetTotalPublicMemory)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns the amount of unused memory on the
* token in which public objects may be stored. This routine
* is optional; if unimplemented, the special value
* CK_UNAVAILABLE_INFORMATION is assumed.
*/
CK_ULONG (PR_CALLBACK *GetFreePublicMemory)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns the total amount of memory on the token
* in which private objects may be stored. This routine is
* optional; if unimplemented, the special value
* CK_UNAVAILABLE_INFORMATION is assumed.
*/
CK_ULONG (PR_CALLBACK *GetTotalPrivateMemory)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns the amount of unused memory on the
* token in which private objects may be stored. This routine
* is optional; if unimplemented, the special value
* CK_UNAVAILABLE_INFORMATION is assumed.
*/
CK_ULONG (PR_CALLBACK *GetFreePrivateMemory)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns the version number of this token's
* hardware. This routine is optional; if unimplemented,
* the value 0.1 is assumed.
*/
CK_VERSION (PR_CALLBACK *GetHardwareVersion)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns the version number of this token's
* firmware. This routine is optional; if unimplemented,
* the value 0.1 is assumed.
*/
CK_VERSION (PR_CALLBACK *GetFirmwareVersion)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine stuffs the current UTC time, as obtained from
* the token, into the sixteen-byte buffer in the form
* YYYYMMDDhhmmss00. This routine need only be implemented
* by token which indicate that they have a real-time clock.
* XXX fgmr-- think about time formats.
*/
CK_RV (PR_CALLBACK *GetUTCTime)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_CHAR utcTime[16]
);
/*
* This routine creates a session on the token, and returns
* the corresponding NSSCKMDSession object. The value of
* rw will be CK_TRUE if the session is to be a read/write
* session, or CK_FALSE otherwise. An NSSArena dedicated to
* the new session is available from the specified NSSCKFWSession.
* This routine may return NULL upon error.
*/
NSSCKMDSession *(PR_CALLBACK *OpenSession)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSCKFWSession *fwSession,
CK_BBOOL rw,
CK_RV *pError
);
/*
* This routine returns the number of PKCS#11 Mechanisms
* supported by this token. This routine is optional; if
* unimplemented, zero is assumed.
*/
CK_ULONG (PR_CALLBACK *GetMechanismCount)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine stuffs into the specified array the types
* of the mechanisms supported by this token. The Framework
* determines the size of the array by calling GetMechanismCount.
*/
CK_RV (PR_CALLBACK *GetMechanismTypes)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_MECHANISM_TYPE types[]
);
/*
* This routine returns a pointer to a Module mechanism
* object corresponding to a specified type. This routine
* need only exist for tokens implementing at least one
* mechanism.
*/
NSSCKMDMechanism *(PR_CALLBACK *GetMechanism)(
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_MECHANISM_TYPE which,
CK_RV *pError
);
/*
* This object may be extended in future versions of the
* NSS Cryptoki Framework. To allow for some flexibility
* in the area of binary compatibility, this field should
* be NULL.
*/
void *null;
};
/*
* NSSCKMDSession
*
* This is the basic handle for a session on a PKCS#11 Token. It
* is created by NSSCKMDToken->OpenSession, and may be obtained
* from the Framework's corresponding NSSCKFWSession object. It
* contains a pointer for use by the Module, to store any session-
* realted data, and it contains the EPV for a set of routines
* which the Module may implement for use by the Framework. Some
* of these routines are optional.
*/
struct NSSCKMDSessionStr {
/*
* The Module may use this pointer for its own purposes.
*/
void *etc;
/*
* This routine is called by the Framework when a session is
* closed. This call is the last thing called before the
* NSSArena in the correspoinding NSSCKFWSession is destroyed.
* This routine is optional; if unimplemented, it merely won't
* be called.
*/
void (PR_CALLBACK *Close)(
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine is used to get any device-specific error.
* This routine is optional.
*/
CK_ULONG (PR_CALLBACK *GetDeviceError)(
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine is used to log in a user to the token. This
* routine is optional, since the Framework's NSSCKFWSession
* object keeps track of the login state.
*/
CK_RV (PR_CALLBACK *Login)(
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_USER_TYPE userType,
NSSItem *pin,
CK_STATE oldState,
CK_STATE newState
);
/*
* This routine is used to log out a user from the token. This
* routine is optional, since the Framework's NSSCKFWSession
* object keeps track of the login state.
*/
CK_RV (PR_CALLBACK *Logout)(
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_STATE oldState,
CK_STATE newState
);
/*
* This routine is used to initialize the normal user's PIN or
* password. This will only be called in the "read/write
* security officer functions" state. If this token has a
* protected authentication path, then the pin argument will
* be NULL. This routine is optional; if unimplemented, the
* Framework will return the error CKR_TOKEN_WRITE_PROTECTED.
*/
CK_RV (PR_CALLBACK *InitPIN)(
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSItem *pin
);
/*
* This routine is used to modify a user's PIN or password. This
* routine will only be called in the "read/write security officer
* functions" or "read/write user functions" state. If this token
* has a protected authentication path, then the pin arguments
* will be NULL. This routine is optional; if unimplemented, the
* Framework will return the error CKR_TOKEN_WRITE_PROTECTED.
*/
CK_RV (PR_CALLBACK *SetPIN)(
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSItem *oldPin,
NSSItem *newPin
);
/*
* This routine is used to find out how much space would be required
* to save the current operational state. This routine is optional;
* if unimplemented, the Framework will reject any attempts to save
* the operational state with the error CKR_STATE_UNSAVEABLE. This
* routine may return zero on error.
*/
CK_ULONG (PR_CALLBACK *GetOperationStateLen)(
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_RV *pError
);
/*
* This routine is used to store the current operational state. This
* routine is only required if GetOperationStateLen is implemented
* and can return a nonzero value. The buffer in the specified item
* will be pre-allocated, and the length will specify the amount of
* space available (which may be more than GetOperationStateLen
* asked for, but which will not be smaller).
*/
CK_RV (PR_CALLBACK *GetOperationState)(
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSItem *buffer
);
/*
* This routine is used to restore an operational state previously
* obtained with GetOperationState. The Framework will take pains
* to be sure that the state is (or was at one point) valid; if the
* Module notices that the state is invalid, it should return an
* error, but it is not required to be paranoid about the issue.
* [XXX fgmr-- should (can?) the framework verify the keys match up?]
* This routine is required only if GetOperationState is implemented.
*/
CK_RV (PR_CALLBACK *SetOperationState)(
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSItem *state,
NSSCKMDObject *mdEncryptionKey,
NSSCKFWObject *fwEncryptionKey,
NSSCKMDObject *mdAuthenticationKey,
NSSCKFWObject *fwAuthenticationKey
);
/*
* This routine is used to create an object. The specified template
* will only specify a session object if the Module has indicated
* that it wishes to handle its own session objects. This routine
* is optional; if unimplemented, the Framework will reject the
* operation with the error CKR_TOKEN_WRITE_PROTECTED. Space for
* token objects should come from the NSSArena available from the
* NSSCKFWToken object; space for session objects (if supported)
* should come from the NSSArena available from the NSSCKFWSession
* object. The appropriate NSSArena pointer will, as a convenience,
* be passed as the handyArenaPointer argument. This routine may
* return NULL upon error.
*/
NSSCKMDObject *(PR_CALLBACK *CreateObject)(
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSArena *handyArenaPointer,
CK_ATTRIBUTE_PTR pTemplate,
CK_ULONG ulAttributeCount,
CK_RV *pError
);
/*
* This routine is used to make a copy of an object. It is entirely
* optional; if unimplemented, the Framework will try to use
* CreateObject instead. If the Module has indicated that it does
* not wish to handle session objects, then this routine will only
* be called to copy a token object to another token object.
* Otherwise, either the original object or the new may be of
* either the token or session variety. As with CreateObject, the
* handyArenaPointer will point to the appropriate arena for the
* new object. This routine may return NULL upon error.
*/
NSSCKMDObject *(PR_CALLBACK *CopyObject)(
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSCKMDObject *mdOldObject,
NSSCKFWObject *fwOldObject,
NSSArena *handyArenaPointer,
CK_ATTRIBUTE_PTR pTemplate,
CK_ULONG ulAttributeCount,
CK_RV *pError
);
/*
* This routine is used to begin an object search. This routine may
* be unimplemented only if the Module does not handle session
* objects, and if none of its tokens have token objects. The
* NSSCKFWFindObjects pointer has an NSSArena that may be used for
* storage for the life of this "find" operation. This routine may
* return NULL upon error. If the Module can determine immediately
* that the search will not find any matching objects, it may return
* NULL, and specify CKR_OK as the error.
*/
NSSCKMDFindObjects *(PR_CALLBACK *FindObjectsInit)(
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_ATTRIBUTE_PTR pTemplate,
CK_ULONG ulAttributeCount,
CK_RV *pError
);
/*
* This routine seeds the random-number generator. It is
* optional, even if GetRandom is implemented. If unimplemented,
* the Framework will issue the error CKR_RANDOM_SEED_NOT_SUPPORTED.
*/
CK_RV (PR_CALLBACK *SeedRandom)(
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSItem *seed
);
/*
* This routine gets random data. It is optional. If unimplemented,
* the Framework will issue the error CKR_RANDOM_NO_RNG.
*/
CK_RV (PR_CALLBACK *GetRandom)(
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSItem *buffer
);
/*
* This object may be extended in future versions of the
* NSS Cryptoki Framework. To allow for some flexibility
* in the area of binary compatibility, this field should
* be NULL.
*/
void *null;
};
/*
* NSSCKMDFindObjects
*
* This is the basic handle for an object search. It is
* created by NSSCKMDSession->FindObjectsInit, and may be
* obtained from the Framework's corresponding object.
* It contains a pointer for use by the Module, to store
* any search-related data, and it contains the EPV for a
* set of routines which the Module may implement for use
* by the Framework. Some of these routines are optional.
*/
struct NSSCKMDFindObjectsStr {
/*
* The Module may use this pointer for its own purposes.
*/
void *etc;
/*
* This routine is called by the Framework to finish a
* search operation. Note that the Framework may finish
* a search before it has completed. This routine is
* optional; if unimplemented, it merely won't be called.
*/
void (PR_CALLBACK *Final)(
NSSCKMDFindObjects *mdFindObjects,
NSSCKFWFindObjects *fwFindObjects,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine is used to obtain another pointer to an
* object matching the search criteria. This routine is
* required. If no (more) objects match the search, it
* should return NULL and set the error to CKR_OK.
*/
NSSCKMDObject *(PR_CALLBACK *Next)(
NSSCKMDFindObjects *mdFindObjects,
NSSCKFWFindObjects *fwFindObjects,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSArena *arena,
CK_RV *pError
);
/*
* This object may be extended in future versions of the
* NSS Cryptoki Framework. To allow for some flexibility
* in the area of binary compatibility, this field should
* be NULL.
*/
void *null;
};
/*
* NSSCKMDCryptoOperaion
*
* This is the basic handle for an encryption, decryption,
* sign, verify, or hash opertion.
* created by NSSCKMDMechanism->XXXXInit, and may be
* obtained from the Framework's corresponding object.
* It contains a pointer for use by the Module, to store
* any intermediate data, and it contains the EPV for a
* set of routines which the Module may implement for use
* by the Framework. Some of these routines are optional.
*/
struct NSSCKMDCryptoOperationStr {
/*
* The Module may use this pointer for its own purposes.
*/
void *etc;
/*
* This routine is called by the Framework clean up the mdCryptoOperation
* structure.
* This routine is optional; if unimplemented, it will be ignored.
*/
void (PR_CALLBACK *Destroy)(
NSSCKMDCryptoOperation *mdCryptoOperation,
NSSCKFWCryptoOperation *fwCryptoOperation,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* how many bytes do we need to finish this buffer?
* must be implemented if Final is implemented.
*/
CK_ULONG (PR_CALLBACK *GetFinalLength)(
NSSCKMDCryptoOperation *mdCryptoOperation,
NSSCKFWCryptoOperation *fwCryptoOperation,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_RV *pError
);
/*
* how many bytes do we need to complete the next operation.
* used in both Update and UpdateFinal.
*/
CK_ULONG (PR_CALLBACK *GetOperationLength)(
NSSCKMDCryptoOperation *mdCryptoOperation,
NSSCKFWCryptoOperation *fwCryptoOperation,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
const NSSItem *inputBuffer,
CK_RV *pError
);
/*
* This routine is called by the Framework to finish a
* search operation. Note that the Framework may finish
* a search before it has completed. This routine is
* optional; if unimplemented, it merely won't be called.
* The respective final call with fail with CKR_FUNCTION_FAILED
* Final should not free the mdCryptoOperation.
*/
CK_RV(PR_CALLBACK *Final)(
NSSCKMDCryptoOperation *mdCryptoOperation,
NSSCKFWCryptoOperation *fwCryptoOperation,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSItem *outputBuffer
);
/*
* This routine is called by the Framework to complete the
* next step in an encryption/decryption operation.
* This routine is optional; if unimplemented, the respective
* update call with fail with CKR_FUNCTION_FAILED.
* Update should not be implemented for signing/verification/digest
* mechanisms.
*/
CK_RV(PR_CALLBACK *Update)(
NSSCKMDCryptoOperation *mdCryptoOperation,
NSSCKFWCryptoOperation *fwCryptoOperation,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
const NSSItem *inputBuffer,
NSSItem *outputBuffer
);
/*
* This routine is called by the Framework to complete the
* next step in a signing/verification/digest operation.
* This routine is optional; if unimplemented, the respective
* update call with fail with CKR_FUNCTION_FAILED
* Update should not be implemented for encryption/decryption
* mechanisms.
*/
CK_RV(PR_CALLBACK *DigestUpdate)(
NSSCKMDCryptoOperation *mdCryptoOperation,
NSSCKFWCryptoOperation *fwCryptoOperation,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
const NSSItem *inputBuffer
);
/*
* This routine is called by the Framework to complete a
* single step operation. This routine is optional; if unimplemented,
* the framework will use the Update and Final functions to complete
* the operation.
*/
CK_RV(PR_CALLBACK *UpdateFinal)(
NSSCKMDCryptoOperation *mdCryptoOperation,
NSSCKFWCryptoOperation *fwCryptoOperation,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
const NSSItem *inputBuffer,
NSSItem *outputBuffer
);
/*
* This routine is called by the Framework to complete next
* step in a combined operation. The Decrypt/Encrypt mechanism
* should define and drive the combo step.
* This routine is optional; if unimplemented,
* the framework will use the appropriate Update functions to complete
* the operation.
*/
CK_RV(PR_CALLBACK *UpdateCombo)(
NSSCKMDCryptoOperation *mdCryptoOperation,
NSSCKFWCryptoOperation *fwCryptoOperation,
NSSCKMDCryptoOperation *mdPeerCryptoOperation,
NSSCKFWCryptoOperation *fwPeerCryptoOperation,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
const NSSItem *inputBuffer,
NSSItem *outputBuffer
);
/*
* Hash a key directly into the digest
*/
CK_RV(PR_CALLBACK *DigestKey)(
NSSCKMDCryptoOperation *mdCryptoOperation,
NSSCKFWCryptoOperation *fwCryptoOperation,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSCKMDObject *mdKey,
NSSCKFWObject *fwKey
);
/*
* This object may be extended in future versions of the
* NSS Cryptoki Framework. To allow for some flexibility
* in the area of binary compatibility, this field should
* be NULL.
*/
void *null;
};
/*
* NSSCKMDMechanism
*
*/
struct NSSCKMDMechanismStr {
/*
* The Module may use this pointer for its own purposes.
*/
void *etc;
/*
* This also frees the fwMechanism if appropriate.
* If it is not supplied, the Framework will assume that the Token
* Manages a static list of mechanisms and the function will not be called.
*/
void (PR_CALLBACK *Destroy)(
NSSCKMDMechanism *mdMechanism,
NSSCKFWMechanism *fwMechanism,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns the minimum key size allowed for
* this mechanism. This routine is optional; if unimplemented,
* zero will be assumed. This routine may return zero on
* error; if the error is CKR_OK, zero will be accepted as
* a valid response.
*/
CK_ULONG (PR_CALLBACK *GetMinKeySize)(
NSSCKMDMechanism *mdMechanism,
NSSCKFWMechanism *fwMechanism,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_RV *pError
);
/*
* This routine returns the maximum key size allowed for
* this mechanism. This routine is optional; if unimplemented,
* zero will be assumed. This routine may return zero on
* error; if the error is CKR_OK, zero will be accepted as
* a valid response.
*/
CK_ULONG (PR_CALLBACK *GetMaxKeySize)(
NSSCKMDMechanism *mdMechanism,
NSSCKFWMechanism *fwMechanism,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_RV *pError
);
/*
* This routine is called to determine if the mechanism is
* implemented in hardware or software. It returns CK_TRUE
* if it is done in hardware.
*/
CK_BBOOL (PR_CALLBACK *GetInHardware)(
NSSCKMDMechanism *mdMechanism,
NSSCKFWMechanism *fwMechanism,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_RV *pError
);
/*
* The crypto routines themselves. Most crypto operations may
* be performed in two ways, streaming and single-part. The
* streaming operations involve the use of (typically) three
* calls-- an Init method to set up the operation, an Update
* method to feed data to the operation, and a Final method to
* obtain the final result. Single-part operations involve
* one method, to perform the crypto operation all at once.
*
* The NSS Cryptoki Framework can implement the single-part
* operations in terms of the streaming operations on behalf
* of the Module. There are a few variances.
*
* Only the Init Functions are defined by the mechanism. Each
* init function will return a NSSCKFWCryptoOperation which
* can supply update, final, the single part updateFinal, and
* the combo updateCombo functions.
*
* For simplicity, the routines are listed in summary here:
*
* EncryptInit,
* DecryptInit,
* DigestInit,
* SignInit,
* SignRecoverInit;
* VerifyInit,
* VerifyRecoverInit;
*
* The key-management routines are
*
* GenerateKey
* GenerateKeyPair
* WrapKey
* UnwrapKey
* DeriveKey
*
* All of these routines based on the Cryptoki API;
* see PKCS#11 for further information.
*/
/*
*/
NSSCKMDCryptoOperation * (PR_CALLBACK *EncryptInit)(
NSSCKMDMechanism *mdMechanism,
NSSCKFWMechanism *fwMechanism,
CK_MECHANISM_PTR pMechanism,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSCKMDObject *mdKey,
NSSCKFWObject *fwKey,
CK_RV *pError
);
/*
*/
NSSCKMDCryptoOperation * (PR_CALLBACK *DecryptInit)(
NSSCKMDMechanism *mdMechanism,
NSSCKFWMechanism *fwMechanism,
CK_MECHANISM_PTR pMechanism,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSCKMDObject *mdKey,
NSSCKFWObject *fwKey,
CK_RV *pError
);
/*
*/
NSSCKMDCryptoOperation * (PR_CALLBACK *DigestInit)(
NSSCKMDMechanism *mdMechanism,
NSSCKFWMechanism *fwMechanism,
CK_MECHANISM_PTR pMechanism,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_RV *pError
);
/*
*/
NSSCKMDCryptoOperation * (PR_CALLBACK *SignInit)(
NSSCKMDMechanism *mdMechanism,
NSSCKFWMechanism *fwMechanism,
CK_MECHANISM_PTR pMechanism,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSCKMDObject *mdKey,
NSSCKFWObject *fwKey,
CK_RV *pError
);
/*
*/
NSSCKMDCryptoOperation * (PR_CALLBACK *VerifyInit)(
NSSCKMDMechanism *mdMechanism,
NSSCKFWMechanism *fwMechanism,
CK_MECHANISM_PTR pMechanism,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSCKMDObject *mdKey,
NSSCKFWObject *fwKey,
CK_RV *pError
);
/*
*/
NSSCKMDCryptoOperation * (PR_CALLBACK *SignRecoverInit)(
NSSCKMDMechanism *mdMechanism,
NSSCKFWMechanism *fwMechanism,
CK_MECHANISM_PTR pMechanism,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSCKMDObject *mdKey,
NSSCKFWObject *fwKey,
CK_RV *pError
);
/*
*/
NSSCKMDCryptoOperation * (PR_CALLBACK *VerifyRecoverInit)(
NSSCKMDMechanism *mdMechanism,
NSSCKFWMechanism *fwMechanism,
CK_MECHANISM_PTR pMechanism,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSCKMDObject *mdKey,
NSSCKFWObject *fwKey,
CK_RV *pError
);
/*
* Key management operations.
*/
/*
* This routine generates a key. This routine may return NULL
* upon error.
*/
NSSCKMDObject *(PR_CALLBACK *GenerateKey)(
NSSCKMDMechanism *mdMechanism,
NSSCKFWMechanism *fwMechanism,
CK_MECHANISM_PTR pMechanism,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_ATTRIBUTE_PTR pTemplate,
CK_ULONG ulAttributeCount,
CK_RV *pError
);
/*
* This routine generates a key pair.
*/
CK_RV (PR_CALLBACK *GenerateKeyPair)(
NSSCKMDMechanism *mdMechanism,
NSSCKFWMechanism *fwMechanism,
CK_MECHANISM_PTR pMechanism,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_ATTRIBUTE_PTR pPublicKeyTemplate,
CK_ULONG ulPublicKeyAttributeCount,
CK_ATTRIBUTE_PTR pPrivateKeyTemplate,
CK_ULONG ulPrivateKeyAttributeCount,
NSSCKMDObject **pPublicKey,
NSSCKMDObject **pPrivateKey
);
/*
* This routine wraps a key.
*/
CK_ULONG (PR_CALLBACK *GetWrapKeyLength)(
NSSCKMDMechanism *mdMechanism,
NSSCKFWMechanism *fwMechanism,
CK_MECHANISM_PTR pMechanism,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSCKMDObject *mdWrappingKey,
NSSCKFWObject *fwWrappingKey,
NSSCKMDObject *mdWrappedKey,
NSSCKFWObject *fwWrappedKey,
CK_RV *pError
);
/*
* This routine wraps a key.
*/
CK_RV (PR_CALLBACK *WrapKey)(
NSSCKMDMechanism *mdMechanism,
NSSCKFWMechanism *fwMechanism,
CK_MECHANISM_PTR pMechanism,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSCKMDObject *mdWrappingKey,
NSSCKFWObject *fwWrappingKey,
NSSCKMDObject *mdKeyObject,
NSSCKFWObject *fwKeyObject,
NSSItem *wrappedKey
);
/*
* This routine unwraps a key. This routine may return NULL
* upon error.
*/
NSSCKMDObject *(PR_CALLBACK *UnwrapKey)(
NSSCKMDMechanism *mdMechanism,
NSSCKFWMechanism *fwMechanism,
CK_MECHANISM_PTR pMechanism,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSCKMDObject *mdWrappingKey,
NSSCKFWObject *fwWrappingKey,
NSSItem *wrappedKey,
CK_ATTRIBUTE_PTR pTemplate,
CK_ULONG ulAttributeCount,
CK_RV *pError
);
/*
* This routine derives a key. This routine may return NULL
* upon error.
*/
NSSCKMDObject *(PR_CALLBACK *DeriveKey)(
NSSCKMDMechanism *mdMechanism,
NSSCKFWMechanism *fwMechanism,
CK_MECHANISM_PTR pMechanism,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
NSSCKMDObject *mdBaseKey,
NSSCKFWObject *fwBaseKey,
CK_ATTRIBUTE_PTR pTemplate,
CK_ULONG ulAttributeCount,
CK_RV *pError
);
/*
* This object may be extended in future versions of the
* NSS Cryptoki Framework. To allow for some flexibility
* in the area of binary compatibility, this field should
* be NULL.
*/
void *null;
};
/*
* NSSCKMDObject
*
* This is the basic handle for any object used by a PKCS#11 Module.
* Modules must implement it if they support their own objects, and
* the Framework supports it for Modules that do not handle session
* objects. This type contains a pointer for use by the implementor,
* to store any object-specific data, and it contains an EPV for a
* set of routines used to access the object.
*/
struct NSSCKMDObjectStr {
/*
* The implementation my use this pointer for its own purposes.
*/
void *etc;
/*
* This routine is called by the Framework when it is letting
* go of an object handle. It can be used by the Module to
* free any resources tied up by an object "in use." It is
* optional.
*/
void (PR_CALLBACK *Finalize)(
NSSCKMDObject *mdObject,
NSSCKFWObject *fwObject,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine is used to completely destroy an object.
* It is optional. The parameter fwObject might be NULL
* if the framework runs out of memory at the wrong moment.
*/
CK_RV (PR_CALLBACK *Destroy)(
NSSCKMDObject *mdObject,
NSSCKFWObject *fwObject,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This helper routine is used by the Framework, and is especially
* useful when it is managing session objects on behalf of the
* Module. This routine is optional; if unimplemented, the
* Framework will actually look up the CKA_TOKEN attribute. In the
* event of an error, just make something up-- the Framework will
* find out soon enough anyway.
*/
CK_BBOOL (PR_CALLBACK *IsTokenObject)(
NSSCKMDObject *mdObject,
NSSCKFWObject *fwObject,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance
);
/*
* This routine returns the number of attributes of which this
* object consists. It is mandatory. It can return zero on
* error.
*/
CK_ULONG (PR_CALLBACK *GetAttributeCount)(
NSSCKMDObject *mdObject,
NSSCKFWObject *fwObject,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_RV *pError
);
/*
* This routine stuffs the attribute types into the provided array.
* The array size (as obtained from GetAttributeCount) is passed in
* as a check; return CKR_BUFFER_TOO_SMALL if the count is wrong
* (either too big or too small).
*/
CK_RV (PR_CALLBACK *GetAttributeTypes)(
NSSCKMDObject *mdObject,
NSSCKFWObject *fwObject,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_ATTRIBUTE_TYPE_PTR typeArray,
CK_ULONG ulCount
);
/*
* This routine returns the size (in bytes) of the specified
* attribute. It can return zero on error.
*/
CK_ULONG (PR_CALLBACK *GetAttributeSize)(
NSSCKMDObject *mdObject,
NSSCKFWObject *fwObject,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_ATTRIBUTE_TYPE attribute,
CK_RV *pError
);
/*
* This routine returns an NSSCKFWItem structure.
* The item pointer points to an NSSItem containing the attribute value.
* The needsFreeing bit tells the framework whether to call the
* FreeAttribute function . Upon error, an NSSCKFWItem structure
* with a NULL NSSItem item pointer will be returned
*/
NSSCKFWItem (PR_CALLBACK *GetAttribute)(
NSSCKMDObject *mdObject,
NSSCKFWObject *fwObject,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_ATTRIBUTE_TYPE attribute,
CK_RV *pError
);
/*
* This routine returns CKR_OK if the attribute could be freed.
*/
CK_RV (PR_CALLBACK *FreeAttribute)(
NSSCKFWItem * item
);
/*
* This routine changes the specified attribute. If unimplemented,
* the object will be considered read-only.
*/
CK_RV (PR_CALLBACK *SetAttribute)(
NSSCKMDObject *mdObject,
NSSCKFWObject *fwObject,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_ATTRIBUTE_TYPE attribute,
NSSItem *value
);
/*
* This routine returns the storage requirements of this object,
* in bytes. Cryptoki doesn't strictly define the definition,
* but it should relate to the values returned by the "Get Memory"
* routines of the NSSCKMDToken. This routine is optional; if
* unimplemented, the Framework will consider this information
* sensitive. This routine may return zero on error. If the
* specified error is CKR_OK, zero will be accepted as a valid
* response.
*/
CK_ULONG (PR_CALLBACK *GetObjectSize)(
NSSCKMDObject *mdObject,
NSSCKFWObject *fwObject,
NSSCKMDSession *mdSession,
NSSCKFWSession *fwSession,
NSSCKMDToken *mdToken,
NSSCKFWToken *fwToken,
NSSCKMDInstance *mdInstance,
NSSCKFWInstance *fwInstance,
CK_RV *pError
);
/*
* This object may be extended in future versions of the
* NSS Cryptoki Framework. To allow for some flexibility
* in the area of binary compatibility, this field should
* be NULL.
*/
void *null;
};
#endif /* NSSCKMDT_H */
|