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

Add support of customizing RNG for crypto algorithms #65

Merged
merged 10 commits into from
Apr 17, 2024
Merged
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
10 changes: 10 additions & 0 deletions rustls-mbedcrypto-provider/src/agreement.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/

use core::fmt;

use mbedtls::pk::{EcGroupId, ECDSA_MAX_LEN};

/// An ECDH key agreement algorithm.
Expand All @@ -14,6 +16,14 @@ pub(crate) struct Algorithm {
pub(crate) max_signature_len: usize,
}

impl fmt::Debug for Algorithm {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Algorithm")
.field("group_id", &self.group_id)
.finish()
}
}

const ELEM_LEN: usize = 32;
const ELEM_AND_SCALAR_LEN: usize = ELEM_LEN;
const ED25519_PUBLIC_KEY_LEN: usize = ELEM_AND_SCALAR_LEN;
Expand Down
52 changes: 26 additions & 26 deletions rustls-mbedcrypto-provider/src/fips_utils/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,14 @@
bignum::Mpi,
ecp::EcPoint,
pk::{EcGroupId, Pk},
rng::RngCallback,
};

mod constants;

use crate::{
fips_utils::constants::{get_ffdhe_q, get_known_ec_key, get_known_ffdhe_key_pair},
kx::DheKxGroup,
kx::{FfdheKxGroup, FfdheKxGroupWrapper},
log,
};

