| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842 |
- /* This file is part of DarkFi (https://dark.fi)
- *
- * Copyright (C) 2020-2024 Dyne.org foundation
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <https://www.gnu.org/licenses/>.
- */
- //! <https://signal.org/docs/specifications/x3dh/x3dh.pdf>
- //! <https://signal.org/docs/specifications/pqxdh/pqxdh.pdf>
- //! <https://signal.org/docs/specifications/doubleratchet/doubleratchet.pdf>
- use std::collections::{HashMap, VecDeque};
- use aes_gcm_siv::{AeadInPlace, Aes256GcmSiv, KeyInit};
- use digest::Update;
- use kyber_kem::{
- kem_decrypt_1024, kem_encrypt_1024, kem_keypair_1024,
- params::{KYBER1024_CT_BYTES, KYBER1024_PK_BYTES},
- };
- use rand::rngs::OsRng;
- use sha2::Sha256;
- use x25519_dalek::{PublicKey as X25519PublicKey, StaticSecret as X25519SecretKey};
- mod hkdf;
- use hkdf::Hkdf;
- mod hmac;
- use hmac::Hmac;
- mod xeddsa;
- use xeddsa::{XeddsaSigner, XeddsaVerifier};
- const AEAD_TAG_SIZE: usize = 16;
- const MESSAGE_KEY_CONSTANT: u8 = 0x01;
- const CHAIN_KEY_CONSTANT: u8 = 0x02;
- const PQXDH_INIT_INFO: &[u8] = b"pqxdh_CURVE25519_SHA-512_CRYSTALS-KYBER-1024";
- const BLANK_NONCE: &[u8] = &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
- // wat do?
- const MAX_SKIP: u64 = 500;
- /// The server contains published identity keys and prekeys.
- #[derive(Default)]
- struct Server(HashMap<X25519PublicKey, Keyset>);
- impl Server {
- pub fn upload(&mut self, ik: X25519PublicKey, keyset: Keyset) {
- self.0.insert(ik, keyset);
- }
- pub fn fetch(&mut self, ik: &X25519PublicKey) -> Option<Bundle> {
- if let Some(keyset) = self.0.get_mut(ik) {
- // The server should provide one one-time prekey if one exists,
- // and then delete it. If all of the one-time prekeys have been
- // deleted, the bundle will not contain a one-time prekey.
- let opk = keyset.opk.pop_front();
- let opk_sig = keyset.opk_sigs.pop_front();
- let pqopk = keyset.pqopk.pop_front();
- let pqopk_sig = keyset.pqopk_sigs.pop_front();
- return Some(Bundle {
- ik: *ik,
- spk: keyset.spk,
- spk_sig: keyset.spk_sig,
- opk,
- opk_sig,
- pqspk: keyset.pqspk,
- pqspk_sig: keyset.pqspk_sig,
- pqopk,
- pqopk_sig,
- })
- }
- None
- }
- }
- /// The set of elliptic curve public keys sent uploaded to a server
- struct Keyset {
- /// Signed prekey
- pub spk: X25519PublicKey,
- /// Signed prekey signature
- pub spk_sig: [u8; 64],
- /// Set of one-time prekeys
- pub opk: VecDeque<X25519PublicKey>,
- /// Set of one-time prekey signatures
- pub opk_sigs: VecDeque<[u8; 64]>,
- /// Last-resort post-quantum prekey
- pub pqspk: [u8; KYBER1024_PK_BYTES],
- /// Last-resort post-quantum prekey signature
- pub pqspk_sig: [u8; 64],
- /// Set of post-quantum one-time prekeys
- pub pqopk: VecDeque<[u8; KYBER1024_PK_BYTES]>,
- /// Set of post-quantum one-time prekey signatures
- pub pqopk_sigs: VecDeque<[u8; 64]>,
- }
- /// The bundle is a structure returned by the server when requesting
- /// it for a certain identity key
- struct Bundle {
- /// Identity key
- pub ik: X25519PublicKey,
- /// Signed prekey
- pub spk: X25519PublicKey,
- /// Signed prekey signature
- pub spk_sig: [u8; 64],
- /// One-time prekey
- pub opk: Option<X25519PublicKey>,
- /// One-time prekey signature
- pub opk_sig: Option<[u8; 64]>,
- /// Last-resort post-quantum prekey
- pub pqspk: [u8; KYBER1024_PK_BYTES],
- /// Last-resort post-quantum prekey signature
- pub pqspk_sig: [u8; 64],
- /// Post-quantum one-time prekey
- pub pqopk: Option<[u8; KYBER1024_PK_BYTES]>,
- /// Post-quantum one-time prekey signature
- pub pqopk_sig: Option<[u8; 64]>,
- }
- /// Initial message sent from Alice to Bob (see below how it's used)
- struct InitialMessage {
- pub ik: X25519PublicKey,
- pub ek: X25519PublicKey,
- pub pqkem_ciphertext: [u8; KYBER1024_CT_BYTES],
- pub prekey_used: Option<X25519PublicKey>,
- pub ciphertext: Vec<u8>,
- }
- #[derive(Copy, Clone, Debug)]
- struct MessageHeader {
- /// Ratchet public key
- dh: X25519PublicKey,
- /// Previous chain length
- pn: u64,
- /// Message number
- n: u64,
- }
- impl MessageHeader {
- /// Creates a new message header containing the DH ratchet public key
- /// `dh` the previous chain length `pn`, and the message number `n`.
- pub fn new(dh: &X25519SecretKey, pn: u64, n: u64) -> Self {
- Self { dh: X25519PublicKey::from(dh), pn, n }
- }
- pub fn to_bytes(self) -> [u8; 48] {
- let mut ret = [0u8; 48];
- ret[..32].copy_from_slice(&self.dh.to_bytes());
- ret[32..40].copy_from_slice(&self.pn.to_le_bytes());
- ret[40..].copy_from_slice(&self.n.to_le_bytes());
- ret
- }
- pub fn from_bytes(arr: [u8; 48]) -> Self {
- let pk_bytes: [u8; 32] = arr[..32].try_into().unwrap();
- let dh = X25519PublicKey::from(pk_bytes);
- let pn = u64::from_le_bytes(arr[32..40].try_into().unwrap());
- let n = u64::from_le_bytes(arr[40..].try_into().unwrap());
- Self { dh, pn, n }
- }
- /// Returns the AEAD encryption of the message header with header key `hk`.
- /// Because the same `hk` will be used repeatedly, the AEAD nonce must
- /// either be a stateful non-repeating value, or must be a random
- /// non-repeating value chosen with at least 128 bits of entropy.
- pub fn encrypt(&self, hk: [u8; 32], ad: &[u8]) -> Vec<u8> {
- // FIXME: BUG: Don't reuse the nonce.
- let nonce = [0u8; 12][..].into();
- let mut ciphertext = vec![0u8; 48 + AEAD_TAG_SIZE];
- ciphertext[..48].copy_from_slice(&self.to_bytes());
- Aes256GcmSiv::new(&hk.into()).encrypt_in_place(nonce, ad, &mut ciphertext).unwrap();
- ciphertext
- }
- /// Returns the authenticated decryption of `ciphertext` with header key `hk`.
- pub fn decrypt(ciphertext: &[u8], hk: [u8; 32], ad: &[u8]) -> Option<Self> {
- // FIXME: BUG: Don't reuse the nonce.
- let nonce = [0u8; 12][..].into();
- let mut plaintext = vec![0u8; ciphertext.len()];
- plaintext.copy_from_slice(ciphertext);
- match Aes256GcmSiv::new(&hk.into()).decrypt_in_place(nonce, ad, &mut plaintext) {
- Ok(()) => {
- plaintext.resize(plaintext.len() - AEAD_TAG_SIZE, 0);
- let message_header = Self::from_bytes(plaintext.try_into().unwrap());
- Some(message_header)
- }
- Err(_) => None,
- }
- }
- }
- /// Returns a pair (32-byte chain key, 32-byte message key) as the output of
- /// applying a KDF keyed by a 32-byte chain key `ck` to some constant.
- /// HMAC with SHA256 is recommended, using `ck` as the HMAC key and using
- /// separate constants as input (e.g. a single byte 0x01 as input to produce
- /// the message key, and a single byte 0x02 as input to produce the next chain
- /// key.
- fn kdf_ck(ck: [u8; 32]) -> ([u8; 32], [u8; 32]) {
- let mut hmac = Hmac::<Sha256>::new_from_slice(&ck);
- hmac.update(&[CHAIN_KEY_CONSTANT]);
- let chain_key = hmac.finalize();
- let mut hmac = Hmac::<Sha256>::new_from_slice(&ck);
- hmac.update(&[MESSAGE_KEY_CONSTANT]);
- let message_key = hmac.finalize();
- (chain_key.into(), message_key.into())
- }
- /// Returns a new root key, chain key, and next header key as the output
- /// of applying a KDF keyed by root key `rk` to a Diffie-Hellman output
- /// `dh_out`.
- /// This function is recommended to be implemented using HKDF with SHA256
- /// using `rk` as HKDF salt, `dh_out` as HKDF input key material, and an
- /// application-specific byte sequence as HKDF info. The info value should
- /// be chosen to be distinct from other uses of HKDF in the application.
- fn kdf_rk(rk: [u8; 32], dh_out: [u8; 32]) -> ([u8; 32], [u8; 32], [u8; 32]) {
- const KDF_RK_INFO: &[u8] = b"x3dh_double_ratchet_kdf_rk";
- const KDF_HE_INFO: &[u8] = b"x3dh_double_ratchet_kdf_rk_he";
- let (_root_key, hkdf) = Hkdf::<Sha256>::extract(&rk, &dh_out);
- let mut chain_key = [0u8; 32];
- hkdf.expand(KDF_RK_INFO, &mut chain_key).unwrap();
- let (root_key, hkdf) = Hkdf::<Sha256>::extract(&rk, &dh_out);
- let mut next_header_key = [0u8; 32];
- hkdf.expand(KDF_HE_INFO, &mut next_header_key).unwrap();
- (root_key.into(), chain_key, next_header_key)
- }
- #[derive(Clone)]
- struct DoubleRatchetSessionState {
- /// DH ratchet key pair (the "sending" or "self" ratchet key) (DHRs)
- pub dh_sending: X25519SecretKey,
- /// DH ratchet public key (the "received" or "remote" key) (DHRr)
- pub dh_remote: X25519PublicKey,
- /// 32-byte root key (RK)
- pub root_key: [u8; 32],
- /// 32-byte Chain Key for sending (CKs)
- pub chain_key_send: [u8; 32],
- /// 32-byte Chain Key for receiving (CKr)
- pub chain_key_recv: [u8; 32],
- /// Message numbers for sending (Ns)
- pub n_send: u64,
- /// Message numbers for receiving (Nr)
- pub n_recv: u64,
- /// Number of messages in previous sending chain (PN)
- pub n_prev: u64,
- /// Dictionary of skipped-over message keys, indexed by header key
- /// and message number. Raises an exception if too many elements
- /// are stored.
- pub mkskipped: HashMap<([u8; 32], u64), [u8; 32]>,
- /// 32-byte Header Key for sending (HKs)
- pub header_key_send: [u8; 32],
- /// 32-byte Header Key for receiving (HKr)
- pub header_key_recv: [u8; 32],
- /// 32-byte Next Header Key for sending (NHKs)
- pub next_header_key_send: [u8; 32],
- /// 32-byte Next Header Key for receiving (NHKr)
- pub next_header_key_recv: [u8; 32],
- }
- impl DoubleRatchetSessionState {
- /// This function performs a symmetric-key ratchet step, then encrypts
- /// the message with the resulting message key. In addition to the
- /// message's _plaintext_ it takes an AD byte sequence which is
- /// prepended to the header to form the associated data for the
- // underlying AEAD encryption.
- pub fn ratchet_encrypt(&mut self, plaintext: &[u8], ad: &[u8]) -> (Vec<u8>, Vec<u8>) {
- let (chain_key, message_key) = kdf_ck(self.chain_key_send);
- self.chain_key_send = chain_key;
- println!("ENCRYPT(): new chain send: {:?}", &chain_key[..5]);
- let header = MessageHeader::new(&self.dh_sending, self.n_prev, self.n_send);
- let enc_header = header.encrypt(self.header_key_send, &[]);
- let mut associated_data = Vec::with_capacity(ad.len() + enc_header.len());
- associated_data.extend_from_slice(ad);
- associated_data.extend_from_slice(&enc_header);
- let mut ciphertext = vec![0u8; plaintext.len() + AEAD_TAG_SIZE];
- ciphertext[..plaintext.len()].copy_from_slice(plaintext);
- // Because each message key is only used once, the AEAD nonce may be
- // handled in several ways:
- // * Fixed to a constant
- // * Derived from `mk` alongside an independent AEAD encryption key
- // * Derived as an additional output from HMAC
- // * Chosen randomly and transmitted
- // ENCRYPT(message_key, plaintext, (AD || enc_header))
- println!("ENCRYPT(): message key: {:?}", &message_key[..5]);
- Aes256GcmSiv::new(&message_key.into())
- .encrypt_in_place(BLANK_NONCE.into(), &associated_data, &mut ciphertext)
- .unwrap();
- self.n_send += 1;
- (enc_header, ciphertext)
- }
- /// Decrypt messages. This function does the following:
- /// * If the message corresponds to a skipped message key this function
- /// decrypts the message, deletes the message key, and returns.
- /// * Otherwise, if a new ratchet key has been received, this function
- /// stores any skipped message keys from the receiving chain and
- /// performs a DH ratchet step to replace the sending and receiving
- /// chains.
- /// * This function then stores any skipped message keys from the current
- /// receiving chain, performs a symmetric-key ratchet step to derive
- /// the relevant message key and next chain key, and decrypts the msg.
- /// If an exception is raised (e.g. message authentication failure), then
- /// the message is discarded and changes to the state object are discarded.
- /// Otherwise, the decrypted plaintext is accepted and changes to the state
- /// object are stored.
- pub fn ratchet_decrypt(&mut self, enc_header: &[u8], ciphertext: &[u8], ad: &[u8]) -> Vec<u8> {
- // We clone here so we don't have to worry about mutating the state before
- // everything is correct.
- let mut state = self.clone();
- if let Some(plaintext) = state.try_skipped_message_keys(enc_header, ciphertext, ad) {
- println!("found skipped");
- *self = state;
- return plaintext
- }
- if let Some((header, dh_ratchet)) = state.decrypt_header(enc_header) {
- if dh_ratchet {
- state.skip_message_keys(header.pn);
- state.dh_ratchet(header);
- }
- state.skip_message_keys(header.n);
- } else {
- panic!("couldn't decrypt header")
- }
- let (chain_key, message_key) = kdf_ck(state.chain_key_recv);
- state.chain_key_recv = chain_key;
- println!("DECRYPT(): new chain recv: {:?}", &chain_key[..5]);
- state.n_recv += 1;
- let mut plaintext = vec![0u8; ciphertext.len()];
- plaintext.copy_from_slice(ciphertext);
- let mut associated_data = Vec::with_capacity(ad.len() + enc_header.len());
- associated_data.extend_from_slice(ad);
- associated_data.extend_from_slice(enc_header);
- // DECRYPT(message_key, ciphertext, (AD || enc_header))
- println!("DECRYPT(): message key: {:?}", &message_key[..5]);
- Aes256GcmSiv::new(&message_key.into())
- .decrypt_in_place(BLANK_NONCE.into(), &associated_data, &mut plaintext)
- .unwrap();
- // Apply the state change
- *self = state;
- plaintext.resize(plaintext.len() - AEAD_TAG_SIZE, 0);
- plaintext
- }
- fn try_skipped_message_keys(
- &mut self,
- enc_header: &[u8],
- ciphertext: &[u8],
- ad: &[u8],
- ) -> Option<Vec<u8>> {
- let mut plaintext = ciphertext.to_vec();
- let mut rem = None;
- for ((hk, n), mk) in self.mkskipped.iter_mut() {
- if let Some(header) = MessageHeader::decrypt(enc_header, *hk, &[]) {
- if header.n == *n {
- rem = Some((*hk, *n));
- let mut associated_data = Vec::with_capacity(ad.len() + enc_header.len());
- associated_data.extend_from_slice(ad);
- associated_data.extend_from_slice(enc_header);
- let mk = *mk;
- Aes256GcmSiv::new(&mk.into())
- .decrypt_in_place(BLANK_NONCE.into(), &associated_data, &mut plaintext)
- .unwrap();
- plaintext.resize(plaintext.len() - AEAD_TAG_SIZE, 0);
- break
- }
- panic!("Failed to decrypt message from skipped message keys");
- }
- }
- if let Some(found) = rem {
- self.mkskipped.remove(&found);
- return Some(plaintext)
- }
- None
- }
- fn decrypt_header(&mut self, enc_header: &[u8]) -> Option<(MessageHeader, bool)> {
- if let Some(header) = MessageHeader::decrypt(enc_header, self.header_key_recv, &[]) {
- return Some((header, false))
- }
- if let Some(header) = MessageHeader::decrypt(enc_header, self.next_header_key_recv, &[]) {
- return Some((header, true))
- }
- println!("Failed to decrypt header");
- None
- }
- fn skip_message_keys(&mut self, until: u64) {
- if self.n_recv + MAX_SKIP < until {
- panic!("I can't hold all of these lemons");
- }
- if self.chain_key_recv != [0u8; 32] {
- while self.n_recv < until {
- let (chain_key_recv, message_key) = kdf_ck(self.chain_key_recv);
- self.chain_key_recv = chain_key_recv;
- println!("SKIP(): new chain recv: {:?}", &chain_key_recv[..5]);
- self.mkskipped.insert((self.header_key_recv, self.n_recv), message_key);
- self.n_recv += 1;
- }
- }
- }
- fn dh_ratchet(&mut self, header: MessageHeader) {
- self.n_prev = self.n_send;
- self.n_send = 0;
- self.n_recv = 0;
- self.header_key_send = self.next_header_key_send;
- self.header_key_recv = self.next_header_key_recv;
- self.dh_remote = header.dh;
- let hkdf_ikm = self.dh_sending.diffie_hellman(&self.dh_remote);
- (self.root_key, self.chain_key_recv, self.next_header_key_recv) =
- kdf_rk(self.root_key, hkdf_ikm.to_bytes());
- let dh_secret_new = X25519SecretKey::random_from_rng(OsRng);
- self.dh_sending = dh_secret_new;
- let hkdf_ikm = self.dh_sending.diffie_hellman(&self.dh_remote);
- (self.root_key, self.chain_key_send, self.next_header_key_send) =
- kdf_rk(self.root_key, hkdf_ikm.to_bytes());
- }
- }
- fn main() {
- // The "server" contains published identity keys and prekeys.
- let mut server = Server::default();
- // The PQXDH protocol has three phases:
- // 1. Bob publishes his identity key and prekeys to a server.
- // 2. Alice fetches a "prekey bundle" from the server, and uses
- // it to send an initial message to Bob.
- // 3. Bob receives and processes Alice's initial message.
- // Alice's identity key `IK_A`
- let ik_a_secret = X25519SecretKey::random_from_rng(OsRng);
- let ik_a_public = X25519PublicKey::from(&ik_a_secret);
- // Bob's identity key `IK_B`
- let ik_b_secret = X25519SecretKey::random_from_rng(OsRng);
- let ik_b_public = X25519PublicKey::from(&ik_b_secret);
- // Bob only needs to upload his identity key to the server once.
- // However, Bob may upload new one-time prekeys at other times
- // (e.g. when the server informs Bob that the server's store
- // of one-time prekeys is getting low).
- // Bob will also upload a new signed prekey and prekey signature
- // at some interval (e.g. once a week/month). The new signed prekey
- // and prekey signature will replace the previous values.
- // Bob's signed prekey `SPK_B`
- let spk_b_secret = X25519SecretKey::random_from_rng(OsRng);
- let spk_b_public = X25519PublicKey::from(&spk_b_secret);
- // Bob's prekey signature `Sig(IK_b, Encode(SPK_B))`
- let nonce = [0_u8; 64];
- let spk_b_sig = ik_b_secret.xeddsa_sign(&spk_b_public.to_bytes(), &nonce);
- // A set of Bob's one-time prekeys `(OPK_B1, OPK_B2, OPK_B3, ...)`
- let mut opk_b_secrets = VecDeque::new();
- let mut opk_b_pubkeys = VecDeque::new();
- let mut opk_b_sigs = VecDeque::new();
- for _ in 0..5 {
- let opk_secret = X25519SecretKey::random_from_rng(OsRng);
- let opk_public = X25519PublicKey::from(&opk_secret);
- let opk_sig = ik_b_secret.xeddsa_sign(&opk_public.to_bytes(), &nonce);
- opk_b_secrets.push_back(opk_secret);
- opk_b_pubkeys.push_back(opk_public);
- opk_b_sigs.push_back(opk_sig);
- }
- // Bob's last-resort PQSPK
- let (_pqspk_b_secret, pqspk_b_public) = kem_keypair_1024(&mut OsRng);
- let pqspk_b_sig = ik_b_secret.xeddsa_sign(&pqspk_b_public, &nonce);
- // A set of Bob's post-quantum one-time prekeys `(PQOPK_B1, PQOPK_B2, ...)`
- let mut pqopk_b_secrets = VecDeque::new();
- let mut pqopk_b_pubkeys = VecDeque::new();
- let mut pqopk_b_sigs = VecDeque::new();
- for _ in 0..5 {
- let (pqopk_secret, pqopk_public) = kem_keypair_1024(&mut OsRng);
- let pqopk_sig = ik_b_secret.xeddsa_sign(&pqopk_public, &nonce);
- pqopk_b_secrets.push_back(pqopk_secret);
- pqopk_b_pubkeys.push_back(pqopk_public);
- pqopk_b_sigs.push_back(pqopk_sig);
- }
- // Bob uploads his keyset to the server.
- let bob_keyset = Keyset {
- spk: spk_b_public,
- spk_sig: spk_b_sig,
- opk: opk_b_pubkeys,
- opk_sigs: opk_b_sigs,
- pqspk: pqspk_b_public,
- pqspk_sig: pqspk_b_sig,
- pqopk: pqopk_b_pubkeys,
- pqopk_sigs: pqopk_b_sigs,
- };
- server.upload(ik_b_public, bob_keyset);
- // To perform an X3DH key agreement with Bob, Alice contacts the server
- // and fetches a "prekey bundle" containing the following values:
- // * Bob's identity key `IK_B`
- // * Bob's signed prekey `SPK_B`
- // * Bob's prekey signature `Sig(IK_B, Encode(SPK_B))`
- // * (Optionally) Bob's one-time prekey `OPK_B`
- // * (Optionally) Bob's one-time prekey signature `Sig(IK_B, Encode(OPK_B))`
- // * Bob's last-resort post-quantum prekey `PQSPK_B`
- // * Bob's last-resort post-quantum prekey signature `Sig(IK_B, Encode(PQSPK_B))`
- // * (Optionally) Bob's post-quantum one-time prekey `PQOPK_B`
- // * (Optionally) Bob's post-quantum one-time prekey signature `Sig(IK_B, Encode(PQOPK_B))`
- let bob_keyset = server.fetch(&ik_b_public).unwrap();
- // Alice verifies the bundle and aborts the protocol on failure
- // (Here we assume we did get one-time prekeys)
- assert!(bob_keyset.ik == ik_b_public);
- assert!(bob_keyset.ik.xeddsa_verify(&bob_keyset.spk.to_bytes(), &bob_keyset.spk_sig));
- assert!(bob_keyset
- .ik
- .xeddsa_verify(&bob_keyset.opk.unwrap().to_bytes(), &bob_keyset.opk_sig.unwrap()));
- assert!(bob_keyset.ik.xeddsa_verify(&bob_keyset.pqspk, &bob_keyset.pqspk_sig));
- assert!(bob_keyset
- .ik
- .xeddsa_verify(&bob_keyset.pqopk.unwrap(), &bob_keyset.pqopk_sig.unwrap()));
- // Alice then generates an ephemeral keypair with public key `EK_A`
- let ek_a_secret = X25519SecretKey::random_from_rng(OsRng);
- let ek_a_public = X25519PublicKey::from(&ek_a_secret);
- // Additionally, she generates a pqkem encapsulated shared secret.
- // This done either with PQOPK or PQSPK, preferably PQOPK if available.
- let (ct, ss) = kem_encrypt_1024(bob_keyset.pqopk.unwrap(), &mut OsRng);
- // If the bundle does _not_ contain a one-time prekey, she calculates:
- // DH1 = DH(IK_A, SPK_B)
- // DH2 = DH(EK_A, IK_B)
- // DH3 = DH(EK_A, SPK_B)
- // SK = KDF(DH1 || DH2 || DH3 || SS)
- // If the bundle _does_ contain a one-time prekey, additionally she
- // does another dh:
- // DH4 = DH(EK_A, OPK_B)
- // SK = KDF(DH1 || DH2 || DH3 || DH4 || SS)
- let dh1 = ik_a_secret.diffie_hellman(&bob_keyset.spk);
- let dh2 = ek_a_secret.diffie_hellman(&bob_keyset.ik);
- let dh3 = ek_a_secret.diffie_hellman(&bob_keyset.spk);
- let mut dh4 = None;
- if let Some(opk) = bob_keyset.opk {
- dh4 = Some(ek_a_secret.diffie_hellman(&opk));
- }
- // KDF represents 32 bytes of output from the HKDF algorithm with inputs:
- // - HKDF input key material = F || KM, where KM is an input byte sequence
- // containing secret key material, and F is a byte sequence containing
- // 32 0xFF bytes when the curve is X25519. F is used for cryptographic
- // domain separation with XEdDSA.
- // - HKDF salt = A zero-filled byte sequence equal to the hash output length.
- // - HKDF info - The info parameter.
- let salt = [0u8; 32];
- let mut ikm = vec![0xFF; 32];
- ikm.extend_from_slice(&dh1.to_bytes());
- ikm.extend_from_slice(&dh2.to_bytes());
- ikm.extend_from_slice(&dh3.to_bytes());
- if let Some(ref opk_dh) = dh4 {
- ikm.extend_from_slice(&opk_dh.to_bytes());
- }
- ikm.extend_from_slice(&ss);
- let hkdf = Hkdf::<Sha256>::new(&salt, &ikm);
- let mut sk = [0u8; 32];
- hkdf.expand(PQXDH_INIT_INFO, &mut sk).unwrap();
- // After calculating SK, Alice deletes her ephemeral private key and the
- // DH outputs, the shared secret SS, and the ciphertext CT.
- // TODO: Actually erase
- drop(ek_a_secret);
- drop(dh1);
- drop(dh2);
- drop(dh3);
- drop(dh4);
- // Alice then calculates an "associated data" byte sequence AD that
- // contains identity information for both parties:
- // AD = Encode(IK_A) || Encode(IK_B)
- // If pqkem does not incorporate PQPK_B into the ciphertext, Alice must
- // also append EncodeKEM(PQPK_B) to AD.
- // Alice may optionally append additional info to AD, such as Alice
- // and Bob's usernames, certificates, or other identifying information.
- let mut ad = Vec::with_capacity(64 + KYBER1024_PK_BYTES);
- ad.extend_from_slice(&ik_a_public.to_bytes());
- ad.extend_from_slice(&bob_keyset.ik.to_bytes());
- ad.extend_from_slice(&bob_keyset.pqopk.unwrap());
- // Alice then sends Bob an initial message containing:
- // - Alice's identity key IK_A
- // - Alice's ephemeral key EK_A
- // - Identifiers stating which of Bob's prekeys Alice used
- // - An initial ciphertext with some AEAD encryption scheme using AD as
- // associated data and using an encryption key which is either SK
- // or the output of some cryptographic PRF keyed by SK.
- let message = b"ohai bob";
- let mut ciphertext = vec![0u8; message.len() + AEAD_TAG_SIZE];
- ciphertext[..message.len()].copy_from_slice(message);
- Aes256GcmSiv::new(&sk.into())
- .encrypt_in_place(BLANK_NONCE.into(), &ad, &mut ciphertext)
- .unwrap();
- let initial_message = InitialMessage {
- ik: ik_a_public,
- ek: ek_a_public,
- pqkem_ciphertext: ct,
- prekey_used: bob_keyset.opk,
- ciphertext,
- };
- // Upon receiving Alice's initial message, Bob retrieves Alice's
- // identity key and ephemeral key from the message. Bob also loads
- // his identity private key, and the private key(s) corresponding
- // to whichever signed prekey and one-time prekey (if any) Alice used.
- // NOTE: In this example, we assume Bob already knows the latest prekey
- // he signed and uploaded to the server.
- // Using these keys, Bob repeats the DH and KDF calculations from the
- // previous section to derive SK, and then deletes the DH values.
- let mut onetime_prekey = None;
- if let Some(opk_used) = initial_message.prekey_used {
- for i in opk_b_secrets.clone() {
- if X25519PublicKey::from(&i.clone()) == opk_used {
- onetime_prekey = Some(i);
- }
- }
- }
- // Bob decrypts the PQ ciphertext
- let ss_b = kem_decrypt_1024(initial_message.pqkem_ciphertext, pqopk_b_secrets[0]);
- let dh1 = spk_b_secret.diffie_hellman(&initial_message.ik);
- let dh2 = ik_b_secret.diffie_hellman(&initial_message.ek);
- let dh3 = spk_b_secret.diffie_hellman(&initial_message.ek);
- let mut dh4 = None;
- if let Some(ref opk) = onetime_prekey {
- dh4 = Some(opk.diffie_hellman(&initial_message.ek));
- }
- let salt = [0u8; 32];
- let mut ikm = vec![0xFF; 32];
- ikm.extend_from_slice(&dh1.to_bytes());
- ikm.extend_from_slice(&dh2.to_bytes());
- ikm.extend_from_slice(&dh3.to_bytes());
- if let Some(ref opk_dh) = dh4 {
- ikm.extend_from_slice(&opk_dh.to_bytes());
- }
- ikm.extend_from_slice(&ss_b);
- // TODO: Erase ephemeral data
- let hkdf = Hkdf::<Sha256>::new(&salt, &ikm);
- let mut sk2 = [0u8; 32];
- hkdf.expand(PQXDH_INIT_INFO, &mut sk2).unwrap();
- assert_eq!(sk, sk2); // Just to confirm everything's correct
- // Bob then constructs the AD byte sequence using IK_A and IK_B
- // as Alice did above.
- let mut ad = Vec::with_capacity(64 + KYBER1024_PK_BYTES);
- ad.extend_from_slice(&initial_message.ik.to_bytes());
- ad.extend_from_slice(&ik_b_public.to_bytes());
- ad.extend_from_slice(&bob_keyset.pqopk.unwrap());
- // Finally, Bob attempts to decrypt the initial ciphertext using SK and AD.
- // If the initial ciphertext fails to decrypt, Bob aborts the protocol and
- // deletes SK.
- let mut plaintext = vec![0_u8; initial_message.ciphertext.len()];
- plaintext.copy_from_slice(&initial_message.ciphertext);
- Aes256GcmSiv::new(&sk2.into())
- .decrypt_in_place(BLANK_NONCE.into(), &ad, &mut plaintext)
- .unwrap();
- plaintext.resize(plaintext.len() - AEAD_TAG_SIZE, 0);
- assert_eq!(plaintext, message); // Just to confirm everything's correct
- // If the initial ciphertext decrypts successfully, the protocol is complete
- // for Bob. Bob deletes any one-time prekey secret key that was used, for
- // forward secrecy. Bob may then continue using SK or keys derived from SK
- // within the post-X3DH protocol for communication with Alice.
- if let Some(opk) = onetime_prekey {
- opk_b_secrets.retain(|x| x.to_bytes() != opk.to_bytes());
- }
- // =======================+
- // Double Ratchet with X3DH
- // ========================
- // * The SK output from X3DH becomes the SK input to Double Ratchet initialization.
- // * The AD output from X3DH becomes the AD input to Double Ratchet {en,de}cryption.
- // * Bob's signed prekey SPK_B becomes Bob's initial ratchet public key (and
- // corresponding keypair) for Double Ratchet initialization.
- // Any Double Ratchet message encrypted using Alice's initial sending chain can
- // serve as an "initial ciphertext" for X3DH. To deal with the possibility of
- // lost or out-of-order messages, a recommended pattern is for Alice to repeatedly
- // send the same X3DH initial message prepended to all of her Double Ratchet
- // messages until she receives Bob's first Double Ratchet response message.
- // Once Alice and Bob have agreed on SK and Bob's ratchet public key, Alice
- // and Bob initialize their states:
- // Alice:
- let alice_dh_secret = X25519SecretKey::random_from_rng(OsRng);
- // The X3DH secret becomes the HKDF salt, and the ikm is the DH output
- // of Alice's DH secret and Bob's SPK_B.
- let hkdf_ikm = alice_dh_secret.diffie_hellman(&bob_keyset.spk);
- let (root_key, chain_key_send, next_header_key_send) = kdf_rk(sk, hkdf_ikm.to_bytes());
- // TODO: We're using SK here as the initial header encryption keys. Perhaps it's not safe?
- let mut ars = DoubleRatchetSessionState {
- dh_sending: alice_dh_secret,
- dh_remote: bob_keyset.spk,
- root_key,
- chain_key_send,
- chain_key_recv: [0u8; 32],
- n_send: 0,
- n_recv: 0,
- n_prev: 0,
- mkskipped: HashMap::default(),
- header_key_send: sk,
- header_key_recv: [0u8; 32],
- next_header_key_send,
- next_header_key_recv: sk,
- };
- // Bob:
- let mut brs = DoubleRatchetSessionState {
- dh_sending: spk_b_secret,
- dh_remote: X25519PublicKey::from([0u8; 32]),
- root_key: sk,
- chain_key_send: [0u8; 32],
- chain_key_recv: [0u8; 32],
- n_send: 0,
- n_recv: 0,
- n_prev: 0,
- mkskipped: HashMap::default(),
- header_key_send: [0u8; 32],
- header_key_recv: [0u8; 32],
- next_header_key_send: sk,
- next_header_key_recv: sk,
- };
- // TODO: What kind of AD should be used?
- // Alice sends it to Bob, and Bob decrypts.
- let message_to_bob = b"hai bobz";
- println!("Alice: n_recv={}, n_send={}, n_prev={}", ars.n_recv, ars.n_send, ars.n_prev);
- let (enc_header, ciphertext) = ars.ratchet_encrypt(message_to_bob, &[]);
- println!("Bob: n_recv={}, n_send={}, n_prev={}", brs.n_recv, brs.n_send, brs.n_prev);
- let plaintext = brs.ratchet_decrypt(&enc_header, &ciphertext, &[]);
- assert_eq!(plaintext, message_to_bob);
- println!("Bob decrypted message: {}", String::from_utf8_lossy(&plaintext));
- // Bob replies to Alice.
- let message_to_alice = b"hai alice, what's up?";
- println!("Bob: n_recv={}, n_send={}, n_prev={}", brs.n_recv, brs.n_send, brs.n_prev);
- let (enc_header, ciphertext) = brs.ratchet_encrypt(message_to_alice, &[]);
- println!("Alice: n_recv={}, n_send={}, n_prev={}", ars.n_recv, ars.n_send, ars.n_prev);
- let plaintext = ars.ratchet_decrypt(&enc_header, &ciphertext, &[]);
- assert_eq!(plaintext, message_to_alice);
- println!("Alice decrypted message: {}", String::from_utf8_lossy(&plaintext));
- // Alice loves Bob.
- let message_to_bob = b"you schizo";
- println!("Alice: n_recv={}, n_send={}, n_prev={}", ars.n_recv, ars.n_send, ars.n_prev);
- let (enc_header, ciphertext) = ars.ratchet_encrypt(message_to_bob, &[]);
- println!("Bob: n_recv={}, n_send={}, n_prev={}", brs.n_recv, brs.n_send, brs.n_prev);
- let plaintext = brs.ratchet_decrypt(&enc_header, &ciphertext, &[]);
- assert_eq!(plaintext, message_to_bob);
- println!("Bob decrypted message: {}", String::from_utf8_lossy(&plaintext));
- // Let's try out of order
- let message_to_bob1 = b"hello";
- let message_to_bob2 = b"jello";
- let (enc_header1, ciphertext1) = ars.ratchet_encrypt(message_to_bob1, &[]);
- let (enc_header2, ciphertext2) = ars.ratchet_encrypt(message_to_bob2, &[]);
- // Slow Bob
- let plaintext = brs.ratchet_decrypt(&enc_header2, &ciphertext2, &[]);
- assert_eq!(plaintext, message_to_bob2);
- let plaintext = brs.ratchet_decrypt(&enc_header1, &ciphertext1, &[]);
- assert_eq!(plaintext, message_to_bob1);
- let message_to_alice = b"weaponised autism";
- let (enc_header, ciphertext) = brs.ratchet_encrypt(message_to_alice, &[]);
- let plaintext = ars.ratchet_decrypt(&enc_header, &ciphertext, &[]);
- assert_eq!(plaintext, message_to_alice);
- }
|