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

#include "config.h"

#include "p11-tests.h"

#include <string.h>

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

void
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;

	/** C_GetSessionInfo */

	if(p11t_test_unexpected)
	{
		/** - Invalid session */
		rv = (p11t_module_funcs->C_GetSessionInfo)((CK_SESSION_HANDLE)-33, &info);
		p11t_check_returns("C_GetSessionInfo: with invalid session", rv, CKR_SESSION_HANDLE_INVALID);

		/** - NULL arguments */
		rv = (p11t_module_funcs->C_GetSessionInfo)(session, NULL);
		p11t_check_returns("C_GetSessionInfo: with null", rv, CKR_ARGUMENTS_BAD);
	}

	/** - Valid call */
	rv = (p11t_module_funcs->C_GetSessionInfo)(session, &info);
	if(!p11t_check_returns("C_GetSessionInfo", rv, CKR_OK))
		return;

	/** - Valid slot id */
	p11t_check_ulong("CK_SESSION_INFO.slotID", info.slotID, slot);

	/** - Valid state for session */
	p11t_check_ulong("CK_SESSION_INFO.state", info.state, state);

	/** - Valid flags for session */
	p11t_check_flag("CK_SESSION_INFO.flags", info.flags, flags);
}

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 = strlen(pin);

	return (CK_UTF8CHAR_PTR)pin;
}

void
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_returns("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_returns("C_Login: open RW session", rv, CKR_OK);

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

	/** C_Login */

	if(p11t_test_unexpected)
	{
		/** - Invalid session */
		rv = (p11t_module_funcs->C_Login)((CK_ULONG)-55, CKU_USER, pin, n_pin);
		p11t_check_returns("C_Login: invalid session", rv, CKR_SESSION_HANDLE_INVALID);

		/** - Invalid user type */
		rv = (p11t_module_funcs->C_Login)(session_ro, CK_INVALID, pin, n_pin);
		p11t_check_returns("C_Login: invalid user type", rv, CKR_USER_TYPE_INVALID);
	}

	/** - Normal login */
	rv = (p11t_module_funcs->C_Login)(session_ro, CKU_USER, pin, n_pin);
	if(rv == CKR_USER_TYPE_INVALID)
		return;
	if(!p11t_check_returns("C_Login", rv, CKR_OK))
		return;

	/** - Login changes all session state */
	session_info(session_ro, slot, CKF_SERIAL_SESSION, CKS_RO_USER_FUNCTIONS);
	session_info(session_rw, slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, CKS_RW_USER_FUNCTIONS);

	/** C_Logout */

	if(p11t_test_unexpected)
	{
		/** - Invalid session */
		rv = (p11t_module_funcs->C_Logout)((CK_ULONG)-55);
		p11t_check_returns("C_Logout: invalid session", rv, CKR_SESSION_HANDLE_INVALID);
	}

	/** - Normal logout */
	rv = (p11t_module_funcs->C_Logout)(session_rw);
	p11t_check_returns("C_Logout", rv, CKR_OK);

	/** - Logout changes all session state */
	session_info(session_ro, slot, CKF_SERIAL_SESSION, CKS_RO_PUBLIC_SESSION);
	session_info(session_rw, slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, CKS_RW_PUBLIC_SESSION);
}

void
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_returns("C_OpenSession: open RW session", rv, CKR_OK);

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

	/** C_Login */

	if(p11t_test_unexpected)
	{
		rv = (p11t_module_funcs->C_OpenSession)(slot, CKF_SERIAL_SESSION, NULL, NULL, &session_ro);
		p11t_check_returns("C_OpenSession: open RO session because SO", rv, CKR_OK);

		/** - Login as SO not allowed with RO session */
		rv = (p11t_module_funcs->C_Login)(session_ro, CKU_SO, pin, n_pin);
		p11t_check_returns("C_Login: with RO as SO", rv, CKR_SESSION_READ_ONLY_EXISTS);

		rv = (p11t_module_funcs->C_CloseSession)(session_ro);
		p11t_check_returns("C_CloseSession: close RO session because SO", rv, CKR_OK);
	}

	/** - Login as SO */
	rv = (p11t_module_funcs->C_Login)(session_rw, CKU_SO, pin, n_pin);
	if(rv == CKR_USER_TYPE_INVALID)
		return;
	if(!p11t_check_returns("C_Login: as SO", rv, CKR_OK))
		return;

	/** - Login changes all session state */
	session_info(session_rw, slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, CKS_RW_SO_FUNCTIONS);

	if(p11t_test_unexpected)
	{
		/** - Can't open RO session when logged in as SO */
		rv = (p11t_module_funcs->C_OpenSession)(slot, CKF_SERIAL_SESSION, NULL, NULL, &session_ro);
		p11t_check_returns("C_OpenSession: open RO when SO logged in", rv, CKR_SESSION_READ_WRITE_SO_EXISTS);
	}

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

	/** - Logout SO changes goes back to public */
	session_info(session_rw, slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, CKS_RW_PUBLIC_SESSION);
}

