Merge pull request #152 from hug-dev/key_info

Rename key ID to key info

Author: ionut-arm

Cargo.lock

@@ -18,7 +18,7 @@ name = "parsec"
 path = "src/bin/main.rs"
 
 [dependencies]
-parsec-interface = "0.13.0"
+parsec-interface = "0.14.0"
 rand = "0.7.2"
 base64 = "0.10.1"
 uuid = "0.7.4"
@@ -45,8 +45,8 @@ picky-asn1-der = "0.2.2"
 picky-asn1 = "0.2.1"
 serde = { version = "1.0", features = ["derive"] }
 sha2 = "0.8.1"
-parsec-client = "0.1.0"
-parsec-interface = { version = "0.13.0", features = ["testing"] }
+parsec-client = "0.2.0"
+parsec-interface = { version = "0.14.0", features = ["testing"] }
 
 [build-dependencies]
 bindgen = "0.50.0"

Cargo.toml

@@ -30,13 +30,13 @@ listener_type = "DomainSocket"
 # timeout expires, the connection is dropped.
 timeout = 200 # in milliseconds
 
-# (Required) Configuration for the components managing key IDs for providers.
+# (Required) Configuration for the components managing key info for providers.
 # Defined as an array of tables: https://github.com/toml-lang/toml#user-content-array-of-tables
 [[key_manager]]
-# (Required) Name of the key ID manager. Used to tie providers to the manager supporting them.
+# (Required) Name of the key info manager. Used to tie providers to the manager supporting them.
 name = "on-disk-manager"
 
-# (Required) Type of key ID manager to be used.
+# (Required) Type of key info manager to be used.
 manager_type = "OnDisk"
 
 # Path to the location where the mapping will be persisted (in this case, the filesystem path)
@@ -48,13 +48,13 @@ manager_type = "OnDisk"
 # (Required) Type of provider.
 provider_type = "MbedCrypto"
 
-# (Required) Name of key ID manager that will support this provider.
-key_id_manager = "on-disk-manager"
+# (Required) Name of key info manager that will support this provider.
+key_info_manager = "on-disk-manager"
 
 # Example of a PKCS 11 provider configuration
 #[[provider]]
 #provider_type = "Pkcs11"
-#key_id_manager = "on-disk-manager"
+#key_info_manager = "on-disk-manager"
 # (Required for this provider) Path to the location of the dynamic library loaded by this provider.
 # For the PKCS 11 provider, this library implements the PKCS 11 API on the target platform.
 #library_path = "/usr/local/lib/softhsm/libsofthsm2.so"
@@ -67,7 +67,7 @@ key_id_manager = "on-disk-manager"
 # Example of a TPM provider configuration
 #[[provider]]
 #provider_type = "Tpm"
-#key_id_manager = "on-disk-manager"
+#key_info_manager = "on-disk-manager"
 # (Required) TPM TCTI device to use with this provider. Options are:
 # - "device": uses the TPM device on /dev/tpm0
 # - "mssim": uses the simulation TPM with the socket

config.toml

@@ -10,16 +10,16 @@ manager_type = "OnDisk"
 
 [[provider]]
 provider_type = "MbedProvider"
-key_id_manager = "on-disk-manager"
+key_info_manager = "on-disk-manager"
 
 [[provider]]
 provider_type = "TpmProvider"
-key_id_manager = "on-disk-manager"
+key_info_manager = "on-disk-manager"
 tcti = "mssim"
 
 [[provider]]
 provider_type = "Pkcs11Provider"
-key_id_manager = "on-disk-manager"
+key_info_manager = "on-disk-manager"
 library_path = "/usr/local/lib/softhsm/libsofthsm2.so"
 user_pin = "123456"
 # The slot_number mandatory field is going to be added by the find_slot_number.sh script

fuzz/config.toml

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 //! Persistent mapping between key triples and key information
 //!
-//! This module declares a [`ManageKeyIDs`](https://parallaxsecond.github.io/parsec-book/parsec_service/key_id_managers.html)
+//! This module declares a [`ManageKeyInfo`](https://parallaxsecond.github.io/parsec-book/parsec_service/key_info_managers.html)
 //! trait to help providers to store in a persistent manner the mapping between the name and the
 //! information of the keys they manage. Different implementors might store this mapping using different
 //! means but it has to be persistent.
@@ -17,14 +17,14 @@ use std::fmt;
 pub mod on_disk_manager;
 
 #[derive(Copy, Clone, Deserialize, Debug)]
