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

[uniffi] Make mls-rs-crypto-openssl optional #157

Closed
wants to merge 1 commit into from
Closed

[uniffi] Make mls-rs-crypto-openssl optional #157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 6 additions & 1 deletion mls-rs-uniffi/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,20 @@ rust-version = "1.68.2"
crate-type = ["lib", "cdylib"]
name = "mls_rs_uniffi"

[features]
openssl = ["mls-rs-crypto-openssl"]
default = ["openssl"]

[dependencies]
async-trait = "0.1.77"
maybe-async = "0.2.10"
mls-rs = { version = "0.39.0", path = "../mls-rs" }
mls-rs-core = { version = "0.18.0", path = "../mls-rs-core" }
mls-rs-crypto-openssl = { version = "0.9.0", path = "../mls-rs-crypto-openssl" }
thiserror = "1.0.57"
uniffi = { git = "https://github.com/mozilla/uniffi-rs/", rev = "eeb785c", version = "0.27.0" }

mls-rs-crypto-openssl = { version = "0.9.0", path = "../mls-rs-crypto-openssl", optional = true }

[target.'cfg(mls_build_async)'.dependencies]
tokio = { version = "1.36.0", features = ["sync"] }

Expand Down
14 changes: 11 additions & 3 deletions mls-rs-uniffi/src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,8 @@ use mls_rs::{
identity::basic,
storage_provider::in_memory::InMemoryGroupStateStorage,
};
use mls_rs_crypto_openssl::OpensslCryptoProvider;

use self::group_state::{GroupStateStorage, GroupStateStorageAdapter};
use crate::config::group_state::{GroupStateStorage, GroupStateStorageAdapter};
use crate::Error;

pub mod group_state;
Expand Down Expand Up @@ -56,10 +55,19 @@ impl mls_rs_core::group::GroupStateStorage for ClientGroupStorage {
}
}

#[cfg(not(any(feature = "openssl")))]
compile_error!(
"The crypto provider must be set by enabling exactly one of the \
following Cargo features: [\"openssl\"]."
);

Comment on lines +58 to +63
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it work to make it like this?

#[cfg(not(any(feature = "openssl")))]
pub type UniFFICryptoProvider = mls_rs::client_builder::Missing;

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hey Marta, yes, we could use that type by default — when I tried it out, I ended up with more complex error messages, not fewer like I had hoped 😅

But it would be nice to use it for consistency.

#[cfg(feature = "openssl")]
pub type UniFFICryptoProvider = mls_rs_crypto_openssl::OpensslCryptoProvider;

Comment on lines +64 to +66
Copy link
Contributor

Choose a reason for hiding this comment

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

If we create another feature "boringssl", we won't be able to have UniFFICryptoProvider defined twice, but features should be additive. Can we achieve additive features by defining #[cfg(feature = "openssl")] UniFFIConfigOpenssl = ... and #[cfg(feature = "boringssl")] UniFFIConfigBoringssl = ...?

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 we create another feature "boringssl", we won't be able to have UniFFICryptoProvider defined twice, but features should be additive.

Yes, ideally... I was going to guard against having multiple features enabled by letting the build fail with compile_fail! like you saw above. It's not great, but I don't know of a way to make the crypto provider dynamic at runtime.

What we need is

  • a non-generic struct which holds a mls_rs::Client inside it
  • the mls_rs::Client value should be able to hold different CryptoProviders, implying that we should have a CryptoProviderWrapper type which impl CryptoProvider and which holds a Box<dyn CryptoProvider>

So I'm looking for a way to do

struct CryptoProviderWrapper {
    crypto_provider: Box<dyn CryptoProvider>,
}

However, this doesn't compile because I need to specify the CipherSuiteProvider associated type. I don't know how I can do this in a non-generic way?

pub type UniFFIConfig = client_builder::WithIdentityProvider<
basic::BasicIdentityProvider,
client_builder::WithCryptoProvider<
OpensslCryptoProvider,
UniFFICryptoProvider,
WithGroupStateStorage<ClientGroupStorage, client_builder::BaseConfig>,
>,
>;
Expand Down
10 changes: 4 additions & 6 deletions mls-rs-uniffi/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ mod config;

use std::sync::Arc;

pub use config::ClientConfig;
use config::UniFFIConfig;
pub use config::{client_config_default, ClientConfig};
use config::{UniFFIConfig, UniFFICryptoProvider};

#[cfg(not(mls_build_async))]
use std::sync::Mutex;
Expand All @@ -36,7 +36,6 @@ use mls_rs::mls_rules;
use mls_rs::{CipherSuiteProvider, CryptoProvider};
use mls_rs_core::identity;
use mls_rs_core::identity::{BasicCredential, IdentityProvider};
use mls_rs_crypto_openssl::OpensslCryptoProvider;

uniffi::setup_scaffolding!();

Expand Down Expand Up @@ -320,7 +319,7 @@ impl TryFrom<mls_rs::CipherSuite> for CipherSuite {
pub async fn generate_signature_keypair(
cipher_suite: CipherSuite,
) -> Result<SignatureKeypair, Error> {
let crypto_provider = mls_rs_crypto_openssl::OpensslCryptoProvider::default();
let crypto_provider = UniFFICryptoProvider::new();
let cipher_suite_provider = crypto_provider
.cipher_suite_provider(cipher_suite.into())
.ok_or(MlsError::UnsupportedCipherSuite(cipher_suite.into()))?;
Expand Down Expand Up @@ -364,7 +363,6 @@ impl Client {
let cipher_suite = signature_keypair.cipher_suite;
let public_key = signature_keypair.public_key;
let secret_key = signature_keypair.secret_key;
let crypto_provider = OpensslCryptoProvider::new();
let basic_credential = BasicCredential::new(id);
let signing_identity =
identity::SigningIdentity::new(basic_credential.into_credential(), public_key.into());
Expand All @@ -373,7 +371,7 @@ impl Client {
.with_single_welcome_message(true);
let mls_rules = mls_rules::DefaultMlsRules::new().with_commit_options(commit_options);
let client = mls_rs::Client::builder()
.crypto_provider(crypto_provider)
.crypto_provider(UniFFICryptoProvider::new())
.identity_provider(basic::BasicIdentityProvider::new())
.signing_identity(signing_identity, secret_key.into(), cipher_suite.into())
.group_state_storage(client_config.group_state_storage.into())
Expand Down
Loading