Line data    Source code

       1             : /*
       2             :  * Copyright (c) 2013 Juniper Networks, Inc. All rights reserved.
       3             :  */
       4             : 
       5             : #include "xmpp/xmpp_proto.h"
       6             : #include <iostream>
       7             : #include <string>
       8             : #include <boost/algorithm/string/replace.hpp>
       9             : #include <boost/algorithm/string/predicate.hpp>
      10             : 
      11             : #include "xmpp/xmpp_connection.h"
      12             : #include "xmpp/xmpp_log.h"
      13             : #include "xmpp/xmpp_session.h"
      14             : #include "xmpp/xmpp_str.h"
      15             : 
      16             : #include "sandesh/sandesh_trace.h"
      17             : #include "sandesh/common/vns_types.h"
      18             : #include "sandesh/common/vns_constants.h"
      19             : #include "sandesh/xmpp_message_sandesh_types.h"
      20             : #include "sandesh/xmpp_trace_sandesh_types.h"
      21             : 
      22             : using namespace std;
      23             : 
      24             : unique_ptr<XmlBase> XmppProto::open_doc_(AllocXmppXmlImpl(sXMPP_STREAM_OPEN));
      25             : 
      26           0 : XmppStanza::XmppStanza() {
      27           0 : }
      28             : 
      29           0 : XmppProto::XmppProto() {
      30           0 : }
      31             : 
      32           0 : XmppProto::~XmppProto() {
      33           0 : }
      34             : 
      35         136 : int XmppProto::EncodeStream(const XmppStreamMessage &str, string &to,
      36             :                             string &from, const string &xmlns, uint8_t *buf,
      37             :                             size_t size) {
      38         136 :     int len = 0;
      39             : 
      40         136 :     switch (str.strmtype) {
      41          60 :         case (XmppStanza::XmppStreamMessage::INIT_STREAM_HEADER):
      42          60 :             len = EncodeOpen(buf, to, from, xmlns, size);
      43          60 :             break;
      44          37 :         case (XmppStanza::XmppStreamMessage::INIT_STREAM_HEADER_RESP):
      45          37 :             len = EncodeOpenResp(buf, to, from, size);
      46          37 :             break;
      47          39 :         case (XmppStanza::XmppStreamMessage::FEATURE_TLS):
      48          39 :             switch (str.strmtlstype) {
      49          14 :                 case (XmppStanza::XmppStreamMessage::TLS_FEATURE_REQUEST):
      50          14 :                     len = EncodeFeatureTlsRequest(buf);
      51          14 :                     break;
      52          15 :                 case (XmppStanza::XmppStreamMessage::TLS_START):
      53          15 :                     len = EncodeFeatureTlsStart(buf);
      54          15 :                     break;
      55          10 :                 case (XmppStanza::XmppStreamMessage::TLS_PROCEED):
      56          10 :                     len = EncodeFeatureTlsProceed(buf);
      57          10 :                     break;
      58             :             }
      59          39 :             break;
      60           0 :         default:
      61           0 :             break;
      62             :     }
      63             : 
      64         136 :     return len;
      65             : }
      66             : 
      67          30 : int XmppProto::EncodeStream(const XmppStanza::XmppMessage &str, uint8_t *buf,
      68             :                             size_t size) {
      69          30 :     int ret = 0;
      70             : 
      71          30 :     if (str.type == XmppStanza::WHITESPACE_MESSAGE_STANZA) {
      72          30 :         return EncodeWhitespace(buf);
      73             :     }
      74             : 
      75           0 :     return ret;
      76             : }
      77             : 
      78           0 : int XmppProto::EncodeMessage(XmlBase *dom, uint8_t *buf, size_t size) {
      79           0 :     int len = dom->WriteDoc(buf);
      80             : 
      81           0 :     return len;
      82             : }
      83             : 
      84           0 : int XmppProto::EncodePresence(uint8_t *buf, size_t size) {
      85           0 :     return 0;
      86             : }
      87             : 
      88           0 : int XmppProto::EncodeIq(const XmppStanza::XmppMessageIq *iq,
      89             :                         XmlBase *doc, uint8_t *buf, size_t size) {
      90           0 :     unique_ptr<XmlBase> send_doc_(AllocXmppXmlImpl());
      91             : 
      92             :     // create
      93           0 :     send_doc_->LoadDoc("");
      94           0 :     send_doc_->AddNode("iq", "");
      95             : 
      96           0 :     switch(iq->stype) {
      97           0 :         case XmppStanza::XmppMessageIq::GET:
      98           0 :             send_doc_->AddAttribute("type", "get");
      99           0 :             break;
     100           0 :         case XmppStanza::XmppMessageIq::SET:
     101           0 :             send_doc_->AddAttribute("type", "set");
     102           0 :             break;
     103           0 :         case XmppStanza::XmppMessageIq::RESULT:
     104           0 :             send_doc_->AddAttribute("type", "result");
     105           0 :             break;
     106           0 :         case XmppStanza::XmppMessageIq::ERROR:
     107           0 :             send_doc_->AddAttribute("type", "error");
     108           0 :             break;
     109           0 :         default:
     110           0 :             break;
     111             :     }
     112           0 :     send_doc_->AddAttribute("from", iq->from);
     113           0 :     send_doc_->AddAttribute("to", iq->to);
     114           0 :     send_doc_->AddAttribute("id", "id1");
     115             : 
     116           0 :     send_doc_->AddChildNode("pubsub", "");
     117           0 :     send_doc_->AddAttribute("xmlns", "http://jabber.org/protocol/pubsub");
     118             : 
     119           0 :     send_doc_->AppendDoc("pubsub", doc);
     120             : 
     121             :     //Returns byte encoded in the doc
     122           0 :     int len = send_doc_->WriteDoc(buf);
     123             : 
     124           0 :     return len;
     125           0 : }
     126             : 
     127          30 : int XmppProto::EncodeWhitespace(uint8_t *buf) {
     128          30 :     string str(sXMPP_WHITESPACE);
     129             : 
     130          30 :     int len = str.size();
     131          30 :     if (len > 0) {
     132          30 :         memcpy(buf, str.data(), len);
     133             :     }
     134             : 
     135          30 :     return len;
     136          30 : }
     137             : 
     138          37 : int XmppProto::EncodeOpenResp(uint8_t *buf, string &to, string &from,
     139             :                               size_t max_size) {
     140             : 
     141          37 :     unique_ptr<XmlBase> resp_doc(XmppStanza::AllocXmppXmlImpl(sXMPP_STREAM_RESP));
     142             : 
     143          37 :     if (resp_doc.get() == NULL) {
     144           0 :         return 0;
     145             :     }
     146             : 
     147          37 :     SetTo(to, resp_doc.get());
     148          37 :     SetFrom(from, resp_doc.get());
     149             : 
     150          37 :     std::stringstream ss;
     151          37 :     resp_doc->PrintDoc(ss);
     152          37 :     std::string msg;
     153          37 :     msg = ss.str();
     154          37 :     size_t len = msg.size();
     155          37 :     if (len > max_size) {
     156           0 :         LOG(ERROR, "\n (Open Confirm) size greater than max buffer size \n");
     157           0 :         return 0;
     158             :     } else {
     159          37 :         boost::algorithm::ireplace_last(msg, "/", " ");
     160          37 :         memcpy(buf, msg.c_str(), len);
     161          37 :         return len;
     162             :     }
     163          37 : }
     164             : 
     165          60 : int XmppProto::EncodeOpen(uint8_t *buf, string &to, string &from,
     166             :                           const string &xmlns, size_t max_size) {
     167             : 
     168          60 :     if (open_doc_.get() ==  NULL) {
     169           0 :         return 0;
     170             :     }
     171             : 
     172          60 :     SetTo(to, open_doc_.get());
     173          60 :     SetFrom(from, open_doc_.get());
     174          60 :     SetXmlns(xmlns, open_doc_.get());
     175             : 
     176             :     //Returns byte encoded in the doc
     177          60 :     std::stringstream ss;
     178          60 :     open_doc_->PrintDoc(ss);
     179          60 :     std::string msg;
     180          60 :     msg = ss.str();
     181          60 :     size_t len = msg.size();
     182          60 :     if (len > max_size) {
     183           0 :         LOG(ERROR, "\n (Open Message) size greater than max buffer size \n");
     184           0 :         return 0;
     185             :     } else {
     186          60 :         boost::algorithm::ireplace_last(msg, "/", " ");
     187          60 :         memcpy(buf, msg.c_str(), len);
     188          60 :         return len;
     189             :     }
     190          60 : }
     191             : 
     192          14 : int XmppProto::EncodeFeatureTlsRequest(uint8_t *buf) {
     193          14 :     unique_ptr<XmlBase> resp_doc(XmppStanza::AllocXmppXmlImpl(sXMPP_STREAM_FEATURE_TLS));
     194             :     //Returns byte encoded in the doc
     195          14 :     int len = resp_doc->WriteDoc(buf);
     196          14 :     return len;
     197          14 : }
     198             : 
     199          15 : int XmppProto::EncodeFeatureTlsStart(uint8_t *buf) {
     200          15 :     unique_ptr<XmlBase> resp_doc(XmppStanza::AllocXmppXmlImpl(sXMPP_STREAM_START_TLS));
     201             :     //Returns byte encoded in the doc
     202          15 :     int len = resp_doc->WriteDoc(buf);
     203          15 :     return len;
     204          15 : }
     205             : 
     206          10 : int XmppProto::EncodeFeatureTlsProceed(uint8_t *buf) {
     207          10 :     unique_ptr<XmlBase> resp_doc(XmppStanza::AllocXmppXmlImpl(sXMPP_STREAM_PROCEED_TLS));
     208             :     //Returns byte encoded in the doc
     209          10 :     int len = resp_doc->WriteDoc(buf);
     210          10 :     return len;
     211          10 : }
     212             : 
     213          84 : XmppStanza::XmppMessage *XmppProto::Decode(const XmppConnection *connection,
     214             :                                            const string &ts) {
     215          84 :     XmlBase *impl = XmppStanza::AllocXmppXmlImpl();
     216          84 :     if (impl == nullptr) {
     217           0 :         return nullptr;
     218             :     }
     219             : 
     220          84 :     XmppStanza::XmppMessage *msg = DecodeInternal(connection, ts, impl);
     221          84 :     if (!msg) {
     222           0 :         return nullptr;
     223             :     }
     224             : 
     225             :     // transfer ownership of the dom implementation
     226          84 :     msg->dom.reset(impl);
     227             : 
     228          84 :     return msg;
     229             : }
     230             : 
     231          84 : XmppStanza::XmppMessage *XmppProto::DecodeInternal(
     232             :         const XmppConnection *connection, const string &ts, XmlBase *impl) {
     233          84 :     XmppStanza::XmppMessage *ret = nullptr;
     234             : 
     235          84 :     string ns(sXMPP_STREAM_O);
     236          84 :     string ws(sXMPP_WHITESPACE);
     237          84 :     string iq(sXMPP_IQ_KEY);
     238             : 
     239          84 :     if (ts.find(sXMPP_IQ) != string::npos) {
     240          23 :         string ts_tmp = ts;
     241             : 
     242          23 :         if (impl->LoadDoc(ts) == -1) {
     243           0 :             XMPP_WARNING(XmppIqMessageParseFail, connection->ToUVEKey(),
     244             :                          XMPP_PEER_DIR_IN);
     245           0 :             assert(false);
     246             :             goto done;
     247             :         }
     248             : 
     249          23 :         XmppStanza::XmppMessageIq *msg = new XmppStanza::XmppMessageIq;
     250          23 :         impl->ReadNode(iq);
     251          23 :         msg->to = XmppProto::GetTo(impl);
     252          23 :         msg->from = XmppProto::GetFrom(impl);
     253          23 :         msg->id = XmppProto::GetId(impl);
     254          23 :         msg->iq_type = XmppProto::GetType(impl);
     255             :         // action is subscribe,publish,collection
     256          23 :         const char *action = XmppProto::GetAction(impl, msg->iq_type);
     257          23 :         if (action) {
     258           8 :             msg->action = action;
     259             :         }
     260          23 :         if (XmppProto::GetNode(impl, msg->action)) {
     261           8 :             msg->node = XmppProto::GetNode(impl, msg->action);
     262             :         }
     263             :         //associate or dissociate collection node
     264          23 :         if (msg->action.compare("collection") == 0) {
     265           2 :             if (XmppProto::GetAsNode(impl)) {
     266           2 :                 msg->as_node = XmppProto::GetAsNode(impl);
     267           2 :                 msg->is_as_node = true;
     268           0 :             } else if (XmppProto::GetDsNode(impl)) {
     269           0 :                 msg->as_node = XmppProto::GetDsNode(impl);
     270           0 :                 msg->is_as_node = false;
     271             :             }
     272             :         }
     273             : 
     274             :         //msg->dom.reset(impl);
     275             : 
     276          23 :         ret = msg;
     277             : 
     278          23 :         XMPP_UTDEBUG(XmppIqMessageProcess, connection->ToUVEKey(),
     279             :                      XMPP_PEER_DIR_IN, msg->node, msg->action, msg->from,
     280             :                      msg->to, msg->id, msg->iq_type);
     281          23 :         goto done;
     282             : 
     283          84 :     } else if (ts.find(sXMPP_MESSAGE) != string::npos) {
     284             : 
     285           0 :         if (impl->LoadDoc(ts) == -1) {
     286           0 :             XMPP_WARNING(XmppChatMessageParseFail, connection->ToUVEKey(),
     287             :                          XMPP_PEER_DIR_IN);
     288           0 :             goto done;
     289             :         }
     290             :         XmppStanza::XmppMessage *msg = new XmppStanza::XmppChatMessage(
     291           0 :                                            STATE_NONE);
     292           0 :         impl->ReadNode(sXMPP_MESSAGE_KEY);
     293             : 
     294           0 :         msg->to = XmppProto::GetTo(impl);
     295           0 :         msg->from = XmppProto::GetFrom(impl);
     296           0 :         ret = msg;
     297             : 
     298           0 :         XMPP_UTDEBUG(XmppChatMessageProcess, connection->ToUVEKey(),
     299             :                      XMPP_PEER_DIR_IN, msg->type, msg->from, msg->to);
     300           0 :         goto done;
     301             : 
     302          61 :     } else if (ts.find(sXMPP_STREAM_O) != string::npos) {
     303             : 
     304             :         // ensusre stream open is at the beginning of the message
     305          28 :         string ts_tmp = ts;
     306          28 :         ts_tmp.erase(std::remove(ts_tmp.begin(), ts_tmp.end(), '\n'), ts_tmp.end());
     307             : 
     308          28 :         if ((ts_tmp.compare(0, strlen(sXMPP_STREAM_START),
     309          56 :              sXMPP_STREAM_START) != 0) &&
     310          28 :             (ts_tmp.compare(0, strlen(sXMPP_STREAM_START_S),
     311             :              sXMPP_STREAM_START_S) != 0)) {
     312           0 :             XMPP_WARNING(XmppBadMessage, connection->ToUVEKey(),
     313             :                          XMPP_PEER_DIR_IN,
     314             :                          "Open message not at the beginning.", ts);
     315           0 :             goto done;
     316             :         }
     317             : 
     318             :         // check if the buf is xmpp open or response message
     319             :         // As end tag will be missing we need to modify the
     320             :         // string for stream open, else dom decoder will fail
     321          28 :         boost::algorithm::replace_last(ts_tmp, ">", "/>");
     322          28 :         if (impl->LoadDoc(ts_tmp) == -1) {
     323           0 :             XMPP_WARNING(XmppBadMessage, connection->ToUVEKey(),
     324             :                          XMPP_PEER_DIR_IN, "Open message parse failed.", ts);
     325           0 :             goto done;
     326             :         }
     327             : 
     328             :         XmppStanza::XmppStreamMessage *strm =
     329          28 :             new XmppStanza::XmppStreamMessage();
     330          28 :         strm->strmtype = XmppStanza::XmppStreamMessage::INIT_STREAM_HEADER;
     331          28 :         impl->ReadNode(ns);
     332          28 :         strm->to = XmppProto::GetTo(impl);
     333          28 :         strm->from = XmppProto::GetFrom(impl);
     334          28 :         strm->xmlns = XmppProto::GetXmlns(impl);
     335             : 
     336          28 :         ret = strm;
     337             : 
     338          28 :         XMPP_UTDEBUG(XmppRxOpenMessage, connection->ToUVEKey(),
     339             :                      XMPP_PEER_DIR_IN, strm->from, strm->to);
     340             : 
     341          61 :     } else if (ts.find(sXMPP_STREAM_NS_TLS) != string::npos) {
     342             : 
     343           3 :         if (impl->LoadDoc(ts) == -1) {
     344           0 :             XMPP_WARNING(XmppBadMessage, connection->ToUVEKey(),
     345             :                          XMPP_PEER_DIR_IN, "Stream TLS parse failed.", ts);
     346           0 :             goto done;
     347             :         }
     348             : 
     349             :         // find stream:features tls required
     350           4 :         if ((ts.find(sXMPP_STREAM_FEATURES_O) != string::npos) &&
     351           4 :             (ts.find(sXMPP_STREAM_STARTTLS_O) != string::npos) &&
     352           1 :             (ts.find(sXMPP_REQUIRED_O) != string::npos)) {
     353             : 
     354             :             XmppStanza::XmppStreamMessage *strm =
     355           1 :                 new XmppStanza::XmppStreamMessage();
     356           1 :             strm->strmtype = XmppStanza::XmppStreamMessage::FEATURE_TLS;
     357           1 :             strm->strmtlstype = XmppStanza::XmppStreamMessage::TLS_FEATURE_REQUEST;
     358             : 
     359           1 :             ret = strm;
     360             : 
     361           1 :             XMPP_UTDEBUG(XmppRxStreamTlsRequired, connection->ToUVEKey(),
     362             :                          XMPP_PEER_DIR_IN);
     363             : 
     364           2 :         } else if (ts.find(sXMPP_STREAM_STARTTLS_O) != string::npos) {
     365             :             XmppStanza::XmppStreamMessage *strm =
     366           1 :                 new XmppStanza::XmppStreamMessage();
     367           1 :             strm->strmtype = XmppStanza::XmppStreamMessage::FEATURE_TLS;
     368           1 :             strm->strmtlstype = XmppStanza::XmppStreamMessage::TLS_START;
     369           1 :             ret = strm;
     370             : 
     371           1 :             XMPP_UTDEBUG(XmppRxStreamStartTls, connection->ToUVEKey(),
     372             :                          XMPP_PEER_DIR_IN);
     373             : 
     374           1 :         } else if (ts.find(sXMPP_STREAM_PROCEED_O) != string::npos) {
     375             :             XmppStanza::XmppStreamMessage *strm =
     376           1 :                 new XmppStanza::XmppStreamMessage();
     377           1 :             strm->strmtype = XmppStanza::XmppStreamMessage::FEATURE_TLS;
     378           1 :             strm->strmtlstype = XmppStanza::XmppStreamMessage::TLS_PROCEED;
     379             : 
     380           1 :             ret = strm;
     381             : 
     382           1 :             XMPP_UTDEBUG(XmppRxStreamProceed, connection->ToUVEKey(),
     383             :                          XMPP_PEER_DIR_IN);
     384             :         }
     385           3 :         goto done;
     386             : 
     387          30 :     } else if (ts.find_first_of(sXMPP_VALIDWS) != string::npos) {
     388             : 
     389             :         XmppStanza::XmppMessage *msg =
     390          30 :             new XmppStanza::XmppMessage(WHITESPACE_MESSAGE_STANZA);
     391          30 :         return msg;
     392             :     } else {
     393           0 :         XMPP_WARNING(XmppBadMessage, connection->ToUVEKey(),
     394             :                      XMPP_PEER_DIR_IN, "Message not supported", ts);
     395             :     }
     396             : 
     397          54 : done:
     398             : 
     399          54 :     return ret;
     400          84 : }
     401             : 
     402          97 : int XmppProto::SetTo(string &to, XmlBase *doc) {
     403          97 :     if (!doc) return -1;
     404             : 
     405          97 :     string ns(sXMPP_STREAM_O);
     406          97 :     doc->ReadNode(ns);
     407          97 :     doc->ModifyAttribute("to", to);
     408             : 
     409          97 :     return 0;
     410          97 : }
     411             : 
     412          97 : int XmppProto::SetFrom(string &from, XmlBase *doc) {
     413          97 :     if (!doc) return -1;
     414             : 
     415          97 :     string ns(sXMPP_STREAM_O);
     416          97 :     doc->ReadNode(ns);
     417          97 :     return doc->ModifyAttribute("from", from);
     418          97 : }
     419             : 
     420          60 : int XmppProto::SetXmlns(const string &xmlns, XmlBase *doc) {
     421          60 :     if (!doc)
     422           0 :         return -1;
     423             : 
     424          60 :     string ns(sXMPP_STREAM_O);
     425          60 :     doc->ReadNode(ns);
     426          60 :     return doc->ModifyAttribute("xmlns", xmlns);
     427          60 : }
     428             : 
     429          51 : const char *XmppProto::GetTo(XmlBase *doc) {
     430          51 :     if (!doc) return NULL;
     431             : 
     432          51 :     string tmp("to");
     433          51 :     return doc->ReadAttrib(tmp);
     434          51 : }
     435             : 
     436          51 : const char *XmppProto::GetFrom(XmlBase *doc) {
     437          51 :     if (!doc) return NULL;
     438             : 
     439          51 :     string tmp("from");
     440          51 :     return doc->ReadAttrib(tmp);
     441          51 : }
     442             : 
     443          28 : const char *XmppProto::GetXmlns(XmlBase *doc) {
     444          28 :     if (!doc)
     445           0 :         return NULL;
     446             : 
     447          28 :     string tmp("xmlns");
     448          28 :     return doc->ReadAttrib(tmp);
     449          28 : }
     450             : 
     451          23 : const char *XmppProto::GetId(XmlBase *doc) {
     452          23 :     if (!doc) return NULL;
     453             : 
     454          23 :     string tmp("id");
     455          23 :     return doc->ReadAttrib(tmp);
     456          23 : }
     457             : 
     458          23 : const char *XmppProto::GetType(XmlBase *doc) {
     459          23 :     if (!doc) return NULL;
     460             : 
     461          23 :     string tmp("type");
     462          23 :     return doc->ReadAttrib(tmp);
     463          23 : }
     464             : 
     465          23 : const char *XmppProto::GetAction(XmlBase *doc, const string &str) {
     466          23 :     if (!doc) return NULL;
     467             : 
     468          23 :     if (str.compare("set") == 0) {
     469           8 :         doc->ReadNode("pubsub");
     470           8 :         return(doc->ReadChildNodeName());
     471          15 :     } else if (str.compare("get") == 0) {
     472             :     }
     473             : 
     474          15 :     return(NULL);
     475             : }
     476             : 
     477          31 : const char *XmppProto::GetNode(XmlBase *doc, const string &str) {
     478          31 :     if (!doc) return NULL;
     479             : 
     480          31 :     if (!str.empty()) {
     481          16 :         return(doc->ReadAttrib("node"));
     482             :     }
     483             : 
     484          15 :     return(NULL);
     485             : }
     486             : 
     487           4 : const char *XmppProto::GetAsNode(XmlBase *doc) {
     488           4 :     if (!doc) return NULL;
     489             : 
     490           4 :     const char *node = doc->ReadNode("associate");
     491           4 :     if (node != NULL) {
     492           4 :         return(doc->ReadAttrib("node"));
     493             :     }
     494             : 
     495           0 :     return(NULL);
     496             : }
     497             : 
     498           0 : const char *XmppProto::GetDsNode(XmlBase *doc) {
     499           0 :     if (!doc) return NULL;
     500             : 
     501           0 :     const char *node = doc->ReadNode("dissociate");
     502           0 :     if (node != NULL) {
     503           0 :         return(doc->ReadAttrib("node"));
     504             :     }
     505             : 
     506           0 :     return(NULL);
     507             : }