Add GlobalConfig with flag for logging errors

This commit adds a GlobalConfig structure with a `log_error_details`
flag which controls if Rust error objects are logged along with the
message.
A `format_error` macro is also added to make the conditional logging
easier.

Signed-off-by: Ionut Mihalcea <ionut.mihalcea@arm.com>

Author: ionut-arm

Cargo.lock

@@ -21,6 +21,11 @@
 # Defaults to 1MB.
 #body_len_limit = 1048576
 
+# Decide whether detailed information about errors occuring should be included in log messages.
+# WARNING: the details might include sensitive information about the keys used by Parsec clients,
+# such as key names or policies
+#log_error_details = false
+
 # (Required) Configuration for the service IPC listener component.
 [listener]
 # (Required) Type of IPC that the service will support.

config.toml

@@ -1,6 +1,7 @@
 [core_settings]
 # The CI already timestamps the logs
 log_timestamp = false
+log_error_details = true
 
 [listener]
 listener_type = "DomainSocket"

e2e_tests/provider_cfg/all/config.toml

@@ -1,6 +1,7 @@
 [core_settings]
 # The CI already timestamps the logs
 log_timestamp = false
+log_error_details = true
 
 [listener]
 listener_type = "DomainSocket"

e2e_tests/provider_cfg/mbed-crypto/config.toml

@@ -1,6 +1,7 @@
 [core_settings]
 # The CI already timestamps the logs
 log_timestamp = false
+log_error_details = true
 
 [listener]
 listener_type = "DomainSocket"

e2e_tests/provider_cfg/pkcs11/config.toml

@@ -1,6 +1,7 @@
 [core_settings]
 # The CI already timestamps the logs
 log_timestamp = false
+log_error_details = true
 
 [listener]
 listener_type = "DomainSocket"

e2e_tests/provider_cfg/tpm/config.toml

@@ -37,6 +37,17 @@
 // This one is hard to avoid.
 #![allow(clippy::multiple_crate_versions)]
 
+#[allow(unused)]
+macro_rules! format_error {
+    ($message:expr, $error:expr) => {
+        if crate::utils::GlobalConfig::log_error_details() {
+            log::error!("{}; Error: {}", $message, $error)
+        } else {
+            log::error!("{};", $message)
+        }
+    };
+}
+
 pub mod authenticators;
 pub mod back;
 pub mod front;

src/lib.rs

@@ -90,7 +90,7 @@ impl Pkcs11Provider {
                 match self.backend.sign(session.session_handle(), &digest_info) {
                     Ok(signature) => Ok(psa_sign_hash::Result { signature }),
                     Err(e) => {
-                        error!("Failed to execute signing operation. Error: {}", e);
+                        format_error!("Failed to execute signing operation", e);
                         Err(utils::to_response_status(e))
                     }
                 }

src/providers/pkcs11_provider/asym_sign.rs

@@ -0,0 +1,51 @@
+// Copyright 2020 Contributors to the Parsec project.
+// SPDX-License-Identifier: Apache-2.0
+use std::sync::atomic::AtomicBool;
+use std::sync::atomic::Ordering;
+
+/// Configuration values that affect most or all the
+/// components of the service.
+#[derive(Default, Debug)]
+pub struct GlobalConfig {
+    log_error_details: AtomicBool,
+}
+
+impl GlobalConfig {
+    const fn new() -> Self {
+        GlobalConfig {
+            log_error_details: AtomicBool::new(false),
+        }
+    }
+
+    /// Determine whether error logs should include detailed
+    /// information about the error
+    pub fn log_error_details() -> bool {
+        GLOBAL_CONFIG.log_error_details.load(Ordering::Relaxed)
+    }
+}
+
+static GLOBAL_CONFIG: GlobalConfig = GlobalConfig::new();
+
+pub(super) struct GlobalConfigBuilder {
+    log_error_details: bool,
+}
+
+impl GlobalConfigBuilder {
+    pub fn new() -> Self {
+        GlobalConfigBuilder {
+            log_error_details: false,
+        }
+    }
+
+    pub fn with_log_error_details(mut self, log_error_details: bool) -> Self {
+        self.log_error_details = log_error_details;
+
+        self
+    }
+
+    pub fn build(self) {
+        GLOBAL_CONFIG
+            .log_error_details
+            .store(self.log_error_details, Ordering::Relaxed);
+    }
+}

src/utils/global_config.rs

@@ -1,6 +1,8 @@
 // Copyright 2019 Contributors to the Parsec project.
 // SPDX-License-Identifier: Apache-2.0
 //! Service utilities
+mod global_config;
 mod service_builder;
 
+pub use global_config::GlobalConfig;
 pub use service_builder::{CoreSettings, ServiceBuilder, ServiceConfig};