From 5dec70af925c9c315a02562373d402e64d9921b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rodolphe=20Br=C3=A9ard?= Date: Sun, 7 Apr 2024 11:48:33 +0200 Subject: [PATCH] Rename the CipherBox as Coffio --- src/{cipher_box.rs => coffio.rs} | 20 ++++++++++---------- src/lib.rs | 4 ++-- src/scheme.rs | 4 ++-- 3 files changed, 14 insertions(+), 14 deletions(-) rename src/{cipher_box.rs => coffio.rs} (96%) diff --git a/src/cipher_box.rs b/src/coffio.rs similarity index 96% rename from src/cipher_box.rs rename to src/coffio.rs index c15b6d4..a5bae98 100644 --- a/src/cipher_box.rs +++ b/src/coffio.rs @@ -5,11 +5,11 @@ use crate::kdf::derive_key; use crate::{storage, IkmId, InputKeyMaterialList}; use std::time::{SystemTime, UNIX_EPOCH}; -pub struct CipherBox<'a> { +pub struct Coffio<'a> { ikm_list: &'a InputKeyMaterialList, } -impl<'a> CipherBox<'a> { +impl<'a> Coffio<'a> { pub fn new(ikm_list: &'a InputKeyMaterialList) -> Self { Self { ikm_list } } @@ -113,7 +113,7 @@ mod tests { let lst = get_ikm_lst_chacha20poly1305_blake3(); let key_ctx = get_static_empty_key_ctx(); let data_ctx = DataContext::from([]); - let cb = CipherBox::new(&lst); + let cb = Coffio::new(&lst); // Encrypt let res = cb.encrypt(&key_ctx, &data_ctx, TEST_DATA); @@ -134,7 +134,7 @@ mod tests { let lst = get_ikm_lst_aes128gcm_sha256(); let key_ctx = get_static_empty_key_ctx(); let data_ctx = DataContext::from([]); - let cb = CipherBox::new(&lst); + let cb = Coffio::new(&lst); // Encrypt let res = cb.encrypt(&key_ctx, &data_ctx, TEST_DATA); @@ -155,7 +155,7 @@ mod tests { let lst = get_ikm_lst_chacha20poly1305_blake3(); let key_ctx = get_static_key_ctx(); let data_ctx = DataContext::from(TEST_DATA_CTX); - let cb = CipherBox::new(&lst); + let cb = Coffio::new(&lst); // Encrypt let res = cb.encrypt(&key_ctx, &data_ctx, TEST_DATA); @@ -176,7 +176,7 @@ mod tests { let lst = get_ikm_lst_aes128gcm_sha256(); let key_ctx = get_static_key_ctx(); let data_ctx = DataContext::from(TEST_DATA_CTX); - let cb = CipherBox::new(&lst); + let cb = Coffio::new(&lst); // Encrypt let res = cb.encrypt(&key_ctx, &data_ctx, TEST_DATA); @@ -197,7 +197,7 @@ mod tests { let lst = get_ikm_lst_chacha20poly1305_blake3(); let key_ctx = KeyContext::from(TEST_KEY_CTX); let data_ctx = DataContext::from(TEST_DATA_CTX); - let cb = CipherBox::new(&lst); + let cb = Coffio::new(&lst); // Encrypt let res = cb.encrypt(&key_ctx, &data_ctx, TEST_DATA); @@ -218,7 +218,7 @@ mod tests { let lst = get_ikm_lst_aes128gcm_sha256(); let key_ctx = KeyContext::from(TEST_KEY_CTX); let data_ctx = DataContext::from(TEST_DATA_CTX); - let cb = CipherBox::new(&lst); + let cb = Coffio::new(&lst); // Encrypt let res = cb.encrypt(&key_ctx, &data_ctx, TEST_DATA); @@ -249,7 +249,7 @@ mod tests { let lst = get_ikm_lst_chacha20poly1305_blake3(); let key_ctx = KeyContext::from(TEST_KEY_CTX); let data_ctx = DataContext::from(TEST_DATA_CTX); - let cb = CipherBox::new(&lst); + let cb = Coffio::new(&lst); // Test if the reference ciphertext used for the tests is actually valid let res = cb.decrypt(&key_ctx, &data_ctx, TEST_CIPHERTEXT); @@ -267,7 +267,7 @@ mod tests { let lst = get_ikm_lst_chacha20poly1305_blake3(); let key_ctx = KeyContext::from(TEST_KEY_CTX); let data_ctx = DataContext::from(TEST_DATA_CTX); - let cb = CipherBox::new(&lst); + let cb = Coffio::new(&lst); let res = cb.decrypt(&key_ctx, &data_ctx, TEST_CIPHERTEXT); assert!(res.is_ok(), "invalid reference ciphertext"); diff --git a/src/lib.rs b/src/lib.rs index 7183f7b..58da25c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,7 +1,7 @@ #[cfg(feature = "encryption")] mod canonicalization; #[cfg(feature = "encryption")] -mod cipher_box; +mod coffio; #[cfg(feature = "encryption")] mod context; #[cfg(feature = "encryption")] @@ -18,7 +18,7 @@ mod scheme; mod storage; #[cfg(feature = "encryption")] -pub use cipher_box::CipherBox; +pub use coffio::Coffio; #[cfg(feature = "encryption")] pub use context::{DataContext, KeyContext}; #[cfg(any(feature = "encryption", feature = "ikm-management"))] diff --git a/src/scheme.rs b/src/scheme.rs index d291f87..d45341a 100644 --- a/src/scheme.rs +++ b/src/scheme.rs @@ -36,10 +36,10 @@ pub(crate) type SchemeSerializeType = u32; /// In the following scheme description, the following terms are used: /// - `Max data size` describes the maximal size of data that can safely be encrypted using a /// single key and nonce, which means you should never pass a `data` parameter to -/// [encrypt][crate::CipherBox::encrypt] that has a higher size. Coffio will not enforce this +/// [encrypt][crate::Coffio::encrypt] that has a higher size. Coffio will not enforce this /// limit, it is your responsibility to do so. /// - `Max invocations` describes the maximal number of times you can safely call -/// [encrypt][crate::CipherBox::encrypt] with a single key, which means you should either rotate +/// [encrypt][crate::Coffio::encrypt] with a single key, which means you should either rotate /// your IKM or use an appropriate key periodicity before reaching this number. Coffio will neither /// enforce this limit nor count the number of invocations, it is your responsibility to do so. #[derive(Copy, Clone, Debug, PartialEq)]