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
|
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
/* p11-rpc-private.h - various ids and signatures for our protocol
Copyright (C) 2008, Stef Walter
The Gnome Keyring Library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.
The Gnome Keyring Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with the Gnome Library; see the file COPYING.LIB. If not,
write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
Author: Stef Walter <stef@memberwebs.com>
*/
#ifndef GCK_RPC_CALLS_H
#define GCK_RPC_CALLS_H
#include "config.h"
#include <stdlib.h>
#include <stdarg.h>
#include "egg/egg-buffer.h"
#include "pkcs11/pkcs11.h"
/* Whether to print debug output or not */
#define DEBUG_OUTPUT 0
/* The calls, must be in sync with array below */
enum {
GCK_RPC_CALL_ERROR = 0,
GCK_RPC_CALL_C_Initialize,
GCK_RPC_CALL_C_Finalize,
GCK_RPC_CALL_C_GetInfo,
GCK_RPC_CALL_C_GetSlotList,
GCK_RPC_CALL_C_GetSlotInfo,
GCK_RPC_CALL_C_GetTokenInfo,
GCK_RPC_CALL_C_GetMechanismList,
GCK_RPC_CALL_C_GetMechanismInfo,
GCK_RPC_CALL_C_InitToken,
GCK_RPC_CALL_C_WaitForSlotEvent,
GCK_RPC_CALL_C_OpenSession,
GCK_RPC_CALL_C_CloseSession,
GCK_RPC_CALL_C_CloseAllSessions,
GCK_RPC_CALL_C_GetFunctionStatus,
GCK_RPC_CALL_C_CancelFunction,
GCK_RPC_CALL_C_GetSessionInfo,
GCK_RPC_CALL_C_InitPIN,
GCK_RPC_CALL_C_SetPIN,
GCK_RPC_CALL_C_GetOperationState,
GCK_RPC_CALL_C_SetOperationState,
GCK_RPC_CALL_C_Login,
GCK_RPC_CALL_C_Logout,
GCK_RPC_CALL_C_CreateObject,
GCK_RPC_CALL_C_CopyObject,
GCK_RPC_CALL_C_DestroyObject,
GCK_RPC_CALL_C_GetObjectSize,
GCK_RPC_CALL_C_GetAttributeValue,
GCK_RPC_CALL_C_SetAttributeValue,
GCK_RPC_CALL_C_FindObjectsInit,
GCK_RPC_CALL_C_FindObjects,
GCK_RPC_CALL_C_FindObjectsFinal,
GCK_RPC_CALL_C_EncryptInit,
GCK_RPC_CALL_C_Encrypt,
GCK_RPC_CALL_C_EncryptUpdate,
GCK_RPC_CALL_C_EncryptFinal,
GCK_RPC_CALL_C_DecryptInit,
GCK_RPC_CALL_C_Decrypt,
GCK_RPC_CALL_C_DecryptUpdate,
GCK_RPC_CALL_C_DecryptFinal,
GCK_RPC_CALL_C_DigestInit,
GCK_RPC_CALL_C_Digest,
GCK_RPC_CALL_C_DigestUpdate,
GCK_RPC_CALL_C_DigestKey,
GCK_RPC_CALL_C_DigestFinal,
GCK_RPC_CALL_C_SignInit,
GCK_RPC_CALL_C_Sign,
GCK_RPC_CALL_C_SignUpdate,
GCK_RPC_CALL_C_SignFinal,
GCK_RPC_CALL_C_SignRecoverInit,
GCK_RPC_CALL_C_SignRecover,
GCK_RPC_CALL_C_VerifyInit,
GCK_RPC_CALL_C_Verify,
GCK_RPC_CALL_C_VerifyUpdate,
GCK_RPC_CALL_C_VerifyFinal,
GCK_RPC_CALL_C_VerifyRecoverInit,
GCK_RPC_CALL_C_VerifyRecover,
GCK_RPC_CALL_C_DigestEncryptUpdate,
GCK_RPC_CALL_C_DecryptDigestUpdate,
GCK_RPC_CALL_C_SignEncryptUpdate,
GCK_RPC_CALL_C_DecryptVerifyUpdate,
GCK_RPC_CALL_C_GenerateKey,
GCK_RPC_CALL_C_GenerateKeyPair,
GCK_RPC_CALL_C_WrapKey,
GCK_RPC_CALL_C_UnwrapKey,
GCK_RPC_CALL_C_DeriveKey,
GCK_RPC_CALL_C_SeedRandom,
GCK_RPC_CALL_C_GenerateRandom,
GCK_RPC_CALL_MAX
};
typedef struct _GckRpcCall {
int call_id;
const char* name;
const char* request;
const char* response;
} GckRpcCall;
/*
* a_ = prefix denotes array of _
* A = CK_ATTRIBUTE
* f_ = prefix denotes buffer for _
* M = CK_MECHANISM
* u = CK_ULONG
* s = space padded string
* v = CK_VERSION
* y = CK_BYTE
* z = null terminated string
*/
static const GckRpcCall gck_rpc_calls[] = {
{ GCK_RPC_CALL_ERROR, "ERROR", NULL, NULL },
{ GCK_RPC_CALL_C_Initialize, "C_Initialize", "ay", "" },
{ GCK_RPC_CALL_C_Finalize, "C_Finalize", "", "" },
{ GCK_RPC_CALL_C_GetInfo, "C_GetInfo", "", "vsusv" },
{ GCK_RPC_CALL_C_GetSlotList, "C_GetSlotList", "yfu", "au" },
{ GCK_RPC_CALL_C_GetSlotInfo, "C_GetSlotInfo", "u", "ssuvv" },
{ GCK_RPC_CALL_C_GetTokenInfo, "C_GetTokenInfo", "u", "ssssuuuuuuuuuuuvvs" },
{ GCK_RPC_CALL_C_GetMechanismList, "C_GetMechanismList", "ufu", "au" },
{ GCK_RPC_CALL_C_GetMechanismInfo, "C_GetMechanismInfo", "uu", "uuu" },
{ GCK_RPC_CALL_C_InitToken, "C_InitToken", "uayz", "" },
{ GCK_RPC_CALL_C_WaitForSlotEvent, "C_WaitForSlotEvent", "u", "u" },
{ GCK_RPC_CALL_C_OpenSession, "C_OpenSession", "uu", "u" },
{ GCK_RPC_CALL_C_CloseSession, "C_CloseSession", "u", "" },
{ GCK_RPC_CALL_C_CloseAllSessions, "C_CloseAllSessions", "u", "" },
{ GCK_RPC_CALL_C_GetFunctionStatus, "C_GetFunctionStatus", "u", "" },
{ GCK_RPC_CALL_C_CancelFunction, "C_CancelFunction", "u", "" },
{ GCK_RPC_CALL_C_GetSessionInfo, "C_GetSessionInfo", "u", "uuuu" },
{ GCK_RPC_CALL_C_InitPIN, "C_InitPIN", "uay", "" },
{ GCK_RPC_CALL_C_SetPIN, "C_SetPIN", "uayay", "" },
{ GCK_RPC_CALL_C_GetOperationState, "C_GetOperationState", "ufy", "ay" },
{ GCK_RPC_CALL_C_SetOperationState, "C_SetOperationState", "uayuu", "" },
{ GCK_RPC_CALL_C_Login, "C_Login", "uuay", "" },
{ GCK_RPC_CALL_C_Logout, "C_Logout", "u", "" },
{ GCK_RPC_CALL_C_CreateObject, "C_CreateObject", "uaA", "u" },
{ GCK_RPC_CALL_C_CopyObject, "C_CopyObject", "uuaA", "u" },
{ GCK_RPC_CALL_C_DestroyObject, "C_DestroyObject", "uu", "" },
{ GCK_RPC_CALL_C_GetObjectSize, "C_GetObjectSize", "uu", "u" },
{ GCK_RPC_CALL_C_GetAttributeValue, "C_GetAttributeValue", "uufA", "aAu" },
{ GCK_RPC_CALL_C_SetAttributeValue, "C_SetAttributeValue", "uuaA", "" },
{ GCK_RPC_CALL_C_FindObjectsInit, "C_FindObjectsInit", "uaA", "" },
{ GCK_RPC_CALL_C_FindObjects, "C_FindObjects", "ufu", "au" },
{ GCK_RPC_CALL_C_FindObjectsFinal, "C_FindObjectsFinal", "u", "" },
{ GCK_RPC_CALL_C_EncryptInit, "C_EncryptInit", "uMu", "" },
{ GCK_RPC_CALL_C_Encrypt, "C_Encrypt", "uayfy", "ay" },
{ GCK_RPC_CALL_C_EncryptUpdate, "C_EncryptUpdate", "uayfy", "ay" },
{ GCK_RPC_CALL_C_EncryptFinal, "C_EncryptFinal", "ufy", "ay" },
{ GCK_RPC_CALL_C_DecryptInit, "C_DecryptInit", "uMu", "" },
{ GCK_RPC_CALL_C_Decrypt, "C_Decrypt", "uayfy", "ay" },
{ GCK_RPC_CALL_C_DecryptUpdate, "C_DecryptUpdate", "uayfy", "ay" },
{ GCK_RPC_CALL_C_DecryptFinal, "C_DecryptFinal", "ufy", "ay" },
{ GCK_RPC_CALL_C_DigestInit, "C_DigestInit", "uM", "" },
{ GCK_RPC_CALL_C_Digest, "C_Digest", "uayfy", "ay" },
{ GCK_RPC_CALL_C_DigestUpdate, "C_DigestUpdate", "uay", "" },
{ GCK_RPC_CALL_C_DigestKey, "C_DigestKey", "uu", "" },
{ GCK_RPC_CALL_C_DigestFinal, "C_DigestFinal", "ufy", "ay" },
{ GCK_RPC_CALL_C_SignInit, "C_SignInit", "uMu", "" },
{ GCK_RPC_CALL_C_Sign, "C_Sign", "uayfy", "ay" },
{ GCK_RPC_CALL_C_SignUpdate, "C_SignUpdate", "uay", "" },
{ GCK_RPC_CALL_C_SignFinal, "C_SignFinal", "ufy", "ay" },
{ GCK_RPC_CALL_C_SignRecoverInit, "C_SignRecoverInit", "uMu", "" },
{ GCK_RPC_CALL_C_SignRecover, "C_SignRecover", "uayfy", "ay" },
{ GCK_RPC_CALL_C_VerifyInit, "C_VerifyInit", "uMu", "" },
{ GCK_RPC_CALL_C_Verify, "C_Verify", "uayay", "" },
{ GCK_RPC_CALL_C_VerifyUpdate, "C_VerifyUpdate", "uay", "" },
{ GCK_RPC_CALL_C_VerifyFinal, "C_VerifyFinal", "uay", "" },
{ GCK_RPC_CALL_C_VerifyRecoverInit, "C_VerifyRecoverInit", "uMu", "" },
{ GCK_RPC_CALL_C_VerifyRecover, "C_VerifyRecover", "uayfy", "ay" },
{ GCK_RPC_CALL_C_DigestEncryptUpdate, "C_DigestEncryptUpdate", "uayfy", "ay" },
{ GCK_RPC_CALL_C_DecryptDigestUpdate, "C_DecryptDigestUpdate", "uayfy", "ay" },
{ GCK_RPC_CALL_C_SignEncryptUpdate, "C_SignEncryptUpdate", "uayfy", "ay" },
{ GCK_RPC_CALL_C_DecryptVerifyUpdate, "C_DecryptVerifyUpdate", "uayfy", "ay" },
{ GCK_RPC_CALL_C_GenerateKey, "C_GenerateKey", "uMaA", "u" },
{ GCK_RPC_CALL_C_GenerateKeyPair, "C_GenerateKeyPair", "uMaAaA", "uu" },
{ GCK_RPC_CALL_C_WrapKey, "C_WrapKey", "uMuufy", "ay" },
{ GCK_RPC_CALL_C_UnwrapKey, "C_UnwrapKey", "uMuayaA", "u" },
{ GCK_RPC_CALL_C_DeriveKey, "C_DeriveKey", "uMuaA", "u" },
{ GCK_RPC_CALL_C_SeedRandom, "C_SeedRandom", "uay", "" },
{ GCK_RPC_CALL_C_GenerateRandom, "C_GenerateRandom", "ufy", "ay" },
};
#ifdef _DEBUG
#define GCK_RPC_CHECK_CALLS() \
{ int i; for (i = 0; i < GCK_RPC_CALL_MAX; ++i) assert (gck_rpc_calls[i].call_id == i); }
#endif
#define GCK_RPC_HANDSHAKE \
((unsigned char*)"PRIVATE-GNOME-KEYRING-PKCS11-PROTOCOL-V-1")
#define GCK_RPC_HANDSHAKE_LEN \
(sizeof (GCK_RPC_HANDSHAKE) - 1)
#define GCK_RPC_SOCKET_EXT "pkcs11"
typedef enum _GckRpcMessageType {
GCK_RPC_REQUEST = 1,
GCK_RPC_RESPONSE
} GckRpcMessageType;
typedef struct _GckRpcMessage {
int call_id;
GckRpcMessageType call_type;
const char *signature;
EggBuffer buffer;
size_t parsed;
const char *sigverify;
} GckRpcMessage;
GckRpcMessage* gck_rpc_message_new (EggBufferAllocator allocator);
void gck_rpc_message_free (GckRpcMessage *msg);
void gck_rpc_message_reset (GckRpcMessage *msg);
int gck_rpc_message_equals (GckRpcMessage *m1,
GckRpcMessage *m2);
#define gck_rpc_message_is_verified(msg) (!(msg)->sigverify || (msg)->sigverify[0] == 0)
#define gck_rpc_message_buffer_error(msg) (egg_buffer_has_error(&(msg)->buffer))
int gck_rpc_message_prep (GckRpcMessage *msg,
int call_id,
GckRpcMessageType type);
int gck_rpc_message_parse (GckRpcMessage *msg,
GckRpcMessageType type);
int gck_rpc_message_verify_part (GckRpcMessage *msg,
const char* part);
int gck_rpc_message_write_byte (GckRpcMessage *msg,
CK_BYTE val);
int gck_rpc_message_write_ulong (GckRpcMessage *msg,
CK_ULONG val);
int gck_rpc_message_write_zero_string (GckRpcMessage *msg,
CK_UTF8CHAR* string);
int gck_rpc_message_write_space_string (GckRpcMessage *msg,
CK_UTF8CHAR* buffer,
CK_ULONG length);
int gck_rpc_message_write_byte_buffer (GckRpcMessage *msg,
CK_ULONG count);
int gck_rpc_message_write_byte_array (GckRpcMessage *msg,
CK_BYTE_PTR arr,
CK_ULONG num);
int gck_rpc_message_write_ulong_buffer (GckRpcMessage *msg,
CK_ULONG count);
int gck_rpc_message_write_ulong_array (GckRpcMessage *msg,
CK_ULONG_PTR arr,
CK_ULONG num);
int gck_rpc_message_write_attribute_buffer (GckRpcMessage *msg,
CK_ATTRIBUTE_PTR arr,
CK_ULONG num);
int gck_rpc_message_write_attribute_array (GckRpcMessage *msg,
CK_ATTRIBUTE_PTR arr,
CK_ULONG num);
int gck_rpc_message_write_version (GckRpcMessage *msg,
CK_VERSION* version);
int gck_rpc_message_read_byte (GckRpcMessage *msg,
CK_BYTE* val);
int gck_rpc_message_read_ulong (GckRpcMessage *msg,
CK_ULONG* val);
int gck_rpc_message_read_space_string (GckRpcMessage *msg,
CK_UTF8CHAR* buffer,
CK_ULONG length);
int gck_rpc_message_read_version (GckRpcMessage *msg,
CK_VERSION* version);
void gck_rpc_log (const char *line);
void gck_rpc_warn (const char* msg, ...);
void gck_rpc_debug (const char* msg, ...);
#ifdef G_DISABLE_ASSERT
#define assert(x)
#else
#include <assert.h>
#endif
/*
* PKCS#11 mechanism parameters are not easy to serialize. They're
* completely different for so many mechanisms, they contain
* pointers to arbitrary memory, and many callers don't initialize
* them completely or properly.
*
* We only support certain mechanisms.
*
* Also callers do yucky things like leaving parts of the structure
* pointing to garbage if they don't think it's going to be used.
*/
int gck_rpc_mechanism_is_supported (CK_MECHANISM_TYPE mech);
void gck_rpc_mechanism_list_purge (CK_MECHANISM_TYPE_PTR mechs, CK_ULONG_PTR n_mechs);
int gck_rpc_mechanism_has_sane_parameters (CK_MECHANISM_TYPE type);
int gck_rpc_mechanism_has_no_parameters (CK_MECHANISM_TYPE mech);
#endif /* GCK_RPC_CALLS_H */
|
