stable now but there are GIANT PIECES MISSING
[citadel.git] / citadel / modules / xmpp / serv_xmpp.c
index 7986cb573fdb254de00bac8f1684f79cff2896e6..dfb895274e83c9353241db35664accbcc07a322e 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * XMPP (Jabber) service for the Citadel system
- * Copyright (c) 2007-2011 by Art Cancro
+ * Copyright (c) 2007-2021 by Art Cancro and citadel.org
  *
  * This program is open source software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
 #include <pwd.h>
 #include <errno.h>
 #include <sys/types.h>
-
-#if TIME_WITH_SYS_TIME
-# include <sys/time.h>
-# include <time.h>
-#else
-# if HAVE_SYS_TIME_H
-#  include <sys/time.h>
-# else
-#  include <time.h>
-# endif
-#endif
-
+#include <time.h>
 #include <sys/wait.h>
 #include <string.h>
 #include <limits.h>
 #include "database.h"
 #include "msgbase.h"
 #include "internet_addressing.h"
-#include "md5.h"
 #include "ctdl_module.h"
 #include "serv_xmpp.h"
 
+/* uncomment for more verbosity - it will log all received XML tags */
+// #define XMPP_XML_DEBUG
+
 /* XML_StopParser is present in expat 2.x */
 #if XML_MAJOR_VERSION > 1
 #define HAVE_XML_STOPPARSER
 
 struct xmpp_event *xmpp_queue = NULL;
 
