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.

Sign up for GitHub

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

Jump to bottom

feat(net): add Framed ECIES implementation #80

Merged
merged 15 commits into from
Oct 16, 2022
Merged

feat(net): add Framed ECIES implementation #80

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
09d624f
feat(net): add ecies crate
Rjected Oct 15, 2022
d9b4b1c
cargo fmt
Rjected Oct 15, 2022
fc89dd6
add hex-literal and proptest to dev-dependencies
Rjected Oct 15, 2022
761cf6a
document util
Rjected Oct 15, 2022
deb4c74
document more
Rjected Oct 15, 2022
49fd89d
chore: allow missing docs in ecies/algorith.rs
gakonst Oct 15, 2022
c6b773f
feat(ecies): improve error handling
gakonst Oct 15, 2022
a658e35
refactor(ecies): movem ingress/egress to lib.rs
gakonst Oct 15, 2022
95f11f1
chore(ecies): allow missing docs in mac
gakonst Oct 15, 2022
99f69c2
chore(ecies): cleanup utils
gakonst Oct 15, 2022
e136130
refactor(ecies): move ECIES Codec to separate file
gakonst Oct 15, 2022
33dca46
refactor(ecies): rename proto to stream
gakonst Oct 15, 2022
ed31e6e
add test scaffold
gakonst Oct 15, 2022
84b38b0
implement server/client read/write test
Rjected Oct 16, 2022
4e4a655
chore: clippy / fmt
gakonst Oct 16, 2022
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
Prev Previous commit
Next Next commit
cargo fmt
  • Loading branch information
