Debian Codegraph @

pkcs11/gkm/gkm-manager.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_MANAGER_H__
22 #define __GKM_MANAGER_H__
23
24 #include <gcrypt.h>
25 #include <glib-object.h>
26
27 #include "gkm-object.h"
28
29 /*
30 * GkmManager
31 *
32 * A GkmManager tracks a set of GkmObject objects. It does not own
33 * those objects. Once an object is registered with the manager it gets
34 * an identifier.
35 *
36 * An object will unregister itself from the manager when it is destroyed or
37 * it can be done explicitely.
38 *
39 * A singleton GkmManager exists for token objects, those stored in
40 * persistent storage. This manager lasts for the lifetime of the daemon.
41 *
42 * Other GkmManager objects can exist per client for session or
43 * temporary objects. Multiple requests for a manager for the same client
44 * will return the same manager. Once all references dissappear this
45 * manager will go away.
46 */
47
48 G_BEGIN_DECLS
49
50 #include <glib-object.h>
51
52 #include "gkm-types.h"
53
54 #include "pkcs11/pkcs11.h"
55
56 #define GKM_TYPE_MANAGER (gkm_manager_get_type ())
57 #define GKM_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GKM_TYPE_MANAGER, GkmManager))
58 #define GKM_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GKM_TYPE_MANAGER, GkmManager))
59 #define GKM_IS_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GKM_TYPE_MANAGER))
60 #define GKM_IS_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GKM_TYPE_MANAGER))
61 #define GKM_MANAGER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GKM_TYPE_MANAGER, GkmManagerClass))
62
63 typedef struct _GkmManagerClass GkmManagerClass;
64 typedef struct _GkmManagerPrivate GkmManagerPrivate;
65
66 struct _GkmManager {
67 GObject parent;
68 GkmManagerPrivate *pv;
69 };
70
71 struct _GkmManagerClass {
72 GObjectClass parent_class;
73
74 /* signals */
75
76 void (*object_added) (GkmManager *self, GkmObject *object);
77
78 void (*object_removed) (GkmManager *self, GkmObject *object);
79
80 void (*attribute_changed) (GkmManager *self, GkmObject *object, CK_ATTRIBUTE_TYPE type);
81 };
82
83 GType gkm_manager_get_type (void) G_GNUC_CONST;
84
85 GkmManager* gkm_manager_for_template (CK_ATTRIBUTE_PTR attrs,
86 CK_ULONG n_attrs,
87 GkmSession *session);
88
89 gboolean gkm_manager_get_for_token (GkmManager *self);
90
91 void gkm_manager_add_attribute_index (GkmManager *self,
92 CK_ATTRIBUTE_TYPE attr,
93 gboolean unique);
94
95 void gkm_manager_add_property_index (GkmManager *self,
96 const gchar *property,
97 gboolean unique);
98
99 GkmObject* gkm_manager_find_by_handle (GkmManager *self,
100 CK_OBJECT_HANDLE obj);
101
102 GList* gkm_manager_find_by_number_property (GkmManager *self,
103 const gchar *property,
104 gulong value);
105
106 GkmObject* gkm_manager_find_one_by_number_property (GkmManager *self,
107 const gchar *property,
108 gulong value);
109
110 GList* gkm_manager_find_by_string_property (GkmManager *self,
111 const gchar *property,
112 const gchar *value);
113
114 GkmObject* gkm_manager_find_one_by_string_property (GkmManager *self,
115 const gchar *property,
116 const gchar *value);
117
118 GList* gkm_manager_find_by_attributes (GkmManager *self,
119 GkmSession *session,
120 CK_ATTRIBUTE_PTR template,
121 CK_ULONG n_attrs);
122
123 GList* gkm_manager_find_by_class (GkmManager *self,
124 GkmSession *session,
125 CK_OBJECT_CLASS klass);
126
127 GkmObject* gkm_manager_find_one_by_attributes (GkmManager *self,
128 GkmSession *session,
129 CK_ATTRIBUTE_PTR template,
130 CK_ULONG n_attrs);
131
132 GkmObject* gkm_manager_find_related (GkmManager *self,
133 GkmSession *session,
134 CK_OBJECT_CLASS klass,
135 GkmObject *related_to);
136
137 CK_RV gkm_manager_find_handles (GkmManager *self,
138 GkmSession *session,
139 gboolean include_private,
140 CK_ATTRIBUTE_PTR template,
141 CK_ULONG count,
142 GArray *found);
143
144 G_END_DECLS
145
146 #endif /* __GKM_MANAGER_H__ */