api: add encryption configuration to file cache

Add encryption configuration to file cache, so we can encrypt data written to the local cache file. Signed-off-by: Jiang Liu <[email protected]>
dragonflyoss · Apr 14, 2023 · 21870b6 · 21870b6
1 parent 266cde0
commit 21870b6
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/api/src/config.rs b/api/src/config.rs
@@ -672,6 +672,15 @@ pub struct FileCacheConfig {
     /// Deprecated: disable index mapping, keep it as false when possible.
     #[serde(default)]
     pub disable_indexed_map: bool,
+    /// Enable encryption data written to the cache file.
+    #[serde(default)]
+    pub enable_encryption: bool,
+    /// Enable convergent encryption for chunk deduplication.
+    #[serde(default)]
+    pub enable_convergent_encryption: bool,
+    /// Key for data encryption, a heximal representation of [u8; 32].
+    #[serde(default)]
+    pub encryption_key: String,
 }
 
 impl FileCacheConfig {

diff --git a/docs/samples/blob_cache_entry_configuration_v2.toml b/docs/samples/blob_cache_entry_configuration_v2.toml
@@ -125,6 +125,9 @@ validate = true
 
 [cache.filecache]
 work_dir = "."
+enable_encryption = true
+enable_convergent_encryption = true
+encryption_key = "fc4a7db5614afc2f400e9478bebed1aefdbc9d7cd03210b84f144683a7a6fd1a"
 
 [cache.fscache]
 work_dir = "."

diff --git a/docs/samples/configuration_v2.toml b/docs/samples/configuration_v2.toml
@@ -120,6 +120,12 @@ type = "filecache"
 compressed = true
 # Whether to validate data read from the cache.
 validate = true
+# Enable encryption data written to the cache file.
+enable_encryption = true
+# Enable convergent encryption for chunk deduplication.
+enable_convergent_encryption = true
+# Key for data encryption, a heximal representation of [u8; 32].
+encryption_key = "fc4a7db5614afc2f400e9478bebed1aefdbc9d7cd03210b84f144683a7a6fd1a"
 
 [cache.filecache]
 work_dir = "."