Expand Down Expand Up @@ -63,9 +64,8 @@
///
/// [NIST SP 800-56A Rev. 3]:
/// https://csrc.nist.gov/pubs/sp/800/56/a/r3/final
pub(crate) fn fips_check_ec_pub_key(ec_mbed_pk: &Pk) -> Result<(), rustls::Error> {
let mut rng = crate::rng::rng_new().ok_or(rustls::Error::FailedToGetRandomBytes)?;
fips_check_ec_pub_key_mbed(ec_mbed_pk, &mut rng).map_err(wrap_mbedtls_error_as_fips)?;
pub(crate) fn fips_check_ec_pub_key<F: mbedtls::rng::Random>(ec_mbed_pk: &Pk, rng: &mut F) -> Result<(), rustls::Error> {
fips_check_ec_pub_key_mbed(ec_mbed_pk, rng).map_err(wrap_mbedtls_error_as_fips)?;
log::debug!("ECC Full Public-Key Validation: passed");
Ok(())
}
Expand All @@ -82,16 +82,19 @@
///
/// [FIPS 140-3 IG]: https://csrc.nist.gov/projects/cryptographic-module-validation-program/fips-140-3-ig-announcements
/// [SP 800-56Ar3]: https://csrc.nist.gov/pubs/sp/800/56/a/r3/final
pub(crate) fn fips_ec_pct(ec_mbed_pk: &mut Pk, ec_group_id: EcGroupId) -> Result<(), rustls::Error> {
let mut rng = crate::rng::rng_new().ok_or(rustls::Error::FailedToGetRandomBytes)?;
pub(crate) fn fips_ec_pct<F: mbedtls::rng::Random>(
ec_mbed_pk: &mut Pk,
ec_group_id: EcGroupId,
rng: &mut F,
) -> Result<(), rustls::Error> {
// Get a static ec pub key based on given [`EcGroupId`]
let known_ec_key_info = get_known_ec_key(&ec_group_id).expect("validated");
let mut known_ec_key = known_ec_key_info
.0
.lock()
.map_err(|_| rustls::Error::General("Failed to get known ec key: poisoned lock".to_string()))?;
let secret_len = known_ec_key_info.1;
fips_ec_pct_mbed(ec_mbed_pk, &mut known_ec_key, secret_len, &mut rng).map_err(wrap_mbedtls_error_as_fips)?;
fips_ec_pct_mbed(ec_mbed_pk, &mut known_ec_key, secret_len, rng).map_err(wrap_mbedtls_error_as_fips)?;
log::debug!("ECC Pairwise Consistency Test: passed");
Ok(())
}
Expand Down Expand Up @@ -196,9 +199,9 @@
/// > standard does not require a PCT.
///
/// [FIPS 140-3 IG]: https://csrc.nist.gov/projects/cryptographic-module-validation-program/fips-140-3-ig-announcements
pub(super) fn ffdhe_pct(dhe_group: &DheKxGroup, y: &Mpi, y_pub: &Mpi) -> Result<(), rustls::Error> {
let p = Mpi::from_binary(dhe_group.group.p).map_err(wrap_mbedtls_error_as_fips)?;
let key_pair = get_known_ffdhe_key_pair(dhe_group.named_group)
pub(super) fn ffdhe_pct<T: RngCallback>(dhe_group: &FfdheKxGroupWrapper<T>, y: &Mpi, y_pub: &Mpi) -> Result<(), rustls::Error> {
let p = Mpi::from_binary(dhe_group.dhe_kx_group.group.p).map_err(wrap_mbedtls_error_as_fips)?;
let key_pair = get_known_ffdhe_key_pair(dhe_group.dhe_kx_group.named_group)
.expect("validated")
.lock()
.map_err(|_| rustls::Error::General("Failed to get ffdhe q".to_string()))?;
Expand Down Expand Up @@ -266,6 +269,7 @@
mod tests {
use super::*;
use mbedtls::{pk::EcGroupId, rng::Random};
use rustls::crypto::SupportedKxGroup;

#[test]
fn test_fips_check_error_display() {
Expand All @@ -290,7 +294,7 @@
EcGroupId::SecP521R1,
] {
let ec_key = Pk::generate_ec(&mut rng, group_id).unwrap();
let () = fips_check_ec_pub_key(&ec_key).unwrap();
let () = fips_check_ec_pub_key(&ec_key, &mut rng).unwrap();
}
}

Expand All @@ -305,7 +309,7 @@
EcGroupId::SecP521R1,
] {
let mut ec_key = Pk::generate_ec(&mut rng, group_id).unwrap();
let () = fips_ec_pct(&mut ec_key, group_id).unwrap();
let () = fips_ec_pct(&mut ec_key, group_id, &mut rng).unwrap();
}
}

Expand All @@ -318,18 +322,17 @@
assert_eq!("Other(OtherError(Mbedtls(AesBadInputData)))", rustls_test_dbg);
}

fn create_ffdhe_key_pair(dhe_group: &DheKxGroup) -> (Mpi, Mpi) {
let g = Mpi::from_binary(dhe_group.group.g).unwrap();
let p = Mpi::from_binary(dhe_group.group.p).unwrap();
fn create_ffdhe_key_pair<T: RngCallback>(dhe_group: &FfdheKxGroupWrapper<T>) -> (Mpi, Mpi) {
let g = Mpi::from_binary(dhe_group.dhe_kx_group.group.g).unwrap();
let p = Mpi::from_binary(dhe_group.dhe_kx_group.group.p).unwrap();
let mut rng = crate::rng::rng_new().unwrap();
let mut x_binary = vec![0; dhe_group.priv_key_len];
let mut x_binary = vec![0; dhe_group.dhe_kx_group.priv_key_len];
rng.random(&mut x_binary).unwrap();
print_vec("private", &x_binary);

let x = Mpi::from_binary(&x_binary).unwrap();
let x_pub = g.mod_exp(&x, &p).unwrap();
let x_pub_binary = x_pub
.to_binary_padded(dhe_group.group.p.len())
.to_binary_padded(dhe_group.dhe_kx_group.group.p.len())
.unwrap();
print_vec("public", &x_pub_binary);
(x, x_pub)
Expand Down Expand Up @@ -359,15 +362,15 @@
] {
println!(
"Running ffdhe pairwise consistency test smoke test on group: {:?}",
dhe_group.named_group
dhe_group.name(),
);
let (y, y_pub) = create_ffdhe_key_pair(dhe_group);
let result = ffdhe_pct(dhe_group, &y, &y_pub);
assert_eq!(
result,
Ok(()),
"ffdhe pairwise consistency test smoke test failed with group {:?}, res: {:?}",
dhe_group.named_group,
dhe_group.name(),

Check warning on line 373 in rustls-mbedcrypto-provider/src/fips_utils/mod.rs

View check run for this annotation

Codecov / codecov/patch

rustls-mbedcrypto-provider/src/fips_utils/mod.rs#L373

Added line #L373 was not covered by tests
result
);
}
Expand All @@ -382,17 +385,14 @@
crate::kx::FFDHE6144_KX_GROUP,
crate::kx::FFDHE8192_KX_GROUP,
] {
println!(
"Running ffdhe public key check smoke test on group: {:?}",
dhe_group.named_group
);
println!("Running ffdhe public key check smoke test on group: {:?}", dhe_group.name(),);
let (_, y_pub) = create_ffdhe_key_pair(dhe_group);
let result = ffdhe_pub_key_check(&dhe_group.group, dhe_group.named_group, &y_pub);
let result = ffdhe_pub_key_check(&dhe_group.dhe_kx_group.group, dhe_group.name(), &y_pub);
assert_eq!(
result,
Ok(()),
"ffdhe public key check smoke test failed with group {:?}, res: {:?}",
dhe_group.named_group,
dhe_group.name(),

Check warning on line 395 in rustls-mbedcrypto-provider/src/fips_utils/mod.rs

View check run for this annotation

Codecov / codecov/patch

rustls-mbedcrypto-provider/src/fips_utils/mod.rs#L395

Added line #L395 was not covered by tests
result
);
}
Expand Down
Loading