enable remote encryption support for remote and synced databases

Author: avinassh

libsql/examples/encryption_sync.rs

@@ -24,7 +24,8 @@ async fn main() {
         None
     };
 
-    let db_builder = Builder::new_synced_database(db_path, sync_url, auth_token, encryption);
+    let db_builder =
+        Builder::new_synced_database(db_path, sync_url, auth_token).remote_encryption(encryption);
 
     let db = match db_builder.build().await {
         Ok(db) => db,

libsql/src/database.rs

@@ -109,6 +109,7 @@ enum DbType {
         connector: crate::util::ConnectorService,
         version: Option<String>,
         namespace: Option<String>,
+        remote_encryption: Option<crate::sync::EncryptionContext>,
     },
 }
 
@@ -545,6 +546,7 @@ cfg_remote! {
                     connector: crate::util::ConnectorService::new(svc),
                     version,
                     namespace: None,
+                    remote_encryption: None
                 },
                 max_write_replication_index: Default::default(),
             })
@@ -733,6 +735,7 @@ impl Database {
                 connector,
                 version,
                 namespace,
+                remote_encryption,
             } => {
                 let conn = std::sync::Arc::new(
                     crate::hrana::connection::HttpConnection::new_with_connector(
@@ -741,7 +744,7 @@ impl Database {
                         connector.clone(),
                         version.as_ref().map(|s| s.as_str()),
                         namespace.as_ref().map(|s| s.as_str()),
-                        None,
+                        remote_encryption.clone(),
                     ),
                 );
 

libsql/src/database/builder.rs

@@ -52,8 +52,6 @@ impl Builder<()> {
             path: impl AsRef<std::path::Path>,
             url: String,
             auth_token: String,
-            #[cfg(feature = "sync")]
-            remote_encryption: Option<crate::sync::EncryptionContext>,
         ) -> Builder<RemoteReplica> {
             Builder {
                 inner: RemoteReplica {
@@ -64,6 +62,7 @@ impl Builder<()> {
                         connector: None,
                         version: None,
                         namespace: None,
+                        remote_encryption: None
                     },
                     encryption_config: None,
                     read_your_writes: true,
@@ -73,7 +72,7 @@ impl Builder<()> {
                     #[cfg(feature = "sync")]
                     sync_protocol: Default::default(),
                     #[cfg(feature = "sync")]
-                    remote_encryption,
+                    remote_encryption: None
                 },
             }
         }
@@ -98,7 +97,6 @@ impl Builder<()> {
             path: impl AsRef<std::path::Path>,
             url: String,
             auth_token: String,
-            remote_encryption: Option<EncryptionContext>,
         ) -> Builder<SyncedDatabase> {
             Builder {
                 inner: SyncedDatabase {
@@ -110,13 +108,14 @@ impl Builder<()> {
                         connector: None,
                         version: None,
                         namespace: None,
+                        remote_encryption: None,
                     },
                     connector: None,
                     read_your_writes: true,
                     remote_writes: false,
                     push_batch_size: 0,
                     sync_interval: None,
-                    remote_encryption,
+                    remote_encryption: None,
                 },
             }
         }
@@ -132,6 +131,7 @@ impl Builder<()> {
                     connector: None,
                     version: None,
                     namespace: None,
+                    remote_encryption: None,
                 },
             }
         }
@@ -146,6 +146,7 @@ cfg_replication_or_remote_or_sync! {
         connector: Option<crate::util::ConnectorService>,
         version: Option<String>,
         namespace: Option<String>,
+        remote_encryption: Option<EncryptionContext>,
     }
 }
 
@@ -238,7 +239,7 @@ cfg_replication! {
         #[cfg(feature = "sync")]
         sync_protocol: super::SyncProtocol,
         #[cfg(feature = "sync")]
-        remote_encryption: Option<crate::sync::EncryptionContext>,
+        remote_encryption: Option<EncryptionContext>,
     }
 
     /// Local replica configuration type in [`Builder`].
@@ -300,6 +301,13 @@ cfg_replication! {
             self
         }
 
+        /// Set the encryption context if the database is encrypted in remote server.
+        #[cfg(feature = "sync")]
+        pub fn remote_encryption(mut self, encryption_context: EncryptionContext) -> Builder<RemoteReplica> {
+            self.inner.remote_encryption = Some(encryption_context);
+            self
+        }
+
         pub fn http_request_callback<F>(mut self, f: F) -> Builder<RemoteReplica>
         where
             F: Fn(&mut http::Request<()>) + Send + Sync + 'static
