diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 108 |
1 files changed, 75 insertions, 33 deletions
@@ -1,51 +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 - [x] xep-0163: pep - [ ] xep-0245: /me -- [ ] xep-0084: user avatar +- [~] xep-0084: user avatar - [x] xep-0172: user nickname - [ ] xep-0280: message carbons - [ ] xep-0191: blocking - [ ] 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-0100: gateway interation +- [~] 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 @@ -55,37 +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 @@ -93,12 +116,14 @@ will prioritise new spec instead of: - [ ] xep-0048: legacy bookmarks - [ ] xep-0049: private xml storage -pubsub: +#### pubsub: + - [ ] xep-0060: pubsub - [ ] xep-0222: public data via pubsub - [ ] xep-0223: private data via pubsub -later (nice to have): +#### later (nice to have): + - [ ] xep-0077: in-band registration - [ ] xep-0157: contact addresses - [ ] xep-0455: service outage status @@ -110,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 @@ -122,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 |