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

Support AWS-LC in FIPS mode #198

Merged
merged 11 commits into from
Oct 18, 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
2 changes: 1 addition & 1 deletion .github/workflows/features.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ jobs:
- name: Install cargo-hack
run: cargo install cargo-hack
- name: Build one feature at a time
run: cargo hack build --each-feature --workspace --exclude harness_client
run: cargo hack build --each-feature --workspace --exclude harness_client --exclude mls-rs-crypto-awslc
18 changes: 16 additions & 2 deletions .github/workflows/native_build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@ jobs:
save-if: ${{ github.ref == 'refs/heads/main' }}
- uses: ilammy/setup-nasm@v1
if: runner.os == 'Windows'
- uses: actions/setup-go@v4
with:
go-version: '>=1.18'
- uses: seanmiddleditch/gha-setup-ninja@master
if: runner.os == 'Windows'
- run: |
echo "VCPKG_ROOT=$env:VCPKG_INSTALLATION_ROOT" | Out-File -FilePath $env:GITHUB_ENV -Append
vcpkg install openssl:x64-windows-static-md sqlite3:x64-windows-static-md
Expand All @@ -35,7 +40,7 @@ jobs:
- name: Test Full RFC Compliance
run: cargo test --all-features --verbose --workspace
- name: Test Bare Bones
run: cargo test --no-default-features --features std,test_util --verbose --workspace
run: cargo test --no-default-features --features std,test_util,non-fips --verbose --workspace
- name: Examples
working-directory: mls-rs
run: cargo run --example basic_usage
Expand All @@ -59,6 +64,11 @@ jobs:
save-if: ${{ github.ref == 'refs/heads/main' }}
- uses: ilammy/setup-nasm@v1
if: runner.os == 'Windows'
- uses: actions/setup-go@v4
with:
go-version: '>=1.18'
- uses: seanmiddleditch/gha-setup-ninja@master
if: runner.os == 'Windows'
- run: |
echo "VCPKG_ROOT=$env:VCPKG_INSTALLATION_ROOT" | Out-File -FilePath $env:GITHUB_ENV -Append
vcpkg install openssl:x64-windows-static-md sqlite3:x64-windows-static-md
Expand All @@ -82,12 +92,16 @@ jobs:
- uses: Swatinem/rust-cache@v2
with:
save-if: ${{ github.ref == 'refs/heads/main' }}
- uses: actions/setup-go@v4
with:
go-version: '>=1.18'
- uses: seanmiddleditch/gha-setup-ninja@master
- name: Rust Fmt
run: cargo fmt --all -- --check
- name: Clippy Full RFC Compliance
run: cargo clippy --all-targets --all-features --workspace -- -D warnings
- name: Clippy Bare Bones
run: cargo clippy --all-targets --no-default-features --features std,test_util --workspace -- -D warnings
run: cargo clippy --all-targets --no-default-features --features std,test_util,non-fips --workspace -- -D warnings
LintAndFormattingMacOS:
# XXX(RLB): It would be good to just use macos-latest here, but
# apparently if you do that, sometimes you get an older (not latest)
Expand Down
12 changes: 9 additions & 3 deletions mls-rs-crypto-awslc/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
[package]
name = "mls-rs-crypto-awslc"
version = "0.12.0"
version = "0.12.1"
edition = "2021"
description = "AWS-LC based CryptoProvider for mls-rs"
homepage = "https://github.com/awslabs/mls-rs"
repository = "https://github.com/awslabs/mls-rs"
keywords = ["mls", "mls-rs", "aws-lc"]
license = "Apache-2.0 OR MIT"

[features]
fips = ["aws-lc-rs/fips", "dep:aws-lc-fips-sys"]
non-fips = ["aws-lc-rs/aws-lc-sys", "dep:aws-lc-sys"]
default = ["non-fips"]

