CipherListView updates (#306)

## 🎟️ Tracking

Tangential to
[PM-22134](https://bitwarden.atlassian.net/browse/PM-22134)

## 📔 Objective

Two updates to ensure parity when migrating from `CipherView` to
`CipherListView` on the clients repo
- Added `local_data` so the type propagates to the clients repo and can
be set there.
- Added  `CopiableCipherFields` enum + property.
- In the browser the copy menu / actions are dynamic based on the
populated fields on the cipher. The `CipherListView` doesn't contain
these details. This array is filled with the available fields so the
extension can still check their availability. When a value is needed the
full cipher is decrypted.
- Added `has_old_attachments` to identify attachments following old
encryption methods. This populates UI signaling to the user that the
attachment needs to be re-encrypted.

## 🦮 Reviewer guidelines

<!-- Suggested interactions but feel free to use (or not) as you desire!
-->

- 👍 (`:+1:`) or similar for great changes
- 📝 (`:memo:`) or ℹ️ (`:information_source:`) for notes or general info
- ❓ (`:question:`) for questions
- 🤔 (`:thinking:`) or 💭 (`:thought_balloon:`) for more open inquiry
that's not quite a confirmed
  issue and could potentially benefit from discussion
- 🎨 (`:art:`) for suggestions / improvements
- ❌ (`:x:`) or ⚠️ (`:warning:`) for more significant problems or
concerns needing attention
- 🌱 (`:seedling:`) or ♻️ (`:recycle:`) for future improvements or
indications of technical debt
- ⛏ (`:pick:`) for minor or nitpick changes


[PM-22134]:
https://bitwarden.atlassian.net/browse/PM-22134?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

Author: nick-livefront

crates/bitwarden-vault/src/cipher/card.rs

@@ -6,7 +6,7 @@ use serde::{Deserialize, Serialize};
 use tsify_next::Tsify;
 
 use super::cipher::CipherKind;
-use crate::VaultParseError;
+use crate::{cipher::cipher::CopyableCipherFields, Cipher, VaultParseError};
 
 #[derive(Serialize, Deserialize, Debug, Clone)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
@@ -143,6 +143,20 @@ impl CipherKind for Card {
 
         Ok(build_subtitle_card(brand, number))
     }
+
+    fn get_copyable_fields(&self, _: Option<&Cipher>) -> Vec<CopyableCipherFields> {
+        [
+            self.number
+                .as_ref()
+                .map(|_| CopyableCipherFields::CardNumber),
+            self.code
+                .as_ref()
+                .map(|_| CopyableCipherFields::CardSecurityCode),
+        ]
+        .into_iter()
+        .flatten()
+        .collect()
+    }
 }
 
 /// Builds the subtitle for a card cipher
@@ -233,4 +247,38 @@ mod tests {
         let subtitle = build_subtitle_card(brand, number);
         assert_eq!(subtitle, "*4444");
     }
+    #[test]
+    fn test_get_copyable_fields_code() {
+        let card = Card {
+            cardholder_name: None,
+            exp_month: None,
+            exp_year: None,
+            code: Some("2.6TpmzzaQHgYr+mXjdGLQlg==|vT8VhfvMlWSCN9hxGYftZ5rjKRsZ9ofjdlUCx5Gubnk=|uoD3/GEQBWKKx2O+/YhZUCzVkfhm8rFK3sUEVV84mv8=".parse().unwrap()),
+            brand: None,
+            number: None,
+        };
+
+        let copyable_fields = card.get_copyable_fields(None);
+
+        assert_eq!(
+            copyable_fields,
+            vec![CopyableCipherFields::CardSecurityCode]
+        );
+    }
+
+    #[test]
+    fn test_get_copyable_fields_number() {
+        let card = Card {
+            cardholder_name: None,
+            exp_month: None,
+            exp_year: None,
+            code: None,
+            brand: None,
+            number: Some("2.6TpmzzaQHgYr+mXjdGLQlg==|vT8VhfvMlWSCN9hxGYftZ5rjKRsZ9ofjdlUCx5Gubnk=|uoD3/GEQBWKKx2O+/YhZUCzVkfhm8rFK3sUEVV84mv8=".parse().unwrap()),
+        };
+
+        let copyable_fields = card.get_copyable_fields(None);
+
+        assert_eq!(copyable_fields, vec![CopyableCipherFields::CardNumber]);
+    }
 }

crates/bitwarden-vault/src/cipher/cipher.rs

@@ -53,6 +53,9 @@ pub(super) trait CipherKind {
         ctx: &mut KeyStoreContext<KeyIds>,
         key: SymmetricKeyId,
     ) -> Result<String, CryptoError>;
+
+    /// Returns a list of populated fields for the cipher.
+    fn get_copyable_fields(&self, cipher: Option<&Cipher>) -> Vec<CopyableCipherFields>;
 }
 
 #[allow(missing_docs)]
