pkcs11t.h 70 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003
  1. /* Copyright (c) OASIS Open 2016. All Rights Reserved./
  2. * /Distributed under the terms of the OASIS IPR Policy,
  3. * [http://www.oasis-open.org/policies-guidelines/ipr], AS-IS, WITHOUT ANY
  4. * IMPLIED OR EXPRESS WARRANTY; there is no warranty of MERCHANTABILITY, FITNESS FOR A
  5. * PARTICULAR PURPOSE or NONINFRINGEMENT of the rights of others.
  6. */
  7. /* Latest version of the specification:
  8. * http://docs.oasis-open.org/pkcs11/pkcs11-base/v2.40/pkcs11-base-v2.40.html
  9. */
  10. /* See top of pkcs11.h for information about the macros that
  11. * must be defined and the structure-packing conventions that
  12. * must be set before including this file.
  13. */
  14. #ifndef _PKCS11T_H_
  15. #define _PKCS11T_H_ 1
  16. #define CRYPTOKI_VERSION_MAJOR 2
  17. #define CRYPTOKI_VERSION_MINOR 40
  18. #define CRYPTOKI_VERSION_AMENDMENT 0
  19. #define CK_TRUE 1
  20. #define CK_FALSE 0
  21. #ifndef CK_DISABLE_TRUE_FALSE
  22. #ifndef FALSE
  23. #define FALSE CK_FALSE
  24. #endif
  25. #ifndef TRUE
  26. #define TRUE CK_TRUE
  27. #endif
  28. #endif
  29. /* an unsigned 8-bit value */
  30. typedef unsigned char CK_BYTE;
  31. /* an unsigned 8-bit character */
  32. typedef CK_BYTE CK_CHAR;
  33. /* an 8-bit UTF-8 character */
  34. typedef CK_BYTE CK_UTF8CHAR;
  35. /* a BYTE-sized Boolean flag */
  36. typedef CK_BYTE CK_BBOOL;
  37. /* an unsigned value, at least 32 bits long */
  38. typedef unsigned long int CK_ULONG;
  39. /* a signed value, the same size as a CK_ULONG */
  40. typedef long int CK_LONG;
  41. /* at least 32 bits; each bit is a Boolean flag */
  42. typedef CK_ULONG CK_FLAGS;
  43. /* some special values for certain CK_ULONG variables */
  44. #define CK_UNAVAILABLE_INFORMATION (~0UL)
  45. #define CK_EFFECTIVELY_INFINITE 0UL
  46. typedef CK_BYTE CK_PTR CK_BYTE_PTR;
  47. typedef CK_CHAR CK_PTR CK_CHAR_PTR;
  48. typedef CK_UTF8CHAR CK_PTR CK_UTF8CHAR_PTR;
  49. typedef CK_ULONG CK_PTR CK_ULONG_PTR;
  50. typedef void CK_PTR CK_VOID_PTR;
  51. /* Pointer to a CK_VOID_PTR-- i.e., pointer to pointer to void */
  52. typedef CK_VOID_PTR CK_PTR CK_VOID_PTR_PTR;
  53. /* The following value is always invalid if used as a session
  54. * handle or object handle
  55. */
  56. #define CK_INVALID_HANDLE 0UL
  57. typedef struct CK_VERSION {
  58. CK_BYTE major; /* integer portion of version number */
  59. CK_BYTE minor; /* 1/100ths portion of version number */
  60. } CK_VERSION;
  61. typedef CK_VERSION CK_PTR CK_VERSION_PTR;
  62. typedef struct CK_INFO {
  63. CK_VERSION cryptokiVersion; /* Cryptoki interface ver */
  64. CK_UTF8CHAR manufacturerID[32]; /* blank padded */
  65. CK_FLAGS flags; /* must be zero */
  66. CK_UTF8CHAR libraryDescription[32]; /* blank padded */
  67. CK_VERSION libraryVersion; /* version of library */
  68. } CK_INFO;
  69. typedef CK_INFO CK_PTR CK_INFO_PTR;
  70. /* CK_NOTIFICATION enumerates the types of notifications that
  71. * Cryptoki provides to an application
  72. */
  73. typedef CK_ULONG CK_NOTIFICATION;
  74. #define CKN_SURRENDER 0UL
  75. #define CKN_OTP_CHANGED 1UL
  76. typedef CK_ULONG CK_SLOT_ID;
  77. typedef CK_SLOT_ID CK_PTR CK_SLOT_ID_PTR;
  78. /* CK_SLOT_INFO provides information about a slot */
  79. typedef struct CK_SLOT_INFO {
  80. CK_UTF8CHAR slotDescription[64]; /* blank padded */
  81. CK_UTF8CHAR manufacturerID[32]; /* blank padded */
  82. CK_FLAGS flags;
  83. CK_VERSION hardwareVersion; /* version of hardware */
  84. CK_VERSION firmwareVersion; /* version of firmware */
  85. } CK_SLOT_INFO;
  86. /* flags: bit flags that provide capabilities of the slot
  87. * Bit Flag Mask Meaning
  88. */
  89. #define CKF_TOKEN_PRESENT 0x00000001UL /* a token is there */
  90. #define CKF_REMOVABLE_DEVICE 0x00000002UL /* removable devices*/
  91. #define CKF_HW_SLOT 0x00000004UL /* hardware slot */
  92. typedef CK_SLOT_INFO CK_PTR CK_SLOT_INFO_PTR;
  93. /* CK_TOKEN_INFO provides information about a token */
  94. typedef struct CK_TOKEN_INFO {
  95. CK_UTF8CHAR label[32]; /* blank padded */
  96. CK_UTF8CHAR manufacturerID[32]; /* blank padded */
  97. CK_UTF8CHAR model[16]; /* blank padded */
  98. CK_CHAR serialNumber[16]; /* blank padded */
  99. CK_FLAGS flags; /* see below */
  100. CK_ULONG ulMaxSessionCount; /* max open sessions */
  101. CK_ULONG ulSessionCount; /* sess. now open */
  102. CK_ULONG ulMaxRwSessionCount; /* max R/W sessions */
  103. CK_ULONG ulRwSessionCount; /* R/W sess. now open */
  104. CK_ULONG ulMaxPinLen; /* in bytes */
  105. CK_ULONG ulMinPinLen; /* in bytes */
  106. CK_ULONG ulTotalPublicMemory; /* in bytes */
  107. CK_ULONG ulFreePublicMemory; /* in bytes */
  108. CK_ULONG ulTotalPrivateMemory; /* in bytes */
  109. CK_ULONG ulFreePrivateMemory; /* in bytes */
  110. CK_VERSION hardwareVersion; /* version of hardware */
  111. CK_VERSION firmwareVersion; /* version of firmware */
  112. CK_CHAR utcTime[16]; /* time */
  113. } CK_TOKEN_INFO;
  114. /* The flags parameter is defined as follows:
  115. * Bit Flag Mask Meaning
  116. */
  117. #define CKF_RNG 0x00000001UL /* has random # generator */
  118. #define CKF_WRITE_PROTECTED 0x00000002UL /* token is write-protected */
  119. #define CKF_LOGIN_REQUIRED 0x00000004UL /* user must login */
  120. #define CKF_USER_PIN_INITIALIZED 0x00000008UL /* normal user's PIN is set */
  121. /* CKF_RESTORE_KEY_NOT_NEEDED. If it is set,
  122. * that means that *every* time the state of cryptographic
  123. * operations of a session is successfully saved, all keys
  124. * needed to continue those operations are stored in the state
  125. */
  126. #define CKF_RESTORE_KEY_NOT_NEEDED 0x00000020UL
  127. /* CKF_CLOCK_ON_TOKEN. If it is set, that means
  128. * that the token has some sort of clock. The time on that
  129. * clock is returned in the token info structure
  130. */
  131. #define CKF_CLOCK_ON_TOKEN 0x00000040UL
  132. /* CKF_PROTECTED_AUTHENTICATION_PATH. If it is
  133. * set, that means that there is some way for the user to login
  134. * without sending a PIN through the Cryptoki library itself
  135. */
  136. #define CKF_PROTECTED_AUTHENTICATION_PATH 0x00000100UL
  137. /* CKF_DUAL_CRYPTO_OPERATIONS. If it is true,
  138. * that means that a single session with the token can perform
  139. * dual simultaneous cryptographic operations (digest and
  140. * encrypt; decrypt and digest; sign and encrypt; and decrypt
  141. * and sign)
  142. */
  143. #define CKF_DUAL_CRYPTO_OPERATIONS 0x00000200UL
  144. /* CKF_TOKEN_INITIALIZED. If it is true, the
  145. * token has been initialized using C_InitializeToken or an
  146. * equivalent mechanism outside the scope of PKCS #11.
  147. * Calling C_InitializeToken when this flag is set will cause
  148. * the token to be reinitialized.
  149. */
  150. #define CKF_TOKEN_INITIALIZED 0x00000400UL
  151. /* CKF_SECONDARY_AUTHENTICATION. If it is
  152. * true, the token supports secondary authentication for
  153. * private key objects.
  154. */
  155. #define CKF_SECONDARY_AUTHENTICATION 0x00000800UL
  156. /* CKF_USER_PIN_COUNT_LOW. If it is true, an
  157. * incorrect user login PIN has been entered at least once
  158. * since the last successful authentication.
  159. */
  160. #define CKF_USER_PIN_COUNT_LOW 0x00010000UL
  161. /* CKF_USER_PIN_FINAL_TRY. If it is true,
  162. * supplying an incorrect user PIN will it to become locked.
  163. */
  164. #define CKF_USER_PIN_FINAL_TRY 0x00020000UL
  165. /* CKF_USER_PIN_LOCKED. If it is true, the
  166. * user PIN has been locked. User login to the token is not
  167. * possible.
  168. */
  169. #define CKF_USER_PIN_LOCKED 0x00040000UL
  170. /* CKF_USER_PIN_TO_BE_CHANGED. If it is true,
  171. * the user PIN value is the default value set by token
  172. * initialization or manufacturing, or the PIN has been
  173. * expired by the card.
  174. */
  175. #define CKF_USER_PIN_TO_BE_CHANGED 0x00080000UL
  176. /* CKF_SO_PIN_COUNT_LOW. If it is true, an
  177. * incorrect SO login PIN has been entered at least once since
  178. * the last successful authentication.
  179. */
  180. #define CKF_SO_PIN_COUNT_LOW 0x00100000UL
  181. /* CKF_SO_PIN_FINAL_TRY. If it is true,
  182. * supplying an incorrect SO PIN will it to become locked.
  183. */
  184. #define CKF_SO_PIN_FINAL_TRY 0x00200000UL
  185. /* CKF_SO_PIN_LOCKED. If it is true, the SO
  186. * PIN has been locked. SO login to the token is not possible.
  187. */
  188. #define CKF_SO_PIN_LOCKED 0x00400000UL
  189. /* CKF_SO_PIN_TO_BE_CHANGED. If it is true,
  190. * the SO PIN value is the default value set by token
  191. * initialization or manufacturing, or the PIN has been
  192. * expired by the card.
  193. */
  194. #define CKF_SO_PIN_TO_BE_CHANGED 0x00800000UL
  195. #define CKF_ERROR_STATE 0x01000000UL
  196. typedef CK_TOKEN_INFO CK_PTR CK_TOKEN_INFO_PTR;
  197. /* CK_SESSION_HANDLE is a Cryptoki-assigned value that
  198. * identifies a session
  199. */
  200. typedef CK_ULONG CK_SESSION_HANDLE;
  201. typedef CK_SESSION_HANDLE CK_PTR CK_SESSION_HANDLE_PTR;
  202. /* CK_USER_TYPE enumerates the types of Cryptoki users */
  203. typedef CK_ULONG CK_USER_TYPE;
  204. /* Security Officer */
  205. #define CKU_SO 0UL
  206. /* Normal user */
  207. #define CKU_USER 1UL
  208. /* Context specific */
  209. #define CKU_CONTEXT_SPECIFIC 2UL
  210. /* CK_STATE enumerates the session states */
  211. typedef CK_ULONG CK_STATE;
  212. #define CKS_RO_PUBLIC_SESSION 0UL
  213. #define CKS_RO_USER_FUNCTIONS 1UL
  214. #define CKS_RW_PUBLIC_SESSION 2UL
  215. #define CKS_RW_USER_FUNCTIONS 3UL
  216. #define CKS_RW_SO_FUNCTIONS 4UL
  217. /* CK_SESSION_INFO provides information about a session */
  218. typedef struct CK_SESSION_INFO {
  219. CK_SLOT_ID slotID;
  220. CK_STATE state;
  221. CK_FLAGS flags; /* see below */
  222. CK_ULONG ulDeviceError; /* device-dependent error code */
  223. } CK_SESSION_INFO;
  224. /* The flags are defined in the following table:
  225. * Bit Flag Mask Meaning
  226. */
  227. #define CKF_RW_SESSION 0x00000002UL /* session is r/w */
  228. #define CKF_SERIAL_SESSION 0x00000004UL /* no parallel */
  229. typedef CK_SESSION_INFO CK_PTR CK_SESSION_INFO_PTR;
  230. /* CK_OBJECT_HANDLE is a token-specific identifier for an
  231. * object
  232. */
  233. typedef CK_ULONG CK_OBJECT_HANDLE;
  234. typedef CK_OBJECT_HANDLE CK_PTR CK_OBJECT_HANDLE_PTR;
  235. /* CK_OBJECT_CLASS is a value that identifies the classes (or
  236. * types) of objects that Cryptoki recognizes. It is defined
  237. * as follows:
  238. */
  239. typedef CK_ULONG CK_OBJECT_CLASS;
  240. /* The following classes of objects are defined: */
  241. #define CKO_DATA 0x00000000UL
  242. #define CKO_CERTIFICATE 0x00000001UL
  243. #define CKO_PUBLIC_KEY 0x00000002UL
  244. #define CKO_PRIVATE_KEY 0x00000003UL
  245. #define CKO_SECRET_KEY 0x00000004UL
  246. #define CKO_HW_FEATURE 0x00000005UL
  247. #define CKO_DOMAIN_PARAMETERS 0x00000006UL
  248. #define CKO_MECHANISM 0x00000007UL
  249. #define CKO_OTP_KEY 0x00000008UL
  250. #define CKO_VENDOR_DEFINED 0x80000000UL
  251. typedef CK_OBJECT_CLASS CK_PTR CK_OBJECT_CLASS_PTR;
  252. /* CK_HW_FEATURE_TYPE is a value that identifies the hardware feature type
  253. * of an object with CK_OBJECT_CLASS equal to CKO_HW_FEATURE.
  254. */
  255. typedef CK_ULONG CK_HW_FEATURE_TYPE;
  256. /* The following hardware feature types are defined */
  257. #define CKH_MONOTONIC_COUNTER 0x00000001UL
  258. #define CKH_CLOCK 0x00000002UL
  259. #define CKH_USER_INTERFACE 0x00000003UL
  260. #define CKH_VENDOR_DEFINED 0x80000000UL
  261. /* CK_KEY_TYPE is a value that identifies a key type */
  262. typedef CK_ULONG CK_KEY_TYPE;
  263. /* the following key types are defined: */
  264. #define CKK_RSA 0x00000000UL
  265. #define CKK_DSA 0x00000001UL
  266. #define CKK_DH 0x00000002UL
  267. #define CKK_ECDSA 0x00000003UL /* Deprecated */
  268. #define CKK_EC 0x00000003UL
  269. #define CKK_X9_42_DH 0x00000004UL
  270. #define CKK_KEA 0x00000005UL
  271. #define CKK_GENERIC_SECRET 0x00000010UL
  272. #define CKK_RC2 0x00000011UL
  273. #define CKK_RC4 0x00000012UL
  274. #define CKK_DES 0x00000013UL
  275. #define CKK_DES2 0x00000014UL
  276. #define CKK_DES3 0x00000015UL
  277. #define CKK_CAST 0x00000016UL
  278. #define CKK_CAST3 0x00000017UL
  279. #define CKK_CAST5 0x00000018UL /* Deprecated */
  280. #define CKK_CAST128 0x00000018UL
  281. #define CKK_RC5 0x00000019UL
  282. #define CKK_IDEA 0x0000001AUL
  283. #define CKK_SKIPJACK 0x0000001BUL
  284. #define CKK_BATON 0x0000001CUL
  285. #define CKK_JUNIPER 0x0000001DUL
  286. #define CKK_CDMF 0x0000001EUL
  287. #define CKK_AES 0x0000001FUL
  288. #define CKK_BLOWFISH 0x00000020UL
  289. #define CKK_TWOFISH 0x00000021UL
  290. #define CKK_SECURID 0x00000022UL
  291. #define CKK_HOTP 0x00000023UL
  292. #define CKK_ACTI 0x00000024UL
  293. #define CKK_CAMELLIA 0x00000025UL
  294. #define CKK_ARIA 0x00000026UL
  295. #define CKK_MD5_HMAC 0x00000027UL
  296. #define CKK_SHA_1_HMAC 0x00000028UL
  297. #define CKK_RIPEMD128_HMAC 0x00000029UL
  298. #define CKK_RIPEMD160_HMAC 0x0000002AUL
  299. #define CKK_SHA256_HMAC 0x0000002BUL
  300. #define CKK_SHA384_HMAC 0x0000002CUL
  301. #define CKK_SHA512_HMAC 0x0000002DUL
  302. #define CKK_SHA224_HMAC 0x0000002EUL
  303. #define CKK_SEED 0x0000002FUL
  304. #define CKK_GOSTR3410 0x00000030UL
  305. #define CKK_GOSTR3411 0x00000031UL
  306. #define CKK_GOST28147 0x00000032UL
  307. #define CKK_VENDOR_DEFINED 0x80000000UL
  308. /* CK_CERTIFICATE_TYPE is a value that identifies a certificate
  309. * type
  310. */
  311. typedef CK_ULONG CK_CERTIFICATE_TYPE;
  312. #define CK_CERTIFICATE_CATEGORY_UNSPECIFIED 0UL
  313. #define CK_CERTIFICATE_CATEGORY_TOKEN_USER 1UL
  314. #define CK_CERTIFICATE_CATEGORY_AUTHORITY 2UL
  315. #define CK_CERTIFICATE_CATEGORY_OTHER_ENTITY 3UL
  316. #define CK_SECURITY_DOMAIN_UNSPECIFIED 0UL
  317. #define CK_SECURITY_DOMAIN_MANUFACTURER 1UL
  318. #define CK_SECURITY_DOMAIN_OPERATOR 2UL
  319. #define CK_SECURITY_DOMAIN_THIRD_PARTY 3UL
  320. /* The following certificate types are defined: */
  321. #define CKC_X_509 0x00000000UL
  322. #define CKC_X_509_ATTR_CERT 0x00000001UL
  323. #define CKC_WTLS 0x00000002UL
  324. #define CKC_VENDOR_DEFINED 0x80000000UL
  325. /* CK_ATTRIBUTE_TYPE is a value that identifies an attribute
  326. * type
  327. */
  328. typedef CK_ULONG CK_ATTRIBUTE_TYPE;
  329. /* The CKF_ARRAY_ATTRIBUTE flag identifies an attribute which
  330. * consists of an array of values.
  331. */
  332. #define CKF_ARRAY_ATTRIBUTE 0x40000000UL
  333. /* The following OTP-related defines relate to the CKA_OTP_FORMAT attribute */
  334. #define CK_OTP_FORMAT_DECIMAL 0UL
  335. #define CK_OTP_FORMAT_HEXADECIMAL 1UL
  336. #define CK_OTP_FORMAT_ALPHANUMERIC 2UL
  337. #define CK_OTP_FORMAT_BINARY 3UL
  338. /* The following OTP-related defines relate to the CKA_OTP_..._REQUIREMENT
  339. * attributes
  340. */
  341. #define CK_OTP_PARAM_IGNORED 0UL
  342. #define CK_OTP_PARAM_OPTIONAL 1UL
  343. #define CK_OTP_PARAM_MANDATORY 2UL
  344. /* The following attribute types are defined: */
  345. #define CKA_CLASS 0x00000000UL
  346. #define CKA_TOKEN 0x00000001UL
  347. #define CKA_PRIVATE 0x00000002UL
  348. #define CKA_LABEL 0x00000003UL
  349. #define CKA_APPLICATION 0x00000010UL
  350. #define CKA_VALUE 0x00000011UL
  351. #define CKA_OBJECT_ID 0x00000012UL
  352. #define CKA_CERTIFICATE_TYPE 0x00000080UL
  353. #define CKA_ISSUER 0x00000081UL
  354. #define CKA_SERIAL_NUMBER 0x00000082UL
  355. #define CKA_AC_ISSUER 0x00000083UL
  356. #define CKA_OWNER 0x00000084UL
  357. #define CKA_ATTR_TYPES 0x00000085UL
  358. #define CKA_TRUSTED 0x00000086UL
  359. #define CKA_CERTIFICATE_CATEGORY 0x00000087UL
  360. #define CKA_JAVA_MIDP_SECURITY_DOMAIN 0x00000088UL
  361. #define CKA_URL 0x00000089UL
  362. #define CKA_HASH_OF_SUBJECT_PUBLIC_KEY 0x0000008AUL
  363. #define CKA_HASH_OF_ISSUER_PUBLIC_KEY 0x0000008BUL
  364. #define CKA_NAME_HASH_ALGORITHM 0x0000008CUL
  365. #define CKA_CHECK_VALUE 0x00000090UL
  366. #define CKA_KEY_TYPE 0x00000100UL
  367. #define CKA_SUBJECT 0x00000101UL
  368. #define CKA_ID 0x00000102UL
  369. #define CKA_SENSITIVE 0x00000103UL
  370. #define CKA_ENCRYPT 0x00000104UL
  371. #define CKA_DECRYPT 0x00000105UL
  372. #define CKA_WRAP 0x00000106UL
  373. #define CKA_UNWRAP 0x00000107UL
  374. #define CKA_SIGN 0x00000108UL
  375. #define CKA_SIGN_RECOVER 0x00000109UL
  376. #define CKA_VERIFY 0x0000010AUL
  377. #define CKA_VERIFY_RECOVER 0x0000010BUL
  378. #define CKA_DERIVE 0x0000010CUL
  379. #define CKA_START_DATE 0x00000110UL
  380. #define CKA_END_DATE 0x00000111UL
  381. #define CKA_MODULUS 0x00000120UL
  382. #define CKA_MODULUS_BITS 0x00000121UL
  383. #define CKA_PUBLIC_EXPONENT 0x00000122UL
  384. #define CKA_PRIVATE_EXPONENT 0x00000123UL
  385. #define CKA_PRIME_1 0x00000124UL
  386. #define CKA_PRIME_2 0x00000125UL
  387. #define CKA_EXPONENT_1 0x00000126UL
  388. #define CKA_EXPONENT_2 0x00000127UL
  389. #define CKA_COEFFICIENT 0x00000128UL
  390. #define CKA_PUBLIC_KEY_INFO 0x00000129UL
  391. #define CKA_PRIME 0x00000130UL
  392. #define CKA_SUBPRIME 0x00000131UL
  393. #define CKA_BASE 0x00000132UL
  394. #define CKA_PRIME_BITS 0x00000133UL
  395. #define CKA_SUBPRIME_BITS 0x00000134UL
  396. #define CKA_SUB_PRIME_BITS CKA_SUBPRIME_BITS
  397. #define CKA_VALUE_BITS 0x00000160UL
  398. #define CKA_VALUE_LEN 0x00000161UL
  399. #define CKA_EXTRACTABLE 0x00000162UL
  400. #define CKA_LOCAL 0x00000163UL
  401. #define CKA_NEVER_EXTRACTABLE 0x00000164UL
  402. #define CKA_ALWAYS_SENSITIVE 0x00000165UL
  403. #define CKA_KEY_GEN_MECHANISM 0x00000166UL
  404. #define CKA_MODIFIABLE 0x00000170UL
  405. #define CKA_COPYABLE 0x00000171UL
  406. #define CKA_DESTROYABLE 0x00000172UL
  407. #define CKA_ECDSA_PARAMS 0x00000180UL /* Deprecated */
  408. #define CKA_EC_PARAMS 0x00000180UL
  409. #define CKA_EC_POINT 0x00000181UL
  410. #define CKA_SECONDARY_AUTH 0x00000200UL /* Deprecated */
  411. #define CKA_AUTH_PIN_FLAGS 0x00000201UL /* Deprecated */
  412. #define CKA_ALWAYS_AUTHENTICATE 0x00000202UL
  413. #define CKA_WRAP_WITH_TRUSTED 0x00000210UL
  414. #define CKA_WRAP_TEMPLATE (CKF_ARRAY_ATTRIBUTE|0x00000211UL)
  415. #define CKA_UNWRAP_TEMPLATE (CKF_ARRAY_ATTRIBUTE|0x00000212UL)
  416. #define CKA_DERIVE_TEMPLATE (CKF_ARRAY_ATTRIBUTE|0x00000213UL)
  417. #define CKA_OTP_FORMAT 0x00000220UL
  418. #define CKA_OTP_LENGTH 0x00000221UL
  419. #define CKA_OTP_TIME_INTERVAL 0x00000222UL
  420. #define CKA_OTP_USER_FRIENDLY_MODE 0x00000223UL
  421. #define CKA_OTP_CHALLENGE_REQUIREMENT 0x00000224UL
  422. #define CKA_OTP_TIME_REQUIREMENT 0x00000225UL
  423. #define CKA_OTP_COUNTER_REQUIREMENT 0x00000226UL
  424. #define CKA_OTP_PIN_REQUIREMENT 0x00000227UL
  425. #define CKA_OTP_COUNTER 0x0000022EUL
  426. #define CKA_OTP_TIME 0x0000022FUL
  427. #define CKA_OTP_USER_IDENTIFIER 0x0000022AUL
  428. #define CKA_OTP_SERVICE_IDENTIFIER 0x0000022BUL
  429. #define CKA_OTP_SERVICE_LOGO 0x0000022CUL
  430. #define CKA_OTP_SERVICE_LOGO_TYPE 0x0000022DUL
  431. #define CKA_GOSTR3410_PARAMS 0x00000250UL
  432. #define CKA_GOSTR3411_PARAMS 0x00000251UL
  433. #define CKA_GOST28147_PARAMS 0x00000252UL
  434. #define CKA_HW_FEATURE_TYPE 0x00000300UL
  435. #define CKA_RESET_ON_INIT 0x00000301UL
  436. #define CKA_HAS_RESET 0x00000302UL
  437. #define CKA_PIXEL_X 0x00000400UL
  438. #define CKA_PIXEL_Y 0x00000401UL
  439. #define CKA_RESOLUTION 0x00000402UL
  440. #define CKA_CHAR_ROWS 0x00000403UL
  441. #define CKA_CHAR_COLUMNS 0x00000404UL
  442. #define CKA_COLOR 0x00000405UL
  443. #define CKA_BITS_PER_PIXEL 0x00000406UL
  444. #define CKA_CHAR_SETS 0x00000480UL
  445. #define CKA_ENCODING_METHODS 0x00000481UL
  446. #define CKA_MIME_TYPES 0x00000482UL
  447. #define CKA_MECHANISM_TYPE 0x00000500UL
  448. #define CKA_REQUIRED_CMS_ATTRIBUTES 0x00000501UL
  449. #define CKA_DEFAULT_CMS_ATTRIBUTES 0x00000502UL
  450. #define CKA_SUPPORTED_CMS_ATTRIBUTES 0x00000503UL
  451. #define CKA_ALLOWED_MECHANISMS (CKF_ARRAY_ATTRIBUTE|0x00000600UL)
  452. #define CKA_VENDOR_DEFINED 0x80000000UL
  453. /* CK_ATTRIBUTE is a structure that includes the type, length
  454. * and value of an attribute
  455. */
  456. typedef struct CK_ATTRIBUTE {
  457. CK_ATTRIBUTE_TYPE type;
  458. CK_VOID_PTR pValue;
  459. CK_ULONG ulValueLen; /* in bytes */
  460. } CK_ATTRIBUTE;
  461. typedef CK_ATTRIBUTE CK_PTR CK_ATTRIBUTE_PTR;
  462. /* CK_DATE is a structure that defines a date */
  463. typedef struct CK_DATE{
  464. CK_CHAR year[4]; /* the year ("1900" - "9999") */
  465. CK_CHAR month[2]; /* the month ("01" - "12") */
  466. CK_CHAR day[2]; /* the day ("01" - "31") */
  467. } CK_DATE;
  468. /* CK_MECHANISM_TYPE is a value that identifies a mechanism
  469. * type
  470. */
  471. typedef CK_ULONG CK_MECHANISM_TYPE;
  472. /* the following mechanism types are defined: */
  473. #define CKM_RSA_PKCS_KEY_PAIR_GEN 0x00000000UL
  474. #define CKM_RSA_PKCS 0x00000001UL
  475. #define CKM_RSA_9796 0x00000002UL
  476. #define CKM_RSA_X_509 0x00000003UL
  477. #define CKM_MD2_RSA_PKCS 0x00000004UL
  478. #define CKM_MD5_RSA_PKCS 0x00000005UL
  479. #define CKM_SHA1_RSA_PKCS 0x00000006UL
  480. #define CKM_RIPEMD128_RSA_PKCS 0x00000007UL
  481. #define CKM_RIPEMD160_RSA_PKCS 0x00000008UL
  482. #define CKM_RSA_PKCS_OAEP 0x00000009UL
  483. #define CKM_RSA_X9_31_KEY_PAIR_GEN 0x0000000AUL
  484. #define CKM_RSA_X9_31 0x0000000BUL
  485. #define CKM_SHA1_RSA_X9_31 0x0000000CUL
  486. #define CKM_RSA_PKCS_PSS 0x0000000DUL
  487. #define CKM_SHA1_RSA_PKCS_PSS 0x0000000EUL
  488. #define CKM_DSA_KEY_PAIR_GEN 0x00000010UL
  489. #define CKM_DSA 0x00000011UL
  490. #define CKM_DSA_SHA1 0x00000012UL
  491. #define CKM_DSA_SHA224 0x00000013UL
  492. #define CKM_DSA_SHA256 0x00000014UL
  493. #define CKM_DSA_SHA384 0x00000015UL
  494. #define CKM_DSA_SHA512 0x00000016UL
  495. #define CKM_DH_PKCS_KEY_PAIR_GEN 0x00000020UL
  496. #define CKM_DH_PKCS_DERIVE 0x00000021UL
  497. #define CKM_X9_42_DH_KEY_PAIR_GEN 0x00000030UL
  498. #define CKM_X9_42_DH_DERIVE 0x00000031UL
  499. #define CKM_X9_42_DH_HYBRID_DERIVE 0x00000032UL
  500. #define CKM_X9_42_MQV_DERIVE 0x00000033UL
  501. #define CKM_SHA256_RSA_PKCS 0x00000040UL
  502. #define CKM_SHA384_RSA_PKCS 0x00000041UL
  503. #define CKM_SHA512_RSA_PKCS 0x00000042UL
  504. #define CKM_SHA256_RSA_PKCS_PSS 0x00000043UL
  505. #define CKM_SHA384_RSA_PKCS_PSS 0x00000044UL
  506. #define CKM_SHA512_RSA_PKCS_PSS 0x00000045UL
  507. #define CKM_SHA224_RSA_PKCS 0x00000046UL
  508. #define CKM_SHA224_RSA_PKCS_PSS 0x00000047UL
  509. #define CKM_SHA512_224 0x00000048UL
  510. #define CKM_SHA512_224_HMAC 0x00000049UL
  511. #define CKM_SHA512_224_HMAC_GENERAL 0x0000004AUL
  512. #define CKM_SHA512_224_KEY_DERIVATION 0x0000004BUL
  513. #define CKM_SHA512_256 0x0000004CUL
  514. #define CKM_SHA512_256_HMAC 0x0000004DUL
  515. #define CKM_SHA512_256_HMAC_GENERAL 0x0000004EUL
  516. #define CKM_SHA512_256_KEY_DERIVATION 0x0000004FUL
  517. #define CKM_SHA512_T 0x00000050UL
  518. #define CKM_SHA512_T_HMAC 0x00000051UL
  519. #define CKM_SHA512_T_HMAC_GENERAL 0x00000052UL
  520. #define CKM_SHA512_T_KEY_DERIVATION 0x00000053UL
  521. #define CKM_RC2_KEY_GEN 0x00000100UL
  522. #define CKM_RC2_ECB 0x00000101UL
  523. #define CKM_RC2_CBC 0x00000102UL
  524. #define CKM_RC2_MAC 0x00000103UL
  525. #define CKM_RC2_MAC_GENERAL 0x00000104UL
  526. #define CKM_RC2_CBC_PAD 0x00000105UL
  527. #define CKM_RC4_KEY_GEN 0x00000110UL
  528. #define CKM_RC4 0x00000111UL
  529. #define CKM_DES_KEY_GEN 0x00000120UL
  530. #define CKM_DES_ECB 0x00000121UL
  531. #define CKM_DES_CBC 0x00000122UL
  532. #define CKM_DES_MAC 0x00000123UL
  533. #define CKM_DES_MAC_GENERAL 0x00000124UL
  534. #define CKM_DES_CBC_PAD 0x00000125UL
  535. #define CKM_DES2_KEY_GEN 0x00000130UL
  536. #define CKM_DES3_KEY_GEN 0x00000131UL
  537. #define CKM_DES3_ECB 0x00000132UL
  538. #define CKM_DES3_CBC 0x00000133UL
  539. #define CKM_DES3_MAC 0x00000134UL
  540. #define CKM_DES3_MAC_GENERAL 0x00000135UL
  541. #define CKM_DES3_CBC_PAD 0x00000136UL
  542. #define CKM_DES3_CMAC_GENERAL 0x00000137UL
  543. #define CKM_DES3_CMAC 0x00000138UL
  544. #define CKM_CDMF_KEY_GEN 0x00000140UL
  545. #define CKM_CDMF_ECB 0x00000141UL
  546. #define CKM_CDMF_CBC 0x00000142UL
  547. #define CKM_CDMF_MAC 0x00000143UL
  548. #define CKM_CDMF_MAC_GENERAL 0x00000144UL
  549. #define CKM_CDMF_CBC_PAD 0x00000145UL
  550. #define CKM_DES_OFB64 0x00000150UL
  551. #define CKM_DES_OFB8 0x00000151UL
  552. #define CKM_DES_CFB64 0x00000152UL
  553. #define CKM_DES_CFB8 0x00000153UL
  554. #define CKM_MD2 0x00000200UL
  555. #define CKM_MD2_HMAC 0x00000201UL
  556. #define CKM_MD2_HMAC_GENERAL 0x00000202UL
  557. #define CKM_MD5 0x00000210UL
  558. #define CKM_MD5_HMAC 0x00000211UL
  559. #define CKM_MD5_HMAC_GENERAL 0x00000212UL
  560. #define CKM_SHA_1 0x00000220UL
  561. #define CKM_SHA_1_HMAC 0x00000221UL
  562. #define CKM_SHA_1_HMAC_GENERAL 0x00000222UL
  563. #define CKM_RIPEMD128 0x00000230UL
  564. #define CKM_RIPEMD128_HMAC 0x00000231UL
  565. #define CKM_RIPEMD128_HMAC_GENERAL 0x00000232UL
  566. #define CKM_RIPEMD160 0x00000240UL
  567. #define CKM_RIPEMD160_HMAC 0x00000241UL
  568. #define CKM_RIPEMD160_HMAC_GENERAL 0x00000242UL
  569. #define CKM_SHA256 0x00000250UL
  570. #define CKM_SHA256_HMAC 0x00000251UL
  571. #define CKM_SHA256_HMAC_GENERAL 0x00000252UL
  572. #define CKM_SHA224 0x00000255UL
  573. #define CKM_SHA224_HMAC 0x00000256UL
  574. #define CKM_SHA224_HMAC_GENERAL 0x00000257UL
  575. #define CKM_SHA384 0x00000260UL
  576. #define CKM_SHA384_HMAC 0x00000261UL
  577. #define CKM_SHA384_HMAC_GENERAL 0x00000262UL
  578. #define CKM_SHA512 0x00000270UL
  579. #define CKM_SHA512_HMAC 0x00000271UL
  580. #define CKM_SHA512_HMAC_GENERAL 0x00000272UL
  581. #define CKM_SECURID_KEY_GEN 0x00000280UL
  582. #define CKM_SECURID 0x00000282UL
  583. #define CKM_HOTP_KEY_GEN 0x00000290UL
  584. #define CKM_HOTP 0x00000291UL
  585. #define CKM_ACTI 0x000002A0UL
  586. #define CKM_ACTI_KEY_GEN 0x000002A1UL
  587. #define CKM_CAST_KEY_GEN 0x00000300UL
  588. #define CKM_CAST_ECB 0x00000301UL
  589. #define CKM_CAST_CBC 0x00000302UL
  590. #define CKM_CAST_MAC 0x00000303UL
  591. #define CKM_CAST_MAC_GENERAL 0x00000304UL
  592. #define CKM_CAST_CBC_PAD 0x00000305UL
  593. #define CKM_CAST3_KEY_GEN 0x00000310UL
  594. #define CKM_CAST3_ECB 0x00000311UL
  595. #define CKM_CAST3_CBC 0x00000312UL
  596. #define CKM_CAST3_MAC 0x00000313UL
  597. #define CKM_CAST3_MAC_GENERAL 0x00000314UL
  598. #define CKM_CAST3_CBC_PAD 0x00000315UL
  599. /* Note that CAST128 and CAST5 are the same algorithm */
  600. #define CKM_CAST5_KEY_GEN 0x00000320UL
  601. #define CKM_CAST128_KEY_GEN 0x00000320UL
  602. #define CKM_CAST5_ECB 0x00000321UL
  603. #define CKM_CAST128_ECB 0x00000321UL
  604. #define CKM_CAST5_CBC 0x00000322UL /* Deprecated */
  605. #define CKM_CAST128_CBC 0x00000322UL
  606. #define CKM_CAST5_MAC 0x00000323UL /* Deprecated */
  607. #define CKM_CAST128_MAC 0x00000323UL
  608. #define CKM_CAST5_MAC_GENERAL 0x00000324UL /* Deprecated */
  609. #define CKM_CAST128_MAC_GENERAL 0x00000324UL
  610. #define CKM_CAST5_CBC_PAD 0x00000325UL /* Deprecated */
  611. #define CKM_CAST128_CBC_PAD 0x00000325UL
  612. #define CKM_RC5_KEY_GEN 0x00000330UL
  613. #define CKM_RC5_ECB 0x00000331UL
  614. #define CKM_RC5_CBC 0x00000332UL
  615. #define CKM_RC5_MAC 0x00000333UL
  616. #define CKM_RC5_MAC_GENERAL 0x00000334UL
  617. #define CKM_RC5_CBC_PAD 0x00000335UL
  618. #define CKM_IDEA_KEY_GEN 0x00000340UL
  619. #define CKM_IDEA_ECB 0x00000341UL
  620. #define CKM_IDEA_CBC 0x00000342UL
  621. #define CKM_IDEA_MAC 0x00000343UL
  622. #define CKM_IDEA_MAC_GENERAL 0x00000344UL
  623. #define CKM_IDEA_CBC_PAD 0x00000345UL
  624. #define CKM_GENERIC_SECRET_KEY_GEN 0x00000350UL
  625. #define CKM_CONCATENATE_BASE_AND_KEY 0x00000360UL
  626. #define CKM_CONCATENATE_BASE_AND_DATA 0x00000362UL
  627. #define CKM_CONCATENATE_DATA_AND_BASE 0x00000363UL
  628. #define CKM_XOR_BASE_AND_DATA 0x00000364UL
  629. #define CKM_EXTRACT_KEY_FROM_KEY 0x00000365UL
  630. #define CKM_SSL3_PRE_MASTER_KEY_GEN 0x00000370UL
  631. #define CKM_SSL3_MASTER_KEY_DERIVE 0x00000371UL
  632. #define CKM_SSL3_KEY_AND_MAC_DERIVE 0x00000372UL
  633. #define CKM_SSL3_MASTER_KEY_DERIVE_DH 0x00000373UL
  634. #define CKM_TLS_PRE_MASTER_KEY_GEN 0x00000374UL
  635. #define CKM_TLS_MASTER_KEY_DERIVE 0x00000375UL
  636. #define CKM_TLS_KEY_AND_MAC_DERIVE 0x00000376UL
  637. #define CKM_TLS_MASTER_KEY_DERIVE_DH 0x00000377UL
  638. #define CKM_TLS_PRF 0x00000378UL
  639. #define CKM_SSL3_MD5_MAC 0x00000380UL
  640. #define CKM_SSL3_SHA1_MAC 0x00000381UL
  641. #define CKM_MD5_KEY_DERIVATION 0x00000390UL
  642. #define CKM_MD2_KEY_DERIVATION 0x00000391UL
  643. #define CKM_SHA1_KEY_DERIVATION 0x00000392UL
  644. #define CKM_SHA256_KEY_DERIVATION 0x00000393UL
  645. #define CKM_SHA384_KEY_DERIVATION 0x00000394UL
  646. #define CKM_SHA512_KEY_DERIVATION 0x00000395UL
  647. #define CKM_SHA224_KEY_DERIVATION 0x00000396UL
  648. #define CKM_PBE_MD2_DES_CBC 0x000003A0UL
  649. #define CKM_PBE_MD5_DES_CBC 0x000003A1UL
  650. #define CKM_PBE_MD5_CAST_CBC 0x000003A2UL
  651. #define CKM_PBE_MD5_CAST3_CBC 0x000003A3UL
  652. #define CKM_PBE_MD5_CAST5_CBC 0x000003A4UL /* Deprecated */
  653. #define CKM_PBE_MD5_CAST128_CBC 0x000003A4UL
  654. #define CKM_PBE_SHA1_CAST5_CBC 0x000003A5UL /* Deprecated */
  655. #define CKM_PBE_SHA1_CAST128_CBC 0x000003A5UL
  656. #define CKM_PBE_SHA1_RC4_128 0x000003A6UL
  657. #define CKM_PBE_SHA1_RC4_40 0x000003A7UL
  658. #define CKM_PBE_SHA1_DES3_EDE_CBC 0x000003A8UL
  659. #define CKM_PBE_SHA1_DES2_EDE_CBC 0x000003A9UL
  660. #define CKM_PBE_SHA1_RC2_128_CBC 0x000003AAUL
  661. #define CKM_PBE_SHA1_RC2_40_CBC 0x000003ABUL
  662. #define CKM_PKCS5_PBKD2 0x000003B0UL
  663. #define CKM_PBA_SHA1_WITH_SHA1_HMAC 0x000003C0UL
  664. #define CKM_WTLS_PRE_MASTER_KEY_GEN 0x000003D0UL
  665. #define CKM_WTLS_MASTER_KEY_DERIVE 0x000003D1UL
  666. #define CKM_WTLS_MASTER_KEY_DERIVE_DH_ECC 0x000003D2UL
  667. #define CKM_WTLS_PRF 0x000003D3UL
  668. #define CKM_WTLS_SERVER_KEY_AND_MAC_DERIVE 0x000003D4UL
  669. #define CKM_WTLS_CLIENT_KEY_AND_MAC_DERIVE 0x000003D5UL
  670. #define CKM_TLS10_MAC_SERVER 0x000003D6UL
  671. #define CKM_TLS10_MAC_CLIENT 0x000003D7UL
  672. #define CKM_TLS12_MAC 0x000003D8UL
  673. #define CKM_TLS12_KDF 0x000003D9UL
  674. #define CKM_TLS12_MASTER_KEY_DERIVE 0x000003E0UL
  675. #define CKM_TLS12_KEY_AND_MAC_DERIVE 0x000003E1UL
  676. #define CKM_TLS12_MASTER_KEY_DERIVE_DH 0x000003E2UL
  677. #define CKM_TLS12_KEY_SAFE_DERIVE 0x000003E3UL
  678. #define CKM_TLS_MAC 0x000003E4UL
  679. #define CKM_TLS_KDF 0x000003E5UL
  680. #define CKM_KEY_WRAP_LYNKS 0x00000400UL
  681. #define CKM_KEY_WRAP_SET_OAEP 0x00000401UL
  682. #define CKM_CMS_SIG 0x00000500UL
  683. #define CKM_KIP_DERIVE 0x00000510UL
  684. #define CKM_KIP_WRAP 0x00000511UL
  685. #define CKM_KIP_MAC 0x00000512UL
  686. #define CKM_CAMELLIA_KEY_GEN 0x00000550UL
  687. #define CKM_CAMELLIA_ECB 0x00000551UL
  688. #define CKM_CAMELLIA_CBC 0x00000552UL
  689. #define CKM_CAMELLIA_MAC 0x00000553UL
  690. #define CKM_CAMELLIA_MAC_GENERAL 0x00000554UL
  691. #define CKM_CAMELLIA_CBC_PAD 0x00000555UL
  692. #define CKM_CAMELLIA_ECB_ENCRYPT_DATA 0x00000556UL
  693. #define CKM_CAMELLIA_CBC_ENCRYPT_DATA 0x00000557UL
  694. #define CKM_CAMELLIA_CTR 0x00000558UL
  695. #define CKM_ARIA_KEY_GEN 0x00000560UL
  696. #define CKM_ARIA_ECB 0x00000561UL
  697. #define CKM_ARIA_CBC 0x00000562UL
  698. #define CKM_ARIA_MAC 0x00000563UL
  699. #define CKM_ARIA_MAC_GENERAL 0x00000564UL
  700. #define CKM_ARIA_CBC_PAD 0x00000565UL
  701. #define CKM_ARIA_ECB_ENCRYPT_DATA 0x00000566UL
  702. #define CKM_ARIA_CBC_ENCRYPT_DATA 0x00000567UL
  703. #define CKM_SEED_KEY_GEN 0x00000650UL
  704. #define CKM_SEED_ECB 0x00000651UL
  705. #define CKM_SEED_CBC 0x00000652UL
  706. #define CKM_SEED_MAC 0x00000653UL
  707. #define CKM_SEED_MAC_GENERAL 0x00000654UL
  708. #define CKM_SEED_CBC_PAD 0x00000655UL
  709. #define CKM_SEED_ECB_ENCRYPT_DATA 0x00000656UL
  710. #define CKM_SEED_CBC_ENCRYPT_DATA 0x00000657UL
  711. #define CKM_SKIPJACK_KEY_GEN 0x00001000UL
  712. #define CKM_SKIPJACK_ECB64 0x00001001UL
  713. #define CKM_SKIPJACK_CBC64 0x00001002UL
  714. #define CKM_SKIPJACK_OFB64 0x00001003UL
  715. #define CKM_SKIPJACK_CFB64 0x00001004UL
  716. #define CKM_SKIPJACK_CFB32 0x00001005UL
  717. #define CKM_SKIPJACK_CFB16 0x00001006UL
  718. #define CKM_SKIPJACK_CFB8 0x00001007UL
  719. #define CKM_SKIPJACK_WRAP 0x00001008UL
  720. #define CKM_SKIPJACK_PRIVATE_WRAP 0x00001009UL
  721. #define CKM_SKIPJACK_RELAYX 0x0000100aUL
  722. #define CKM_KEA_KEY_PAIR_GEN 0x00001010UL
  723. #define CKM_KEA_KEY_DERIVE 0x00001011UL
  724. #define CKM_KEA_DERIVE 0x00001012UL
  725. #define CKM_FORTEZZA_TIMESTAMP 0x00001020UL
  726. #define CKM_BATON_KEY_GEN 0x00001030UL
  727. #define CKM_BATON_ECB128 0x00001031UL
  728. #define CKM_BATON_ECB96 0x00001032UL
  729. #define CKM_BATON_CBC128 0x00001033UL
  730. #define CKM_BATON_COUNTER 0x00001034UL
  731. #define CKM_BATON_SHUFFLE 0x00001035UL
  732. #define CKM_BATON_WRAP 0x00001036UL
  733. #define CKM_ECDSA_KEY_PAIR_GEN 0x00001040UL /* Deprecated */
  734. #define CKM_EC_KEY_PAIR_GEN 0x00001040UL
  735. #define CKM_ECDSA 0x00001041UL
  736. #define CKM_ECDSA_SHA1 0x00001042UL
  737. #define CKM_ECDSA_SHA224 0x00001043UL
  738. #define CKM_ECDSA_SHA256 0x00001044UL
  739. #define CKM_ECDSA_SHA384 0x00001045UL
  740. #define CKM_ECDSA_SHA512 0x00001046UL
  741. #define CKM_ECDH1_DERIVE 0x00001050UL
  742. #define CKM_ECDH1_COFACTOR_DERIVE 0x00001051UL
  743. #define CKM_ECMQV_DERIVE 0x00001052UL
  744. #define CKM_ECDH_AES_KEY_WRAP 0x00001053UL
  745. #define CKM_RSA_AES_KEY_WRAP 0x00001054UL
  746. #define CKM_JUNIPER_KEY_GEN 0x00001060UL
  747. #define CKM_JUNIPER_ECB128 0x00001061UL
  748. #define CKM_JUNIPER_CBC128 0x00001062UL
  749. #define CKM_JUNIPER_COUNTER 0x00001063UL
  750. #define CKM_JUNIPER_SHUFFLE 0x00001064UL
  751. #define CKM_JUNIPER_WRAP 0x00001065UL
  752. #define CKM_FASTHASH 0x00001070UL
  753. #define CKM_AES_KEY_GEN 0x00001080UL
  754. #define CKM_AES_ECB 0x00001081UL
  755. #define CKM_AES_CBC 0x00001082UL
  756. #define CKM_AES_MAC 0x00001083UL
  757. #define CKM_AES_MAC_GENERAL 0x00001084UL
  758. #define CKM_AES_CBC_PAD 0x00001085UL
  759. #define CKM_AES_CTR 0x00001086UL
  760. #define CKM_AES_GCM 0x00001087UL
  761. #define CKM_AES_CCM 0x00001088UL
  762. #define CKM_AES_CTS 0x00001089UL
  763. #define CKM_AES_CMAC 0x0000108AUL
  764. #define CKM_AES_CMAC_GENERAL 0x0000108BUL
  765. #define CKM_AES_XCBC_MAC 0x0000108CUL
  766. #define CKM_AES_XCBC_MAC_96 0x0000108DUL
  767. #define CKM_AES_GMAC 0x0000108EUL
  768. #define CKM_BLOWFISH_KEY_GEN 0x00001090UL
  769. #define CKM_BLOWFISH_CBC 0x00001091UL
  770. #define CKM_TWOFISH_KEY_GEN 0x00001092UL
  771. #define CKM_TWOFISH_CBC 0x00001093UL
  772. #define CKM_BLOWFISH_CBC_PAD 0x00001094UL
  773. #define CKM_TWOFISH_CBC_PAD 0x00001095UL
  774. #define CKM_DES_ECB_ENCRYPT_DATA 0x00001100UL
  775. #define CKM_DES_CBC_ENCRYPT_DATA 0x00001101UL
  776. #define CKM_DES3_ECB_ENCRYPT_DATA 0x00001102UL
  777. #define CKM_DES3_CBC_ENCRYPT_DATA 0x00001103UL
  778. #define CKM_AES_ECB_ENCRYPT_DATA 0x00001104UL
  779. #define CKM_AES_CBC_ENCRYPT_DATA 0x00001105UL
  780. #define CKM_GOSTR3410_KEY_PAIR_GEN 0x00001200UL
  781. #define CKM_GOSTR3410 0x00001201UL
  782. #define CKM_GOSTR3410_WITH_GOSTR3411 0x00001202UL
  783. #define CKM_GOSTR3410_KEY_WRAP 0x00001203UL
  784. #define CKM_GOSTR3410_DERIVE 0x00001204UL
  785. #define CKM_GOSTR3411 0x00001210UL
  786. #define CKM_GOSTR3411_HMAC 0x00001211UL
  787. #define CKM_GOST28147_KEY_GEN 0x00001220UL
  788. #define CKM_GOST28147_ECB 0x00001221UL
  789. #define CKM_GOST28147 0x00001222UL
  790. #define CKM_GOST28147_MAC 0x00001223UL
  791. #define CKM_GOST28147_KEY_WRAP 0x00001224UL
  792. #define CKM_DSA_PARAMETER_GEN 0x00002000UL
  793. #define CKM_DH_PKCS_PARAMETER_GEN 0x00002001UL
  794. #define CKM_X9_42_DH_PARAMETER_GEN 0x00002002UL
  795. #define CKM_DSA_PROBABLISTIC_PARAMETER_GEN 0x00002003UL
  796. #define CKM_DSA_SHAWE_TAYLOR_PARAMETER_GEN 0x00002004UL
  797. #define CKM_AES_OFB 0x00002104UL
  798. #define CKM_AES_CFB64 0x00002105UL
  799. #define CKM_AES_CFB8 0x00002106UL
  800. #define CKM_AES_CFB128 0x00002107UL
  801. #define CKM_AES_CFB1 0x00002108UL
  802. #define CKM_AES_KEY_WRAP 0x00002109UL /* WAS: 0x00001090 */
  803. #define CKM_AES_KEY_WRAP_PAD 0x0000210AUL /* WAS: 0x00001091 */
  804. #define CKM_RSA_PKCS_TPM_1_1 0x00004001UL
  805. #define CKM_RSA_PKCS_OAEP_TPM_1_1 0x00004002UL
  806. #define CKM_VENDOR_DEFINED 0x80000000UL
  807. typedef CK_MECHANISM_TYPE CK_PTR CK_MECHANISM_TYPE_PTR;
  808. /* CK_MECHANISM is a structure that specifies a particular
  809. * mechanism
  810. */
  811. typedef struct CK_MECHANISM {
  812. CK_MECHANISM_TYPE mechanism;
  813. CK_VOID_PTR pParameter;
  814. CK_ULONG ulParameterLen; /* in bytes */
  815. } CK_MECHANISM;
  816. typedef CK_MECHANISM CK_PTR CK_MECHANISM_PTR;
  817. /* CK_MECHANISM_INFO provides information about a particular
  818. * mechanism
  819. */
  820. typedef struct CK_MECHANISM_INFO {
  821. CK_ULONG ulMinKeySize;
  822. CK_ULONG ulMaxKeySize;
  823. CK_FLAGS flags;
  824. } CK_MECHANISM_INFO;
  825. /* The flags are defined as follows:
  826. * Bit Flag Mask Meaning */
  827. #define CKF_HW 0x00000001UL /* performed by HW */
  828. /* Specify whether or not a mechanism can be used for a particular task */
  829. #define CKF_ENCRYPT 0x00000100UL
  830. #define CKF_DECRYPT 0x00000200UL
  831. #define CKF_DIGEST 0x00000400UL
  832. #define CKF_SIGN 0x00000800UL
  833. #define CKF_SIGN_RECOVER 0x00001000UL
  834. #define CKF_VERIFY 0x00002000UL
  835. #define CKF_VERIFY_RECOVER 0x00004000UL
  836. #define CKF_GENERATE 0x00008000UL
  837. #define CKF_GENERATE_KEY_PAIR 0x00010000UL
  838. #define CKF_WRAP 0x00020000UL
  839. #define CKF_UNWRAP 0x00040000UL
  840. #define CKF_DERIVE 0x00080000UL
  841. /* Describe a token's EC capabilities not available in mechanism
  842. * information.
  843. */
  844. #define CKF_EC_F_P 0x00100000UL
  845. #define CKF_EC_F_2M 0x00200000UL
  846. #define CKF_EC_ECPARAMETERS 0x00400000UL
  847. #define CKF_EC_NAMEDCURVE 0x00800000UL
  848. #define CKF_EC_UNCOMPRESS 0x01000000UL
  849. #define CKF_EC_COMPRESS 0x02000000UL
  850. #define CKF_EXTENSION 0x80000000UL
  851. typedef CK_MECHANISM_INFO CK_PTR CK_MECHANISM_INFO_PTR;
  852. /* CK_RV is a value that identifies the return value of a
  853. * Cryptoki function
  854. */
  855. typedef CK_ULONG CK_RV;
  856. #define CKR_OK 0x00000000UL
  857. #define CKR_CANCEL 0x00000001UL
  858. #define CKR_HOST_MEMORY 0x00000002UL
  859. #define CKR_SLOT_ID_INVALID 0x00000003UL
  860. #define CKR_GENERAL_ERROR 0x00000005UL
  861. #define CKR_FUNCTION_FAILED 0x00000006UL
  862. #define CKR_ARGUMENTS_BAD 0x00000007UL
  863. #define CKR_NO_EVENT 0x00000008UL
  864. #define CKR_NEED_TO_CREATE_THREADS 0x00000009UL
  865. #define CKR_CANT_LOCK 0x0000000AUL
  866. #define CKR_ATTRIBUTE_READ_ONLY 0x00000010UL
  867. #define CKR_ATTRIBUTE_SENSITIVE 0x00000011UL
  868. #define CKR_ATTRIBUTE_TYPE_INVALID 0x00000012UL
  869. #define CKR_ATTRIBUTE_VALUE_INVALID 0x00000013UL
  870. #define CKR_ACTION_PROHIBITED 0x0000001BUL
  871. #define CKR_DATA_INVALID 0x00000020UL
  872. #define CKR_DATA_LEN_RANGE 0x00000021UL
  873. #define CKR_DEVICE_ERROR 0x00000030UL
  874. #define CKR_DEVICE_MEMORY 0x00000031UL
  875. #define CKR_DEVICE_REMOVED 0x00000032UL
  876. #define CKR_ENCRYPTED_DATA_INVALID 0x00000040UL
  877. #define CKR_ENCRYPTED_DATA_LEN_RANGE 0x00000041UL
  878. #define CKR_FUNCTION_CANCELED 0x00000050UL
  879. #define CKR_FUNCTION_NOT_PARALLEL 0x00000051UL
  880. #define CKR_FUNCTION_NOT_SUPPORTED 0x00000054UL
  881. #define CKR_KEY_HANDLE_INVALID 0x00000060UL
  882. #define CKR_KEY_SIZE_RANGE 0x00000062UL
  883. #define CKR_KEY_TYPE_INCONSISTENT 0x00000063UL
  884. #define CKR_KEY_NOT_NEEDED 0x00000064UL
  885. #define CKR_KEY_CHANGED 0x00000065UL
  886. #define CKR_KEY_NEEDED 0x00000066UL
  887. #define CKR_KEY_INDIGESTIBLE 0x00000067UL
  888. #define CKR_KEY_FUNCTION_NOT_PERMITTED 0x00000068UL
  889. #define CKR_KEY_NOT_WRAPPABLE 0x00000069UL
  890. #define CKR_KEY_UNEXTRACTABLE 0x0000006AUL
  891. #define CKR_MECHANISM_INVALID 0x00000070UL
  892. #define CKR_MECHANISM_PARAM_INVALID 0x00000071UL
  893. #define CKR_OBJECT_HANDLE_INVALID 0x00000082UL
  894. #define CKR_OPERATION_ACTIVE 0x00000090UL
  895. #define CKR_OPERATION_NOT_INITIALIZED 0x00000091UL
  896. #define CKR_PIN_INCORRECT 0x000000A0UL
  897. #define CKR_PIN_INVALID 0x000000A1UL
  898. #define CKR_PIN_LEN_RANGE 0x000000A2UL
  899. #define CKR_PIN_EXPIRED 0x000000A3UL
  900. #define CKR_PIN_LOCKED 0x000000A4UL
  901. #define CKR_SESSION_CLOSED 0x000000B0UL
  902. #define CKR_SESSION_COUNT 0x000000B1UL
  903. #define CKR_SESSION_HANDLE_INVALID 0x000000B3UL
  904. #define CKR_SESSION_PARALLEL_NOT_SUPPORTED 0x000000B4UL
  905. #define CKR_SESSION_READ_ONLY 0x000000B5UL
  906. #define CKR_SESSION_EXISTS 0x000000B6UL
  907. #define CKR_SESSION_READ_ONLY_EXISTS 0x000000B7UL
  908. #define CKR_SESSION_READ_WRITE_SO_EXISTS 0x000000B8UL
  909. #define CKR_SIGNATURE_INVALID 0x000000C0UL
  910. #define CKR_SIGNATURE_LEN_RANGE 0x000000C1UL
  911. #define CKR_TEMPLATE_INCOMPLETE 0x000000D0UL
  912. #define CKR_TEMPLATE_INCONSISTENT 0x000000D1UL
  913. #define CKR_TOKEN_NOT_PRESENT 0x000000E0UL
  914. #define CKR_TOKEN_NOT_RECOGNIZED 0x000000E1UL
  915. #define CKR_TOKEN_WRITE_PROTECTED 0x000000E2UL
  916. #define CKR_UNWRAPPING_KEY_HANDLE_INVALID 0x000000F0UL
  917. #define CKR_UNWRAPPING_KEY_SIZE_RANGE 0x000000F1UL
  918. #define CKR_UNWRAPPING_KEY_TYPE_INCONSISTENT 0x000000F2UL
  919. #define CKR_USER_ALREADY_LOGGED_IN 0x00000100UL
  920. #define CKR_USER_NOT_LOGGED_IN 0x00000101UL
  921. #define CKR_USER_PIN_NOT_INITIALIZED 0x00000102UL
  922. #define CKR_USER_TYPE_INVALID 0x00000103UL
  923. #define CKR_USER_ANOTHER_ALREADY_LOGGED_IN 0x00000104UL
  924. #define CKR_USER_TOO_MANY_TYPES 0x00000105UL
  925. #define CKR_WRAPPED_KEY_INVALID 0x00000110UL
  926. #define CKR_WRAPPED_KEY_LEN_RANGE 0x00000112UL
  927. #define CKR_WRAPPING_KEY_HANDLE_INVALID 0x00000113UL
  928. #define CKR_WRAPPING_KEY_SIZE_RANGE 0x00000114UL
  929. #define CKR_WRAPPING_KEY_TYPE_INCONSISTENT 0x00000115UL
  930. #define CKR_RANDOM_SEED_NOT_SUPPORTED 0x00000120UL
  931. #define CKR_RANDOM_NO_RNG 0x00000121UL
  932. #define CKR_DOMAIN_PARAMS_INVALID 0x00000130UL
  933. #define CKR_CURVE_NOT_SUPPORTED 0x00000140UL
  934. #define CKR_BUFFER_TOO_SMALL 0x00000150UL
  935. #define CKR_SAVED_STATE_INVALID 0x00000160UL
  936. #define CKR_INFORMATION_SENSITIVE 0x00000170UL
  937. #define CKR_STATE_UNSAVEABLE 0x00000180UL
  938. #define CKR_CRYPTOKI_NOT_INITIALIZED 0x00000190UL
  939. #define CKR_CRYPTOKI_ALREADY_INITIALIZED 0x00000191UL
  940. #define CKR_MUTEX_BAD 0x000001A0UL
  941. #define CKR_MUTEX_NOT_LOCKED 0x000001A1UL
  942. #define CKR_NEW_PIN_MODE 0x000001B0UL
  943. #define CKR_NEXT_OTP 0x000001B1UL
  944. #define CKR_EXCEEDED_MAX_ITERATIONS 0x000001B5UL
  945. #define CKR_FIPS_SELF_TEST_FAILED 0x000001B6UL
  946. #define CKR_LIBRARY_LOAD_FAILED 0x000001B7UL
  947. #define CKR_PIN_TOO_WEAK 0x000001B8UL
  948. #define CKR_PUBLIC_KEY_INVALID 0x000001B9UL
  949. #define CKR_FUNCTION_REJECTED 0x00000200UL
  950. #define CKR_VENDOR_DEFINED 0x80000000UL
  951. /* CK_NOTIFY is an application callback that processes events */
  952. typedef CK_CALLBACK_FUNCTION(CK_RV, CK_NOTIFY)(
  953. CK_SESSION_HANDLE hSession, /* the session's handle */
  954. CK_NOTIFICATION event,
  955. CK_VOID_PTR pApplication /* passed to C_OpenSession */
  956. );
  957. /* CK_FUNCTION_LIST is a structure holding a Cryptoki spec
  958. * version and pointers of appropriate types to all the
  959. * Cryptoki functions
  960. */
  961. typedef struct CK_FUNCTION_LIST CK_FUNCTION_LIST;
  962. typedef CK_FUNCTION_LIST CK_PTR CK_FUNCTION_LIST_PTR;
  963. typedef CK_FUNCTION_LIST_PTR CK_PTR CK_FUNCTION_LIST_PTR_PTR;
  964. /* CK_CREATEMUTEX is an application callback for creating a
  965. * mutex object
  966. */
  967. typedef CK_CALLBACK_FUNCTION(CK_RV, CK_CREATEMUTEX)(
  968. CK_VOID_PTR_PTR ppMutex /* location to receive ptr to mutex */
  969. );
  970. /* CK_DESTROYMUTEX is an application callback for destroying a
  971. * mutex object
  972. */
  973. typedef CK_CALLBACK_FUNCTION(CK_RV, CK_DESTROYMUTEX)(
  974. CK_VOID_PTR pMutex /* pointer to mutex */
  975. );
  976. /* CK_LOCKMUTEX is an application callback for locking a mutex */
  977. typedef CK_CALLBACK_FUNCTION(CK_RV, CK_LOCKMUTEX)(
  978. CK_VOID_PTR pMutex /* pointer to mutex */
  979. );
  980. /* CK_UNLOCKMUTEX is an application callback for unlocking a
  981. * mutex
  982. */
  983. typedef CK_CALLBACK_FUNCTION(CK_RV, CK_UNLOCKMUTEX)(
  984. CK_VOID_PTR pMutex /* pointer to mutex */
  985. );
  986. /* CK_C_INITIALIZE_ARGS provides the optional arguments to
  987. * C_Initialize
  988. */
  989. typedef struct CK_C_INITIALIZE_ARGS {
  990. CK_CREATEMUTEX CreateMutex;
  991. CK_DESTROYMUTEX DestroyMutex;
  992. CK_LOCKMUTEX LockMutex;
  993. CK_UNLOCKMUTEX UnlockMutex;
  994. CK_FLAGS flags;
  995. CK_VOID_PTR pReserved;
  996. } CK_C_INITIALIZE_ARGS;
  997. /* flags: bit flags that provide capabilities of the slot
  998. * Bit Flag Mask Meaning
  999. */
  1000. #define CKF_LIBRARY_CANT_CREATE_OS_THREADS 0x00000001UL
  1001. #define CKF_OS_LOCKING_OK 0x00000002UL
  1002. typedef CK_C_INITIALIZE_ARGS CK_PTR CK_C_INITIALIZE_ARGS_PTR;
  1003. /* additional flags for parameters to functions */
  1004. /* CKF_DONT_BLOCK is for the function C_WaitForSlotEvent */
  1005. #define CKF_DONT_BLOCK 1
  1006. /* CK_RSA_PKCS_MGF_TYPE is used to indicate the Message
  1007. * Generation Function (MGF) applied to a message block when
  1008. * formatting a message block for the PKCS #1 OAEP encryption
  1009. * scheme.
  1010. */
  1011. typedef CK_ULONG CK_RSA_PKCS_MGF_TYPE;
  1012. typedef CK_RSA_PKCS_MGF_TYPE CK_PTR CK_RSA_PKCS_MGF_TYPE_PTR;
  1013. /* The following MGFs are defined */
  1014. #define CKG_MGF1_SHA1 0x00000001UL
  1015. #define CKG_MGF1_SHA256 0x00000002UL
  1016. #define CKG_MGF1_SHA384 0x00000003UL
  1017. #define CKG_MGF1_SHA512 0x00000004UL
  1018. #define CKG_MGF1_SHA224 0x00000005UL
  1019. /* CK_RSA_PKCS_OAEP_SOURCE_TYPE is used to indicate the source
  1020. * of the encoding parameter when formatting a message block
  1021. * for the PKCS #1 OAEP encryption scheme.
  1022. */
  1023. typedef CK_ULONG CK_RSA_PKCS_OAEP_SOURCE_TYPE;
  1024. typedef CK_RSA_PKCS_OAEP_SOURCE_TYPE CK_PTR CK_RSA_PKCS_OAEP_SOURCE_TYPE_PTR;
  1025. /* The following encoding parameter sources are defined */
  1026. #define CKZ_DATA_SPECIFIED 0x00000001UL
  1027. /* CK_RSA_PKCS_OAEP_PARAMS provides the parameters to the
  1028. * CKM_RSA_PKCS_OAEP mechanism.
  1029. */
  1030. typedef struct CK_RSA_PKCS_OAEP_PARAMS {
  1031. CK_MECHANISM_TYPE hashAlg;
  1032. CK_RSA_PKCS_MGF_TYPE mgf;
  1033. CK_RSA_PKCS_OAEP_SOURCE_TYPE source;
  1034. CK_VOID_PTR pSourceData;
  1035. CK_ULONG ulSourceDataLen;
  1036. } CK_RSA_PKCS_OAEP_PARAMS;
  1037. typedef CK_RSA_PKCS_OAEP_PARAMS CK_PTR CK_RSA_PKCS_OAEP_PARAMS_PTR;
  1038. /* CK_RSA_PKCS_PSS_PARAMS provides the parameters to the
  1039. * CKM_RSA_PKCS_PSS mechanism(s).
  1040. */
  1041. typedef struct CK_RSA_PKCS_PSS_PARAMS {
  1042. CK_MECHANISM_TYPE hashAlg;
  1043. CK_RSA_PKCS_MGF_TYPE mgf;
  1044. CK_ULONG sLen;
  1045. } CK_RSA_PKCS_PSS_PARAMS;
  1046. typedef CK_RSA_PKCS_PSS_PARAMS CK_PTR CK_RSA_PKCS_PSS_PARAMS_PTR;
  1047. typedef CK_ULONG CK_EC_KDF_TYPE;
  1048. /* The following EC Key Derivation Functions are defined */
  1049. #define CKD_NULL 0x00000001UL
  1050. #define CKD_SHA1_KDF 0x00000002UL
  1051. /* The following X9.42 DH key derivation functions are defined */
  1052. #define CKD_SHA1_KDF_ASN1 0x00000003UL
  1053. #define CKD_SHA1_KDF_CONCATENATE 0x00000004UL
  1054. #define CKD_SHA224_KDF 0x00000005UL
  1055. #define CKD_SHA256_KDF 0x00000006UL
  1056. #define CKD_SHA384_KDF 0x00000007UL
  1057. #define CKD_SHA512_KDF 0x00000008UL
  1058. #define CKD_CPDIVERSIFY_KDF 0x00000009UL
  1059. /* CK_ECDH1_DERIVE_PARAMS provides the parameters to the
  1060. * CKM_ECDH1_DERIVE and CKM_ECDH1_COFACTOR_DERIVE mechanisms,
  1061. * where each party contributes one key pair.
  1062. */
  1063. typedef struct CK_ECDH1_DERIVE_PARAMS {
  1064. CK_EC_KDF_TYPE kdf;
  1065. CK_ULONG ulSharedDataLen;
  1066. CK_BYTE_PTR pSharedData;
  1067. CK_ULONG ulPublicDataLen;
  1068. CK_BYTE_PTR pPublicData;
  1069. } CK_ECDH1_DERIVE_PARAMS;
  1070. typedef CK_ECDH1_DERIVE_PARAMS CK_PTR CK_ECDH1_DERIVE_PARAMS_PTR;
  1071. /*
  1072. * CK_ECDH2_DERIVE_PARAMS provides the parameters to the
  1073. * CKM_ECMQV_DERIVE mechanism, where each party contributes two key pairs.
  1074. */
  1075. typedef struct CK_ECDH2_DERIVE_PARAMS {
  1076. CK_EC_KDF_TYPE kdf;
  1077. CK_ULONG ulSharedDataLen;
  1078. CK_BYTE_PTR pSharedData;
  1079. CK_ULONG ulPublicDataLen;
  1080. CK_BYTE_PTR pPublicData;
  1081. CK_ULONG ulPrivateDataLen;
  1082. CK_OBJECT_HANDLE hPrivateData;
  1083. CK_ULONG ulPublicDataLen2;
  1084. CK_BYTE_PTR pPublicData2;
  1085. } CK_ECDH2_DERIVE_PARAMS;
  1086. typedef CK_ECDH2_DERIVE_PARAMS CK_PTR CK_ECDH2_DERIVE_PARAMS_PTR;
  1087. typedef struct CK_ECMQV_DERIVE_PARAMS {
  1088. CK_EC_KDF_TYPE kdf;
  1089. CK_ULONG ulSharedDataLen;
  1090. CK_BYTE_PTR pSharedData;
  1091. CK_ULONG ulPublicDataLen;
  1092. CK_BYTE_PTR pPublicData;
  1093. CK_ULONG ulPrivateDataLen;
  1094. CK_OBJECT_HANDLE hPrivateData;
  1095. CK_ULONG ulPublicDataLen2;
  1096. CK_BYTE_PTR pPublicData2;
  1097. CK_OBJECT_HANDLE publicKey;
  1098. } CK_ECMQV_DERIVE_PARAMS;
  1099. typedef CK_ECMQV_DERIVE_PARAMS CK_PTR CK_ECMQV_DERIVE_PARAMS_PTR;
  1100. /* Typedefs and defines for the CKM_X9_42_DH_KEY_PAIR_GEN and the
  1101. * CKM_X9_42_DH_PARAMETER_GEN mechanisms
  1102. */
  1103. typedef CK_ULONG CK_X9_42_DH_KDF_TYPE;
  1104. typedef CK_X9_42_DH_KDF_TYPE CK_PTR CK_X9_42_DH_KDF_TYPE_PTR;
  1105. /* CK_X9_42_DH1_DERIVE_PARAMS provides the parameters to the
  1106. * CKM_X9_42_DH_DERIVE key derivation mechanism, where each party
  1107. * contributes one key pair
  1108. */
  1109. typedef struct CK_X9_42_DH1_DERIVE_PARAMS {
  1110. CK_X9_42_DH_KDF_TYPE kdf;
  1111. CK_ULONG ulOtherInfoLen;
  1112. CK_BYTE_PTR pOtherInfo;
  1113. CK_ULONG ulPublicDataLen;
  1114. CK_BYTE_PTR pPublicData;
  1115. } CK_X9_42_DH1_DERIVE_PARAMS;
  1116. typedef struct CK_X9_42_DH1_DERIVE_PARAMS CK_PTR CK_X9_42_DH1_DERIVE_PARAMS_PTR;
  1117. /* CK_X9_42_DH2_DERIVE_PARAMS provides the parameters to the
  1118. * CKM_X9_42_DH_HYBRID_DERIVE and CKM_X9_42_MQV_DERIVE key derivation
  1119. * mechanisms, where each party contributes two key pairs
  1120. */
  1121. typedef struct CK_X9_42_DH2_DERIVE_PARAMS {
  1122. CK_X9_42_DH_KDF_TYPE kdf;
  1123. CK_ULONG ulOtherInfoLen;
  1124. CK_BYTE_PTR pOtherInfo;
  1125. CK_ULONG ulPublicDataLen;
  1126. CK_BYTE_PTR pPublicData;
  1127. CK_ULONG ulPrivateDataLen;
  1128. CK_OBJECT_HANDLE hPrivateData;
  1129. CK_ULONG ulPublicDataLen2;
  1130. CK_BYTE_PTR pPublicData2;
  1131. } CK_X9_42_DH2_DERIVE_PARAMS;
  1132. typedef CK_X9_42_DH2_DERIVE_PARAMS CK_PTR CK_X9_42_DH2_DERIVE_PARAMS_PTR;
  1133. typedef struct CK_X9_42_MQV_DERIVE_PARAMS {
  1134. CK_X9_42_DH_KDF_TYPE kdf;
  1135. CK_ULONG ulOtherInfoLen;
  1136. CK_BYTE_PTR pOtherInfo;
  1137. CK_ULONG ulPublicDataLen;
  1138. CK_BYTE_PTR pPublicData;
  1139. CK_ULONG ulPrivateDataLen;
  1140. CK_OBJECT_HANDLE hPrivateData;
  1141. CK_ULONG ulPublicDataLen2;
  1142. CK_BYTE_PTR pPublicData2;
  1143. CK_OBJECT_HANDLE publicKey;
  1144. } CK_X9_42_MQV_DERIVE_PARAMS;
  1145. typedef CK_X9_42_MQV_DERIVE_PARAMS CK_PTR CK_X9_42_MQV_DERIVE_PARAMS_PTR;
  1146. /* CK_KEA_DERIVE_PARAMS provides the parameters to the
  1147. * CKM_KEA_DERIVE mechanism
  1148. */
  1149. typedef struct CK_KEA_DERIVE_PARAMS {
  1150. CK_BBOOL isSender;
  1151. CK_ULONG ulRandomLen;
  1152. CK_BYTE_PTR pRandomA;
  1153. CK_BYTE_PTR pRandomB;
  1154. CK_ULONG ulPublicDataLen;
  1155. CK_BYTE_PTR pPublicData;
  1156. } CK_KEA_DERIVE_PARAMS;
  1157. typedef CK_KEA_DERIVE_PARAMS CK_PTR CK_KEA_DERIVE_PARAMS_PTR;
  1158. /* CK_RC2_PARAMS provides the parameters to the CKM_RC2_ECB and
  1159. * CKM_RC2_MAC mechanisms. An instance of CK_RC2_PARAMS just
  1160. * holds the effective keysize
  1161. */
  1162. typedef CK_ULONG CK_RC2_PARAMS;
  1163. typedef CK_RC2_PARAMS CK_PTR CK_RC2_PARAMS_PTR;
  1164. /* CK_RC2_CBC_PARAMS provides the parameters to the CKM_RC2_CBC
  1165. * mechanism
  1166. */
  1167. typedef struct CK_RC2_CBC_PARAMS {
  1168. CK_ULONG ulEffectiveBits; /* effective bits (1-1024) */
  1169. CK_BYTE iv[8]; /* IV for CBC mode */
  1170. } CK_RC2_CBC_PARAMS;
  1171. typedef CK_RC2_CBC_PARAMS CK_PTR CK_RC2_CBC_PARAMS_PTR;
  1172. /* CK_RC2_MAC_GENERAL_PARAMS provides the parameters for the
  1173. * CKM_RC2_MAC_GENERAL mechanism
  1174. */
  1175. typedef struct CK_RC2_MAC_GENERAL_PARAMS {
  1176. CK_ULONG ulEffectiveBits; /* effective bits (1-1024) */
  1177. CK_ULONG ulMacLength; /* Length of MAC in bytes */
  1178. } CK_RC2_MAC_GENERAL_PARAMS;
  1179. typedef CK_RC2_MAC_GENERAL_PARAMS CK_PTR \
  1180. CK_RC2_MAC_GENERAL_PARAMS_PTR;
  1181. /* CK_RC5_PARAMS provides the parameters to the CKM_RC5_ECB and
  1182. * CKM_RC5_MAC mechanisms
  1183. */
  1184. typedef struct CK_RC5_PARAMS {
  1185. CK_ULONG ulWordsize; /* wordsize in bits */
  1186. CK_ULONG ulRounds; /* number of rounds */
  1187. } CK_RC5_PARAMS;
  1188. typedef CK_RC5_PARAMS CK_PTR CK_RC5_PARAMS_PTR;
  1189. /* CK_RC5_CBC_PARAMS provides the parameters to the CKM_RC5_CBC
  1190. * mechanism
  1191. */
  1192. typedef struct CK_RC5_CBC_PARAMS {
  1193. CK_ULONG ulWordsize; /* wordsize in bits */
  1194. CK_ULONG ulRounds; /* number of rounds */
  1195. CK_BYTE_PTR pIv; /* pointer to IV */
  1196. CK_ULONG ulIvLen; /* length of IV in bytes */
  1197. } CK_RC5_CBC_PARAMS;
  1198. typedef CK_RC5_CBC_PARAMS CK_PTR CK_RC5_CBC_PARAMS_PTR;
  1199. /* CK_RC5_MAC_GENERAL_PARAMS provides the parameters for the
  1200. * CKM_RC5_MAC_GENERAL mechanism
  1201. */
  1202. typedef struct CK_RC5_MAC_GENERAL_PARAMS {
  1203. CK_ULONG ulWordsize; /* wordsize in bits */
  1204. CK_ULONG ulRounds; /* number of rounds */
  1205. CK_ULONG ulMacLength; /* Length of MAC in bytes */
  1206. } CK_RC5_MAC_GENERAL_PARAMS;
  1207. typedef CK_RC5_MAC_GENERAL_PARAMS CK_PTR \
  1208. CK_RC5_MAC_GENERAL_PARAMS_PTR;
  1209. /* CK_MAC_GENERAL_PARAMS provides the parameters to most block
  1210. * ciphers' MAC_GENERAL mechanisms. Its value is the length of
  1211. * the MAC
  1212. */
  1213. typedef CK_ULONG CK_MAC_GENERAL_PARAMS;
  1214. typedef CK_MAC_GENERAL_PARAMS CK_PTR CK_MAC_GENERAL_PARAMS_PTR;
  1215. typedef struct CK_DES_CBC_ENCRYPT_DATA_PARAMS {
  1216. CK_BYTE iv[8];
  1217. CK_BYTE_PTR pData;
  1218. CK_ULONG length;
  1219. } CK_DES_CBC_ENCRYPT_DATA_PARAMS;
  1220. typedef CK_DES_CBC_ENCRYPT_DATA_PARAMS CK_PTR CK_DES_CBC_ENCRYPT_DATA_PARAMS_PTR;
  1221. typedef struct CK_AES_CBC_ENCRYPT_DATA_PARAMS {
  1222. CK_BYTE iv[16];
  1223. CK_BYTE_PTR pData;
  1224. CK_ULONG length;
  1225. } CK_AES_CBC_ENCRYPT_DATA_PARAMS;
  1226. typedef CK_AES_CBC_ENCRYPT_DATA_PARAMS CK_PTR CK_AES_CBC_ENCRYPT_DATA_PARAMS_PTR;
  1227. /* CK_SKIPJACK_PRIVATE_WRAP_PARAMS provides the parameters to the
  1228. * CKM_SKIPJACK_PRIVATE_WRAP mechanism
  1229. */
  1230. typedef struct CK_SKIPJACK_PRIVATE_WRAP_PARAMS {
  1231. CK_ULONG ulPasswordLen;
  1232. CK_BYTE_PTR pPassword;
  1233. CK_ULONG ulPublicDataLen;
  1234. CK_BYTE_PTR pPublicData;
  1235. CK_ULONG ulPAndGLen;
  1236. CK_ULONG ulQLen;
  1237. CK_ULONG ulRandomLen;
  1238. CK_BYTE_PTR pRandomA;
  1239. CK_BYTE_PTR pPrimeP;
  1240. CK_BYTE_PTR pBaseG;
  1241. CK_BYTE_PTR pSubprimeQ;
  1242. } CK_SKIPJACK_PRIVATE_WRAP_PARAMS;
  1243. typedef CK_SKIPJACK_PRIVATE_WRAP_PARAMS CK_PTR \
  1244. CK_SKIPJACK_PRIVATE_WRAP_PARAMS_PTR;
  1245. /* CK_SKIPJACK_RELAYX_PARAMS provides the parameters to the
  1246. * CKM_SKIPJACK_RELAYX mechanism
  1247. */
  1248. typedef struct CK_SKIPJACK_RELAYX_PARAMS {
  1249. CK_ULONG ulOldWrappedXLen;
  1250. CK_BYTE_PTR pOldWrappedX;
  1251. CK_ULONG ulOldPasswordLen;
  1252. CK_BYTE_PTR pOldPassword;
  1253. CK_ULONG ulOldPublicDataLen;
  1254. CK_BYTE_PTR pOldPublicData;
  1255. CK_ULONG ulOldRandomLen;
  1256. CK_BYTE_PTR pOldRandomA;
  1257. CK_ULONG ulNewPasswordLen;
  1258. CK_BYTE_PTR pNewPassword;
  1259. CK_ULONG ulNewPublicDataLen;
  1260. CK_BYTE_PTR pNewPublicData;
  1261. CK_ULONG ulNewRandomLen;
  1262. CK_BYTE_PTR pNewRandomA;
  1263. } CK_SKIPJACK_RELAYX_PARAMS;
  1264. typedef CK_SKIPJACK_RELAYX_PARAMS CK_PTR \
  1265. CK_SKIPJACK_RELAYX_PARAMS_PTR;
  1266. typedef struct CK_PBE_PARAMS {
  1267. CK_BYTE_PTR pInitVector;
  1268. CK_UTF8CHAR_PTR pPassword;
  1269. CK_ULONG ulPasswordLen;
  1270. CK_BYTE_PTR pSalt;
  1271. CK_ULONG ulSaltLen;
  1272. CK_ULONG ulIteration;
  1273. } CK_PBE_PARAMS;
  1274. typedef CK_PBE_PARAMS CK_PTR CK_PBE_PARAMS_PTR;
  1275. /* CK_KEY_WRAP_SET_OAEP_PARAMS provides the parameters to the
  1276. * CKM_KEY_WRAP_SET_OAEP mechanism
  1277. */
  1278. typedef struct CK_KEY_WRAP_SET_OAEP_PARAMS {
  1279. CK_BYTE bBC; /* block contents byte */
  1280. CK_BYTE_PTR pX; /* extra data */
  1281. CK_ULONG ulXLen; /* length of extra data in bytes */
  1282. } CK_KEY_WRAP_SET_OAEP_PARAMS;
  1283. typedef CK_KEY_WRAP_SET_OAEP_PARAMS CK_PTR CK_KEY_WRAP_SET_OAEP_PARAMS_PTR;
  1284. typedef struct CK_SSL3_RANDOM_DATA {
  1285. CK_BYTE_PTR pClientRandom;
  1286. CK_ULONG ulClientRandomLen;
  1287. CK_BYTE_PTR pServerRandom;
  1288. CK_ULONG ulServerRandomLen;
  1289. } CK_SSL3_RANDOM_DATA;
  1290. typedef struct CK_SSL3_MASTER_KEY_DERIVE_PARAMS {
  1291. CK_SSL3_RANDOM_DATA RandomInfo;
  1292. CK_VERSION_PTR pVersion;
  1293. } CK_SSL3_MASTER_KEY_DERIVE_PARAMS;
  1294. typedef struct CK_SSL3_MASTER_KEY_DERIVE_PARAMS CK_PTR \
  1295. CK_SSL3_MASTER_KEY_DERIVE_PARAMS_PTR;
  1296. typedef struct CK_SSL3_KEY_MAT_OUT {
  1297. CK_OBJECT_HANDLE hClientMacSecret;
  1298. CK_OBJECT_HANDLE hServerMacSecret;
  1299. CK_OBJECT_HANDLE hClientKey;
  1300. CK_OBJECT_HANDLE hServerKey;
  1301. CK_BYTE_PTR pIVClient;
  1302. CK_BYTE_PTR pIVServer;
  1303. } CK_SSL3_KEY_MAT_OUT;
  1304. typedef CK_SSL3_KEY_MAT_OUT CK_PTR CK_SSL3_KEY_MAT_OUT_PTR;
  1305. typedef struct CK_SSL3_KEY_MAT_PARAMS {
  1306. CK_ULONG ulMacSizeInBits;
  1307. CK_ULONG ulKeySizeInBits;
  1308. CK_ULONG ulIVSizeInBits;
  1309. CK_BBOOL bIsExport;
  1310. CK_SSL3_RANDOM_DATA RandomInfo;
  1311. CK_SSL3_KEY_MAT_OUT_PTR pReturnedKeyMaterial;
  1312. } CK_SSL3_KEY_MAT_PARAMS;
  1313. typedef CK_SSL3_KEY_MAT_PARAMS CK_PTR CK_SSL3_KEY_MAT_PARAMS_PTR;
  1314. typedef struct CK_TLS_PRF_PARAMS {
  1315. CK_BYTE_PTR pSeed;
  1316. CK_ULONG ulSeedLen;
  1317. CK_BYTE_PTR pLabel;
  1318. CK_ULONG ulLabelLen;
  1319. CK_BYTE_PTR pOutput;
  1320. CK_ULONG_PTR pulOutputLen;
  1321. } CK_TLS_PRF_PARAMS;
  1322. typedef CK_TLS_PRF_PARAMS CK_PTR CK_TLS_PRF_PARAMS_PTR;
  1323. typedef struct CK_WTLS_RANDOM_DATA {
  1324. CK_BYTE_PTR pClientRandom;
  1325. CK_ULONG ulClientRandomLen;
  1326. CK_BYTE_PTR pServerRandom;
  1327. CK_ULONG ulServerRandomLen;
  1328. } CK_WTLS_RANDOM_DATA;
  1329. typedef CK_WTLS_RANDOM_DATA CK_PTR CK_WTLS_RANDOM_DATA_PTR;
  1330. typedef struct CK_WTLS_MASTER_KEY_DERIVE_PARAMS {
  1331. CK_MECHANISM_TYPE DigestMechanism;
  1332. CK_WTLS_RANDOM_DATA RandomInfo;
  1333. CK_BYTE_PTR pVersion;
  1334. } CK_WTLS_MASTER_KEY_DERIVE_PARAMS;
  1335. typedef CK_WTLS_MASTER_KEY_DERIVE_PARAMS CK_PTR \
  1336. CK_WTLS_MASTER_KEY_DERIVE_PARAMS_PTR;
  1337. typedef struct CK_WTLS_PRF_PARAMS {
  1338. CK_MECHANISM_TYPE DigestMechanism;
  1339. CK_BYTE_PTR pSeed;
  1340. CK_ULONG ulSeedLen;
  1341. CK_BYTE_PTR pLabel;
  1342. CK_ULONG ulLabelLen;
  1343. CK_BYTE_PTR pOutput;
  1344. CK_ULONG_PTR pulOutputLen;
  1345. } CK_WTLS_PRF_PARAMS;
  1346. typedef CK_WTLS_PRF_PARAMS CK_PTR CK_WTLS_PRF_PARAMS_PTR;
  1347. typedef struct CK_WTLS_KEY_MAT_OUT {
  1348. CK_OBJECT_HANDLE hMacSecret;
  1349. CK_OBJECT_HANDLE hKey;
  1350. CK_BYTE_PTR pIV;
  1351. } CK_WTLS_KEY_MAT_OUT;
  1352. typedef CK_WTLS_KEY_MAT_OUT CK_PTR CK_WTLS_KEY_MAT_OUT_PTR;
  1353. typedef struct CK_WTLS_KEY_MAT_PARAMS {
  1354. CK_MECHANISM_TYPE DigestMechanism;
  1355. CK_ULONG ulMacSizeInBits;
  1356. CK_ULONG ulKeySizeInBits;
  1357. CK_ULONG ulIVSizeInBits;
  1358. CK_ULONG ulSequenceNumber;
  1359. CK_BBOOL bIsExport;
  1360. CK_WTLS_RANDOM_DATA RandomInfo;
  1361. CK_WTLS_KEY_MAT_OUT_PTR pReturnedKeyMaterial;
  1362. } CK_WTLS_KEY_MAT_PARAMS;
  1363. typedef CK_WTLS_KEY_MAT_PARAMS CK_PTR CK_WTLS_KEY_MAT_PARAMS_PTR;
  1364. typedef struct CK_CMS_SIG_PARAMS {
  1365. CK_OBJECT_HANDLE certificateHandle;
  1366. CK_MECHANISM_PTR pSigningMechanism;
  1367. CK_MECHANISM_PTR pDigestMechanism;
  1368. CK_UTF8CHAR_PTR pContentType;
  1369. CK_BYTE_PTR pRequestedAttributes;
  1370. CK_ULONG ulRequestedAttributesLen;
  1371. CK_BYTE_PTR pRequiredAttributes;
  1372. CK_ULONG ulRequiredAttributesLen;
  1373. } CK_CMS_SIG_PARAMS;
  1374. typedef CK_CMS_SIG_PARAMS CK_PTR CK_CMS_SIG_PARAMS_PTR;
  1375. typedef struct CK_KEY_DERIVATION_STRING_DATA {
  1376. CK_BYTE_PTR pData;
  1377. CK_ULONG ulLen;
  1378. } CK_KEY_DERIVATION_STRING_DATA;
  1379. typedef CK_KEY_DERIVATION_STRING_DATA CK_PTR \
  1380. CK_KEY_DERIVATION_STRING_DATA_PTR;
  1381. /* The CK_EXTRACT_PARAMS is used for the
  1382. * CKM_EXTRACT_KEY_FROM_KEY mechanism. It specifies which bit
  1383. * of the base key should be used as the first bit of the
  1384. * derived key
  1385. */
  1386. typedef CK_ULONG CK_EXTRACT_PARAMS;
  1387. typedef CK_EXTRACT_PARAMS CK_PTR CK_EXTRACT_PARAMS_PTR;
  1388. /* CK_PKCS5_PBKD2_PSEUDO_RANDOM_FUNCTION_TYPE is used to
  1389. * indicate the Pseudo-Random Function (PRF) used to generate
  1390. * key bits using PKCS #5 PBKDF2.
  1391. */
  1392. typedef CK_ULONG CK_PKCS5_PBKD2_PSEUDO_RANDOM_FUNCTION_TYPE;
  1393. typedef CK_PKCS5_PBKD2_PSEUDO_RANDOM_FUNCTION_TYPE CK_PTR \
  1394. CK_PKCS5_PBKD2_PSEUDO_RANDOM_FUNCTION_TYPE_PTR;
  1395. #define CKP_PKCS5_PBKD2_HMAC_SHA1 0x00000001UL
  1396. #define CKP_PKCS5_PBKD2_HMAC_GOSTR3411 0x00000002UL
  1397. #define CKP_PKCS5_PBKD2_HMAC_SHA224 0x00000003UL
  1398. #define CKP_PKCS5_PBKD2_HMAC_SHA256 0x00000004UL
  1399. #define CKP_PKCS5_PBKD2_HMAC_SHA384 0x00000005UL
  1400. #define CKP_PKCS5_PBKD2_HMAC_SHA512 0x00000006UL
  1401. #define CKP_PKCS5_PBKD2_HMAC_SHA512_224 0x00000007UL
  1402. #define CKP_PKCS5_PBKD2_HMAC_SHA512_256 0x00000008UL
  1403. /* CK_PKCS5_PBKDF2_SALT_SOURCE_TYPE is used to indicate the
  1404. * source of the salt value when deriving a key using PKCS #5
  1405. * PBKDF2.
  1406. */
  1407. typedef CK_ULONG CK_PKCS5_PBKDF2_SALT_SOURCE_TYPE;
  1408. typedef CK_PKCS5_PBKDF2_SALT_SOURCE_TYPE CK_PTR \
  1409. CK_PKCS5_PBKDF2_SALT_SOURCE_TYPE_PTR;
  1410. /* The following salt value sources are defined in PKCS #5 v2.0. */
  1411. #define CKZ_SALT_SPECIFIED 0x00000001UL
  1412. /* CK_PKCS5_PBKD2_PARAMS is a structure that provides the
  1413. * parameters to the CKM_PKCS5_PBKD2 mechanism.
  1414. */
  1415. typedef struct CK_PKCS5_PBKD2_PARAMS {
  1416. CK_PKCS5_PBKDF2_SALT_SOURCE_TYPE saltSource;
  1417. CK_VOID_PTR pSaltSourceData;
  1418. CK_ULONG ulSaltSourceDataLen;
  1419. CK_ULONG iterations;
  1420. CK_PKCS5_PBKD2_PSEUDO_RANDOM_FUNCTION_TYPE prf;
  1421. CK_VOID_PTR pPrfData;
  1422. CK_ULONG ulPrfDataLen;
  1423. CK_UTF8CHAR_PTR pPassword;
  1424. CK_ULONG_PTR ulPasswordLen;
  1425. } CK_PKCS5_PBKD2_PARAMS;
  1426. typedef CK_PKCS5_PBKD2_PARAMS CK_PTR CK_PKCS5_PBKD2_PARAMS_PTR;
  1427. /* CK_PKCS5_PBKD2_PARAMS2 is a corrected version of the CK_PKCS5_PBKD2_PARAMS
  1428. * structure that provides the parameters to the CKM_PKCS5_PBKD2 mechanism
  1429. * noting that the ulPasswordLen field is a CK_ULONG and not a CK_ULONG_PTR.
  1430. */
  1431. typedef struct CK_PKCS5_PBKD2_PARAMS2 {
  1432. CK_PKCS5_PBKDF2_SALT_SOURCE_TYPE saltSource;
  1433. CK_VOID_PTR pSaltSourceData;
  1434. CK_ULONG ulSaltSourceDataLen;
  1435. CK_ULONG iterations;
  1436. CK_PKCS5_PBKD2_PSEUDO_RANDOM_FUNCTION_TYPE prf;
  1437. CK_VOID_PTR pPrfData;
  1438. CK_ULONG ulPrfDataLen;
  1439. CK_UTF8CHAR_PTR pPassword;
  1440. CK_ULONG ulPasswordLen;
  1441. } CK_PKCS5_PBKD2_PARAMS2;
  1442. typedef CK_PKCS5_PBKD2_PARAMS2 CK_PTR CK_PKCS5_PBKD2_PARAMS2_PTR;
  1443. typedef CK_ULONG CK_OTP_PARAM_TYPE;
  1444. typedef CK_OTP_PARAM_TYPE CK_PARAM_TYPE; /* backward compatibility */
  1445. typedef struct CK_OTP_PARAM {
  1446. CK_OTP_PARAM_TYPE type;
  1447. CK_VOID_PTR pValue;
  1448. CK_ULONG ulValueLen;
  1449. } CK_OTP_PARAM;
  1450. typedef CK_OTP_PARAM CK_PTR CK_OTP_PARAM_PTR;
  1451. typedef struct CK_OTP_PARAMS {
  1452. CK_OTP_PARAM_PTR pParams;
  1453. CK_ULONG ulCount;
  1454. } CK_OTP_PARAMS;
  1455. typedef CK_OTP_PARAMS CK_PTR CK_OTP_PARAMS_PTR;
  1456. typedef struct CK_OTP_SIGNATURE_INFO {
  1457. CK_OTP_PARAM_PTR pParams;
  1458. CK_ULONG ulCount;
  1459. } CK_OTP_SIGNATURE_INFO;
  1460. typedef CK_OTP_SIGNATURE_INFO CK_PTR CK_OTP_SIGNATURE_INFO_PTR;
  1461. #define CK_OTP_VALUE 0UL
  1462. #define CK_OTP_PIN 1UL
  1463. #define CK_OTP_CHALLENGE 2UL
  1464. #define CK_OTP_TIME 3UL
  1465. #define CK_OTP_COUNTER 4UL
  1466. #define CK_OTP_FLAGS 5UL
  1467. #define CK_OTP_OUTPUT_LENGTH 6UL
  1468. #define CK_OTP_OUTPUT_FORMAT 7UL
  1469. #define CKF_NEXT_OTP 0x00000001UL
  1470. #define CKF_EXCLUDE_TIME 0x00000002UL
  1471. #define CKF_EXCLUDE_COUNTER 0x00000004UL
  1472. #define CKF_EXCLUDE_CHALLENGE 0x00000008UL
  1473. #define CKF_EXCLUDE_PIN 0x00000010UL
  1474. #define CKF_USER_FRIENDLY_OTP 0x00000020UL
  1475. typedef struct CK_KIP_PARAMS {
  1476. CK_MECHANISM_PTR pMechanism;
  1477. CK_OBJECT_HANDLE hKey;
  1478. CK_BYTE_PTR pSeed;
  1479. CK_ULONG ulSeedLen;
  1480. } CK_KIP_PARAMS;
  1481. typedef CK_KIP_PARAMS CK_PTR CK_KIP_PARAMS_PTR;
  1482. typedef struct CK_AES_CTR_PARAMS {
  1483. CK_ULONG ulCounterBits;
  1484. CK_BYTE cb[16];
  1485. } CK_AES_CTR_PARAMS;
  1486. typedef CK_AES_CTR_PARAMS CK_PTR CK_AES_CTR_PARAMS_PTR;
  1487. typedef struct CK_GCM_PARAMS {
  1488. CK_BYTE_PTR pIv;
  1489. CK_ULONG ulIvLen;
  1490. CK_ULONG ulIvBits;
  1491. CK_BYTE_PTR pAAD;
  1492. CK_ULONG ulAADLen;
  1493. CK_ULONG ulTagBits;
  1494. } CK_GCM_PARAMS;
  1495. typedef CK_GCM_PARAMS CK_PTR CK_GCM_PARAMS_PTR;
  1496. typedef struct CK_CCM_PARAMS {
  1497. CK_ULONG ulDataLen;
  1498. CK_BYTE_PTR pNonce;
  1499. CK_ULONG ulNonceLen;
  1500. CK_BYTE_PTR pAAD;
  1501. CK_ULONG ulAADLen;
  1502. CK_ULONG ulMACLen;
  1503. } CK_CCM_PARAMS;
  1504. typedef CK_CCM_PARAMS CK_PTR CK_CCM_PARAMS_PTR;
  1505. /* Deprecated. Use CK_GCM_PARAMS */
  1506. typedef struct CK_AES_GCM_PARAMS {
  1507. CK_BYTE_PTR pIv;
  1508. CK_ULONG ulIvLen;
  1509. CK_ULONG ulIvBits;
  1510. CK_BYTE_PTR pAAD;
  1511. CK_ULONG ulAADLen;
  1512. CK_ULONG ulTagBits;
  1513. } CK_AES_GCM_PARAMS;
  1514. typedef CK_AES_GCM_PARAMS CK_PTR CK_AES_GCM_PARAMS_PTR;
  1515. /* Deprecated. Use CK_CCM_PARAMS */
  1516. typedef struct CK_AES_CCM_PARAMS {
  1517. CK_ULONG ulDataLen;
  1518. CK_BYTE_PTR pNonce;
  1519. CK_ULONG ulNonceLen;
  1520. CK_BYTE_PTR pAAD;
  1521. CK_ULONG ulAADLen;
  1522. CK_ULONG ulMACLen;
  1523. } CK_AES_CCM_PARAMS;
  1524. typedef CK_AES_CCM_PARAMS CK_PTR CK_AES_CCM_PARAMS_PTR;
  1525. typedef struct CK_CAMELLIA_CTR_PARAMS {
  1526. CK_ULONG ulCounterBits;
  1527. CK_BYTE cb[16];
  1528. } CK_CAMELLIA_CTR_PARAMS;
  1529. typedef CK_CAMELLIA_CTR_PARAMS CK_PTR CK_CAMELLIA_CTR_PARAMS_PTR;
  1530. typedef struct CK_CAMELLIA_CBC_ENCRYPT_DATA_PARAMS {
  1531. CK_BYTE iv[16];
  1532. CK_BYTE_PTR pData;
  1533. CK_ULONG length;
  1534. } CK_CAMELLIA_CBC_ENCRYPT_DATA_PARAMS;
  1535. typedef CK_CAMELLIA_CBC_ENCRYPT_DATA_PARAMS CK_PTR \
  1536. CK_CAMELLIA_CBC_ENCRYPT_DATA_PARAMS_PTR;
  1537. typedef struct CK_ARIA_CBC_ENCRYPT_DATA_PARAMS {
  1538. CK_BYTE iv[16];
  1539. CK_BYTE_PTR pData;
  1540. CK_ULONG length;
  1541. } CK_ARIA_CBC_ENCRYPT_DATA_PARAMS;
  1542. typedef CK_ARIA_CBC_ENCRYPT_DATA_PARAMS CK_PTR \
  1543. CK_ARIA_CBC_ENCRYPT_DATA_PARAMS_PTR;
  1544. typedef struct CK_DSA_PARAMETER_GEN_PARAM {
  1545. CK_MECHANISM_TYPE hash;
  1546. CK_BYTE_PTR pSeed;
  1547. CK_ULONG ulSeedLen;
  1548. CK_ULONG ulIndex;
  1549. } CK_DSA_PARAMETER_GEN_PARAM;
  1550. typedef CK_DSA_PARAMETER_GEN_PARAM CK_PTR CK_DSA_PARAMETER_GEN_PARAM_PTR;
  1551. typedef struct CK_ECDH_AES_KEY_WRAP_PARAMS {
  1552. CK_ULONG ulAESKeyBits;
  1553. CK_EC_KDF_TYPE kdf;
  1554. CK_ULONG ulSharedDataLen;
  1555. CK_BYTE_PTR pSharedData;
  1556. } CK_ECDH_AES_KEY_WRAP_PARAMS;
  1557. typedef CK_ECDH_AES_KEY_WRAP_PARAMS CK_PTR CK_ECDH_AES_KEY_WRAP_PARAMS_PTR;
  1558. typedef CK_ULONG CK_JAVA_MIDP_SECURITY_DOMAIN;
  1559. typedef CK_ULONG CK_CERTIFICATE_CATEGORY;
  1560. typedef struct CK_RSA_AES_KEY_WRAP_PARAMS {
  1561. CK_ULONG ulAESKeyBits;
  1562. CK_RSA_PKCS_OAEP_PARAMS_PTR pOAEPParams;
  1563. } CK_RSA_AES_KEY_WRAP_PARAMS;
  1564. typedef CK_RSA_AES_KEY_WRAP_PARAMS CK_PTR CK_RSA_AES_KEY_WRAP_PARAMS_PTR;
  1565. typedef struct CK_TLS12_MASTER_KEY_DERIVE_PARAMS {
  1566. CK_SSL3_RANDOM_DATA RandomInfo;
  1567. CK_VERSION_PTR pVersion;
  1568. CK_MECHANISM_TYPE prfHashMechanism;
  1569. } CK_TLS12_MASTER_KEY_DERIVE_PARAMS;
  1570. typedef CK_TLS12_MASTER_KEY_DERIVE_PARAMS CK_PTR \
  1571. CK_TLS12_MASTER_KEY_DERIVE_PARAMS_PTR;
  1572. typedef struct CK_TLS12_KEY_MAT_PARAMS {
  1573. CK_ULONG ulMacSizeInBits;
  1574. CK_ULONG ulKeySizeInBits;
  1575. CK_ULONG ulIVSizeInBits;
  1576. CK_BBOOL bIsExport;
  1577. CK_SSL3_RANDOM_DATA RandomInfo;
  1578. CK_SSL3_KEY_MAT_OUT_PTR pReturnedKeyMaterial;
  1579. CK_MECHANISM_TYPE prfHashMechanism;
  1580. } CK_TLS12_KEY_MAT_PARAMS;
  1581. typedef CK_TLS12_KEY_MAT_PARAMS CK_PTR CK_TLS12_KEY_MAT_PARAMS_PTR;
  1582. typedef struct CK_TLS_KDF_PARAMS {
  1583. CK_MECHANISM_TYPE prfMechanism;
  1584. CK_BYTE_PTR pLabel;
  1585. CK_ULONG ulLabelLength;
  1586. CK_SSL3_RANDOM_DATA RandomInfo;
  1587. CK_BYTE_PTR pContextData;
  1588. CK_ULONG ulContextDataLength;
  1589. } CK_TLS_KDF_PARAMS;
  1590. typedef CK_TLS_KDF_PARAMS CK_PTR CK_TLS_KDF_PARAMS_PTR;
  1591. typedef struct CK_TLS_MAC_PARAMS {
  1592. CK_MECHANISM_TYPE prfHashMechanism;
  1593. CK_ULONG ulMacLength;
  1594. CK_ULONG ulServerOrClient;
  1595. } CK_TLS_MAC_PARAMS;
  1596. typedef CK_TLS_MAC_PARAMS CK_PTR CK_TLS_MAC_PARAMS_PTR;
  1597. typedef struct CK_GOSTR3410_DERIVE_PARAMS {
  1598. CK_EC_KDF_TYPE kdf;
  1599. CK_BYTE_PTR pPublicData;
  1600. CK_ULONG ulPublicDataLen;
  1601. CK_BYTE_PTR pUKM;
  1602. CK_ULONG ulUKMLen;
  1603. } CK_GOSTR3410_DERIVE_PARAMS;
  1604. typedef CK_GOSTR3410_DERIVE_PARAMS CK_PTR CK_GOSTR3410_DERIVE_PARAMS_PTR;
  1605. typedef struct CK_GOSTR3410_KEY_WRAP_PARAMS {
  1606. CK_BYTE_PTR pWrapOID;
  1607. CK_ULONG ulWrapOIDLen;
  1608. CK_BYTE_PTR pUKM;
  1609. CK_ULONG ulUKMLen;
  1610. CK_OBJECT_HANDLE hKey;
  1611. } CK_GOSTR3410_KEY_WRAP_PARAMS;
  1612. typedef CK_GOSTR3410_KEY_WRAP_PARAMS CK_PTR CK_GOSTR3410_KEY_WRAP_PARAMS_PTR;
  1613. typedef struct CK_SEED_CBC_ENCRYPT_DATA_PARAMS {
  1614. CK_BYTE iv[16];
  1615. CK_BYTE_PTR pData;
  1616. CK_ULONG length;
  1617. } CK_SEED_CBC_ENCRYPT_DATA_PARAMS;
  1618. typedef CK_SEED_CBC_ENCRYPT_DATA_PARAMS CK_PTR \
  1619. CK_SEED_CBC_ENCRYPT_DATA_PARAMS_PTR;
  1620. #endif /* _PKCS11T_H_ */