Module core_crypto::prelude
source · Expand description
Common imports that should be useful for most uses of the crate
Re-exports§
pub use crate::e2e_identity::error::E2eIdentityError;
pub use crate::e2e_identity::error::E2eIdentityResult;
pub use crate::e2e_identity::types::E2eiAcmeChallenge;
pub use crate::e2e_identity::types::E2eiAcmeDirectory;
pub use crate::e2e_identity::types::E2eiNewAcmeAuthz;
pub use crate::e2e_identity::types::E2eiNewAcmeOrder;
pub use crate::e2e_identity::E2eiEnrollment;
pub use crate::mls::conversation::decrypt;
pub use crate::mls::conversation::decrypt::MlsBufferedConversationDecryptMessage;
pub use crate::mls::conversation::decrypt::MlsConversationDecryptMessage;
pub use crate::mls::conversation::ConversationId;
pub use crate::mls::conversation::MlsConversation;
pub use crate::mls::MlsCentral;
pub use crate::CoreCrypto;
pub use crate::CoreCryptoCallbacks;
Structs§
- Represents a x509 certificate chain supplied by the client It can fetch it after an end-to-end identity process where it can get back a certificate from the Authentication Service
- Represents a MLS client which in our case is the equivalent of a device.
- A Client identifier
- Credential.
- Wrapped 32-byte entropy seed with bounds check
- Group epoch. Internally this is stored as a
u64
. The group epoch is incremented with every valid Commit that is merged into the group state. - The key package struct.
- The key package struct.
- Configuration parameters for
MlsCentral
- A wrapper for the OpenMLS Ciphersuite, so that we are able to provide a default value.
- Returned when a commit is created
- The configuration parameters for a group/conversation
- Returned when initializing a conversation through a commit. Different from conversation created from a [
openmls::prelude::Welcome
] message or an external commit. - Returned when a commit is created
- The configuration parameters for a group/conversation which are not handled natively by openmls
- A
MlsGroup
represents an MLS group with a high-level API. The API exposes high level functions to manage a group by adding/removing members, get the current member list, etc. - Specifies the configuration parameters for a
MlsGroup
. Refer to the User Manual for more information about the different configuration values. - A [GroupInfo] with metadata
- Before use with the
MlsGroup
API, the message has to be unpacked viaextract
to yield its [MlsMessageInBody
]. - Returned when a Proposal is created. Helps roll backing a local proposal
- Abstraction over a [openmls::prelude::hash_ref::ProposalRef] to deal with conversions
- Result returned after rotating the Credential of the current client in all the local conversations
- A type that represents a group info of which the signature has not been verified. It implements the [
Verifiable
] trait and can be turned into a group info by callingverify(...)
with the signature key of theCredential
. When receiving a serialized group info, it can only be deserialized into aVerifiableGroupInfo
, which can then be turned into a group info as described above. - Contains everything client needs to know after decrypting an (encrypted) Welcome message
- Represents the identity claims identifying a client Those claims are verifiable by any member in the group
- Represents the parts of WireIdentity that are specific to a X509 certificate (and not a Basic one).
Enums§
- MLS ciphersuites.
- Used by consumers to initializes a MLS client. Encompasses all the client types available. Could be enriched later with Verifiable Presentations.
- CoreCrypto errors
- Wrapper for errors that can happen during a Cryptobox migration
- Indicates the standalone status of a device Credential in a MLS group at a moment T. This does not represent the states where a device is not using MLS or is not using end-to-end identity
- Indicates the state of a Conversation regarding end-to-end identity.
- Represents the byte array in MlsGroupInfoBundle
- Lists all the supported Credential types. Could list in the future some types not supported by openmls such as Verifiable Presentation
- MLS-specific error wrapper - see github.com/openmls/openmls for details
- GroupInfoEncryptionType
- Internal representation of proposal to ease further additions
- RatchetTreeType
- Wrapper over WireFormatPolicy
- Container enum for leaf and parent nodes.
- Wrapper for Proteus-related errors
Constants§
- Default number of KeyPackages a client generates the first time it’s created
Type Aliases§
- A simpler definition for Result types that the Error is a CryptoError
- A reference to a key package. This value uniquely identifies a key package.
- 32-byte raw entropy seed