archive versioning

Author: Alexander Weber

src/archive.rs

@@ -1,50 +1,50 @@
 pub const VERSION_ID_LEN: usize = 36;
-pub const VERSION_0_1_0: &'static str = "9f1e0683-7655-4f73-940a-38fa580b5725";
+pub const VERSION_0_1: &'static str = "9f1e0683-7655-4f73-940a-38fa580b5725";
 
-/// The archive that describes the single file storaing all information.
-#[derive(Debug, serde::Serialize, serde::Deserialize)]
-pub(crate) struct Archive {
-    /// Version of this program with which the secret has been generated.
-    pub version: String,
-    /// Automatically generated unique ID of this archive.
-    pub uid: String,
-    /// The actual share of the secret.
-    pub share: Share,
+pub mod v1 {
+    /// The archive that describes the single file storaing all information.
+    #[derive(Debug, serde::Serialize, serde::Deserialize)]
+    pub(crate) struct Archive {
+        /// Automatically generated unique ID of this archive.
+        pub uid: String,
+        /// The actual share of the secret.
+        pub share: Share,
 
-    /// This shares name.
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub name: Option<String>,
-    /// Some plain text comment.
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub comment: Option<String>,
-    /// Some information about the secret.
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub info: Option<SecretInfo>,
-}
+        /// This shares name.
+        #[serde(skip_serializing_if = "Option::is_none")]
+        pub name: Option<String>,
+        /// Some plain text comment.
+        #[serde(skip_serializing_if = "Option::is_none")]
+        pub comment: Option<String>,
+        /// Some information about the secret.
+        #[serde(skip_serializing_if = "Option::is_none")]
+        pub info: Option<SecretInfo>,
+    }
 
-// Describing an individual share.
-#[derive(Debug, serde::Serialize, serde::Deserialize)]
-pub(crate) enum Share {
-    /// Plain base64 encoded share data.
-    PlainBase64(String),
-    /// Symmetrically encrypted, base64 encoded share data.
-    EncryptedBase64 { hash: Hash, data: String },
-}
+    // Describing an individual share.
+    #[derive(Debug, serde::Serialize, serde::Deserialize)]
+    pub(crate) enum Share {
+        /// Plain base64 encoded share data.
+        PlainBase64(String),
+        /// Symmetrically encrypted, base64 encoded share data.
+        EncryptedBase64 { hash: Hash, data: String },
+    }
 
-/// Describes the hash algorithm and value that is used for password
-/// verification.
-#[derive(Debug, serde::Serialize, serde::Deserialize)]
-pub(crate) enum Hash {
-    /// Argon2id hash.
-    Argon2id(String),
-}
+    /// Describes the hash algorithm and value that is used for password
+    /// verification.
+    #[derive(Debug, serde::Serialize, serde::Deserialize)]
+    pub(crate) enum Hash {
+        /// Argon2id hash.
+        Argon2id(String),
+    }
 
-/// Describes the secret that has been sharded. Contains information about how
-/// to restore.
-#[derive(Debug, serde::Serialize, serde::Deserialize)]
-pub(crate) struct SecretInfo {
-    /// The amount of shares that were generated for the secret.
-    pub num_shares: usize,
-    /// The amount of shares that are needed for restoring the secret.
-    pub threshold: usize,
+    /// Describes the secret that has been sharded. Contains information about
+    /// how to restore.
+    #[derive(Debug, serde::Serialize, serde::Deserialize)]
+    pub(crate) struct SecretInfo {
+        /// The amount of shares that were generated for the secret.
+        pub num_shares: usize,
+        /// The amount of shares that are needed for restoring the secret.
+        pub threshold: usize,
+    }
 }

src/engine.rs

@@ -1,11 +1,8 @@
 use {
     crate::{
         archive::{
-            Archive,
-            Hash,
-            SecretInfo,
-            Share,
-            VERSION_0_1_0,
+            v1,
+            VERSION_0_1,
             VERSION_ID_LEN,
         },
         blueprint::Blueprint,
@@ -54,13 +51,12 @@ impl<'x> SSS<'x> {
         )?;
 
         for z in blueprint.generate.iter().zip(shares) {
-            let share_data = Archive {
-                version: VERSION_0_1_0.to_owned(),
+            let share_data = v1::Archive {
                 uid: Uuid::new_v4().hyphenated().to_string(),
                 name: z.0.name.clone(),
                 comment: z.0.comment.clone(),
                 info: if z.0.info.unwrap_or(false) {
-                    Some(SecretInfo {
+                    Some(v1::SecretInfo {
                         num_shares: blueprint.generate.len(),
                         threshold: blueprint.threshold,
                     })
@@ -82,20 +78,20 @@ impl<'x> SSS<'x> {
                             .serialize()
                             .to_string();
 
-                        Share::EncryptedBase64 {
+                        v1::Share::EncryptedBase64 {
                             data: STANDARD.encode(simplecrypt::encrypt(z.1.as_bytes(), pass.as_bytes())),
-                            hash: Hash::Argon2id(hash),
+                            hash: v1::Hash::Argon2id(hash),
                         }
                     },
                     | None => {
                         let encoded_share = STANDARD.encode(z.1);
-                        Share::PlainBase64(encoded_share)
+                        v1::Share::PlainBase64(encoded_share)
                     },
                 },
             };
             let share_data_str = STANDARD.encode(serde_yaml::to_string(&share_data)?);
 
-            fs::write(&z.0.path, format!("{}{}", VERSION_0_1_0, share_data_str))?;
+            fs::write(&z.0.path, format!("{}{}", VERSION_0_1, share_data_str))?;
         }
         Ok(())
     }
@@ -106,11 +102,11 @@ impl<'x> SSS<'x> {
             let version = String::from_utf8(s.1[0..VERSION_ID_LEN].to_vec())?;
             let data = &s.1[VERSION_ID_LEN..];
             match version.as_str() {
-                | VERSION_0_1_0 => {
-                    let archive = serde_yaml::from_str::<Archive>(&String::from_utf8(STANDARD.decode(&data)?)?)?;
+                | VERSION_0_1 => {
+                    let archive = serde_yaml::from_str::<v1::Archive>(&String::from_utf8(STANDARD.decode(&data)?)?)?;
                     let data = match archive.share {
-                        | Share::PlainBase64(v) => STANDARD.decode(v)?,
-                        | Share::EncryptedBase64 { hash, data } => {
+                        | v1::Share::PlainBase64(v) => STANDARD.decode(v)?,
+                        | v1::Share::EncryptedBase64 { hash, data } => {
                             let pw: String = dialoguer::Password::new()
                                 .with_prompt(format!(
                                     "Enter password for share (path: {}, name: {})",
@@ -119,7 +115,7 @@ impl<'x> SSS<'x> {
                                 ))
                                 .interact()?;
                             match hash {
-                                | Hash::Argon2id(v) => {
+                                | v1::Hash::Argon2id(v) => {
                                     let pw_hash = argon2::PasswordHash::new(&v).or(Err(Error::PasswordVerification))?;
                                     self.argon
                                         .verify_password(pw.as_bytes(), &pw_hash)