[PM-5691] Extract crypto to separate crate #402

Hinton · 2023-12-05T20:22:35Z

Type of change

- [ ] Bug fix
- [ ] New feature development
- [x] Tech debt (refactoring, code cleanup, dependency upgrades, etc)
- [ ] Build/deploy pipeline (DevOps)
- [ ] Other

Objective

We should make an effort to break up the large bitwarden crate into smaller more isolated crates. This extracts the cryptographic primitives into a crate, which better isolates them and may improve compile time slightly. We should continue to extract further areas.

Code changes

crates/bitwarden/src/crypto: Move everything to crates/bitwarden-crypto.

Screenshots

Before you submit

Please add unit tests where it makes sense to do so (encouraged but not required)

bitwarden-bot · 2023-12-06T01:21:51Z

Checkmarx One – Scan Summary & Details – 4bca6312-994f-4f30-ac86-77879465b0e1

No New Or Fixed Issues Found

# Conflicts: # crates/bitwarden-crypto/src/enc_string.rs # crates/bitwarden-crypto/src/rsa.rs # crates/bitwarden/Cargo.toml # crates/bitwarden/src/auth/login/access_token.rs # crates/bitwarden/src/auth/login/api_key.rs # crates/bitwarden/src/auth/login/password.rs # crates/bitwarden/src/client/client.rs # crates/bitwarden/src/client/encryption_settings.rs # crates/bitwarden/src/crypto/enc_string.rs # crates/bitwarden/src/crypto/enc_string/symmetric.rs # crates/bitwarden/src/crypto/mod.rs # crates/bitwarden/src/mobile/crypto.rs # crates/bitwarden/src/tool/generators/client_generator.rs # crates/bitwarden/src/tool/generators/passphrase.rs # crates/bitwarden/src/uniffi_support.rs # crates/bitwarden/src/vault/cipher/attachment.rs # crates/bitwarden/src/vault/cipher/card.rs # crates/bitwarden/src/vault/cipher/cipher.rs # crates/bitwarden/src/vault/cipher/field.rs # crates/bitwarden/src/vault/cipher/identity.rs # crates/bitwarden/src/vault/cipher/login.rs # crates/bitwarden/src/vault/cipher/secure_note.rs # crates/bitwarden/src/vault/collection.rs # crates/bitwarden/src/vault/folder.rs # crates/bitwarden/src/vault/password_history.rs # crates/bitwarden/src/vault/send.rs

codecov · 2024-01-04T17:36:25Z

Codecov Report

Attention: 101 lines in your changes are missing coverage. Please review.

Comparison is base (4c91270) 50.04% compared to head (f9dca85) 50.15%.
Report is 6 commits behind head on main.

❗ Current head f9dca85 differs from pull request most recent head cf2a3b6. Consider uploading reports for the commit cf2a3b6 to get more accurate results

Files	Patch %	Lines
crates/bitwarden/src/auth/login/mod.rs	0.00%	24 Missing ⚠️
crates/bitwarden-crypto/src/uniffi_support.rs	0.00%	14 Missing ⚠️
crates/bitwarden-crypto/src/encryptable.rs	38.46%	8 Missing ⚠️
crates/bitwarden/src/vault/cipher/cipher.rs	0.00%	7 Missing ⚠️
crates/bitwarden/src/vault/password_history.rs	0.00%	5 Missing ⚠️
crates/bitwarden/src/vault/cipher/login.rs	0.00%	4 Missing ⚠️
crates/bitwarden/src/vault/send.rs	63.63%	4 Missing ⚠️
crates/bitwarden-crypto/src/error.rs	0.00%	3 Missing ⚠️
...rates/bitwarden-crypto/src/enc_string/symmetric.rs	75.00%	2 Missing ⚠️
crates/bitwarden-crypto/src/fingerprint.rs	66.66%	2 Missing ⚠️
... and 16 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #402      +/-   ##
==========================================
+ Coverage   50.04%   50.15%   +0.10%     
==========================================
  Files         155      157       +2     
  Lines        7467     7493      +26     
==========================================
+ Hits         3737     3758      +21     
- Misses       3730     3735       +5

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

# Conflicts: # crates/bitwarden/src/platform/generate_fingerprint.rs

# Conflicts: # crates/bitwarden/src/error.rs # crates/bitwarden/src/vault/send.rs

