Skip to content

Example: merge ciphers clients create #467

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

Draft
wants to merge 1 commit into
base: vault/migrate-ciphers
Choose a base branch
from
Draft

Example: merge ciphers clients create #467

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
6 changes: 3 additions & 3 deletions crates/bitwarden-core/src/client/test_accounts.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ use bitwarden_crypto::{EncString, Kdf};

use crate::{
key_management::crypto::{InitOrgCryptoRequest, InitUserCryptoMethod, InitUserCryptoRequest},
Client, UserId,
Client, ClientSettings, UserId,
};

impl Client {
pub async fn init_test_account(account: TestAccount) -> Self {
let client = Client::new(None);
pub async fn init_test_account(account: TestAccount, settings: Option<ClientSettings>) -> Self {
let client = Client::new(settings);

client.internal.load_flags(HashMap::from([(
"enableCipherKeyEncryption".to_owned(),
Expand Down
2 changes: 1 addition & 1 deletion crates/bitwarden-core/src/key_management/crypto_client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ mod tests {
#[tokio::test]
async fn test_enroll_pin_envelope() {
// Initialize a test client with user crypto
let client = Client::init_test_account(test_bitwarden_com_account()).await;
let client = Client::init_test_account(test_bitwarden_com_account(), None).await;
let user_key_initial =
SymmetricCryptoKey::try_from(client.crypto().get_user_encryption_key().await.unwrap())
.unwrap();
Expand Down
1 change: 1 addition & 0 deletions crates/bitwarden-vault/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ wasm = [
"bitwarden-collections/wasm",
"bitwarden-core/wasm",
"bitwarden-encoding/wasm",
"bitwarden-crypto/wasm",
"dep:tsify",
"dep:wasm-bindgen",
"dep:wasm-bindgen-futures"
Expand Down
187 changes: 97 additions & 90 deletions crates/bitwarden-vault/src/cipher/cipher_client/create.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ use bitwarden_core::{
key_management::{KeyIds, SymmetricKeyId},
require, ApiError, MissingFieldError, UserId,
};
use bitwarden_crypto::{CompositeEncryptable, CryptoError, IdentifyKey, KeyStore, KeyStoreContext};
use bitwarden_crypto::{CompositeEncryptable, CryptoError, IdentifyKey, KeyStoreContext};
use bitwarden_error::bitwarden_error;
use bitwarden_state::repository::{Repository, RepositoryError};
use bitwarden_state::repository::RepositoryError;
use serde::{Deserialize, Serialize};
use thiserror::Error;
#[cfg(feature = "wasm")]
Expand Down Expand Up @@ -105,26 +105,6 @@ impl IdentifyKey<SymmetricKeyId> for CipherAddEditRequest {
}
}

async fn create_cipher<R: Repository<Cipher> + ?Sized>(
key_store: &KeyStore<KeyIds>,
api_config: &bitwarden_api_api::apis::configuration::Configuration,
repository: &R,
request: CipherAddEditRequest,
) -> Result<CipherView, CreateCipherError> {
let cipher_request = key_store.encrypt(request)?;
let resp = ciphers_api::ciphers_post(api_config, Some(cipher_request))
.await
.map_err(ApiError::from)?;

let cipher: Cipher = resp.try_into()?;

repository
.set(require!(cipher.id).to_string(), cipher.clone())
.await?;

Ok(key_store.decrypt(&cipher)?)
}

impl CiphersClient {
/// Create a new [Cipher] and save it to the server.
pub async fn create(
Expand All @@ -137,19 +117,35 @@ impl CiphersClient {

request.encrypted_for = self.client.internal.get_user_id();

create_cipher(key_store, &config.api, repository.as_ref(), request).await
let cipher_request = key_store.encrypt(request)?;
let resp = ciphers_api::ciphers_post(&config.api, Some(cipher_request))
.await
.map_err(ApiError::from)?;

let cipher: Cipher = resp.try_into()?;

repository
.set(require!(cipher.id).to_string(), cipher.clone())
.await?;

Ok(key_store.decrypt(&cipher)?)
}
}

#[cfg(test)]
mod tests {
use std::sync::Arc;

use bitwarden_api_api::models::CipherResponseModel;
use bitwarden_crypto::SymmetricCryptoKey;
use bitwarden_core::{
client::test_accounts::test_bitwarden_com_account, Client, ClientSettings, DeviceType,
};
use bitwarden_state::repository::Repository;
use bitwarden_test::{start_api_mock, MemoryRepository};
use wiremock::{matchers, Mock, Request, ResponseTemplate};

use super::*;
use crate::{CipherId, CipherRepromptType, CipherType, LoginView};
use crate::{CipherId, CipherRepromptType, CipherType, LoginView, VaultClientExt};

const TEST_CIPHER_ID: &str = "5faa9684-c793-4a2d-8a12-b33900187097";
const TEST_USER_ID: &str = "550e8400-e29b-41d4-a716-446655440000";
Expand Down Expand Up @@ -196,69 +192,74 @@ mod tests {

#[tokio::test]
async fn test_create_cipher() {
let store: KeyStore<KeyIds> = KeyStore::default();
#[allow(deprecated)]
let _ = store.context_mut().set_symmetric_key(
SymmetricKeyId::User,
SymmetricCryptoKey::make_aes256_cbc_hmac_key(),
);

let cipher_id: CipherId = TEST_CIPHER_ID.parse().unwrap();
let user_id: UserId = TEST_USER_ID.parse().unwrap();

let (_server, api_config) = start_api_mock(vec![Mock::given(matchers::path("/ciphers"))
.respond_with(move |req: &Request| {
let body: CipherRequestModel = req.body_json().unwrap();
ResponseTemplate::new(201).set_body_json(CipherResponseModel {
object: Some("cipher".to_string()),
id: Some(cipher_id.into()),
name: Some(body.name.clone()),
r#type: body.r#type,
organization_id: body
.organization_id
.as_ref()
.and_then(|id| uuid::Uuid::parse_str(id).ok()),
folder_id: body
.folder_id
.as_ref()
.and_then(|id| uuid::Uuid::parse_str(id).ok()),
favorite: body.favorite,
reprompt: body.reprompt,
key: body.key.clone(),
notes: body.notes.clone(),
view_password: Some(true),
edit: Some(true),
organization_use_totp: Some(true),
revision_date: Some("2025-01-01T00:00:00Z".to_string()),
creation_date: Some("2025-01-01T00:00:00Z".to_string()),
deleted_date: None,
login: body.login,
card: body.card,
identity: body.identity,
secure_note: body.secure_note,
ssh_key: body.ssh_key,
fields: body.fields,
password_history: body.password_history,
attachments: None,
permissions: None,
data: None,
archived_date: None,
let (mock_server, _api_config) =
start_api_mock(vec![Mock::given(matchers::path("/api/ciphers"))
.respond_with(move |req: &Request| {
let body: CipherRequestModel = req.body_json().unwrap();
ResponseTemplate::new(201).set_body_json(CipherResponseModel {
object: Some("cipher".to_string()),
id: Some(cipher_id.into()),
name: Some(body.name.clone()),
r#type: body.r#type,
organization_id: body
.organization_id
.as_ref()
.and_then(|id| uuid::Uuid::parse_str(id).ok()),
folder_id: body
.folder_id
.as_ref()
.and_then(|id| uuid::Uuid::parse_str(id).ok()),
favorite: body.favorite,
reprompt: body.reprompt,
key: body.key.clone(),
notes: body.notes.clone(),
view_password: Some(true),
edit: Some(true),
organization_use_totp: Some(true),
revision_date: Some("2025-01-01T00:00:00Z".to_string()),
creation_date: Some("2025-01-01T00:00:00Z".to_string()),
deleted_date: None,
login: body.login,
card: body.card,
identity: body.identity,
secure_note: body.secure_note,
ssh_key: body.ssh_key,
fields: body.fields,
password_history: body.password_history,
attachments: None,
permissions: None,
data: None,
archived_date: None,
})
})
})
.expect(1)])
.await;
.expect(1)])
.await;

let settings = ClientSettings {
identity_url: format!("http://{}/identity", mock_server.address()),
api_url: format!("http://{}/api", mock_server.address()),
user_agent: "Bitwarden Rust-SDK [TEST]".into(),
device_type: DeviceType::SDK,
};
Comment on lines +241 to +246
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice. I see where I missed it. I initially started with something similar

let client = Client::init_test_account(test_bitwarden_com_account(), Some(settings)).await;

let repository = Arc::new(MemoryRepository::<Cipher>::default());
client
.platform()
.state()
.register_client_managed(repository.clone());

let repository = MemoryRepository::<Cipher>::default();
let cipher_view = generate_test_cipher();

let request = CipherAddEditRequest {
cipher: cipher_view.clone(),
encrypted_for: Some(user_id),
};

let result = create_cipher(&store, &api_config, &repository, request)
.await
.unwrap();
let result = client.vault().ciphers().create(request).await.unwrap();

assert_eq!(result.id, Some(cipher_id));
assert_eq!(result.name, "Test Login");
Expand All @@ -275,8 +276,9 @@ mod tests {
})
);

let key_store = client.internal.get_key_store();
// Confirm the cipher was stored in the repository
let stored_cipher_view: CipherView = store
let stored_cipher_view: CipherView = key_store
.decrypt(
&repository
.get(cipher_id.to_string())
Expand All @@ -295,27 +297,32 @@ mod tests {

#[tokio::test]
async fn test_create_cipher_http_error() {
let store: KeyStore<KeyIds> = KeyStore::default();
#[allow(deprecated)]
let _ = store.context_mut().set_symmetric_key(
SymmetricKeyId::User,
SymmetricCryptoKey::make_aes256_cbc_hmac_key(),
);

let (_server, api_config) = start_api_mock(vec![
Mock::given(matchers::path("/ciphers")).respond_with(ResponseTemplate::new(500))
])
.await;
let (mock_server, _api_config) =
start_api_mock(vec![Mock::given(matchers::path("/api/ciphers"))
.respond_with(ResponseTemplate::new(500))])
.await;

let settings = ClientSettings {
identity_url: format!("http://{}/identity", mock_server.address()),
api_url: format!("http://{}/api", mock_server.address()),
user_agent: "Bitwarden Rust-SDK [TEST]".into(),
device_type: DeviceType::SDK,
};
let client = Client::init_test_account(test_bitwarden_com_account(), Some(settings)).await;
let repository = Arc::new(MemoryRepository::<Cipher>::default());
client
.platform()
.state()
.register_client_managed(repository.clone());

let repository = MemoryRepository::<Cipher>::default();
let cipher_view = generate_test_cipher();

let request = CipherAddEditRequest {
cipher: cipher_view,
encrypted_for: None,
};

let result = create_cipher(&store, &api_config, &repository, request).await;
let result = client.vault().ciphers().create(request).await;

assert!(result.is_err());
assert!(matches!(result.unwrap_err(), CreateCipherError::Api(_)));
Expand Down
14 changes: 7 additions & 7 deletions crates/bitwarden-vault/src/cipher/cipher_client/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ mod tests {

#[tokio::test]
async fn test_decrypt_list() {
let client = Client::init_test_account(test_bitwarden_com_account()).await;
let client = Client::init_test_account(test_bitwarden_com_account(), None).await;

let dec = client
.vault()
Expand Down Expand Up @@ -352,7 +352,7 @@ mod tests {

#[tokio::test]
async fn test_decrypt_list_with_failures_all_success() {
let client = Client::init_test_account(test_bitwarden_com_account()).await;
let client = Client::init_test_account(test_bitwarden_com_account(), None).await;

let valid_cipher = test_cipher();

Expand All @@ -368,7 +368,7 @@ mod tests {

#[tokio::test]
async fn test_decrypt_list_with_failures_mixed_results() {
let client = Client::init_test_account(test_bitwarden_com_account()).await;
let client = Client::init_test_account(test_bitwarden_com_account(), None).await;
let valid_cipher = test_cipher();
let mut invalid_cipher = test_cipher();
// Set an invalid encryptedkey to cause decryption failure
Expand All @@ -386,7 +386,7 @@ mod tests {

#[tokio::test]
async fn test_move_user_cipher_with_attachment_without_key_to_org_fails() {
let client = Client::init_test_account(test_bitwarden_com_account()).await;
let client = Client::init_test_account(test_bitwarden_com_account(), None).await;

let mut cipher = test_cipher();
cipher.attachments = Some(vec![test_attachment_legacy()]);
Expand All @@ -404,7 +404,7 @@ mod tests {

#[tokio::test]
async fn test_encrypt_cipher_with_legacy_attachment_without_key() {
let client = Client::init_test_account(test_bitwarden_com_account()).await;
let client = Client::init_test_account(test_bitwarden_com_account(), None).await;

let mut cipher = test_cipher();
let attachment = test_attachment_legacy();
Expand Down Expand Up @@ -446,7 +446,7 @@ mod tests {

#[tokio::test]
async fn test_encrypt_cipher_with_v1_attachment_without_key() {
let client = Client::init_test_account(test_bitwarden_com_account()).await;
let client = Client::init_test_account(test_bitwarden_com_account(), None).await;

let mut cipher = test_cipher();
let attachment = test_attachment_v2();
Expand Down Expand Up @@ -534,7 +534,7 @@ mod tests {

#[tokio::test]
async fn test_encrypt_cipher_for_rotation() {
let client = Client::init_test_account(test_bitwarden_com_account()).await;
let client = Client::init_test_account(test_bitwarden_com_account(), None).await;

let new_key = SymmetricCryptoKey::make_aes256_cbc_hmac_key();

Expand Down
4 changes: 2 additions & 2 deletions crates/bitwarden-vault/src/collection_client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ mod tests {

#[tokio::test]
async fn test_decrypt_list() {
let client = Client::init_test_account(test_bitwarden_com_account()).await;
let client = Client::init_test_account(test_bitwarden_com_account(), None).await;

let dec = client.vault().collections().decrypt_list(vec![Collection {
id: Some("66c5ca57-0868-4c7e-902f-b181009709c0".parse().unwrap()),
Expand All @@ -139,7 +139,7 @@ mod tests {

#[tokio::test]
async fn test_decrypt() {
let client = Client::init_test_account(test_bitwarden_com_account()).await;
let client = Client::init_test_account(test_bitwarden_com_account(), None).await;

let dec = client.vault().collections().decrypt(Collection {
id: Some("66c5ca57-0868-4c7e-902f-b181009709c0".parse().unwrap()),
Expand Down
Loading