Debian Codegraph @

pkcs11/gkm/gkm-session.h

raw
1 /*
2 * gnome-keyring
3 *
4 * Copyright (C) 2008 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 #ifndef __GKM_SESSION_H__
22 #define __GKM_SESSION_H__
23
24 #include <glib-object.h>
25
26 #include "gkm-module.h"
27 #include "gkm-manager.h"
28
29 #define GKM_TYPE_SESSION (gkm_session_get_type ())
30 #define GKM_SESSION(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GKM_TYPE_SESSION, GkmSession))
31 #define GKM_SESSION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GKM_TYPE_SESSION, GkmSessionClass))
32 #define GKM_IS_SESSION(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GKM_TYPE_SESSION))
33 #define GKM_IS_SESSION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GKM_TYPE_SESSION))
34 #define GKM_SESSION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GKM_TYPE_SESSION, GkmSessionClass))
35
36 typedef struct _GkmSessionClass GkmSessionClass;
37 typedef struct _GkmSessionPrivate GkmSessionPrivate;
38
39 struct _GkmSession {
40 GObject parent;
41 GkmSessionPrivate *pv;
42 };
43
44 struct _GkmSessionClass {
45 GObjectClass parent_class;
46
47 #if 0
48 /* signals --------------------------------------------------------- */
49
50 void (*signal) (GkmSession *session);
51 #endif
52 };
53
54 GType gkm_session_get_type (void);
55
56 GkmSession* gkm_session_for_session_object (GkmObject *obj);
57
58 GkmSession* gkm_session_for_session_object (GkmObject *obj);
59
60 CK_SESSION_HANDLE gkm_session_get_handle (GkmSession *self);
61
62 CK_SLOT_ID gkm_session_get_slot_id (GkmSession *self);
63
64 CK_ULONG gkm_session_get_apartment (GkmSession *self);
65
66 GkmModule* gkm_session_get_module (GkmSession *self);
67
68 GkmManager* gkm_session_get_manager (GkmSession *self);
69
70 gboolean gkm_session_is_read_only (GkmSession *self);
71
72 gboolean gkm_session_is_for_application (GkmSession *self);
73
74 gulong gkm_session_get_logged_in (GkmSession *self);
75
76 void gkm_session_set_logged_in (GkmSession *self,
77 gulong logged_in);
78
79 gpointer gkm_session_get_crypto_state (GkmSession *self);
80
81 void gkm_session_set_crypto_state (GkmSession *self,
82 gpointer state,
83 GDestroyNotify destroy);
84
85 GkmCredential* gkm_session_get_credential (GkmSession *self);
86
87 CK_RV gkm_session_lookup_readable_object (GkmSession *self,
88 CK_OBJECT_HANDLE handle,
89 GkmObject **result);
90
91 CK_RV gkm_session_lookup_writable_object (GkmSession *self,
92 CK_OBJECT_HANDLE handle,
93 GkmObject **result);
94
95 CK_RV gkm_session_login_context_specific (GkmSession *self,
96 CK_UTF8CHAR_PTR pin,
97 CK_ULONG n_pin);
98
99 void gkm_session_add_session_object (GkmSession *self,
100 GkmTransaction *transaction,
101 GkmObject *obj);
102
103 void gkm_session_destroy_session_object (GkmSession *self,
104 GkmTransaction *transaction,
105 GkmObject *obj);
106
107 GkmObject* gkm_session_create_object_for_factory (GkmSession *self,
108 GkmFactory *factory,
109 GkmTransaction *transaction,
110 CK_ATTRIBUTE_PTR attrs,
111 CK_ULONG n_attrs);
112
113 GkmObject* gkm_session_create_object_for_attributes (GkmSession *self,
114 GkmTransaction *transaction,
115 CK_ATTRIBUTE_PTR attrs,
116 CK_ULONG n_attrs);
117
118 void gkm_session_complete_object_creation (GkmSession *self,
119 GkmTransaction *transaction,
120 GkmObject *object,
121 gboolean add,
122 CK_ATTRIBUTE_PTR attrs,
123 CK_ULONG n_attrs);
124
125 CK_RV gkm_session_C_GetFunctionStatus (GkmSession *self);
126
127 CK_RV gkm_session_C_CancelFunction (GkmSession *self);
128
129 CK_RV gkm_session_C_GetSessionInfo (GkmSession* self,
130 CK_SESSION_INFO_PTR info);
131
132 CK_RV gkm_session_C_GetOperationState (GkmSession* self,
133 CK_BYTE_PTR operation_state,
134 CK_ULONG_PTR operation_state_len);
135
136 CK_RV gkm_session_C_SetOperationState (GkmSession* self,
137 CK_BYTE_PTR operation_state,
138 CK_ULONG operation_state_len,
139 CK_OBJECT_HANDLE encryption_key,
140 CK_OBJECT_HANDLE authentication_key);
141
142 CK_RV gkm_session_C_CreateObject (GkmSession* self,
143 CK_ATTRIBUTE_PTR template,
144 CK_ULONG count,
145 CK_OBJECT_HANDLE_PTR new_object);
146
147 CK_RV gkm_session_C_CopyObject (GkmSession* self,
148 CK_OBJECT_HANDLE object,
149 CK_ATTRIBUTE_PTR template,
150 CK_ULONG count,
151 CK_OBJECT_HANDLE_PTR new_object);
152
153 CK_RV gkm_session_C_DestroyObject (GkmSession* self,
154 CK_OBJECT_HANDLE object);
155
156 CK_RV gkm_session_C_GetObjectSize (GkmSession* self,
157 CK_OBJECT_HANDLE object,
158 CK_ULONG_PTR size);
159
160 CK_RV gkm_session_C_GetAttributeValue (GkmSession* self,
161 CK_OBJECT_HANDLE handle,
162 CK_ATTRIBUTE_PTR template,
163 CK_ULONG count);
164
165 CK_RV gkm_session_C_SetAttributeValue (GkmSession* self,
166 CK_OBJECT_HANDLE handle,
167 CK_ATTRIBUTE_PTR template,
168 CK_ULONG count);
169
170 CK_RV gkm_session_C_FindObjectsInit (GkmSession* self,
171 CK_ATTRIBUTE_PTR template,
172 CK_ULONG count);
173
174 CK_RV gkm_session_C_FindObjects (GkmSession* self,
175 CK_OBJECT_HANDLE_PTR objects,
176 CK_ULONG max_count,
177 CK_ULONG_PTR count);
178
179 CK_RV gkm_session_C_FindObjectsFinal (GkmSession* self);
180
181 CK_RV gkm_session_C_EncryptInit (GkmSession *self,
182 CK_MECHANISM_PTR mechanism,
183 CK_OBJECT_HANDLE key);
184
185 CK_RV gkm_session_C_Encrypt (GkmSession *self,
186 CK_BYTE_PTR data,
187 CK_ULONG data_len,
188 CK_BYTE_PTR encrypted_data,
189 CK_ULONG_PTR encrypted_data_len);
190
191 CK_RV gkm_session_C_EncryptUpdate (GkmSession *self,
192 CK_BYTE_PTR part,
193 CK_ULONG part_len,
194 CK_BYTE_PTR encrypted_part,
195 CK_ULONG_PTR encrypted_part_len);
196
197 CK_RV gkm_session_C_EncryptFinal (GkmSession *self,
198 CK_BYTE_PTR last_part,
199 CK_ULONG_PTR last_part_len);
200
201 CK_RV gkm_session_C_DecryptInit (GkmSession *self,
202 CK_MECHANISM_PTR mechanism,
203 CK_OBJECT_HANDLE key);
204
205 CK_RV gkm_session_C_Decrypt (GkmSession *self,
206 CK_BYTE_PTR enc_data,
207 CK_ULONG enc_data_len,
208 CK_BYTE_PTR data,
209 CK_ULONG_PTR data_len);
210
211 CK_RV gkm_session_C_DecryptUpdate (GkmSession *self,
212 CK_BYTE_PTR enc_part,
213 CK_ULONG enc_part_len,
214 CK_BYTE_PTR part,
215 CK_ULONG_PTR part_len);
216
217 CK_RV gkm_session_C_DecryptFinal (GkmSession *self,
218 CK_BYTE_PTR last_part,
219 CK_ULONG_PTR last_part_len);
220
221 CK_RV gkm_session_C_DigestInit (GkmSession *self,
222 CK_MECHANISM_PTR mechanism);
223
224 CK_RV gkm_session_C_Digest (GkmSession *self,
225 CK_BYTE_PTR data,
226 CK_ULONG data_len,
227 CK_BYTE_PTR digest,
228 CK_ULONG_PTR digest_len);
229
230 CK_RV gkm_session_C_DigestUpdate (GkmSession *self,
231 CK_BYTE_PTR part,
232 CK_ULONG part_len);
233
234 CK_RV gkm_session_C_DigestKey (GkmSession *self,
235 CK_OBJECT_HANDLE key);
236
237 CK_RV gkm_session_C_DigestFinal (GkmSession *self,
238 CK_BYTE_PTR digest,
239 CK_ULONG_PTR digest_len);
240
241 CK_RV gkm_session_C_SignInit (GkmSession *self,
242 CK_MECHANISM_PTR mechanism,
243 CK_OBJECT_HANDLE key);
244
245 CK_RV gkm_session_C_Sign (GkmSession *self,
246 CK_BYTE_PTR data,
247 CK_ULONG data_len,
248 CK_BYTE_PTR signature,
249 CK_ULONG_PTR signature_len);
250
251 CK_RV gkm_session_C_SignUpdate (GkmSession *self,
252 CK_BYTE_PTR part,
253 CK_ULONG part_len);
254
255 CK_RV gkm_session_C_SignFinal (GkmSession *self,
256 CK_BYTE_PTR signature,
257 CK_ULONG_PTR signature_len);
258
259 CK_RV gkm_session_C_SignRecoverInit (GkmSession *self,
260 CK_MECHANISM_PTR mechanism,
261 CK_OBJECT_HANDLE key);
262
263 CK_RV gkm_session_C_SignRecover (GkmSession *self,
264 CK_BYTE_PTR data,
265 CK_ULONG data_len,
266 CK_BYTE_PTR signature,
267 CK_ULONG_PTR signature_len);
268
269 CK_RV gkm_session_C_VerifyInit (GkmSession *self,
270 CK_MECHANISM_PTR mechanism,
271 CK_OBJECT_HANDLE key);
272
273 CK_RV gkm_session_C_Verify (GkmSession *self,
274 CK_BYTE_PTR data,
275 CK_ULONG data_len,
276 CK_BYTE_PTR signature,
277 CK_ULONG signature_len);
278
279 CK_RV gkm_session_C_VerifyUpdate (GkmSession *self,
280 CK_BYTE_PTR part,
281 CK_ULONG part_len);
282
283 CK_RV gkm_session_C_VerifyFinal (GkmSession *self,
284 CK_BYTE_PTR signature,
285 CK_ULONG signature_len);
286
287 CK_RV gkm_session_C_VerifyRecoverInit (GkmSession *self,
288 CK_MECHANISM_PTR mechanism,
289 CK_OBJECT_HANDLE key);
290
291 CK_RV gkm_session_C_VerifyRecover (GkmSession *self,
292 CK_BYTE_PTR signature,
293 CK_ULONG signature_len,
294 CK_BYTE_PTR data,
295 CK_ULONG_PTR data_len);
296
297 CK_RV gkm_session_C_DigestEncryptUpdate (GkmSession *self,
298 CK_BYTE_PTR part,
299 CK_ULONG part_len,
300 CK_BYTE_PTR enc_part,
301 CK_ULONG_PTR enc_part_len);
302
303 CK_RV gkm_session_C_DecryptDigestUpdate (GkmSession *self,
304 CK_BYTE_PTR enc_part,
305 CK_ULONG enc_part_len,
306 CK_BYTE_PTR part,
307 CK_ULONG_PTR part_len);
308
309 CK_RV gkm_session_C_SignEncryptUpdate (GkmSession *self,
310 CK_BYTE_PTR part,
311 CK_ULONG part_len,
312 CK_BYTE_PTR enc_part,
313 CK_ULONG_PTR enc_part_len);
314
315 CK_RV gkm_session_C_DecryptVerifyUpdate (GkmSession *self,
316 CK_BYTE_PTR enc_part,
317 CK_ULONG enc_part_len,
318 CK_BYTE_PTR part,
319 CK_ULONG_PTR part_len);
320
321 CK_RV gkm_session_C_GenerateKey (GkmSession* self,
322 CK_MECHANISM_PTR mechanism,
323 CK_ATTRIBUTE_PTR template,
324 CK_ULONG count,
325 CK_OBJECT_HANDLE_PTR key);
326
327 CK_RV gkm_session_C_GenerateKeyPair (GkmSession* self,
328 CK_MECHANISM_PTR mechanism,
329 CK_ATTRIBUTE_PTR pub_template,
330 CK_ULONG pub_count,
331 CK_ATTRIBUTE_PTR priv_template,
332 CK_ULONG priv_count,
333 CK_OBJECT_HANDLE_PTR pub_key,
334 CK_OBJECT_HANDLE_PTR priv_key);
335
336 CK_RV gkm_session_C_WrapKey (GkmSession* self,
337 CK_MECHANISM_PTR mechanism,
338 CK_OBJECT_HANDLE wrapping_key,
339 CK_OBJECT_HANDLE key,
340 CK_BYTE_PTR wrapped_key,
341 CK_ULONG_PTR wrapped_key_len);
342
343 CK_RV gkm_session_C_UnwrapKey (GkmSession* self,
344 CK_MECHANISM_PTR mechanism,
345 CK_OBJECT_HANDLE unwrapping_key,
346 CK_BYTE_PTR wrapped_key,
347 CK_ULONG wrapped_key_len,
348 CK_ATTRIBUTE_PTR template,
349 CK_ULONG count,
350 CK_OBJECT_HANDLE_PTR key);
351
352 CK_RV gkm_session_C_DeriveKey (GkmSession* self,
353 CK_MECHANISM_PTR mechanism,
354 CK_OBJECT_HANDLE base_key,
355 CK_ATTRIBUTE_PTR template,
356 CK_ULONG count,
357 CK_OBJECT_HANDLE_PTR key);
358
359 CK_RV gkm_session_C_SeedRandom (GkmSession* self,
360 CK_BYTE_PTR seed,
361 CK_ULONG seed_len);
362
363 CK_RV gkm_session_C_GenerateRandom (GkmSession* self,
364 CK_BYTE_PTR random_data,
365 CK_ULONG random_len);
366
367 #endif /* __GKM_SESSION_H__ */