Presage

A Rust library that helps building clients for the Signal Messenger, using libsignal-service-rs. It is designed to provide everything you need to get started.

Features:

• Local storage with sqlx and sqlite (see #287) with optional encryption with sqlcipher (fixed in #335)
• Registration
  • SMS
  • Voice call
• Link as secondary device from Android / iOS app (like Signal Desktop)
• Contacts (synchronized from primary device) and profiles
• Groups
• Messages (incoming and outgoing)
• Fetch, decrypt and store attachments

Instructions

Add the following to your Cargo.toml:

[dependencies]
presage = { git = "https://github.com/whisperfish/presage" }
presage-store-sqlite = { git = "https://github.com/whisperfish/presage" }

# For a discussion as to why, see: 
# https://github.com/whisperfish/libsignal-service-rs/tree/93c23cf27d27a17a803e34ea3dd6a82d268fa79e#working-around-the-issue-with-curve25519-dalek
[patch.crates-io]
curve25519-dalek = { git = 'https://github.com/signalapp/curve25519-dalek', tag = 'signal-curve25519-4.1.3' }

and look at the generated Rust documentation of the Manager struct to get started.

Enable CDSI (Contact Discovery)

The secure contact discovery (from phone numbers) feature depends on libsignal-net which chose to depend on boringSSL. Unfortunately, we rely on sqlcipher which is only compatible with OpenSSL > 3.x (their APIs are incompatible, but share names).

To use cdsi you can use our fork of libsqlite3-sys with a custom encryption provider written in Rust, like so in your Cargo.toml:

presage = { git = "https://github.com/whisperfish/presage" }
presage-sqlite = { git = "https://github.com/whisperfish/presage", default-features = false, features = ["cdsi"] }

[patch.crates-io]
libsqlite3-sys = { version = "0.36.0", git = "https://github.com/whisperfish/rusqlite", rev = '2a42b3354c9194700d08aa070f70a131a470e7dc' }

Demo CLI

Included in this repository is a nearly fully functional CLI that can serve as an example to build your client (you can also use it to query your presage database):

# print help section
cargo run -- --help

# link as secondary device, a PNG with a QR code to scan should open
cargo run -- link-device --device-name presage

# start receiving messages
cargo run -- receive