[dependencies]
aws-lc-rs = "=1.8.0"
aws-lc-sys = { version = "0.19.0" }
aws-lc-rs = { version = "=1.10.0", default-features = false, features = ["alloc"] }
aws-lc-sys = { version = "0.22.0", optional = true }
aws-lc-fips-sys = { version = "0.12.0", optional = true }
mls-rs-core = { path = "../mls-rs-core", version = "0.19.0" }
mls-rs-crypto-hpke = { path = "../mls-rs-crypto-hpke", version = "0.10.0" }
mls-rs-crypto-traits = { path = "../mls-rs-crypto-traits", version = "0.11.0" }
Expand Down
8 changes: 4 additions & 4 deletions mls-rs-crypto-awslc/src/ec.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@

use std::{os::raw::c_void, ptr::null_mut};

use aws_lc_rs::error::Unspecified;
use aws_lc_sys::{
use crate::aws_lc_sys_impl::{
d2i_ECPrivateKey, point_conversion_form_t, BN_bin2bn, BN_bn2bin, BN_free, ECDH_compute_key,
EC_GROUP_free, EC_GROUP_new_by_curve_name, EC_KEY_free, EC_KEY_generate_key, EC_KEY_get0_group,
EC_KEY_get0_private_key, EC_KEY_get0_public_key, EC_KEY_new_by_curve_name,
Expand All @@ -14,6 +13,7 @@ use aws_lc_sys::{
EVP_PKEY_set1_EC_KEY, NID_X9_62_prime256v1, NID_secp384r1, NID_secp521r1, X25519_keypair,
X25519_public_from_private, EC_POINT, EVP_PKEY, X25519,
};
use aws_lc_rs::error::Unspecified;
use mls_rs_core::crypto::{CipherSuite, HpkePublicKey, HpkeSecretKey};
use mls_rs_crypto_traits::Curve;

Expand Down Expand Up @@ -172,7 +172,7 @@ pub fn x25519_public_key(secret_key: &[u8]) -> Result<Vec<u8>, AwsLcCryptoError>
}

pub struct EcPrivateKey {
pub(crate) inner: *mut aws_lc_sys::ec_key_st,
pub(crate) inner: *mut crate::aws_lc_sys_impl::ec_key_st,
curve: Curve,
}

Expand Down Expand Up @@ -298,7 +298,7 @@ impl EcPrivateKey {

impl Drop for EcPrivateKey {
fn drop(&mut self) {
unsafe { aws_lc_sys::EC_KEY_free(self.inner) }
unsafe { crate::aws_lc_sys_impl::EC_KEY_free(self.inner) }
}
}

Expand Down
2 changes: 1 addition & 1 deletion mls-rs-crypto-awslc/src/ecdsa.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ use aws_lc_rs::{
signature::{self, UnparsedPublicKey, ED25519_PUBLIC_KEY_LEN},
};

use aws_lc_sys::{
use crate::aws_lc_sys_impl::{
ECDSA_SIG_free, ECDSA_SIG_to_bytes, ECDSA_do_sign, ED25519_keypair, ED25519_sign,
EVP_PKEY_new_raw_private_key, EVP_PKEY_new_raw_public_key, OPENSSL_free,
ED25519_PRIVATE_KEY_LEN, ED25519_SIGNATURE_LEN, EVP_PKEY_ED25519,
Expand Down
4 changes: 3 additions & 1 deletion mls-rs-crypto-awslc/src/kdf.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@

use std::mem::MaybeUninit;

use crate::aws_lc_sys_impl::{
EVP_sha256, EVP_sha384, EVP_sha512, HKDF_expand, HKDF_extract, EVP_MD,
};
use aws_lc_rs::error::Unspecified;
use aws_lc_sys::{EVP_sha256, EVP_sha384, EVP_sha512, HKDF_expand, HKDF_extract, EVP_MD};
use mls_rs_core::crypto::CipherSuite;
use mls_rs_crypto_traits::KdfId;

Expand Down
14 changes: 11 additions & 3 deletions mls-rs-crypto-awslc/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,18 @@ mod kdf;

pub mod x509;

use std::{ffi::c_int, mem::MaybeUninit};
#[cfg(feature = "fips")]
use aws_lc_fips_sys as aws_lc_sys_impl;

#[cfg(not(feature = "fips"))]
use aws_lc_sys as aws_lc_sys_impl;

use std::{ffi::c_int, mem::MaybeUninit, num::TryFromIntError};

use aead::AwsLcAead;
use aws_lc_rs::{digest, error::Unspecified, hmac};

use aws_lc_sys::SHA256;
use crate::aws_lc_sys_impl::SHA256;
use mls_rs_core::{
crypto::{
CipherSuite, CipherSuiteProvider, CryptoProvider, HpkeCiphertext, HpkePublicKey,
Expand Down Expand Up @@ -160,6 +166,8 @@ pub enum AwsLcCryptoError {
UnsupportedCipherSuite,
#[error("Cert validation error: {0}")]
CertValidationFailure(String),
#[error(transparent)]
TryFromIntError(#[from] TryFromIntError),
}

impl From<Unspecified> for AwsLcCryptoError {
Expand Down Expand Up @@ -315,7 +323,7 @@ impl CipherSuiteProvider for AwsLcCipherSuite {

fn random_bytes(&self, out: &mut [u8]) -> Result<(), Self::Error> {
unsafe {
if 1 != aws_lc_sys::RAND_bytes(out.as_mut_ptr(), out.len()) {
if 1 != crate::aws_lc_sys_impl::RAND_bytes(out.as_mut_ptr(), out.len()) {
return Err(Unspecified.into());
}
}
Expand Down
2 changes: 1 addition & 1 deletion mls-rs-crypto-awslc/src/x509.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ pub use writer::CertificateRequestWriter;
mod test_utils {
use std::ptr::null_mut;

use aws_lc_sys::{
use crate::aws_lc_sys_impl::{
i2d_X509_REQ, BIO_free, BIO_new_mem_buf, EVP_PKEY_free, EVP_PKEY_get_raw_private_key,
EVP_PKEY_get_raw_public_key, PEM_read_bio_PrivateKey, PEM_read_bio_X509_REQ, X509_REQ_free,
};
Expand Down
60 changes: 34 additions & 26 deletions mls-rs-crypto-awslc/src/x509/certificate.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ use std::{
time::Duration,
};

use aws_lc_sys::{
use crate::aws_lc_sys_impl::{
d2i_X509, i2d_X509, i2d_X509_NAME, ASN1_INTEGER_free, ASN1_INTEGER_to_BN, ASN1_TIME_free,
ASN1_TIME_new, ASN1_TIME_set_posix, ASN1_TIME_to_posix, BN_bin2bn, BN_bn2bin, BN_free,
BN_num_bytes, BN_to_ASN1_INTEGER, EC_KEY_get0_group, EC_KEY_get0_public_key,
EC_POINT_point2oct, EVP_PKEY_get0_EC_KEY, EVP_PKEY_get_raw_public_key, NID_subject_alt_name,
X509V3_set_ctx, X509_EXTENSION_dup, X509_add_ext, X509_free, X509_get0_notAfter,
X509_get0_notBefore, X509_get0_pubkey, X509_get_ext, X509_get_ext_count, X509_get_ext_d2i,
X509_get_issuer_name, X509_get_serialNumber, X509_get_subject_name, X509_new,
EC_POINT_point2oct, EVP_PKEY_free, EVP_PKEY_get0_EC_KEY, EVP_PKEY_get_raw_public_key,
NID_subject_alt_name, X509V3_set_ctx, X509_EXTENSION_dup, X509_add_ext, X509_free,
X509_get0_notAfter, X509_get0_notBefore, X509_get_ext, X509_get_ext_count, X509_get_ext_d2i,
X509_get_issuer_name, X509_get_pubkey, X509_get_serialNumber, X509_get_subject_name, X509_new,
X509_set_issuer_name, X509_set_notAfter, X509_set_notBefore, X509_set_pubkey,
X509_set_serialNumber, X509_set_subject_name, X509_set_version, X509_sign, ASN1_TIME, X509,
};
Expand Down Expand Up @@ -197,43 +197,51 @@ impl Certificate {

pub fn public_key(&self) -> Result<SignaturePublicKey, AwsLcCryptoError> {
unsafe {
let pub_key = X509_get0_pubkey(self.0);
let pub_key = X509_get_pubkey(self.0);
let ec_key = EVP_PKEY_get0_EC_KEY(pub_key);

if !ec_key.is_null() {
let mut out_buf = vec![0u8; 256];
let res = || {
if !ec_key.is_null() {
let mut out_buf = vec![0u8; 256];

let len = EC_POINT_point2oct(
let len = EC_POINT_point2oct(
EC_KEY_get0_group(ec_key),
EC_KEY_get0_public_key(ec_key),
aws_lc_sys::point_conversion_form_t::POINT_CONVERSION_UNCOMPRESSED,
crate::aws_lc_sys_impl::point_conversion_form_t::POINT_CONVERSION_UNCOMPRESSED,
out_buf.as_mut_ptr(),
256,
null_mut(),
);

if len == 0 {
return Err(AwsLcCryptoError::InvalidKeyData);
}
if len == 0 {
return Err(AwsLcCryptoError::InvalidKeyData);
}

out_buf.truncate(len);
out_buf.truncate(len);

Ok(out_buf.into())
} else {
let mut len = 0;
Ok(out_buf.into())
} else {
let mut len = 0;

check_res(EVP_PKEY_get_raw_public_key(pub_key, null_mut(), &mut len))?;
check_res(EVP_PKEY_get_raw_public_key(pub_key, null_mut(), &mut len))?;

let mut out = vec![0u8; len];
let mut out = vec![0u8; len];

check_res(EVP_PKEY_get_raw_public_key(
pub_key,
out.as_mut_ptr(),
&mut len,
))?;
check_res(EVP_PKEY_get_raw_public_key(
pub_key,
out.as_mut_ptr(),
&mut len,
))?;

Ok(out.into())
}
Ok(out.into())
}
};

let res = res();

EVP_PKEY_free(pub_key);

res
}
}

Expand Down
34 changes: 28 additions & 6 deletions mls-rs-crypto-awslc/src/x509/component.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,18 @@ use std::{
ptr::null_mut,
};

use aws_lc_sys::{
#[cfg(feature = "fips")]
use crate::aws_lc_sys_impl::{
sk_free as OPENSSL_sk_free, sk_new_null as OPENSSL_sk_new_null, sk_pop as OPENSSL_sk_pop,
sk_push as OPENSSL_sk_push,
};

#[cfg(not(feature = "fips"))]
use crate::aws_lc_sys_impl::{
OPENSSL_sk_free, OPENSSL_sk_new_null, OPENSSL_sk_pop, OPENSSL_sk_push,
};

use crate::aws_lc_sys_impl::{
stack_st, ASN1_STRING_data, ASN1_STRING_free, ASN1_STRING_get0_data, ASN1_STRING_length,
ASN1_STRING_set, ASN1_STRING_type_new, BIO_free, BIO_new, BIO_number_written, BIO_read,
BIO_s_mem, GENERAL_NAME_free, GENERAL_NAME_get0_value, GENERAL_NAME_new,
Expand All @@ -19,9 +30,8 @@ use aws_lc_sys::{
NID_givenName, NID_initials, NID_key_usage, NID_localityName, NID_organizationName,
NID_organizationalUnitName, NID_pkcs9_emailAddress, NID_pseudonym, NID_serialNumber,
NID_stateOrProvinceName, NID_streetAddress, NID_subject_alt_name, NID_subject_key_identifier,
NID_surname, NID_title, NID_userId, OBJ_obj2nid, OPENSSL_sk_free, OPENSSL_sk_new_null,
OPENSSL_sk_pop, OPENSSL_sk_push, X509V3_EXT_conf_nid, X509V3_EXT_i2d, X509V3_EXT_print,
X509_EXTENSION_free, X509_NAME_ENTRY_get_data, X509_NAME_ENTRY_get_object,
NID_surname, NID_title, NID_userId, OBJ_obj2nid, X509V3_EXT_conf_nid, X509V3_EXT_i2d,
X509V3_EXT_print, X509_EXTENSION_free, X509_NAME_ENTRY_get_data, X509_NAME_ENTRY_get_object,
X509_NAME_add_entry_by_NID, X509_NAME_entry_count, X509_NAME_free, X509_NAME_get_entry,
X509_NAME_new, X509_name_st, ASN1_STRING, GENERAL_NAME, GEN_DNS, GEN_EMAIL, GEN_IPADD, GEN_RID,
GEN_URI, MBSTRING_UTF8, V_ASN1_IA5STRING, V_ASN1_OCTET_STRING, X509V3_CTX, X509_EXTENSION,
Expand Down Expand Up @@ -88,7 +98,7 @@ impl X509Name {

#[cfg(test)]
pub fn to_der(&self) -> Result<Vec<u8>, AwsLcCryptoError> {
use aws_lc_sys::i2d_X509_NAME;
use crate::aws_lc_sys_impl::i2d_X509_NAME;

unsafe {
let len = check_int_return(i2d_X509_NAME(self.0, null_mut()))?;
Expand Down Expand Up @@ -490,7 +500,19 @@ impl X509Extension {
return Err(AwsLcCryptoError::CryptoError);
}

let mut out_buffer = vec![0u8; BIO_number_written(bio_out)];
#[cfg(feature = "fips")]
let out_len = BIO_number_written(bio_out);

#[cfg(not(feature = "fips"))]
let out_len = match BIO_number_written(bio_out).try_into() {
Ok(out_len) => out_len,
Err(e) => {
BIO_free(bio_out);
return Err(AwsLcCryptoError::from(e));
}
};

let mut out_buffer = vec![0u8; out_len];

let res = BIO_read(
bio_out,
Expand Down
15 changes: 8 additions & 7 deletions mls-rs-crypto-awslc/src/x509/request.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,18 @@ use std::{
ptr::{null, null_mut},
};

use aws_lc_sys::{
i2d_X509_REQ, EVP_sha256, EVP_sha384, EVP_sha512, X509_REQ_add_extensions, X509_REQ_free,
X509_REQ_new, X509_REQ_set_pubkey, X509_REQ_set_subject_name, X509_REQ_set_version,
X509_REQ_sign, EVP_MD, X509_REQ,
use crate::{
aws_lc_sys_impl::{
i2d_X509_REQ, EVP_sha256, EVP_sha384, EVP_sha512, X509_REQ_add_extensions, X509_REQ_free,
X509_REQ_new, X509_REQ_set_pubkey, X509_REQ_set_subject_name, X509_REQ_set_version,
X509_REQ_sign, EVP_MD, X509_REQ,
},
ec::EvpPkey,
};
use mls_rs_core::crypto::SignatureSecretKey;
use mls_rs_crypto_traits::Curve;

use crate::{
check_int_return, check_non_null, check_res, ec::EvpPkey, ecdsa::AwsLcEcdsa, AwsLcCryptoError,
};
use crate::{check_int_return, check_non_null, check_res, ecdsa::AwsLcEcdsa, AwsLcCryptoError};

use super::component::{Stack, X509Extension, X509Name};

Expand Down
2 changes: 1 addition & 1 deletion mls-rs-crypto-awslc/src/x509/validator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

use std::ffi::{c_long, c_ulong, CStr};

use aws_lc_sys::{
use crate::aws_lc_sys_impl::{
time_t, X509_STORE_CTX_free, X509_STORE_CTX_get0_param, X509_STORE_CTX_get_error,
X509_STORE_CTX_init, X509_STORE_CTX_new, X509_STORE_CTX_set0_trusted_stack, X509_STORE_free,
X509_STORE_new, X509_VERIFY_PARAM_get_flags, X509_VERIFY_PARAM_set_flags,
Expand Down
Loading