# Conflicts: # crates/bitwarden-crypto/src/keys/symmetric_crypto_key.rs # crates/bitwarden/src/crypto/mod.rs # crates/bitwarden/src/vault/send.rs

# Conflicts: # crates/bitwarden/src/auth/password.rs

# Conflicts: # crates/bitwarden-crypto/src/enc_string/asymmetric.rs # crates/bitwarden-crypto/src/enc_string/symmetric.rs # crates/bitwarden-crypto/src/keys/master_key.rs # crates/bitwarden-crypto/src/keys/symmetric_crypto_key.rs # crates/bitwarden-crypto/src/rsa.rs # crates/bitwarden/src/auth/login/access_token.rs # crates/bitwarden/src/client/access_token.rs # crates/bitwarden/src/platform/generate_fingerprint.rs

# Conflicts: # crates/bitwarden-crypto/src/enc_string/symmetric.rs # crates/bitwarden-crypto/src/keys/master_key.rs # crates/bitwarden-crypto/src/keys/symmetric_crypto_key.rs # crates/bitwarden/src/crypto/mod.rs

# Conflicts: # crates/bitwarden-crypto/src/keys/master_key.rs # crates/bitwarden/src/crypto/mod.rs

# Conflicts: # crates/bitwarden-crypto/src/asymmetric_crypto_key.rs # crates/bitwarden-crypto/src/enc_string/asymmetric.rs # crates/bitwarden-crypto/src/encryptable.rs # crates/bitwarden-crypto/src/keys/key_encryptable.rs # crates/bitwarden-crypto/src/keys/symmetric_crypto_key.rs # crates/bitwarden/src/client/encryption_settings.rs # crates/bitwarden/src/crypto/mod.rs # crates/bitwarden/src/vault/cipher/attachment.rs # crates/bitwarden/src/vault/cipher/card.rs # crates/bitwarden/src/vault/cipher/cipher.rs # crates/bitwarden/src/vault/cipher/field.rs # crates/bitwarden/src/vault/cipher/identity.rs # crates/bitwarden/src/vault/cipher/local_data.rs # crates/bitwarden/src/vault/cipher/login.rs # crates/bitwarden/src/vault/cipher/secure_note.rs # crates/bitwarden/src/vault/collection.rs # crates/bitwarden/src/vault/folder.rs # crates/bitwarden/src/vault/password_history.rs # crates/bitwarden/src/vault/send.rs

michalchecinski

There's a need to add bitwarden-crypto here: https://github.com/bitwarden/sdk/blob/1028efde6557e30d241c03fd4754d32fe38db17a/.github/workflows/version-bump.yml#L18

And also to publish workflow: https://github.com/bitwarden/sdk/blob/main/.github/workflows/publish-rust-crates.yml

Continuation on #402. This PR extracts the generators to their own crate to establish clear boundaries between the code. There is still some logic in the client to expose generators that we may want to revisit. Also extracts explicit errors for the different generators for better error handling downstream when/if desired.

Experiment with using a separate crate for crypto

3c55a87

Hinton and others added 4 commits December 7, 2023 11:09

Move more code to bitwarden-crypto

b454601

Move remaining files, improve docs

7e0b392

Merge branch 'main' into ps/crypto-crate

b96f219

Hinton changed the title ~~Experiment with using a separate crate for crypto~~ Extract crypto to separate crate Jan 4, 2024

Hinton added 2 commits January 4, 2024 18:32

Fix build error

0af379f

Fix naming

3c4e603

Hinton added 2 commits January 4, 2024 18:43

Fix clippy

9d7126b

Improve comments

05a761d

Hinton marked this pull request as ready for review January 8, 2024 09:20

Hinton added 13 commits January 8, 2024 11:03

Merge branch 'main' of github.com:bitwarden/sdk into ps/crypto-crate

0e96011

# Conflicts: # crates/bitwarden/src/platform/generate_fingerprint.rs

Fix ambigous

9e446cf

Fix android

c1e7f6f

Use mobile feature for crypto

1c571f4

Move uniffi AsymmEncString to bitwarden crate

c26c888

Merge branch 'main' of github.com:bitwarden/sdk into ps/crypto-crate

30c4489

# Conflicts: # crates/bitwarden/src/error.rs # crates/bitwarden/src/vault/send.rs

