core/stanza_router.lua

   1
   2 -- The code in this file should be self-explanatory, though the logic is horrible
   3 -- for more info on that, see doc/stanza_routing.txt, which attempts to condense
   4 -- the rules from the RFCs (mainly 3921)
   5
   6 require "core.servermanager"
   7
   8 local log = require "util.logger".init("stanzarouter")
   9
  10 local st = require "util.stanza";
  11 local send_s2s = require "core.s2smanager".send_to_host;
  12 local user_exists = require "core.usermanager".user_exists;
  13
  14 local rostermanager = require "core.rostermanager";
  15 local sessionmanager = require "core.sessionmanager";
  16 local offlinemanager = require "core.offlinemanager";
  17
  18 local s2s_verify_dialback = require "core.s2smanager".verify_dialback;
  19 local s2s_make_authenticated = require "core.s2smanager".make_authenticated;
  20
  21 local modules_handle_stanza = require "core.modulemanager".handle_stanza;
  22 local component_handle_stanza = require "core.componentmanager".handle_stanza;
  23
  24 local format = string.format;
  25 local tostring = tostring;
  26 local t_concat = table.concat;
  27 local t_insert = table.insert;
  28 local tonumber = tonumber;
  29 local s_find = string.find;
  30
  31 local jid_split = require "util.jid".split;
  32 local print = print;
  33
  34 function core_process_stanza(origin, stanza)
  35         log("debug", "Received["..origin.type.."]: "..tostring(st.reply(st.reply(stanza))))
  36
  37         if not stanza.attr.xmlns then stanza.attr.xmlns = "jabber:client"; end -- FIXME Hack. This should be removed when we fix namespace handling.
  38         -- TODO verify validity of stanza (as well as JID validity)
  39         if stanza.name == "iq" and not(#stanza.tags == 1 and stanza.tags[1].attr.xmlns) then
  40                 if stanza.attr.type == "set" or stanza.attr.type == "get" then
  41                         error("Invalid IQ");
  42                 elseif #stanza.tags > 1 and not(stanza.attr.type == "error" or stanza.attr.type == "result") then
  43                         error("Invalid IQ");
  44                 end
  45         end
  46
  47         if origin.type == "c2s" and not origin.full_jid
  48                 and not(stanza.name == "iq" and stanza.tags[1].name == "bind"
  49                                 and stanza.tags[1].attr.xmlns == "urn:ietf:params:xml:ns:xmpp-bind") then
  50                 error("Client MUST bind resource after auth");
  51         end
  52
  53         -- TODO also, stazas should be returned to their original state before the function ends
  54         if origin.type == "c2s" then
  55                 stanza.attr.from = origin.full_jid;
  56         end
  57         local to = stanza.attr.to;
  58         local node, host, resource = jid_split(to);
  59         local to_bare = node and (node.."@"..host) or host; -- bare JID
  60         local from = stanza.attr.from;
  61         local from_node, from_host, from_resource = jid_split(from);
  62         local from_bare = from_node and (from_node.."@"..from_host) or from_host; -- bare JID
  63
  64         if origin.type == "s2sin" then
  65                 if origin.from_host ~= from_host then -- remote server trying to impersonate some other server?
  66                         log("warn", "Received a stanza claiming to be from %s, over a conn authed for %s!", from, origin.from_host);
  67                         return; -- FIXME what should we do here? does this work with subdomains?
  68                 end
  69         end
  70         --[[if to and not(hosts[to]) and not(hosts[to_bare]) and (hosts[host] and hosts[host].type ~= "local") then -- not for us?
  71                 log("warn", "stanza recieved for a non-local server");
  72                 return; -- FIXME what should we do here?
  73         end]] -- FIXME
  74
  75         -- FIXME do stanzas not of jabber:client get handled by components?
  76         if origin.type == "s2sin" or origin.type == "c2s" then
  77                 if not to then
  78                         core_handle_stanza(origin, stanza);
  79                 elseif hosts[to] and hosts[to].type == "local" then -- directed at a local server
  80                         core_handle_stanza(origin, stanza);
  81                 elseif stanza.attr.xmlns and stanza.attr.xmlns ~= "jabber:client" and stanza.attr.xmlns ~= "jabber:server" then
  82                         modules_handle_stanza(origin, stanza);
  83                 elseif hosts[to_bare] and hosts[to_bare].type == "component" then -- hack to allow components to handle node@server
  84                         component_handle_stanza(origin, stanza);
  85                 elseif hosts[to] and hosts[to].type == "component" then -- hack to allow components to handle node@server/resource and server/resource
  86                         component_handle_stanza(origin, stanza);
  87                 elseif hosts[host] and hosts[host].type == "component" then -- directed at a component
  88                         component_handle_stanza(origin, stanza);
  89                 elseif origin.type == "c2s" and stanza.name == "presence" and stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" then
  90                         handle_outbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare);
  91                 elseif stanza.name == "iq" and not resource then -- directed at bare JID
  92                         core_handle_stanza(origin, stanza);
  93                 else
  94                         core_route_stanza(origin, stanza);
  95                 end
  96         else
  97                 core_handle_stanza(origin, stanza);
  98         end
  99 end
 100
 101 -- This function handles stanzas which are not routed any further,
 102 -- that is, they are handled by this server
 103 function core_handle_stanza(origin, stanza)
 104         -- Handlers
 105         if modules_handle_stanza(origin, stanza) then return; end
 106         if origin.type == "c2s" or origin.type == "c2s_unauthed" then
 107                 local session = origin;
 108
 109                 if stanza.name == "presence" and origin.roster then
 110                         if stanza.attr.type == nil or stanza.attr.type == "unavailable" then
 111                                 for jid in pairs(origin.roster) do -- broadcast to all interested contacts
 112                                         local subscription = origin.roster[jid].subscription;
 113                                         if subscription == "both" or subscription == "from" then
 114                                                 stanza.attr.to = jid;
 115                                                 core_route_stanza(origin, stanza);
 116                                         end
 117                                 end
 118                                 local node, host = jid_split(stanza.attr.from);
 119                                 for _, res in pairs(hosts[host].sessions[node].sessions) do -- broadcast to all resources
 120                                         if res ~= origin and res.full_jid then -- to resource. FIXME is res.full_jid the correct check? Maybe it should be res.presence
 121                                                 stanza.attr.to = res.full_jid;
 122                                                 core_route_stanza(origin, stanza);
 123                                         end
 124                                 end
 125                                 if stanza.attr.type == nil and not origin.presence then -- initial presence
 126                                         local probe = st.presence({from = origin.full_jid, type = "probe"});
 127                                         for jid in pairs(origin.roster) do -- probe all contacts we are subscribed to
 128                                                 local subscription = origin.roster[jid].subscription;
 129                                                 if subscription == "both" or subscription == "to" then
 130                                                         probe.attr.to = jid;
 131                                                         core_route_stanza(origin, probe);
 132                                                 end
 133                                         end
 134                                         for _, res in pairs(hosts[host].sessions[node].sessions) do -- broadcast from all available resources
 135                                                 if res ~= origin and res.presence then
 136                                                         res.presence.attr.to = origin.full_jid;
 137                                                         core_route_stanza(res, res.presence);
 138                                                         res.presence.attr.to = nil;
 139                                                 end
 140                                         end
 141                                         if origin.roster.pending then -- resend incoming subscription requests
 142                                                 for jid in pairs(origin.roster.pending) do
 143                                                         origin.send(st.presence({type="subscribe", from=jid})); -- TODO add to attribute? Use original?
 144                                                 end
 145                                         end
 146                                         local request = st.presence({type="subscribe", from=origin.username.."@"..origin.host});
 147                                         for jid, item in pairs(origin.roster) do -- resend outgoing subscription requests
 148                                                 if item.ask then
 149                                                         request.attr.to = jid;
 150                                                         core_route_stanza(origin, request);
 151                                                 end
 152                                         end
 153                                         for _, msg in ipairs(offlinemanager.load(node, host) or {}) do
 154                                                 origin.send(msg); -- FIXME do we need to modify to/from in any way?
 155                                         end
 156                                         offlinemanager.deleteAll(node, host);
 157                                 end
 158                                 origin.priority = 0;
 159                                 if stanza.attr.type == "unavailable" then
 160                                         origin.presence = nil;
 161                                 else
 162                                         origin.presence = stanza;
 163                                         local priority = stanza:child_with_name("priority");
 164                                         if priority and #priority > 0 then
 165                                                 priority = t_concat(priority);
 166                                                 if s_find(priority, "^[+-]?[0-9]+$") then
 167                                                         priority = tonumber(priority);
 168                                                         if priority < -128 then priority = -128 end
 169                                                         if priority > 127 then priority = 127 end
 170                                                         origin.priority = priority;
 171                                                 end
 172                                         end
 173                                 end
 174                                 stanza.attr.to = nil; -- reset it
 175                         else
 176                                 log("warn", "Unhandled c2s presence: %s", tostring(stanza));
 177                                 origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); -- FIXME correct error?
 178                         end
 179                 else
 180                         log("warn", "Unhandled c2s stanza: %s", tostring(stanza));
 181                         origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); -- FIXME correct error?
 182                 end -- TODO handle other stanzas
 183         else
 184                 log("warn", "Unhandled origin: %s", origin.type);
 185                 -- s2s stanzas can get here
 186                 (origin.sends2s or origin.send)(st.error_reply(stanza, "cancel", "service-unavailable")); -- FIXME correct error?
 187         end
 188 end
 189
 190 function send_presence_of_available_resources(user, host, jid, recipient_session)
 191         local h = hosts[host];
 192         local count = 0;
 193         if h and h.type == "local" then
 194                 local u = h.sessions[user];
 195                 if u then
 196                         for k, session in pairs(u.sessions) do
 197                                 local pres = session.presence;
 198                                 if pres then
 199                                         pres.attr.to = jid;
 200                                         pres.attr.from = session.full_jid;
 201                                         recipient_session.send(pres);
 202                                         pres.attr.to = nil;
 203                                         pres.attr.from = nil;
 204                                         count = count + 1;
 205                                 end
 206                         end
 207                 end
 208         end
 209         return count;
 210 end
 211
 212 function handle_outbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare)
 213         local node, host = jid_split(from_bare);
 214         local st_from, st_to = stanza.attr.from, stanza.attr.to;
 215         stanza.attr.from, stanza.attr.to = from_bare, to_bare;
 216         if stanza.attr.type == "subscribe" then
 217                 log("debug", "outbound subscribe from "..from_bare.." for "..to_bare);
 218                 -- 1. route stanza
 219                 -- 2. roster push (subscription = none, ask = subscribe)
 220                 if rostermanager.set_contact_pending_out(node, host, to_bare) then
 221                         rostermanager.roster_push(node, host, to_bare);
 222                 end -- else file error
 223                 core_route_stanza(origin, stanza);
 224         elseif stanza.attr.type == "unsubscribe" then
 225                 log("debug", "outbound unsubscribe from "..from_bare.." for "..to_bare);
 226                 -- 1. route stanza
 227                 -- 2. roster push (subscription = none or from)
 228                 if rostermanager.unsubscribe(node, host, to_bare) then
 229                         rostermanager.roster_push(node, host, to_bare); -- FIXME do roster push when roster has in fact not changed?
 230                 end -- else file error
 231                 core_route_stanza(origin, stanza);
 232         elseif stanza.attr.type == "subscribed" then
 233                 log("debug", "outbound subscribed from "..from_bare.." for "..to_bare);
 234                 -- 1. route stanza
 235                 -- 2. roster_push ()
 236                 -- 3. send_presence_of_available_resources
 237                 if rostermanager.subscribed(node, host, to_bare) then
 238                         rostermanager.roster_push(node, host, to_bare);
 239                         core_route_stanza(origin, stanza);
 240                         send_presence_of_available_resources(node, host, to_bare, origin);
 241                 end
 242         elseif stanza.attr.type == "unsubscribed" then
 243                 log("debug", "outbound unsubscribed from "..from_bare.." for "..to_bare);
 244                 -- 1. route stanza
 245                 -- 2. roster push (subscription = none or to)
 246                 if rostermanager.unsubscribed(node, host, to_bare) then
 247                         rostermanager.roster_push(node, host, to_bare);
 248                         core_route_stanza(origin, stanza);
 249                 end
 250         end
 251         stanza.attr.from, stanza.attr.to = st_from, st_to;
 252 end
 253
 254 function handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare)
 255         local node, host = jid_split(to_bare);
 256         local st_from, st_to = stanza.attr.from, stanza.attr.to;
 257         stanza.attr.from, stanza.attr.to = from_bare, to_bare;
 258         if stanza.attr.type == "probe" then
 259                 log("debug", "inbound probe from "..from_bare.." for "..to_bare);
 260                 if rostermanager.is_contact_subscribed(node, host, from_bare) then
 261                         if 0 == send_presence_of_available_resources(node, host, from_bare, origin) then
 262                                 -- TODO send last recieved unavailable presence (or we MAY do nothing, which is fine too)
 263                         end
 264                 else
 265                         core_route_stanza(origin, st.presence({from=to_bare, to=from_bare, type="unsubscribed"}));
 266                 end
 267         elseif stanza.attr.type == "subscribe" then
 268                 log("debug", "inbound subscribe from "..from_bare.." for "..to_bare);
 269                 if rostermanager.is_contact_subscribed(node, host, from_bare) then
 270                         core_route_stanza(origin, st.presence({from=to_bare, to=from_bare, type="subscribed"})); -- already subscribed
 271                 else
 272                         if not rostermanager.is_contact_pending_in(node, host, from_bare) then
 273                                 if rostermanager.set_contact_pending_in(node, host, from_bare) then
 274                                         sessionmanager.send_to_available_resources(node, host, stanza);
 275                                 end -- TODO else return error, unable to save
 276                         end
 277                 end
 278         elseif stanza.attr.type == "unsubscribe" then
 279                 log("debug", "inbound unsubscribe from "..from_bare.." for "..to_bare);
 280                 if rostermanager.process_inbound_unsubscribe(node, host, from_bare) then
 281                         rostermanager.roster_push(node, host, from_bare);
 282                 end
 283         elseif stanza.attr.type == "subscribed" then
 284                 log("debug", "inbound subscribed from "..from_bare.." for "..to_bare);
 285                 if rostermanager.process_inbound_subscription_approval(node, host, from_bare) then
 286                         rostermanager.roster_push(node, host, from_bare);
 287                 end
 288         elseif stanza.attr.type == "unsubscribed" then
 289                 log("debug", "inbound unsubscribed from "..from_bare.." for "..to_bare);
 290                 if rostermanager.process_inbound_subscription_approval(node, host, from_bare) then
 291                         rostermanager.roster_push(node, host, from_bare);
 292                 end
 293         end -- discard any other type
 294         stanza.attr.from, stanza.attr.to = st_from, st_to;
 295 end
 296
 297 function core_route_stanza(origin, stanza)
 298         -- Hooks
 299         --- ...later
 300
 301         -- Deliver
 302         local to = stanza.attr.to;
 303         local node, host, resource = jid_split(to);
 304         local to_bare = node and (node.."@"..host) or host; -- bare JID
 305         local from = stanza.attr.from;
 306         local from_node, from_host, from_resource = jid_split(from);
 307         local from_bare = from_node and (from_node.."@"..from_host) or from_host; -- bare JID
 308
 309         if stanza.name == "presence" and (stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable") then resource = nil; end
 310
 311         local host_session = hosts[host]
 312         if host_session and host_session.type == "local" then
 313                 -- Local host
 314                 local user = host_session.sessions[node];
 315                 if user then
 316                         local res = user.sessions[resource];
 317                         if not res then
 318                                 -- if we get here, resource was not specified or was unavailable
 319                                 if stanza.name == "presence" then
 320                                         if stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" then
 321                                                 handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare);
 322                                         else -- sender is available or unavailable
 323                                                 for _, session in pairs(user.sessions) do -- presence broadcast to all user resources.
 324                                                         if session.full_jid then -- FIXME should this be just for available resources? Do we need to check subscription?
 325                                                                 stanza.attr.to = session.full_jid; -- reset at the end of function
 326                                                                 session.send(stanza);
 327                                                         end
 328                                                 end
 329                                         end
 330                                 elseif stanza.name == "message" then -- select a resource to recieve message
 331                                         local priority = 0;
 332                                         local recipients = {};
 333                                         for _, session in pairs(user.sessions) do -- find resource with greatest priority
 334                                                 local p = session.priority;
 335                                                 if p > priority then
 336                                                         priority = p;
 337                                                         recipients = {session};
 338                                                 elseif p == priority then
 339                                                         t_insert(recipients, session);
 340                                                 end
 341                                         end
 342                                         local count = 0;
 343                                         for _, session in pairs(recipients) do
 344                                                 session.send(stanza);
 345                                                 count = count + 1;
 346                                         end
 347                                         if count == 0 then
 348                                                 offlinemanager.store(node, host, stanza);
 349                                                 -- TODO deal with storage errors
 350                                         end
 351                                 else
 352                                         -- TODO send IQ error
 353                                 end
 354                         else
 355                                 -- User + resource is online...
 356                                 stanza.attr.to = res.full_jid; -- reset at the end of function
 357                                 res.send(stanza); -- Yay \o/
 358                         end
 359                 else
 360                         -- user not online
 361                         if user_exists(node, host) then
 362                                 if stanza.name == "presence" then
 363                                         if stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" then
 364                                                 handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare);
 365                                         else
 366                                                 -- TODO send unavailable presence or unsubscribed
 367                                         end
 368                                 elseif stanza.name == "message" then
 369                                         if stanza.attr.type == "chat" or stanza.attr.type == "normal" or not stanza.attr.type then
 370                                                 offlinemanager.store(node, host, stanza);
 371                                                 -- FIXME don't store messages with only chat state notifications
 372                                         end
 373                                         -- TODO allow configuration of offline storage
 374                                         -- TODO send error if not storing offline
 375                                 elseif stanza.name == "iq" then
 376                                         -- TODO send IQ error
 377                                 end
 378                         else -- user does not exist
 379                                 -- TODO we would get here for nodeless JIDs too. Do something fun maybe? Echo service? Let plugins use xmpp:server/resource addresses?
 380                                 if stanza.name == "presence" then
 381                                         if stanza.attr.type == "probe" then
 382                                                 origin.send(st.presence({from = to_bare, to = from_bare, type = "unsubscribed"}));
 383                                         end
 384                                         -- else ignore
 385                                 else
 386                                         origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
 387                                 end
 388                         end
 389                 end
 390         elseif origin.type == "c2s" then
 391                 -- Remote host
 392                 local xmlns = stanza.attr.xmlns;
 393                 --stanza.attr.xmlns = "jabber:server";
 394                 stanza.attr.xmlns = nil;
 395                 log("debug", "sending s2s stanza: %s", tostring(stanza));
 396                 send_s2s(origin.host, host, stanza); -- TODO handle remote routing errors
 397                 stanza.attr.xmlns = xmlns; -- reset
 398         elseif origin.type == "component" or origin.type == "local" then
 399                 -- Route via s2s for components and modules
 400                 log("debug", "Routing outgoing stanza for %s to %s", origin.host, host);
 401                 for k,v in pairs(origin) do print("origin:", tostring(k), tostring(v)); end
 402                 print(tostring(host), tostring(from_host))
 403                 send_s2s(origin.host, host, stanza);
 404         else
 405                 log("warn", "received stanza from unhandled connection type: %s", origin.type);
 406         end
 407         stanza.attr.to = to; -- reset
 408 end
 409
 410 function handle_stanza_toremote(stanza)
 411         log("error", "Stanza bound for remote host, but s2s is not implemented");
 412 end
 413
 414