@@ -186,6 +189,24 @@ pub enum CipherListViewType {
     SshKey,
 }
 
+/// Available fields on a cipher and can be copied from a the list view in the UI.
+#[derive(Serialize, Deserialize, Debug, PartialEq)]
+#[cfg_attr(feature = "wasm", derive(Tsify), tsify(into_wasm_abi, from_wasm_abi))]
+#[cfg_attr(feature = "uniffi", derive(uniffi::Enum))]
+pub enum CopyableCipherFields {
+    LoginUsername,
+    LoginPassword,
+    LoginTotp,
+    CardNumber,
+    CardSecurityCode,
+    IdentityUsername,
+    IdentityEmail,
+    IdentityPhone,
+    IdentityAddress,
+    SshKey,
+    SecureNotes,
+}
+
 #[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, PartialEq)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
@@ -215,10 +236,17 @@ pub struct CipherListView {
 
     /// The number of attachments
     pub attachments: u32,
+    /// Indicates if the cipher has old attachments that need to be re-uploaded
+    pub has_old_attachments: bool,
 
     pub creation_date: DateTime<Utc>,
     pub deleted_date: Option<DateTime<Utc>>,
     pub revision_date: DateTime<Utc>,
+
+    /// Hints for the presentation layer for which fields can be copied.
+    pub copyable_fields: Vec<CopyableCipherFields>,
+
+    pub local_data: Option<LocalDataView>,
 }
 
 impl CipherListView {
@@ -366,7 +394,7 @@ impl Cipher {
             CipherType::Card => self.card.as_ref().map(|v| v as _),
             CipherType::Identity => self.identity.as_ref().map(|v| v as _),
             CipherType::SshKey => self.ssh_key.as_ref().map(|v| v as _),
-            _ => None,
+            CipherType::SecureNote => self.secure_note.as_ref().map(|v| v as _),
         }
     }
 
@@ -380,6 +408,14 @@ impl Cipher {
             .map(|sub| sub.decrypt_subtitle(ctx, key))
             .unwrap_or_else(|| Ok(String::new()))
     }
+
+    /// Returns a list of copyable field names for this cipher,
+    /// based on the cipher type and populated properties.
+    fn get_copyable_fields(&self) -> Vec<CopyableCipherFields> {
+        self.get_kind()
+            .map(|kind| kind.get_copyable_fields(Some(self)))
+            .unwrap_or_default()
+    }
 }
 
 impl CipherView {
@@ -586,9 +622,16 @@ impl Decryptable<KeyIds, SymmetricKeyId, CipherListView> for Cipher {
                 .as_ref()
                 .map(|a| a.len() as u32)
                 .unwrap_or(0),
+            has_old_attachments: self
+                .attachments
+                .as_ref()
+                .map(|a| a.iter().any(|att| att.key.is_none()))
+                .unwrap_or(false),
             creation_date: self.creation_date,
             deleted_date: self.deleted_date,
             revision_date: self.revision_date,
+            copyable_fields: self.get_copyable_fields(),
+            local_data: self.local_data.decrypt(ctx, ciphers_key)?,
         })
     }
 }
@@ -837,9 +880,16 @@ mod tests {
                 permissions: cipher.permissions,
                 view_password: cipher.view_password,
                 attachments: 0,
+                has_old_attachments: false,
                 creation_date: cipher.creation_date,
                 deleted_date: cipher.deleted_date,
-                revision_date: cipher.revision_date
+                revision_date: cipher.revision_date,
+                copyable_fields: vec![
+                    CopyableCipherFields::LoginUsername,
+                    CopyableCipherFields::LoginPassword,
+                    CopyableCipherFields::LoginTotp
+                ],
+                local_data: None,
             }
         )
     }

crates/bitwarden-vault/src/cipher/identity.rs

@@ -6,7 +6,7 @@ use serde::{Deserialize, Serialize};
 use tsify_next::Tsify;
 
 use super::cipher::CipherKind;
-use crate::VaultParseError;
+use crate::{cipher::cipher::CopyableCipherFields, Cipher, VaultParseError};
 
 #[derive(Serialize, Deserialize, Debug, Clone)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
@@ -163,6 +163,31 @@ impl CipherKind for Identity {
 
         Ok(build_subtitle_identity(first_name, last_name))
     }