-pub enum KeyIdManagerType {
+pub enum KeyInfoManagerType {
     OnDisk,
 }
 
 #[derive(Deserialize, Debug)]
-pub struct KeyIdManagerConfig {
+pub struct KeyInfoManagerConfig {
     pub name: String,
-    pub manager_type: KeyIdManagerType,
+    pub manager_type: KeyInfoManagerType,
     pub store_path: Option<String>,
 }
 
@@ -72,41 +72,41 @@ impl KeyTriple {
     }
 }
 
-/// Converts the error string returned by the ManageKeyIDs methods to
-/// ResponseStatus::KeyIDManagerError.
+/// Converts the error string returned by the ManageKeyInfo methods to
+/// ResponseStatus::KeyInfoManagerError.
 pub fn to_response_status(error_string: String) -> ResponseStatus {
     error!(
-        "Converting error string \"{}\" to ResponseStatus:KeyIDManagerError.",
+        "Converting error string \"{}\" to ResponseStatus:KeyInfoManagerError.",
         error_string
     );
-    ResponseStatus::KeyIDManagerError
+    ResponseStatus::KeyInfoManagerError
 }
 
 /// Management interface for key name to key info mapping
 ///
 /// Interface to be implemented for persistent storage of key name -> key info mappings.
-pub trait ManageKeyIDs {
+pub trait ManageKeyInfo {
     /// Returns a reference to the key info corresponding to this key triple or `None` if it does not
     /// exist.
     ///
     /// # Errors
     ///
-    /// Returns an error as a String if there was a problem accessing the Key ID Manager.
+    /// Returns an error as a String if there was a problem accessing the Key Info Manager.
     fn get(&self, key_triple: &KeyTriple) -> Result<Option<&KeyInfo>, String>;
 
     /// Returns a Vec of reference to the key triples corresponding to this provider.
     ///
     /// # Errors
     ///
-    /// Returns an error as a String if there was a problem accessing the Key ID Manager.
+    /// Returns an error as a String if there was a problem accessing the Key Info Manager.
     fn get_all(&self, provider_id: ProviderID) -> Result<Vec<&KeyTriple>, String>;
 
     /// Inserts a new mapping between the key triple and the key info. If the triple already exists,
     /// overwrite the existing mapping and returns the old `KeyInfo`. Otherwise returns `None`.
     ///
     /// # Errors
     ///
-    /// Returns an error as a String if there was a problem accessing the Key ID Manager.
+    /// Returns an error as a String if there was a problem accessing the Key Info Manager.
     fn insert(
         &mut self,
         key_triple: KeyTriple,
@@ -118,13 +118,13 @@ pub trait ManageKeyIDs {
     ///
     /// # Errors
     ///
-    /// Returns an error as a String if there was a problem accessing the Key ID Manager.
+    /// Returns an error as a String if there was a problem accessing the Key Info Manager.
     fn remove(&mut self, key_triple: &KeyTriple) -> Result<Option<KeyInfo>, String>;
 
     /// Check if a key triple mapping exists.
     ///
     /// # Errors
     ///
-    /// Returns an error as a String if there was a problem accessing the Key ID Manager.
+    /// Returns an error as a String if there was a problem accessing the Key Info Manager.
     fn exists(&self, key_triple: &KeyTriple) -> Result<bool, String>;
 }

src/key_id_managers/mod.rs renamed to src/key_info_managers/mod.rs

@@ -1,6 +1,6 @@
 // Copyright 2019 Contributors to the Parsec project.
 // SPDX-License-Identifier: Apache-2.0
-//! A key ID manager storing key triple to key info mapping on files on disk
+//! A key info manager storing key triple to key info mapping on files on disk
 //!
 //! The path where the mappings should be stored is configurable. Because of possible data races,
 //! there should not be two instances of this manager pointing to the same mapping folder at a time.
@@ -12,7 +12,7 @@
 //! example, for operating systems having a limit of 255 characters for filenames (Unix systems),
 //! names will be limited to 188 bytes of UTF-8 characters.
 //! For security reasons, only the PARSEC service should have the ability to modify these files.
-use super::{KeyInfo, KeyTriple, ManageKeyIDs};
+use super::{KeyInfo, KeyTriple, ManageKeyInfo};
 use crate::authenticators::ApplicationName;
 use log::{error, info};
 use parsec_interface::requests::ProviderID;
@@ -27,7 +27,7 @@ use std::path::PathBuf;
 pub const DEFAULT_MAPPINGS_PATH: &str = "./mappings";
 
 #[derive(Debug)]
-pub struct OnDiskKeyIDManager {
+pub struct OnDiskKeyInfoManager {
     /// Internal mapping, used for non-modifying operations.
     key_store: HashMap<KeyTriple, KeyInfo>,
     /// Folder where all the key triple to key info mappings are saved. This folder will be created
@@ -145,11 +145,11 @@ fn list_files(path: &PathBuf) -> std::io::Result<Vec<PathBuf>> {
         .collect())
 }
 
-/// Filesystem-based `KeyIdManager`
+/// Filesystem-based `KeyInfoManager`
 ///
-/// The `OnDiskKeyIdManager` relies on access control mechanisms provided by the OS for
+/// The `OnDiskKeyInfoManager` relies on access control mechanisms provided by the OS for
 /// the filesystem to ensure security of the mappings.
-impl OnDiskKeyIDManager {
+impl OnDiskKeyInfoManager {
     /// Creates an instance of the on-disk manager from the mapping files. This function will
     /// create the mappings directory if it does not already exist.
     /// The mappings folder is composed of three levels: two levels of directory and one level
@@ -178,7 +178,7 @@ impl OnDiskKeyIDManager {
     /// # Errors
     ///
     /// Returns an std::io error if the function failed reading the mapping files.
-    fn new(mappings_dir_path: PathBuf) -> std::io::Result<OnDiskKeyIDManager> {
+    fn new(mappings_dir_path: PathBuf) -> std::io::Result<OnDiskKeyInfoManager> {
         let mut key_store = HashMap::new();
 
         // Will ignore if the mappings directory already exists.
@@ -217,7 +217,7 @@ impl OnDiskKeyIDManager {
             }
         }
 
-        Ok(OnDiskKeyIDManager {
+        Ok(OnDiskKeyInfoManager {
             key_store,
             mappings_dir_path,
         })
@@ -262,7 +262,7 @@ impl OnDiskKeyIDManager {
     }
 }
 
-impl ManageKeyIDs for OnDiskKeyIDManager {
+impl ManageKeyInfo for OnDiskKeyInfoManager {
     fn get(&self, key_triple: &KeyTriple) -> Result<Option<&KeyInfo>, String> {
         // An Option<&Vec<u8>> can not automatically coerce to an Option<&[u8]>, it needs to be
         // done by hand.
@@ -309,25 +309,25 @@ impl ManageKeyIDs for OnDiskKeyIDManager {
 }
 
 #[derive(Debug, Default)]
-pub struct OnDiskKeyIDManagerBuilder {
+pub struct OnDiskKeyInfoManagerBuilder {
     mappings_dir_path: Option<PathBuf>,
 }
 
-impl OnDiskKeyIDManagerBuilder {
-    pub fn new() -> OnDiskKeyIDManagerBuilder {
-        OnDiskKeyIDManagerBuilder {
+impl OnDiskKeyInfoManagerBuilder {
+    pub fn new() -> OnDiskKeyInfoManagerBuilder {
+        OnDiskKeyInfoManagerBuilder {
             mappings_dir_path: None,
         }
     }
 
-    pub fn with_mappings_dir_path(mut self, path: PathBuf) -> OnDiskKeyIDManagerBuilder {
+    pub fn with_mappings_dir_path(mut self, path: PathBuf) -> OnDiskKeyInfoManagerBuilder {
         self.mappings_dir_path = Some(path);
 
         self
     }
 
-    pub fn build(self) -> std::io::Result<OnDiskKeyIDManager> {
-        OnDiskKeyIDManager::new(self.mappings_dir_path.ok_or_else(|| {
+    pub fn build(self) -> std::io::Result<OnDiskKeyInfoManager> {
+        OnDiskKeyInfoManager::new(self.mappings_dir_path.ok_or_else(|| {
             error!("Mappings directory path is missing");
             Error::new(ErrorKind::InvalidData, "mappings directory path is missing")
         })?)
@@ -336,8 +336,8 @@ impl OnDiskKeyIDManagerBuilder {
 
 #[cfg(test)]
 mod test {
-    use super::super::{KeyInfo, KeyTriple, ManageKeyIDs};
-    use super::OnDiskKeyIDManager;
+    use super::super::{KeyInfo, KeyTriple, ManageKeyInfo};
+    use super::OnDiskKeyInfoManager;
     use crate::authenticators::ApplicationName;
     use parsec_interface::operations::psa_algorithm::{Algorithm, AsymmetricSignature, Hash};
     use parsec_interface::operations::psa_key_attributes::{
@@ -381,11 +381,11 @@ mod test {
     }
 
     #[test]
-    fn insert_get_key_id() {
-        let path = PathBuf::from(env!("OUT_DIR").to_owned() + "/insert_get_key_id_mappings");
-        let mut manager = OnDiskKeyIDManager::new(path.clone()).unwrap();
+    fn insert_get_key_info() {
+        let path = PathBuf::from(env!("OUT_DIR").to_owned() + "/insert_get_key_info_mappings");
+        let mut manager = OnDiskKeyInfoManager::new(path.clone()).unwrap();
 
-        let key_triple = new_key_triple("insert_get_key_id".to_string());
+        let key_triple = new_key_triple("insert_get_key_info".to_string());
         let key_info = test_key_info();
 
         assert!(manager.get(&key_triple).unwrap().is_none());
@@ -409,7 +409,7 @@ mod test {
     #[test]
     fn insert_remove_key() {
         let path = PathBuf::from(env!("OUT_DIR").to_owned() + "/insert_remove_key_mappings");
-        let mut manager = OnDiskKeyIDManager::new(path.clone()).unwrap();
+        let mut manager = OnDiskKeyInfoManager::new(path.clone()).unwrap();
 
         let key_triple = new_key_triple("insert_remove_key".to_string());
         let key_info = test_key_info();
@@ -423,7 +423,7 @@ mod test {
     #[test]
     fn remove_unexisting_key() {
         let path = PathBuf::from(env!("OUT_DIR").to_owned() + "/remove_unexisting_key_mappings");
-        let mut manager = OnDiskKeyIDManager::new(path.clone()).unwrap();
+        let mut manager = OnDiskKeyInfoManager::new(path.clone()).unwrap();
 
         let key_triple = new_key_triple("remove_unexisting_key".to_string());
         assert_eq!(manager.remove(&key_triple).unwrap(), None);
@@ -433,7 +433,7 @@ mod test {
     #[test]
     fn exists() {
         let path = PathBuf::from(env!("OUT_DIR").to_owned() + "/exists_mappings");
-        let mut manager = OnDiskKeyIDManager::new(path.clone()).unwrap();
+        let mut manager = OnDiskKeyInfoManager::new(path.clone()).unwrap();
 
         let key_triple = new_key_triple("exists".to_string());
         let key_info = test_key_info();
@@ -451,7 +451,7 @@ mod test {
     #[test]
     fn insert_overwrites() {
         let path = PathBuf::from(env!("OUT_DIR").to_owned() + "/insert_overwrites_mappings");
-        let mut manager = OnDiskKeyIDManager::new(path.clone()).unwrap();
+        let mut manager = OnDiskKeyInfoManager::new(path.clone()).unwrap();
 
         let key_triple = new_key_triple("insert_overwrites".to_string());
         let key_info_1 = test_key_info();
@@ -479,7 +479,7 @@ mod test {
     #[test]
     fn big_names_ascii() {
         let path = PathBuf::from(env!("OUT_DIR").to_owned() + "/big_names_ascii_mappings");
-        let mut manager = OnDiskKeyIDManager::new(path.clone()).unwrap();
+        let mut manager = OnDiskKeyInfoManager::new(path.clone()).unwrap();
 
         let big_app_name_ascii = ApplicationName::new("  Lorem ipsum dolor sit amet, ei suas viris sea, deleniti repudiare te qui. Natum paulo decore ut nec, ne propriae offendit adipisci has. Eius clita legere mel at, ei vis minimum tincidunt.".to_string());
         let big_key_name_ascii = "  Lorem ipsum dolor sit amet, ei suas viris sea, deleniti repudiare te qui. Natum paulo decore ut nec, ne propriae offendit adipisci has. Eius clita legere mel at, ei vis minimum tincidunt.".to_string();
@@ -497,7 +497,7 @@ mod test {
     #[test]
     fn big_names_emoticons() {
         let path = PathBuf::from(env!("OUT_DIR").to_owned() + "/big_names_emoticons_mappings");
-        let mut manager = OnDiskKeyIDManager::new(path.clone()).unwrap();
+        let mut manager = OnDiskKeyInfoManager::new(path.clone()).unwrap();
 
         let big_app_name_emoticons = ApplicationName::new("😀😁😂😃😄😅😆😇😈😉😊😋😌😍😎😏😐😑😒😓😔😕😖😗😘😙😚😛😜😝😞😟😠😡😢😣😤😥😦😧😨😩😪😫😬😭😮".to_string());
         let big_key_name_emoticons = "😀😁😂😃😄😅😆😇😈😉😊😋😌😍😎😏😐😑😒😓😔😕😖😗😘😙😚😛😜😝😞😟😠😡😢😣😤😥😦😧😨😩😪😫😬😭😮".to_string();
@@ -541,7 +541,7 @@ mod test {
             attributes: test_key_attributes(),
         };
         {
-            let mut manager = OnDiskKeyIDManager::new(path.clone()).unwrap();
+            let mut manager = OnDiskKeyInfoManager::new(path.clone()).unwrap();
 
             let _ = manager
                 .insert(key_triple1.clone(), key_info1.clone())
@@ -555,7 +555,7 @@ mod test {
         }
         // The local hashmap is dropped when leaving the inner scope.
         {
-            let mut manager = OnDiskKeyIDManager::new(path.clone()).unwrap();
+            let mut manager = OnDiskKeyInfoManager::new(path.clone()).unwrap();
 
             assert_eq!(manager.remove(&key_triple1).unwrap().unwrap(), key_info1);
             assert_eq!(manager.remove(&key_triple2).unwrap().unwrap(), key_info2);