2 * XMPP (Jabber) service for the Citadel system
3 * Copyright (c) 2007-2019 by Art Cancro and citadel.org
5 * This program is open source software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #include <sys/types.h>
30 #if TIME_WITH_SYS_TIME
31 # include <sys/time.h>
35 # include <sys/time.h>
45 #include <libcitadel.h>
49 #include "citserver.h"
55 #include "internet_addressing.h"
57 #include "ctdl_module.h"
58 #include "serv_xmpp.h"
60 /* uncomment for more verbosity - it will log all received XML tags */
61 // #define XMPP_XML_DEBUG
63 /* XML_StopParser is present in expat 2.x */
64 #if XML_MAJOR_VERSION > 1
65 #define HAVE_XML_STOPPARSER
68 struct xmpp_event *xmpp_queue = NULL;
70 #ifdef HAVE_XML_STOPPARSER
71 /* Stop the parser if an entity declaration is hit. */
72 static void xmpp_entity_declaration(void *userData, const XML_Char *entityName,
73 int is_parameter_entity, const XML_Char *value,
74 int value_length, const XML_Char *base,
75 const XML_Char *systemId, const XML_Char *publicId,
76 const XML_Char *notationName
78 syslog(LOG_WARNING, "xmpp: illegal entity declaration encountered; stopping parser.");
79 XML_StopParser(XMPP->xp, XML_FALSE);
85 * support function for xmlesc() which helps with UTF-8 strings
87 static inline int Ctdl_GetUtf8SequenceLength(const char *CharS, const char *CharE)
90 unsigned char test = (1<<7);
92 if ((*CharS & 0xC0) != 0xC0) {
96 while ((n < 8) && ((test & ((unsigned char)*CharS)) != 0)) {
100 if ((n > 6) || ((CharE - CharS) < n)) {
108 * Given a source string and a target buffer, returns the string
109 * properly escaped for insertion into an XML stream. Returns a
110 * pointer to the target buffer for convenience.
112 char *xmlesc(char *buf, char *str, int bufsiz)
120 if (!buf) return(NULL);
129 for (ptr=str; *ptr; ptr++) {
132 strcpy(&buf[len], "<");
135 else if (ch == '>') {
136 strcpy(&buf[len], ">");
139 else if (ch == '&') {
140 strcpy(&buf[len], "&");
143 else if ((ch >= 0x20) && (ch <= 0x7F)) {
147 else if (ch < 0x20) {
148 buf[len++] = '_'; // we probably shouldn't be doing this
152 IsUtf8Sequence = Ctdl_GetUtf8SequenceLength(ptr, pche);
155 while ((IsUtf8Sequence > 0) &&
166 sprintf(oct, "&#%o;", ch);
167 strcpy(&buf[len], oct);
171 if ((len + 6) > bufsiz) {
180 * We have just received a <stream> tag from the client, so send them ours
182 void xmpp_stream_start(void *data, const char *supplied_el, const char **attr)
187 if (!strcasecmp(attr[0], "to")) {
188 safestrncpy(XMPP->server_name, attr[1], sizeof XMPP->server_name);
193 cprintf("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
194 cprintf("<stream:stream ");
195 cprintf("from=\"%s\" ", xmlesc(xmlbuf, XMPP->server_name, sizeof xmlbuf));
196 cprintf("id=\"%08x\" ", CC->cs_pid);
197 cprintf("version=\"1.0\" ");
198 cprintf("xmlns:stream=\"http://etherx.jabber.org/streams\" ");
199 cprintf("xmlns=\"jabber:client\">");
201 /* The features of this stream are... */
202 cprintf("<stream:features>");
205 * TLS encryption (but only if it isn't already active)
208 if (!CC->redirect_ssl) {
209 cprintf("<starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'></starttls>");
213 if (!CC->logged_in) {
214 /* If we're not logged in yet, offer SASL as our feature set */
215 xmpp_output_auth_mechs();
217 /* Also offer non-SASL authentication */
218 cprintf("<auth xmlns=\"http://jabber.org/features/iq-auth\"/>");
221 /* Offer binding and sessions as part of our feature set */
222 cprintf("<bind xmlns=\"urn:ietf:params:xml:ns:xmpp-bind\"/>");
223 cprintf("<session xmlns=\"urn:ietf:params:xml:ns:xmpp-session\"/>");
224 cprintf("</stream:features>");
226 CC->is_async = 1; /* XMPP sessions are inherently async-capable */
230 void xmpp_xml_start(void *data, const char *supplied_el, const char **attr) {
235 /* Create a version of the element with the namespace removed.
236 * Now we can access "el" or "supplied_el" depending on whether we want to see the whole namespace.
238 safestrncpy(el, supplied_el, sizeof el);
239 while (sep = strchr(el, ':'), sep) {
243 #ifdef XMPP_XML_DEBUG
244 syslog(LOG_DEBUG, "xmpp: ELEMENT START: <%s>", el);
245 for (i=0; attr[i] != NULL; i+=2) {
246 syslog(LOG_DEBUG, "xmpp: Attribute '%s' = '%s'", attr[i], attr[i+1]);
250 if (!strcasecmp(el, "stream")) {
251 xmpp_stream_start(data, supplied_el, attr);
254 else if (!strcasecmp(el, "query")) {
255 XMPP->iq_query_xmlns[0] = 0;
256 safestrncpy(XMPP->iq_query_xmlns, supplied_el, sizeof XMPP->iq_query_xmlns);
259 else if (!strcasecmp(el, "bind")) {
260 XMPP->bind_requested = 1;
263 else if (!strcasecmp(el, "iq")) {
264 for (i=0; attr[i] != NULL; i+=2) {
265 if (!strcasecmp(attr[i], "type")) {
266 safestrncpy(XMPP->iq_type, attr[i+1], sizeof XMPP->iq_type);
268 else if (!strcasecmp(attr[i], "id")) {
269 safestrncpy(XMPP->iq_id, attr[i+1], sizeof XMPP->iq_id);
271 else if (!strcasecmp(attr[i], "from")) {
272 safestrncpy(XMPP->iq_from, attr[i+1], sizeof XMPP->iq_from);
274 else if (!strcasecmp(attr[i], "to")) {
275 safestrncpy(XMPP->iq_to, attr[i+1], sizeof XMPP->iq_to);
280 else if (!strcasecmp(el, "auth")) {
281 XMPP->sasl_auth_mech[0] = 0;
282 for (i=0; attr[i] != NULL; i+=2) {
283 if (!strcasecmp(attr[i], "mechanism")) {
284 safestrncpy(XMPP->sasl_auth_mech, attr[i+1], sizeof XMPP->sasl_auth_mech);
289 else if (!strcasecmp(el, "message")) {
290 for (i=0; attr[i] != NULL; i+=2) {
291 if (!strcasecmp(attr[i], "to")) {
292 safestrncpy(XMPP->message_to, attr[i+1], sizeof XMPP->message_to);
297 else if (!strcasecmp(el, "html")) {
298 ++XMPP->html_tag_level;
303 void xmpp_xml_end(void *data, const char *supplied_el) {
308 /* Create a version of the element with the namespace removed.
309 * Now we can access "el" or "supplied_el" depending on whether we want to see the whole namespace.
311 safestrncpy(el, supplied_el, sizeof el);
312 while (sep = strchr(el, ':'), sep) {
316 #ifdef XMPP_XML_DEBUG
317 syslog(LOG_DEBUG, "xmpp: ELEMENT END : <%s>", el);
318 if (XMPP->chardata_len > 0) {
319 syslog(LOG_DEBUG, "xmpp: chardata: %s", XMPP->chardata);
323 if (!strcasecmp(el, "resource")) {
324 if (XMPP->chardata_len > 0) {
325 safestrncpy(XMPP->iq_client_resource, XMPP->chardata, sizeof XMPP->iq_client_resource);
326 striplt(XMPP->iq_client_resource);
330 else if (!strcasecmp(el, "username")) { /* NON SASL ONLY */
331 if (XMPP->chardata_len > 0) {
332 safestrncpy(XMPP->iq_client_username, XMPP->chardata, sizeof XMPP->iq_client_username);
333 striplt(XMPP->iq_client_username);
337 else if (!strcasecmp(el, "password")) { /* NON SASL ONLY */
338 if (XMPP->chardata_len > 0) {
339 safestrncpy(XMPP->iq_client_password, XMPP->chardata, sizeof XMPP->iq_client_password);
340 striplt(XMPP->iq_client_password);
344 else if (!strcasecmp(el, "iq")) {
347 * iq type="get" (handle queries)
349 if (!strcasecmp(XMPP->iq_type, "get")) {
352 * Query on a namespace
354 if (!IsEmptyStr(XMPP->iq_query_xmlns)) {
355 xmpp_query_namespace(XMPP->iq_id, XMPP->iq_from, XMPP->iq_to, XMPP->iq_query_xmlns);
359 * ping ( http://xmpp.org/extensions/xep-0199.html )
361 else if (XMPP->ping_requested) {
362 cprintf("<iq type=\"result\" ");
363 if (!IsEmptyStr(XMPP->iq_from)) {
364 cprintf("to=\"%s\" ", xmlesc(xmlbuf, XMPP->iq_from, sizeof xmlbuf));
366 if (!IsEmptyStr(XMPP->iq_to)) {
367 cprintf("from=\"%s\" ", xmlesc(xmlbuf, XMPP->iq_to, sizeof xmlbuf));
369 cprintf("id=\"%s\"/>", xmlesc(xmlbuf, XMPP->iq_id, sizeof xmlbuf));
373 * Client is requesting its own vCard
374 * (If we make this more elaborate, move it to a separate function)
376 else if (XMPP->iq_vcard) {
377 cprintf("<iq type=\"result\" id=\"%s\" ", xmlesc(xmlbuf, XMPP->iq_id, sizeof xmlbuf));
378 cprintf("to=\"%s\">", xmlesc(xmlbuf, XMPP->iq_from, sizeof xmlbuf));
379 cprintf("<vCard xmlns=\"vcard-temp\">");
380 cprintf("<fn>%s</fn>", xmlesc(xmlbuf, CC->user.fullname, sizeof xmlbuf));
381 cprintf("<nickname>%s</nickname>", xmlesc(xmlbuf, CC->user.fullname, sizeof xmlbuf));
387 * Unknown query ... return the XML equivalent of a blank stare
390 syslog(LOG_DEBUG, "xmpp: Unknown query <%s> - returning <service-unavailable/>", el);
391 cprintf("<iq type=\"error\" id=\"%s\">", xmlesc(xmlbuf, XMPP->iq_id, sizeof xmlbuf));
392 cprintf("<error code=\"503\" type=\"cancel\">"
393 "<service-unavailable xmlns=\"urn:ietf:params:xml:ns:xmpp-stanzas\"/>"
401 * Non SASL authentication
404 (!strcasecmp(XMPP->iq_type, "set"))
405 && (!strcasecmp(XMPP->iq_query_xmlns, "jabber:iq:auth:query"))
407 xmpp_non_sasl_authenticate(XMPP->iq_id, XMPP->iq_client_username, XMPP->iq_client_password);
411 * If this <iq> stanza was a "bind" attempt, process it ...
414 (XMPP->bind_requested)
415 && (!IsEmptyStr(XMPP->iq_id))
418 /* If the client has not specified a client resource, generate one */
419 if (IsEmptyStr(XMPP->iq_client_resource)) {
420 snprintf(XMPP->iq_client_resource, sizeof XMPP->iq_client_resource, "%d", CC->cs_pid);
423 /* Generate the "full JID" of the client (user@host/resource) */
424 snprintf(XMPP->client_jid, sizeof XMPP->client_jid, "%s/%s", CC->cs_inet_email, XMPP->iq_client_resource);
426 /* Tell the client what its JID is */
427 cprintf("<iq type=\"result\" id=\"%s\">", xmlesc(xmlbuf, XMPP->iq_id, sizeof xmlbuf));
428 cprintf("<bind xmlns=\"urn:ietf:params:xml:ns:xmpp-bind\">");
429 cprintf("<jid>%s</jid>", xmlesc(xmlbuf, XMPP->client_jid, sizeof xmlbuf));
434 else if (XMPP->iq_session) {
435 cprintf("<iq type=\"result\" id=\"%s\">", xmlesc(xmlbuf, XMPP->iq_id, sizeof xmlbuf));
440 cprintf("<iq type=\"error\" id=\"%s\">", xmlesc(xmlbuf, XMPP->iq_id, sizeof xmlbuf));
441 cprintf("<error>Don't know how to do '%s'!</error>", xmlesc(xmlbuf, XMPP->iq_type, sizeof xmlbuf));
443 syslog(LOG_DEBUG, "XMPP: don't know how to do iq_type='%s' with iq_query_xmlns='%s'", XMPP->iq_type, XMPP->iq_query_xmlns);
446 /* Now clear these fields out so they don't get used by a future stanza */
448 XMPP->iq_from[0] = 0;
450 XMPP->iq_type[0] = 0;
451 XMPP->iq_client_resource[0] = 0;
452 XMPP->iq_session = 0;
454 XMPP->iq_query_xmlns[0] = 0;
455 XMPP->bind_requested = 0;
456 XMPP->ping_requested = 0;
459 else if (!strcasecmp(el, "auth")) {
460 /* Try to authenticate (this function is responsible for the output stanza) */
461 xmpp_sasl_auth(XMPP->sasl_auth_mech, (XMPP->chardata != NULL ? XMPP->chardata : "") );
463 /* Now clear these fields out so they don't get used by a future stanza */
464 XMPP->sasl_auth_mech[0] = 0;
467 else if (!strcasecmp(el, "session")) {
468 XMPP->iq_session = 1;
471 else if (!strcasecmp(supplied_el, "vcard-temp:vCard")) {
475 else if (!strcasecmp(el, "presence")) {
476 /* Respond to a <presence> update by firing back with presence information
477 * on the entire wholist. Check this assumption, it's probably wrong.
479 xmpp_wholist_presence_dump();
482 else if ( (!strcasecmp(el, "body")) && (XMPP->html_tag_level == 0) ) {
483 if (XMPP->message_body != NULL) {
484 free(XMPP->message_body);
485 XMPP->message_body = NULL;
487 if (XMPP->chardata_len > 0) {
488 XMPP->message_body = strdup(XMPP->chardata);
492 else if (!strcasecmp(el, "message")) {
493 xmpp_send_message(XMPP->message_to, XMPP->message_body);
494 XMPP->html_tag_level = 0;
497 else if (!strcasecmp(el, "html")) {
498 --XMPP->html_tag_level;
501 else if (!strcasecmp(el, "starttls")) {
503 cprintf("<proceed xmlns='urn:ietf:params:xml:ns:xmpp-tls'/>");
504 CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
505 if (!CC->redirect_ssl) CC->kill_me = KILLME_NO_CRYPTO;
507 cprintf("<failure xmlns='urn:ietf:params:xml:ns:xmpp-tls'/>");
508 CC->kill_me = KILLME_NO_CRYPTO;
512 else if (!strcasecmp(el, "ping")) {
513 XMPP->ping_requested = 1;
516 else if (!strcasecmp(el, "stream")) {
517 syslog(LOG_DEBUG, "xmpp: client shut down their stream");
518 xmpp_massacre_roster();
519 cprintf("</stream>\n");
520 CC->kill_me = KILLME_CLIENT_LOGGED_OUT;
523 else if (!strcasecmp(el, "query")) {
524 /* already processed , no further action needed here */
527 else if (!strcasecmp(el, "bind")) {
528 /* already processed , no further action needed here */
532 syslog(LOG_DEBUG, "xmpp: ignoring unknown tag <%s>", el);
535 XMPP->chardata_len = 0;
536 if (XMPP->chardata_alloc > 0) {
537 XMPP->chardata[0] = 0;
542 void xmpp_xml_chardata(void *data, const XML_Char *s, int len)
546 if (X->chardata_alloc == 0) {
547 X->chardata_alloc = SIZ;
548 X->chardata = malloc(X->chardata_alloc);
550 if ((X->chardata_len + len + 1) > X->chardata_alloc) {
551 X->chardata_alloc = X->chardata_len + len + 1024;
552 X->chardata = realloc(X->chardata, X->chardata_alloc);
554 memcpy(&X->chardata[X->chardata_len], s, len);
555 X->chardata_len += len;
556 X->chardata[X->chardata_len] = 0;
561 * This cleanup function blows away the temporary memory and files used by the XMPP service.
563 void xmpp_cleanup_function(void) {
565 /* Don't do this stuff if this is not a XMPP session! */
566 if (CC->h_command_function != xmpp_command_loop) return;
568 if (XMPP->chardata != NULL) {
569 free(XMPP->chardata);
570 XMPP->chardata = NULL;
571 XMPP->chardata_len = 0;
572 XMPP->chardata_alloc = 0;
573 if (XMPP->message_body != NULL) {
574 free(XMPP->message_body);
577 XML_ParserFree(XMPP->xp);
583 * Here's where our XMPP session begins its happy day.
585 void xmpp_greeting(void) {
586 client_set_inbound_buf(4);
587 strcpy(CC->cs_clientname, "XMPP session");
588 CC->session_specific_data = malloc(sizeof(citxmpp));
589 memset(XMPP, 0, sizeof(citxmpp));
590 XMPP->last_event_processed = queue_event_seq;
592 /* XMPP does not use a greeting, but we still have to initialize some things. */
594 XMPP->xp = XML_ParserCreateNS("UTF-8", ':');
595 if (XMPP->xp == NULL) {
596 syslog(LOG_ERR, "xmpp: cannot create XML parser");
597 CC->kill_me = KILLME_XML_PARSER;
601 XML_SetElementHandler(XMPP->xp, xmpp_xml_start, xmpp_xml_end);
602 XML_SetCharacterDataHandler(XMPP->xp, xmpp_xml_chardata);
603 // XML_SetUserData(XMPP->xp, something...);
605 /* Prevent the "billion laughs" attack against expat by disabling
606 * internal entity expansion. With 2.x, forcibly stop the parser
607 * if an entity is declared - this is safer and a more obvious
608 * failure mode. With older versions, simply prevent expansion
609 * of such entities. */
610 #ifdef HAVE_XML_STOPPARSER
611 XML_SetEntityDeclHandler(XMPP->xp, xmpp_entity_declaration);
613 XML_SetDefaultHandler(XMPP->xp, NULL);
616 CC->can_receive_im = 1; /* This protocol is capable of receiving instant messages */
621 * Main command loop for XMPP sessions.
623 void xmpp_command_loop(void) {
625 StrBuf *stream_input = NewStrBuf();
628 rc = client_read_random_blob(stream_input, 30);
630 XML_Parse(XMPP->xp, ChrPtr(stream_input), rc, 0);
633 syslog(LOG_ERR, "xmpp: client disconnected: ending session.");
634 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
636 FreeStrBuf(&stream_input);
641 * Async loop for XMPP sessions (handles the transmission of unsolicited stanzas)
643 void xmpp_async_loop(void) {
644 xmpp_process_events();
645 xmpp_output_incoming_messages();
650 * Login hook for XMPP sessions
652 void xmpp_login_hook(void) {
653 xmpp_queue_event(XMPP_EVT_LOGIN, CC->cs_inet_email);
658 * Logout hook for XMPP sessions
660 void xmpp_logout_hook(void) {
661 xmpp_queue_event(XMPP_EVT_LOGOUT, CC->cs_inet_email);
665 const char *CitadelServiceXMPP="XMPP";
666 extern void xmpp_cleanup_events(void);
667 CTDL_MODULE_INIT(xmpp)
670 CtdlRegisterServiceHook(CtdlGetConfigInt("c_xmpp_c2s_port"),
677 CtdlRegisterSessionHook(xmpp_cleanup_function, EVT_STOP, PRIO_STOP + 70);
678 CtdlRegisterSessionHook(xmpp_login_hook, EVT_LOGIN, PRIO_LOGIN + 90);
679 CtdlRegisterSessionHook(xmpp_logout_hook, EVT_LOGOUT, PRIO_LOGOUT + 90);
680 CtdlRegisterSessionHook(xmpp_login_hook, EVT_UNSTEALTH, PRIO_UNSTEALTH + 1);
681 CtdlRegisterSessionHook(xmpp_logout_hook, EVT_STEALTH, PRIO_STEALTH + 1);
682 CtdlRegisterCleanupHook(xmpp_cleanup_events);
686 /* return our module name for the log */