Merge pull request #1 from philipr-za/philip-add-github-ci

philipr-za · web-flow · commit 9a76cc7a1f69 · 2025-05-14T12:34:27.000+01:00
Add github actions ci to repo
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -0,0 +1,76 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  test-latest:
+    name: Test on latest Rust
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Rust Version"
+        run: rustc --version
+      
+      - name: "Checkout code"
+        uses: actions/checkout@v4
+      
+      - name: Setup
+        run: |
+          rustc --version
+          apt-get update && apt-get install -y valgrind
+          cargo install cargo-valgrind
+          
+      - name: Run tests
+        run: |
+          cargo valgrind test
+          cargo test
+          
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: target-latest
+          path: target
+          retention-days: 14
+
+  test-msrv:
+    name: Test on Rust MSRV (1.63.0)
+    runs-on: ubuntu-latest
+    container:
+      image: rust:1.63.0
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Setup
+        run: |
+          rustc --version
+          apt-get update && apt-get install -y valgrind
+          cargo install cargo-valgrind --version 2.0.0
+          
+      - name: Run tests
+        run: |
+          cargo valgrind test
+          cargo test
+          
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: target-msrv
+          path: target
+          retention-days: 14
+
+  Format:                      
+    name: Format - nightly toolchain
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+    - name: "Checkout repo"
+      uses: actions/checkout@v4
+    - name: "Select toolchain"
+      uses: dtolnay/rust-toolchain@nightly
+    - name: "Install rustfmt"
+      run: rustup component add rustfmt
+    - name: "Check formatting"
+      run: cargo +nightly fmt --all -- --check
diff --git a/src/error.rs b/src/error.rs
@@ -20,5 +20,5 @@ pub enum Error {
     #[error("Buffer not large enough to accomodate padded buffer")]
     PaddedBufferTooSmall,
     #[error("Unable to unpad buffer: {0}")]
-    UnpadError(String)
+    UnpadError(String),
 }
diff --git a/src/padding.rs b/src/padding.rs
@@ -72,7 +72,7 @@ impl Padding for Pkcs7 {
             return Err(Error::PaddedBufferTooSmall);
         }
 
-        let padding_length = padded_length-data_length;
+        let padding_length = padded_length - data_length;
 
         buffer[data_length..padded_length].fill(padding_length as u8);
         Ok(&buffer[0..padded_length])
@@ -84,10 +84,12 @@ impl Padding for Pkcs7 {
             Some(l) => *l,
         };
         if buffer.len() < padding_length as usize {
-            return Err(Error::UnpadError("Buffer smaller than PKCS7 recorded padded length".to_string()));
+            return Err(Error::UnpadError(
+                "Buffer smaller than PKCS7 recorded padded length".to_string(),
+            ));
         }
         if padding_length == 0 {
-            return Err(Error::UnpadError("PKCS7 padding length can't be zero".to_string()))
+            return Err(Error::UnpadError("PKCS7 padding length can't be zero".to_string()));
         }
 
         Ok(&buffer[0..buffer.len() - padding_length as usize])
