Compare commits

..
2 Commits
15 changed files with 421 additions and 278 deletions

No files matched your search

+2 -4
View File
@@ -14,10 +14,8 @@ extend-ignore-re = [
# In SMTP it's called HELO, so ignore it # In SMTP it's called HELO, so ignore it
"(?i)helo_name", "(?i)helo_name",
"Server name sent during.+HELO", "Server name sent during.+HELO",
# COSE Is short for CBOR Object Signing and Encryption, ignore these specific items # COSE Is short for CBOR Object Signing and Encryption
"COSE", "(?i)cose",
"COSEKey",
"COSEAlgorithm",
# Ignore this specific string as it's valid # Ignore this specific string as it's valid
"Ensure they are valid OTPs", "Ensure they are valid OTPs",
# This word is misspelled upstream # This word is misspelled upstream
Whitespace-only changes.
@@ -0,0 +1,3 @@
-- A blob-encrypted cipher keeps all of its content in `data`, up to 500,000 characters, so the
-- 64 KiB of TEXT is too small. Like upstream, which uses LONGTEXT.
ALTER TABLE ciphers MODIFY data LONGTEXT NOT NULL;
Whitespace-only changes.
@@ -0,0 +1 @@
-- TEXT has no size limit here, only MySQL needed the change
Whitespace-only changes.
@@ -0,0 +1 @@
-- TEXT has no size limit here, only MySQL needed the change
+135 -73
View File
@@ -203,17 +203,21 @@ struct KeysData {
public_key: String, public_key: String,
} }
/// The `accountKeys` payload, which replaces the flat `keys`/`userAsymmetricKeys` object. /// Upstream's implicit `[Required]` on a non-nullable string: present and not blank.
fn required(value: Option<String>, field: &str) -> ApiResult<String> {
match value {
Some(value) if !value.trim().is_empty() => Ok(value),
_ => err!(format!("The {field} field is required.")),
}
}
/// The `accountKeys` payload: a v1 key pair, or v2 with a signature key pair and security state.
/// ///
/// It carries either a "v1" state (just the encryption key pair) or a "v2" one, which adds a /// Ref: <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Core/KeyManagement/Models/Api/Request/AccountKeysRequestModel.cs#L6-L50>
/// signature key pair, a signed public key, and a signed security state. The two deprecated
/// top-level fields are still sent by the SDK alongside the nested ones and are only used as a
/// fallback for clients that don't send `publicKeyEncryptionKeyPair` yet.
///
/// Ref: <https://github.com/bitwarden/server/blob/main/src/Core/KeyManagement/Models/Api/Request/AccountKeysRequestModel.cs>
#[derive(Debug, Deserialize)] #[derive(Debug, Deserialize)]
#[serde(rename_all = "camelCase")] #[serde(rename_all = "camelCase")]
pub struct AccountKeysData { struct AccountKeysData {
// Required like upstream, but only used without `public_key_encryption_key_pair`
user_key_encrypted_account_private_key: Option<String>, user_key_encrypted_account_private_key: Option<String>,
account_public_key: Option<String>, account_public_key: Option<String>,
@@ -245,7 +249,7 @@ struct SecurityStateData {
security_version: i32, security_version: i32,
} }
pub struct ValidatedAccountKeys { struct ValidatedAccountKeys {
private_key: String, private_key: String,
public_key: String, public_key: String,
v2: Option<ValidatedV2AccountKeys>, v2: Option<ValidatedV2AccountKeys>,
@@ -261,25 +265,37 @@ struct ValidatedV2AccountKeys {
} }
impl AccountKeysData { impl AccountKeysData {
/// Checks that the payload describes a complete account cryptographic state. /// Upstream's model checks, plus the v2 fields all or none: no client can unlock a partial v2 state.
/// fn validate(self) -> ApiResult<ValidatedAccountKeys> {
/// The v2 fields have to be all present or all absent: a client that receives a COSE-wrapped let top_private_key =
/// private key without the matching signature key pair and security state refuses to unlock the required(self.user_key_encrypted_account_private_key, "UserKeyEncryptedAccountPrivateKey")?;
/// vault, so storing half a state would produce an account nobody can log into. let top_public_key = required(self.account_public_key, "AccountPublicKey")?;
pub fn validate(self) -> ApiResult<ValidatedAccountKeys> { let (private_key, public_key, signed_public_key) = match self.public_key_encryption_key_pair {
let (private_key, public_key, signed_public_key) = if let Some(key_pair) = self.public_key_encryption_key_pair { Some(key_pair) => (
(key_pair.wrapped_private_key, key_pair.public_key, key_pair.signed_public_key) required(Some(key_pair.wrapped_private_key), "WrappedPrivateKey")?,
// Older clients only send the deprecated top-level fields, which are always v1. required(Some(key_pair.public_key), "PublicKey")?,
} else if let (Some(private_key), Some(public_key)) = key_pair.signed_public_key,
(self.user_key_encrypted_account_private_key, self.account_public_key) ),
{ // Older clients only send the top-level fields, which are always v1
(private_key, public_key, None) None => (top_private_key, top_public_key, None),
} else {
err!("The account keys are missing an encryption key pair")
}; };
if let Some(signature_key_pair) = &self.signature_key_pair {
required(Some(signature_key_pair.signature_algorithm.clone()), "SignatureAlgorithm")?;
required(Some(signature_key_pair.wrapped_signing_key.clone()), "WrappedSigningKey")?;
required(Some(signature_key_pair.verifying_key.clone()), "VerifyingKey")?;
}
if let Some(security_state) = &self.security_state {
required(Some(security_state.security_state.clone()), "SecurityState")?;
if security_state.security_state.encode_utf16().count() > 10_000 {
err!("The field SecurityState must be a string with a maximum length of 10000.")
}
}
let v2 = match (signed_public_key, self.signature_key_pair, self.security_state) { let v2 = match (signed_public_key, self.signature_key_pair, self.security_state) {
(Some(signed_public_key), Some(signature_key_pair), Some(security_state)) => { (Some(signed_public_key), Some(signature_key_pair), Some(security_state)) => {
// Upstream fails on a null one, but takes an empty one that no client can unlock with
let signed_public_key = required(Some(signed_public_key), "SignedPublicKey")?;
let Some(signature_algorithm) = SignatureAlgorithm::parse(&signature_key_pair.signature_algorithm) let Some(signature_algorithm) = SignatureAlgorithm::parse(&signature_key_pair.signature_algorithm)
else { else {
err!(format!( err!(format!(
@@ -322,28 +338,28 @@ impl From<KeysData> for ValidatedAccountKeys {
} }
impl ValidatedAccountKeys { impl ValidatedAccountKeys {
/// The keys of a request that may carry either shape. `accountKeys` supersedes the flat `keys` /// The keys of a registration: `accountKeys` only for a v2 account, like upstream.
/// object when both are sent. ///
fn from_request(account_keys: Option<AccountKeysData>, keys: Option<KeysData>) -> ApiResult<Option<Self>> { /// Ref: <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Core/Auth/Models/Api/Request/Accounts/RegisterFinishRequestModel.cs#L77-L100>
match (account_keys, keys) { fn for_registration(account_keys: Option<AccountKeysData>, keys: Option<KeysData>) -> ApiResult<Self> {
(Some(account_keys), _) => account_keys.validate().map(Some), if let Some(account_keys) = account_keys {
(None, keys) => Ok(keys.map(Self::from)), let account_keys = account_keys.validate()?;
if account_keys.is_v2() {
return Ok(account_keys);
}
} }
let Some(keys) = keys else {
err!("PublicKey and WrappedPrivateKey not found in RequestModel")
};
Ok(keys.into())
} }
fn is_v2(&self) -> bool { fn is_v2(&self) -> bool {
self.v2.is_some() self.v2.is_some()
} }
/// Writes the parts of the state that live on the user itself. The user still needs saving, and /// Sets the keys on the user, which then needs saving before [`Self::save_signature_key_pair`].
/// [`Self::save_signature_key_pair`] still needs calling once it has been. fn apply(&self, user: &mut User) -> EmptyResult {
///
/// Rejects downgrading an account from v2 back to v1.
pub fn apply(&self, user: &mut User) -> EmptyResult {
if user.is_v2() && self.v2.is_none() {
err!("Cannot downgrade an account from v2 to v1 encryption")
}
user.private_key = Some(self.private_key.clone()); user.private_key = Some(self.private_key.clone());
user.public_key = Some(self.public_key.clone()); user.public_key = Some(self.public_key.clone());
@@ -354,9 +370,8 @@ impl ValidatedAccountKeys {
Ok(()) Ok(())
} }
/// Persists the signature key pair. Separate from [`Self::apply`] because the row has a foreign /// Saves the signature key pair, which needs the user to exist for its foreign key.
/// key to the user, so it can only be written once the user exists. async fn save_signature_key_pair(&self, user_id: &UserId, conn: &DbConn) -> EmptyResult {
pub async fn save_signature_key_pair(&self, user_id: &UserId, conn: &DbConn) -> EmptyResult {
// Skip if the account is v1, since v1 accounts don't have a signature key pair. // Skip if the account is v1, since v1 accounts don't have a signature key pair.
let Some(v2) = &self.v2 else { let Some(v2) = &self.v2 else {
return Ok(()); return Ok(());
@@ -527,7 +542,7 @@ pub async fn register(data: Json<RegisterData>, conn: DbConn) -> JsonResult {
// the user can retry without losing their invitation below. // the user can retry without losing their invitation below.
let password_hint = clean_password_hint(data.master_password_hint.as_ref()); let password_hint = clean_password_hint(data.master_password_hint.as_ref());
enforce_password_hint_setting(password_hint.as_ref())?; enforce_password_hint_setting(password_hint.as_ref())?;
let account_keys = ValidatedAccountKeys::from_request(data.account_keys, data.keys)?; let account_keys = ValidatedAccountKeys::for_registration(data.account_keys, data.keys)?;
let mut user = match User::find_by_mail(&email, &conn).await { let mut user = match User::find_by_mail(&email, &conn).await {
Some(user) => { Some(user) => {
@@ -584,13 +599,10 @@ pub async fn register(data: Json<RegisterData>, conn: DbConn) -> JsonResult {
user.name = name; user.name = name;
} }
if let Some(ref account_keys) = account_keys { account_keys.apply(&mut user)?;
account_keys.apply(&mut user)?; // Like upstream, only a v2 registration records the key id; v1 accounts report it through `user-key-id`
// Like upstream, only a v2 registration records the user key id. A v1 account reports it if account_keys.is_v2() {
// later, through `user-key-id`. user.key_id = data.compat.key_id();
if account_keys.is_v2() {
user.key_id = data.compat.key_id();
}
} }
if email_verified { if email_verified {
@@ -613,10 +625,7 @@ pub async fn register(data: Json<RegisterData>, conn: DbConn) -> JsonResult {
} }
user.save(&conn).await?; user.save(&conn).await?;
account_keys.save_signature_key_pair(&user.uuid, &conn).await?;
if let Some(account_keys) = account_keys {
account_keys.save_signature_key_pair(&user.uuid, &conn).await?;
}
// accept any open emergency access invitations // accept any open emergency access invitations
if !CONFIG.mail_enabled() && CONFIG.emergency_access_allowed() { if !CONFIG.mail_enabled() && CONFIG.emergency_access_allowed() {
@@ -630,9 +639,41 @@ pub async fn register(data: Json<RegisterData>, conn: DbConn) -> JsonResult {
}))) })))
} }
/// Upstream's shape checks of the set-password body, on the raw JSON that the untagged compat would hide.
///
/// Ref: <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Api/Auth/Models/Request/Accounts/SetInitialPasswordRequestModel.cs#L75-L106>
fn validate_set_password_shape(body: &Value) -> EmptyResult {
let has = |name: &str| {
body.as_object().is_some_and(|o| o.iter().any(|(k, v)| k.eq_ignore_ascii_case(name) && !v.is_null()))
};
if has("accountKeys") && has("keys") {
err!("Cannot specify both AccountKeys and Keys. Provide exactly one keypair.")
}
let (authentication, unlock) = (has("masterPasswordAuthentication"), has("masterPasswordUnlock"));
if authentication != unlock {
err!(
"Must provide both MasterPasswordAuthentication and MasterPasswordUnlock together. Cannot provide one without the other."
)
}
if authentication && (has("masterPasswordHash") || has("key") || has("kdf")) {
err!(
"Cannot mix modern (MasterPasswordAuthentication/MasterPasswordUnlock) and legacy (MasterPasswordHash/Key/Kdf) fields. Provide one shape or the other."
)
}
Ok(())
}
#[post("/accounts/set-password", data = "<data>")] #[post("/accounts/set-password", data = "<data>")]
async fn post_set_password(data: Json<SetPasswordData>, headers: Headers, conn: DbConn) -> JsonResult { async fn post_set_password(data: Json<Value>, headers: Headers, conn: DbConn) -> JsonResult {
let data: SetPasswordData = data.into_inner(); let data = data.into_inner();
validate_set_password_shape(&data)?;
let Ok(data) = serde_json::from_value::<SetPasswordData>(data) else {
err_code!("Unexpected SetPasswordData format", Status::UnprocessableEntity.code)
};
if data.master_password_hint.as_ref().is_some_and(|h| h.encode_utf16().count() > 50) {
err!("The field MasterPasswordHint must be a string with a maximum length of 50.")
}
let mut user = headers.user; let mut user = headers.user;
if user.private_key.is_some() || !user.password_hash.is_empty() { if user.private_key.is_some() || !user.password_hash.is_empty() {
@@ -648,7 +689,25 @@ async fn post_set_password(data: Json<SetPasswordData>, headers: Headers, conn:
let password_hint = clean_password_hint(data.master_password_hint.as_ref()); let password_hint = clean_password_hint(data.master_password_hint.as_ref());
enforce_password_hint_setting(password_hint.as_ref())?; enforce_password_hint_setting(password_hint.as_ref())?;
let account_keys = ValidatedAccountKeys::from_request(data.account_keys, data.keys)?; // Like upstream, `accountKeys` only through the v2 JIT flow
// Ref: <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Api/Auth/Controllers/AccountsController.cs#L314-L359>
let account_keys = match data.account_keys {
Some(account_keys) => {
if !matches!(data.compat, RegisterDataCompat::RegisterDataCur(_))
|| !crate::util::is_client_feature_flag_enabled(
"enable-account-encryption-v2-jit-password-registration",
)
{
err!("Request includes V2 AccountKeys but V2 encryption is not enabled.")
}
let account_keys = account_keys.validate()?;
if !account_keys.is_v2() {
err!("AccountKeys are only supported for V2 encryption.")
}
Some(account_keys)
}
None => data.keys.map(ValidatedAccountKeys::from),
};
set_kdf_data(&mut user, data.compat.kdf())?; set_kdf_data(&mut user, data.compat.kdf())?;
@@ -812,8 +871,9 @@ async fn get_keys(headers: Headers, conn: DbConn) -> JsonResult {
#[derive(Debug, Deserialize)] #[derive(Debug, Deserialize)]
#[serde(rename_all = "camelCase")] #[serde(rename_all = "camelCase")]
struct PostKeysData { struct PostKeysData {
#[serde(flatten)] // Required like upstream, even next to `accountKeys`
keys: Option<KeysData>, public_key: Option<String>,
encrypted_private_key: Option<String>,
account_keys: Option<AccountKeysData>, account_keys: Option<AccountKeysData>,
// The id of the user key these account keys belong to, only honored for v2 `accountKeys` // The id of the user key these account keys belong to, only honored for v2 `accountKeys`
user_key_id: Option<KeyId>, user_key_id: Option<KeyId>,
@@ -825,15 +885,18 @@ async fn post_keys(data: Json<PostKeysData>, headers: Headers, conn: DbConn) ->
let mut user = headers.user; let mut user = headers.user;
// This only sets the keys of an account that has none yet. Replacing existing ones is what a key // Only for an account without keys, replacing them is what a key rotation does
// rotation does, with the checks that go with it.
if user.private_key.is_some() || user.public_key.is_some() { if user.private_key.is_some() || user.public_key.is_some() {
err!("User has existing keypair") err!("User has existing keypair")
} }
// `accountKeys` supersedes the flat `keys` object when both are sent. // Ref: <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Core/Auth/Models/Api/Request/Accounts/KeysRequestModel.cs#L11-L19>
let account_keys = match (data.account_keys, data.keys) { let public_key = required(data.public_key, "PublicKey")?;
(Some(account_keys), _) => { let encrypted_private_key = required(data.encrypted_private_key, "EncryptedPrivateKey")?;
// `accountKeys` supersedes the flat keys when both are sent
let account_keys = match data.account_keys {
Some(account_keys) => {
let account_keys = account_keys.validate()?; let account_keys = account_keys.validate()?;
if !account_keys.is_v2() { if !account_keys.is_v2() {
err!("AccountKeys are only supported for V2 encryption.") err!("AccountKeys are only supported for V2 encryption.")
@@ -844,8 +907,11 @@ async fn post_keys(data: Json<PostKeysData>, headers: Headers, conn: DbConn) ->
} }
account_keys account_keys
} }
(None, Some(keys)) => keys.into(), None => KeysData {
(None, None) => err!("No account keys provided"), encrypted_private_key,
public_key,
}
.into(),
}; };
account_keys.apply(&mut user)?; account_keys.apply(&mut user)?;
@@ -989,11 +1055,9 @@ struct UnlockData {
contained_key_id: Option<KeyId>, contained_key_id: Option<KeyId>,
} }
/// A password or KDF change re-wraps the same user key, so a key id sent with it has to be the /// A password or KDF change keeps the user key, so its key id must be the current one, when both are known.
/// current one. Either may be missing: from a client that predates key ids, or a user whose key id
/// isn't known yet. There is nothing to compare in those cases.
/// ///
/// Ref: <https://github.com/bitwarden/server/blob/main/src/Core/KeyManagement/Models/Data/MasterPasswordUnlockData.cs> /// Ref: <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Core/KeyManagement/Models/Data/MasterPasswordUnlockData.cs#L27-L47>
fn validate_key_id_unchanged(user: &User, unlock_data: &UnlockData) -> EmptyResult { fn validate_key_id_unchanged(user: &User, unlock_data: &UnlockData) -> EmptyResult {
if let (Some(current), Some(contained)) = (&user.key_id, &unlock_data.contained_key_id) if let (Some(current), Some(contained)) = (&user.key_id, &unlock_data.contained_key_id)
&& current != contained && current != contained
@@ -1204,9 +1268,7 @@ async fn post_rotatekey(data: Json<KeyData>, headers: Headers, conn: DbConn, nt:
err!("Invalid password") err!("Invalid password")
} }
// This only rotates the keys of a v1 account. A v2 account's signing key would stay wrapped by the // Rotating v2 keys, or upgrading to them, would leave an account that can't be unlocked here
// old user key, and a v1 account can't be upgraded here, since the signature key pair isn't read.
// Either would leave an account that can't be unlocked.
if headers.user.is_v2() { if headers.user.is_v2() {
err!("Key rotation is not supported for v2 accounts") err!("Key rotation is not supported for v2 accounts")
} }
+119 -73
View File
@@ -197,7 +197,7 @@ async fn sync(data: SyncData, headers: Headers, client_version: Option<ClientVer
Value::Null Value::Null
}; };
// Upstream omits this when unset rather than sending null. // Upstream omits these when unset rather than sending null
let mut user_decryption = json!({ "masterPasswordUnlock": master_password_unlock }); let mut user_decryption = json!({ "masterPasswordUnlock": master_password_unlock });
if let Some(key_id) = &headers.user.key_id { if let Some(key_id) = &headers.user.key_id {
user_decryption["userKeyId"] = json!(key_id); user_decryption["userKeyId"] = json!(key_id);
@@ -274,7 +274,8 @@ pub struct CipherData {
key: Option<String>, key: Option<String>,
pub encrypted_for: UserId, // Added in web-v2025.6.0 // Added in web-v2025.6.0. Deprecated upstream for `encrypted_by_key_id`, but still checked when sent
pub encrypted_for: Option<UserId>,
// Added in web-v2025.8.1, Optional for compat // Added in web-v2025.8.1, Optional for compat
pub encrypted_by_key_id: Option<KeyId>, pub encrypted_by_key_id: Option<KeyId>,
@@ -341,12 +342,22 @@ impl From<CipherValidationError> for crate::Error {
} }
} }
/// A user-owned cipher must be encrypted with the user's current key. Organization ciphers use the /// The cipher must have been encrypted for the acting user. Only checked when the client sends the field.
/// organization key, which has no id yet, and either id may be missing: from a client that predates
/// the field, or a user whose key id isn't known yet. There is nothing to compare in those cases.
/// ///
/// Ref: upstream's `CiphersController.ValidateCipherEncryptedByUser` /// Ref: <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Api/Vault/Controllers/CiphersController.cs#L1857-L1870>
fn validate_encrypted_by_user_key(data: &CipherData, user: &User, is_org_cipher: bool) -> EmptyResult { fn validate_encrypted_for_user(data: &CipherData, user_id: &UserId) -> EmptyResult {
if data.encrypted_for.as_ref().is_some_and(|encrypted_for| encrypted_for != user_id) {
err!("Cipher was not encrypted for the current user. Please try again.")
}
Ok(())
}
/// [`validate_encrypted_for_user`], plus the key id of a user-owned cipher, when both ids are known.
///
/// Ref: <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Api/Vault/Controllers/CiphersController.cs#L1886-L1911>
fn validate_encrypted_by_user(data: &CipherData, user: &User, is_org_cipher: bool) -> EmptyResult {
validate_encrypted_for_user(data, &user.uuid)?;
if !is_org_cipher if !is_org_cipher
&& let (Some(cipher_key_id), Some(user_key_id)) = (&data.encrypted_by_key_id, &user.key_id) && let (Some(cipher_key_id), Some(user_key_id)) = (&data.encrypted_by_key_id, &user.key_id)
&& cipher_key_id != user_key_id && cipher_key_id != user_key_id
@@ -360,16 +371,15 @@ fn validate_encrypted_by_user_key(data: &CipherData, user: &User, is_org_cipher:
const MAX_CIPHER_DATA_LENGTH: usize = 500_000; const MAX_CIPHER_DATA_LENGTH: usize = 500_000;
impl CipherData { impl CipherData {
/// Whether the content is a single blob rather than the per-type fields. This parses `data`, so /// Whether `data` is a blob rather than the per-type fields. Parses `data`, so keep the result.
/// callers that need the answer more than once should keep it.
pub fn is_blob(&self) -> bool { pub fn is_blob(&self) -> bool {
self.data.as_deref().is_some_and(is_data_blob_encrypted) self.data.as_deref().is_some_and(is_data_blob_encrypted)
} }
/// Checks the content the way upstream's model validation does, before anything is saved. /// Upstream's model checks that depend on the format: the size of `data`, and a name unless it's a blob.
/// `is_blob` is [`Self::is_blob`].
/// ///
/// Ref: <https://github.com/bitwarden/server/blob/main/src/Api/Vault/Models/Request/CipherRequestModel.cs> /// Ref: <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Api/Vault/Models/Request/CipherRequestModel.cs#L76-L77>
/// and <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Api/Vault/Models/Request/CipherRequestModel.cs#L91-L99>
pub fn validate_content(&self, is_blob: bool) -> Result<(), CipherValidationError> { pub fn validate_content(&self, is_blob: bool) -> Result<(), CipherValidationError> {
if let Some(data) = &self.data if let Some(data) = &self.data
&& data.len() > MAX_CIPHER_DATA_LENGTH && data.len() > MAX_CIPHER_DATA_LENGTH
@@ -425,17 +435,14 @@ async fn post_ciphers_create(
) -> JsonResult { ) -> JsonResult {
let mut data: ShareCipherData = data.into_inner(); let mut data: ShareCipherData = data.into_inner();
if data.cipher.encrypted_for != headers.user.uuid { validate_encrypted_by_user(&data.cipher, &headers.user, data.cipher.organization_id.is_some())?;
err_code!("Invalid user cipher", Status::UnprocessableEntity.code);
}
validate_encrypted_by_user_key(&data.cipher, &headers.user, data.cipher.organization_id.is_some())?;
// This check is usually only needed in update_cipher_from_data(), but we // This check is usually only needed in update_cipher_from_data(), but we
// need it here as well to avoid creating an empty cipher in the call to // need it here as well to avoid creating an empty cipher in the call to
// cipher.save() below. // cipher.save() below.
enforce_personal_ownership_policy(Some(&data.cipher), &headers, &conn).await?; enforce_personal_ownership_policy(Some(&data.cipher), &headers, &conn).await?;
let mut cipher = Cipher::new(data.cipher.r#type, String::new()); let mut cipher = Cipher::new(data.cipher.r#type);
cipher.user_uuid = Some(headers.user.uuid.clone()); cipher.user_uuid = Some(headers.user.uuid.clone());
cipher.save(&conn).await?; cipher.save(&conn).await?;
@@ -459,11 +466,7 @@ async fn post_ciphers_create(
async fn post_ciphers(data: Json<CipherData>, headers: Headers, conn: DbConn, nt: Notify<'_>) -> JsonResult { async fn post_ciphers(data: Json<CipherData>, headers: Headers, conn: DbConn, nt: Notify<'_>) -> JsonResult {
let mut data: CipherData = data.into_inner(); let mut data: CipherData = data.into_inner();
if data.encrypted_for != headers.user.uuid { validate_encrypted_by_user(&data, &headers.user, data.organization_id.is_some())?;
err_code!("Invalid user cipher", Status::UnprocessableEntity.code);
}
validate_encrypted_by_user_key(&data, &headers.user, data.organization_id.is_some())?;
// The web/browser clients set this field to null as expected, but the // The web/browser clients set this field to null as expected, but the
// mobile clients seem to set the invalid value `0001-01-01T00:00:00`, // mobile clients seem to set the invalid value `0001-01-01T00:00:00`,
@@ -471,7 +474,7 @@ async fn post_ciphers(data: Json<CipherData>, headers: Headers, conn: DbConn, nt
// needed when creating a new cipher, so just ignore it unconditionally. // needed when creating a new cipher, so just ignore it unconditionally.
data.last_known_revision_date = None; data.last_known_revision_date = None;
let mut cipher = Cipher::new(data.r#type, String::new()); let mut cipher = Cipher::new(data.r#type);
update_cipher_from_data(&mut cipher, data, &headers, None, &conn, &nt, UpdateType::SyncCipherCreate).await?; update_cipher_from_data(&mut cipher, data, &headers, None, &conn, &nt, UpdateType::SyncCipherCreate).await?;
Ok(Json(cipher.to_json(&headers.host, &headers.user.uuid, None, CipherSyncType::User, &conn).await?)) Ok(Json(cipher.to_json(&headers.host, &headers.user.uuid, None, CipherSyncType::User, &conn).await?))
@@ -495,6 +498,44 @@ async fn enforce_personal_ownership_policy(data: Option<&CipherData>, headers: &
Ok(()) Ok(())
} }
/// The checks of saving a cipher, for callers that run them before writing anything else
async fn validate_cipher_update(
cipher: &Cipher,
data: &CipherData,
headers: &Headers,
conn: &DbConn,
ut: UpdateType,
) -> EmptyResult {
// Check that the client isn't updating an existing cipher with stale data.
// And only perform this check when not importing ciphers, else the date/time check will fail.
if ut != UpdateType::None
&& let Some(dt) = &data.last_known_revision_date
{
match NaiveDateTime::parse_from_str(dt, "%+") {
// ISO 8601 format
Err(err) => warn!("Error parsing LastKnownRevisionDate '{dt}': {err}"),
Ok(dt) if cipher.updated_at.signed_duration_since(dt).num_seconds() > 1 => {
err!("The client copy of this cipher is out of date. Resync the client and try again.")
}
Ok(_) => (),
}
}
if let Some(note) = &data.notes {
let max_note_size = CONFIG._max_note_size();
if note.len() > max_note_size {
err!(format!("The field Notes exceeds the maximum encrypted value length of {max_note_size} characters."))
}
}
if let Some(folder_id) = &data.folder_id
&& Folder::find_by_uuid_and_user(folder_id, &headers.user.uuid, conn).await.is_none()
{
err!("Invalid folder", "Folder does not exist or belongs to another user");
}
Ok(())
}
pub async fn update_cipher_from_data( pub async fn update_cipher_from_data(
cipher: &mut Cipher, cipher: &mut Cipher,
data: CipherData, data: CipherData,
@@ -522,33 +563,12 @@ pub async fn update_cipher_from_data(
let is_blob = data.is_blob(); let is_blob = data.is_blob();
data.validate_content(is_blob)?; data.validate_content(is_blob)?;
validate_cipher_update(cipher, &data, headers, conn, ut).await?;
// Check that the client isn't updating an existing cipher with stale data.
// And only perform this check when not importing ciphers, else the date/time check will fail.
if ut != UpdateType::None
&& let Some(dt) = data.last_known_revision_date
{
match NaiveDateTime::parse_from_str(&dt, "%+") {
// ISO 8601 format
Err(err) => warn!("Error parsing LastKnownRevisionDate '{dt}': {err}"),
Ok(dt) if cipher.updated_at.signed_duration_since(dt).num_seconds() > 1 => {
err!("The client copy of this cipher is out of date. Resync the client and try again.")
}
Ok(_) => (),
}
}
if cipher.organization_uuid.is_some() && cipher.organization_uuid != data.organization_id { if cipher.organization_uuid.is_some() && cipher.organization_uuid != data.organization_id {
err!("Organization mismatch. Please resync the client before updating the cipher") err!("Organization mismatch. Please resync the client before updating the cipher")
} }
if let Some(note) = &data.notes {
let max_note_size = CONFIG._max_note_size();
if note.len() > max_note_size {
err!(format!("The field Notes exceeds the maximum encrypted value length of {max_note_size} characters."))
}
}
// Check if this cipher is being transferred from a personal to an organization vault // Check if this cipher is being transferred from a personal to an organization vault
let transfer_cipher = cipher.organization_uuid.is_none() && data.organization_id.is_some(); let transfer_cipher = cipher.organization_uuid.is_none() && data.organization_id.is_some();
@@ -579,12 +599,6 @@ pub async fn update_cipher_from_data(
cipher.user_uuid = Some(headers.user.uuid.clone()); cipher.user_uuid = Some(headers.user.uuid.clone());
} }
if let Some(ref folder_id) = data.folder_id
&& Folder::find_by_uuid_and_user(folder_id, &headers.user.uuid, conn).await.is_none()
{
err!("Invalid folder", "Folder does not exist or belongs to another user");
}
// Modify attachments name and keys when rotating // Modify attachments name and keys when rotating
if let Some(attachments) = data.attachments2 { if let Some(attachments) = data.attachments2 {
for (id, attachment) in attachments { for (id, attachment) in attachments {
@@ -624,8 +638,7 @@ pub async fn update_cipher_from_data(
}; };
if let Some(blob) = data.data.filter(|_| is_blob) { if let Some(blob) = data.data.filter(|_| is_blob) {
// A blob holds all of the content, the name included, so nothing is kept outside it. The name // A blob holds everything, the name included; the column can't be null, so it's left empty
// column can't be null, so it's left empty; `to_json` reports it as null, as upstream does.
// TODO: Make `ciphers.name` nullable and store `None` here instead. // TODO: Make `ciphers.name` nullable and store `None` here instead.
cipher.name = String::new(); cipher.name = String::new();
cipher.notes = None; cipher.notes = None;
@@ -750,7 +763,7 @@ async fn post_ciphers_import(data: Json<ImportData>, headers: Headers, conn: DbC
let folder_id = relations_map.get(&index).and_then(|i| folders.get(*i).cloned()); let folder_id = relations_map.get(&index).and_then(|i| folders.get(*i).cloned());
cipher_data.folder_id = folder_id; cipher_data.folder_id = folder_id;
let mut cipher = Cipher::new(cipher_data.r#type, String::new()); let mut cipher = Cipher::new(cipher_data.r#type);
update_cipher_from_data(&mut cipher, cipher_data, &headers, None, &conn, &nt, UpdateType::None).await?; update_cipher_from_data(&mut cipher, cipher_data, &headers, None, &conn, &nt, UpdateType::None).await?;
} }
@@ -818,7 +831,8 @@ async fn put_cipher(
err!("Cipher is not write accessible") err!("Cipher is not write accessible")
} }
validate_encrypted_by_user_key(&data, &headers.user, cipher.organization_uuid.is_some())?; // Against the cipher we hold rather than the organization the client claims, like upstream
validate_encrypted_by_user(&data, &headers.user, cipher.organization_uuid.is_some())?;
update_cipher_from_data(&mut cipher, data, &headers, None, &conn, &nt, UpdateType::SyncCipherUpdate).await?; update_cipher_from_data(&mut cipher, data, &headers, None, &conn, &nt, UpdateType::SyncCipherUpdate).await?;
@@ -1078,9 +1092,7 @@ async fn post_cipher_share(
conn: DbConn, conn: DbConn,
nt: Notify<'_>, nt: Notify<'_>,
) -> JsonResult { ) -> JsonResult {
let data: ShareCipherData = data.into_inner(); put_cipher_share(cipher_id, data, headers, conn, nt).await
share_cipher_by_uuid(&cipher_id, data, &headers, &conn, &nt, None).await
} }
#[put("/ciphers/<cipher_id>/share", data = "<data>")] #[put("/ciphers/<cipher_id>/share", data = "<data>")]
@@ -1093,6 +1105,21 @@ async fn put_cipher_share(
) -> JsonResult { ) -> JsonResult {
let data: ShareCipherData = data.into_inner(); let data: ShareCipherData = data.into_inner();
// Upstream's `PutShare` checks, before anything is written.
// Ref: <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Api/Vault/Controllers/CiphersController.cs#L899-L912>
// and <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Api/Vault/Models/Request/CipherRequestModel.cs#L498-L519>
if data.cipher.organization_id.is_none() {
err!("Cipher OrganizationId is required.")
}
if data.collection_ids.is_empty() {
err!("You must select at least one collection.")
}
if !Cipher::find_by_uuid(&cipher_id, &conn).await.is_some_and(|c| c.user_uuid.as_ref() == Some(&headers.user.uuid))
{
err_code!("Cipher doesn't exist", Status::NotFound.code)
}
validate_encrypted_for_user(&data.cipher, &headers.user.uuid)?;
share_cipher_by_uuid(&cipher_id, data, &headers, &conn, &nt, None).await share_cipher_by_uuid(&cipher_id, data, &headers, &conn, &nt, None).await
} }
@@ -1112,18 +1139,33 @@ async fn put_cipher_share_selected(
) -> EmptyResult { ) -> EmptyResult {
let mut data: ShareSelectedCipherData = data.into_inner(); let mut data: ShareSelectedCipherData = data.into_inner();
// Upstream's `PutShareMany` checks, before anything is written.
// Ref: <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Api/Vault/Controllers/CiphersController.cs#L1395-L1421>
// and <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Api/Vault/Models/Request/CipherRequestModel.cs#L560-L604>
if data.ciphers.is_empty() { if data.ciphers.is_empty() {
err!("You must select at least one cipher.") err!("You must select at least one cipher.")
} }
if data.ciphers.iter().any(|c| c.id.is_none() || c.organization_id.is_none()) {
err!("All Ciphers must have an Id and OrganizationId.")
}
if data.ciphers.iter().map(|c| &c.organization_id).collect::<HashSet<_>>().len() != 1 {
err!("All ciphers must be for the same organization.")
}
if data.collection_ids.is_empty() { if data.collection_ids.is_empty() {
err!("You must select at least one collection.") err!("You must select at least one collection.")
} }
for cipher in &data.ciphers { for cipher in &data.ciphers {
if cipher.id.is_none() { cipher.validate_content(cipher.is_blob())?;
err!("Request missing ids field") }
} for cipher in &data.ciphers {
validate_encrypted_for_user(cipher, &headers.user.uuid)?;
}
let owned_ciphers = Cipher::find_owned_by_user(&headers.user.uuid, &conn).await;
for cipher_data in &data.ciphers {
let Some(cipher) = owned_ciphers.iter().find(|c| cipher_data.id.as_ref() == Some(&c.uuid)) else {
err!("Trying to share ciphers that you do not own.")
};
validate_cipher_update(cipher, cipher_data, &headers, &conn, UpdateType::None).await?;
} }
while let Some(cipher) = data.ciphers.pop() { while let Some(cipher) = data.ciphers.pop() {
@@ -1170,6 +1212,20 @@ async fn share_cipher_by_uuid(
err!("Organization mismatch. Please resync the client before updating the cipher") err!("Organization mismatch. Please resync the client before updating the cipher")
} }
// When LastKnownRevisionDate is None, it is a new cipher, so send CipherCreate.
// If there is an override, like when handling multiple items, we want to prevent a push notification for every single item
let ut = if let Some(ut) = override_ut {
ut
} else if data.cipher.last_known_revision_date.is_some() {
UpdateType::SyncCipherUpdate
} else {
UpdateType::SyncCipherCreate
};
// For the same reason, the other checks of saving
data.cipher.validate_content(data.cipher.is_blob())?;
validate_cipher_update(&cipher, &data.cipher, headers, conn, ut).await?;
let mut shared_to_collections = vec![]; let mut shared_to_collections = vec![];
if let Some(organization_id) = &data.cipher.organization_id { if let Some(organization_id) = &data.cipher.organization_id {
@@ -1188,16 +1244,6 @@ async fn share_cipher_by_uuid(
} }
} }
// When LastKnownRevisionDate is None, it is a new cipher, so send CipherCreate.
// If there is an override, like when handling multiple items, we want to prevent a push notification for every single item
let ut = if let Some(ut) = override_ut {
ut
} else if data.cipher.last_known_revision_date.is_some() {
UpdateType::SyncCipherUpdate
} else {
UpdateType::SyncCipherCreate
};
update_cipher_from_data(&mut cipher, data.cipher, headers, Some(shared_to_collections), conn, nt, ut).await?; update_cipher_from_data(&mut cipher, data.cipher, headers, Some(shared_to_collections), conn, nt, ut).await?;
Ok(Json(cipher.to_json(&headers.host, &headers.user.uuid, None, CipherSyncType::User, conn).await?)) Ok(Json(cipher.to_json(&headers.host, &headers.user.uuid, None, CipherSyncType::User, conn).await?))
+43 -6
View File
@@ -8,7 +8,7 @@ use crate::{
CONFIG, CONFIG,
api::admin::FAKE_ADMIN_UUID, api::admin::FAKE_ADMIN_UUID,
api::{ api::{
EmptyResult, JsonResult, Notify, PasswordOrOtpData, UpdateType, ApiResult, EmptyResult, JsonResult, Notify, PasswordOrOtpData, UpdateType,
core::{CipherSyncData, CipherSyncType, accept_org_invite, log_event, two_factor}, core::{CipherSyncData, CipherSyncType, accept_org_invite, log_event, two_factor},
}, },
auth::{AdminHeaders, Headers, ManagerHeaders, ManagerHeadersLoose, OrgMemberHeaders, OwnerHeaders, decode_invite}, auth::{AdminHeaders, Headers, ManagerHeaders, ManagerHeadersLoose, OrgMemberHeaders, OwnerHeaders, decode_invite},
@@ -1829,7 +1829,7 @@ async fn post_org_import(
cipher_data.folder_id = None; cipher_data.folder_id = None;
// Replace the client-provided, unvalidated organizationId with the real target org // Replace the client-provided, unvalidated organizationId with the real target org
cipher_data.organization_id = Some(org_id.clone()); cipher_data.organization_id = Some(org_id.clone());
let mut cipher = Cipher::new(cipher_data.r#type, String::new()); let mut cipher = Cipher::new(cipher_data.r#type);
update_cipher_from_data( update_cipher_from_data(
&mut cipher, &mut cipher,
cipher_data, cipher_data,
@@ -2764,8 +2764,26 @@ struct OrganizationUserRecoverAccountRequest {
// But the clients do not seem to use this at all // But the clients do not seem to use this at all
// Just add it here in case they will // Just add it here in case they will
#[get("/organizations/<org_id>/public-key")] #[get("/organizations/<org_id>/public-key")]
async fn get_organization_public_key(org_id: OrganizationId, headers: OrgMemberHeaders, conn: DbConn) -> JsonResult { async fn get_organization_public_key(
if org_id != headers.membership.org_uuid { org_id: OrganizationId,
headers: Headers,
member: Result<OrgMemberHeaders, &'static str>,
conn: DbConn,
) -> JsonResult {
// SSO users without an org get the fake one, whose key the v2 JIT password flow fetches anyway
if org_id.eq_ignore_ascii_case(FAKE_SSO_IDENTIFIER) && headers.user.private_key.is_none() {
return Ok(Json(json!({
"object": "organizationPublicKey",
"publicKey": fake_sso_org_public_key().await?,
})));
}
let member = match member {
Ok(member) => member,
// The guard already logged it
Err(e) => return Err(crate::error::Error::new_msg(e).with_code(Status::Unauthorized.code)),
};
if org_id != member.membership.org_uuid {
err!("Organization not found", "Organization id's do not match"); err!("Organization not found", "Organization id's do not match");
} }
let Some(org) = Organization::find_by_uuid(&org_id, &conn).await else { let Some(org) = Organization::find_by_uuid(&org_id, &conn).await else {
@@ -2778,11 +2796,30 @@ async fn get_organization_public_key(org_id: OrganizationId, headers: OrgMemberH
}))) })))
} }
/// The SDK only uses this key to wrap an account recovery key that it never sends for the fake org,
/// so it is made once and its private half dropped.
async fn fake_sso_org_public_key() -> ApiResult<String> {
static PUBLIC_KEY: std::sync::LazyLock<Option<String>> = std::sync::LazyLock::new(|| {
let der = openssl::rsa::Rsa::generate(2048).and_then(|rsa| rsa.public_key_to_der()).ok()?;
Some(data_encoding::BASE64.encode(&der))
});
let Ok(Some(public_key)) = tokio::task::spawn_blocking(|| PUBLIC_KEY.clone()).await else {
err!("Failed to generate the organization key")
};
Ok(public_key)
}
// Obsolete - Renamed to public-key (2023.8), left for backwards compatibility with older clients // Obsolete - Renamed to public-key (2023.8), left for backwards compatibility with older clients
// https://github.com/bitwarden/server/blob/9ebe16587175b1c0e9208f84397bb75d0d595510/src/Api/AdminConsole/Controllers/OrganizationsController.cs#L487-L492 // https://github.com/bitwarden/server/blob/9ebe16587175b1c0e9208f84397bb75d0d595510/src/Api/AdminConsole/Controllers/OrganizationsController.cs#L487-L492
#[get("/organizations/<org_id>/keys")] #[get("/organizations/<org_id>/keys")]
async fn get_organization_keys(org_id: OrganizationId, headers: OrgMemberHeaders, conn: DbConn) -> JsonResult { async fn get_organization_keys(
get_organization_public_key(org_id, headers, conn).await org_id: OrganizationId,
headers: Headers,
member: Result<OrgMemberHeaders, &'static str>,
conn: DbConn,
) -> JsonResult {
get_organization_public_key(org_id, headers, member, conn).await
} }
// Will allow to reset 2FA too // Will allow to reset 2FA too
+1 -1
View File
@@ -1424,8 +1424,8 @@ pub const SUPPORTED_FEATURE_FLAGS: &[&str] = &[
"ssh-agent-v2", "ssh-agent-v2",
// Key Management Team // Key Management Team
"windows-native-credential-sync", "windows-native-credential-sync",
"pm-27278-v2-password-registration",
"enable-account-encryption-v2-jit-password-registration", "enable-account-encryption-v2-jit-password-registration",
"pm-27278-v2-password-registration",
// Mobile Team // Mobile Team
"pm-34171-card-scanner", "pm-34171-card-scanner",
// Platform Team // Platform Team
+78 -73
View File
@@ -19,7 +19,7 @@ use crate::{
}, },
}, },
error::MapResult, error::MapResult,
util::LowerCase, util::{LowerCase, convert_json_key_lcase_first},
}; };
use macros::UuidFromParam; use macros::UuidFromParam;
@@ -63,13 +63,9 @@ pub struct Cipher {
pub reprompt: Option<i32>, pub reprompt: Option<i32>,
} }
/// Whether `data` is a sealed cipher blob rather than the legacy per-type JSON. /// Whether `data` is a v2 cipher blob, recognized like upstream by a top-level `format_version` key.
/// ///
/// Ciphers of v2 accounts are encrypted as a single blob that carries everything, name included, /// Ref: <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Core/Vault/Entities/Cipher.cs#L36-L41>
/// and is opaque to us. It is recognized the same way upstream does, by a top-level
/// `format_version` key that the legacy JSON never has.
///
/// Ref: <https://github.com/bitwarden/server/blob/main/src/Core/Vault/Entities/Cipher.cs>
pub fn is_data_blob_encrypted(data: &str) -> bool { pub fn is_data_blob_encrypted(data: &str) -> bool {
serde_json::from_str::<Value>(data).is_ok_and(|d| is_blob_value(&d)) serde_json::from_str::<Value>(data).is_ok_and(|d| is_blob_value(&d))
} }
@@ -86,7 +82,8 @@ pub enum RepromptType {
/// Local methods /// Local methods
impl Cipher { impl Cipher {
pub fn new(atype: i32, name: String) -> Self { /// The name is set when the data is saved, since a blob-encrypted cipher has it inside `data`
pub fn new(atype: i32) -> Self {
let now = Utc::now().naive_utc(); let now = Utc::now().naive_utc();
Self { Self {
@@ -100,7 +97,7 @@ impl Cipher {
key: None, key: None,
atype, atype,
name, name: String::new(),
notes: None, notes: None,
fields: None, fields: None,
@@ -175,9 +172,8 @@ impl Cipher {
) -> Result<Value, crate::Error> { ) -> Result<Value, crate::Error> {
use crate::util::{format_date, validate_and_format_date}; use crate::util::{format_date, validate_and_format_date};
// Parsed once here, since `data` can be large and this runs for every cipher in a sync. // Parsed once, since `data` can be large and this runs for every cipher in a sync
// `LowerCase` only lowercases the first letter of each key, so it keeps `format_version`. let type_data = serde_json::from_str::<Value>(&self.data);
let type_data = serde_json::from_str::<LowerCase<Value>>(&self.data).map(|d| d.data);
let is_blob_encrypted = type_data.as_ref().is_ok_and(is_blob_value); let is_blob_encrypted = type_data.as_ref().is_ok_and(is_blob_value);
let mut attachments_json: Value = Value::Null; let mut attachments_json: Value = Value::Null;
@@ -215,62 +211,70 @@ impl Cipher {
(false, false, false) (false, false, false)
}; };
// Like upstream, a cipher that was stored without fields or password history reports them as let fields_json: Vec<_> = self
// null rather than as an empty list; clients keep the two apart. .fields
let fields_json: Option<Vec<_>> = self.fields.as_ref().map(|s| { .as_ref()
serde_json::from_str::<Vec<LowerCase<Value>>>(s) .and_then(|s| {
.inspect_err(|e| warn!("Error parsing fields {e:?} for {}", self.uuid)) serde_json::from_str::<Vec<LowerCase<Value>>>(s)
.ok() .inspect_err(|e| warn!("Error parsing fields {e:?} for {}", self.uuid))
.map(|d| { .ok()
d.into_iter() })
.map(|mut f| { .map(|d| {
// Check if the `type` key is a number, strings break some clients d.into_iter()
// The fallback type is the hidden type `1`. this should prevent accidental data disclosure .map(|mut f| {
// If not try to convert the string value to a number and fallback to `1` // Check if the `type` key is a number, strings break some clients
// If it is both not a number and not a string, fallback to `1` // The fallback type is the hidden type `1`. this should prevent accidental data disclosure
match f.data.get("type") { // If not try to convert the string value to a number and fallback to `1`
Some(t) if t.is_number() => {} // If it is both not a number and not a string, fallback to `1`
Some(t) if t.is_string() => { match f.data.get("type") {
let type_num = &t.as_str().unwrap_or("1").parse::<u8>().unwrap_or(1); Some(t) if t.is_number() => {}
f.data["type"] = json!(type_num); Some(t) if t.is_string() => {
} let type_num = &t.as_str().unwrap_or("1").parse::<u8>().unwrap_or(1);
_ => { f.data["type"] = json!(type_num);
f.data["type"] = json!(1);
}
} }
f.data _ => {
}) f.data["type"] = json!(1);
.collect() }
}) }
.unwrap_or_default() f.data
}); })
.collect()
})
.unwrap_or_default();
let password_history_json: Option<Vec<_>> = self.password_history.as_ref().map(|s| { let password_history_json: Vec<_> = self
serde_json::from_str::<Vec<LowerCase<Value>>>(s) .password_history
.inspect_err(|e| warn!("Error parsing password history {e:?} for {}", self.uuid)) .as_ref()
.ok() .and_then(|s| {
.map(|d| { serde_json::from_str::<Vec<LowerCase<Value>>>(s)
// Check every password history item if they are valid and return it. .inspect_err(|e| warn!("Error parsing password history {e:?} for {}", self.uuid))
// If a password field has the type `null` skip it, it breaks newer Bitwarden clients .ok()
// A second check is done to verify the lastUsedDate exists and is a valid DateTime string, if not the epoch start time will be used })
d.into_iter() .map(|d| {
.filter_map(|d| match d.data.get("password") { // Check every password history item if they are valid and return it.
Some(p) if p.is_string() => Some(d.data), // If a password field has the type `null` skip it, it breaks newer Bitwarden clients
_ => None, // A second check is done to verify the lastUsedDate exists and is a valid DateTime string, if not the epoch start time will be used
}) d.into_iter()
.map(|mut d| { .filter_map(|d| match d.data.get("password") {
let lud = if let Some(l) = d.get("lastUsedDate").and_then(|l| l.as_str()) { Some(p) if p.is_string() => Some(d.data),
validate_and_format_date(l) _ => None,
} else { })
"1970-01-01T00:00:00.000000Z".to_owned() .map(|mut d| {
}; let lud = if let Some(l) = d.get("lastUsedDate").and_then(|l| l.as_str()) {
d["lastUsedDate"] = json!(lud); validate_and_format_date(l)
d } else {
}) "1970-01-01T00:00:00.000000Z".to_owned()
.collect() };
}) d["lastUsedDate"] = json!(lud);
.unwrap_or_default() d
}); })
.collect()
})
.unwrap_or_default();
// Like upstream, fields and password history stored as NULL are sent as null, not `[]`
let fields_json = self.fields.is_some().then_some(fields_json);
let password_history_json = self.password_history.is_some().then_some(password_history_json);
let collection_ids = if let Some(cipher_sync_data) = cipher_sync_data { let collection_ids = if let Some(cipher_sync_data) = cipher_sync_data {
if let Some(cipher_collections) = cipher_sync_data.cipher_collections.get(&self.uuid) { if let Some(cipher_collections) = cipher_sync_data.cipher_collections.get(&self.uuid) {
@@ -368,8 +372,7 @@ impl Cipher {
}; };
if is_blob_encrypted { if is_blob_encrypted {
// The blob holds all of the content, so it is sent back as-is and the structured fields // Like upstream, sent as-is with the structured fields null
// stay null, as upstream does. Only the name needs clearing, the others are never stored.
json_object["data"] = json!(self.data); json_object["data"] = json!(self.data);
json_object["name"] = Value::Null; json_object["name"] = Value::Null;
} else { } else {
@@ -378,16 +381,18 @@ impl Cipher {
Ok(json_object) Ok(json_object)
} }
/// The per-type data (`login`, `card`, …) of a legacy cipher, from `type_data` as parsed from /// The per-type data of a legacy cipher, with fixups for values known to break clients.
/// `self.data`, with fixups for values that are known to break clients.
fn legacy_type_data_json(&self, type_data: Result<Value, serde_json::Error>) -> Value { fn legacy_type_data_json(&self, type_data: Result<Value, serde_json::Error>) -> Value {
use crate::util::validate_and_format_date; use crate::util::validate_and_format_date;
// Get the type_data or a default to an empty json object '{}'. // Get the type_data or a default to an empty json object '{}'.
// If not passing an empty object, mobile clients will crash. // If not passing an empty object, mobile clients will crash.
let mut type_data_json = type_data let mut type_data_json = if let Ok(data @ Value::Object(_)) = type_data {
.inspect_err(|_| warn!("Error parsing data field for {}", self.uuid)) convert_json_key_lcase_first(data)
.unwrap_or_else(|_| Value::Object(serde_json::Map::new())); } else {
warn!("Error parsing data field for {}", self.uuid);
Value::Object(serde_json::Map::new())
};
// NOTE: This was marked as *Backwards Compatibility Code*, but as of January 2021 this is still being used by upstream // NOTE: This was marked as *Backwards Compatibility Code*, but as of January 2021 this is still being used by upstream
// Set the first element of the Uris array as Uri, this is needed several (mobile) clients. // Set the first element of the Uris array as Uri, this is needed several (mobile) clients.
+29 -40
View File
@@ -73,8 +73,7 @@ pub struct User {
pub key_id: Option<KeyId>, pub key_id: Option<KeyId>,
// "v2" account cryptographic state. Either all of these are set (together with a row in // The v2 state: all set, with a `user_signature_key_pairs` row, or none, see `User::is_v2`
// `user_signature_key_pairs`) or none of them are; see `User::is_v2`.
pub signed_public_key: Option<String>, pub signed_public_key: Option<String>,
pub security_state: Option<String>, pub security_state: Option<String>,
pub security_version: Option<i32>, pub security_version: Option<i32>,
@@ -283,34 +282,35 @@ impl User {
UserSignatureKeyPair::find_by_user(&self.uuid, conn).await UserSignatureKeyPair::find_by_user(&self.uuid, conn).await
} }
/// The `accountKeys` object (upstream's `PrivateKeysResponseModel`), null without a key pair
pub async fn account_keys_json(&self, conn: &DbConn) -> Value { pub async fn account_keys_json(&self, conn: &DbConn) -> Value {
if self.private_key.is_none() { if self.private_key.is_some() {
return Value::Null; let (signed_public_key, signature_key_pair, security_state) = match self.v2_signature_key_pair(conn).await {
Some(key_pair) => (
json!(self.signed_public_key),
key_pair.to_json(),
json!({
"securityState": self.security_state,
"securityVersion": self.security_version,
}),
),
None => (Value::Null, Value::Null, Value::Null),
};
json!({
"publicKeyEncryptionKeyPair": {
"wrappedPrivateKey": self.private_key,
"publicKey": self.public_key,
"signedPublicKey": signed_public_key,
"object": "publicKeyEncryptionKeyPair",
},
"securityState": security_state,
"signatureKeyPair": signature_key_pair,
"object": "privateKeys"
})
} else {
Value::Null
} }
let (signed_public_key, signature_key_pair, security_state) = match self.v2_signature_key_pair(conn).await {
Some(key_pair) => (
json!(self.signed_public_key),
key_pair.to_json(),
json!({
"securityState": self.security_state,
"securityVersion": self.security_version,
}),
),
None => (Value::Null, Value::Null, Value::Null),
};
json!({
"publicKeyEncryptionKeyPair": {
"wrappedPrivateKey": self.private_key,
"publicKey": self.public_key,
"signedPublicKey": signed_public_key,
"object": "publicKeyEncryptionKeyPair",
},
"signatureKeyPair": signature_key_pair,
"securityState": security_state,
"object": "privateKeys"
})
} }
pub async fn public_keys_json(&self, conn: &DbConn) -> Value { pub async fn public_keys_json(&self, conn: &DbConn) -> Value {
@@ -612,18 +612,7 @@ pub struct UserId(String);
)] )]
#[deref(forward)] #[deref(forward)]
#[from(forward)] #[from(forward)]
pub struct KeyId(#[serde(deserialize_with = "deserialize_key_id")] String); pub struct KeyId(String);
/// Rejects a key id from a request that isn't 16 bytes as lowercase hex, as upstream's `[KeyId]` does.
///
/// Ref: <https://github.com/bitwarden/server/blob/main/src/Core/KeyManagement/Models/Data/KeyId.cs>
fn deserialize_key_id<'de, D: serde::Deserializer<'de>>(deserializer: D) -> Result<String, D::Error> {
let key_id = <String as serde::Deserialize>::deserialize(deserializer)?;
if key_id.len() != 32 || !key_id.bytes().all(|b| matches!(b, b'0'..=b'9' | b'a'..=b'f')) {
return Err(serde::de::Error::custom("Key id must be a 32 character lowercase hex-encoded string."));
}
Ok(key_id)
}
impl SsoUser { impl SsoUser {
pub async fn save(&self, conn: &DbConn) -> EmptyResult { pub async fn save(&self, conn: &DbConn) -> EmptyResult {
+3 -8
View File
@@ -12,14 +12,9 @@ use crate::{
use super::UserId; use super::UserId;
/// A user's signature key pair, part of the "v2" account cryptographic state. /// A user's signature key pair, part of the v2 state, in its own table like upstream.
/// ///
/// Upstream keeps this in its own table rather than as columns on the user, with a unique index on /// Ref: <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Sql/dbo/KeyManagement/Tables/UserSignatureKeyPair.sql#L1-L15>
/// the user id. The stated intent is to eventually keep superseded key pairs around (an `active`
/// flag was sketched but not shipped), which is why this is modelled as a row with its own identity
/// instead of a set of user attributes.
///
/// Ref: <https://github.com/bitwarden/server/blob/main/src/Sql/dbo/KeyManagement/Tables/UserSignatureKeyPair.sql>
#[derive(Identifiable, Queryable, Insertable, AsChangeset, Selectable)] #[derive(Identifiable, Queryable, Insertable, AsChangeset, Selectable)]
#[diesel(table_name = user_signature_key_pairs)] #[diesel(table_name = user_signature_key_pairs)]
#[diesel(treat_none_as_null = true)] #[diesel(treat_none_as_null = true)]
@@ -38,7 +33,7 @@ pub struct UserSignatureKeyPair {
pub updated_at: NaiveDateTime, pub updated_at: NaiveDateTime,
} }
/// https://github.com/bitwarden/server/blob/main/src/Core/KeyManagement/Enums/SignatureAlgorithm.cs /// Ref: <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Core/KeyManagement/Enums/SignatureAlgorithm.cs#L6-L10>
#[derive(Clone, Copy, Debug, PartialEq, Eq)] #[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum SignatureAlgorithm { pub enum SignatureAlgorithm {
Ed25519 = 0, Ed25519 = 0,
+6
View File
@@ -839,6 +839,12 @@ pub fn parse_experimental_client_feature_flags(
.collect() .collect()
} }
/// Whether the admin enabled this supported client feature flag
pub fn is_client_feature_flag_enabled(flag: &str) -> bool {
parse_experimental_client_feature_flags(&CONFIG.experimental_client_feature_flags(), &FeatureFlagFilter::ValidOnly)
.contains_key(flag)
}
/// TODO: This is extracted from IpAddr::is_global, which is unstable: /// TODO: This is extracted from IpAddr::is_global, which is unstable:
/// https://doc.rust-lang.org/nightly/std/net/enum.IpAddr.html#method.is_global /// https://doc.rust-lang.org/nightly/std/net/enum.IpAddr.html#method.is_global
/// Remove once https://github.com/rust-lang/rust/issues/27709 is merged /// Remove once https://github.com/rust-lang/rust/issues/27709 is merged