@@ -347,6 +355,7 @@ cfg_replication! {
                         connector,
                         version,
                         namespace,
+                        ..
                     },
                 encryption_config,
                 read_your_writes,
@@ -415,10 +424,11 @@ cfg_replication! {
 
                         if res.status().is_success() {
                             tracing::trace!("Using sync protocol v2 for {}", url);
-                            let builder = Builder::new_synced_database(path, url, auth_token, remote_encryption)
+                            let builder = Builder::new_synced_database(path, url, auth_token)
                                 .connector(connector)
                                 .remote_writes(true)
-                                .read_your_writes(read_your_writes);
+                                .read_your_writes(read_your_writes)
+                                .remote_encryption(remote_encryption);
 
                             let builder = if let Some(sync_interval) = sync_interval {
                                 builder.sync_interval(sync_interval)
@@ -475,7 +485,10 @@ cfg_replication! {
 
 
             Ok(Database {
-                db_type: DbType::Sync { db, encryption_config },
+                db_type: DbType::Sync {
+                    db,
+                    encryption_config,
+                },
                 max_write_replication_index: Default::default(),
             })
         }
@@ -515,6 +528,7 @@ cfg_replication! {
                 connector,
                 version,
                 namespace,
+                ..
             }) = remote
             {
                 let connector = if let Some(connector) = connector {
@@ -598,6 +612,12 @@ cfg_sync! {
             self
         }
 
+         /// Set the encryption context if the database is encrypted in remote server.
+        pub fn remote_encryption(mut self, encryption_context: Option<EncryptionContext>) -> Builder<SyncedDatabase> {
+            self.inner.remote_encryption = encryption_context;
+            self
+        }
+
         /// Provide a custom http connector that will be used to create http connections.
         pub fn connector<C>(mut self, connector: C) -> Builder<SyncedDatabase>
         where
@@ -624,6 +644,7 @@ cfg_sync! {
                         connector: _,
                         version: _,
                         namespace: _,
+                        ..
                     },
                 connector,
                 remote_writes,
@@ -759,6 +780,12 @@ cfg_remote! {
             self
         }
 
+        /// Set the encryption context if the database is encrypted in remote server.
+        pub fn remote_encryption(mut self, encryption_context: EncryptionContext) -> Builder<Remote> {
+            self.inner.remote_encryption = Some(encryption_context);
+            self
+        }
+
         /// Build the remote database client.
         pub async fn build(self) -> Result<Database> {
             let Remote {
@@ -767,6 +794,7 @@ cfg_remote! {
                 connector,
                 version,
                 namespace,
+                remote_encryption,
             } = self.inner;
 
             let connector = if let Some(connector) = connector {
@@ -789,6 +817,7 @@ cfg_remote! {
                     connector,
                     version,
                     namespace,
+                    remote_encryption
                 },
                 max_write_replication_index: Default::default(),
             })

libsql/src/sync/test.rs

@@ -20,6 +20,7 @@ async fn test_sync_context_push_frame() {
         db_path.to_str().unwrap().to_string(),
         server.url(),
         None,
+        None,
     )
     .await
     .unwrap();
@@ -49,6 +50,7 @@ async fn test_sync_context_with_auth() {
         db_path.to_str().unwrap().to_string(),
         server.url(),
         Some("test_token".to_string()),
+        None,
     )
     .await
     .unwrap();
@@ -73,6 +75,7 @@ async fn test_sync_context_multiple_frames() {
         db_path.to_str().unwrap().to_string(),
         server.url(),
         None,
+        None,
     )
     .await
     .unwrap();
@@ -102,6 +105,7 @@ async fn test_sync_context_corrupted_metadata() {
         db_path.to_str().unwrap().to_string(),
         server.url(),
         None,
+        None,
     )
     .await
     .unwrap();
@@ -123,6 +127,7 @@ async fn test_sync_context_corrupted_metadata() {
         db_path.to_str().unwrap().to_string(),
         server.url(),
         None,
+        None,
     )
     .await
     .unwrap();
@@ -146,6 +151,7 @@ async fn test_sync_restarts_with_lower_max_frame_no() {
         db_path.to_str().unwrap().to_string(),
         server.url(),
         None,
+        None,
     )
     .await
     .unwrap();
@@ -171,6 +177,7 @@ async fn test_sync_restarts_with_lower_max_frame_no() {
         db_path.to_str().unwrap().to_string(),
         server.url(),
         None,
+        None,
     )
     .await
     .unwrap();
@@ -210,6 +217,7 @@ async fn test_sync_context_retry_on_error() {
         db_path.to_str().unwrap().to_string(),
         server.url(),
         None,
+        None,
     )
     .await
     .unwrap();