cleanup CI, cargo.toml, README and license blocks

Author: philipr-za

.github/workflows/rust.yml

@@ -26,6 +26,7 @@ jobs:
         run: |
           cargo valgrind test
           cargo test
+          cargo test --doc
           
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
@@ -45,11 +46,13 @@ jobs:
       - name: Setup
         run: |
           rustc --version
-          apt-get update && apt-get install -y valgrind
+          sudo apt-get update && sudo apt-get install -y valgrind
           cargo install cargo-valgrind --version 2.0.0
           
       - name: Run tests
         run: |
+          rm Cargo.lock
+          cargo +1.63.0 generate-lockfile
           cargo valgrind test
           cargo test
           

Cargo.lock

@@ -1,9 +1,14 @@
 [package]
-name = "ctaes"
+name = "ctaes-rs"
 version = "0.1.0"
-authors = ["Blockstream <[email protected]>"]
-links = "ctaes"
-edition = "2015"
+authors = ["Philip Robinson <[email protected]>"]
+license = "MIT"
+homepage = "https://github.com/ElementsProject/rust-ctaes/"
+repository = "https://github.com/ElementsProject/rust-ctaes/"
+description = "Rust bindings and API for CTAES a constant-time AES implementation from Bitcoin Core https://github.com/bitcoin-core/ctaes"
+keywords = [ "crypto", "bitcoin", "aes" ]
+readme = "README.md"
+edition = "2021"
 
 [dependencies]
 thiserror = "1.0.30"

Cargo.toml

@@ -1,6 +1,7 @@
-# rust-ctaes
+# ctaes-rs
 
-A Rust FFI wrapper for CTAES library from <https://github.com/bitcoin-core/ctaes>
+Rust bindings and API for CTAES (constant-time AES implementation from Bitcoin Core found at
+https://github.com/bitcoin-core/ctaes")
 
 The CTAES Library provides a constant time implementation of the AES algorithm. For completeness
 this crate provides the interface to the AES-ECB methods, but they should not be used. Rather,

README.md

@@ -1,8 +1,6 @@
-/*********************************************************************
-* Copyright (c) 2023 Blockstream                                     *
-* Distributed under the MIT software license, see the accompanying   *
-* file COPYING or https://opensource.org/licenses/mit-license.php.   *
-**********************************************************************/
+// Copyright (c) 2023 Blockstream
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or https://opensource.org/licenses/mit-license.php.
 
 // Using Zeroize to zero out the memory used by AES contexts on drop
 use zeroize::Zeroize;

src/ctaes_ffi.rs

@@ -1,8 +1,6 @@
-/*********************************************************************
-* Copyright (c) 2023 Blockstream                                     *
-* Distributed under the MIT software license, see the accompanying   *
-* file COPYING or https://opensource.org/licenses/mit-license.php.   *
-**********************************************************************/
+// Copyright (c) 2023 Blockstream
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or https://opensource.org/licenses/mit-license.php.
 
 use thiserror::Error;
 

src/error.rs

@@ -1,4 +1,9 @@
-//! A Rust FFI wrapper for CTAES library from <https://github.com/bitcoin-core/ctaes>
+// Copyright (c) 2023 Blockstream
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or https://opensource.org/licenses/mit-license.php.
+
+//! Rust bindings and API for CTAES (constant-time AES implementation from Bitcoin Core found at
+//! https://github.com/bitcoin-core/ctaes)
 //!
 //! The CTAES Library provides a constant time implementation of the AES algorithm. For completeness
 //! this crate provides the interface to the AES-ECB methods, but they should not be used. Rather,
@@ -12,7 +17,7 @@
 //! ```
 //! extern crate hex_conservative;
 //! use hex_conservative::FromHex;
-//! use ctaes::{Padding, Pkcs7, AesCbcBlockCipher, Aes128Cbc};
+//! use ctaes_rs::{Padding, Pkcs7, AesCbcBlockCipher, Aes128Cbc};
 //!
 //! let key = <[u8; 16]>::from_hex("2b7e151628aed2a6abf7158809cf4f3c").unwrap();
 //! let iv = <[u8; 16]>::from_hex("000102030405060708090a0b0c0d0e0f").unwrap();
@@ -396,10 +401,10 @@ impl AesCbcBlockCipher for Aes256Cbc<'_> {}
 
 #[cfg(test)]
 mod test {
-    use AES128_KEY_LENGTH;
-    use AES192_KEY_LENGTH;
-    use AES256_KEY_LENGTH;
-    use {
+    use crate::AES128_KEY_LENGTH;
+    use crate::AES192_KEY_LENGTH;
+    use crate::AES256_KEY_LENGTH;
+    use crate::{
         Aes128, Aes128Cbc, Aes192, Aes192Cbc, Aes256, Aes256Cbc, AesBlockCipher, AesCbcBlockCipher,
         Error,
     };

src/lib.rs

@@ -1,10 +1,8 @@
-/*********************************************************************
- * Copyright (c) 2023 Blockstream                                     *
- * Distributed under the MIT software license, see the accompanying   *
- * file COPYING or https://opensource.org/licenses/mit-license.php.   *
- **********************************************************************/
+// Copyright (c) 2023 Blockstream
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or https://opensource.org/licenses/mit-license.php.
 
-use Error;
+use crate::Error;
 
 /// Trait defining interface for a Padding implementation
 pub trait Padding {
@@ -98,8 +96,8 @@ impl Padding for Pkcs7 {
 
 #[cfg(test)]
 mod test {
-    use padding::{Padding, Pkcs7, ZeroPadding};
-    use Error;
+    use crate::padding::{Padding, Pkcs7, ZeroPadding};
+    use crate::Error;
 
     #[test]
     fn test_zero_padding() {

src/padding.rs

@@ -4,12 +4,11 @@
 * file COPYING or https://opensource.org/licenses/mit-license.php.   *
 **********************************************************************/
 
-extern crate ctaes;
 extern crate hex_conservative;
 
-use ctaes::Aes192Cbc;
-use ctaes::Aes256Cbc;
-use ctaes::{Aes128, Aes128Cbc, Aes192, Aes256, AesBlockCipher, AesCbcBlockCipher};
+use ctaes_rs::Aes192Cbc;
+use ctaes_rs::Aes256Cbc;
+use ctaes_rs::{Aes128, Aes128Cbc, Aes192, Aes256, AesBlockCipher, AesCbcBlockCipher};
 use hex_conservative::FromHex;
 
 struct AesTestVector {