4 * XMPP (Jabber) service for the Citadel system
5 * Copyright (c) 2007-2010 by Art Cancro
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 #include <sys/types.h>
32 #if TIME_WITH_SYS_TIME
33 # include <sys/time.h>
37 # include <sys/time.h>
47 #include <libcitadel.h>
51 #include "citserver.h"
57 #include "internet_addressing.h"
59 #include "ctdl_module.h"
60 #include "serv_xmpp.h"
62 struct xmpp_event *xmpp_queue = NULL;
64 /* We have just received a <stream> tag from the client, so send them ours */
66 void xmpp_stream_start(void *data, const char *supplied_el, const char **attr)
69 if (!strcasecmp(attr[0], "to")) {
70 safestrncpy(XMPP->server_name, attr[1], sizeof XMPP->server_name);
75 cprintf("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
77 cprintf("<stream:stream ");
78 cprintf("from=\"%s\" ", XMPP->server_name);
79 cprintf("id=\"%08x\" ", CC->cs_pid);
80 cprintf("version=\"1.0\" ");
81 cprintf("xmlns:stream=\"http://etherx.jabber.org/streams\" ");
82 cprintf("xmlns=\"jabber:client\">");
84 /* The features of this stream are... */
85 cprintf("<stream:features>");
87 #ifdef HAVE_OPENSSL_XXXX_COMMENTED_OUT
88 /* TLS encryption (but only if it isn't already active) */
89 if (!CC->redirect_ssl) {
90 cprintf("<starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'></starttls>");
95 /* If we're not logged in yet, offer SASL as our feature set */
96 xmpp_output_auth_mechs();
98 /* Also offer non-SASL authentication */
99 cprintf("<auth xmlns=\"http://jabber.org/features/iq-auth\"/>");
102 /* Offer binding and sessions as part of our feature set */
103 cprintf("<bind xmlns=\"urn:ietf:params:xml:ns:xmpp-bind\"/>");
104 cprintf("<session xmlns=\"urn:ietf:params:xml:ns:xmpp-session\"/>");
106 cprintf("</stream:features>");
108 CC->is_async = 1; /* XMPP sessions are inherently async-capable */
112 void xmpp_xml_start(void *data, const char *supplied_el, const char **attr) {
117 /* Axe the namespace, we don't care about it */
118 safestrncpy(el, supplied_el, sizeof el);
119 while (sep = strchr(el, ':'), sep) {
124 CtdlLogPrintf(CTDL_DEBUG, "XMPP ELEMENT START: <%s>\n", el);
125 for (i=0; attr[i] != NULL; i+=2) {
126 CtdlLogPrintf(CTDL_DEBUG, " Attribute '%s' = '%s'\n", attr[i], attr[i+1]);
128 uncomment for more verbosity */
130 if (!strcasecmp(el, "stream")) {
131 xmpp_stream_start(data, supplied_el, attr);
134 else if (!strcasecmp(el, "query")) {
135 XMPP->iq_query_xmlns[0] = 0;
136 safestrncpy(XMPP->iq_query_xmlns, supplied_el, sizeof XMPP->iq_query_xmlns);
139 else if (!strcasecmp(el, "bind")) {
140 XMPP->bind_requested = 1;
143 else if (!strcasecmp(el, "iq")) {
144 for (i=0; attr[i] != NULL; i+=2) {
145 if (!strcasecmp(attr[i], "type")) {
146 safestrncpy(XMPP->iq_type, attr[i+1], sizeof XMPP->iq_type);
148 else if (!strcasecmp(attr[i], "id")) {
149 safestrncpy(XMPP->iq_id, attr[i+1], sizeof XMPP->iq_id);
151 else if (!strcasecmp(attr[i], "from")) {
152 safestrncpy(XMPP->iq_from, attr[i+1], sizeof XMPP->iq_from);
154 else if (!strcasecmp(attr[i], "to")) {
155 safestrncpy(XMPP->iq_to, attr[i+1], sizeof XMPP->iq_to);
160 else if (!strcasecmp(el, "auth")) {
161 XMPP->sasl_auth_mech[0] = 0;
162 for (i=0; attr[i] != NULL; i+=2) {
163 if (!strcasecmp(attr[i], "mechanism")) {
164 safestrncpy(XMPP->sasl_auth_mech, attr[i+1], sizeof XMPP->sasl_auth_mech);
169 else if (!strcasecmp(el, "message")) {
170 for (i=0; attr[i] != NULL; i+=2) {
171 if (!strcasecmp(attr[i], "to")) {
172 safestrncpy(XMPP->message_to, attr[i+1], sizeof XMPP->message_to);
177 else if (!strcasecmp(el, "html")) {
178 ++XMPP->html_tag_level;
184 void xmpp_xml_end(void *data, const char *supplied_el) {
188 /* Axe the namespace, we don't care about it */
189 safestrncpy(el, supplied_el, sizeof el);
190 while (sep = strchr(el, ':'), sep) {
195 CtdlLogPrintf(CTDL_DEBUG, "XMPP ELEMENT END : <%s>\n", el);
196 if (XMPP->chardata_len > 0) {
197 CtdlLogPrintf(CTDL_DEBUG, " chardata: %s\n", XMPP->chardata);
199 uncomment for more verbosity */
201 if (!strcasecmp(el, "resource")) {
202 if (XMPP->chardata_len > 0) {
203 safestrncpy(XMPP->iq_client_resource, XMPP->chardata,
204 sizeof XMPP->iq_client_resource);
205 striplt(XMPP->iq_client_resource);
209 else if (!strcasecmp(el, "username")) { /* NON SASL ONLY */
210 if (XMPP->chardata_len > 0) {
211 safestrncpy(XMPP->iq_client_username, XMPP->chardata,
212 sizeof XMPP->iq_client_username);
213 striplt(XMPP->iq_client_username);
217 else if (!strcasecmp(el, "password")) { /* NON SASL ONLY */
218 if (XMPP->chardata_len > 0) {
219 safestrncpy(XMPP->iq_client_password, XMPP->chardata,
220 sizeof XMPP->iq_client_password);
221 striplt(XMPP->iq_client_password);
225 else if (!strcasecmp(el, "iq")) {
228 * iq type="get" (handle queries)
230 if (!strcasecmp(XMPP->iq_type, "get")) {
233 * Query on a namespace
235 if (!IsEmptyStr(XMPP->iq_query_xmlns)) {
236 xmpp_query_namespace(XMPP->iq_id, XMPP->iq_from,
237 XMPP->iq_to, XMPP->iq_query_xmlns);
241 * ping ( http://xmpp.org/extensions/xep-0199.html )
243 else if (XMPP->ping_requested) {
244 cprintf("<iq type=\"result\" ");
245 if (!IsEmptyStr(XMPP->iq_from)) {
246 cprintf("to=\"%s\" ", XMPP->iq_from);
248 if (!IsEmptyStr(XMPP->iq_to)) {
249 cprintf("from=\"%s\" ", XMPP->iq_to);
251 cprintf("id=\"%s\"/>", XMPP->iq_id);
255 * Unknown query ... return the XML equivalent of a blank stare
258 CtdlLogPrintf(CTDL_DEBUG,
259 "Unknown query <%s> - returning <service-unavailable/>\n",
262 cprintf("<iq type=\"error\" id=\"%s\">", XMPP->iq_id);
263 cprintf("<error code=\"503\" type=\"cancel\">"
264 "<service-unavailable xmlns=\"urn:ietf:params:xml:ns:xmpp-stanzas\"/>"
272 * Non SASL authentication
275 (!strcasecmp(XMPP->iq_type, "set"))
276 && (!strcasecmp(XMPP->iq_query_xmlns, "jabber:iq:auth:query"))
279 xmpp_non_sasl_authenticate(
281 XMPP->iq_client_username,
282 XMPP->iq_client_password,
283 XMPP->iq_client_resource
288 * If this <iq> stanza was a "bind" attempt, process it ...
291 (XMPP->bind_requested)
292 && (!IsEmptyStr(XMPP->iq_id))
293 && (!IsEmptyStr(XMPP->iq_client_resource))
297 /* Generate the "full JID" of the client resource */
299 snprintf(XMPP->client_jid, sizeof XMPP->client_jid,
302 XMPP->iq_client_resource
305 /* Tell the client what its JID is */
307 cprintf("<iq type=\"result\" id=\"%s\">", XMPP->iq_id);
308 cprintf("<bind xmlns=\"urn:ietf:params:xml:ns:xmpp-bind\">");
309 cprintf("<jid>%s</jid>", XMPP->client_jid);
314 else if (XMPP->iq_session) {
315 cprintf("<iq type=\"result\" id=\"%s\">", XMPP->iq_id);
320 cprintf("<iq type=\"error\" id=\"%s\">", XMPP->iq_id);
321 cprintf("<error>Don't know howto do '%s'!</error>", XMPP->iq_type);
325 /* Now clear these fields out so they don't get used by a future stanza */
327 XMPP->iq_from[0] = 0;
329 XMPP->iq_type[0] = 0;
330 XMPP->iq_client_resource[0] = 0;
331 XMPP->iq_session = 0;
332 XMPP->iq_query_xmlns[0] = 0;
333 XMPP->bind_requested = 0;
334 XMPP->ping_requested = 0;
337 else if (!strcasecmp(el, "auth")) {
339 /* Try to authenticate (this function is responsible for the output stanza) */
340 xmpp_sasl_auth(XMPP->sasl_auth_mech, (XMPP->chardata != NULL ? XMPP->chardata : "") );
342 /* Now clear these fields out so they don't get used by a future stanza */
343 XMPP->sasl_auth_mech[0] = 0;
346 else if (!strcasecmp(el, "session")) {
347 XMPP->iq_session = 1;
350 else if (!strcasecmp(el, "presence")) {
352 /* Respond to a <presence> update by firing back with presence information
353 * on the entire wholist. Check this assumption, it's probably wrong.
355 xmpp_wholist_presence_dump();
358 else if ( (!strcasecmp(el, "body")) && (XMPP->html_tag_level == 0) ) {
359 if (XMPP->message_body != NULL) {
360 free(XMPP->message_body);
361 XMPP->message_body = NULL;
363 if (XMPP->chardata_len > 0) {
364 XMPP->message_body = strdup(XMPP->chardata);
368 else if (!strcasecmp(el, "message")) {
369 xmpp_send_message(XMPP->message_to, XMPP->message_body);
370 XMPP->html_tag_level = 0;
373 else if (!strcasecmp(el, "html")) {
374 --XMPP->html_tag_level;
377 else if (!strcasecmp(el, "starttls")) {
379 cprintf("<proceed xmlns='urn:ietf:params:xml:ns:xmpp-tls'/>");
380 CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
381 if (!CC->redirect_ssl) CC->kill_me = 1;
383 cprintf("<failure xmlns='urn:ietf:params:xml:ns:xmpp-tls'/>");
388 else if (!strcasecmp(el, "ping")) {
389 XMPP->ping_requested = 1;
392 else if (!strcasecmp(el, "stream")) {
393 CtdlLogPrintf(CTDL_DEBUG, "XMPP client shut down their stream\n");
394 xmpp_massacre_roster();
395 cprintf("</stream>\n");
400 CtdlLogPrintf(CTDL_DEBUG, "Ignoring unknown tag <%s>\n", el);
403 XMPP->chardata_len = 0;
404 if (XMPP->chardata_alloc > 0) {
405 XMPP->chardata[0] = 0;
410 void xmpp_xml_chardata(void *data, const XML_Char *s, int len)
412 struct citxmpp *X = XMPP;
414 if (X->chardata_alloc == 0) {
415 X->chardata_alloc = SIZ;
416 X->chardata = malloc(X->chardata_alloc);
418 if ((X->chardata_len + len + 1) > X->chardata_alloc) {
419 X->chardata_alloc = X->chardata_len + len + 1024;
420 X->chardata = realloc(X->chardata, X->chardata_alloc);
422 memcpy(&X->chardata[X->chardata_len], s, len);
423 X->chardata_len += len;
424 X->chardata[X->chardata_len] = 0;
429 * This cleanup function blows away the temporary memory and files used by the XMPP service.
431 void xmpp_cleanup_function(void) {
433 /* Don't do this stuff if this is not a XMPP session! */
434 if (CC->h_command_function != xmpp_command_loop) return;
436 if (XMPP->chardata != NULL) {
437 free(XMPP->chardata);
438 XMPP->chardata = NULL;
439 XMPP->chardata_len = 0;
440 XMPP->chardata_alloc = 0;
441 if (XMPP->message_body != NULL) {
442 free(XMPP->message_body);
445 XML_ParserFree(XMPP->xp);
452 * Here's where our XMPP session begins its happy day.
454 void xmpp_greeting(void) {
455 strcpy(CC->cs_clientname, "XMPP session");
456 CC->session_specific_data = malloc(sizeof(struct citxmpp));
457 memset(XMPP, 0, sizeof(struct citxmpp));
458 XMPP->last_event_processed = queue_event_seq;
460 /* XMPP does not use a greeting, but we still have to initialize some things. */
462 XMPP->xp = XML_ParserCreateNS("UTF-8", ':');
463 if (XMPP->xp == NULL) {
464 CtdlLogPrintf(CTDL_ALERT, "Cannot create XML parser!\n");
469 XML_SetElementHandler(XMPP->xp, xmpp_xml_start, xmpp_xml_end);
470 XML_SetCharacterDataHandler(XMPP->xp, xmpp_xml_chardata);
471 // XML_SetUserData(XMPP->xp, something...);
473 CC->can_receive_im = 1; /* This protocol is capable of receiving instant messages */
478 * Main command loop for XMPP sessions.
480 void xmpp_command_loop(void) {
485 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
486 retval = client_read(cmdbuf, 1);
488 CtdlLogPrintf(CTDL_ERR, "Client disconnected: ending session.\r\n");
493 /* FIXME ... this is woefully inefficient. */
495 XML_Parse(XMPP->xp, cmdbuf, 1, 0);
500 * Async loop for XMPP sessions (handles the transmission of unsolicited stanzas)
502 void xmpp_async_loop(void) {
503 xmpp_process_events();
504 xmpp_output_incoming_messages();
509 * Login hook for XMPP sessions
511 void xmpp_login_hook(void) {
512 xmpp_queue_event(XMPP_EVT_LOGIN, CC->cs_inet_email);
513 xmpp_delete_old_buddies_who_no_longer_exist_from_the_client_roster();
518 * Logout hook for XMPP sessions
520 void xmpp_logout_hook(void) {
521 xmpp_queue_event(XMPP_EVT_LOGOUT, CC->cs_inet_email);
525 const char *CitadelServiceXMPP="XMPP";
527 CTDL_MODULE_INIT(xmpp)
530 CtdlRegisterServiceHook(config.c_xmpp_c2s_port,
536 CtdlRegisterSessionHook(xmpp_cleanup_function, EVT_STOP);
537 CtdlRegisterSessionHook(xmpp_login_hook, EVT_LOGIN);
538 CtdlRegisterSessionHook(xmpp_logout_hook, EVT_LOGOUT);
539 CtdlRegisterSessionHook(xmpp_login_hook, EVT_UNSTEALTH);
540 CtdlRegisterSessionHook(xmpp_logout_hook, EVT_STEALTH);
543 /* return our Subversion id for the Log */