Debian Codegraph @

pkcs11/gkm/gkm-mock.h

raw
1 /*
2 * gnome-keyring
3 *
4 * Copyright (C) 2010 Stefan Walter
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU Lesser General Public License as
8 * published by the Free Software Foundation; either version 2.1 of
9 * the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this program; if not, see
18 * <http://www.gnu.org/licenses/>.
19 */
20
21 #include <glib.h>
22
23 #include "pkcs11/pkcs11.h"
24 #include "pkcs11/pkcs11i.h"
25
26 #ifndef GKM_MOCK_H
27 #define GKM_MOCK_H
28
29 CK_RV gkm_mock_C_Initialize (CK_VOID_PTR pInitArgs);
30
31 CK_RV gkm_mock_C_Finalize (CK_VOID_PTR pReserved);
32
33 CK_RV gkm_mock_C_GetInfo (CK_INFO_PTR pInfo);
34
35 CK_RV gkm_mock_C_GetFunctionList (CK_FUNCTION_LIST_PTR_PTR list);
36
37 CK_RV gkm_mock_C_GetSlotList (CK_BBOOL tokenPresent,
38 CK_SLOT_ID_PTR pSlotList,
39 CK_ULONG_PTR pulCount);
40
41 CK_RV gkm_mock_C_GetSlotInfo (CK_SLOT_ID slotID,
42 CK_SLOT_INFO_PTR pInfo);
43
44 CK_RV gkm_mock_C_GetTokenInfo (CK_SLOT_ID slotID,
45 CK_TOKEN_INFO_PTR pInfo);
46
47 CK_RV gkm_mock_fail_C_GetTokenInfo (CK_SLOT_ID slotID,
48 CK_TOKEN_INFO_PTR pInfo);
49
50 CK_RV gkm_mock_C_GetMechanismList (CK_SLOT_ID slotID,
51 CK_MECHANISM_TYPE_PTR pMechanismList,
52 CK_ULONG_PTR pulCount);
53
54 CK_RV gkm_mock_C_GetMechanismInfo (CK_SLOT_ID slotID,
55 CK_MECHANISM_TYPE type,
56 CK_MECHANISM_INFO_PTR pInfo);
57
58 CK_RV gkm_mock_C_InitToken (CK_SLOT_ID slotID,
59 CK_UTF8CHAR_PTR pPin,
60 CK_ULONG ulPinLen,
61 CK_UTF8CHAR_PTR pLabel);
62
63 CK_RV gkm_mock_unsupported_C_WaitForSlotEvent (CK_FLAGS flags,
64 CK_SLOT_ID_PTR pSlot,
65 CK_VOID_PTR pReserved);
66
67 CK_RV gkm_mock_C_OpenSession (CK_SLOT_ID slotID,
68 CK_FLAGS flags,
69 CK_VOID_PTR pApplication,
70 CK_NOTIFY Notify,
71 CK_SESSION_HANDLE_PTR phSession);
72
73 CK_RV gkm_mock_fail_C_OpenSession (CK_SLOT_ID slotID,
74 CK_FLAGS flags,
75 CK_VOID_PTR pApplication,
76 CK_NOTIFY Notify,
77 CK_SESSION_HANDLE_PTR phSession);
78
79 CK_RV gkm_mock_C_CloseSession (CK_SESSION_HANDLE hSession);
80
81 CK_RV gkm_mock_C_CloseAllSessions (CK_SLOT_ID slotID);
82
83 CK_RV gkm_mock_C_GetFunctionStatus (CK_SESSION_HANDLE hSession);
84
85 CK_RV gkm_mock_C_CancelFunction (CK_SESSION_HANDLE hSession);
86
87 CK_RV gkm_mock_C_GetSessionInfo (CK_SESSION_HANDLE hSession,
88 CK_SESSION_INFO_PTR pInfo);
89
90 CK_RV gkm_mock_fail_C_GetSessionInfo (CK_SESSION_HANDLE hSession,
91 CK_SESSION_INFO_PTR pInfo);
92
93 CK_RV gkm_mock_C_InitPIN (CK_SESSION_HANDLE hSession,
94 CK_UTF8CHAR_PTR pPin,
95 CK_ULONG ulPinLen);
96
97 CK_RV gkm_mock_C_SetPIN (CK_SESSION_HANDLE hSession,
98 CK_UTF8CHAR_PTR pOldPin,
99 CK_ULONG ulOldLen,
100 CK_UTF8CHAR_PTR pNewPin,
101 CK_ULONG ulNewLen);
102
103 CK_RV gkm_mock_unsupported_C_GetOperationState (CK_SESSION_HANDLE hSession,
104 CK_BYTE_PTR pOperationState,
105 CK_ULONG_PTR pulOperationStateLen);
106
107 CK_RV gkm_mock_unsupported_C_SetOperationState (CK_SESSION_HANDLE hSession,
108 CK_BYTE_PTR pOperationState,
109 CK_ULONG ulOperationStateLen,
110 CK_OBJECT_HANDLE hEncryptionKey,
111 CK_OBJECT_HANDLE hAuthenticationKey);
112
113 CK_RV gkm_mock_C_Login (CK_SESSION_HANDLE hSession,
114 CK_USER_TYPE userType,
115 CK_UTF8CHAR_PTR pPin,
116 CK_ULONG pPinLen);
117
118 CK_RV gkm_mock_C_Logout (CK_SESSION_HANDLE hSession);
119
120 CK_RV gkm_mock_C_CreateObject (CK_SESSION_HANDLE hSession,
121 CK_ATTRIBUTE_PTR pTemplate,
122 CK_ULONG ulCount,
123 CK_OBJECT_HANDLE_PTR phObject);
124
125 CK_RV gkm_mock_unsupported_C_CopyObject (CK_SESSION_HANDLE hSession,
126 CK_OBJECT_HANDLE hObject,
127 CK_ATTRIBUTE_PTR pTemplate,
128 CK_ULONG ulCount,
129 CK_OBJECT_HANDLE_PTR phNewObject);
130
131 CK_RV gkm_mock_C_DestroyObject (CK_SESSION_HANDLE hSession,
132 CK_OBJECT_HANDLE hObject);
133
134 CK_RV gkm_mock_unsupported_C_GetObjectSize (CK_SESSION_HANDLE hSession,
135 CK_OBJECT_HANDLE hObject,
136 CK_ULONG_PTR pulSize);
137
138 CK_RV gkm_mock_C_GetAttributeValue (CK_SESSION_HANDLE hSession,
139 CK_OBJECT_HANDLE hObject,
140 CK_ATTRIBUTE_PTR pTemplate,
141 CK_ULONG ulCount);
142
143 CK_RV gkm_mock_C_SetAttributeValue (CK_SESSION_HANDLE hSession,
144 CK_OBJECT_HANDLE hObject,
145 CK_ATTRIBUTE_PTR pTemplate,
146 CK_ULONG ulCount);
147
148 CK_RV gkm_mock_C_FindObjectsInit (CK_SESSION_HANDLE hSession,
149 CK_ATTRIBUTE_PTR pTemplate,
150 CK_ULONG ulCount);
151
152 CK_RV gkm_mock_C_FindObjects (CK_SESSION_HANDLE hSession,
153 CK_OBJECT_HANDLE_PTR phObject,
154 CK_ULONG ulMaxObjectCount,
155 CK_ULONG_PTR pulObjectCount);
156
157 CK_RV gkm_mock_C_FindObjectsFinal (CK_SESSION_HANDLE hSession);
158
159 CK_RV gkm_mock_C_EncryptInit (CK_SESSION_HANDLE hSession,
160 CK_MECHANISM_PTR pMechanism,
161 CK_OBJECT_HANDLE hKey);
162
163 CK_RV gkm_mock_C_Encrypt (CK_SESSION_HANDLE hSession,
164 CK_BYTE_PTR pData,
165 CK_ULONG ulDataLen,
166 CK_BYTE_PTR pEncryptedData,
167 CK_ULONG_PTR pulEncryptedDataLen);
168
169 CK_RV gkm_mock_unsupported_C_EncryptUpdate (CK_SESSION_HANDLE hSession,
170 CK_BYTE_PTR pPart,
171 CK_ULONG ulPartLen,
172 CK_BYTE_PTR pEncryptedPart,
173 CK_ULONG_PTR pulEncryptedPartLen);
174
175 CK_RV gkm_mock_unsupported_C_EncryptFinal (CK_SESSION_HANDLE hSession,
176 CK_BYTE_PTR pLastEncryptedPart,
177 CK_ULONG_PTR pulLastEncryptedPartLen);
178
179 CK_RV gkm_mock_C_DecryptInit (CK_SESSION_HANDLE hSession,
180 CK_MECHANISM_PTR pMechanism,
181 CK_OBJECT_HANDLE hKey);
182
183 CK_RV gkm_mock_C_Decrypt (CK_SESSION_HANDLE hSession,
184 CK_BYTE_PTR pEncryptedData,
185 CK_ULONG ulEncryptedDataLen,
186 CK_BYTE_PTR pData,
187 CK_ULONG_PTR pulDataLen);
188
189 CK_RV gkm_mock_unsupported_C_DecryptUpdate (CK_SESSION_HANDLE hSession,
190 CK_BYTE_PTR pEncryptedPart,
191 CK_ULONG ulEncryptedPartLen,
192 CK_BYTE_PTR pPart,
193 CK_ULONG_PTR pulPartLen);
194
195 CK_RV gkm_mock_unsupported_C_DecryptFinal (CK_SESSION_HANDLE hSession,
196 CK_BYTE_PTR pLastPart,
197 CK_ULONG_PTR pulLastPartLen);
198
199 CK_RV gkm_mock_unsupported_C_DigestInit (CK_SESSION_HANDLE hSession,
200 CK_MECHANISM_PTR pMechanism);
201
202 CK_RV gkm_mock_unsupported_C_Digest (CK_SESSION_HANDLE hSession,
203 CK_BYTE_PTR pData,
204 CK_ULONG ulDataLen,
205 CK_BYTE_PTR pDigest,
206 CK_ULONG_PTR pulDigestLen);
207
208 CK_RV gkm_mock_unsupported_C_DigestUpdate (CK_SESSION_HANDLE hSession,
209 CK_BYTE_PTR pPart,
210 CK_ULONG ulPartLen);
211
212 CK_RV gkm_mock_unsupported_C_DigestKey (CK_SESSION_HANDLE hSession,
213 CK_OBJECT_HANDLE hKey);
214
215 CK_RV gkm_mock_unsupported_C_DigestFinal (CK_SESSION_HANDLE hSession,
216 CK_BYTE_PTR pDigest,
217 CK_ULONG_PTR pulDigestLen);
218
219 CK_RV gkm_mock_C_SignInit (CK_SESSION_HANDLE hSession,
220 CK_MECHANISM_PTR pMechanism,
221 CK_OBJECT_HANDLE hKey);
222
223 CK_RV gkm_mock_C_Sign (CK_SESSION_HANDLE hSession,
224 CK_BYTE_PTR pData,
225 CK_ULONG ulDataLen,
226 CK_BYTE_PTR pSignature,
227 CK_ULONG_PTR pulSignatureLen);
228
229 CK_RV gkm_mock_unsupported_C_SignUpdate (CK_SESSION_HANDLE hSession,
230 CK_BYTE_PTR pPart,
231 CK_ULONG ulPartLen);
232
233 CK_RV gkm_mock_unsupported_C_SignFinal (CK_SESSION_HANDLE hSession,
234 CK_BYTE_PTR pSignature,
235 CK_ULONG_PTR pulSignatureLen);
236
237 CK_RV gkm_mock_unsupported_C_SignRecoverInit (CK_SESSION_HANDLE hSession,
238 CK_MECHANISM_PTR pMechanism,
239 CK_OBJECT_HANDLE hKey);
240
241 CK_RV gkm_mock_unsupported_C_SignRecover (CK_SESSION_HANDLE hSession,
242 CK_BYTE_PTR pData,
243 CK_ULONG ulDataLen,
244 CK_BYTE_PTR pSignature,
245 CK_ULONG_PTR pulSignatureLen);
246
247 CK_RV gkm_mock_C_VerifyInit (CK_SESSION_HANDLE hSession,
248 CK_MECHANISM_PTR pMechanism,
249 CK_OBJECT_HANDLE hKey);
250
251 CK_RV gkm_mock_C_Verify (CK_SESSION_HANDLE hSession,
252 CK_BYTE_PTR pData,
253 CK_ULONG ulDataLen,
254 CK_BYTE_PTR pSignature,
255 CK_ULONG ulSignatureLen);
256
257 CK_RV gkm_mock_unsupported_C_VerifyUpdate (CK_SESSION_HANDLE hSession,
258 CK_BYTE_PTR pPart,
259 CK_ULONG ulPartLen);
260
261 CK_RV gkm_mock_unsupported_C_VerifyFinal (CK_SESSION_HANDLE hSession,
262 CK_BYTE_PTR pSignature,
263 CK_ULONG pulSignatureLen);
264
265 CK_RV gkm_mock_unsupported_C_VerifyRecoverInit (CK_SESSION_HANDLE hSession,
266 CK_MECHANISM_PTR pMechanism,
267 CK_OBJECT_HANDLE hKey);
268
269 CK_RV gkm_mock_unsupported_C_VerifyRecover (CK_SESSION_HANDLE hSession,
270 CK_BYTE_PTR pSignature,
271 CK_ULONG pulSignatureLen,
272 CK_BYTE_PTR pData,
273 CK_ULONG_PTR pulDataLen);
274
275 CK_RV gkm_mock_unsupported_C_DigestEncryptUpdate (CK_SESSION_HANDLE hSession,
276 CK_BYTE_PTR pPart,
277 CK_ULONG ulPartLen,
278 CK_BYTE_PTR pEncryptedPart,
279 CK_ULONG_PTR ulEncryptedPartLen);
280
281 CK_RV gkm_mock_unsupported_C_DecryptDigestUpdate (CK_SESSION_HANDLE hSession,
282 CK_BYTE_PTR pEncryptedPart,
283 CK_ULONG ulEncryptedPartLen,
284 CK_BYTE_PTR pPart,
285 CK_ULONG_PTR pulPartLen);
286
287 CK_RV gkm_mock_unsupported_C_SignEncryptUpdate (CK_SESSION_HANDLE hSession,
288 CK_BYTE_PTR pPart,
289 CK_ULONG ulPartLen,
290 CK_BYTE_PTR pEncryptedPart,
291 CK_ULONG_PTR ulEncryptedPartLen);
292
293 CK_RV gkm_mock_unsupported_C_DecryptVerifyUpdate (CK_SESSION_HANDLE hSession,
294 CK_BYTE_PTR pEncryptedPart,
295 CK_ULONG ulEncryptedPartLen,
296 CK_BYTE_PTR pPart,
297 CK_ULONG_PTR pulPartLen);
298
299 CK_RV gkm_mock_unsupported_C_GenerateKey (CK_SESSION_HANDLE hSession,
300 CK_MECHANISM_PTR pMechanism,
301 CK_ATTRIBUTE_PTR pTemplate,
302 CK_ULONG ulCount,
303 CK_OBJECT_HANDLE_PTR phKey);
304
305 CK_RV gkm_mock_unsupported_C_GenerateKeyPair (CK_SESSION_HANDLE hSession,
306 CK_MECHANISM_PTR pMechanism,
307 CK_ATTRIBUTE_PTR pPublicKeyTemplate,
308 CK_ULONG ulPublicKeyAttributeCount,
309 CK_ATTRIBUTE_PTR pPrivateKeyTemplate,
310 CK_ULONG ulPrivateKeyAttributeCount,
311 CK_OBJECT_HANDLE_PTR phPublicKey,
312 CK_OBJECT_HANDLE_PTR phPrivateKey);
313
314 CK_RV gkm_mock_unsupported_C_WrapKey (CK_SESSION_HANDLE hSession,
315 CK_MECHANISM_PTR pMechanism,
316 CK_OBJECT_HANDLE hWrappingKey,
317 CK_OBJECT_HANDLE hKey,
318 CK_BYTE_PTR pWrappedKey,
319 CK_ULONG_PTR pulWrappedKeyLen);
320
321 CK_RV gkm_mock_unsupported_C_UnwrapKey (CK_SESSION_HANDLE hSession,
322 CK_MECHANISM_PTR pMechanism,
323 CK_OBJECT_HANDLE pUnwrappingKey,
324 CK_BYTE_PTR pWrappedKey,
325 CK_ULONG pulWrappedKeyLen,
326 CK_ATTRIBUTE_PTR pTemplate,
327 CK_ULONG ulCount,
328 CK_OBJECT_HANDLE_PTR phKey);
329
330 CK_RV gkm_mock_unsupported_C_DeriveKey (CK_SESSION_HANDLE hSession,
331 CK_MECHANISM_PTR pMechanism,
332 CK_OBJECT_HANDLE hBaseKey,
333 CK_ATTRIBUTE_PTR pTemplate,
334 CK_ULONG ulCount,
335 CK_OBJECT_HANDLE_PTR phKey);
336
337 CK_RV gkm_mock_unsupported_C_SeedRandom (CK_SESSION_HANDLE hSession,
338 CK_BYTE_PTR pSeed,
339 CK_ULONG ulSeedLen);
340
341 CK_RV gkm_mock_unsupported_C_GenerateRandom (CK_SESSION_HANDLE hSession,
342 CK_BYTE_PTR pRandomData,
343 CK_ULONG ulRandomLen);
344
345 CK_OBJECT_HANDLE gkm_mock_module_find_object (CK_SESSION_HANDLE session,
346 CK_ATTRIBUTE_PTR attrs,
347 CK_ULONG n_attrs);
348
349 guint gkm_mock_module_count_objects (CK_SESSION_HANDLE session);
350
351 typedef gboolean (*GkmMockEnumerator) (CK_OBJECT_HANDLE handle,
352 GArray *attrs,
353 gpointer user_data);
354
355 void gkm_mock_module_enumerate_objects (CK_SESSION_HANDLE session,
356 GkmMockEnumerator func,
357 gpointer user_data);
358
359 CK_OBJECT_HANDLE gkm_mock_module_take_object (GArray *template);
360
361 void gkm_mock_module_set_object (CK_OBJECT_HANDLE object,
362 CK_ATTRIBUTE_PTR attrs,
363 CK_ULONG n_attrs);
364
365 void gkm_mock_module_set_pin (const gchar *password);
366
367 /*
368 * Some dumb crypto mechanisms for simple testing.
369 *
370 * CKM_T_CAPITALIZE (encrypt/decrypt)
371 * capitalizes to encrypt
372 * lowercase to decrypt
373 *
374 * CKM_T_PREFIX (sign/verify)
375 * sign prefixes data with key label
376 * verify unprefixes data with key label.
377 *
378 * CKM_T_GENERATE (generate-pair)
379 * generates a pair of keys, mechanism param should be 'generate'
380 *
381 * CKM_T_WRAP (wrap key)
382 * wraps key by returning value, mechanism param should be 'wrap'
383 *
384 * CKM_T_DERIVE (derive-key)
385 * derives key by setting value to 'derived'.
386 * mechanism param should be 'derive'
387 */
388
389 #define CKM_MOCK_CAPITALIZE (CKM_VENDOR_DEFINED | 1)
390 #define CKM_MOCK_PREFIX (CKM_VENDOR_DEFINED | 2)
391 #define CKM_MOCK_GENERATE (CKM_VENDOR_DEFINED | 3)
392 #define CKM_MOCK_WRAP (CKM_VENDOR_DEFINED | 4)
393 #define CKM_MOCK_DERIVE (CKM_VENDOR_DEFINED | 5)
394
395 #endif /* TESTMODULE_H_ */