[PM-25818] Migrate Basic Cipher Create, Edit, and Get Operations to SDK #455

gbubemismith · 2025-09-15T14:34:44Z

🎟️ Tracking

https://bitwarden.atlassian.net/browse/PM-25818

📔 Objective

⏰ Reminders before review

Contributor guidelines followed
All formatters and local linters executed and passed
Written new unit and / or integration tests where applicable
Protected functional changes with optionality (feature flags)
Used internationalization (i18n) for all UI strings
CI builds passed
Communicated to DevOps any deployment requirements
Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
team

🦮 Reviewer guidelines

👍 (:+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

github-actions · 2025-09-15T14:40:05Z

Checkmarx One – Scan Summary & Details – 9499221c-d540-46b8-aba6-53d452380fd8

Great job! No new security vulnerabilities introduced in this pull request

nick-livefront

Just a handful of questions from me. I'm following this and the implementation but I would say that my rust experience is a little lack luster on if there are improvements to be made on that thread. I will hold off on approving to hopefully solicit some more impactful feedback, but I can if I'm the gateway between moving this forward.

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

nick-livefront · 2025-09-15T19:35:21Z

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

+            organization_use_totp: cipher.organization_use_totp.unwrap_or(true),
+            edit: cipher.edit.unwrap_or(true),


❓ Probably an edge case, the current CipherView defaults these values to false rather than true. Should this logic follow suit or is the deviation intentional?

nick-livefront · 2025-09-15T19:37:06Z

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

+        list_ciphers(key_store, repository.as_ref()).await
+    }
+
+    /// Get [Cipher] by ID from state and decrypt it to a [CipherView].


I did not know you could link to other entities in a comment with [...], TIL!

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

## 🎟️ Tracking  ## 📔 Objective These crates had some missing features, which caused compilation errors when trying to run the tests from VSCode. The reason that CI kept building was that rust unifies all the workspace features, so as long as one crate has them enabled it's fine. On the other hand, when running a test from VSCode, it will only have that crates features in mind. Note that the uniffi feature of core requires internal because of these two types: https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-core/src/uniffi_support.rs#L30-L42 ## ⏰ Reminders before review - Contributor guidelines followed - All formatters and local linters executed and passed - Written new unit and / or integration tests where applicable - Protected functional changes with optionality (feature flags) - Used internationalization (i18n) for all UI strings - CI builds passed - Communicated to DevOps any deployment requirements - Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team ## 🦮 Reviewer guidelines  - 👍 (`:+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

Scaffolds a new workflow for updating API bindings.

Updated SDK to use an `archivedDate` in the ciphers.

This adds two custom dylint lint. - `error_suffix`: Requires all types that implements `Error` ends with an `Error` suffix. - `error_enum`: Forbids ending enum error variants with `Error`.

Wraps up the b64 migration.

We removed the ability to throw `VaultLocked` a while back. This removes the actual error struct and any place it's used in.

nikwithak · 2025-09-15T21:48:32Z

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

