diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 108 |
1 files changed, 77 insertions, 31 deletions
@@ -1,7 +1,5 @@ rexmpp - a reusable XMPP IM client library -This is currently at a draft/prototype stage. - The goal is to produce a library reusable from different languages (via C FFI), without hijacking an event loop, requiring any specific one, or otherwise restricting a user, and fairly feature-rich. The @@ -14,7 +12,31 @@ rely on any particular UI, should be flexible and not stay in the way of implementing additional XEPs on top of it, and should try to make it easy to implement a decent client application using it. -Current dependencies: c-ares, libxml2, gnutls, gsasl. +Mandatory dependencies: + +- libxml2, libexpat, or rxml (Rust) +- gcrypt, nettle, or openssl + +Optional dependencies: + +- gsasl +- libunbound or c-ares +- gnutls with gnutls-dane or openssl +- icu-i18n +- gpgme +- curl + +For Jingle calls: + +- libnice (with glib) +- gnutls or openssl +- libsrtp2 +- portaudio +- opus (optional) + +For use of the alternative Rust implementations, rustc and cargo +should be available, and the following Rust libraries will be pulled: +libc, errno, rxml. A rough roadmap: @@ -22,67 +44,91 @@ A rough roadmap: - Basic protocol: -[+] XMPP core (RFC 6120). A prototype is mostly ready, though it can - use more of error handling and refinement. +[+] XMPP core (RFC 6120). Mostly ready, though would be nice to + review and refactor. - Reliable and predictable message delivery: -[+] XEP-0198: Stream Management. Implemented (both acknowledgements - and resumption, making use of XEP-0203: Delayed Delivery). -[+] XEP-0280: Message Carbons. +[+] XEP-0198 v1.6: Stream Management. Implemented (both acknowledgements + and resumption, making use of XEP-0203 v2.0: Delayed Delivery). +[+] XEP-0280 v0.13: Message Carbons. - Better connectivity: [+] "Happy Eyeballs" (RFC 8305). -[+] XEP-0368: SRV records for XMPP over TLS. -[+] SOCKS5 (RFC 1928) support. Implemented, though can be improved. -[+] XEP-0199: XMPP Ping. +[+] XEP-0368 v1.1: SRV records for XMPP over TLS (when built with + libunbound or c-ares). +[+] SOCKS5 (RFC 1928) support. Implemented, though no authentication. +[+] XEP-0199 v2.0: XMPP Ping. +[.] Certificate verification using DANE (experimental, only when built + with GnuTLS). +[+] DNSSEC checks (when built with libunbound). - Library refinement: [.] Doxygen documentation. [.] Texinfo manual. -[ ] Proper JID handling (RFC 7622). -[ ] Abstraction of the used XML, SASL, TLS, and DNS libraries, and - optional usage of alternative ones. Though maybe shouldn't - abstract out XML functions and structures: could reuse existing - libxml2 bindings that way. -[ ] Automated testing. +[.] Proper JID handling (RFC 7622). +[+] Abstraction of the used XML, SASL, TLS, and DNS libraries, and + optional usage of alternative ones. +[.] Automated testing. +[.] Alternative module implementations in Rust (looks like there is a + memory leak somewhere around those though). - IM features: [+] XMPP IM (RFC 6121): roster management (loading and pushes, with versioning and caching) -[+] XEP-0030: Service Discovery (replying to queries) -[+] XEP-0115: Entity Capabilities (including into initial presence) -[ ] XEP-0166: Jingle -[ ] XEP-0234: Jingle File Transfer -[ ] XEP-0261: Jingle In-Band Bytestreams Transport Method -[ ] XEP-0363: HTTP File Upload -[ ] XEP-0260: Jingle SOCKS5 Bytestreams Transport Method -[ ] XEP-0391: Jingle Encrypted Transports +[+] XEP-0030 v2.5: Service Discovery (replying to queries, recursively + searching for features) +[+] XEP-0115 v1.5: Entity Capabilities (including into initial presence) +[+] XEP-0092 v1.1: Software Version +[+] XEP-0172 v1.1: User Nickname +[+] XEP-0373 v0.6: OpenPGP for XMPP +[+] XEP-0402 v1.1: PEP Native Bookmarks +[+] XEP-0410 v1.1: MUC Self-Ping +[+] XEP-0363 v1.0: HTTP File Upload (when built with curl) +[+] XEP-0166 v1.1: Jingle +[+] XEP-0234 v0.19: Jingle File Transfer (sending and accepting, but + no requests and no ranged transfers) +[+] XEP-0261 v1.0: Jingle In-Band Bytestreams Transport Method +[+] XEP-0167 v1.2: Jingle RTP Sessions (uses PortAudio and Opus) +[+] XEP-0176 v1.1: Jingle ICE-UDP Transport Method (uses libnice, + discovers TURN/STUN servers with XEP-0215: External Service + Discovery) +[+] XEP-0320 v1.0: Use of DTLS-SRTP in Jingle Sessions +[ ] XEP-0260: Jingle SOCKS5 Bytestreams Transport Method? +[ ] XEP-0391: Jingle Encrypted Transports? [ ] XEP-0184: Message Delivery Receipts? -[ ] OpenPGP/OTR/OMEMO/MLS encryption? +[ ] OTR/OMEMO/MLS encryption? - Additional state tracking: -[ ] XMPP IM (RFC 6121): track presences of contacts. +[+] XMPP IM (RFC 6121): track presences of contacts. +[+] XEP-0163 v1.2: Personal Eventing Protocol: track contacts' + published items. +[+] IQ response caching. [ ] XEP-0030: Service Discovery: track features provided by known - entities. + entities? [ ] XEP-0115: Entity Capabilities: maintain a capability database, - track capabilities of known entities. -[ ] XEP-0045: Multi-User Chat: tracking of related states/presences. + track capabilities of known entities? +[ ] XEP-0045: Multi-User Chat: tracking of related states/presences? + +- Various utility functions: -- Various utility functions? +[+] Display name establishment. +[+] A console module. +[+] XEP-0060 v1.19: Publish-Subscribe: helper functions. - Examples and application: [+] Basic usage example. [.] WeeChat plugin. +[+] Emacs mode (and an XML-based interface). See emacs/README. |