@Rjected
Rjected committed Oct 15, 2022
commit d9b4b1c45638afdeeb5973edfbceb8e60eae4503
126 changes: 35 additions & 91 deletions crates/net/ecies/src/algorithm.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use crate::{
mac::{HeaderBytes, MAC},
util::{hmac_sha256, id2pk, pk2id, sha256},
proto::ECIESError,
util::{hmac_sha256, id2pk, pk2id, sha256},
};
use aes::{cipher::StreamCipher, Aes128, Aes256};
use anyhow::{format_err, Context};
Expand All @@ -10,9 +10,9 @@ use bytes::{BufMut, Bytes, BytesMut};
use ctr::Ctr64BE;
use digest::{crypto_common::KeyIvInit, Digest};
use educe::Educe;
use rand::{thread_rng, Rng};
use reth_primitives::{H128, H256, H512 as PeerId};
use reth_rlp::{Encodable, Rlp, RlpEncodable, RlpMaxEncodedLen};
use rand::{thread_rng, Rng};
use secp256k1::{
ecdsa::{RecoverableSignature, RecoveryId},
PublicKey, SecretKey, SECP256K1,
Expand All @@ -37,12 +37,7 @@ fn kdf(secret: H256, s1: &[u8], dest: &mut [u8]) {
let mut written = 0_usize;
while written < dest.len() {
let mut hasher = Sha256::default();
let ctrs = [
(ctr >> 24) as u8,
(ctr >> 16) as u8,
(ctr >> 8) as u8,
ctr as u8,
];
let ctrs = [(ctr >> 24) as u8, (ctr >> 16) as u8, (ctr >> 8) as u8, ctr as u8];
hasher.update(&ctrs);
hasher.update(secret.as_bytes());
hasher.update(s1);
Expand Down Expand Up @@ -87,10 +82,7 @@ pub struct ECIES {

fn split_at_mut<T>(arr: &mut [T], mid: usize) -> Result<(&mut [T], &mut [T]), ECIESError> {
if mid > arr.len() {
return Err(ECIESError::Other(format_err!(
"too short: {mid} > {}",
arr.len()
)));
return Err(ECIESError::Other(format_err!("too short: {mid} > {}", arr.len())))
}
Ok(arr.split_at_mut(mid))
}
Expand Down Expand Up @@ -203,11 +195,8 @@ impl ECIES {

let total_size: u16 = u16::try_from(65 + 16 + data.len() + 32).unwrap();

let tag = hmac_sha256(
mac_key.as_ref(),
&[iv.as_bytes(), &encrypted],
&total_size.to_be_bytes(),
);
let tag =
hmac_sha256(mac_key.as_ref(), &[iv.as_bytes(), &encrypted], &total_size.to_be_bytes());

out.extend_from_slice(iv.as_bytes());
out.extend_from_slice(&encrypted);
Expand All @@ -231,7 +220,7 @@ impl ECIES {

let check_tag = hmac_sha256(mac_key.as_ref(), &[iv, encrypted_data], auth_data);
if check_tag != tag {
return Err(ECIESError::TagCheckFailed);
return Err(ECIESError::TagCheckFailed)
}

let decrypted_data = encrypted_data;
Expand Down Expand Up @@ -308,9 +297,7 @@ impl ECIES {
fn parse_auth_unencrypted(&mut self, data: &[u8]) -> Result<(), ECIESError> {
let mut data = Rlp::new(data)?;

let sigdata = data
.get_next::<[u8; 65]>()?
.ok_or(ECIESError::InvalidAuthData)?;
let sigdata = data.get_next::<[u8; 65]>()?.ok_or(ECIESError::InvalidAuthData)?;
let signature = RecoverableSignature::from_compact(
&sigdata[0..64],
RecoveryId::from_i32(sigdata[64] as i32)?,
Expand All @@ -325,10 +312,8 @@ impl ECIES {
&secp256k1::Message::from_slice((x ^ self.remote_nonce.unwrap()).as_ref()).unwrap(),
&signature,
)?);
self.ephemeral_shared_secret = Some(ecdh_x(
&self.remote_ephemeral_public_key.unwrap(),
&self.ephemeral_secret_key,
));
self.ephemeral_shared_secret =
Some(ecdh_x(&self.remote_ephemeral_public_key.unwrap(), &self.ephemeral_secret_key));

Ok(())
}
Expand Down Expand Up @@ -390,10 +375,8 @@ impl ECIES {
Some(id2pk(data.get_next()?.ok_or(ECIESError::InvalidAckData)?)?);
self.remote_nonce = Some(data.get_next()?.ok_or(ECIESError::InvalidAckData)?);

self.ephemeral_shared_secret = Some(ecdh_x(
&self.remote_ephemeral_public_key.unwrap(),
&self.ephemeral_secret_key,
));
self.ephemeral_shared_secret =
Some(ecdh_x(&self.remote_ephemeral_public_key.unwrap(), &self.ephemeral_secret_key));
Ok(())
}

Expand Down Expand Up @@ -430,14 +413,10 @@ impl ECIES {
hasher.update(shared_secret.as_ref());
H256::from(hasher.finalize().as_ref())
};
self.ingress_aes = Some(Ctr64BE::<Aes256>::new(
aes_secret.as_ref().into(),
iv.as_ref().into(),
));
self.egress_aes = Some(Ctr64BE::<Aes256>::new(
aes_secret.as_ref().into(),
iv.as_ref().into(),
));
self.ingress_aes =
Some(Ctr64BE::<Aes256>::new(aes_secret.as_ref().into(), iv.as_ref().into()));
self.egress_aes =
Some(Ctr64BE::<Aes256>::new(aes_secret.as_ref().into(), iv.as_ref().into()));

let mac_secret: H256 = {
let mut hasher = Keccak256::new();
Expand All @@ -446,23 +425,14 @@ impl ECIES {
H256::from(hasher.finalize().as_ref())
};
self.ingress_mac = Some(MAC::new(mac_secret));
self.ingress_mac
.as_mut()
.unwrap()
.update((mac_secret ^ self.nonce).as_ref());
self.ingress_mac
.as_mut()
.unwrap()
.update(self.remote_init_msg.as_ref().unwrap());
self.ingress_mac.as_mut().unwrap().update((mac_secret ^ self.nonce).as_ref());
self.ingress_mac.as_mut().unwrap().update(self.remote_init_msg.as_ref().unwrap());
self.egress_mac = Some(MAC::new(mac_secret));
self.egress_mac
.as_mut()
.unwrap()
.update((mac_secret ^ self.remote_nonce.unwrap()).as_ref());
self.egress_mac
.as_mut()
.unwrap()
.update(self.init_msg.as_ref().unwrap());
self.egress_mac.as_mut().unwrap().update(self.init_msg.as_ref().unwrap());
}

#[cfg(test)]
Expand All @@ -480,10 +450,7 @@ impl ECIES {
header[3..6].copy_from_slice(&[194, 128, 128]);

let mut header = HeaderBytes::from(header);
self.egress_aes
.as_mut()
.unwrap()
.apply_keystream(&mut header);
self.egress_aes.as_mut().unwrap().apply_keystream(&mut header);
self.egress_mac.as_mut().unwrap().update_header(&header);
let tag = self.egress_mac.as_mut().unwrap().digest();

Expand All @@ -500,24 +467,21 @@ impl ECIES {
self.ingress_mac.as_mut().unwrap().update_header(header);
let check_mac = self.ingress_mac.as_mut().unwrap().digest();
if check_mac != mac {
return Err(ECIESError::TagCheckFailed);
return Err(ECIESError::TagCheckFailed)
}

self.ingress_aes.as_mut().unwrap().apply_keystream(header);
if header.as_slice().len() < 3 {
return Err(ECIESError::InvalidHeader);
return Err(ECIESError::InvalidHeader)
}
let body_size = usize::try_from(header.as_slice().read_uint::<BigEndian>(3)?)
.context("excessive body len")?;

if body_size > MAX_BODY_SIZE {
return Err(ECIESError::IO(io::Error::new(
io::ErrorKind::InvalidInput,
format!(
"body size ({}) exceeds limit ({} bytes)",
body_size, MAX_BODY_SIZE
),
)));
format!("body size ({}) exceeds limit ({} bytes)", body_size, MAX_BODY_SIZE),
)))
}

self.body_size = Some(body_size);
Expand All @@ -531,11 +495,7 @@ impl ECIES {

pub fn body_len(&self) -> usize {
let len = self.body_size.unwrap();
(if len % 16 == 0 {
len
} else {
(len / 16 + 1) * 16
}) + 16
(if len % 16 == 0 { len } else { (len / 16 + 1) * 16 }) + 16
}

#[cfg(test)]
Expand All @@ -546,11 +506,7 @@ impl ECIES {
}

pub fn write_body(&mut self, out: &mut BytesMut, data: &[u8]) {
let len = if data.len() % 16 == 0 {
data.len()
} else {
(data.len() / 16 + 1) * 16
};
let len = if data.len() % 16 == 0 { data.len() } else { (data.len() / 16 + 1) * 16 };
let old_len = out.len();
out.resize(old_len + len, 0);

Expand All @@ -570,7 +526,7 @@ impl ECIES {
self.ingress_mac.as_mut().unwrap().update_body(body);
let check_mac = self.ingress_mac.as_mut().unwrap().digest();
if check_mac != mac {
return Err(ECIESError::TagCheckFailed);
return Err(ECIESError::TagCheckFailed)
}

let size = self.body_size.unwrap();
Expand Down Expand Up @@ -687,22 +643,13 @@ mod tests {
))
.unwrap();

let client_nonce = H256(hex!(
"7e968bba13b6c50e2c4cd7f241cc0d64d1ac25c7f5952df231ac6a2bda8ee5d6"
));
let client_nonce =
H256(hex!("7e968bba13b6c50e2c4cd7f241cc0d64d1ac25c7f5952df231ac6a2bda8ee5d6"));

let server_id = pk2id(&PublicKey::from_secret_key(
SECP256K1,
&eip8_test_server_key(),
));
let server_id = pk2id(&PublicKey::from_secret_key(SECP256K1, &eip8_test_server_key()));

ECIES::new_static_client(
client_static_key,
server_id,
client_nonce,
client_ephemeral_key,
)
.unwrap()
ECIES::new_static_client(client_static_key, server_id, client_nonce, client_ephemeral_key)
.unwrap()
}

fn eip8_test_server() -> ECIES {
Expand All @@ -711,9 +658,8 @@ mod tests {
))
.unwrap();

let server_nonce = H256(hex!(
"559aead08264d5795d3909718cdd05abd49572e84fe55590eef31a88a08fdffd"
));
let server_nonce =
H256(hex!("559aead08264d5795d3909718cdd05abd49572e84fe55590eef31a88a08fdffd"));

ECIES::new_static_server(eip8_test_server_key(), server_nonce, server_ephemeral_key)
.unwrap()
Expand Down Expand Up @@ -801,9 +747,7 @@ mod tests {
let mut test_client = eip8_test_client();
let mut test_server = eip8_test_server();

test_server
.read_auth(&mut test_client.create_auth())
.unwrap();
test_server.read_auth(&mut test_client.create_auth()).unwrap();

test_client.read_ack(&mut test_server.create_ack()).unwrap();

Expand Down
13 changes: 4 additions & 9 deletions crates/net/ecies/src/mac.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ use aes::Aes256Enc;
use block_padding::NoPadding;
use cipher::BlockEncrypt;
use digest::KeyInit;
use reth_primitives::{H128, H256};
use generic_array::GenericArray;
use reth_primitives::{H128, H256};
use sha3::{Digest, Keccak256};
use typenum::U16;

Expand All @@ -17,10 +17,7 @@ pub struct MAC {

impl MAC {
pub fn new(secret: H256) -> Self {
Self {
secret,
hasher: Keccak256::new(),
}
Self { secret, hasher: Keccak256::new() }
}

pub fn update(&mut self, data: &[u8]) {
Expand All @@ -30,8 +27,7 @@ impl MAC {
pub fn update_header(&mut self, data: &HeaderBytes) {
let aes = Aes256Enc::new_from_slice(self.secret.as_ref()).unwrap();
let mut encrypted = self.digest().to_fixed_bytes();
aes.encrypt_padded::<NoPadding>(&mut encrypted, H128::len_bytes())
.unwrap();
aes.encrypt_padded::<NoPadding>(&mut encrypted, H128::len_bytes()).unwrap();
for i in 0..data.len() {
encrypted[i] ^= data[i];
}
Expand All @@ -43,8 +39,7 @@ impl MAC {
let prev = self.digest();
let aes = Aes256Enc::new_from_slice(self.secret.as_ref()).unwrap();
let mut encrypted = self.digest().to_fixed_bytes();
aes.encrypt_padded::<NoPadding>(&mut encrypted, H128::len_bytes())
.unwrap();
aes.encrypt_padded::<NoPadding>(&mut encrypted, H128::len_bytes()).unwrap();
for i in 0..16 {
encrypted[i] ^= prev[i];
}
Expand Down
Loading