summaryrefslogtreecommitdiff
path: root/src/slot.c
blob: e3ff99f51d08b0c38aadae054150baf356f4a12d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469

#include "p11-tests.h"

#include <stdlib.h>
#include <stdio.h>
#include <string.h>

CK_INFO slot_global;

CK_ULONG p11t_slot_count = 0;
static CK_SLOT_ID_PTR slot_ids = NULL;
static CK_SLOT_INFO_PTR slot_info = NULL;
static CK_TOKEN_INFO_PTR slot_token_info = NULL;

static CK_ULONG *slot_mech_count;
static CK_MECHANISM_TYPE_PTR *slot_mech_type;
static CK_MECHANISM_INFO_PTR *slot_mech_info;

/* ----------------------------------------------------------------------------------
 * TESTS
 */

void
test_slot_global(void)
{
	CK_RV rv;

	/** C_GetInfo */

	assert(p11t_module_funcs);

	if(p11t_test_unexpected)
	{
		/** - NULL argument */
		rv = (p11t_module_funcs->C_GetInfo)(NULL);
		p11t_check_returns("C_GetInfo: null argument", rv, CKR_ARGUMENTS_BAD);
	}

	/* Obvious crap fill */
	memset(&slot_global, 0xFF, sizeof(CK_INFO));

	/** - Normal call */
	rv = (p11t_module_funcs->C_GetInfo)(&slot_global);
	if(!p11t_check_returns("C_GetInfo", rv, CKR_OK))
	{
		memset(&slot_global, 0, sizeof(CK_INFO));
		return;
	}

	/** - Space padded strings in CK_INFO */
	p11t_check_padded("CK_INFO.manufacturerID", slot_global.manufacturerID);
	p11t_check_padded("CK_INFO.libraryDescription", slot_global.libraryDescription);

	/** - No flags set */
	p11t_check_ulong("CK_INFO.flags", slot_global.flags, 0);
}

int
compar_slot_id(const void *one, const void *two)
{
	CK_SLOT_ID a = *((CK_SLOT_ID*)one);
	CK_SLOT_ID b = *((CK_SLOT_ID*)two);
	if(a == b)
		return 0;
	if(a > b)
		return 1;
	return -1;
}