@@ -141,9 +143,8 @@ mod test {
         let mut buffer = [2u8; 2 * BLOCK_SIZE + 1];
 
         buffer[0..2 * BLOCK_SIZE].fill(1u8);
-        
-        let padded_buffer =
-            Pkcs7::pad(buffer.as_mut_slice(), DATA_LENGTH, BLOCK_SIZE).unwrap();
+
+        let padded_buffer = Pkcs7::pad(buffer.as_mut_slice(), DATA_LENGTH, BLOCK_SIZE).unwrap();
 
         assert_eq!(&padded_buffer[0..DATA_LENGTH], [1u8; DATA_LENGTH].as_slice());
 
diff --git a/tests/tests.rs b/tests/tests.rs
@@ -4,13 +4,13 @@
 * file COPYING or https://opensource.org/licenses/mit-license.php.   *
 **********************************************************************/
 
-extern crate hex_conservative;
 extern crate ctaes;
+extern crate hex_conservative;
 
-use hex_conservative::FromHex;
-use ctaes::{Aes128, Aes128Cbc, Aes192, Aes256, AesBlockCipher, AesCbcBlockCipher};
-use ctaes::Aes256Cbc;
 use ctaes::Aes192Cbc;
+use ctaes::Aes256Cbc;
+use ctaes::{Aes128, Aes128Cbc, Aes192, Aes256, AesBlockCipher, AesCbcBlockCipher};
+use hex_conservative::FromHex;
 
 struct AesTestVector {
     key: Vec<u8>,
@@ -25,79 +25,94 @@ fn aes_test_vectors() -> Vec<AesTestVector> {
     vectors.push(AesTestVector {
         key: <Vec<u8>>::from_hex("000102030405060708090a0b0c0d0e0f").unwrap(),
         plaintext: <Vec<u8>>::from_hex("00112233445566778899aabbccddeeff").unwrap(),
-        ciphertext: <Vec<u8>>::from_hex("69c4e0d86a7b0430d8cdb78070b4c55a").unwrap()
+        ciphertext: <Vec<u8>>::from_hex("69c4e0d86a7b0430d8cdb78070b4c55a").unwrap(),
     });
     vectors.push(AesTestVector {
         key: <Vec<u8>>::from_hex("000102030405060708090a0b0c0d0e0f1011121314151617").unwrap(),
         plaintext: <Vec<u8>>::from_hex("00112233445566778899aabbccddeeff").unwrap(),
-        ciphertext: <Vec<u8>>::from_hex("dda97ca4864cdfe06eaf70a0ec0d7191").unwrap()
+        ciphertext: <Vec<u8>>::from_hex("dda97ca4864cdfe06eaf70a0ec0d7191").unwrap(),
     });
     vectors.push(AesTestVector {
-        key: <Vec<u8>>::from_hex("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap(),
+        key: <Vec<u8>>::from_hex(
+            "000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f",
+        )
+        .unwrap(),
         plaintext: <Vec<u8>>::from_hex("00112233445566778899aabbccddeeff").unwrap(),
-        ciphertext: <Vec<u8>>::from_hex("8ea2b7ca516745bfeafc49904b496089").unwrap()
+        ciphertext: <Vec<u8>>::from_hex("8ea2b7ca516745bfeafc49904b496089").unwrap(),
     });
 
     /* AES-ECB test vectors from NIST sp800-38a. */
     vectors.push(AesTestVector {
         key: <Vec<u8>>::from_hex("2b7e151628aed2a6abf7158809cf4f3c").unwrap(),
         plaintext: <Vec<u8>>::from_hex("6bc1bee22e409f96e93d7e117393172a").unwrap(),
-        ciphertext: <Vec<u8>>::from_hex("3ad77bb40d7a3660a89ecaf32466ef97").unwrap()
+        ciphertext: <Vec<u8>>::from_hex("3ad77bb40d7a3660a89ecaf32466ef97").unwrap(),
     });
     vectors.push(AesTestVector {
         key: <Vec<u8>>::from_hex("2b7e151628aed2a6abf7158809cf4f3c").unwrap(),
         plaintext: <Vec<u8>>::from_hex("ae2d8a571e03ac9c9eb76fac45af8e51").unwrap(),
-        ciphertext: <Vec<u8>>::from_hex("f5d3d58503b9699de785895a96fdbaaf").unwrap()
+        ciphertext: <Vec<u8>>::from_hex("f5d3d58503b9699de785895a96fdbaaf").unwrap(),
     });
     vectors.push(AesTestVector {
         key: <Vec<u8>>::from_hex("2b7e151628aed2a6abf7158809cf4f3c").unwrap(),
         plaintext: <Vec<u8>>::from_hex("30c81c46a35ce411e5fbc1191a0a52ef").unwrap(),
-        ciphertext: <Vec<u8>>::from_hex("43b1cd7f598ece23881b00e3ed030688").unwrap()
+        ciphertext: <Vec<u8>>::from_hex("43b1cd7f598ece23881b00e3ed030688").unwrap(),
     });
     vectors.push(AesTestVector {
         key: <Vec<u8>>::from_hex("2b7e151628aed2a6abf7158809cf4f3c").unwrap(),
         plaintext: <Vec<u8>>::from_hex("f69f2445df4f9b17ad2b417be66c3710").unwrap(),
-        ciphertext: <Vec<u8>>::from_hex("7b0c785e27e8ad3f8223207104725dd4").unwrap()
+        ciphertext: <Vec<u8>>::from_hex("7b0c785e27e8ad3f8223207104725dd4").unwrap(),
     });
     vectors.push(AesTestVector {
         key: <Vec<u8>>::from_hex("8e73b0f7da0e6452c810f32b809079e562f8ead2522c6b7b").unwrap(),
         plaintext: <Vec<u8>>::from_hex("6bc1bee22e409f96e93d7e117393172a").unwrap(),
-        ciphertext: <Vec<u8>>::from_hex("bd334f1d6e45f25ff712a214571fa5cc").unwrap()
+        ciphertext: <Vec<u8>>::from_hex("bd334f1d6e45f25ff712a214571fa5cc").unwrap(),
     });
     vectors.push(AesTestVector {
         key: <Vec<u8>>::from_hex("8e73b0f7da0e6452c810f32b809079e562f8ead2522c6b7b").unwrap(),
         plaintext: <Vec<u8>>::from_hex("ae2d8a571e03ac9c9eb76fac45af8e51").unwrap(),
-        ciphertext: <Vec<u8>>::from_hex("974104846d0ad3ad7734ecb3ecee4eef").unwrap()
+        ciphertext: <Vec<u8>>::from_hex("974104846d0ad3ad7734ecb3ecee4eef").unwrap(),
     });
     vectors.push(AesTestVector {
         key: <Vec<u8>>::from_hex("8e73b0f7da0e6452c810f32b809079e562f8ead2522c6b7b").unwrap(),
         plaintext: <Vec<u8>>::from_hex("30c81c46a35ce411e5fbc1191a0a52ef").unwrap(),
-        ciphertext: <Vec<u8>>::from_hex("ef7afd2270e2e60adce0ba2face6444e").unwrap()
+        ciphertext: <Vec<u8>>::from_hex("ef7afd2270e2e60adce0ba2face6444e").unwrap(),
     });
     vectors.push(AesTestVector {
         key: <Vec<u8>>::from_hex("8e73b0f7da0e6452c810f32b809079e562f8ead2522c6b7b").unwrap(),
         plaintext: <Vec<u8>>::from_hex("f69f2445df4f9b17ad2b417be66c3710").unwrap(),
-        ciphertext: <Vec<u8>>::from_hex("9a4b41ba738d6c72fb16691603c18e0e").unwrap()
+        ciphertext: <Vec<u8>>::from_hex("9a4b41ba738d6c72fb16691603c18e0e").unwrap(),
     });
     vectors.push(AesTestVector {
-        key: <Vec<u8>>::from_hex("603deb1015ca71be2b73aef0857d77811f352c073b6108d72d9810a30914dff4").unwrap(),
+        key: <Vec<u8>>::from_hex(
+            "603deb1015ca71be2b73aef0857d77811f352c073b6108d72d9810a30914dff4",
+        )
+        .unwrap(),
         plaintext: <Vec<u8>>::from_hex("6bc1bee22e409f96e93d7e117393172a").unwrap(),
-        ciphertext: <Vec<u8>>::from_hex("f3eed1bdb5d2a03c064b5a7e3db181f8").unwrap()
+        ciphertext: <Vec<u8>>::from_hex("f3eed1bdb5d2a03c064b5a7e3db181f8").unwrap(),
     });
     vectors.push(AesTestVector {
-        key: <Vec<u8>>::from_hex("603deb1015ca71be2b73aef0857d77811f352c073b6108d72d9810a30914dff4").unwrap(),
+        key: <Vec<u8>>::from_hex(
+            "603deb1015ca71be2b73aef0857d77811f352c073b6108d72d9810a30914dff4",
+        )
+        .unwrap(),
         plaintext: <Vec<u8>>::from_hex("ae2d8a571e03ac9c9eb76fac45af8e51").unwrap(),
-        ciphertext: <Vec<u8>>::from_hex("591ccb10d410ed26dc5ba74a31362870").unwrap()
+        ciphertext: <Vec<u8>>::from_hex("591ccb10d410ed26dc5ba74a31362870").unwrap(),
     });
     vectors.push(AesTestVector {
-        key: <Vec<u8>>::from_hex("603deb1015ca71be2b73aef0857d77811f352c073b6108d72d9810a30914dff4").unwrap(),
+        key: <Vec<u8>>::from_hex(
+            "603deb1015ca71be2b73aef0857d77811f352c073b6108d72d9810a30914dff4",
+        )
+        .unwrap(),
         plaintext: <Vec<u8>>::from_hex("30c81c46a35ce411e5fbc1191a0a52ef").unwrap(),
-        ciphertext: <Vec<u8>>::from_hex("b6ed21b99ca6f4f9f153e7b1beafed1d").unwrap()
+        ciphertext: <Vec<u8>>::from_hex("b6ed21b99ca6f4f9f153e7b1beafed1d").unwrap(),
     });
     vectors.push(AesTestVector {
-        key: <Vec<u8>>::from_hex("603deb1015ca71be2b73aef0857d77811f352c073b6108d72d9810a30914dff4").unwrap(),
+        key: <Vec<u8>>::from_hex(
+            "603deb1015ca71be2b73aef0857d77811f352c073b6108d72d9810a30914dff4",
+        )
+        .unwrap(),
         plaintext: <Vec<u8>>::from_hex("f69f2445df4f9b17ad2b417be66c3710").unwrap(),
-        ciphertext: <Vec<u8>>::from_hex("23304b7a39f9f3ff067d8d8f9e24ecc7").unwrap()
+        ciphertext: <Vec<u8>>::from_hex("23304b7a39f9f3ff067d8d8f9e24ecc7").unwrap(),
     });
 
     vectors
@@ -135,23 +150,22 @@ fn aes_cbc_test_vectors() -> Vec<AesCbcTestVector> {
     vectors
 }
 
-
 #[test]
 fn test_aes_ciphers() {
     for test_vector in aes_test_vectors() {
         match test_vector.key.len() {
             16 => {
                 let cipher = Aes128::new(test_vector.key.as_slice()).unwrap();
                 test_cipher(cipher, &test_vector.plaintext, &test_vector.ciphertext);
-            },
+            }
             24 => {
                 let cipher = Aes192::new(test_vector.key.as_slice()).unwrap();
                 test_cipher(cipher, &test_vector.plaintext, &test_vector.ciphertext);
-            },
+            }
             32 => {
                 let cipher = Aes256::new(test_vector.key.as_slice()).unwrap();
                 test_cipher(cipher, &test_vector.plaintext, &test_vector.ciphertext);
-            },
+            }
             _ => panic!("Invalid key length"),
         };
     }
@@ -173,17 +187,20 @@ fn test_aes_cbc_ciphers() {
     for test_vector in aes_cbc_test_vectors() {
         match test_vector.key.len() {
             16 => {
-                let cipher = Aes128Cbc::new(test_vector.key.as_slice(), test_vector.iv.as_slice()).unwrap();
+                let cipher =
+                    Aes128Cbc::new(test_vector.key.as_slice(), test_vector.iv.as_slice()).unwrap();
                 test_cbc_cipher(cipher, &test_vector.plaintext, &test_vector.ciphertext);
-            },
+            }
             24 => {
-                let cipher = Aes192Cbc::new(test_vector.key.as_slice(), test_vector.iv.as_slice()).unwrap();
+                let cipher =
+                    Aes192Cbc::new(test_vector.key.as_slice(), test_vector.iv.as_slice()).unwrap();
                 test_cbc_cipher(cipher, &test_vector.plaintext, &test_vector.ciphertext);
-            },
+            }
             32 => {
-                let cipher = Aes256Cbc::new(test_vector.key.as_slice(), test_vector.iv.as_slice()).unwrap();
+                let cipher =
+                    Aes256Cbc::new(test_vector.key.as_slice(), test_vector.iv.as_slice()).unwrap();
                 test_cbc_cipher(cipher, &test_vector.plaintext, &test_vector.ciphertext);
-            },
+            }
             _ => panic!("Invalid key length"),
         };
     }
@@ -198,4 +215,4 @@ fn test_cbc_cipher<T: AesCbcBlockCipher>(cipher: T, plaintext: &Vec<u8>, ciphert
 
     cipher.decrypt(ciphered.as_slice(), deciphered.as_mut_slice()).unwrap();
     assert_eq!(deciphered.as_slice(), plaintext.as_slice());
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -20,5 +20,5 @@ pub enum Error {`
`20`	`20`	`#[error("Buffer not large enough to accomodate padded buffer")]`
`21`	`21`	`PaddedBufferTooSmall,`
`22`	`22`	`#[error("Unable to unpad buffer: {0}")]`
`23`		`- UnpadError(String)`
	`23`	`+ UnpadError(String),`
`24`	`24`	`}`