void
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);

	/** C_OpenSession */

	if(p11t_test_unexpected)
	{
		/** - Invalid slot */
		rv = (p11t_module_funcs->C_OpenSession)((CK_SLOT_ID)-5, CKF_SERIAL_SESSION, NULL, NULL, &session_ro);
		p11t_check_returns("C_OpenSession: with invalid slot", rv, CKR_SLOT_ID_INVALID);

		/** - Null arguments */
		rv = (p11t_module_funcs->C_OpenSession)(slot, CKF_SERIAL_SESSION, NULL, NULL, NULL);
		p11t_check_returns("C_OpenSession: with invalid slot", rv, CKR_ARGUMENTS_BAD);

		/** - No flags */
		rv = (p11t_module_funcs->C_OpenSession)(slot, 0, NULL, NULL, &session_ro);
		p11t_check_returns("C_OpenSession: with 0 flags", rv, CKR_SESSION_PARALLEL_NOT_SUPPORTED);

		/** - Without serial flag */
		rv = (p11t_module_funcs->C_OpenSession)(slot, CKF_RW_SESSION, NULL, NULL, &session_ro);
		p11t_check_returns("C_OpenSession: with RW flags", rv, CKR_SESSION_PARALLEL_NOT_SUPPORTED);
	}

	/** - Valid flags */
	rv = (p11t_module_funcs->C_OpenSession)(slot, CKF_SERIAL_SESSION, NULL, NULL, &session_ro);
	p11t_check_returns("C_OpenSession: with serial flags", rv, CKR_OK);
	rv = (p11t_module_funcs->C_OpenSession)(slot, CKF_SERIAL_SESSION, NULL, NULL, &session_ro2);
	p11t_check_returns("C_OpenSession: with serial flags", rv, CKR_OK);

	/** - Read write session */
	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_returns("C_OpenSession: with read write flags", rv, CKR_OK);

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

	/** C_CloseSession */

	if(p11t_test_unexpected)
	{
		/** - Invalid session */
		rv = (p11t_module_funcs->C_CloseSession)((CK_SESSION_HANDLE)-10);
		p11t_check_returns("C_CloseSession: invalid handle", rv, CKR_SESSION_HANDLE_INVALID);
	}

	if(session_ro != CK_INVALID)
	{
		/** - Normal call */
		rv = (p11t_module_funcs->C_CloseSession)(session_ro);
		p11t_check_returns("C_CloseSession: valid", rv, CKR_OK);

		if(p11t_test_unexpected)
		{
			/** - Check open session was closed */
			rv = (p11t_module_funcs->C_GetSessionInfo)(session_ro, &info);
			p11t_check_returns("C_GetSessionInfo: after close", rv, CKR_SESSION_HANDLE_INVALID);

			/** - Close twice */

			/*
			 * 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_returns("C_CloseSession: valid", rv, CKR_SESSION_HANDLE_INVALID);
		}
	}

	if(session_rw != CK_INVALID)
	{
		rv = (p11t_module_funcs->C_CloseSession)(session_rw);
		p11t_check_returns("C_CloseSession: read write", rv, CKR_OK);
	}

	/** C_CloseAllSessions */

	if(p11t_test_unexpected)
	{
		/** - Invalid slot id */
		rv = (p11t_module_funcs->C_CloseAllSessions)((CK_SLOT_ID)-34);
		p11t_check_returns("C_CloseAllSessions: invalid slot", rv, CKR_SLOT_ID_INVALID);
	}

	/** - Normal call */
	rv = (p11t_module_funcs->C_CloseAllSessions)(slot);
	p11t_check_returns("C_CloseAllSessions", rv, CKR_OK);

	if(p11t_test_unexpected)
	{
		/** - Check open session was closed */
		rv = (p11t_module_funcs->C_GetSessionInfo)(session_ro2, &info);
		p11t_check_returns("C_GetSessionInfo: after close all", rv, CKR_SESSION_HANDLE_INVALID);

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

void
session_pin(CK_SLOT_ID slot)
{
	/** C_InitPIN */

	/** - Not Implemented */

	/** C_SetPIN */

	/** - Not Implemented */
}

void
session_operation_state(CK_SLOT_ID slot)
{
	/** C_GetOperationState */

	/** - Not Implemented */

	/** C_SetOperationState */

	/** - Not Implemented */
}

void
p11t_session_tests()
{
	CK_ULONG i;

	for(i = 0; i < p11t_slot_count; ++i)
	{
		CK_SLOT_ID slot = p11t_slot_ids[i];
		session_pin(slot);
		session_main(slot);
		session_user_login(slot);
		session_so_login(slot);
	}
}

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;
}