Fix ios

7e3f8a2

Fix test

075f175

Merge branch 'main' of github.com:bitwarden/sdk into ps/crypto-crate

63e922e

# Conflicts: # crates/bitwarden-crypto/src/keys/symmetric_crypto_key.rs # crates/bitwarden/src/crypto/mod.rs # crates/bitwarden/src/vault/send.rs

Merge branch 'main' of github.com:bitwarden/sdk into ps/crypto-crate

2e8fba1

# Conflicts: # crates/bitwarden/src/auth/password.rs

Fix clippy

490abc6

Merge branch 'main' of github.com:bitwarden/sdk into ps/crypto-crate

bff92d5

# Conflicts: # crates/bitwarden-crypto/src/enc_string/symmetric.rs # crates/bitwarden-crypto/src/keys/master_key.rs # crates/bitwarden-crypto/src/keys/symmetric_crypto_key.rs # crates/bitwarden/src/crypto/mod.rs

Hinton requested a review from a team as a code owner January 11, 2024 12:34

Hinton requested review from dani-garcia and MGibson1 January 11, 2024 12:34

fmt

e5584fd

Hinton added 7 commits January 11, 2024 16:01

Remove unused dependencies

d319867

Remove bitwarden::Kdf

0ae213a

Minor import tweaks

4d686dd

Remove unnecessary into

4bf7bb2

Remove InvalidLen

d9481b3

Merge branch 'main' of github.com:bitwarden/sdk into ps/crypto-crate

5cc63b0

# Conflicts: # crates/bitwarden-crypto/src/keys/master_key.rs # crates/bitwarden/src/crypto/mod.rs

Resolve linting errors

6116292

Hinton requested a review from dani-garcia January 11, 2024 15:43

dani-garcia previously approved these changes Jan 11, 2024

View reviewed changes

Hinton changed the title ~~Extract crypto to separate crate~~ [PM-5691] Extract crypto to separate crate Jan 12, 2024

Hinton dismissed dani-garcia’s stale review via de160d9 January 12, 2024 17:15

Hinton added 4 commits January 12, 2024 18:17

fmt and clippy

dd70d0a

Fix doc

6bf18e1

Remove test feature in crypto

f9d83e0

Fix tests

f9dca85

Hinton requested a review from dani-garcia January 15, 2024 10:25

Remove crypto/mod.rs, remove rsa from bitwarden crate

fb300ba

dani-garcia previously approved these changes Jan 15, 2024

View reviewed changes

michalchecinski requested changes Jan 15, 2024

View reviewed changes

Update bump and publish workflows

cf2a3b6

Hinton dismissed dani-garcia’s stale review via cf2a3b6 January 15, 2024 14:44

Hinton requested a review from michalchecinski January 15, 2024 14:44

michalchecinski approved these changes Jan 15, 2024

View reviewed changes

Hinton requested a review from dani-garcia January 15, 2024 14:59

dani-garcia approved these changes Jan 15, 2024

View reviewed changes

Hinton merged commit d2cb4f9 into main Jan 15, 2024
43 checks passed

Hinton deleted the ps/crypto-crate branch January 15, 2024 15:13

Hinton mentioned this pull request Jan 16, 2024

[PM-5692] Extract generators to separate crate #511

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[PM-5691] Extract crypto to separate crate #402

[PM-5691] Extract crypto to separate crate #402

Hinton commented Dec 5, 2023 •

edited

Loading

bitwarden-bot commented Dec 6, 2023 •

edited

Loading

codecov bot commented Jan 4, 2024 •

edited

Loading

michalchecinski left a comment

[PM-5691] Extract crypto to separate crate #402

[PM-5691] Extract crypto to separate crate #402

Conversation

Hinton commented Dec 5, 2023 • edited Loading

Type of change

Objective

Code changes

Screenshots

Before you submit

bitwarden-bot commented Dec 6, 2023 • edited Loading

No New Or Fixed Issues Found

codecov bot commented Jan 4, 2024 • edited Loading

Codecov Report

michalchecinski left a comment

Choose a reason for hiding this comment

Hinton commented Dec 5, 2023 •

edited

Loading

bitwarden-bot commented Dec 6, 2023 •

edited

Loading

codecov bot commented Jan 4, 2024 •

edited

Loading