blueprint-keystore 0.2.0-alpha.10

Keystore for Tangle Blueprints
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

//! Backing storage implementations for local keystores

use crate::error::Result;
use blueprint_crypto::{BytesEncoding, KeyType, KeyTypeId};
use blueprint_std::{boxed::Box, vec::Vec};
use serde::de::DeserializeOwned;

#[cfg(feature = "std")]
mod fs;
#[cfg(feature = "std")]
pub use fs::FileStorage;
mod in_memory;
pub use in_memory::InMemoryStorage;
// Raw storage trait that can be made into a trait object
#[allow(missing_docs, clippy::missing_errors_doc)]
pub trait RawStorage: Send + Sync {
    fn store_raw(
        &self,
        type_id: KeyTypeId,
        public_bytes: Vec<u8>,
        secret_bytes: Vec<u8>,
    ) -> Result<()>;
    fn load_secret_raw(
        &self,
        type_id: KeyTypeId,
        public_bytes: Vec<u8>,
    ) -> Result<Option<Box<[u8]>>>;
    fn remove_raw(&self, type_id: KeyTypeId, public_bytes: Vec<u8>) -> Result<()>;
    fn contains_raw(&self, type_id: KeyTypeId, public_bytes: Vec<u8>) -> bool;
    fn list_raw(&self, type_id: KeyTypeId) -> Box<dyn Iterator<Item = Box<[u8]>> + '_>;
}

// Type-safe wrapper around raw storage
pub struct TypedStorage<S: RawStorage> {
    storage: S,
}

// Occurs when no features are enabled
#[cfg_attr(
    not(any(
        feature = "ecdsa",
        feature = "sr25519-schnorrkel",
        feature = "zebra",
        feature = "bls",
        feature = "bn254"
    )),
    allow(unreachable_code, unused_variables, unused_mut)
)]
#[allow(missing_docs, clippy::missing_errors_doc)]
impl<S: RawStorage> TypedStorage<S> {
    pub fn new(storage: S) -> Self {
        Self { storage }
    }

    pub fn store<T: KeyType>(&self, public: &T::Public, secret: &T::Secret) -> Result<()> {
        let public_bytes = public.to_bytes();
        let secret_bytes = secret.to_bytes();
        self.storage
            .store_raw(T::key_type_id(), public_bytes, secret_bytes)
    }

    pub fn load<T: KeyType>(&self, public: &T::Public) -> Result<Option<T::Secret>>
    where
        T::Secret: DeserializeOwned,
    {
        let public_bytes = public.to_bytes();
        match self
            .storage
            .load_secret_raw(T::key_type_id(), public_bytes)?
        {
            Some(secret_bytes) => {
                let secret = T::Secret::from_bytes(&secret_bytes)?;
                Ok(Some(secret))
            }
            None => Ok(None),
        }
    }

    pub fn remove<T: KeyType>(&self, public: &T::Public) -> Result<()> {
        let public_bytes = public.to_bytes();
        self.storage.remove_raw(T::key_type_id(), public_bytes)
    }

    pub fn contains<T: KeyType>(&self, public: &T::Public) -> bool {
        self.storage
            .contains_raw(T::key_type_id(), public.to_bytes())
    }

    pub fn list<T: KeyType>(&self) -> impl Iterator<Item = T::Public> + '_
    where
        T::Public: DeserializeOwned,
    {
        self.storage
            .list_raw(T::key_type_id())
            .filter_map(move |bytes| T::Public::from_bytes(&bytes).ok())
    }
}