Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

derive Copy and Clone for UnboundKey #1158

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/aead.rs
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,7 @@ impl Aad<[u8; 0]> {
}

/// An AEAD key without a designated role or nonce sequence.
#[derive(Copy, Clone)]
pub struct UnboundKey {
inner: KeyInner,
algorithm: &'static Algorithm,
Expand All @@ -399,6 +400,7 @@ impl core::fmt::Debug for UnboundKey {
}

#[allow(clippy::large_enum_variant, variant_size_differences)]
#[derive(Copy, Clone)]
enum KeyInner {
AesGcm(aes_gcm::Key),
ChaCha20Poly1305(chacha20_poly1305::Key),
Expand Down
2 changes: 2 additions & 0 deletions src/aead/aes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
use super::{counter, iv::Iv, quic::Sample, Block, Direction, BLOCK_LEN};
use crate::{bits::BitLength, c, cpu, endian::*, error, polyfill};

#[derive(Copy, Clone)]
pub(crate) struct Key {
inner: AES_KEY,
cpu_features: cpu::Features,
Expand Down Expand Up @@ -322,6 +323,7 @@ impl Key {

// Keep this in sync with AES_KEY in aes.h.
#[repr(C)]
#[derive(Copy, Clone)]
pub(super) struct AES_KEY {
pub rd_key: [u32; 4 * (MAX_ROUNDS + 1)],
pub rounds: c::uint,
Expand Down
1 change: 1 addition & 0 deletions src/aead/aes_gcm.rs
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ pub static AES_256_GCM: aead::Algorithm = aead::Algorithm {
max_input_len: AES_GCM_MAX_INPUT_LEN,
};

#[derive(Copy, Clone)]
pub struct Key {
gcm_key: gcm::Key, // First because it has a large alignment requirement.
aes_key: aes::Key,
Expand Down
1 change: 1 addition & 0 deletions src/aead/chacha.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ use super::{counter, iv::Iv, quic::Sample, BLOCK_LEN};
use crate::{c, endian::*};

#[repr(transparent)]
#[derive(Copy, Clone)]
pub struct Key([LittleEndian<u32>; KEY_LEN / 4]);

impl From<[u8; KEY_LEN]> for Key {
Expand Down
5 changes: 3 additions & 2 deletions src/aead/gcm.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ use crate::cpu;
#[cfg(not(target_arch = "aarch64"))]
mod gcm_nohw;

#[derive(Copy, Clone)]
pub struct Key(HTable);

impl Key {
Expand Down Expand Up @@ -86,7 +87,7 @@ impl Context {
inner: ContextInner {
Xi: Xi(Block::zero()),
_unused: Block::zero(),
Htable: key.0.clone(),
Htable: key.0,
},
cpu_features,
};
Expand Down Expand Up @@ -234,7 +235,7 @@ impl Context {
}

// The alignment is required by non-Rust code that uses `GCM128_CONTEXT`.
#[derive(Clone)]
#[derive(Copy, Clone)]
#[repr(C, align(16))]
struct HTable {
Htable: [u128; HTABLE_LEN],
Expand Down
44 changes: 44 additions & 0 deletions tests/aead_tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -427,6 +427,50 @@ fn test_aead_key_debug() {
);
}

#[test]
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
fn test_aead_unboundkey_copy_clone() {
let key_bytes = [0; 32];
let nonce = [0; aead::NONCE_LEN];

let key1 = aead::UnboundKey::new(&aead::AES_256_GCM, &key_bytes).unwrap();
// Copy and clone key1.
let key2 = key1;
#[allow(clippy::clone_on_copy)]
let key3 = key1.clone();

// UnboundKey doesn't support AsRef or PartialEq, so instead just check that all three keys
// produce the same encrypted output.
let mut buf1 = [0; 32];
let tag1 = aead::LessSafeKey::new(key1)
.seal_in_place_separate_tag(
aead::Nonce::try_assume_unique_for_key(&nonce).unwrap(),
aead::Aad::empty(),
&mut buf1,
)
.unwrap();
let mut buf2 = [0; 32];
let tag2 = aead::LessSafeKey::new(key2)
.seal_in_place_separate_tag(
aead::Nonce::try_assume_unique_for_key(&nonce).unwrap(),
aead::Aad::empty(),
&mut buf2,
)
.unwrap();
let mut buf3 = [0; 32];
let tag3 = aead::LessSafeKey::new(key3)
.seal_in_place_separate_tag(
aead::Nonce::try_assume_unique_for_key(&nonce).unwrap(),
aead::Aad::empty(),
&mut buf3,
)
.unwrap();
assert_eq!(tag1.as_ref(), tag2.as_ref());
assert_eq!(tag1.as_ref(), tag3.as_ref());
assert_eq!(buf1, buf2);
assert_eq!(buf1, buf3);
}

fn make_key<K: aead::BoundKey<OneNonceSequence>>(
algorithm: &'static aead::Algorithm,
key: &[u8],
Expand Down