void
test_slot_info(void)
{
	CK_SLOT_ID_PTR present, only;
	CK_ULONG n_present, n_only, count;
	CK_ULONG i;
	CK_RV rv;

	/** C_GetSlotList */

	assert(p11t_module_funcs);

	if(p11t_test_unexpected)
	{
		/** - NULL arguments */
		rv = (p11t_module_funcs->C_GetSlotList)(FALSE, NULL, NULL);
		p11t_check_returns("C_GetSlotList: null argument", rv, CKR_ARGUMENTS_BAD);
	}

	/** - Retrieving the count */
	rv = (p11t_module_funcs->C_GetSlotList)(FALSE, NULL, &p11t_slot_count);
	p11t_check_returns("C_GetSlotList", rv, CKR_OK);

	if(p11t_slot_count == 0)
	{
		p11t_msg_print("C_GetSlotList: no slots to test");
		return;
	}

	/* Allocate a bit extra. We're going to try and trip up module */
	slot_ids = calloc(p11t_slot_count + 5, sizeof(CK_SLOT_ID));
	assert(slot_ids);

	slot_info = calloc(p11t_slot_count, sizeof(CK_SLOT_INFO));
	assert(slot_info);

	slot_token_info = calloc(p11t_slot_count, sizeof(CK_TOKEN_INFO));
	assert(slot_token_info);

	if(p11t_test_unexpected)
	{
		/** - Passing buffer space along with zero count. */
		count = 0;
		rv = (p11t_module_funcs->C_GetSlotList)(FALSE, slot_ids, &count);
		p11t_check_returns("C_GetSlotList: zero buffer", rv, CKR_BUFFER_TOO_SMALL);
		p11t_check_ulong("C_GetSlotList: count invalid zero space passed", count, p11t_slot_count);

		if(p11t_slot_count > 1)
		{
			/** - Passing buffer space along with low count. */
			count = 1;
			rv = (p11t_module_funcs->C_GetSlotList)(FALSE, slot_ids, &count);
			p11t_check_returns("C_GetSlotList: low buffer", rv, CKR_BUFFER_TOO_SMALL);
			p11t_check_ulong("C_GetSlotList: count invalid when too little space passed", count, p11t_slot_count);
		}
	}

	/** - Passing too much buffer space. */
	if(p11t_test_unexpected)
		count = p11t_slot_count + 5;
	else
		count = p11t_slot_count;
	rv = (p11t_module_funcs->C_GetSlotList)(FALSE, slot_ids, &count);
	if(!p11t_check_returns("C_GetSlotList", rv, CKR_OK))
	{
		p11t_slot_count = 0;
		return;
	}

	p11t_check_ulong("C_GetSlotList: count invalid when too much space passed", count, p11t_slot_count);

	/* When we ask for just token valid ones, they should only be the ones we noted with flags */
	present = calloc(p11t_slot_count, sizeof(CK_SLOT_ID));
	only = calloc(p11t_slot_count, sizeof(CK_SLOT_ID));
	assert(present && only);
	n_present = 0;

	/* Now go through and load info about each slot */
	for(i = 0; i < p11t_slot_count; ++i)
	{
		/** C_GetSlotInfo */

		if(p11t_test_unexpected)
		{
			/** - NULL argument */
			rv = (p11t_module_funcs->C_GetSlotInfo)(slot_ids[i], NULL);
			p11t_check_returns("C_GetSlotInfo: null argument", rv, CKR_ARGUMENTS_BAD);
		}

		/** - Normal call */
		rv = (p11t_module_funcs->C_GetSlotInfo)(slot_ids[i], &slot_info[i]);
		p11t_check_returns("C_GetSlotInfo", rv, CKR_OK);

		/** - Space padded CK_SLOT_INFO fields */
		p11t_check_padded("CK_SLOT_INFO.slotDescription", slot_info[i].slotDescription);
		p11t_check_padded("CK_SLOT_INFO.manufacturerID", slot_info[i].manufacturerID);

		/** - CK_SLOT_INFO flags are from valid set */
		p11t_check_mask("CK_SLOT_INFO.flags", slot_info[i].flags,
		                CKF_TOKEN_PRESENT | CKF_REMOVABLE_DEVICE | CKF_HW_SLOT);

		/** - Track CKF_TOKEN_PRESENT flag and compare to C_GetSlotList(TRUE) */
		if((slot_info[i].flags & CKF_TOKEN_PRESENT) == CKF_TOKEN_PRESENT)
		{
			/* Note if token is present for later */
			present[n_present++] = slot_ids[i];

			/** C_GetTokenInfo */

			if(p11t_test_unexpected)
			{
				/** - Null arguments */
				rv = (p11t_module_funcs->C_GetTokenInfo)(slot_ids[i], NULL);
				p11t_check_returns("C_GetTokenInfo: null arguments", rv, CKR_ARGUMENTS_BAD);
			}

			/** - Normal call */
			rv = (p11t_module_funcs->C_GetTokenInfo)(slot_ids[i], &slot_token_info[i]);
			p11t_check_returns("C_GetTokenInfo", rv, CKR_OK);

			/** - Space padded CK_TOKEN_INFO fields */
			p11t_check_padded("CK_TOKEN_INFO.label", slot_token_info[i].label);
			p11t_check_padded("CK_TOKEN_INFO.manufacturerID", slot_token_info[i].manufacturerID);
			p11t_check_padded("CK_TOKEN_INFO.model", slot_token_info[i].model);
			p11t_check_padded("CK_TOKEN_INFO.serialNumber", slot_token_info[i].serialNumber);

			/** - CK_TOKEN_INFO flags are from valid set */
			p11t_check_mask("CK_TOKEN_INFO.flags", slot_token_info[i].flags,
			                CKF_RNG | CKF_WRITE_PROTECTED | CKF_LOGIN_REQUIRED | CKF_USER_PIN_INITIALIZED |
			                CKF_RESTORE_KEY_NOT_NEEDED | CKF_CLOCK_ON_TOKEN | CKF_PROTECTED_AUTHENTICATION_PATH |
			                CKF_DUAL_CRYPTO_OPERATIONS | CKF_TOKEN_INITIALIZED | CKF_SECONDARY_AUTHENTICATION |
			                CKF_USER_PIN_COUNT_LOW | CKF_USER_PIN_FINAL_TRY | CKF_USER_PIN_LOCKED |
			                CKF_USER_PIN_TO_BE_CHANGED | CKF_SO_PIN_COUNT_LOW | CKF_SO_PIN_FINAL_TRY |
			                CKF_SO_PIN_LOCKED | CKF_SO_PIN_TO_BE_CHANGED);

			/* Can't validate all the statistics, any number is valid */

			/** - Validate token time when CKF_CLOCK_ON_TOKEN */
			if((slot_token_info[i].flags & CKF_CLOCK_ON_TOKEN) == CKF_CLOCK_ON_TOKEN)
			{
				int year, month, day, hour, minute, second, extra, n;
				char buffer[sizeof(slot_token_info[i].utcTime) + 1];

				memcpy(buffer, (char*)slot_token_info[i].utcTime,
				       sizeof(slot_token_info[i].utcTime));
				buffer[sizeof(slot_token_info[i].utcTime)] = 0;

				n = sscanf(buffer, "%04d%02d%02d%02d%02d%02d%02d",
				           &year, &month, &day, &hour, &minute, &second, &extra);

				if(n != 7 ||
				   year < 0 || year > 9999 ||
				   month < 1 || month > 12 ||
				   day < 1 || day > 31 ||
				   hour < 0 || hour > 23 ||
				   minute < 0 || minute > 59 ||
				   second < 0 || second > 50 ||
				   extra != 0)
				{
					p11t_msg_print("C_GetTokenInfo: invalid time on token: %s", buffer);
				}
			}
		}
		else if(p11t_test_unexpected)
		{
			/** - Calling on slot without token */
			rv = (p11t_module_funcs->C_GetTokenInfo)(slot_ids[i], &slot_token_info[i]);
			p11t_check_returns("C_GetSlotInfo: without token", rv, CKR_TOKEN_NOT_PRESENT);
		}
	}

	rv = (p11t_module_funcs->C_GetSlotList)(TRUE, only, &n_only);
	p11t_check_returns("C_GetSlotList: only tokens", rv, CKR_OK);

	p11t_check_ulong("C_GetSlotInfo: number of present tokens doesn't match token info flags. ie: CKF_TOKEN_PRESENT", n_only, n_present);

	qsort(only, n_only, sizeof(CK_SLOT_ID), compar_slot_id);
	qsort(present, n_present, sizeof(CK_SLOT_ID), compar_slot_id);
	if(memcmp(only, present, sizeof(CK_SLOT_ID) * n_only) != 0)
		p11t_msg_print("C_GetSlotInfo: present tokens don't match those in token info flags. ie: CKF_TOKEN_PRESENT");
}

