Skip to content

[PM-24051] In identity and sync response & decryption options, add MasterPasswordUnlockDataResponse in response model #376

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

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

[PM-24051] In identity and sync response & decryption options, add MasterPasswordUnlockDataResponse in response model #376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
44773f7
Adds MasterPasswordUnlock into identity's response user decryption op…
mzieniukbw Aug 4, 2025
0712878
Adds MasterPasswordUnlock KDF change handling in sync
mzieniukbw Aug 4, 2025
8ca20a8
simplification
mzieniukbw Aug 5, 2025
28a8423
clippy fix
mzieniukbw Aug 5, 2025
b089ea0
formatting
mzieniukbw Aug 5, 2025
0d35393
no handling, just response parsing
mzieniukbw Aug 5, 2025
a08179d
test coverage
mzieniukbw Aug 5, 2025
b3647f2
wasm
mzieniukbw Aug 5, 2025
36d3136
wasm unit test coverage
mzieniukbw Aug 5, 2025
7c8664d
wasm unit test coverage
mzieniukbw Aug 5, 2025
9c7d50d
Added UserDecryption data, response model with handling
mzieniukbw Aug 5, 2025
70ad9d3
autogenerated wasm responses, UserDecryption struct, use of TryFrom
mzieniukbw Aug 7, 2025
110f4db
failing unit test
mzieniukbw Aug 7, 2025
ff86adf
lint
mzieniukbw Aug 7, 2025
fa253a3
lint
mzieniukbw Aug 7, 2025
4a95dc5
KdfType enum duplicate
mzieniukbw Aug 7, 2025
cd37e31
revert identity crate wasm, since there it's not used right now
mzieniukbw Aug 8, 2025
3bf880f
docs
mzieniukbw Aug 8, 2025
93a3d0c
formatting
mzieniukbw Aug 8, 2025
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
3 changes: 3 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions crates/bitwarden-api-api/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ repository.workspace = true
license-file.workspace = true
keywords.workspace = true

[features]
default = []
wasm = ["dep:tsify", "dep:wasm-bindgen"] # WASM support

[dependencies]
reqwest = { workspace = true }
serde = { workspace = true }
Expand All @@ -22,5 +26,7 @@ serde_with = { version = ">=3.8, <4", default-features = false, features = [
"std",
"macros",
] }
tsify = { workspace = true, optional = true, features = ["js"], default-features = false }
url = ">=2.5, <3"
uuid = { workspace = true }
wasm-bindgen = { workspace = true, optional = true, features = ["serde-serialize"] }
7 changes: 7 additions & 0 deletions crates/bitwarden-api-api/src/models/master_password_unlock_kdf_response_model.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,17 @@
*/

use serde::{Deserialize, Serialize};
#[cfg(feature = "wasm")]
use wasm_bindgen::prelude::wasm_bindgen;

use crate::models;

#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
#[cfg_attr(
feature = "wasm",
derive(tsify::Tsify),
tsify(into_wasm_abi, from_wasm_abi)
)]
pub struct MasterPasswordUnlockKdfResponseModel {
#[serde(rename = "kdfType")]
pub kdf_type: models::KdfType,
Expand Down
15 changes: 11 additions & 4 deletions crates/bitwarden-api-api/src/models/master_password_unlock_response_model.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,31 @@
*/

use serde::{Deserialize, Serialize};
#[cfg(feature = "wasm")]
use wasm_bindgen::prelude::wasm_bindgen;

use crate::models;

#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
#[cfg_attr(
feature = "wasm",
derive(tsify::Tsify),
tsify(into_wasm_abi, from_wasm_abi)
)]
pub struct MasterPasswordUnlockResponseModel {
#[serde(rename = "kdf")]
pub kdf: Box<models::MasterPasswordUnlockKdfResponseModel>,
#[serde(rename = "masterKeyEncryptedUserKey")]
pub master_key_encrypted_user_key: Option<String>,
pub master_key_encrypted_user_key: String,
Copy link
Member

@Hinton Hinton Aug 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Platform hasn't made any strides into making fields required as it has compatibility implications. This will throw an error should these fields not be available in the past, present or future. I.e. can we guarantee forever that this endpoint in the past and future has and always will include master_key_encrypted_user_key and salt? And if these are missing are we fine with it throwing?

This is related to https://bitwarden.atlassian.net/wiki/spaces/DEV/pages/760971277/Improve+API+bindings.

#[serde(rename = "salt")]
pub salt: Option<String>,
pub salt: String,
}

impl MasterPasswordUnlockResponseModel {
pub fn new(
kdf: models::MasterPasswordUnlockKdfResponseModel,
master_key_encrypted_user_key: Option<String>,
salt: Option<String>,
master_key_encrypted_user_key: String,
salt: String,
) -> MasterPasswordUnlockResponseModel {
MasterPasswordUnlockResponseModel {
kdf: Box::new(kdf),
Expand Down
7 changes: 7 additions & 0 deletions crates/bitwarden-api-api/src/models/user_decryption_response_model.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,17 @@
*/

use serde::{Deserialize, Serialize};
#[cfg(feature = "wasm")]
use wasm_bindgen::prelude::wasm_bindgen;

use crate::models;

#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
#[cfg_attr(
feature = "wasm",
derive(tsify::Tsify),
tsify(into_wasm_abi, from_wasm_abi)
)]
pub struct UserDecryptionResponseModel {
#[serde(
rename = "masterPasswordUnlock",
Expand Down
5 changes: 5 additions & 0 deletions crates/bitwarden-core/src/auth/api/response/identity_success_response.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
use std::{collections::HashMap, num::NonZeroU32};

use bitwarden_api_api::models::UserDecryptionResponseModel;
use bitwarden_api_identity::models::KdfType;
use serde::{Deserialize, Serialize};
use serde_json::Value;
Expand Down Expand Up @@ -35,6 +36,9 @@ pub struct IdentityTokenSuccessResponse {
#[serde(rename = "keyConnectorUrl", alias = "KeyConnectorUrl")]
key_connector_url: Option<String>,

#[serde(rename = "userDecryptionOptions", alias = "UserDecryptionOptions")]
pub user_decryption_options: Option<UserDecryptionResponseModel>,

/// Stores unknown api response fields
extra: Option<HashMap<String, Value>>,
}
Expand All @@ -61,6 +65,7 @@ mod test {
force_password_reset: Default::default(),
api_use_key_connector: Default::default(),
key_connector_url: Default::default(),
user_decryption_options: Default::default(),
extra: Default::default(),
}
}
Expand Down
Loading
Loading