1 unstable release

0.5.0 Apr 25, 2024

#1951 in Cryptography

Download history 128/week @ 2024-04-22 39/week @ 2024-04-29 44/week @ 2024-05-06 42/week @ 2024-05-13 76/week @ 2024-05-20 48/week @ 2024-05-27 63/week @ 2024-06-03 76/week @ 2024-06-10

268 downloads per month
Used in 4 crates (3 directly)

Custom license

230KB
10K SLoC

Bitwarden Crypto

This is an internal crate for the Bitwarden SDK do not depend on this directly and use the bitwarden crate instead.

This crate does not follow semantic versioning and the public interface may change at any time.


lib.rs:

Bitwarden Cryptographic primitives

This crate contains the cryptographic primitives used throughout the SDK. The general aspiration is for this crate to handle all the difficult cryptographic operations and expose higher level concepts to the rest of the SDK.

Generally you should not find yourself needing to edit this crate! Everything written here requires additional care and attention to ensure that the cryptographic primitives are secure.

Example:

use bitwarden_crypto::{SymmetricCryptoKey, KeyEncryptable, KeyDecryptable, CryptoError};

async fn example() -> Result<(), CryptoError> {
  let key = SymmetricCryptoKey::generate(rand::thread_rng());

  let data = "Hello, World!".to_owned();
  let encrypted = data.clone().encrypt_with_key(&key)?;
  let decrypted: String = encrypted.decrypt_with_key(&key)?;

  assert_eq!(data, decrypted);
  Ok(())
}

Development considerations

This crate is expected to provide long term support for cryptographic operations. To that end, the following considerations should be taken into account when making changes to this crate:

  • Limit public interfaces to the bare minimum.
  • Breaking changes should be rare and well communicated.
  • Serializable representation of keys and encrypted data must be supported indefinitely as we have no way to update all data.

Conventions:

  • Pure Functions that deterministically "derive" keys from input are prefixed with derive_.
  • Functions that generate non deterministically keys are prefixed with make_.

Differences from clients

There are some noteworthy differences compared to the other Bitwarden clients. These changes are made in an effort to introduce conventions in how we name things, improve best practices and abstracting away internal complexity.

  • CryptoService.makeSendKey & AccessService.createAccessToken are replaced by the generic derive_shareable_key
  • MasterKey operations such as makeMasterKey and hashMasterKey are moved to the MasterKey struct.

Dependencies

~6.5–8.5MB
~174K SLoC