void
test_slot_events(void)
{
	/** C_WaitForSlotEvent */
	/** - Not Implemented */
}

void
test_slot_mechanisms(void)
{
	CK_MECHANISM_TYPE_PTR mech_list;
	CK_MECHANISM_INFO_PTR mech_info;
	CK_SLOT_ID slot_id;
	CK_ULONG mech_count, value;
	CK_ULONG i, j;
	CK_RV rv;

	assert(p11t_module_funcs);

	/** C_GetMechanismList */

	if(!p11t_slot_count)
		return;

	if(p11t_test_unexpected)
	{
		/* - Invalid Slot */
		mech_count = 0;
		rv = (p11t_module_funcs->C_GetMechanismList)((CK_ULONG)-10, NULL, &mech_count);
		p11t_check_returns("C_GetMechanismList: invalid slot id", rv, CKR_SLOT_ID_INVALID);
	}

	slot_mech_count = calloc(p11t_slot_count, sizeof(CK_ULONG));
	assert(slot_mech_count);

	slot_mech_info = calloc(p11t_slot_count, sizeof(CK_MECHANISM_INFO_PTR));
	assert(slot_mech_info);

	slot_mech_type = calloc(p11t_slot_count, sizeof(CK_MECHANISM_TYPE_PTR));
	assert(slot_mech_type);

	for(i = 0; i < p11t_slot_count; ++i)
	{
		slot_id = slot_ids[i];

		if(p11t_test_unexpected)
		{
			/** - Null arguments */
			rv = (p11t_module_funcs->C_GetMechanismList)(slot_id, NULL, NULL);
			p11t_check_returns("C_GetMechanismList: null arguments", rv, CKR_ARGUMENTS_BAD);
		}

		/** - Without buffer */
		rv = (p11t_module_funcs->C_GetMechanismList)(slot_id, NULL, &mech_count);
		p11t_check_returns("C_GetMechanismList: without buffer", rv, CKR_OK);

		mech_list = NULL;
		mech_info = NULL;

		if(mech_count > 0)
		{
			mech_list = calloc(mech_count + 5, sizeof(CK_MECHANISM_TYPE));
			assert(mech_list);

			if(p11t_test_unexpected)
			{
				/** - Zero count but buffer present */
				value = 0;
				rv = (p11t_module_funcs->C_GetMechanismList)(slot_id, mech_list, &value);
				p11t_check_returns("C_GetMechanismList: zero buffer", rv, CKR_BUFFER_TOO_SMALL);
				p11t_check_ulong("C_GetMechanismList: should have number of mechs", value, mech_count);

				if(mech_count > 1)
				{
					/** - Low count but buffer present */
					value = 1;
					rv = (p11t_module_funcs->C_GetMechanismList)(slot_id, mech_list, &value);
					p11t_check_returns("C_GetMechanismList: low buffer", rv, CKR_BUFFER_TOO_SMALL);
					p11t_check_ulong("C_GetMechanismList: should have number of mechs", value, mech_count);
				}
			}

			/* - Call with too much buffer */
			if(p11t_test_unexpected)
				value = mech_count + 5;
			else
				value = mech_count;
			rv = (p11t_module_funcs->C_GetMechanismList)(slot_id, mech_list, &value);
			p11t_check_returns("C_GetMechanismList: high buffer", rv, CKR_OK);
			p11t_check_ulong("C_GetMechanismList: should have number of mechs", value, mech_count);


			mech_info = calloc(mech_count, sizeof(CK_MECHANISM_INFO));
			assert(mech_info);

			/** C_GetMechanismInfo */

			if(p11t_test_unexpected)
			{
				/** - Invalid mechanism */
				rv = (p11t_module_funcs->C_GetMechanismInfo)(slot_id, (CK_ULONG)-10, mech_info);
				p11t_check_returns("C_GetMechanismInfo: with invalid mech", rv, CKR_MECHANISM_INVALID);

				/** - Null arguments */
				rv = (p11t_module_funcs->C_GetMechanismInfo)(slot_id, mech_list[0], NULL);
				p11t_check_returns("C_GetMechanismInfo: with null arg", rv, CKR_ARGUMENTS_BAD);

				/** - Invalid slot id */
				rv = (p11t_module_funcs->C_GetMechanismInfo)((CK_ULONG)-11, mech_list[0], mech_info);
				p11t_check_returns("C_GetMechanismInfo: with invalid slot", rv, CKR_SLOT_ID_INVALID);
			}

			for(j = 0; j < mech_count; ++j)
			{
				/** - Normal call */
				rv = (p11t_module_funcs->C_GetMechanismInfo)(slot_id, mech_list[i], &mech_info[i]);
				p11t_check_returns("C_GetMechanismInfo", rv, CKR_OK);

				if(mech_info[i].ulMinKeySize > mech_info[i].ulMaxKeySize)
					p11t_msg_print("C_GetMechanismInfo: Mechanism min key size is greater than max");

				p11t_check_mask("CK_MECHANISM_INFO.flags", mech_info[i].flags,
				                CKF_HW | CKF_ENCRYPT | CKF_DECRYPT | CKF_DIGEST | CKF_SIGN |
				                CKF_SIGN_RECOVER | CKF_VERIFY | CKF_VERIFY_RECOVER | CKF_GENERATE |
				                CKF_GENERATE_KEY_PAIR | CKF_WRAP | CKF_UNWRAP | CKF_DERIVE);

				p11t_check_nflag("CK_MECHANISM_INFO.flags", mech_info[i].flags, CKF_EXTENSION);
			}

		}

		slot_mech_info[i] = mech_info;
		slot_mech_type[i] = mech_list;
		slot_mech_count[i] = mech_count;
	}
}

