test(kyberlib): ✅ add new tests for lib.rs

sebastienrousseau · May 8, 2024 · b965213 · b965213
1 parent 5d78610
commit b965213
Show file tree

Hide file tree

Showing 19 changed files with 504 additions and 18 deletions.
diff --git a/benches/bench.rs b/benches/bench.rs
@@ -1,4 +1,4 @@
-// Copyright © 2023 KyberLib. All rights reserved.
+// Copyright © 2024 kyberlib. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 //! This crate is responsible for benchmarking various components of the application.

diff --git a/src/api.rs b/src/api.rs
@@ -1,4 +1,4 @@
-// Copyright © 2023 KyberLib. All rights reserved.
+// Copyright © 2024 kyberlib. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 use crate::{

diff --git a/src/error.rs b/src/error.rs
@@ -1,4 +1,4 @@
-// Copyright © 2023 KyberLib. All rights reserved.
+// Copyright © 2024 kyberlib. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 /// Error types for the failure modes in Kyber key exchange.

diff --git a/src/kem.rs b/src/kem.rs
@@ -1,4 +1,4 @@
-// Copyright © 2023 KyberLib. All rights reserved.
+// Copyright © 2024 kyberlib. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 use crate::{

diff --git a/src/kex.rs b/src/kex.rs
@@ -1,4 +1,4 @@
-// Copyright © 2023 KyberLib. All rights reserved.
+// Copyright © 2024 kyberlib. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 use crate::{kem::*, params::*, symmetric::kdf, KyberLibError};

diff --git a/src/lib.rs b/src/lib.rs
@@ -1,4 +1,4 @@
-// Copyright © 2023 KyberLib. All rights reserved.
+// Copyright © 2024 kyberlib. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 //! # `KyberLib` 🦀
@@ -144,6 +144,7 @@ mod avx2;
 use avx2::*;
 
 #[cfg(any(not(target_arch = "x86_64"), not(feature = "avx2")))]
+/// Reference implementation for the KyberLib library.
 pub mod reference;
 #[cfg(any(not(target_arch = "x86_64"), not(feature = "avx2")))]
 use reference::*;

diff --git a/src/macros.rs b/src/macros.rs
@@ -1,4 +1,4 @@
-// Copyright © 2023 KyberLib. All rights reserved.
+// Copyright © 2024 kyberlib. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 //! # KyberLib Macros

diff --git a/src/params.rs b/src/params.rs
@@ -1,4 +1,4 @@
-// Copyright © 2023 KyberLib. All rights reserved.
+// Copyright © 2024 kyberlib. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 // Constants and parameters used in the Kyber cryptographic scheme.

diff --git a/src/rng.rs b/src/rng.rs
@@ -1,4 +1,4 @@
-// Copyright © 2023 KyberLib. All rights reserved.
+// Copyright © 2024 kyberlib. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 use crate::KyberLibError;

diff --git a/src/symmetric.rs b/src/symmetric.rs
@@ -1,4 +1,4 @@
-// Copyright © 2023 KyberLib. All rights reserved.
+// Copyright © 2024 kyberlib. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 #![allow(dead_code)]
@@ -42,7 +42,9 @@ pub type XofState = Aes256CtrCtx;
 /// Keccak state for absorbing data
 #[derive(Copy, Clone, Debug, Default)]
 pub struct KeccakState {
+    /// State array for Keccak
     pub s: [u64; 25],
+    /// Position in the state array
     pub pos: usize,
 }
 

diff --git a/src/wasm.rs b/src/wasm.rs
@@ -1,4 +1,4 @@
-// Copyright © 2023 KyberLib. All rights reserved.
+// Copyright © 2024 kyberlib. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 #![allow(non_snake_case)]

diff --git a/tests/test_error.rs b/tests/test_error.rs
@@ -1,4 +1,4 @@
-// Copyright © 2023 kyberlib. All rights reserved.
+// Copyright © 2024 kyberlib. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 #![cfg(test)]