summaryrefslogtreecommitdiff
path: root/src/session.c
blob: 1ed0104447dcc42fec2847a0311264ebff418035 (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

#include "p11-tests.h"

#include <string.h>

static const char *login_user_pin = NULL;
static const char *login_so_pin = NULL;


void
p11t_session_config(const char *name, const char *value)
{
	if(strcmp(name, "login-user-pin") == 0)
		login_user_pin = value;
	if(strcmp(name, "login-so-pin") == 0)
		login_so_pin = value;
}

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

static int
test_session_info(CK_SESSION_HANDLE session, CK_SLOT_ID slot, CK_FLAGS flags, CK_STATE state)
{
	CK_SESSION_INFO info;
	CK_RV rv;

	if(session == CK_INVALID)
		return CONTINUE;

	P11T_SECTION("C_GetSessionInfo");

	if(p11t_test_unexpected)
	{
		rv = (p11t_module_funcs->C_GetSessionInfo)((CK_SESSION_HANDLE)-33, &info);
		P11T_CHECK_RV("Invalid session", rv, CKR_SESSION_HANDLE_INVALID);

		rv = (p11t_module_funcs->C_GetSessionInfo)(session, NULL);
		P11T_CHECK_RV("Null arguments", rv, CKR_ARGUMENTS_BAD);
	}

	rv = (p11t_module_funcs->C_GetSessionInfo)(session, &info);
	P11T_CHECK_RV("Valid call", rv, CKR_OK);

	P11T_SECTION("CK_SESSION_INFO");

	P11T_CHECK_ULONG("slotID", info.slotID, slot);
	P11T_CHECK_ULONG("state", info.state, state);
	P11T_CHECK_FLAG("flags", info.flags, flags);

	return CONTINUE;
}

static CK_UTF8CHAR_PTR
calculate_pin(CK_SLOT_ID slot, CK_USER_TYPE user, CK_ULONG_PTR n_pin)
{
	CK_TOKEN_INFO_PTR info;
	const char *pin;

	*n_pin = 0;

	info = p11t_slot_get_token_info(slot);
	if(info && info->flags & CKF_PROTECTED_AUTHENTICATION_PATH)
		return NULL;

	if(user == CKU_USER)
		pin = login_user_pin;
	else if(user == CKU_SO)
		pin = login_so_pin;
	else
		pin = NULL;

	if(pin)
		*n_pin = (CK_ULONG)strlen(pin);

	return (CK_UTF8CHAR_PTR)pin;
}

static int
test_session_user_login(CK_SLOT_ID slot)
{
	CK_SESSION_HANDLE session_ro = CK_INVALID;
	CK_SESSION_HANDLE session_rw = CK_INVALID;
	CK_UTF8CHAR_PTR pin;
	CK_ULONG n_pin;
	CK_RV rv;

	pin = calculate_pin(slot, CKU_USER, &n_pin);

	rv = (p11t_module_funcs->C_OpenSession)(slot, CKF_SERIAL_SESSION, NULL, NULL, &session_ro);
	P11T_CHECK_RV("C_Login: open RO session", rv, CKR_OK);
	rv = (p11t_module_funcs->C_OpenSession)(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, NULL, NULL, &session_rw);
	P11T_CHECK_RV("C_Login: open RW session", rv, CKR_OK);

	/* Check the session state before login */
	test_session_info(session_ro, slot, CKF_SERIAL_SESSION, CKS_RO_PUBLIC_SESSION);
	test_session_info(session_rw, slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, CKS_RW_PUBLIC_SESSION);

	P11T_SECTION("C_Login");

	if(p11t_test_unexpected)
	{
		rv = (p11t_module_funcs->C_Login)((CK_ULONG)-55, CKU_USER, pin, n_pin);
		P11T_CHECK_RV("Invalid session", rv, CKR_SESSION_HANDLE_INVALID);

		rv = (p11t_module_funcs->C_Login)(session_ro, CK_INVALID, pin, n_pin);
		P11T_CHECK_RV("Invalid user type", rv, CKR_USER_TYPE_INVALID);
	}

	rv = (p11t_module_funcs->C_Login)(session_ro, CKU_USER, pin, n_pin);
	if(rv == CKR_USER_TYPE_INVALID)
		return CONTINUE;
	P11T_CHECK_RV("Normal login", rv, CKR_OK);

	P11T_CHECK_NOTE("Login changes all session's state");
	test_session_info(session_ro, slot, CKF_SERIAL_SESSION, CKS_RO_USER_FUNCTIONS);
	test_session_info(session_rw, slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, CKS_RW_USER_FUNCTIONS);

	P11T_SECTION("C_Logout");

	if(p11t_test_unexpected)
	{
		rv = (p11t_module_funcs->C_Logout)((CK_ULONG)-55);
		P11T_CHECK_RV("Invalid session", rv, CKR_SESSION_HANDLE_INVALID);
	}

	rv = (p11t_module_funcs->C_Logout)(session_rw);
	P11T_CHECK_RV("Normal logout", rv, CKR_OK);

	P11T_CHECK_NOTE("Logout changes all session state");
	test_session_info(session_ro, slot, CKF_SERIAL_SESSION, CKS_RO_PUBLIC_SESSION);
	test_session_info(session_rw, slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, CKS_RW_PUBLIC_SESSION);

	return CONTINUE;
}

static int
test_session_so_login(CK_SLOT_ID slot)
{
	CK_SESSION_HANDLE session_ro = CK_INVALID;
	CK_SESSION_HANDLE session_rw = CK_INVALID;
	CK_UTF8CHAR_PTR pin;
	CK_ULONG n_pin;
	CK_RV rv;

	pin = calculate_pin(slot, CKU_SO, &n_pin);

	rv = (p11t_module_funcs->C_OpenSession)(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, NULL, NULL, &session_rw);
	P11T_CHECK_RV("C_OpenSession: open RW session", rv, CKR_OK);

	/* Check the session state before login */
	test_session_info(session_rw, slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, CKS_RW_PUBLIC_SESSION);

	P11T_SECTION("C_Login");

	if(p11t_test_unexpected)
	{
		rv = (p11t_module_funcs->C_OpenSession)(slot, CKF_SERIAL_SESSION, NULL, NULL, &session_ro);
		P11T_CHECK_RV("Test opening RO session before login as SO", rv, CKR_OK);

		rv = (p11t_module_funcs->C_Login)(session_ro, CKU_SO, pin, n_pin);
		if(rv == CKR_USER_TYPE_INVALID)
			return CONTINUE;
		P11T_CHECK_RV("Login as SO not allowed with RO session", rv, CKR_SESSION_READ_ONLY_EXISTS);

		rv = (p11t_module_funcs->C_CloseSession)(session_ro);
		P11T_CHECK_RV("Test closing RO session before login as SO", rv, CKR_OK);
	}

	rv = (p11t_module_funcs->C_Login)(session_rw, CKU_SO, pin, n_pin);
	if(rv == CKR_USER_TYPE_INVALID)
		return CONTINUE;
	P11T_CHECK_RV("Login as SO", rv, CKR_OK);

	P11T_CHECK_NOTE("SO login changes all session state");
	test_session_info(session_rw, slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, CKS_RW_SO_FUNCTIONS);

	if(p11t_test_unexpected)
	{
		P11T_SECTION("C_OpenSession");

		rv = (p11t_module_funcs->C_OpenSession)(slot, CKF_SERIAL_SESSION, NULL, NULL, &session_ro);
		P11T_CHECK_RV("Can't open RO session when logged in as SO", rv, CKR_SESSION_READ_WRITE_SO_EXISTS);
	}

	P11T_SECTION("C_Logout");

	rv = (p11t_module_funcs->C_Logout)(session_rw);
	P11T_CHECK_RV("Logout from SO", rv, CKR_OK);

	P11T_CHECK_NOTE("Logout SO changes goes back to public");
	test_session_info(session_rw, slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, CKS_RW_PUBLIC_SESSION);

	return CONTINUE;
}

static int
test_session_main(CK_SLOT_ID slot)
{
	CK_SESSION_HANDLE session_ro = CK_INVALID;
	CK_SESSION_HANDLE session_rw = CK_INVALID;
	CK_SESSION_HANDLE session_ro2 = CK_INVALID;
	CK_SESSION_INFO info;
	CK_RV rv;

	assert(p11t_module_funcs);

	P11T_SECTION("C_OpenSession");

	if(p11t_test_unexpected)
	{
		rv = (p11t_module_funcs->C_OpenSession)((CK_SLOT_ID)-5, CKF_SERIAL_SESSION, NULL, NULL, &session_ro);
		P11T_CHECK_RV("Invalid slot", rv, CKR_SLOT_ID_INVALID);

		rv = (p11t_module_funcs->C_OpenSession)(slot, CKF_SERIAL_SESSION, NULL, NULL, NULL);
		P11T_CHECK_RV("Null arguments", rv, CKR_ARGUMENTS_BAD);

		rv = (p11t_module_funcs->C_OpenSession)(slot, 0, NULL, NULL, &session_ro);
		P11T_CHECK_RV("No flags", rv, CKR_SESSION_PARALLEL_NOT_SUPPORTED);

		rv = (p11t_module_funcs->C_OpenSession)(slot, CKF_RW_SESSION, NULL, NULL, &session_ro);
		P11T_CHECK_RV("Without serial flag", rv, CKR_SESSION_PARALLEL_NOT_SUPPORTED);
	}

	rv = (p11t_module_funcs->C_OpenSession)(slot, CKF_SERIAL_SESSION, NULL, NULL, &session_ro);
	P11T_CHECK_RV("Valid flags", rv, CKR_OK);
	rv = (p11t_module_funcs->C_OpenSession)(slot, CKF_SERIAL_SESSION, NULL, NULL, &session_ro2);
	P11T_CHECK_RV("Valid flags", rv, CKR_OK);

	rv = (p11t_module_funcs->C_OpenSession)(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, NULL, NULL, &session_rw);
	if(rv == CKR_TOKEN_WRITE_PROTECTED)
		session_rw = CK_INVALID;
	else
		P11T_CHECK_RV("Read write session", rv, CKR_OK);

	/* Test all the sessions and validate their state */
	test_session_info(session_ro, slot, CKF_SERIAL_SESSION, CKS_RO_PUBLIC_SESSION);
	test_session_info(session_ro2, slot, CKF_SERIAL_SESSION, CKS_RO_PUBLIC_SESSION);
	test_session_info(session_rw, slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, CKS_RW_PUBLIC_SESSION);

	P11T_SECTION("C_CloseSession");

	if(p11t_test_unexpected)
	{
		rv = (p11t_module_funcs->C_CloseSession)((CK_SESSION_HANDLE)-10);
		P11T_CHECK_RV("Invalid session", rv, CKR_SESSION_HANDLE_INVALID);
	}

	if(session_ro != CK_INVALID)
	{
		rv = (p11t_module_funcs->C_CloseSession)(session_ro);
		P11T_CHECK_RV("Normal call", rv, CKR_OK);

		if(p11t_test_unexpected)
		{
			rv = (p11t_module_funcs->C_GetSessionInfo)(session_ro, &info);
			P11T_CHECK_RV("Check open session was closed", rv, CKR_SESSION_HANDLE_INVALID);

			/*
			 * Note that CKR_SESSION_CLOSED is a valid return in this case.
			 * That should only be returned in the rare case when a session
			 * was closed during the execution of a function. A corner case.
			 */

			rv = (p11t_module_funcs->C_CloseSession)(session_ro);
			P11T_CHECK_RV("Close twice", rv, CKR_SESSION_HANDLE_INVALID);
		}
	}

	if(session_rw != CK_INVALID)
	{
		rv = (p11t_module_funcs->C_CloseSession)(session_rw);
		P11T_CHECK_RV("Normal call", rv, CKR_OK);
	}

	P11T_SECTION("C_CloseAllSessions");

	if(p11t_test_unexpected)
	{
		rv = (p11t_module_funcs->C_CloseAllSessions)((CK_SLOT_ID)-34);
		P11T_CHECK_RV("Invalid slot id", rv, CKR_SLOT_ID_INVALID);
	}

	rv = (p11t_module_funcs->C_CloseAllSessions)(slot);
	P11T_CHECK_RV("Normal call", rv, CKR_OK);

	if(p11t_test_unexpected)
	{
		rv = (p11t_module_funcs->C_GetSessionInfo)(session_ro2, &info);
		P11T_CHECK_RV("Check open session was closed", rv, CKR_SESSION_HANDLE_INVALID);

		rv = (p11t_module_funcs->C_CloseAllSessions)(slot);
		P11T_CHECK_RV("Call when no sessions open", rv, CKR_OK);
	}

	return CONTINUE;
}

static int
test_session_pin(CK_SLOT_ID slot)
{
	P11T_SECTION("C_InitPIN");
	P11T_CHECK_NOTE("Not Tested");

	P11T_SECTION("C_SetPIN");
	P11T_CHECK_NOTE("Not Tested");

	return CONTINUE;
}

static int
test_session_operation_state(CK_SLOT_ID slot)
{
	P11T_SECTION("C_GetOperationState");
	P11T_CHECK_NOTE("Not Tested");

	P11T_SECTION("C_SetOperationState");
	P11T_CHECK_NOTE("Not Tested");

	return CONTINUE;
}

void
p11t_session_tests()
{
	CK_ULONG i;

	for(i = 0; i < p11t_slot_count; ++i)
	{
		CK_SLOT_ID slot = p11t_slot_get_id(i);
		test_session_pin(slot);
		test_session_main(slot);
		test_session_user_login(slot);
		test_session_so_login(slot);
		test_session_operation_state(slot);
	}
}

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

CK_SESSION_HANDLE
p11t_session_open(CK_SLOT_ID slot, int readwrite)
{
	CK_SESSION_HANDLE session;
	CK_FLAGS flags;

	assert(p11t_module_funcs);

	flags = CKF_SERIAL_SESSION;
	if(readwrite)
		flags |= CKF_RW_SESSION;

	if((p11t_module_funcs->C_OpenSession)(slot, flags, NULL, NULL, &session) != CKR_OK)
		return CK_INVALID;

	return session;
}

int
p11t_session_login(CK_SESSION_HANDLE session)
{
	CK_SESSION_INFO info;
	CK_UTF8CHAR_PTR pin;
	CK_ULONG n_pin;

	assert(session != CK_INVALID);
	assert(p11t_module_funcs);

	if((p11t_module_funcs->C_GetSessionInfo)(session, &info) != CKR_OK)
		return 0;

	switch(info.state)
	{
	case CKS_RO_USER_FUNCTIONS:
	case CKS_RW_USER_FUNCTIONS:
	case CKS_RW_SO_FUNCTIONS:
		return 1;
	}

	pin = calculate_pin(info.slotID, CKU_USER, &n_pin);
	if((p11t_module_funcs->C_Login)(session, CKU_USER, pin, n_pin) != CKR_OK)
		return 0;

	return 1;
}

int
p11t_session_logout(CK_SESSION_HANDLE session)
{
	CK_SESSION_INFO info;

	assert(session != CK_INVALID);
	assert(p11t_module_funcs);

	if((p11t_module_funcs->C_GetSessionInfo)(session, &info) != CKR_OK)
		return 0;

	switch(info.state)
	{
	case CKS_RO_PUBLIC_SESSION:
	case CKS_RW_PUBLIC_SESSION:
		return 1;
	}

	if((p11t_module_funcs->C_Logout)(session) != CKR_OK)
		return 0;

	return 1;
}

int
p11t_session_close(CK_SESSION_HANDLE session)
{
	CK_RV rv;

	assert(session != CK_INVALID);
	assert(p11t_module_funcs);

	rv = (p11t_module_funcs->C_CloseSession)(session);
	switch(rv)
	{
	case CKR_SESSION_HANDLE_INVALID:
	case CKR_SESSION_CLOSED:
	case CKR_OK:
		return 1;
	default:
		return 0;
	}
}

int
p11t_session_close_all(CK_SLOT_ID slot)
{
	assert(p11t_module_funcs);

	if((p11t_module_funcs->C_CloseAllSessions)(slot) == CKR_OK)
		return 1;
	return 0;
}