void
test_init_token(void)
{
	/** C_InitToken */

	/** - Not Implemented */
}

void
p11t_slot_tests(void)
{
	test_slot_global();
	test_slot_info();
	test_slot_events();
	test_init_token();
	test_slot_mechanisms();
}

/* ----------------------------------------------------------------------------------
 * METHODS
 */

static int
get_slot_index(CK_SLOT_ID slot)
{
	CK_ULONG i;

	for(i = 0; i < p11t_slot_count; ++i)
	{
		if(slot == slot_ids[i])
			return i;
	}

	return -1;
}

CK_SLOT_ID
p11t_slot_get_id(int index)
{
	if(index >= (int)p11t_slot_count)
		return CK_INVALID;
	return slot_ids[index];
}

CK_SLOT_INFO_PTR
p11t_slot_get_info(CK_SLOT_ID slot)
{
	int i = get_slot_index(slot);
	if(i < 0)
		return NULL;
	return &slot_info[i];
}

CK_TOKEN_INFO_PTR
p11t_slot_get_token_info(CK_SLOT_ID slot)
{
	int i = get_slot_index(slot);
	if(i < 0)
		return NULL;

	if(slot_info[i].flags & CKF_TOKEN_PRESENT)
		return &slot_token_info[i];

	return NULL;
}

void
p11t_slot_for_each_mech(CK_MECHANISM_TYPE mech_type,
                        P11tSlotMechCallback callback)
{
	CK_ULONG i, j;

	for(i = 0; i < p11t_slot_count; ++i)
	{
		for(j = 0; j < slot_mech_count[i]; ++j)
		{
			if(mech_type == CK_INVALID || slot_mech_type[i][j] == mech_type)
				(callback)(slot_ids[i], slot_mech_type[i][j], &slot_mech_info[i][j]);
		}
	}
}