-
Notifications
You must be signed in to change notification settings - Fork 28
/
item.rs
412 lines (353 loc) · 13.9 KB
/
item.rs
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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
//Copyright 2022 secret-service-rs Developers
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.
use crate::error::Error;
use crate::proxy::item::ItemProxy;
use crate::proxy::service::ServiceProxy;
use crate::session::decrypt;
use crate::session::Session;
use crate::ss::SS_DBUS_NAME;
use crate::util::{exec_prompt, format_secret, lock_or_unlock, LockAction};
use std::collections::HashMap;
use zbus::{zvariant::OwnedObjectPath, CacheProperties};
pub struct Item<'a> {
conn: zbus::Connection,
session: &'a Session,
pub item_path: OwnedObjectPath,
item_proxy: ItemProxy<'a>,
service_proxy: &'a ServiceProxy<'a>,
}
impl<'a> Item<'a> {
pub(crate) async fn new(
conn: zbus::Connection,
session: &'a Session,
service_proxy: &'a ServiceProxy<'a>,
item_path: OwnedObjectPath,
) -> Result<Item<'a>, Error> {
let item_proxy = ItemProxy::builder(&conn)
.destination(SS_DBUS_NAME)?
.path(item_path.clone())?
.cache_properties(CacheProperties::No)
.build()
.await?;
Ok(Item {
conn,
session,
item_path,
item_proxy,
service_proxy,
})
}
pub async fn is_locked(&self) -> Result<bool, Error> {
Ok(self.item_proxy.locked().await?)
}
pub async fn ensure_unlocked(&self) -> Result<(), Error> {
if self.is_locked().await? {
Err(Error::Locked)
} else {
Ok(())
}
}
pub async fn unlock(&self) -> Result<(), Error> {
lock_or_unlock(
self.conn.clone(),
self.service_proxy,
&self.item_path,
LockAction::Unlock,
)
.await
}
pub async fn lock(&self) -> Result<(), Error> {
lock_or_unlock(
self.conn.clone(),
self.service_proxy,
&self.item_path,
LockAction::Lock,
)
.await
}
pub async fn get_attributes(&self) -> Result<HashMap<String, String>, Error> {
Ok(self.item_proxy.attributes().await?)
}
pub async fn set_attributes(&self, attributes: HashMap<&str, &str>) -> Result<(), Error> {
Ok(self.item_proxy.set_attributes(attributes).await?)
}
pub async fn get_label(&self) -> Result<String, Error> {
Ok(self.item_proxy.label().await?)
}
pub async fn set_label(&self, new_label: &str) -> Result<(), Error> {
Ok(self.item_proxy.set_label(new_label).await?)
}
/// Deletes dbus object, but struct instance still exists (current implementation)
pub async fn delete(&self) -> Result<(), Error> {
// ensure_unlocked handles prompt for unlocking if necessary
self.ensure_unlocked().await?;
let prompt_path = self.item_proxy.delete().await?;
// "/" means no prompt necessary
if prompt_path.as_str() != "/" {
exec_prompt(self.conn.clone(), &prompt_path).await?;
}
Ok(())
}
pub async fn get_secret(&self) -> Result<Vec<u8>, Error> {
let secret_struct = self
.item_proxy
.get_secret(&self.session.object_path)
.await?;
let secret = secret_struct.value;
if let Some(session_key) = self.session.get_aes_key() {
// get "param" (aes_iv) field out of secret struct
let aes_iv = secret_struct.parameters;
// decrypt
let decrypted_secret = decrypt(&secret, session_key, &aes_iv)?;
Ok(decrypted_secret)
} else {
Ok(secret)
}
}
pub async fn get_secret_content_type(&self) -> Result<String, Error> {
let secret_struct = self
.item_proxy
.get_secret(&self.session.object_path)
.await?;
let content_type = secret_struct.content_type;
Ok(content_type)
}
pub async fn set_secret(&self, secret: &[u8], content_type: &str) -> Result<(), Error> {
let secret_struct = format_secret(self.session, secret, content_type)?;
Ok(self.item_proxy.set_secret(secret_struct).await?)
}
pub async fn get_created(&self) -> Result<u64, Error> {
Ok(self.item_proxy.created().await?)
}
pub async fn get_modified(&self) -> Result<u64, Error> {
Ok(self.item_proxy.modified().await?)
}
/// Returns if an item is equal to `other`.
///
/// This is the equivalent of the `PartialEq` trait, but `async`.
pub async fn equal_to(&self, other: &Item<'_>) -> Result<bool, Error> {
let this_attrs = self.get_attributes().await?;
let other_attrs = other.get_attributes().await?;
Ok(self.item_path == other.item_path && this_attrs == other_attrs)
}
}
#[cfg(test)]
mod test {
use crate::*;
async fn create_test_default_item<'a>(collection: &'a Collection<'_>) -> Item<'a> {
collection
.create_item("Test", HashMap::new(), b"test", false, "text/plain")
.await
.unwrap()
}
#[tokio::test]
async fn should_create_and_delete_item() {
let ss = SecretService::connect(EncryptionType::Plain).await.unwrap();
let collection = ss.get_default_collection().await.unwrap();
let item = create_test_default_item(&collection).await;
item.delete().await.unwrap();
// Random operation to prove that path no longer exists
if item.get_label().await.is_ok() {
panic!("item still existed");
}
}
#[tokio::test]
async fn should_check_if_item_locked() {
let ss = SecretService::connect(EncryptionType::Plain).await.unwrap();
let collection = ss.get_default_collection().await.unwrap();
let item = create_test_default_item(&collection).await;
item.is_locked().await.unwrap();
item.delete().await.unwrap();
}
#[tokio::test]
#[ignore]
async fn should_lock_and_unlock() {
let ss = SecretService::connect(EncryptionType::Plain).await.unwrap();
let collection = ss.get_default_collection().await.unwrap();
let item = create_test_default_item(&collection).await;
let locked = item.is_locked().await.unwrap();
if locked {
item.unlock().await.unwrap();
item.ensure_unlocked().await.unwrap();
assert!(!item.is_locked().await.unwrap());
item.lock().await.unwrap();
assert!(item.is_locked().await.unwrap());
} else {
item.lock().await.unwrap();
assert!(item.is_locked().await.unwrap());
item.unlock().await.unwrap();
item.ensure_unlocked().await.unwrap();
assert!(!item.is_locked().await.unwrap());
}
item.delete().await.unwrap();
}
#[tokio::test]
async fn should_get_and_set_item_label() {
let ss = SecretService::connect(EncryptionType::Plain).await.unwrap();
let collection = ss.get_default_collection().await.unwrap();
let item = create_test_default_item(&collection).await;
// Set label to test and check
item.set_label("Tester").await.unwrap();
let label = item.get_label().await.unwrap();
assert_eq!(label, "Tester");
item.delete().await.unwrap();
}
#[tokio::test]
async fn should_create_with_item_attributes() {
let ss = SecretService::connect(EncryptionType::Plain).await.unwrap();
let collection = ss.get_default_collection().await.unwrap();
let item = collection
.create_item(
"Test",
HashMap::from([("test_attributes_in_item", "test")]),
b"test",
false,
"text/plain",
)
.await
.unwrap();
let attributes = item.get_attributes().await.unwrap();
// We do not compare exact attributes, since the secret service provider could add its own
// at any time. Instead, we only check that the ones we provided are returned back.
assert_eq!(
attributes
.get("test_attributes_in_item")
.map(String::as_str),
Some("test")
);
item.delete().await.unwrap();
}
#[tokio::test]
async fn should_get_and_set_item_attributes() {
let ss = SecretService::connect(EncryptionType::Plain).await.unwrap();
let collection = ss.get_default_collection().await.unwrap();
let item = create_test_default_item(&collection).await;
// Also test empty array handling
item.set_attributes(HashMap::new()).await.unwrap();
item.set_attributes(HashMap::from([("test_attributes_in_item_get", "test")]))
.await
.unwrap();
let attributes = item.get_attributes().await.unwrap();
// We do not compare exact attributes, since the secret service provider could add its own
// at any time. Instead, we only check that the ones we provided are returned back.
assert_eq!(
attributes
.get("test_attributes_in_item_get")
.map(String::as_str),
Some("test")
);
item.delete().await.unwrap();
}
#[tokio::test]
async fn should_get_modified_created_props() {
let ss = SecretService::connect(EncryptionType::Plain).await.unwrap();
let collection = ss.get_default_collection().await.unwrap();
let item = create_test_default_item(&collection).await;
item.set_label("Tester").await.unwrap();
let _created = item.get_created().await.unwrap();
let _modified = item.get_modified().await.unwrap();
item.delete().await.unwrap();
}
#[tokio::test]
async fn should_create_and_get_secret() {
let ss = SecretService::connect(EncryptionType::Plain).await.unwrap();
let collection = ss.get_default_collection().await.unwrap();
let item = create_test_default_item(&collection).await;
let secret = item.get_secret().await.unwrap();
item.delete().await.unwrap();
assert_eq!(secret, b"test");
}
#[tokio::test]
async fn should_create_and_get_secret_encrypted() {
let ss = SecretService::connect(EncryptionType::Dh).await.unwrap();
let collection = ss.get_default_collection().await.unwrap();
let item = create_test_default_item(&collection).await;
let secret = item.get_secret().await.unwrap();
item.delete().await.unwrap();
assert_eq!(secret, b"test");
}
#[tokio::test]
async fn should_get_secret_content_type() {
let ss = SecretService::connect(EncryptionType::Plain).await.unwrap();
let collection = ss.get_default_collection().await.unwrap();
let item = create_test_default_item(&collection).await;
let content_type = item.get_secret_content_type().await.unwrap();
item.delete().await.unwrap();
assert_eq!(content_type, "text/plain".to_owned());
}
#[tokio::test]
async fn should_set_secret() {
let ss = SecretService::connect(EncryptionType::Plain).await.unwrap();
let collection = ss.get_default_collection().await.unwrap();
let item = create_test_default_item(&collection).await;
item.set_secret(b"new_test", "text/plain").await.unwrap();
let secret = item.get_secret().await.unwrap();
item.delete().await.unwrap();
assert_eq!(secret, b"new_test");
}
#[tokio::test]
async fn should_create_encrypted_item() {
let ss = SecretService::connect(EncryptionType::Dh).await.unwrap();
let collection = ss.get_default_collection().await.unwrap();
let item = collection
.create_item(
"Test",
HashMap::new(),
b"test_encrypted",
false,
"text/plain",
)
.await
.expect("Error on item creation");
let secret = item.get_secret().await.unwrap();
item.delete().await.unwrap();
assert_eq!(secret, b"test_encrypted");
}
#[tokio::test]
async fn should_create_encrypted_item_from_empty_secret() {
//empty string
let ss = SecretService::connect(EncryptionType::Dh).await.unwrap();
let collection = ss.get_default_collection().await.unwrap();
let item = collection
.create_item("Test", HashMap::new(), b"", false, "text/plain")
.await
.expect("Error on item creation");
let secret = item.get_secret().await.unwrap();
item.delete().await.unwrap();
assert_eq!(secret, b"");
}
#[tokio::test]
async fn should_get_encrypted_secret_across_dbus_connections() {
{
let ss = SecretService::connect(EncryptionType::Dh).await.unwrap();
let collection = ss.get_default_collection().await.unwrap();
let item = collection
.create_item(
"Test",
HashMap::from([("test_attributes_in_item_encrypt", "test")]),
b"test_encrypted",
false,
"text/plain",
)
.await
.expect("Error on item creation");
let secret = item.get_secret().await.unwrap();
assert_eq!(secret, b"test_encrypted");
}
{
let ss = SecretService::connect(EncryptionType::Dh).await.unwrap();
let collection = ss.get_default_collection().await.unwrap();
let search_item = collection
.search_items(HashMap::from([("test_attributes_in_item_encrypt", "test")]))
.await
.unwrap();
let item = search_item.first().unwrap();
assert_eq!(item.get_secret().await.unwrap(), b"test_encrypted");
item.delete().await.unwrap();
}
}
}