chore(keylog): separate TLS keylog responsibilities (#1166)

Author: 0x676e67

src/tls/conn/ext.rs

@@ -10,12 +10,12 @@ use crate::{
 
 /// SslConnectorBuilderExt trait for `SslConnectorBuilder`.
 pub trait SslConnectorBuilderExt {
-    /// Configure the CertStore for the given `SslConnectorBuilder`.
-    fn set_cert_store(self, store: Option<&CertStore>) -> crate::Result<SslConnectorBuilder>;
-
     /// Configure the Identity for the given `SslConnectorBuilder`.
     fn set_identity(self, identity: Option<&Identity>) -> crate::Result<SslConnectorBuilder>;
 
+    /// Configure the CertStore for the given `SslConnectorBuilder`.
+    fn set_cert_store(self, store: Option<&CertStore>) -> crate::Result<SslConnectorBuilder>;
+
     /// Configure the certificate verification for the given `SslConnectorBuilder`.
     fn set_cert_verification(self, enable: bool) -> SslConnectorBuilder;
 
@@ -27,16 +27,6 @@ pub trait SslConnectorBuilderExt {
 }
 
 impl SslConnectorBuilderExt for SslConnectorBuilder {
-    fn set_cert_store(mut self, store: Option<&CertStore>) -> crate::Result<SslConnectorBuilder> {
-        if let Some(store) = store {
-            self.set_cert_store_ref(&store.0)
-        } else {
-            self.set_default_verify_paths().map_err(Error::tls)?;
-        }
-
-        Ok(self)
-    }
-
     fn set_identity(mut self, identity: Option<&Identity>) -> crate::Result<SslConnectorBuilder> {
         if let Some(identity) = identity {
             self.set_certificate(&identity.cert).map_err(Error::tls)?;
@@ -52,6 +42,16 @@ impl SslConnectorBuilderExt for SslConnectorBuilder {
         Ok(self)
     }
 
+    fn set_cert_store(mut self, store: Option<&CertStore>) -> crate::Result<SslConnectorBuilder> {
+        if let Some(store) = store {
+            self.set_cert_store_ref(&store.0)
+        } else {
+            self.set_default_verify_paths().map_err(Error::tls)?;
+        }
+
+        Ok(self)
+    }
+
     fn set_cert_verification(mut self, enable: bool) -> SslConnectorBuilder {
         self.set_verify(if enable {
             SslVerifyMode::PEER

src/tls/keylog.rs

@@ -7,8 +7,6 @@
 //! `SSLKEYLOGFILE` environment variable or by specifying a custom file path. Handles are cached
 //! globally to avoid duplicate file access.
 
-mod handle;
-
 use std::{
     borrow::Cow,
     collections::{HashMap, hash_map::Entry},
@@ -95,3 +93,70 @@ where
     }
     ret
 }
+
+mod handle {
+    use std::{
+        fs::OpenOptions,
+        io::{Result, Write},
+        path::Path,
+        sync::{
+            Arc,
+            mpsc::{self, Sender},
+        },
+    };
+
+    /// Handle for writing to a key log file.
+    #[derive(Debug, Clone)]
+    pub struct Handle {
+        #[allow(unused)]
+        filepath: Arc<Path>,
+        sender: Sender<String>,
+    }
+
+    impl Handle {
+        /// Create a new [`Handle`] with the specified path and sender.
+        pub fn new(filepath: Arc<Path>) -> Result<Self> {
+            if let Some(parent) = filepath.parent() {
+                std::fs::create_dir_all(parent)?;
+            }
+
+            let mut file = OpenOptions::new()
+                .create(true)
+                .append(true)
+                .open(&filepath)?;
+
+            let (sender, receiver) = mpsc::channel::<String>();
+
+            let _path_name = filepath.clone();
+            std::thread::spawn(move || {
+                trace!(
+                    file = ?_path_name,
+                    "Handle: receiver task up and running",
+                );
+                while let Ok(line) = receiver.recv() {
+                    if let Err(_err) = file.write_all(line.as_bytes()) {
+                        error!(
+                            file = ?_path_name,
+                            error = %_err,
+                            "Handle: failed to write file",
+                        );
+                    }
+                }
+            });
+
+            Ok(Handle { filepath, sender })
+        }
+
+        /// Write a line to the keylogger.
+        pub fn write(&self, line: &str) {
+            let line = format!("{line}\n");
+            if let Err(_err) = self.sender.send(line) {
+                error!(
+                    file = ?self.filepath,
+                    error = %_err,
+                    "Handle: failed to send log line for writing",
+                );
+            }
+        }
+    }
+}