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
|
Title: C Examples
Slug: libsecret-c-example
# C Examples
## Define a password schema
Each stored password has a set of attributes which are later
used to lookup the password. The names and types of the attributes
are defined in a schema. The schema is usually defined once globally.
Here's how to define a schema:
```c
// in a header:
const SecretSchema * example_get_schema (void) G_GNUC_CONST;
#define EXAMPLE_SCHEMA example_get_schema ()
// in a .c file:
const SecretSchema *
example_get_schema (void)
{
static const SecretSchema the_schema = {
"org.example.Password", SECRET_SCHEMA_NONE,
{
{ "number", SECRET_SCHEMA_ATTRIBUTE_INTEGER },
{ "string", SECRET_SCHEMA_ATTRIBUTE_STRING },
{ "even", SECRET_SCHEMA_ATTRIBUTE_BOOLEAN },
{ "NULL", 0 },
}
};
return &the_schema;
}
```
See the [other examples](#store-a-password) for how to use the schema.
## Store a password
Here's how to store a password in the running secret service,
like gnome-keyring or ksecretservice.
Each stored password has a set of attributes which are later
used to lookup the password. The attributes should not contain
secrets, as they are not stored in an encrypted fashion.
These examples use the [example schema](#define-a-password-schema).
This first example stores a password asynchronously, and is
appropriate for GUI applications so that the UI does not block.
```c
static void
on_password_stored (GObject *source,
GAsyncResult *result,
gpointer unused)
{
GError *error = NULL;
secret_password_store_finish (result, &error);
if (error != NULL) {
/* ... handle the failure here */
g_error_free (error);
} else {
/* ... do something now that the password has been stored */
}
}
/*
* The variable argument list is the attributes used to later
* lookup the password. These attributes must conform to the schema.
*/
secret_password_store (EXAMPLE_SCHEMA, SECRET_COLLECTION_DEFAULT, "The label",
"the password", NULL, on_password_stored, NULL,
"number", 8,
"string", "eight",
"even", TRUE,
NULL);
```
This next example stores a password synchronously. The function
call will block until the password is stored. So this is appropriate for
non GUI applications.
```c
GError *error = NULL;
/*
* The variable argument list is the attributes used to later
* lookup the password. These attributes must conform to the schema.
*/
secret_password_store_sync (EXAMPLE_SCHEMA, SECRET_COLLECTION_DEFAULT,
"The label", "the password", NULL, &error,
"number", 9,
"string", "nine",
"even", FALSE,
NULL);
if (error != NULL) {
/* ... handle the failure here */
g_error_free (error);
} else {
/* ... do something now that the password has been stored */
}
```
## Lookup a password
Here's how to lookup a password in the running secret service,
like gnome-keyring or ksecretservice.
Each stored password has a set of attributes which are
used to lookup the password. If multiple passwords match the
lookup attributes, then the one stored most recently is returned.
These examples use the [example schema](#define-a-password-schema).
This first example looks up a password asynchronously, and is
appropriate for GUI applications so that the UI does not block.
```c
static void
on_password_lookup (GObject *source,
GAsyncResult *result,
gpointer unused)
{
GError *error = NULL;
gchar *password = secret_password_lookup_finish (result, &error);
if (error != NULL) {
/* ... handle the failure here */
g_error_free (error);
} else if (password == NULL) {
/* password will be null, if no matching password found */
} else {
/* ... do something with the password */
secret_password_free (password);
}
}
/*
* The variable argument list is the attributes used to later
* lookup the password. These attributes must conform to the schema.
*/
secret_password_lookup (EXAMPLE_SCHEMA, NULL, on_password_lookup, NULL,
"string", "nine",
"even", FALSE,
NULL);
```
This next example looks up a password synchronously. The function
call will block until the lookup completes. So this is appropriate for
non GUI applications.
```c
GError *error = NULL;
/* The attributes used to lookup the password should conform to the schema. */
gchar *password = secret_password_lookup_sync (EXAMPLE_SCHEMA, NULL, &error,
"string", "nine",
"even", FALSE,
NULL);
if (error != NULL) {
/* ... handle the failure here */
g_error_free (error);
} else if (password == NULL) {
/* password will be null, if no matching password found */
} else {
/* ... do something with the password */
secret_password_free (password);
}
```
## Remove a password
Here's how to remove a password from the running secret service,
like gnome-keyring or ksecretservice.
Each stored password has a set of attributes which are
used to find which password to remove. If multiple passwords match the
attributes, then the one stored most recently is removed.
These examples use the [example schema](#define-a-password-schema).
This first example removes a password asynchronously, and is
appropriate for GUI applications so that the UI does not block.
```c
static void
on_password_cleared (GObject *source,
GAsyncResult *result,
gpointer unused)
{
GError *error = NULL;
gboolean removed = secret_password_clear_finish (result, &error);
if (error != NULL) {
/* ... handle the failure here */
g_error_free (error);
} else {
/* removed will be TRUE if a password was removed */
}
}
/*
* The variable argument list is the attributes used to later
* lookup the password. These attributes must conform to the schema.
*/
secret_password_clear (EXAMPLE_SCHEMA, NULL, on_password_cleared, NULL,
"string", "nine",
"even", FALSE,
NULL);
```
This next example looks up a password synchronously. The function
call will block until the lookup completes. So this is appropriate for
non GUI applications.
```c
GError *error = NULL;
/*
* The variable argument list is the attributes used to later
* lookup the password. These attributes must conform to the schema.
*/
gboolean removed = secret_password_clear_sync (EXAMPLE_SCHEMA, NULL, &error,
"string", "nine",
"even", FALSE,
NULL);
if (error != NULL) {
/* ... handle the failure here */
g_error_free (error);
} else {
/* removed will be TRUE if a password was removed */
}
```
|