+
+    fn get_copyable_fields(&self, _: Option<&Cipher>) -> Vec<CopyableCipherFields> {
+        [
+            self.username
+                .as_ref()
+                .map(|_| CopyableCipherFields::IdentityUsername),
+            self.email
+                .as_ref()
+                .map(|_| CopyableCipherFields::IdentityEmail),
+            self.phone
+                .as_ref()
+                .map(|_| CopyableCipherFields::IdentityPhone),
+            self.address1
+                .as_ref()
+                .or(self.address2.as_ref())
+                .or(self.address3.as_ref())
+                .or(self.city.as_ref())
+                .or(self.state.as_ref())
+                .or(self.postal_code.as_ref())
+                .map(|_| CopyableCipherFields::IdentityAddress),
+        ]
+        .into_iter()
+        .flatten()
+        .collect()
+    }
 }
 
 /// Builds the subtitle for a card cipher
@@ -193,6 +218,30 @@ fn build_subtitle_identity(first_name: Option<String>, last_name: Option<String>
 #[cfg(test)]
 mod tests {
     use super::*;
+    use crate::cipher::cipher::CopyableCipherFields;
+
+    fn create_identity() -> Identity {
+        Identity {
+            title: None,
+            first_name: None,
+            middle_name: None,
+            last_name: None,
+            address1: None,
+            address2: None,
+            address3: None,
+            city: None,
+            state: None,
+            postal_code: None,
+            country: None,
+            company: None,
+            email: None,
+            phone: None,
+            ssn: None,
+            username: None,
+            passport_number: None,
+            license_number: None,
+        }
+    }
 
     #[test]
     fn test_build_subtitle_identity() {
@@ -229,4 +278,59 @@ mod tests {
         let subtitle = build_subtitle_identity(first_name, last_name);
         assert_eq!(subtitle, "");
     }
+
+    #[test]
+    fn test_get_copyable_fields_identity_empty() {
+        let identity = create_identity();
+
+        let copyable_fields = identity.get_copyable_fields(None);
+        assert_eq!(copyable_fields, vec![]);
+    }
+
+    #[test]
+    fn test_get_copyable_fields_identity_has_username() {
+        let mut identity = create_identity();
+        identity.username = Some("2.yXXpPbsf6NZhLVkNe/i4Bw==|ol/HTI++aMO1peBBBhSR7Q==|awNmmj31efIXTzaru42/Ay+bQ6V+1MrKxXh1Uo5gca8=".parse().unwrap());
+
+        let copyable_fields = identity.get_copyable_fields(None);
+        assert_eq!(
+            copyable_fields,
+            vec![CopyableCipherFields::IdentityUsername]
+        );
+    }
+
+    #[test]
+    fn test_get_copyable_fields_identity_has_email() {
+        let mut identity = create_identity();
+        identity.email = Some("2.yXXpPbsf6NZhLVkNe/i4Bw==|ol/HTI++aMO1peBBBhSR7Q==|awNmmj31efIXTzaru42/Ay+bQ6V+1MrKxXh1Uo5gca8=".parse().unwrap());
+
+        let copyable_fields = identity.get_copyable_fields(None);
+        assert_eq!(copyable_fields, vec![CopyableCipherFields::IdentityEmail]);
+    }
+
+    #[test]
+    fn test_get_copyable_fields_identity_has_phone() {
+        let mut identity = create_identity();
+        identity.phone = Some("2.yXXpPbsf6NZhLVkNe/i4Bw==|ol/HTI++aMO1peBBBhSR7Q==|awNmmj31efIXTzaru42/Ay+bQ6V+1MrKxXh1Uo5gca8=".parse().unwrap());
+
+        let copyable_fields = identity.get_copyable_fields(None);
+        assert_eq!(copyable_fields, vec![CopyableCipherFields::IdentityPhone]);
+    }
+
+    #[test]
+    fn test_get_copyable_fields_identity_has_address() {
+        let mut identity = create_identity();
+
+        identity.address1 = Some("2.yXXpPbsf6NZhLVkNe/i4Bw==|ol/HTI++aMO1peBBBhSR7Q==|awNmmj31efIXTzaru42/Ay+bQ6V+1MrKxXh1Uo5gca8=".parse().unwrap());
+
+        let mut copyable_fields = identity.get_copyable_fields(None);
+
+        assert_eq!(copyable_fields, vec![CopyableCipherFields::IdentityAddress]);
+
+        identity.state = Some("2.yXXpPbsf6NZhLVkNe/i4Bw==|ol/HTI++aMO1peBBBhSR7Q==|awNmmj31efIXTzaru42/Ay+bQ6V+1MrKxXh1Uo5gca8=".parse().unwrap());
+        identity.address1 = None;
+
+        copyable_fields = identity.get_copyable_fields(None);
+        assert_eq!(copyable_fields, vec![CopyableCipherFields::IdentityAddress]);
+    }
 }

crates/bitwarden-vault/src/cipher/local_data.rs

@@ -14,7 +14,7 @@ pub struct LocalData {
     last_launched: Option<DateTime<Utc>>,
 }
 
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 #[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
 #[cfg_attr(feature = "wasm", derive(Tsify), tsify(into_wasm_abi, from_wasm_abi))]