+    repository: &dyn Repository<Cipher>,
+) -> Result<Vec<CipherView>, GetCipherError> {
+    let ciphers = repository.list().await?;
+    let views = store.decrypt_list(&ciphers)?;


Would it be better to use decrypt_list_failures here to avoid blocking when only some of them fail to decrypt?

Thanks for adding list_ciphers_with_failures! Do you think we still need the list_ciphers for any use cases, or could we remove it altogether?

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

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

codecov · 2025-09-16T19:18:21Z

Codecov Report

❌ Patch coverage is 76.34855% with 285 lines in your changes missing coverage. Please review.
✅ Project coverage is 78.48%. Comparing base (d7ce769) to head (2b57bcf).
⚠️ Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
...bitwarden-vault/src/cipher/cipher_client/create.rs	85.00%	45 Missing ⚠️
...tes/bitwarden-vault/src/cipher/cipher_view_type.rs	51.68%	43 Missing ⚠️
...s/bitwarden-vault/src/cipher/cipher_client/edit.rs	92.63%	41 Missing ⚠️
crates/bitwarden-vault/src/cipher/login.rs	47.05%	36 Missing ⚠️
...es/bitwarden-vault/src/cipher/cipher_client/get.rs	0.00%	33 Missing ⚠️
crates/bitwarden-vault/src/cipher/identity.rs	0.00%	22 Missing ⚠️
crates/bitwarden-vault/src/cipher/field.rs	0.00%	15 Missing ⚠️
crates/bitwarden-vault/src/cipher/card.rs	0.00%	10 Missing ⚠️
crates/bitwarden-vault/src/cipher/cipher.rs	84.12%	10 Missing ⚠️
crates/bitwarden-vault/src/cipher/secure_note.rs	0.00%	10 Missing ⚠️
... and 3 more

Additional details and impacted files

@@            Coverage Diff            @@
##             main     #455     +/-   ##
=========================================
  Coverage   78.48%   78.48%             
=========================================
  Files         276      280      +4     
  Lines       27435    28631   +1196     
=========================================
+ Hits        21531    22472    +941     
- Misses       5904     6159    +255

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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

… vault/migrate-ciphers

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

Hinton

Overall good, there are a couple of things we should consider.

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

Hinton · 2025-09-26T10:11:08Z

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

+        ctx: &mut KeyStoreContext<KeyIds>,
+        key: SymmetricKeyId,
+    ) -> Result<(), CryptoError> {
+        let old_key = Cipher::decrypt_cipher_key(ctx, key, &self.key)?;


question: Since we're creating a cipher key will never exist right?

It shouldn't, in which case decrypt_cipher_key will return the existing key. I included this just in case we do get a CipherCreateRequest that already has a key, which would imply the Fido2 credentials were already encrypted with that key. Happy to remove if we're making the assumption that won't happen.

Hinton · 2025-09-26T10:15:25Z

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

+        self.type_data
+            .as_login_view_mut()
+            .map(|l| l.reencrypt_fido2_credentials(ctx, old_key, new_key))
+            .transpose()?;


thought: This raises a good question, how would we create a new cipher with a passkey? They are intentionally encrypted but would that even be viable generally?

I think temporarily we can pass in already encrypted data in the web clients, but this might not work on mobile. Long term having a different flow for creating items with passkeys might be required? CC @coroiu since you have more insight into our sdk passkey flows.

On clients we don't create ciphers with passkeys. The cipher is created first by the popout, which returns the new cipherId to background which then reads out the cipher and attaches a new passkey to it. It's a bad way of doing it but I think it saves us from having to worry about creation with passkeys in this PR.

mobile on the other hand does create ciphers with passkeys but creation and encryption is encapsulated in the SDK and could use the Repository<Cipher> instead of going through the CipherClient

I think with the new APIs you would need to create the cipher first before adding passkeys. We'll see what troubles appears when we start migrating mobile to use it.

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

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

Hinton · 2025-09-26T10:57:32Z

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

+impl TryFrom<CipherView> for CipherEditRequest {
+    type Error = MissingFieldError;
+
+    fn try_from(value: CipherView) -> Result<Self, Self::Error> {
+        let type_data = match value.r#type {
+            CipherType::Login => value.login.map(CipherViewType::Login),
+            CipherType::SecureNote => value.secure_note.map(CipherViewType::SecureNote),
+            CipherType::Card => value.card.map(CipherViewType::Card),
+            CipherType::Identity => value.identity.map(CipherViewType::Identity),
+            CipherType::SshKey => value.ssh_key.map(CipherViewType::SshKey),
+        };
+        Ok(Self {
+            id: value.id.ok_or(MissingFieldError("id"))?,
+            r#type: value.r#type,
+            organization_id: value.organization_id,
+            folder_id: value.folder_id,
+            favorite: value.favorite,
+            reprompt: value.reprompt,
+            key: value.key,
+            name: value.name,
+            notes: value.notes,
+            fields: value.fields.unwrap_or_default(),
+            password_history: value.password_history,
+            attachments: value.attachments,
+            type_data,
+            revision_date: value.revision_date,
+            archived_date: value.archived_date,
+        })
+    }
+}


