Module key_management

This module contains the definition for the key identifiers used by the rest of the crates. Any code that needs to interact with the [KeyStore] should use these types.

• SymmetricKeyId is used to identify symmetric keys.
• AsymmetricKeyId is used to identify asymmetric keys.
• KeyIds is a helper type that combines both symmetric and asymmetric key identifiers. This is usually used in the type bounds of [KeyStore], KeyStoreContext, PrimitiveEncryptable, CompositeEncryptable, and Decryptable.

Modules

account_cryptographic_state

User account cryptographic state

crypto

Mobile specific crypto operations

crypto_client 🔒

master_password 🔒

security_state 🔒

Security state is a signed object that attests to a user’s (or later an organization’s) security state. The security goal is to prevent downgrades of specific features within the user’s account by the server / a networked attacker with TLS introspection access.

user_decryption 🔒

Structs

CryptoClient

A client for the crypto operations.

KeyIds

SecurityState

The security state is a signed object attesting to the security state of a user.

SignedSecurityState

A signed and serialized SecurityState object.

UserDecryptionData

Represents data required to decrypt user’s vault. Currently, this is only used for master password unlock.

Enums

AsymmetricKeyId

MasterPasswordError

Error for master password related operations.

SigningKeyId

SymmetricKeyId

Constants

MINIMUM_ENFORCE_ICON_URI_HASH_VERSION

Icon URI hashes are enforced starting with this security state version.

Functions

create_test_crypto_with_user_and_org_key

This is a helper function to create a test KeyStore with a single user key and an organization key using the provided organization uuid. While this function is not marked as #[cfg(test)], it should only be used for testing purposes. It’s only public so that other crates can make use of it in their own tests.

create_test_crypto_with_user_key

This is a helper function to create a test KeyStore with a single user key. While this function is not marked as #[cfg(test)], it should only be used for testing purposes. It’s only public so that other crates can make use of it in their own tests.