Merge pull request #263 from samwell61/master

Refactored provider names

Author: ionut-arm

src/providers/core_provider/mod.rs renamed to src/providers/core/mod.rs

@@ -34,7 +34,7 @@ const SUPPORTED_OPCODES: [Opcode; 4] = [
 /// available.
 #[derive(Derivative)]
 #[derivative(Debug)]
-pub struct CoreProvider {
+pub struct Provider {
     wire_protocol_version_min: u8,
     wire_protocol_version_maj: u8,
     provider_info: Vec<ProviderInfo>,
@@ -44,7 +44,7 @@ pub struct CoreProvider {
     prov_list: Vec<Arc<dyn Provide + Send + Sync>>,
 }
 
-impl Provide for CoreProvider {
+impl Provide for Provider {
     fn list_opcodes(&self, op: list_opcodes::Operation) -> Result<list_opcodes::Result> {
         trace!("list_opcodes ingress");
         Ok(list_opcodes::Result {
@@ -87,7 +87,7 @@ impl Provide for CoreProvider {
 /// Builder for CoreProvider
 #[derive(Derivative, Default)]
 #[derivative(Debug)]
-pub struct CoreProviderBuilder {
+pub struct ProviderBuilder {
     version_maj: Option<u8>,
     version_min: Option<u8>,
     #[derivative(Debug = "ignore")]
@@ -96,10 +96,10 @@ pub struct CoreProviderBuilder {
     authenticator_info: Vec<AuthenticatorInfo>,
 }
 
-impl CoreProviderBuilder {
+impl ProviderBuilder {
     /// Create a new CoreProvider builder
     pub fn new() -> Self {
-        CoreProviderBuilder {
+        ProviderBuilder {
             version_maj: None,
             version_min: None,
             prov_list: Vec::new(),
@@ -130,7 +130,7 @@ impl CoreProviderBuilder {
     }
 
     /// Build into a CoreProvider
-    pub fn build(self) -> std::io::Result<CoreProvider> {
+    pub fn build(self) -> std::io::Result<Provider> {
         let mut provider_opcodes = HashMap::new();
         let _ = provider_opcodes.insert(
             ProviderID::Core,
@@ -167,7 +167,7 @@ impl CoreProviderBuilder {
             id: ProviderID::Core,
         });
 
-        let core_provider = CoreProvider {
+        let core_provider = Provider {
             wire_protocol_version_maj: self
                 .version_maj
                 .ok_or_else(|| Error::new(ErrorKind::InvalidData, "version maj is missing"))?,
@@ -190,7 +190,7 @@ mod tests {
 
     #[test]
     fn test_ping() {
-        let provider = CoreProvider {
+        let provider = Provider {
             wire_protocol_version_min: 8,
             wire_protocol_version_maj: 10,
             provider_info: Vec::new(),

src/providers/mbed_crypto_provider/aead.rs renamed to src/providers/mbed_crypto/aead.rs

@@ -1,14 +1,14 @@
 // Copyright 2020 Contributors to the Parsec project.
 // SPDX-License-Identifier: Apache-2.0
-use super::{key_management, MbedCryptoProvider};
+use super::{key_management, Provider};
 use crate::authenticators::ApplicationName;
 use crate::key_info_managers::KeyTriple;
 use parsec_interface::operations::{psa_aead_decrypt, psa_aead_encrypt};
 use parsec_interface::requests::{ProviderID, ResponseStatus, Result};
 use psa_crypto::operations::aead;
 use psa_crypto::types::key;
 
-impl MbedCryptoProvider {
+impl Provider {
     pub(super) fn psa_aead_encrypt_internal(
         &self,
         app_name: ApplicationName,

src/providers/mbed_crypto_provider/asym_encryption.rs renamed to src/providers/mbed_crypto/asym_encryption.rs

@@ -1,14 +1,14 @@
 // Copyright 2020 Contributors to the Parsec project.
 // SPDX-License-Identifier: Apache-2.0
-use super::{key_management, MbedCryptoProvider};
+use super::{key_management, Provider};
 use crate::authenticators::ApplicationName;
 use crate::key_info_managers::KeyTriple;
 use parsec_interface::operations::{psa_asymmetric_decrypt, psa_asymmetric_encrypt};
 use parsec_interface::requests::{ProviderID, ResponseStatus, Result};
 use psa_crypto::operations::asym_encryption;
 use psa_crypto::types::key;
 
-impl MbedCryptoProvider {
+impl Provider {
     pub(super) fn psa_asymmetric_encrypt_internal(
         &self,
         app_name: ApplicationName,

src/providers/mbed_crypto_provider/asym_sign.rs renamed to src/providers/mbed_crypto/asym_sign.rs

@@ -1,14 +1,14 @@
 // Copyright 2020 Contributors to the Parsec project.
 // SPDX-License-Identifier: Apache-2.0
-use super::{key_management, MbedCryptoProvider};
+use super::{key_management, Provider};
 use crate::authenticators::ApplicationName;
 use crate::key_info_managers::KeyTriple;
 use parsec_interface::operations::{psa_sign_hash, psa_verify_hash};
 use parsec_interface::requests::{ProviderID, ResponseStatus, Result};
 use psa_crypto::operations::asym_signature;
 use psa_crypto::types::key;
 
-impl MbedCryptoProvider {
+impl Provider {
     pub(super) fn psa_sign_hash_internal(
         &self,
         app_name: ApplicationName,

src/providers/mbed_crypto_provider/generate_random.rs renamed to src/providers/mbed_crypto/generate_random.rs

@@ -1,9 +1,9 @@
-use super::MbedCryptoProvider;
+use super::Provider;
 use parsec_interface::operations::psa_generate_random;
 use parsec_interface::requests::{ResponseStatus, Result};
 use psa_crypto::operations::other::generate_random;
 
-impl MbedCryptoProvider {
+impl Provider {
     pub(super) fn psa_generate_random_internal(
         &self,
         op: psa_generate_random::Operation,

src/providers/mbed_crypto_provider/hash.rs renamed to src/providers/mbed_crypto/hash.rs

@@ -1,11 +1,11 @@
 // Copyright 2020 Contributors to the Parsec project.
 // SPDX-License-Identifier: Apache-2.0
-use super::MbedCryptoProvider;
+use super::Provider;
 use parsec_interface::operations::{psa_hash_compare, psa_hash_compute};
 use parsec_interface::requests::{ResponseStatus, Result};
 use psa_crypto::operations::hash;
 
-impl MbedCryptoProvider {
+impl Provider {
     pub(super) fn psa_hash_compute_internal(
         &self,
         op: psa_hash_compute::Operation,

src/providers/mbed_crypto_provider/key_agreement.rs renamed to src/providers/mbed_crypto/key_agreement.rs

@@ -1,6 +1,6 @@
 // Copyright 2020 Contributors to the Parsec project.
 // SPDX-License-Identifier: Apache-2.0
-use super::{key_management, MbedCryptoProvider};
+use super::{key_management, Provider};
 use crate::authenticators::ApplicationName;
 use crate::key_info_managers::KeyTriple;
 use parsec_interface::operations::psa_raw_key_agreement;
@@ -9,7 +9,7 @@ use parsec_interface::secrecy::Secret;
 use psa_crypto::operations::key_agreement;
 use psa_crypto::types::key;
 
-impl MbedCryptoProvider {
+impl Provider {
     pub(super) fn psa_raw_key_agreement(
         &self,
         app_name: ApplicationName,

src/providers/mbed_crypto_provider/key_management.rs renamed to src/providers/mbed_crypto/key_management.rs

@@ -1,6 +1,6 @@
 // Copyright 2020 Contributors to the Parsec project.
 // SPDX-License-Identifier: Apache-2.0
-use super::MbedCryptoProvider;
+use super::Provider;
 use crate::authenticators::ApplicationName;
 use crate::key_info_managers;
 use crate::key_info_managers::{KeyInfo, KeyTriple, ManageKeyInfo};
@@ -90,7 +90,7 @@ pub fn key_info_exists(key_triple: &KeyTriple, store_handle: &dyn ManageKeyInfo)
         .map_err(key_info_managers::to_response_status)
 }
 
-impl MbedCryptoProvider {
+impl Provider {
     pub(super) fn psa_generate_key_internal(
         &self,
         app_name: ApplicationName,

src/providers/mbed_crypto_provider/mod.rs renamed to src/providers/mbed_crypto/mod.rs

@@ -54,7 +54,7 @@ const SUPPORTED_OPCODES: [Opcode; 15] = [
 /// Mbed Crypto provider structure
 #[derive(Derivative)]
 #[derivative(Debug)]
-pub struct MbedCryptoProvider {
+pub struct Provider {
     // When calling write on a reference of key_info_store, a type
     // std::sync::RwLockWriteGuard<dyn ManageKeyInfo + Send + Sync> is returned. We need to use the
     // dereference operator (*) to access the inner type dyn ManageKeyInfo + Send + Sync and then
@@ -73,21 +73,19 @@ pub struct MbedCryptoProvider {
     id_counter: AtomicU32,
 }
 
-impl MbedCryptoProvider {
+impl Provider {
     /// Creates and initialise a new instance of MbedCryptoProvider.
     /// Checks if there are not more keys stored in the Key Info Manager than in the MbedCryptoProvider and
     /// if there, delete them. Adds Key IDs currently in use in the local IDs store.
     /// Returns `None` if the initialisation failed.
-    fn new(
-        key_info_store: Arc<RwLock<dyn ManageKeyInfo + Send + Sync>>,
-    ) -> Option<MbedCryptoProvider> {
+    fn new(key_info_store: Arc<RwLock<dyn ManageKeyInfo + Send + Sync>>) -> Option<Provider> {
         // Safety: this function should be called before any of the other Mbed Crypto functions
         // are.
         if let Err(error) = psa_crypto::init() {
             format_error!("Error when initialising Mbed Crypto", error);
             return None;
         }
-        let mbed_crypto_provider = MbedCryptoProvider {
+        let mbed_crypto_provider = Provider {
             key_info_store,
             key_handle_mutex: Mutex::new(()),
             id_counter: AtomicU32::new(key::PSA_KEY_ID_USER_MIN),
@@ -148,7 +146,7 @@ impl MbedCryptoProvider {
     }
 }
 
-impl Provide for MbedCryptoProvider {
+impl Provide for Provider {
     fn describe(&self) -> Result<(ProviderInfo, HashSet<Opcode>)> {
         trace!("describe ingress");
         Ok((ProviderInfo {
@@ -299,15 +297,15 @@ impl Provide for MbedCryptoProvider {
 /// Mbed Crypto provider builder
 #[derive(Default, Derivative)]
 #[derivative(Debug)]
-pub struct MbedCryptoProviderBuilder {
+pub struct ProviderBuilder {
     #[derivative(Debug = "ignore")]
     key_info_store: Option<Arc<RwLock<dyn ManageKeyInfo + Send + Sync>>>,
 }
 
-impl MbedCryptoProviderBuilder {
+impl ProviderBuilder {
     /// Create a new provider builder
-    pub fn new() -> MbedCryptoProviderBuilder {
-        MbedCryptoProviderBuilder {
+    pub fn new() -> ProviderBuilder {
+        ProviderBuilder {
             key_info_store: None,
         }
     }
@@ -316,15 +314,15 @@ impl MbedCryptoProviderBuilder {
     pub fn with_key_info_store(
         mut self,
         key_info_store: Arc<RwLock<dyn ManageKeyInfo + Send + Sync>>,
-    ) -> MbedCryptoProviderBuilder {
+    ) -> ProviderBuilder {
         self.key_info_store = Some(key_info_store);
 
         self
     }
 
     /// Build into a MbedProvider
-    pub fn build(self) -> std::io::Result<MbedCryptoProvider> {
-        MbedCryptoProvider::new(
+    pub fn build(self) -> std::io::Result<Provider> {
+        Provider::new(
             self.key_info_store
                 .ok_or_else(|| Error::new(ErrorKind::InvalidData, "missing key info store"))?,
         )

src/providers/mod.rs

@@ -12,16 +12,16 @@ use serde::Deserialize;
 use std::collections::HashSet;
 use zeroize::Zeroize;
 
-pub mod core_provider;
+pub mod core;
 
 #[cfg(feature = "pkcs11-provider")]
-pub mod pkcs11_provider;
+pub mod pkcs11;
 
 #[cfg(feature = "mbed-crypto-provider")]
-pub mod mbed_crypto_provider;
+pub mod mbed_crypto;
 
 #[cfg(feature = "tpm-provider")]
-pub mod tpm_provider;
+pub mod tpm;
 
 /// Provider configuration structure
 /// For providers configs in Parsec config.toml we use a format similar