-int XMPPSrvDebugEnable = 0;
-
-
-
 #ifdef HAVE_XML_STOPPARSER
 /* Stop the parser if an entity declaration is hit. */
 static void xmpp_entity_declaration(void *userData, const XML_Char *entityName,
@@ -76,28 +63,31 @@ static void xmpp_entity_declaration(void *userData, const XML_Char *entityName,
                                const XML_Char *systemId, const XML_Char *publicId,
                                const XML_Char *notationName
 ) {
-       XMPPM_syslog(LOG_WARNING, "Illegal entity declaration encountered; stopping parser.");
+       syslog(LOG_WARNING, "xmpp: illegal entity declaration encountered; stopping parser.");
        XML_StopParser(XMPP->xp, XML_FALSE);
 }
 #endif
 
-static inline int XMPP_GetUtf8SequenceLength(const char *CharS, const char *CharE)
+
+/*
+ * support function for xmlesc() which helps with UTF-8 strings
+ */
+static inline int Ctdl_GetUtf8SequenceLength(const char *CharS, const char *CharE)
 {
-       /* if this is is migrated to strbuf, remove this copy. */
        int n = 0;
         unsigned char test = (1<<7);
 
-       if ((*CharS & 0xC0) != 0xC0) 
+       if ((*CharS & 0xC0) != 0xC0) {
                return 1;
+       }
 
-       while ((n < 8) && 
-              ((test & ((unsigned char)*CharS)) != 0)) 
-       {
+       while ((n < 8) && ((test & ((unsigned char)*CharS)) != 0))  {
                test = test >> 1;
                n ++;
        }
-       if ((n > 6) || ((CharE - CharS) < n))
+       if ((n > 6) || ((CharE - CharS) < n)) {
                n = 0;
+       }
        return n;
 }
 
@@ -106,17 +96,14 @@ static inline int XMPP_GetUtf8SequenceLength(const char *CharS, const char *Char
  * Given a source string and a target buffer, returns the string
  * properly escaped for insertion into an XML stream.  Returns a
  * pointer to the target buffer for convenience.
- *
- * BUG: this does not properly handle UTF-8
  */
 char *xmlesc(char *buf, char *str, int bufsiz)
 {
-       char *ptr;
-       char *eiptr;
+       int IsUtf8Sequence;
+       char *ptr, *pche;
        unsigned char ch;
        int inlen;
        int len = 0;
-       int IsUtf8Sequence;
 
        if (!buf) return(NULL);
        buf[0] = 0;
@@ -124,9 +111,8 @@ char *xmlesc(char *buf, char *str, int bufsiz)
        if (!str) {
                return(buf);
        }
-
        inlen = strlen(str);
-       eiptr = str + inlen;
+       pche = str + inlen;
 
        for (ptr=str; *ptr; ptr++) {
                ch = *ptr;
@@ -147,26 +133,24 @@ char *xmlesc(char *buf, char *str, int bufsiz)
                        buf[len] = 0;
                }
                else if (ch < 0x20) {
-                       /* we probably shouldn't be doing this */
-                       buf[len++] = '_';
+                       buf[len++] = '_';       // we probably shouldn't be doing this
                        buf[len] = 0;
                }
                else {
-                       char oct[32];
-
-                       IsUtf8Sequence =  XMPP_GetUtf8SequenceLength(&buf[len], eiptr);
+                       IsUtf8Sequence =  Ctdl_GetUtf8SequenceLength(ptr, pche);
                        if (IsUtf8Sequence)
                        {
-                               while (IsUtf8Sequence > 0){
+                               while ((IsUtf8Sequence > 0) && 
+                                      (ptr < pche))
+                               {
                                        buf[len] = *ptr;
-                                       len ++;
-                                       if (--IsUtf8Sequence)
-                                               ptr++;
+                                       ptr ++;
+                                       --IsUtf8Sequence;
                                }
-                               buf[len] = '\0';
                        }
                        else
                        {
+                               char oct[10];
                                sprintf(oct, "&#%o;", ch);
                                strcpy(&buf[len], oct);
                                len += strlen(oct);
@@ -195,7 +179,6 @@ void xmpp_stream_start(void *data, const char *supplied_el, const char **attr)
        }
 
        cprintf("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
-
        cprintf("<stream:stream ");
        cprintf("from=\"%s\" ", xmlesc(xmlbuf, XMPP->server_name, sizeof xmlbuf));
        cprintf("id=\"%08x\" ", CC->cs_pid);
@@ -208,13 +191,13 @@ void xmpp_stream_start(void *data, const char *supplied_el, const char **attr)
 
        /*
         * TLS encryption (but only if it isn't already active)
-        * 
+        */ 
 #ifdef HAVE_OPENSSL
        if (!CC->redirect_ssl) {
                cprintf("<starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'></starttls>");
        }
 #endif
-       */
+
        if (!CC->logged_in) {
                /* If we're not logged in yet, offer SASL as our feature set */
                xmpp_output_auth_mechs();
@@ -226,7 +209,6 @@ void xmpp_stream_start(void *data, const char *supplied_el, const char **attr)
        /* Offer binding and sessions as part of our feature set */
        cprintf("<bind xmlns=\"urn:ietf:params:xml:ns:xmpp-bind\"/>");
        cprintf("<session xmlns=\"urn:ietf:params:xml:ns:xmpp-session\"/>");
-
        cprintf("</stream:features>");
 
        CC->is_async = 1;               /* XMPP sessions are inherently async-capable */
@@ -238,18 +220,20 @@ void xmpp_xml_start(void *data, const char *supplied_el, const char **attr) {
        char *sep = NULL;
        int i;
 
-       /* Axe the namespace, we don't care about it */
+       /* Create a version of the element with the namespace removed.
+        * Now we can access "el" or "supplied_el" depending on whether we want to see the whole namespace.
+        */
        safestrncpy(el, supplied_el, sizeof el);
        while (sep = strchr(el, ':'), sep) {
                strcpy(el, ++sep);
        }
 
-       /*
-       XMPP_syslog(LOG_DEBUG, "XMPP ELEMENT START: <%s>\n", el);
+#ifdef XMPP_XML_DEBUG
+       syslog(LOG_DEBUG, "xmpp: ELEMENT START: <%s>", el);
        for (i=0; attr[i] != NULL; i+=2) {
-               XMPP_syslog(LOG_DEBUG, "                    Attribute '%s' = '%s'\n", attr[i], attr[i+1]);
+               syslog(LOG_DEBUG, "xmpp: Attribute '%s' = '%s'", attr[i], attr[i+1]);
        }
-       uncomment for more verbosity */
+#endif
 
        if (!strcasecmp(el, "stream")) {
                xmpp_stream_start(data, supplied_el, attr);
@@ -304,45 +288,43 @@ void xmpp_xml_start(void *data, const char *supplied_el, const char **attr) {
 }
 
 
-
 void xmpp_xml_end(void *data, const char *supplied_el) {
        char el[256];
        char *sep = NULL;
        char xmlbuf[256];
 
-       /* Axe the namespace, we don't care about it */
+       /* Create a version of the element with the namespace removed.
+        * Now we can access "el" or "supplied_el" depending on whether we want to see the whole namespace.
+        */
        safestrncpy(el, supplied_el, sizeof el);
        while (sep = strchr(el, ':'), sep) {
                strcpy(el, ++sep);
        }
 
-       /*
-       XMPP_syslog(LOG_DEBUG, "XMPP ELEMENT END  : <%s>\n", el);
+#ifdef XMPP_XML_DEBUG
+       syslog(LOG_DEBUG, "xmpp: ELEMENT END  : <%s>", el);
        if (XMPP->chardata_len > 0) {
-               XMPP_syslog(LOG_DEBUG, "          chardata: %s\n", XMPP->chardata);
+               syslog(LOG_DEBUG, "xmpp: chardata: %s", XMPP->chardata);
        }
-       uncomment for more verbosity */
+#endif
 
        if (!strcasecmp(el, "resource")) {
                if (XMPP->chardata_len > 0) {
-                       safestrncpy(XMPP->iq_client_resource, XMPP->chardata,
-                               sizeof XMPP->iq_client_resource);
+                       safestrncpy(XMPP->iq_client_resource, XMPP->chardata, sizeof XMPP->iq_client_resource);
                        striplt(XMPP->iq_client_resource);
                }
        }
 
        else if (!strcasecmp(el, "username")) {         /* NON SASL ONLY */
                if (XMPP->chardata_len > 0) {
-                       safestrncpy(XMPP->iq_client_username, XMPP->chardata,
-                               sizeof XMPP->iq_client_username);
+                       safestrncpy(XMPP->iq_client_username, XMPP->chardata, sizeof XMPP->iq_client_username);
                        striplt(XMPP->iq_client_username);
                }
        }
 
        else if (!strcasecmp(el, "password")) {         /* NON SASL ONLY */
                if (XMPP->chardata_len > 0) {
-                       safestrncpy(XMPP->iq_client_password, XMPP->chardata,
-                               sizeof XMPP->iq_client_password);
+                       safestrncpy(XMPP->iq_client_password, XMPP->chardata, sizeof XMPP->iq_client_password);
                        striplt(XMPP->iq_client_password);
                }
        }
@@ -358,8 +340,7 @@ void xmpp_xml_end(void *data, const char *supplied_el) {
                         * Query on a namespace
                         */
                        if (!IsEmptyStr(XMPP->iq_query_xmlns)) {
-                               xmpp_query_namespace(XMPP->iq_id, XMPP->iq_from,
-                                               XMPP->iq_to, XMPP->iq_query_xmlns);
+                               xmpp_query_namespace(XMPP->iq_id, XMPP->iq_from, XMPP->iq_to, XMPP->iq_query_xmlns);
                        }
 
                        /*
@@ -376,14 +357,25 @@ void xmpp_xml_end(void *data, const char *supplied_el) {
                                cprintf("id=\"%s\"/>", xmlesc(xmlbuf, XMPP->iq_id, sizeof xmlbuf));
                        }
 
+                       /*
+                        * Client is requesting its own vCard
+                        * (If we make this more elaborate, move it to a separate function)
+                        */
+                       else if (XMPP->iq_vcard) {
+                               cprintf("<iq type=\"result\" id=\"%s\" ", xmlesc(xmlbuf, XMPP->iq_id, sizeof xmlbuf));
+                               cprintf("to=\"%s\">", xmlesc(xmlbuf, XMPP->iq_from, sizeof xmlbuf));
+                               cprintf("<vCard xmlns=\"vcard-temp\">");
+                               cprintf("<fn>%s</fn>", xmlesc(xmlbuf, CC->user.fullname, sizeof xmlbuf));
+                               cprintf("<nickname>%s</nickname>", xmlesc(xmlbuf, CC->user.fullname, sizeof xmlbuf));
+                               cprintf("</vCard>");
+                               cprintf("</iq>");
+                       }
+
                        /*
                         * Unknown query ... return the XML equivalent of a blank stare
                         */
                        else {
-                               XMPP_syslog(LOG_DEBUG,
-                                           "Unknown query <%s> - returning <service-unavailable/>\n",
-                                           el
-                               );
+                               syslog(LOG_DEBUG, "xmpp: Unknown query <%s> - returning <service-unavailable/>", el);
                                cprintf("<iq type=\"error\" id=\"%s\">", xmlesc(xmlbuf, XMPP->iq_id, sizeof xmlbuf));
                                cprintf("<error code=\"503\" type=\"cancel\">"
                                        "<service-unavailable xmlns=\"urn:ietf:params:xml:ns:xmpp-stanzas\"/>"
@@ -399,14 +391,8 @@ void xmpp_xml_end(void *data, const char *supplied_el) {
                else if (
                        (!strcasecmp(XMPP->iq_type, "set"))
                        && (!strcasecmp(XMPP->iq_query_xmlns, "jabber:iq:auth:query"))
-                       ) {
-
-                       xmpp_non_sasl_authenticate(
-                               XMPP->iq_id,
-                               XMPP->iq_client_username,
-                               XMPP->iq_client_password,
-                               XMPP->iq_client_resource
-                       );
+               ) {
+                       xmpp_non_sasl_authenticate(XMPP->iq_id, XMPP->iq_client_username, XMPP->iq_client_password);
                }       
 
                /*
@@ -415,20 +401,17 @@ void xmpp_xml_end(void *data, const char *supplied_el) {
                else if (
                        (XMPP->bind_requested)
                        && (!IsEmptyStr(XMPP->iq_id))
-                       && (!IsEmptyStr(XMPP->iq_client_resource))
                        && (CC->logged_in)
-                       ) {
-
-                       /* Generate the "full JID" of the client resource */
+               ) {
+                       /* If the client has not specified a client resource, generate one */
+                       if (IsEmptyStr(XMPP->iq_client_resource)) {
+                               snprintf(XMPP->iq_client_resource, sizeof XMPP->iq_client_resource, "%d", CC->cs_pid);
+                       }
 
-                       snprintf(XMPP->client_jid, sizeof XMPP->client_jid,
-                               "%s/%s",
-                               CC->cs_inet_email,
-                               XMPP->iq_client_resource
-                       );
+                       /* Generate the "full JID" of the client (user@host/resource) */
+                       snprintf(XMPP->client_jid, sizeof XMPP->client_jid, "%s/%s", CC->cs_principal_id, XMPP->iq_client_resource);
 
                        /* Tell the client what its JID is */
-
                        cprintf("<iq type=\"result\" id=\"%s\">", xmlesc(xmlbuf, XMPP->iq_id, sizeof xmlbuf));
                        cprintf("<bind xmlns=\"urn:ietf:params:xml:ns:xmpp-bind\">");
                        cprintf("<jid>%s</jid>", xmlesc(xmlbuf, XMPP->client_jid, sizeof xmlbuf));
@@ -443,8 +426,9 @@ void xmpp_xml_end(void *data, const char *supplied_el) {
 
                else {
                        cprintf("<iq type=\"error\" id=\"%s\">", xmlesc(xmlbuf, XMPP->iq_id, sizeof xmlbuf));
-                       cprintf("<error>Don't know howto do '%s'!</error>", xmlesc(xmlbuf, XMPP->iq_type, sizeof xmlbuf));
+                       cprintf("<error>Don't know how to do '%s'!</error>", xmlesc(xmlbuf, XMPP->iq_type, sizeof xmlbuf));
                        cprintf("</iq>");
+                       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);
                }
 
                /* Now clear these fields out so they don't get used by a future stanza */
@@ -454,13 +438,13 @@ void xmpp_xml_end(void *data, const char *supplied_el) {
                XMPP->iq_type[0] = 0;
                XMPP->iq_client_resource[0] = 0;
                XMPP->iq_session = 0;
+               XMPP->iq_vcard = 0;
                XMPP->iq_query_xmlns[0] = 0;
                XMPP->bind_requested = 0;
                XMPP->ping_requested = 0;
        }
 
        else if (!strcasecmp(el, "auth")) {
-
                /* Try to authenticate (this function is responsible for the output stanza) */
                xmpp_sasl_auth(XMPP->sasl_auth_mech, (XMPP->chardata != NULL ? XMPP->chardata : "") );
 
@@ -472,8 +456,11 @@ void xmpp_xml_end(void *data, const char *supplied_el) {
                XMPP->iq_session = 1;
        }
 
-       else if (!strcasecmp(el, "presence")) {
+       else if (!strcasecmp(supplied_el, "vcard-temp:vCard")) {
+               XMPP->iq_vcard = 1;
+       }
 
+       else if (!strcasecmp(el, "presence")) {
                /* Respond to a <presence> update by firing back with presence information
                 * on the entire wholist.  Check this assumption, it's probably wrong.
                 */
@@ -515,14 +502,22 @@ void xmpp_xml_end(void *data, const char *supplied_el) {
        }
 
        else if (!strcasecmp(el, "stream")) {
-               XMPPM_syslog(LOG_DEBUG, "XMPP client shut down their stream\n");
+               syslog(LOG_DEBUG, "xmpp: client shut down their stream");
                xmpp_massacre_roster();
                cprintf("</stream>\n");
                CC->kill_me = KILLME_CLIENT_LOGGED_OUT;
        }
 
+       else if (!strcasecmp(el, "query")) {
+               /* already processed , no further action needed here */
+       }
+
+       else if (!strcasecmp(el, "bind")) {
+               /* already processed , no further action needed here */
+       }
+
        else {
-               XMPP_syslog(LOG_DEBUG, "Ignoring unknown tag <%s>\n", el);
+               syslog(LOG_DEBUG, "xmpp: ignoring unknown tag <%s>", el);
        }
 
        XMPP->chardata_len = 0;
@@ -572,7 +567,6 @@ void xmpp_cleanup_function(void) {
 }
 
 
-
 /*
  * Here's where our XMPP session begins its happy day.
  */
@@ -587,7 +581,7 @@ void xmpp_greeting(void) {
 
        XMPP->xp = XML_ParserCreateNS("UTF-8", ':');
        if (XMPP->xp == NULL) {
-               XMPPM_syslog(LOG_ALERT, "Cannot create XML parser!\n");
+               syslog(LOG_ERR, "xmpp: cannot create XML parser");
                CC->kill_me = KILLME_XML_PARSER;
                return;
        }
@@ -624,7 +618,7 @@ void xmpp_command_loop(void) {
                XML_Parse(XMPP->xp, ChrPtr(stream_input), rc, 0);
        }
        else {
-               XMPPM_syslog(LOG_ERR, "client disconnected: ending session.\n");
+               syslog(LOG_ERR, "xmpp: client disconnected: ending session.");
                CC->kill_me = KILLME_CLIENT_DISCONNECTED;
        }
        FreeStrBuf(&stream_input);
@@ -644,7 +638,7 @@ void xmpp_async_loop(void) {
  * Login hook for XMPP sessions
  */
 void xmpp_login_hook(void) {
-       xmpp_queue_event(XMPP_EVT_LOGIN, CC->cs_inet_email);
+       xmpp_queue_event(XMPP_EVT_LOGIN, CC->cs_principal_id);
 }
 
 
@@ -652,33 +646,26 @@ void xmpp_login_hook(void) {
  * Logout hook for XMPP sessions
  */
 void xmpp_logout_hook(void) {
-       xmpp_queue_event(XMPP_EVT_LOGOUT, CC->cs_inet_email);
+       xmpp_queue_event(XMPP_EVT_LOGOUT, CC->cs_principal_id);
 }
 
 
-void LogXMPPSrvDebugEnable(const int n)
-{
-       XMPPSrvDebugEnable = n;
-}
 const char *CitadelServiceXMPP="XMPP";
-extern void xmpp_cleanup_events(void);
 CTDL_MODULE_INIT(xmpp)
 {
        if (!threading) {
-               CtdlRegisterServiceHook(config.c_xmpp_c2s_port,
+               CtdlRegisterServiceHook(CtdlGetConfigInt("c_xmpp_c2s_port"),
                                        NULL,
                                        xmpp_greeting,
                                        xmpp_command_loop,
                                        xmpp_async_loop,
                                        CitadelServiceXMPP
                );
-               CtdlRegisterDebugFlagHook(HKEY("serv_xmpp"), LogXMPPSrvDebugEnable, &XMPPSrvDebugEnable);
                CtdlRegisterSessionHook(xmpp_cleanup_function, EVT_STOP, PRIO_STOP + 70);
                 CtdlRegisterSessionHook(xmpp_login_hook, EVT_LOGIN, PRIO_LOGIN + 90);
                 CtdlRegisterSessionHook(xmpp_logout_hook, EVT_LOGOUT, PRIO_LOGOUT + 90);
                 CtdlRegisterSessionHook(xmpp_login_hook, EVT_UNSTEALTH, PRIO_UNSTEALTH + 1);
                 CtdlRegisterSessionHook(xmpp_logout_hook, EVT_STEALTH, PRIO_STEALTH + 1);
-               CtdlRegisterCleanupHook(xmpp_cleanup_events);
 
        }