question: It seems a bit weird going from CipherView to CipherEditRequest?

The intent here was that a client will have a CipherView locally, make changes to it, and then go to save those changes by converting it into an Edit request.

Something along the lines of:

// Start with a decrypted cipher let cipher_view: CipherView = ciphers_client.decrypt(cipher)?; // Make some local changes to the CipherView cipher_view.name = "New Cipher Name"; cipher_view.login = Some(LoginView { username: Some("new_login".to_string()), password: Some("password".to_string()), ..Default::default(), }); // Send the changes upstream ciphers_client.edit(cipher_view.into());

Hmm, that does seem like a nicer rust interface although I'd caution against modifying a CipherView ever, and you should probably convert to a CipherEditRequest before modifying it. The conversion to CipherEditRequest is lossly and might not save passkeys for example.

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

… vault/migrate-ciphers

Co-authored-by: Oscar Hinton <Hinton@users.noreply.github.com>

sonarqubecloud · 2025-09-29T17:19:40Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
3.3% Duplication on New Code

See analysis details on SonarQube Cloud

Hinton

This is mostly looking great. There are some last comments, and some previous comments that were missed.

Hinton · 2025-09-30T10:20:27Z

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

+    /// Get all ciphers from state and decrypt them, returning both successes and failures.
+    /// This method will not fail when some ciphers fail to decrypt, allowing for graceful
+    /// handling of corrupted or problematic cipher data.
+    pub async fn list_with_failures(&self) -> Result<DecryptCipherListResult, GetCipherError> {


suggestion (non blocking): I think we can just call this list?

Hinton · 2025-09-30T11:16:20Z

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

+impl TryFrom<CipherView> for CipherEditRequest {
+    type Error = MissingFieldError;
+
+    fn try_from(value: CipherView) -> Result<Self, Self::Error> {
+        let type_data = match value.r#type {
+            CipherType::Login => value.login.map(CipherViewType::Login),
+            CipherType::SecureNote => value.secure_note.map(CipherViewType::SecureNote),
+            CipherType::Card => value.card.map(CipherViewType::Card),
+            CipherType::Identity => value.identity.map(CipherViewType::Identity),
+            CipherType::SshKey => value.ssh_key.map(CipherViewType::SshKey),
+        };
+        Ok(Self {
+            id: value.id.ok_or(MissingFieldError("id"))?,
+            r#type: value.r#type,
+            organization_id: value.organization_id,
+            folder_id: value.folder_id,
+            favorite: value.favorite,
+            reprompt: value.reprompt,
+            key: value.key,
+            name: value.name,
+            notes: value.notes,
+            fields: value.fields.unwrap_or_default(),
+            password_history: value.password_history,
+            attachments: value.attachments,
+            type_data,
+            revision_date: value.revision_date,
+            archived_date: value.archived_date,
+        })
+    }
+}


Hmm, that does seem like a nicer rust interface although I'd caution against modifying a CipherView ever, and you should probably convert to a CipherEditRequest before modifying it. The conversion to CipherEditRequest is lossly and might not save passkeys for example.

Hinton · 2025-09-30T11:18:19Z

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

+        self.type_data
+            .as_login_view_mut()
+            .map(|l| l.reencrypt_fido2_credentials(ctx, old_key, new_key))
+            .transpose()?;


I think with the new APIs you would need to create the cipher first before adding passkeys. We'll see what troubles appears when we start migrating mobile to use it.

Hinton · 2025-09-30T12:40:58Z

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

+    pub notes: Option<String>,
+    pub favorite: bool,
+    pub reprompt: CipherRepromptType,
+    pub type_data: Option<CipherViewType>,


