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

chore(s2n-quic-crypto): remove ring #2332

Merged
merged 2 commits into from
Sep 25, 2024
Merged

chore(s2n-quic-crypto): remove ring #2332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa70395
chore(s2n-quic-crypto): remove ring
WesleyRosenblum Sep 25, 2024
97ce2b1
formatting
WesleyRosenblum Sep 25, 2024
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
7 changes: 1 addition & 6 deletions quic/s2n-quic-crypto/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,13 @@ fips = ["aws-lc-rs/fips"]
testing = []

[dependencies]
aws-lc-rs = { version = "1.9", features = ["prebuilt-nasm"] }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we only want to enable this is our dev-dependencies? The problem with features is they are only additive and this would make it difficult for someone to opt out of this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If its not on by default, wouldn't windows builds start breaking?

Could we add prebuilt-nasm as a default feature on s2n-quic, so customers can opt out by turning off default features?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I guess this is part of the reason we haven't made the change. Well I guess today it's no worse than what windows environments get with ring... So let's move forward as-is and we can revisit the default-features = false route.

cfg-if = "1"
lazy_static = "1"
s2n-codec = { version = "=0.46.0", path = "../../common/s2n-codec", default-features = false }
s2n-quic-core = { version = "=0.46.0", path = "../s2n-quic-core", default-features = false }
zeroize = { version = "1", default-features = false, features = ["derive"] }

[target.'cfg(not(target_os = "windows"))'.dependencies]
aws-lc-rs = { version = "1.6" }

[target.'cfg(target_os = "windows")'.dependencies]
ring = { version = "0.17", default-features = false }

[dev-dependencies]
hex-literal = "0.4"
insta = { version = "1", features = ["json"] }
Expand Down
2 changes: 1 addition & 1 deletion quic/s2n-quic-crypto/src/aead/default.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

use crate::{
aead::{Aead, Result},
ring_aead::{Aad, LessSafeKey, Nonce, MAX_TAG_LEN, NONCE_LEN},
aws_lc_aead::{Aad, LessSafeKey, Nonce, MAX_TAG_LEN, NONCE_LEN},
};
use s2n_quic_core::crypto::{packet_protection::Error, scatter};

Expand Down
4 changes: 2 additions & 2 deletions quic/s2n-quic-crypto/src/aead/fips.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

