diff options
| -rw-r--r-- | README.md | 120 | ||||
| -rw-r--r-- | filamento/src/logic/process_stanza.rs | 49 | ||||
| -rw-r--r-- | stanza/Cargo.toml | 1 | ||||
| -rw-r--r-- | stanza/src/client/message.rs | 12 | ||||
| -rw-r--r-- | stanza/src/lib.rs | 2 | ||||
| -rw-r--r-- | stanza/src/xep_0060/event.rs | 28 | ||||
| -rw-r--r-- | stanza/src/xep_0060/pubsub.rs | 18 | ||||
| -rw-r--r-- | stanza/src/xep_0084/data.rs | 30 | ||||
| -rw-r--r-- | stanza/src/xep_0084/metadata.rs | 106 | ||||
| -rw-r--r-- | stanza/src/xep_0084/mod.rs | 8 |
10 files changed, 331 insertions, 43 deletions
@@ -1,55 +1,67 @@ -# jabber client library +# xmpp thingies -- luz: the client. sends and receives messages. contains a message/user store. +## crates: -## TODO: +- filamento: the client logic. handles commands and processes incoming stanzas. contains a message/user store. +- lampada: the client structure. handles connection and reconnection, delegates command and incoming stanza processing to an implementor of Logic. +- luz: jabber client connection and stream base types. +- stanza: type definitions for converting to and from peanuts xml `Element`s for stanza parsing and composition. +- jid: basic JID type, with parsing and display. -- [x] how to know if stanza has been sent -- [ ] error states for all negotiation parts -- [x] better errors -- [x] rename structs -- [x] remove commented code -- [ ] asynchronous connect (with take_mut?) -- [x] split into separate crates: stanza, jabber, and luz -- [ ] use nom for better jid parsing +#### separate: -### specs: +- [macaw](https://bunny.garden/macaw): gui client that utilises filamento +- [peanuts](https://bunny.garden/peanuts): xml serialisation and deserialization library + +## specs: - [x] rfc 6120: core - [x] rfc 6121: im - [x] rfc 7590: tls - [x] xep-0368: srv records for xmpp over tls -- [ ] server side downgrade protection for sasl +- [ ] xep-0474: server side downgrade protection for sasl - [x] xep-0199: xmpp ping - [x] xep-0203: delayed delivery - [x] xep-0030: service discovery - [x] xep-0115: entity capabilities -- [ ] xep-0163: pep +- [x] xep-0163: pep - [ ] xep-0245: /me -- [ ] xep-0084: user avatar -- [ ] xep-0172: user nickname +- [~] xep-0084: user avatar +- [x] xep-0172: user nickname - [ ] xep-0280: message carbons - [ ] xep-0191: blocking -- [ ] xep-0222: public data via pubsub -- [ ] xep-0223: private data via pubsub - [ ] xep-0313: mam -- [ ] xep-0198: stream management - [ ] xep-0085: chat state notifications - [ ] xep-0428: fallback indication - [ ] xep-0359: unique and stable stanza ids - [ ] xep-0424: message retraction -- [ ] xep-0352: client state indication -- [ ] xep-0166: jingle -- [ ] xep-0292: vcard4 -- [ ] chat read markers - - [ ] xep-0490: message displayed synchronization - - [ ] xep-0333: displayed markers +- [ ] xep-0308: last message correction +- [ ] xep-0461: message replies +- [ ] xep-0449: stickers +- [ ] xep-0490: message displayed synchronization +- [ ] xep-0333: displayed markers - [ ] xep-0184: message delivery receipts -- [ ] xep-0060: pubsub - [ ] xep-0100: gateway interation -- [ ] xep-0402: pep native bookmarks +- [~] xep-0059: result set management +- [x] xep-0300: use of cryptographic hash functions +- [~] xep-0131: stanza headers +- [ ] xep-0012: last activity +- [ ] xep-0166: jingle +- [ ] xep-0154: user profile + +#### user status: + +- [ ] xep-0107: user mood +- [ ] xep-0108: user activity +- [ ] xep-0118: user tune + +#### connection: + +- [ ] xep-0198: stream management +- [ ] xep-0352: client state indication + +#### calls: -calls: - [ ] xep-0167: jingle rtp sessions - [ ] xep-0353: jingle message initiation - [ ] xep-0176: jingle ice-udp transport @@ -59,36 +71,44 @@ calls: - [ ] xep-0294: jingle trp header extensions negotiation - [ ] xep-0338: jingle grouping framework - [ ] xep-0339: source-specific media attributes in jingle +- [ ] privacy lists + +#### mix: -mix: - [ ] xep-0369: mix -e2ee: +#### e2ee: + - [ ] xep-0380: explicit message encryption - [ ] xep-0420: stanza content encryption - [ ] xep-0384: omemo - [ ] xep-0396: jingle encrypted transports omemo -file/media sharing (further research needed): +#### file/media sharing (further research needed): + - [ ] xep-0363: http file upload +- [ ] xep-0329: file information sharing +- [ ] xep-0447: stateless file sharing - [ ] xep-0385: stateless inline media sharing - [ ] xep-0066: out of band data - [ ] xep-0261: jingle in-band bytestreams - [ ] xep-0234: jingle file transfer -need more research: -- [ ] xep-0154: user profile -- [ ] message editing - - [ ] xep-0308: last message correction (should not be used for older than last message according to spec) +#### need more research: + - [ ] message styling + - [ ] xep-0071: xhtml-im - [ ] xep-0393: message styling -will prioritise new spec instead of: +#### will prioritise new spec instead of: + - [ ] muc - [ ] xep-0045: muc - [ ] xep-0249: direct muc invitations - [ ] xep-0410: muc self-ping + - [ ] xep-0402: pep native bookmarks - [ ] vcard legacy + - [ ] xep-0292: vcard4 - [ ] xep-0398: user avatar compat - [ ] xep-0153: vcard avatars - [ ] xep-0054: vcard-temp @@ -96,7 +116,14 @@ will prioritise new spec instead of: - [ ] xep-0048: legacy bookmarks - [ ] xep-0049: private xml storage -later (nice to have): +#### pubsub: + +- [ ] xep-0060: pubsub +- [ ] xep-0222: public data via pubsub +- [ ] xep-0223: private data via pubsub + +#### later (nice to have): + - [ ] xep-0077: in-band registration - [ ] xep-0157: contact addresses - [ ] xep-0455: service outage status @@ -108,7 +135,7 @@ later (nice to have): - [ ] xep-0386: bind 2.0 - [ ] xep-0409: im routing-ng - [ ] xep-0397: instant stream resumption - - [ ] xep-0390: entity capabilities 2.0 + - [~] xep-0390: entity capabilities 2.0 - [ ] improved on-boarding - [ ] xep-0401: easy user onboarding - [ ] xep-0379: pre-authenticated roster subscription @@ -120,3 +147,20 @@ later (nice to have): - [ ] xep-0388: extensible sasl profile (sasl 2.0) - [ ] xep-xxxx: oauth client login - [ ] xep-xxxx: client access management + +#### to write: + +- [ ] advanced message body (for custom emoji, styling, etc.). can opt in to mixed content in message body. base as bold, italic, underline, strikethrough, then extensible with new tags for e.g. emoji, color, size, font, chat effects. +- [ ] omemo cross-signing verification or something along those lines, with a main device and linked devices +- [ ] better stickers/emoji xep +- [ ] mix voice channels (w/ sfu) +- [ ] mix guilds +- [ ] pep native spaces +- [ ] pinned messages +- [ ] chat settings +- [ ] encrypted chat history share +- [ ] disappearing messages +- [ ] poke +- [ ] polls +- [ ] privacy lists/circles +- [ ] pubsub node items filter for each person diff --git a/filamento/src/logic/process_stanza.rs b/filamento/src/logic/process_stanza.rs index 182fb43..11d7588 100644 --- a/filamento/src/logic/process_stanza.rs +++ b/filamento/src/logic/process_stanza.rs @@ -9,6 +9,7 @@ use stanza::{ }, stanza_error::Error as StanzaError, xep_0030::{self, info}, + xep_0060::event::{Content, Event, ItemsType}, }; use tracing::{debug, error, info, warn}; use uuid::Uuid; @@ -107,6 +108,54 @@ pub async fn recv_message( .await; } + if let Some(event) = stanza_message.event { + match event { + Event::Items(items) => match items.node.as_str() { + "http://jabber.org/protocol/nick" => match items.items { + ItemsType::Item(items) => { + if let Some(item) = items.first() { + match &item.item { + Some(c) => match c { + Content::Nick(nick) => { + if let Err(e) = logic + .db() + .upsert_user_nick(from.as_bare(), nick.0.clone()) + .await + { + logic + .handle_error(Error::MessageRecv( + MessageRecvError::NickUpdate(e), + )) + .await; + } + + logic + .update_sender() + .send(UpdateMessage::NickChanged { + jid: from.as_bare(), + nick: nick.0.clone(), + }) + .await; + } + Content::Unknown(element) => {} + }, + None => {} + } + } + } + ItemsType::Retract(retracts) => {} + }, + _ => {} + }, + // Event::Collection(collection) => todo!(), + // Event::Configuration(configuration) => todo!(), + // Event::Delete(delete) => todo!(), + // Event::Purge(purge) => todo!(), + // Event::Subscription(subscription) => todo!(), + _ => {} + } + } + Ok(None) // TODO: can this be more efficient? } else { diff --git a/stanza/Cargo.toml b/stanza/Cargo.toml index d63703f..69fabc2 100644 --- a/stanza/Cargo.toml +++ b/stanza/Cargo.toml @@ -15,6 +15,7 @@ xep_0004 = [] xep_0030 = [] xep_0059 = [] xep_0060 = ["xep_0004", "dep:chrono"] +xep_0084 = [] xep_0115 = [] xep_0128 = ["xep_0004"] xep_0131 = [] diff --git a/stanza/src/client/message.rs b/stanza/src/client/message.rs index d94b82e..78258ca 100644 --- a/stanza/src/client/message.rs +++ b/stanza/src/client/message.rs @@ -6,6 +6,8 @@ use peanuts::{ DeserializeError, Element, XML_NS, }; +#[cfg(feature = "xep_0060")] +use crate::xep_0060::event::Event; #[cfg(feature = "xep_0131")] use crate::xep_0131::Headers; #[cfg(feature = "xep_0172")] @@ -33,6 +35,8 @@ pub struct Message { pub headers: Option<Headers>, #[cfg(feature = "xep_0172")] pub nick: Option<Nick>, + #[cfg(feature = "xep_0060")] + pub event: Option<Event>, } impl FromElement for Message { @@ -59,6 +63,9 @@ impl FromElement for Message { #[cfg(feature = "xep_0172")] let nick = element.child_opt()?; + #[cfg(feature = "xep_0060")] + let event = element.child_opt()?; + Ok(Message { from, id, @@ -74,6 +81,8 @@ impl FromElement for Message { headers, #[cfg(feature = "xep_0172")] nick, + #[cfg(feature = "xep_0060")] + event, }) } } @@ -105,6 +114,9 @@ impl IntoElement for Message { #[cfg(feature = "xep_0172")] let builder = builder.push_child_opt(self.nick.clone()); + #[cfg(feature = "xep_0060")] + let builder = builder.push_child_opt(self.event.clone()); + builder } } diff --git a/stanza/src/lib.rs b/stanza/src/lib.rs index 3ecace0..569b891 100644 --- a/stanza/src/lib.rs +++ b/stanza/src/lib.rs @@ -17,6 +17,8 @@ pub mod xep_0030; pub mod xep_0059; #[cfg(feature = "xep_0060")] pub mod xep_0060; +#[cfg(feature = "xep_0084")] +pub mod xep_0084; #[cfg(feature = "xep_0115")] pub mod xep_0115; #[cfg(feature = "xep_0131")] diff --git a/stanza/src/xep_0060/event.rs b/stanza/src/xep_0060/event.rs index d2c150a..1be011d 100644 --- a/stanza/src/xep_0060/event.rs +++ b/stanza/src/xep_0060/event.rs @@ -8,6 +8,8 @@ use peanuts::{ }; use crate::xep_0004::X; +#[cfg(feature = "xep_0084")] +use crate::xep_0084; #[cfg(feature = "xep_0172")] use crate::xep_0172::{self, Nick}; @@ -219,8 +221,8 @@ impl IntoElement for Delete { #[derive(Clone, Debug)] pub struct Items { - node: String, - items: ItemsType, + pub node: String, + pub items: ItemsType, } impl FromElement for Items { @@ -260,9 +262,9 @@ pub enum ItemsType { #[derive(Clone, Debug)] pub struct Item { - id: Option<String>, - publisher: Option<String>, - item: Option<Content>, + pub id: Option<String>, + pub publisher: Option<String>, + pub item: Option<Content>, } impl FromElement for Item { @@ -296,6 +298,10 @@ impl IntoElement for Item { pub enum Content { #[cfg(feature = "xep_0172")] Nick(Nick), + #[cfg(feature = "xep_0084")] + AvatarData(xep_0084::Data), + #[cfg(feature = "xep_0084")] + AvatarMetadata(xep_0084::Metadata), Unknown(Element), } @@ -304,6 +310,14 @@ impl FromElement for Content { match element.identify() { #[cfg(feature = "xep_0172")] (Some(xep_0172::XMLNS), "nick") => Ok(Content::Nick(Nick::from_element(element)?)), + #[cfg(feature = "xep_0084")] + (Some(xep_0084::data::XMLNS), "data") => { + Ok(Content::AvatarData(xep_0084::Data::from_element(element)?)) + } + #[cfg(feature = "xep_0084")] + (Some(xep_0084::metadata::XMLNS), "metadata") => Ok(Content::AvatarMetadata( + xep_0084::Metadata::from_element(element)?, + )), _ => Ok(Self::Unknown(element)), } } @@ -314,6 +328,10 @@ impl IntoElement for Content { match self { #[cfg(feature = "xep_0172")] Content::Nick(nick) => nick.builder(), + #[cfg(feature = "xep_0084")] + Content::AvatarData(data) => data.builder(), + #[cfg(feature = "xep_0084")] + Content::AvatarMetadata(metadata) => metadata.builder(), Content::Unknown(_e) => panic!("unknown content cannot be serialized"), } } diff --git a/stanza/src/xep_0060/pubsub.rs b/stanza/src/xep_0060/pubsub.rs index 25fc405..0f698dc 100644 --- a/stanza/src/xep_0060/pubsub.rs +++ b/stanza/src/xep_0060/pubsub.rs @@ -7,6 +7,8 @@ use peanuts::{ }; use crate::xep_0004::X; +#[cfg(feature = "xep_0084")] +use crate::xep_0084; #[cfg(feature = "xep_0172")] use crate::xep_0172::{self, Nick}; @@ -377,6 +379,10 @@ impl IntoElement for Item { pub enum Content { #[cfg(feature = "xep_0172")] Nick(Nick), + #[cfg(feature = "xep_0084")] + AvatarData(xep_0084::Data), + #[cfg(feature = "xep_0084")] + AvatarMetadata(xep_0084::Metadata), Unknown(Element), } @@ -385,6 +391,14 @@ impl FromElement for Content { match element.identify() { #[cfg(feature = "xep_0172")] (Some(xep_0172::XMLNS), "nick") => Ok(Content::Nick(Nick::from_element(element)?)), + #[cfg(feature = "xep_0084")] + (Some(xep_0084::data::XMLNS), "data") => { + Ok(Content::AvatarData(xep_0084::Data::from_element(element)?)) + } + #[cfg(feature = "xep_0084")] + (Some(xep_0084::metadata::XMLNS), "metadata") => Ok(Content::AvatarMetadata( + xep_0084::Metadata::from_element(element)?, + )), _ => Ok(Self::Unknown(element)), } } @@ -395,6 +409,10 @@ impl IntoElement for Content { match self { #[cfg(feature = "xep_0172")] Content::Nick(nick) => nick.builder(), + #[cfg(feature = "xep_0084")] + Content::AvatarData(data) => data.builder(), + #[cfg(feature = "xep_0084")] + Content::AvatarMetadata(metadata) => metadata.builder(), Content::Unknown(_e) => panic!("unknown content cannot be serialized"), } } diff --git a/stanza/src/xep_0084/data.rs b/stanza/src/xep_0084/data.rs new file mode 100644 index 0000000..2a37df4 --- /dev/null +++ b/stanza/src/xep_0084/data.rs @@ -0,0 +1,30 @@ +use peanuts::{ + element::{FromElement, IntoElement}, + Element, +}; + +pub const XMLNS: &str = "urn:xmpp:avatar:data"; + +#[derive(Debug, Clone)] +pub struct Data(pub String); + +impl FromElement for Data { + fn from_element(mut element: peanuts::Element) -> peanuts::element::DeserializeResult<Self> { + element.check_name("data")?; + element.check_namespace(XMLNS)?; + + Ok(Self(element.pop_value_opt()?.unwrap_or_default())) + } +} + +impl IntoElement for Data { + fn builder(&self) -> peanuts::element::ElementBuilder { + let builder = Element::builder("data", Some(XMLNS)); + + if self.0.is_empty() { + builder + } else { + builder.push_text(self.0.clone()) + } + } +} diff --git a/stanza/src/xep_0084/metadata.rs b/stanza/src/xep_0084/metadata.rs new file mode 100644 index 0000000..c6a3fb4 --- /dev/null +++ b/stanza/src/xep_0084/metadata.rs @@ -0,0 +1,106 @@ +use peanuts::{ + element::{FromElement, IntoElement}, + Element, +}; + +pub const XMLNS: &str = "urn:xmpp:avatar:metadata"; + +#[derive(Debug, Clone)] +pub struct Metadata { + pub info: Vec<Info>, + pub pointers: Vec<Pointer>, +} + +impl FromElement for Metadata { + fn from_element(mut element: Element) -> peanuts::element::DeserializeResult<Self> { + element.check_name("metadata")?; + element.check_namespace(XMLNS)?; + + let info = element.pop_children()?; + let pointers = element.pop_children()?; + + Ok(Self { info, pointers }) + } +} + +impl IntoElement for Metadata { + fn builder(&self) -> peanuts::element::ElementBuilder { + Element::builder("metadata", Some(XMLNS)) + .push_children(self.info.clone()) + .push_children(self.pointers.clone()) + } +} + +#[derive(Debug, Clone)] +pub struct Info { + pub bytes: u32, + pub height: Option<u16>, + pub id: String, + pub r#type: String, + pub url: Option<String>, + pub width: Option<u16>, +} + +impl FromElement for Info { + fn from_element(mut element: Element) -> peanuts::element::DeserializeResult<Self> { + element.check_name("info")?; + element.check_namespace(XMLNS)?; + + let bytes = element.attribute("bytes")?; + let height = element.attribute_opt("height")?; + let id = element.attribute("id")?; + let r#type = element.attribute("type")?; + let url = element.attribute_opt("url")?; + let width = element.attribute_opt("width")?; + + Ok(Self { + bytes, + height, + id, + r#type, + url, + width, + }) + } +} + +impl IntoElement for Info { + fn builder(&self) -> peanuts::element::ElementBuilder { + Element::builder("info", Some(XMLNS)) + .push_attribute("bytes", self.bytes) + .push_attribute_opt("height", self.height) + .push_attribute("id", self.id.clone()) + .push_attribute("type", self.r#type.clone()) + .push_attribute_opt("url", self.url.clone()) + .push_attribute_opt("width", self.width) + } +} + +#[derive(Debug, Clone)] +pub struct Pointer(pub PointerInner); + +impl FromElement for Pointer { + fn from_element(mut element: Element) -> peanuts::element::DeserializeResult<Self> { + element.check_name("pointer")?; + element.check_namespace(XMLNS)?; + + Ok(Self(PointerInner::Unsupported(element.pop_child_one()?))) + } +} + +impl IntoElement for Pointer { + fn builder(&self) -> peanuts::element::ElementBuilder { + let _builder = Element::builder("pointer", Some(XMLNS)); + + match &self.0 { + PointerInner::Unsupported(_element) => { + panic!("cannot serialize unsupported PointerInner") + } + } + } +} + +#[derive(Debug, Clone)] +pub enum PointerInner { + Unsupported(Element), +} diff --git a/stanza/src/xep_0084/mod.rs b/stanza/src/xep_0084/mod.rs new file mode 100644 index 0000000..be7d5d7 --- /dev/null +++ b/stanza/src/xep_0084/mod.rs @@ -0,0 +1,8 @@ +pub use data::Data; +pub use metadata::Info; +pub use metadata::Metadata; +pub use metadata::Pointer; +pub use metadata::PointerInner; + +pub mod data; +pub mod metadata; |