question: Is this actually optional? I don't think you can create ciphers without a type.

Suggested change

pub type_data: Option<CipherViewType>,

pub type_data: CipherViewType,

Hinton · 2025-09-30T17:24:23Z

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

+    pub notes: Option<String>,
+    pub favorite: bool,
+    pub reprompt: CipherRepromptType,
+    pub type_data: Option<CipherViewType>,


question (non blocking): Should we rename this to type?

Hinton · 2025-09-30T17:25:06Z

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

+    pub name: String,
+    pub notes: Option<String>,
+    pub fields: Vec<FieldView>,
+    pub password_history: Option<Vec<PasswordHistoryView>>,


question: I think we can drop this field? It should be calculated by the SDK.

Agreed! We should be able to remove it at let it be calculated internally.

Hinton · 2025-09-30T17:25:36Z

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

+    pub notes: Option<String>,
+    pub fields: Vec<FieldView>,
+    pub password_history: Option<Vec<PasswordHistoryView>>,
+    pub attachments: Option<Vec<AttachmentView>>,


I want to say we should drop this as well and refer people to dedicated functions but maybe we want to keep it around for now until we have those APIs?

We should be able to remove it now and avoid the possibility of mistakenly trying to update attachments directly. At least for the TS clients, attachment creation/management is through its own methods that can be migrated to the SDK at a later time.

shane-melton

Changes really good from my perspective, nice work on this! I wanted to echo/agree with a few of Oscar's comments that I think we should address before merge.

shane-melton · 2025-09-30T22:40:12Z

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

👍 Thanks for moving the uri checksum generation and fido2 re-encryption logic to Login!

shane-melton · 2025-09-30T22:41:37Z

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

👍 Very nice!

shane-melton · 2025-09-30T22:50:25Z

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

+    pub name: String,
+    pub notes: Option<String>,
+    pub fields: Vec<FieldView>,
+    pub password_history: Option<Vec<PasswordHistoryView>>,


Agreed! We should be able to remove it at let it be calculated internally.

shane-melton · 2025-09-30T22:57:23Z

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

+    pub notes: Option<String>,
+    pub fields: Vec<FieldView>,
+    pub password_history: Option<Vec<PasswordHistoryView>>,
+    pub attachments: Option<Vec<AttachmentView>>,


We should be able to remove it now and avoid the possibility of mistakenly trying to update attachments directly. At least for the TS clients, attachment creation/management is through its own methods that can be migrated to the SDK at a later time.

gbubemismith added 3 commits September 15, 2025 09:39

Added conversions for ciphers

d5fb7b2

Added create, edit and get

8144b98

Exposed through cipher client

0734d40

gbubemismith requested review from a team as code owners September 15, 2025 14:34

gbubemismith requested review from Jingo88, addisonbeck, shane-melton, nick-livefront and coroiu and removed request for addisonbeck September 15, 2025 14:34

nick-livefront reviewed Sep 15, 2025

View reviewed changes

gbubemismith marked this pull request as draft September 15, 2025 19:47

dani-garcia and others added 9 commits September 15, 2025 16:45

