Merge pull request #1 from 448-engineering/better_api

Better api

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "memsecurity"
-version = "1.0.0"
+version = "1.2.0"
 authors = ["448 ENGINEERING DESIGN DEVELOPERS <superuser@448.africa>"]
 license = "Apache-2.0 OR MIT"
 description = "Securely hold secrets in memory and protect them against cross-protection-boundary readout via microarchitectural, via attacks on physical layout, and via coldboot attacks."

src/keygen.rs

@@ -92,7 +92,8 @@ mod keymaker {
                     Err(_) => return Err(MemSecurityErr::EncryptionErr)
                 }
 
-            let ciphertext = ZeroizeBytesArray::with_additional_capacity(TAG_LENGTH).set(buffer);
+            let ciphertext =
+                ZeroizeBytesArray::with_additional_capacity(TAG_LENGTH).set_bytes_mut(buffer);
 
             self.add_ciphertext(ciphertext);
 
@@ -112,7 +113,7 @@ mod keymaker {
                 b"",
                 &mut buffer,
             ) {
-                Ok(_) => Ok(ZeroizeBytesArray::new().set(buffer)),
+                Ok(_) => Ok(ZeroizeBytesArray::new().set_bytes_mut(buffer)),
                 Err(_) => {
                     buffer.fill(0); // Zero out the partially decrypted plaintext
                     drop(buffer); // Drop the partially leaked plaintext

src/zeroizable_arrays.rs

@@ -116,8 +116,24 @@ impl<const N: usize> ZeroizeBytesArray<N> {
         ZeroizeBytesArray(BytesMut::with_capacity(N))
     }
 
+    /// Initialize the array and set the internal value of the array to the value specified by method argument
+    pub fn new_with_data(value: [u8; N]) -> Self {
+        let mut value_bytes = BytesMut::with_capacity(N);
+
+        value_bytes.put(&value[..]);
+
+        ZeroizeBytesArray(value_bytes)
+    }
+
     /// Set the internal value of the array to the value specified by method argument
-    pub fn set(mut self, value: BytesMut) -> Self {
+    pub fn set(mut self, value: [u8; N]) -> Self {
+        self.0.put(&value[..]);
+
+        self
+    }
+
+    /// Set the internal value of the array to the value specified by method argument value which is a `BytesMut`
+    pub fn set_bytes_mut(mut self, value: BytesMut) -> Self {
         self.0.put(&value[..]);
 
         self
@@ -197,6 +213,21 @@ impl ZeroizeBytes {
         ZeroizeBytes(BytesMut::new())
     }
 
+    /// Initialize the array and set the internal value of the array to the value specified by method argument
+    pub fn new_with_data(value: &[u8]) -> Self {
+        let mut value_bytes = BytesMut::new();
+        value_bytes.put(&value[..]);
+
+        ZeroizeBytes(value_bytes)
+    }
+
+    /// Set the internal value of the array to the value specified by method argument value which is a `BytesMut`
+    pub fn set_bytes_mut(mut self, value: BytesMut) -> Self {
+        self.0.put(&value[..]);
+
+        self
+    }
+
     /// Sets the internal value to the new value
     pub fn set(&mut self, value: BytesMut) -> &mut Self {
         self.0.put(&value[..]);