feat: bubble up message sender to applications

This commit is contained in:
kaichaosun 2026-06-23 14:31:23 +08:00
parent a5abefa314
commit f7883adf79
No known key found for this signature in database
GPG Key ID: 223E0F992F4F03BF
4 changed files with 105 additions and 44 deletions

View File

@ -13,7 +13,7 @@ use storage::ChatStore;
use crate::delegate::DelegateCredential;
use crate::errors::ClientError;
use crate::event::Event;
use crate::event::{Event, MessageSender};
type ClientCore<I, T, R, S> = Core<(I, T, R, ThreadedWakeupService, S)>;
type AccountAddressRef<'a> = &'a str;
@ -257,47 +257,57 @@ fn account_key_from_hex(addr: &str) -> Option<Ed25519VerifyingKey> {
Ed25519VerifyingKey::from_bytes(&bytes).ok()
}
/// Whether to surface a received message, given its sender credential checked
/// against the account → device directory (our account store).
/// Decode and verify a message's sender from its credential, checked against the
/// account → device directory (our account store).
///
/// The credential binds a delegate device key to an optional account address.
/// When it claims an account, that account's published device set must include
/// this device — otherwise the account→device mapping is wrong or unconfirmable
/// and the message is dropped (`false`). A credential that claims no account (or
/// no credential at all) asserts no mapping, so it is delivered (`true`).
fn should_deliver(directory: &impl AccountDirectory, encoded: &[u8]) -> bool {
/// - `Err(())` — drop the message: it claims an account whose device mapping is
/// wrong or can't be confirmed.
/// - `Ok(None)` — deliver, but the sender is unknown (no credential, e.g. a
/// PrivateV1 1:1 message).
/// - `Ok(Some(sender))` — deliver with the sender. The `account` is set only when
/// the directory confirmed the device belongs to it, so it is always verified.
fn decode_sender(
directory: &impl AccountDirectory,
encoded: &[u8],
) -> Result<Option<MessageSender>, ()> {
// No credential (e.g. the PrivateV1 placeholder) asserts no account mapping.
if encoded.is_empty() {
return true;
return Ok(None);
}
let Ok(data) = hex::decode(encoded) else {
tracing::warn!("sender credential is not valid hex; dropping message");
return false;
return Err(());
};
let cred = match DelegateCredential::try_from(data) {
Ok(cred) => cred,
Err(_) => {
tracing::warn!("malformed sender credential; dropping message");
return false;
return Err(());
}
};
let device = hex::encode(cred.delegate_id().as_ref());
// An unassociated delegate asserts no account → device mapping.
let Some(account_addr) = cred.account_addr() else {
return true;
return Ok(Some(MessageSender {
account: None,
local_identity: IdentId::new(device),
}));
};
let Some(account_key) = account_key_from_hex(account_addr) else {
tracing::warn!(
account_addr,
"sender account address is not a verifying key; dropping message"
);
return false;
return Err(());
};
match directory.fetch(&account_key) {
Ok(Some(set)) if set.devices.iter().any(|d| d == &device) => true,
Ok(Some(set)) if set.devices.iter().any(|d| d == &device) => Ok(Some(MessageSender {
account: Some(IdentId::new(account_addr.to_string())),
local_identity: IdentId::new(device),
})),
_ => {
tracing::warn!(account_addr, %device, "account → device mapping is wrong or unconfirmable; dropping message");
false
Err(())
}
}
}
@ -305,10 +315,13 @@ fn should_deliver(directory: &impl AccountDirectory, encoded: &[u8]) -> bool {
fn convo_events(outcome: ConvoOutcome, directory: &impl AccountDirectory) -> Vec<Event> {
let ConvoOutcome { convo_id, content } = outcome;
content
.filter(|c| should_deliver(directory, &c.encoded_credential))
.map(|c| Event::MessageReceived {
convo_id: Arc::from(convo_id),
content: c.bytes,
.and_then(|c| {
let sender = decode_sender(directory, &c.encoded_credential).ok()?;
Some(Event::MessageReceived {
convo_id: Arc::from(convo_id),
content: c.bytes,
sender,
})
})
.into_iter()
.collect()
@ -326,11 +339,12 @@ fn inbox_events(outcome: InboxOutcome, directory: &impl AccountDirectory) -> Vec
class: new_conversation.class,
});
if let Some(c) = initial.and_then(|co| co.content)
&& should_deliver(directory, &c.encoded_credential)
&& let Ok(sender) = decode_sender(directory, &c.encoded_credential)
{
events.push(Event::MessageReceived {
convo_id: Arc::clone(&id),
content: c.bytes,
sender,
});
}
events
@ -341,9 +355,9 @@ mod sender_check_tests {
use std::collections::HashMap;
use crypto::{Ed25519SigningKey, Ed25519VerifyingKey};
use libchat::{DeviceSet, SignedDeviceBundle};
use libchat::{DeviceSet, IdentId, SignedDeviceBundle};
use super::should_deliver;
use super::{MessageSender, decode_sender};
use crate::delegate::DelegateCredential;
/// In-test account → device directory. Holds device id sets keyed by the hex
@ -400,15 +414,25 @@ mod sender_check_tests {
hex::encode(cred.serialize()).into_bytes()
}
fn local_id(k: &Ed25519VerifyingKey) -> IdentId {
IdentId::new(hex::encode(k.as_ref()))
}
/// The account published a device set that includes the sending device — the
/// claim checks out, so the message is delivered.
/// claim checks out, so the message is delivered with a verified account.
#[test]
fn verified_sender_is_delivered() {
fn verified_sender_surfaces_account_and_device() {
let account = key();
let device = key();
let dir = FakeDir::with_devices(&account, &[&device]);
let cred = DelegateCredential::associated(&device, &hex::encode(account.as_ref()));
assert!(should_deliver(&dir, &encoded(cred)));
assert_eq!(
decode_sender(&dir, &encoded(cred)),
Ok(Some(MessageSender {
account: Some(local_id(&account)),
local_identity: local_id(&device),
}))
);
}
/// The account published a device set that does NOT include the sending
@ -420,15 +444,22 @@ mod sender_check_tests {
let spoofer = key();
let dir = FakeDir::with_devices(&account, &[&endorsed]);
let cred = DelegateCredential::associated(&spoofer, &hex::encode(account.as_ref()));
assert!(!should_deliver(&dir, &encoded(cred)));
assert!(decode_sender(&dir, &encoded(cred)).is_err());
}
/// A delegate that claims no account makes no mapping to contradict.
/// A delegate that claims no account surfaces its device but no account.
#[test]
fn unassociated_sender_is_delivered() {
fn unassociated_sender_surfaces_device_only() {
let dir = FakeDir::default();
let cred = DelegateCredential::unassociated(&key());
assert!(should_deliver(&dir, &encoded(cred)));
let device = key();
let cred = DelegateCredential::unassociated(&device);
assert_eq!(
decode_sender(&dir, &encoded(cred)),
Ok(Some(MessageSender {
account: None,
local_identity: local_id(&device),
}))
);
}
/// The claimed account has never published a device set — the mapping is
@ -439,7 +470,7 @@ mod sender_check_tests {
let device = key();
let dir = FakeDir::default(); // nothing published
let cred = DelegateCredential::associated(&device, &hex::encode(account.as_ref()));
assert!(!should_deliver(&dir, &encoded(cred)));
assert!(decode_sender(&dir, &encoded(cred)).is_err());
}
/// A directory outage leaves the mapping unconfirmed, so the message is
@ -453,15 +484,15 @@ mod sender_check_tests {
..Default::default()
};
let cred = DelegateCredential::associated(&device, &hex::encode(account.as_ref()));
assert!(!should_deliver(&dir, &encoded(cred)));
assert!(decode_sender(&dir, &encoded(cred)).is_err());
}
/// No credential at all (e.g. the PrivateV1 placeholder) asserts no account
/// mapping and is delivered.
/// mapping and is delivered with no sender.
#[test]
fn empty_credential_is_delivered() {
fn empty_credential_has_no_sender() {
let dir = FakeDir::default();
assert!(should_deliver(&dir, b""));
assert_eq!(decode_sender(&dir, b""), Ok(None));
}
/// Bytes that aren't a well-formed credential leave the sender's mapping
@ -469,8 +500,8 @@ mod sender_check_tests {
#[test]
fn malformed_credential_is_dropped() {
let dir = FakeDir::default();
assert!(!should_deliver(&dir, b"not hex"));
assert!(!should_deliver(&dir, hex::encode([0u8; 4]).as_bytes()));
assert!(decode_sender(&dir, b"not hex").is_err());
assert!(decode_sender(&dir, hex::encode([0u8; 4]).as_bytes()).is_err());
}
/// An account address that isn't a verifying key can't be looked up, so the
@ -479,6 +510,6 @@ mod sender_check_tests {
fn non_key_account_address_is_dropped() {
let dir = FakeDir::default();
let cred = DelegateCredential::associated(&key(), "user@example.com");
assert!(!should_deliver(&dir, &encoded(cred)));
assert!(decode_sender(&dir, &encoded(cred)).is_err());
}
}

View File

@ -8,7 +8,20 @@
use std::sync::Arc;
use libchat::ConversationClass;
use libchat::{ConversationClass, IdentId};
/// The sender of a received message, recovered from its credential.
///
/// `account` is present only when the sender associated an account *and* the
/// account → device directory confirmed this device belongs to it — spoofed or
/// unconfirmable claims never reach the application, so a `Some` account is
/// always verified. `local_identity` is the sending device (delegate key),
/// hex-encoded.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MessageSender {
pub account: Option<IdentId>,
pub local_identity: IdentId,
}
/// A discrete chat event.
#[non_exhaustive]
@ -23,6 +36,7 @@ pub enum Event {
MessageReceived {
convo_id: Arc<str>,
content: Vec<u8>,
sender: Option<MessageSender>,
},
InboundError {
message: String,

View File

@ -10,7 +10,7 @@ pub use client::{ChatClient, Transport};
pub use delegate::DelegateSigner;
pub use delivery_in_process::{InProcessDelivery, MessageBus};
pub use errors::ClientError;
pub use event::Event;
pub use event::{Event, MessageSender};
// Re-export types callers need to interact with ChatClient.
pub use libchat::{

View File

@ -95,8 +95,10 @@ fn direct_v1_standalone_integration() {
// address, and publish a device bundle so the receiver can verify the
// account → device mapping carried in the sender's credential.
let saro_account = TestLogosAccount::new("Saro");
let saro_account_id = hex::encode(saro_account.public_key().as_ref());
let mut saro_delegate = DelegateSigner::random();
saro_delegate.associate(hex::encode(saro_account.public_key().as_ref()));
saro_delegate.associate(saro_account_id.clone());
let saro_device_id = hex::encode(saro_delegate.public_key().as_ref());
publish_device_bundle(&mut reg_service, &saro_account, saro_delegate.public_key());
let raya_account = TestLogosAccount::new("Raya");
@ -121,8 +123,16 @@ fn direct_v1_standalone_integration() {
saro.send_message(&convo_id, b"Hey from saro")
.expect("payload mismatch");
expect_event(&raya_events, "MessageReceived", |e| match e {
Event::MessageReceived { content, .. } => {
Event::MessageReceived { content, sender, .. } => {
assert_eq!(content.as_slice(), b"Hey from saro");
// saro associated an account and published a matching bundle, so the
// sender surfaces with a verified account and its device.
let sender = sender.expect("verified sender present");
assert_eq!(
sender.account.as_ref().map(|a| a.as_str()),
Some(saro_account_id.as_str())
);
assert_eq!(sender.local_identity.as_str(), saro_device_id.as_str());
Ok(())
}
other => Err(other),
@ -153,9 +163,15 @@ fn saro_raya_message_exchange() {
saro.send_message(&saro_convo_id, b"hello raya").unwrap();
expect_event(&raya_events, "MessageReceived", |e| match e {
Event::MessageReceived { convo_id, content } => {
Event::MessageReceived {
convo_id,
content,
sender,
} => {
assert_eq!(convo_id, raya_convo_id);
assert_eq!(content.as_slice(), b"hello raya");
// PrivateV1 1:1 carries no credential, so there is no sender.
assert!(sender.is_none());
Ok(())
}
other => Err(other),