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
// Copyright 2018-2020 Cargill Incorporated // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. //! Public key information and role-based permissions. //! //! The `keys` module provides interfaces for managing key information and role-based permissions. //! //! Key information, accessed via the `KeyRegistry` interface, is the link between a public key and //! its associated splinter node. This can provide context about a key used to sign messages. //! Additional, optional meta data can be associated with the public key as well. //! //! Key permissions, accessed via the `KeyPermissionManager` interface, are queried through a simple //! role-based access system. The underlying implementation determines how those values are set //! and modified. mod error; pub mod insecure; #[cfg(feature = "rest-api")] pub mod rest_api; pub mod storage; use std::collections::HashMap; use std::fmt; use crate::hex::to_hex; pub use error::{KeyPermissionError, KeyRegistryError}; /// Information associated with a public key. /// /// This struct contains information related to a public key, with the most specific information /// pertaining to the associated splinter node. /// /// It also provides metadata about the key, that maybe provided to the registry for /// application-specific details. For example, the name of the person or organization of the key. #[derive(Clone)] pub struct KeyInfo { public_key: Vec<u8>, associated_node_id: String, metadata: HashMap<String, String>, } impl KeyInfo { /// Build a key info /// /// ``` /// # use splinter::keys::KeyInfo; /// /// let key = KeyInfo::builder(b"some pub key".to_vec(), "my node".into()) /// .with_metadata("username", "Alice") /// .with_metadata("organization", "ACME, Corp") /// .build(); /// /// assert_eq!(b"some pub key", key.public_key()); /// assert_eq!("my node", key.associated_node_id()); /// assert_eq!(Some(&"Alice".into()), key.get_metadata("username")); /// assert_eq!(Some(&"ACME, Corp".into()), key.get_metadata("organization")); /// ``` pub fn builder(public_key: Vec<u8>, associated_node_id: String) -> KeyInfoBuilder { KeyInfoBuilder { public_key, associated_node_id, metadata: HashMap::default(), } } /// The public key. pub fn public_key(&self) -> &[u8] { &self.public_key } /// The associated splinter node. /// /// This could be thought of as the "home node" of this public key. pub fn associated_node_id(&self) -> &str { &self.associated_node_id } /// Get a piece of metadata for the given key. pub fn get_metadata(&self, key: &str) -> Option<&String> { self.metadata.get(key) } /// Get the metadata for the key info pub fn metadata(&self) -> &HashMap<String, String> { &self.metadata } } impl fmt::Debug for KeyInfo { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!( f, r#"KeyInfo {{ public_key: "{}", associated_node_id: {:?}, metadata: {:?} }}"#, to_hex(&self.public_key), &self.associated_node_id, &self.metadata ) } } /// Builder for creating KeyInfo instances. pub struct KeyInfoBuilder { public_key: Vec<u8>, associated_node_id: String, metadata: HashMap<String, String>, } impl KeyInfoBuilder { /// Add a meta data entry. pub fn with_metadata<S: Into<String>>(mut self, key: S, value: S) -> Self { self.metadata.insert(key.into(), value.into()); self } /// Build the key info pub fn build(self) -> KeyInfo { KeyInfo { public_key: self.public_key, associated_node_id: self.associated_node_id, metadata: self.metadata, } } } type KeyRegistryResult<T> = Result<T, KeyRegistryError>; /// A registry of public key information. /// /// The key registry provides an interface for storing and retrieving key information. Key /// information helps to tie a public key to a particular splinter node, as well as associating /// application metadata with the public key. pub trait KeyRegistry: Send + Sync { /// Save a public key and its information. /// /// # Errors /// /// Returns a `KeyRegistryError` if the underling implementation could not save the key /// information. fn save_key(&mut self, key_info: KeyInfo) -> KeyRegistryResult<()>; /// Save a collection of public keys and their information. /// /// # Errors /// /// Returns a `KeyRegistryError` if the underling implementation could not save the key /// information. fn save_keys(&mut self, key_infos: Vec<KeyInfo>) -> KeyRegistryResult<()>; /// Delete a public key and its information. /// /// Returns the existing key information, if it exists. /// /// # Errors /// /// Returns a `KeyRegistryError` if the underling implementation could not delete the key /// information. fn delete_key(&mut self, public_key: &[u8]) -> KeyRegistryResult<Option<KeyInfo>>; /// Return a public key and its information. /// /// Returns the key information, if it exists. /// /// # Errors /// /// Returns a `KeyRegistryError` if the underling implementation could not retrieve the key /// information. fn get_key(&self, public_key: &[u8]) -> KeyRegistryResult<Option<KeyInfo>>; /// Return an iterator over all keys in the registry. /// /// This returns an iterator over the key registry. The iterator allows the underlying /// implementation to stream the results in a lazy fashion, if needed. /// /// # Errors /// /// Returns a `KeyRegistryError` if the underling implementation could not provide the /// iterator. fn keys<'iter, 'a: 'iter>( &'a self, ) -> KeyRegistryResult<Box<dyn Iterator<Item = KeyInfo> + 'iter>>; /// Return the total count of keys in the registry. fn count(&self) -> KeyRegistryResult<usize>; /// Clones this instance and returns a boxed, dynamic version. fn clone_box(&self) -> Box<dyn KeyRegistry>; } impl Clone for Box<dyn KeyRegistry> { fn clone(&self) -> Self { self.clone_box() } } type KeyPermissionResult<T> = Result<T, KeyPermissionError>; /// Manages role-based permissions associated with public keys. /// /// The KeyPermissionManager provides an interface for providing details on whether or not a public /// key has permissions to act in specific roles. /// /// Note: the underlying implementation determines how those values are set and modified - these /// operations are not exposed via this interface. pub trait KeyPermissionManager: Send { /// Checks to see if a public key is permitted for the given role. /// /// # Errors /// /// Returns a `KeyPermissionError` if the underling implementation encountered an error while /// checking the permissions. fn is_permitted(&self, public_key: &[u8], role: &str) -> KeyPermissionResult<bool>; }