Scaffold workflow for generating api bindings (#441)

0535582

Scaffolds a new workflow for updating API bindings.

[PM-23193] Add ArchivedDate (#422)

d008260

Updated SDK to use an `archivedDate` in the ciphers.

Add dylint lints for errors (#430)

d204e42

This adds two custom dylint lint. - `error_suffix`: Requires all types that implements `Error` ends with an `Error` suffix. - `error_enum`: Forbids ending enum error variants with `Error`.

Migrate more b64 (#411)

9a8d482

Wraps up the b64 migration.

Remove unused vault locked error (#440)

778c3ac

We removed the ability to throw `VaultLocked` a while back. This removes the actual error struct and any place it's used in.

Set default values

09af3cb

Added todo's

298b336

nikwithak reviewed Sep 15, 2025

View reviewed changes

gbubemismith added 3 commits September 16, 2025 12:23

Added archived date to request and response

841f40a

Fixed merge conflicts

17cecd8

Removed error

9d27d7f

gbubemismith added 2 commits September 16, 2025 16:47

Added list with failures

d219627

fixed lint issues

c1fcadc

Handle cipher-key encryption for Create/Edit requests

f8dfeea

nikwithak reviewed Sep 26, 2025

View reviewed changes

crates/bitwarden-vault/src/cipher/cipher_view_type.rs Show resolved Hide resolved

Merge branch 'main' of https://github.com/bitwarden/sdk-internal into…

bd539ac

… vault/migrate-ciphers

Hinton reviewed Sep 26, 2025

View reviewed changes

crates/bitwarden-vault/src/cipher/cipher_client/create.rs Outdated Show resolved Hide resolved

Hinton reviewed Sep 26, 2025

View reviewed changes

nikwithak self-assigned this Sep 26, 2025

nikwithak and others added 15 commits September 26, 2025 13:06

Add missing field to cipher requests

b3bbda7

Export CipherViewType and fix TS export errors

8c331aa

Merge branch 'main' of https://github.com/bitwarden/sdk-internal into…

1ea2211

… vault/migrate-ciphers

Consume new ApiClient approach from main

cc78556

Remove outdated comment from cipher_client/create.rs

532a6ba

Co-authored-by: Oscar Hinton <Hinton@users.noreply.github.com>

Remove pub from CipherCreateRequest::generate_cipher_key

7f4033c

Co-authored-by: Oscar Hinton <Hinton@users.noreply.github.com>

Address PR feedback

69bbc99

Use slice instead of \&Vec<_> in detect_hidden_field_changes

d06a363

Remove Default from CipherType

a331fc6

Generate login checksums before encrypting

f931e47

Remove list operations in favor of list_with_failures

4a0c45c

Add docstring for get_cipher_type

1cf6514

Fix clippy errors.

86b0b56

Bugfix: Store cipher key when encrypting CipherCreateRequest

69978d0

Remove unnecessary comments

ef2f7ca

nikwithak requested review from shane-melton and Hinton September 27, 2025 00:39

coroiu previously approved these changes Sep 29, 2025

View reviewed changes

Remove unused import in create_cipher tests

2b57bcf

nikwithak dismissed coroiu’s stale review via 2b57bcf September 29, 2025 17:13

shane-melton mentioned this pull request Sep 29, 2025

[PM-25682] Migrate CipherView and subviews to be TS strict compliant bitwarden/clients#16463

Open

Hinton reviewed Sep 30, 2025

View reviewed changes

shane-melton reviewed Sep 30, 2025

View reviewed changes

		organization_use_totp: cipher.organization_use_totp.unwrap_or(true),
		edit: cipher.edit.unwrap_or(true),

	pub type_data: Option<CipherViewType>,
	pub type_data: CipherViewType,

[PM-25818] Migrate Basic Cipher Create, Edit, and Get Operations to SDK #455

Are you sure you want to change the base?

[PM-25818] Migrate Basic Cipher Create, Edit, and Get Operations to SDK #455

Uh oh!

Conversation

gbubemismith commented Sep 15, 2025

🎟️ Tracking

📔 Objective

⏰ Reminders before review

🦮 Reviewer guidelines

Uh oh!

github-actions bot commented Sep 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Great job! No new security vulnerabilities introduced in this pull request

Uh oh!

nick-livefront left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Hinton left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Sep 29, 2025

Quality Gate passed

Uh oh!

Hinton left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Hinton Sep 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

github-actions bot commented Sep 15, 2025 •

edited

Loading

codecov bot commented Sep 16, 2025 •

edited

Loading

Hinton left a comment •

edited

Loading

Hinton Sep 30, 2025 •

edited

Loading