|
1 /* This Source Code Form is subject to the terms of the Mozilla Public |
|
2 * License, v. 2.0. If a copy of the MPL was not distributed with this |
|
3 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
|
4 |
|
5 #ifndef NSSCKFW_H |
|
6 #define NSSCKFW_H |
|
7 |
|
8 /* |
|
9 * nssckfw.h |
|
10 * |
|
11 * This file prototypes the publicly available calls of the |
|
12 * NSS Cryptoki Framework. |
|
13 */ |
|
14 |
|
15 #ifndef NSSBASET_H |
|
16 #include "nssbaset.h" |
|
17 #endif /* NSSBASET_H */ |
|
18 |
|
19 #ifndef NSSCKT_H |
|
20 #include "nssckt.h" |
|
21 #endif /* NSSCKT_H */ |
|
22 |
|
23 #ifndef NSSCKFWT_H |
|
24 #include "nssckfwt.h" |
|
25 #endif /* NSSCKFWT_H */ |
|
26 |
|
27 /* |
|
28 * NSSCKFWInstance |
|
29 * |
|
30 * NSSCKFWInstance_GetMDInstance |
|
31 * NSSCKFWInstance_GetArena |
|
32 * NSSCKFWInstance_MayCreatePthreads |
|
33 * NSSCKFWInstance_CreateMutex |
|
34 * NSSCKFWInstance_GetConfigurationData |
|
35 */ |
|
36 |
|
37 /* |
|
38 * NSSCKFWInstance_GetMDInstance |
|
39 * |
|
40 */ |
|
41 |
|
42 NSS_EXTERN NSSCKMDInstance * |
|
43 NSSCKFWInstance_GetMDInstance |
|
44 ( |
|
45 NSSCKFWInstance *fwInstance |
|
46 ); |
|
47 |
|
48 /* |
|
49 * NSSCKFWInstance_GetArena |
|
50 * |
|
51 */ |
|
52 |
|
53 NSS_EXTERN NSSArena * |
|
54 NSSCKFWInstance_GetArena |
|
55 ( |
|
56 NSSCKFWInstance *fwInstance, |
|
57 CK_RV *pError |
|
58 ); |
|
59 |
|
60 /* |
|
61 * NSSCKFWInstance_MayCreatePthreads |
|
62 * |
|
63 */ |
|
64 |
|
65 NSS_EXTERN CK_BBOOL |
|
66 NSSCKFWInstance_MayCreatePthreads |
|
67 ( |
|
68 NSSCKFWInstance *fwInstance |
|
69 ); |
|
70 |
|
71 /* |
|
72 * NSSCKFWInstance_CreateMutex |
|
73 * |
|
74 */ |
|
75 |
|
76 NSS_EXTERN NSSCKFWMutex * |
|
77 NSSCKFWInstance_CreateMutex |
|
78 ( |
|
79 NSSCKFWInstance *fwInstance, |
|
80 NSSArena *arena, |
|
81 CK_RV *pError |
|
82 ); |
|
83 |
|
84 /* |
|
85 * NSSCKFWInstance_GetConfigurationData |
|
86 * |
|
87 */ |
|
88 |
|
89 NSS_EXTERN NSSUTF8 * |
|
90 NSSCKFWInstance_GetConfigurationData |
|
91 ( |
|
92 NSSCKFWInstance *fwInstance |
|
93 ); |
|
94 |
|
95 /* |
|
96 * NSSCKFWInstance_GetInitArgs |
|
97 * |
|
98 */ |
|
99 |
|
100 NSS_EXTERN CK_C_INITIALIZE_ARGS_PTR |
|
101 NSSCKFWInstance_GetInitArgs |
|
102 ( |
|
103 NSSCKFWInstance *fwInstance |
|
104 ); |
|
105 |
|
106 /* |
|
107 * NSSCKFWSlot |
|
108 * |
|
109 * NSSCKFWSlot_GetMDSlot |
|
110 * NSSCKFWSlot_GetFWInstance |
|
111 * NSSCKFWSlot_GetMDInstance |
|
112 * |
|
113 */ |
|
114 |
|
115 /* |
|
116 * NSSCKFWSlot_GetMDSlot |
|
117 * |
|
118 */ |
|
119 |
|
120 NSS_EXTERN NSSCKMDSlot * |
|
121 NSSCKFWSlot_GetMDSlot |
|
122 ( |
|
123 NSSCKFWSlot *fwSlot |
|
124 ); |
|
125 |
|
126 /* |
|
127 * NSSCKFWSlot_GetFWInstance |
|
128 * |
|
129 */ |
|
130 |
|
131 NSS_EXTERN NSSCKFWInstance * |
|
132 NSSCKFWSlot_GetFWInstance |
|
133 ( |
|
134 NSSCKFWSlot *fwSlot |
|
135 ); |
|
136 |
|
137 /* |
|
138 * NSSCKFWSlot_GetMDInstance |
|
139 * |
|
140 */ |
|
141 |
|
142 NSS_EXTERN NSSCKMDInstance * |
|
143 NSSCKFWSlot_GetMDInstance |
|
144 ( |
|
145 NSSCKFWSlot *fwSlot |
|
146 ); |
|
147 |
|
148 /* |
|
149 * NSSCKFWToken |
|
150 * |
|
151 * NSSCKFWToken_GetMDToken |
|
152 * NSSCKFWToken_GetFWSlot |
|
153 * NSSCKFWToken_GetMDSlot |
|
154 * NSSCKFWToken_GetSessionState |
|
155 * |
|
156 */ |
|
157 |
|
158 /* |
|
159 * NSSCKFWToken_GetMDToken |
|
160 * |
|
161 */ |
|
162 |
|
163 NSS_EXTERN NSSCKMDToken * |
|
164 NSSCKFWToken_GetMDToken |
|
165 ( |
|
166 NSSCKFWToken *fwToken |
|
167 ); |
|
168 |
|
169 /* |
|
170 * NSSCKFWToken_GetArena |
|
171 * |
|
172 */ |
|
173 |
|
174 NSS_EXTERN NSSArena * |
|
175 NSSCKFWToken_GetArena |
|
176 ( |
|
177 NSSCKFWToken *fwToken, |
|
178 CK_RV *pError |
|
179 ); |
|
180 |
|
181 /* |
|
182 * NSSCKFWToken_GetFWSlot |
|
183 * |
|
184 */ |
|
185 |
|
186 NSS_EXTERN NSSCKFWSlot * |
|
187 NSSCKFWToken_GetFWSlot |
|
188 ( |
|
189 NSSCKFWToken *fwToken |
|
190 ); |
|
191 |
|
192 /* |
|
193 * NSSCKFWToken_GetMDSlot |
|
194 * |
|
195 */ |
|
196 |
|
197 NSS_EXTERN NSSCKMDSlot * |
|
198 NSSCKFWToken_GetMDSlot |
|
199 ( |
|
200 NSSCKFWToken *fwToken |
|
201 ); |
|
202 |
|
203 /* |
|
204 * NSSCKFWToken_GetSessionState |
|
205 * |
|
206 */ |
|
207 |
|
208 NSS_EXTERN CK_STATE |
|
209 NSSCKFWToken_GetSessionState |
|
210 ( |
|
211 NSSCKFWToken *fwToken |
|
212 ); |
|
213 |
|
214 /* |
|
215 * NSSCKFWMechanism |
|
216 * |
|
217 * NSSKCFWMechanism_GetMDMechanism |
|
218 * NSSCKFWMechanism_GetParameter |
|
219 * |
|
220 */ |
|
221 |
|
222 /* |
|
223 * NSSKCFWMechanism_GetMDMechanism |
|
224 * |
|
225 */ |
|
226 |
|
227 NSS_EXTERN NSSCKMDMechanism * |
|
228 NSSCKFWMechanism_GetMDMechanism |
|
229 ( |
|
230 NSSCKFWMechanism *fwMechanism |
|
231 ); |
|
232 |
|
233 /* |
|
234 * NSSCKFWMechanism_GetParameter |
|
235 * |
|
236 */ |
|
237 |
|
238 NSS_EXTERN NSSItem * |
|
239 NSSCKFWMechanism_GetParameter |
|
240 ( |
|
241 NSSCKFWMechanism *fwMechanism |
|
242 ); |
|
243 |
|
244 /* |
|
245 * NSSCKFWSession |
|
246 * |
|
247 * NSSCKFWSession_GetMDSession |
|
248 * NSSCKFWSession_GetArena |
|
249 * NSSCKFWSession_CallNotification |
|
250 * NSSCKFWSession_IsRWSession |
|
251 * NSSCKFWSession_IsSO |
|
252 * NSSCKFWSession_GetCurrentCryptoOperation |
|
253 * |
|
254 */ |
|
255 |
|
256 /* |
|
257 * NSSCKFWSession_GetMDSession |
|
258 * |
|
259 */ |
|
260 |
|
261 NSS_EXTERN NSSCKMDSession * |
|
262 NSSCKFWSession_GetMDSession |
|
263 ( |
|
264 NSSCKFWSession *fwSession |
|
265 ); |
|
266 |
|
267 /* |
|
268 * NSSCKFWSession_GetArena |
|
269 * |
|
270 */ |
|
271 |
|
272 NSS_EXTERN NSSArena * |
|
273 NSSCKFWSession_GetArena |
|
274 ( |
|
275 NSSCKFWSession *fwSession, |
|
276 CK_RV *pError |
|
277 ); |
|
278 |
|
279 /* |
|
280 * NSSCKFWSession_CallNotification |
|
281 * |
|
282 */ |
|
283 |
|
284 NSS_EXTERN CK_RV |
|
285 NSSCKFWSession_CallNotification |
|
286 ( |
|
287 NSSCKFWSession *fwSession, |
|
288 CK_NOTIFICATION event |
|
289 ); |
|
290 |
|
291 /* |
|
292 * NSSCKFWSession_IsRWSession |
|
293 * |
|
294 */ |
|
295 |
|
296 NSS_EXTERN CK_BBOOL |
|
297 NSSCKFWSession_IsRWSession |
|
298 ( |
|
299 NSSCKFWSession *fwSession |
|
300 ); |
|
301 |
|
302 /* |
|
303 * NSSCKFWSession_IsSO |
|
304 * |
|
305 */ |
|
306 |
|
307 NSS_EXTERN CK_BBOOL |
|
308 NSSCKFWSession_IsSO |
|
309 ( |
|
310 NSSCKFWSession *fwSession |
|
311 ); |
|
312 |
|
313 /* |
|
314 * NSSCKFWSession_GetCurrentCryptoOperation |
|
315 * |
|
316 */ |
|
317 |
|
318 NSS_EXTERN NSSCKFWCryptoOperation * |
|
319 NSSCKFWSession_GetCurrentCryptoOperation |
|
320 ( |
|
321 NSSCKFWSession *fwSession, |
|
322 NSSCKFWCryptoOperationState state |
|
323 ); |
|
324 |
|
325 /* |
|
326 * NSSCKFWObject |
|
327 * |
|
328 * NSSCKFWObject_GetMDObject |
|
329 * NSSCKFWObject_GetArena |
|
330 * NSSCKFWObject_IsTokenObject |
|
331 * NSSCKFWObject_GetAttributeCount |
|
332 * NSSCKFWObject_GetAttributeTypes |
|
333 * NSSCKFWObject_GetAttributeSize |
|
334 * NSSCKFWObject_GetAttribute |
|
335 * NSSCKFWObject_GetObjectSize |
|
336 */ |
|
337 |
|
338 /* |
|
339 * NSSCKFWObject_GetMDObject |
|
340 * |
|
341 */ |
|
342 NSS_EXTERN NSSCKMDObject * |
|
343 NSSCKFWObject_GetMDObject |
|
344 ( |
|
345 NSSCKFWObject *fwObject |
|
346 ); |
|
347 |
|
348 /* |
|
349 * NSSCKFWObject_GetArena |
|
350 * |
|
351 */ |
|
352 NSS_EXTERN NSSArena * |
|
353 NSSCKFWObject_GetArena |
|
354 ( |
|
355 NSSCKFWObject *fwObject, |
|
356 CK_RV *pError |
|
357 ); |
|
358 |
|
359 /* |
|
360 * NSSCKFWObject_IsTokenObject |
|
361 * |
|
362 */ |
|
363 NSS_EXTERN CK_BBOOL |
|
364 NSSCKFWObject_IsTokenObject |
|
365 ( |
|
366 NSSCKFWObject *fwObject |
|
367 ); |
|
368 |
|
369 /* |
|
370 * NSSCKFWObject_GetAttributeCount |
|
371 * |
|
372 */ |
|
373 NSS_EXTERN CK_ULONG |
|
374 NSSCKFWObject_GetAttributeCount |
|
375 ( |
|
376 NSSCKFWObject *fwObject, |
|
377 CK_RV *pError |
|
378 ); |
|
379 |
|
380 /* |
|
381 * NSSCKFWObject_GetAttributeTypes |
|
382 * |
|
383 */ |
|
384 NSS_EXTERN CK_RV |
|
385 NSSCKFWObject_GetAttributeTypes |
|
386 ( |
|
387 NSSCKFWObject *fwObject, |
|
388 CK_ATTRIBUTE_TYPE_PTR typeArray, |
|
389 CK_ULONG ulCount |
|
390 ); |
|
391 |
|
392 /* |
|
393 * NSSCKFWObject_GetAttributeSize |
|
394 * |
|
395 */ |
|
396 NSS_EXTERN CK_ULONG |
|
397 NSSCKFWObject_GetAttributeSize |
|
398 ( |
|
399 NSSCKFWObject *fwObject, |
|
400 CK_ATTRIBUTE_TYPE attribute, |
|
401 CK_RV *pError |
|
402 ); |
|
403 |
|
404 /* |
|
405 * NSSCKFWObject_GetAttribute |
|
406 * |
|
407 */ |
|
408 NSS_EXTERN NSSItem * |
|
409 NSSCKFWObject_GetAttribute |
|
410 ( |
|
411 NSSCKFWObject *fwObject, |
|
412 CK_ATTRIBUTE_TYPE attribute, |
|
413 NSSItem *itemOpt, |
|
414 NSSArena *arenaOpt, |
|
415 CK_RV *pError |
|
416 ); |
|
417 |
|
418 /* |
|
419 * NSSCKFWObject_GetObjectSize |
|
420 * |
|
421 */ |
|
422 NSS_EXTERN CK_ULONG |
|
423 NSSCKFWObject_GetObjectSize |
|
424 ( |
|
425 NSSCKFWObject *fwObject, |
|
426 CK_RV *pError |
|
427 ); |
|
428 |
|
429 /* |
|
430 * NSSCKFWFindObjects |
|
431 * |
|
432 * NSSCKFWFindObjects_GetMDFindObjects |
|
433 * |
|
434 */ |
|
435 |
|
436 /* |
|
437 * NSSCKFWFindObjects_GetMDFindObjects |
|
438 * |
|
439 */ |
|
440 |
|
441 NSS_EXTERN NSSCKMDFindObjects * |
|
442 NSSCKFWFindObjects_GetMDFindObjects |
|
443 ( |
|
444 NSSCKFWFindObjects * |
|
445 ); |
|
446 |
|
447 /* |
|
448 * NSSCKFWMutex |
|
449 * |
|
450 * NSSCKFWMutex_Destroy |
|
451 * NSSCKFWMutex_Lock |
|
452 * NSSCKFWMutex_Unlock |
|
453 * |
|
454 */ |
|
455 |
|
456 /* |
|
457 * NSSCKFWMutex_Destroy |
|
458 * |
|
459 */ |
|
460 |
|
461 NSS_EXTERN CK_RV |
|
462 NSSCKFWMutex_Destroy |
|
463 ( |
|
464 NSSCKFWMutex *mutex |
|
465 ); |
|
466 |
|
467 /* |
|
468 * NSSCKFWMutex_Lock |
|
469 * |
|
470 */ |
|
471 |
|
472 NSS_EXTERN CK_RV |
|
473 NSSCKFWMutex_Lock |
|
474 ( |
|
475 NSSCKFWMutex *mutex |
|
476 ); |
|
477 |
|
478 /* |
|
479 * NSSCKFWMutex_Unlock |
|
480 * |
|
481 */ |
|
482 |
|
483 NSS_EXTERN CK_RV |
|
484 NSSCKFWMutex_Unlock |
|
485 ( |
|
486 NSSCKFWMutex *mutex |
|
487 ); |
|
488 |
|
489 #endif /* NSSCKFW_H */ |
|
490 |