use crate::{
aead::{Aead, Result},
ring_aead::{
aws_lc_aead::{
self, Aad, Nonce, TlsProtocolId, TlsRecordOpeningKey, TlsRecordSealingKey, MAX_TAG_LEN,
NONCE_LEN,
},
Expand All @@ -21,7 +21,7 @@ pub struct FipsKey {

impl FipsKey {
#[inline]
pub fn new(algorithm: &'static ring_aead::Algorithm, key_bytes: &[u8]) -> Result<Self> {
pub fn new(algorithm: &'static aws_lc_aead::Algorithm, key_bytes: &[u8]) -> Result<Self> {
let opener = TlsRecordOpeningKey::new(algorithm, TlsProtocolId::TLS13, key_bytes)
.expect("key size verified");
let sealer = TlsRecordSealingKey::new(algorithm, TlsProtocolId::TLS13, key_bytes)
Expand Down
4 changes: 2 additions & 2 deletions quic/s2n-quic-crypto/src/cipher_suite.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

use crate::{aead::Aead, header_key::HeaderKey, hkdf, iv, ring_aead as aead};
use crate::{aead::Aead, aws_lc_aead as aead, header_key::HeaderKey, hkdf, iv};
use core::fmt;
use s2n_quic_core::{
assume,
Expand Down Expand Up @@ -36,7 +36,7 @@ macro_rules! impl_cipher_suite {

pub const KEY_LEN: usize = $cipher_key_len;
pub const TAG_LEN: usize = 16;
pub const NONCE_LEN: usize = crate::ring_aead::NONCE_LEN;
pub const NONCE_LEN: usize = crate::aws_lc_aead::NONCE_LEN;

type Key = platform::$lower::Key;

Expand Down
3 changes: 2 additions & 1 deletion quic/s2n-quic-crypto/src/cipher_suite/negotiated.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
// SPDX-License-Identifier: Apache-2.0

use crate::{
aws_lc_aead as aead,
cipher_suite::{TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256},
header_key::HeaderKey,
hkdf, ring_aead as aead,
hkdf,
};
use core::fmt;
use s2n_quic_core::crypto::{self, packet_protection, scatter};
Expand Down
4 changes: 2 additions & 2 deletions quic/s2n-quic-crypto/src/cipher_suite/ring.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ macro_rules! key {
($name:ident, $ring_cipher:path, $key_size:expr, $tag_len:expr) => {
pub mod $name {
use super::super::$name::{KEY_LEN, NONCE_LEN, TAG_LEN};
use crate::ring_aead::{self as aead};
use crate::aws_lc_aead::{self as aead};
use s2n_quic_core::crypto::scatter;
use zeroize::Zeroize;

Expand Down Expand Up @@ -43,7 +43,7 @@ macro_rules! key_no_fips_support {
($name:ident, $ring_cipher:path, $key_size:expr, $tag_len:expr) => {
pub mod $name {
use super::super::$name::{KEY_LEN, NONCE_LEN, TAG_LEN};
use crate::ring_aead::{self as aead};
use crate::aws_lc_aead::{self as aead};
use s2n_quic_core::crypto::scatter;
use zeroize::Zeroize;

Expand Down
2 changes: 1 addition & 1 deletion quic/s2n-quic-crypto/src/header_key.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

use crate::{hkdf, ring_aead as aead};
use crate::{aws_lc_aead as aead, hkdf};
use core::fmt;
use s2n_quic_core::crypto::{self, HeaderProtectionMask};

Expand Down
2 changes: 1 addition & 1 deletion quic/s2n-quic-crypto/src/iv.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use crate::hkdf;
use s2n_codec::{Encoder, EncoderBuffer};
use zeroize::Zeroize;

pub use crate::ring_aead::NONCE_LEN;
pub use crate::aws_lc_aead::NONCE_LEN;

pub struct Iv([u8; NONCE_LEN]);

Expand Down
7 changes: 2 additions & 5 deletions quic/s2n-quic-crypto/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,9 @@ mod aead;
mod cipher_suite;
mod iv;

#[cfg(not(target_os = "windows"))]
use aws_lc_rs as ring;

#[doc(hidden)]
pub use ring::{
aead as ring_aead, aead::MAX_TAG_LEN, constant_time, digest, hkdf, hkdf::Prk, hmac,
pub use aws_lc_rs::{
aead as aws_lc_aead, aead::MAX_TAG_LEN, constant_time, digest, hkdf, hkdf::Prk, hmac,
};

#[derive(Clone)]
Expand Down
10 changes: 5 additions & 5 deletions quic/s2n-quic-crypto/src/negotiated.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
// SPDX-License-Identifier: Apache-2.0

use crate::{
cipher_suite::NegotiatedCipherSuite as CipherSuite, header_key::HeaderKeyPair,
ring_aead::Algorithm, SecretPair,
aws_lc_aead::Algorithm, cipher_suite::NegotiatedCipherSuite as CipherSuite,
header_key::HeaderKeyPair, SecretPair,
};
use s2n_quic_core::{
crypto::{packet_protection, scatter, Key},
Expand Down Expand Up @@ -100,15 +100,15 @@ macro_rules! negotiated_crypto {
impl $name {
/// Create a server cipher suite with a given negotiated algorithm and secret
pub fn new_server(
algorithm: &$crate::ring_aead::Algorithm,
algorithm: &$crate::aws_lc_aead::Algorithm,
secrets: $crate::SecretPair,
) -> Option<(Self, $header_key)> {
Self::new(s2n_quic_core::endpoint::Type::Server, algorithm, secrets)
}

/// Create a client cipher suite with a given negotiated algorithm and secret
pub fn new_client(
algorithm: &$crate::ring_aead::Algorithm,
algorithm: &$crate::aws_lc_aead::Algorithm,
secrets: $crate::SecretPair,
) -> Option<(Self, $header_key)> {
Self::new(s2n_quic_core::endpoint::Type::Client, algorithm, secrets)
Expand All @@ -117,7 +117,7 @@ macro_rules! negotiated_crypto {
/// Create a cipher_suite for an endpoint type with a given negotiated algorithm and secret
pub fn new(
endpoint: s2n_quic_core::endpoint::Type,
algorithm: &$crate::ring_aead::Algorithm,
algorithm: &$crate::aws_lc_aead::Algorithm,
secrets: $crate::SecretPair,
) -> Option<(Self, $header_key)> {
let (key, header_key) =
Expand Down
2 changes: 1 addition & 1 deletion quic/s2n-quic-crypto/src/retry.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

use crate::{constant_time, ring_aead as aead};
use crate::{aws_lc_aead as aead, constant_time};
use s2n_quic_core::crypto::{
self, packet_protection,
retry::{IntegrityTag, NONCE_BYTES, SECRET_KEY_BYTES},
Expand Down
2 changes: 1 addition & 1 deletion quic/s2n-quic-tls/src/callback.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use s2n_quic_core::{
endpoint, transport,
};
use s2n_quic_crypto::{
handshake::HandshakeKey, hkdf, one_rtt::OneRttKey, ring_aead as aead, Prk, SecretPair, Suite,
aws_lc_aead as aead, handshake::HandshakeKey, hkdf, one_rtt::OneRttKey, Prk, SecretPair, Suite,
};
use s2n_tls::{connection::Connection, error::Fallible, ffi::*};

Expand Down
Loading