Merge pull request #508 from parallaxsecond/tg/random-fix

Get random authvalues locally instead of from the TPM

Author: tgonzalezorlandoarm

SECURITY.md

@@ -0,0 +1,36 @@
+# Security policy
+
+Security is of paramount importance to the tss-esapi project. We do all we can to identify and fix
+issues, however some problems might slip through the cracks. Any efforts towards responsible
+disclosure of security problems are greatly appreciated and your contributions will be acknowledged.
+
+## Our disclosure policy
+
+All security vulnerabilities affecting the tss-esapi project - including those reported using the
+steps highlighted below, those discovered during routine testing, and those found in our dependency
+tree either through `cargo-audit` or otherwise - will receive
+[security advisories](https://github.com/parallaxsecond/rust-tss-esapi/security) in a timely
+manner. The advisories should include sufficient information about the cause, effect, and possible
+mitigations for the vulnerability. If any information is missing, or you would like to raise a
+question about the advisories, please open an issue in
+[our repo](https://github.com/parallaxsecond/rust-tss-esapi).
+
+Efforts to mitigate for the reported vulnerabilities will be tracked using GitHub issues linked to
+the corresponding advisories.
+
+## Reporting a vulnerability
+
+To report a vulnerability, please send an email to
+[[email protected]](mailto:[email protected]). We will
+promptly reply to your report and we will strive to keep you in the loop as we try to reach a
+resolution.
+
+# Security considerations for the use of the software
+
+The authvalue provided to the TPM to perform certain operations like creating Primary Keys is
+currently randomly generated by [getrandom](https://crates.io/crates/getrandom), which assumes
+"that the system always provides high-quality cryptographically secure random data, ideally backed
+by hardware entropy sources."
+
+The user of this software should take this into consideration when setting up their system and using
+this software.

tss-esapi/Cargo.toml

@@ -27,6 +27,7 @@ tss-esapi-sys = { path = "../tss-esapi-sys", version = "0.5.0" }
 oid = "0.2.1"
 picky-asn1 = "0.8.0"
 picky-asn1-x509 = "0.12.0"
+getrandom = "0.2.11"
 
 [dev-dependencies]
 env_logger = "0.10.0"

tss-esapi/src/abstraction/transient/mod.rs

@@ -137,6 +137,7 @@ impl TransientKeyContext {
     ///
     /// # Errors
     /// * if the authentication size is larger than 32 a `WrongParamSize` wrapper error is returned
+    /// * if there is an error when obtaining random numbers from the local machine
     pub fn create_key(
         &mut self,
         key_params: KeyParams,
@@ -147,8 +148,12 @@ impl TransientKeyContext {
         }
         let key_auth = if auth_size > 0 {
             self.set_session_attrs()?;
-            let random_bytes = self.context.get_random(auth_size)?;
-            Some(Auth::try_from(random_bytes.value().to_vec())?)
+            let mut random_bytes = vec![0u8; auth_size];
+            getrandom::getrandom(&mut random_bytes).map_err(|_| {
+                log::error!("Failed to obtain a random authvalue for key creation");
+                Error::WrapperError(ErrorKind::InternalError)
+            })?;
+            Some(Auth::try_from(random_bytes)?)
         } else {
             None
         };
@@ -637,7 +642,7 @@ impl TransientKeyContextBuilder {
     /// Bootstrap the TransientKeyContext.
     ///
     /// The root key is created as a primary key in the provided hierarchy and thus authentication is
-    /// needed for said hierarchy. The authentication valuei for the key is generated by the TPM itself,
+    /// needed for said hierarchy. The authentication value for the key is generated locally in the machine,
     /// with a configurable length, and never exposed outside the context.
     ///
     /// # Warning
@@ -650,9 +655,9 @@ impl TransientKeyContextBuilder {
     /// * `root_key_auth_size` must be at most 32
     ///
     /// # Errors
-    /// * errors are returned if any method calls return an error: `Context::get_random`,
-    /// `Context::start_auth_session`, `Context::create_primary`, `Context::flush_context`,
-    /// `Context::set_handle_auth`
+    /// * errors are returned if any method calls return an error: `Context::start_auth_session`
+    /// `Context::create_primary`, `Context::flush_context`, `Context::set_handle_auth`
+    /// or if an internal error occurs when getting random numbers from the local machine
     /// * if the root key authentication size is given greater than 32 or if the root key size is
     /// not 1024, 2048, 3072 or 4096, a `InvalidParam` wrapper error is returned
     pub fn build(mut self) -> Result<TransientKeyContext> {
@@ -665,8 +670,12 @@ impl TransientKeyContextBuilder {
         let mut context = Context::new(self.tcti_name_conf)?;
 
         let root_key_auth = if self.root_key_auth_size > 0 {
-            let random = context.get_random(self.root_key_auth_size)?;
-            Some(Auth::try_from(random.value().to_vec())?)
+            let mut random = vec![0u8; self.root_key_auth_size];
+            getrandom::getrandom(&mut random).map_err(|_| {
+                log::error!("Failed to obtain a random value for root key authentication");
+                Error::WrapperError(ErrorKind::InternalError)
+            })?;
+            Some(Auth::try_from(random)?)
         } else {
             None
         };

tss-esapi/src/context/tpm_commands/asymmetric_primitives.rs

@@ -131,8 +131,9 @@ impl Context {
     /// # context.tr_sess_set_attributes(session, session_attributes, session_attributes_mask)
     /// #     .expect("Failed to set attributes on session");
     /// # context.set_sessions((Some(session), None, None));
-    /// # let random_digest = context.get_random(16).unwrap();
-    /// # let key_auth = Auth::try_from(random_digest.value().to_vec()).unwrap();
+    /// # let mut random_digest = vec![0u8; 16];
+    /// # getrandom::getrandom(&mut random_digest).unwrap();
+    /// # let key_auth = Auth::try_from(random_digest).unwrap();
     /// #
     /// // Create a key suitable for ECDH key generation
     /// let ecc_parms = PublicEccParametersBuilder::new()
@@ -268,8 +269,9 @@ impl Context {
     /// # context.tr_sess_set_attributes(session, session_attributes, session_attributes_mask)
     /// #     .expect("Failed to set attributes on session");
     /// # context.set_sessions((Some(session), None, None));
-    /// # let random_digest = context.get_random(16).unwrap();
-    /// # let key_auth = Auth::try_from(random_digest.value().to_vec()).unwrap();
+    /// # let mut random_digest = vec![0u8; 16];
+    /// # getrandom::getrandom(&mut random_digest).unwrap();
+    /// # let key_auth = Auth::try_from(random_digest).unwrap();
     /// #
     /// // Create a key suitable for ECDH key generation
     /// let ecc_parms = PublicEccParametersBuilder::new()

tss-esapi/src/context/tpm_commands/context_management.rs

@@ -109,10 +109,9 @@ impl Context {
     ///
     /// // Execute context methods using the session
     /// context.execute_with_session(Some(session), |ctx| {
-    ///     let random_digest = ctx.get_random(16)
-    ///         .expect("Call to get_random failed");
-    ///     let key_auth = Auth::try_from(random_digest.value().to_vec())
-    ///         .expect("Failed to create Auth");
+    ///     let mut random_digest = vec![0u8; 16];
+    ///     getrandom::getrandom(&mut random_digest).expect("Call to getrandom failed");
+    ///     let key_auth = Auth::try_from(random_digest).expect("Failed to create Auth");
     ///     let key_handle = ctx
     ///         .create_primary(
     ///             Hierarchy::Owner,

tss-esapi/src/context/tpm_commands/symmetric_primitives.rs

@@ -56,12 +56,10 @@ impl Context {
     /// #     .tr_set_auth(tss_esapi::interface_types::resource_handles::Hierarchy::Owner.into(), Auth::default())
     /// #     .expect("Failed to set auth to empty for owner");
     /// # // Create primary key auth
+    /// # let mut random_digest = vec![0u8; 16];
+    /// # getrandom::getrandom(&mut random_digest).expect("get_rand call failed");
     /// # let primary_key_auth = Auth::try_from(
-    /// #     context
-    /// #         .get_random(16)
-    /// #         .expect("get_rand call failed")
-    /// #         .value()
-    /// #         .to_vec(),
+    /// #     random_digest
     /// # )
     /// # .expect("Failed to create primary key auth");
     /// # // Create primary key
@@ -103,12 +101,10 @@ impl Context {
     /// #     .build()
     /// #     .expect("Failed to create public for symmetric key public");
     /// # // Create auth for the symmetric key
+    /// # let mut random_digest = vec![0u8; 16];
+    /// # getrandom::getrandom(&mut random_digest).expect("get_rand call failed");
     /// # let symmetric_key_auth = Auth::try_from(
-    /// #     context
-    /// #         .get_random(16)
-    /// #         .expect("get_rand call failed")
-    /// #         .value()
-    /// #         .to_vec(),
+    /// #     random_digest
     /// # )
     /// # .expect("Failed to create symmetric key auth");
     /// # // Create symmetric key data

tss-esapi/tests/integration_tests/abstraction_tests/transient_key_context_tests.rs

@@ -503,8 +503,9 @@ fn ctx_migration_test() {
     // Create two key contexts using `Context`, one for an RSA keypair,
     // one for just the public part of the key
     let mut basic_ctx = crate::common::create_ctx_with_session();
-    let random_digest = basic_ctx.get_random(16).unwrap();
-    let key_auth = Auth::try_from(random_digest.value().to_vec()).unwrap();
+    let mut random_digest = vec![0u8; 16];
+    getrandom::getrandom(&mut random_digest).unwrap();
+    let key_auth = Auth::try_from(random_digest).unwrap();
     let prim_key_handle = basic_ctx
         .create_primary(
             Hierarchy::Owner,

tss-esapi/tests/integration_tests/context_tests/tpm_commands/asymmetric_primitives_tests.rs

@@ -19,8 +19,9 @@ mod test_rsa_encrypt_decrypt {
     #[test]
     fn test_encrypt_decrypt() {
         let mut context = create_ctx_with_session();
-        let random_digest = context.get_random(16).unwrap();
-        let key_auth = Auth::try_from(random_digest.value().to_vec()).unwrap();
+        let mut random_digest = vec![0u8; 16];
+        getrandom::getrandom(&mut random_digest).unwrap();
+        let key_auth = Auth::try_from(random_digest).unwrap();
 
         let key_handle = context
             .create_primary(
@@ -59,8 +60,9 @@ mod test_rsa_encrypt_decrypt {
     #[test]
     fn test_ecdh() {
         let mut context = create_ctx_with_session();
-        let random_digest = context.get_random(16).unwrap();
-        let key_auth = Auth::try_from(random_digest.value().to_vec()).unwrap();
+        let mut random_digest = vec![0u8; 16];
+        getrandom::getrandom(&mut random_digest).unwrap();
+        let key_auth = Auth::try_from(random_digest).unwrap();
 
         let ecc_parms = PublicEccParametersBuilder::new()
             .with_ecc_scheme(EccScheme::EcDh(HashScheme::new(HashingAlgorithm::Sha256)))

tss-esapi/tests/integration_tests/context_tests/tpm_commands/context_management_tests.rs

@@ -8,8 +8,9 @@ mod test_ctx_save {
     #[test]
     fn test_ctx_save() {
         let mut context = create_ctx_with_session();
-        let random_digest = context.get_random(16).unwrap();
-        let key_auth = Auth::try_from(random_digest.value().to_vec()).unwrap();
+        let mut random_digest = vec![0u8; 16];
+        getrandom::getrandom(&mut random_digest).unwrap();
+        let key_auth = Auth::try_from(random_digest).unwrap();
 
         let key_handle = context
             .create_primary(
@@ -28,8 +29,9 @@ mod test_ctx_save {
     #[test]
     fn test_ctx_save_leaf() {
         let mut context = create_ctx_with_session();
-        let random_digest = context.get_random(16).unwrap();
-        let key_auth = Auth::try_from(random_digest.value().to_vec()).unwrap();
+        let mut random_digest = vec![0u8; 16];
+        getrandom::getrandom(&mut random_digest).unwrap();
+        let key_auth = Auth::try_from(random_digest).unwrap();
 
         let prim_key_handle = context
             .create_primary(
@@ -72,13 +74,14 @@ mod test_ctx_load {
     #[test]
     fn test_ctx_load() {
         let mut context = create_ctx_with_session();
-        let key_auth = context.get_random(16).unwrap();
+        let mut random_digest = vec![0u8; 16];
+        getrandom::getrandom(&mut random_digest).unwrap();
 
         let prim_key_handle = context
             .create_primary(
                 Hierarchy::Owner,
                 decryption_key_pub(),
-                Some(Auth::try_from(key_auth.value().to_vec()).unwrap()),
+                Some(Auth::try_from(random_digest.clone()).unwrap()),
                 None,
                 None,
                 None,
@@ -90,7 +93,7 @@ mod test_ctx_load {
             .create(
                 prim_key_handle,
                 signing_key_pub(),
-                Some(Auth::try_from(key_auth.value().to_vec()).unwrap()),
+                Some(Auth::try_from(random_digest).unwrap()),
                 None,
                 None,
                 None,
@@ -115,8 +118,9 @@ mod test_flush_context {
     #[test]
     fn test_flush_ctx() {
         let mut context = create_ctx_with_session();
-        let random_digest = context.get_random(16).unwrap();
-        let key_auth = Auth::try_from(random_digest.value().to_vec()).unwrap();
+        let mut random_digest = vec![0u8; 16];
+        getrandom::getrandom(&mut random_digest).unwrap();
+        let key_auth = Auth::try_from(random_digest).unwrap();
 
         let key_handle = context
             .create_primary(
@@ -136,8 +140,9 @@ mod test_flush_context {
     #[test]
     fn test_flush_parent_ctx() {
         let mut context = create_ctx_with_session();
-        let random_digest = context.get_random(16).unwrap();
-        let key_auth = Auth::try_from(random_digest.value().to_vec()).unwrap();
+        let mut random_digest = vec![0u8; 16];
+        getrandom::getrandom(&mut random_digest).unwrap();
+        let key_auth = Auth::try_from(random_digest).unwrap();
 
         let prim_key_handle = context
             .create_primary(

tss-esapi/tests/integration_tests/context_tests/tpm_commands/enhanced_authorization_ea_commands_tests.rs

@@ -537,8 +537,9 @@ mod test_policy_authorize {
     #[test]
     fn test_policy_authorize() {
         let mut context = create_ctx_with_session();
-        let random_digest = context.get_random(16).unwrap();
-        let key_auth = Auth::try_from(random_digest.value().to_vec()).unwrap();
+        let mut random_digest = vec![0u8; 16];
+        getrandom::getrandom(&mut random_digest).unwrap();
+        let key_auth = Auth::try_from(random_digest).unwrap();
 
         let key_handle = context
             .create_primary(