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
|
Title: Javascript Examples
Slug: libsecret-js-example
# Javascript 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:
```js
const Secret = imports.gi.Secret;
/* This schema is usually defined once globally */
const EXAMPLE_SCHEMA = new Secret.Schema.new("org.example.Password",
Secret.SchemaFlags.NONE,
{
"number": Secret.SchemaAttributeType.INTEGER,
"string": Secret.SchemaAttributeType.STRING,
"even": Secret.SchemaAttributeType.BOOLEAN,
}
);
```
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.
```js
const Secret = imports.gi.Secret;
function on_password_stored(source, result) {
Secret.password_store_finish(result);
/* ... do something now that the password has been stored */
}
/*
* The attributes used to later lookup the password. These
* attributes should conform to the schema.
*/
var attributes = {
"number": "8",
"string": "eight",
"even": "true"
};
Secret.password_store(EXAMPLE_SCHEMA, attributes, Secret.COLLECTION_DEFAULT,
"The label", "the password", null, on_password_stored);
```
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.
```js
const Secret = imports.gi.Secret;
/*
* The attributes used to later lookup the password. These
* attributes should conform to the schema.
*/
var attributes = {
"number": "9",
"string": "nine",
"even": "false"
};
Secret.password_store_sync(EXAMPLE_SCHEMA, attributes, Secret.COLLECTION_DEFAULT,
"The label", "the password", null);
```
## 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.
```js
const Secret = imports.gi.Secret;
function on_password_lookup(source, result) {
var password = Secret.password_lookup_finish(result);
/* password will be null if no matching password found */
}
/* The attributes used to lookup the password should conform to the schema. */
Secret.password_lookup(EXAMPLE_SCHEMA, { "number": "8", "even": "true" },
null, on_password_lookup);
```
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.
```js
const Secret = imports.gi.Secret;
/* The attributes used to lookup the password should conform to the schema. */
var password = Secret.password_lookup_sync(EXAMPLE_SCHEMA,
{ "number": "8", "even": "true" },
null);
/* password will be null, if no matching password found */
```
## 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.
```js
const Secret = imports.gi.Secret;
function on_password_clear(source, result) {
var removed = Secret.password_clear_finish(result);
/* removed will be true if the password was removed */
}
/* The attributes used to lookup which password to remove should conform to the schema. */
Secret.password_clear(EXAMPLE_SCHEMA, { "number": "8", "even": "true" },
null, on_password_clear);
```
This next example removes a password synchronously. The function
call will block until the removal completes. So this is appropriate for
non GUI applications.
```js
const Secret = imports.gi.Secret;
/* The attributes used to lookup which password to remove should conform to the schema. */
var removed = Secret.password_clear_sync(EXAMPLE_SCHEMA,
{ "number": "8", "even": "true" },
null);
/* removed will be true if the password was removed */
```
|
