libsignal_protocol/
lib.rs

1//
2// Copyright 2020-2021 Signal Messenger, LLC.
3// SPDX-License-Identifier: AGPL-3.0-only
4//
5
6//! Rust implementation of the **[Signal Protocol]** for asynchronous
7//! forward-secret public-key cryptography.
8//!
9//! In particular, this library implements operations conforming to the following specifications:
10//! - the **[X3DH]** key agreement protocol,
11//! - the **[Double Ratchet]** *(Axolotl)* messaging protocol,
12//!
13//! [Signal Protocol]: https://signal.org/
14//! [X3DH]: https://signal.org/docs/specifications/x3dh/
15//! [Double Ratchet]: https://signal.org/docs/specifications/doubleratchet/
16
17#![warn(clippy::unwrap_used)]
18#![deny(unsafe_code)]
19
20// TODO(https://github.com/signalapp/libsignal/issues/285): it should be an aspiration to
21// eventually warn and then error for public members without docstrings. Also see
22// https://doc.rust-lang.org/rustdoc/what-to-include.html for background.
23// #![warn(missing_docs)]
24
25mod consts;
26mod crypto;
27mod curve;
28pub mod error;
29mod fingerprint;
30mod group_cipher;
31mod identity_key;
32pub mod incremental_mac;
33pub mod kem;
34mod proto;
35mod protocol;
36mod ratchet;
37mod sealed_sender;
38mod sender_keys;
39mod session;
40mod session_cipher;
41mod state;
42mod storage;
43mod timestamp;
44mod utils;
45
46pub use curve::{KeyPair, PrivateKey, PublicKey};
47use error::Result;
48pub use error::SignalProtocolError;
49pub use fingerprint::{DisplayableFingerprint, Fingerprint, ScannableFingerprint};
50pub use group_cipher::{
51    create_sender_key_distribution_message, group_decrypt, group_encrypt,
52    process_sender_key_distribution_message,
53};
54pub use identity_key::{IdentityKey, IdentityKeyPair};
55pub use libsignal_core::{
56    Aci, DeviceId, Pni, ProtocolAddress, ServiceId, ServiceIdFixedWidthBinaryBytes, ServiceIdKind,
57};
58pub use protocol::{
59    extract_decryption_error_message_from_serialized_content, CiphertextMessage,
60    CiphertextMessageType, DecryptionErrorMessage, KyberPayload, PlaintextContent,
61    PreKeySignalMessage, SenderKeyDistributionMessage, SenderKeyMessage, SignalMessage,
62};
63pub use ratchet::{
64    initialize_alice_session_record, initialize_bob_session_record, AliceSignalProtocolParameters,
65    BobSignalProtocolParameters,
66};
67pub use sealed_sender::{
68    sealed_sender_decrypt, sealed_sender_decrypt_to_usmc, sealed_sender_encrypt,
69    sealed_sender_encrypt_from_usmc, sealed_sender_multi_recipient_encrypt, ContentHint,
70    SealedSenderDecryptionResult, SealedSenderV2SentMessage, SealedSenderV2SentMessageRecipient,
71    SenderCertificate, ServerCertificate, UnidentifiedSenderMessageContent,
72};
73pub use sender_keys::SenderKeyRecord;
74pub use session::{process_prekey, process_prekey_bundle};
75pub use session_cipher::{
76    message_decrypt, message_decrypt_prekey, message_decrypt_signal, message_encrypt,
77};
78pub use state::{
79    GenericSignedPreKey, KyberPreKeyId, KyberPreKeyRecord, PreKeyBundle, PreKeyBundleContent,
80    PreKeyId, PreKeyRecord, SessionRecord, SignedPreKeyId, SignedPreKeyRecord,
81};
82pub use storage::{
83    Direction, IdentityKeyStore, InMemIdentityKeyStore, InMemKyberPreKeyStore, InMemPreKeyStore,
84    InMemSenderKeyStore, InMemSessionStore, InMemSignalProtocolStore, InMemSignedPreKeyStore,
85    KyberPreKeyStore, PreKeyStore, ProtocolStore, SenderKeyStore, SessionStore, SignedPreKeyStore,
86};
87pub use timestamp::Timestamp;
libsignal_protocol/lib.rs

libsignal_protocol/
lib.rs
