KeyBoxen 0.1.0

Standalone secret-service daemon for window managers
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

// Copyright (C) 2022 KeyBoxen Authors
// SPDX-License-Identifier: GPL-3.0-or-later

//! DBus transaction data
//!
//! This module implements the data structures that are exchanged over
//! the DBus with the clients.

use serde::{Deserialize, Serialize};
use zbus::zvariant::{OwnedObjectPath, Type};
use zbus::DBusError;

/// DBus secret object
///
/// Item [secrets][ch02] that are exchanged over the DBus in response to
/// GetSecrets RPC call. The `value` may be encrypted, based on
/// algorithms and keys agreed upon session initiation and contained
/// in the session object. The data description is available in the
/// [API spec][ch14.sec].
///
/// [ch02]: https://specifications.freedesktop.org/secret-service/latest/ch02.html
/// [ch14.sec]: https://specifications.freedesktop.org/secret-service/latest/ch14.html#type-Secret
#[derive(Serialize, Deserialize, Type)]
pub struct DBusSecret {
    session: OwnedObjectPath,
    parameters: Vec<u8>,
    value: Vec<u8>,
    content_type: String,
}

/// Dbus Errors
///
/// Errors that are raised by the Secret Service over DBus, often as
/// responses to failed RPC invocations. Some errors are standard
/// [DBus Errors]. Others are specific [Secrets Errors][ch15].
///
/// [DBus Errors]: https://gitlab.freedesktop.org/dbus/dbus/-/blob/b30c2c293d6c599adafca5b82cb7df6351ca2fa1/dbus/dbus-protocol.h#L352
/// [ch15]: https://specifications.freedesktop.org/secret-service/latest/ch15.html
#[derive(DBusError, Debug)]
#[dbus_error(prefix = "org.freedesktop")]
pub enum DBusErrorKind {
    /// Unknown or fall-through ZBus error.
    #[dbus_error(zbus_error)]
    ZBus(zbus::Error),

    /// Algorithm is not supported
    #[dbus_error(name = "DBus.Error.NotSupported")]
    NotSupported(String),

    /// The object must be unlocked before this action can be carried out
    #[dbus_error(name = "Secret.Error.IsLocked")]
    IsLocked(String),

    /// The session does not exist
    #[dbus_error(name = "Secret.Error.NoSession")]
    NoSession(String),

    /// No such item or collection exists
    #[dbus_error(name = "Secret.Error.NoSuchObject")]
    NoSuchObject(String),
}