source/diameter/codec/Message.cpp

   1 // ANNA - Anna is Not Nothingness Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // http://redmine.teslayout.com/projects/anna-suite
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     *  Neither the name of the copyright holder nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 // Local
  38 #include <anna/diameter/codec/Message.hpp>
  39 #include <anna/diameter/codec/Format.hpp>
  40
  41 #include <anna/diameter/codec/functions.hpp> // REQUIRED_WORDS
  42 #include <anna/config/defines.hpp> // general types, decoding helpers (DECODE[2/3/4]BYTES_INDX_VALUETYPE), etc.
  43 #include <anna/diameter/functions.hpp>
  44 #include <anna/diameter/codec/functions.hpp> // REQUIRED_WORDS
  45 #include <anna/diameter/codec/OamModule.hpp>
  46 #include <anna/diameter/codec/Engine.hpp>
  47 #include <anna/diameter/stack/Avp.hpp>
  48 #include <anna/diameter/stack/Format.hpp>
  49 #include <anna/diameter/stack/Dictionary.hpp>
  50 #include <anna/diameter/stack/Engine.hpp>
  51 #include <anna/core/functions.hpp>
  52 #include <anna/core/util/RegularExpression.hpp>
  53 #include <anna/diameter/helpers/base/defines.hpp>
  54
  55 #include <anna/core/tracing/Logger.hpp>
  56 #include <anna/core/functions.hpp>
  57 #include <anna/core/tracing/TraceMethod.hpp>
  58 #include <anna/xml/xml.hpp>
  59
  60 // STL
  61 #include <string>
  62 #include <vector>
  63
  64
  65 using namespace anna;
  66 using namespace anna::diameter::codec;
  67
  68
  69 //static
  70 namespace anna {
  71
  72 namespace diameter {
  73
  74 namespace codec {
  75 const int Message::HeaderLength(20);
  76 const U8 Message::RBitMask(0x80);
  77 const U8 Message::PBitMask(0x40);
  78 const U8 Message::EBitMask(0x20);
  79 const U8 Message::TBitMask(0x10);
  80 }
  81 }
  82 }
  83
  84 //------------------------------------------------------------------------------
  85 //----------------------------------------------------------- Message::Message()
  86 //------------------------------------------------------------------------------
  87 Message::Message() : a_forCode(true) {
  88   initialize();
  89 }
  90
  91
  92 //------------------------------------------------------------------------------
  93 //----------------------------------------------------------- Message::Message()
  94 //------------------------------------------------------------------------------
  95 Message::Message(CommandId id) : a_forCode(true) {
  96   initialize();
  97   setId(id);
  98 }
  99
 100
 101 //------------------------------------------------------------------------------
 102 //---------------------------------------------------------- Message::~Message()
 103 //------------------------------------------------------------------------------
 104 Message::~Message() {
 105   clear();
 106 }
 107
 108
 109 //------------------------------------------------------------------------------
 110 //--------------------------------------------------------- Message::getEngine()
 111 //------------------------------------------------------------------------------
 112 Engine * Message::getEngine() const throw(anna::RuntimeException) {
 113   return a_engine ? a_engine : (a_engine = anna::functions::component <Engine> (ANNA_FILE_LOCATION));
 114 }
 115
 116
 117 //------------------------------------------------------------------------------
 118 //-------------------------------------------------------- Message::initialize()
 119 //------------------------------------------------------------------------------
 120 void Message::initialize() throw() {
 121   a_engine = NULL;
 122   a_version = 1;
 123   a_id = CommandId(0, false);
 124   a_flags = 0x00;
 125   a_applicationId = 0;
 126   a_hopByHop = 0;
 127   a_endToEnd = 0;
 128   //a_avps.clear();
 129   a_insertionPositionForChilds = 0;
 130   //a_finds.clear();
 131 }
 132
 133
 134 //------------------------------------------------------------------------------
 135 //------------------------------------------------------------- Message::clear()
 136 //------------------------------------------------------------------------------
 137 void Message::clear() throw(anna::RuntimeException) {
 138   for(avp_iterator it = avp_begin(); it != avp_end(); it++) { /*avp(it)->clear(); */getEngine()->releaseAvp(Avp::avp(it)); }
 139
 140   a_avps.clear();
 141   a_forCode.clear();
 142   // Cache system:
 143   a_finds.clear();
 144   // Initialize:
 145   initialize();
 146 }
 147
 148
 149 //------------------------------------------------------------------------------
 150 //----------------------------------------------------------- Message::flagsOK()
 151 //------------------------------------------------------------------------------
 152 bool Message::flagsOK(int &rc) const throw() {
 153   // Dictionary stack command:
 154   const stack::Command *stackCommand = getStackCommand();
 155
 156   if(!stackCommand) {
 157     anna::Logger::error("Impossible to decide if flags are correct because stack command is not identified. Assume flags ok", ANNA_FILE_LOCATION);
 158     //rc = helpers::base::AVPVALUES__Result_Code::?????;
 159     return true;
 160   };
 161
 162   // DIAMETER_INVALID_HDR_BITS 3008
 163   //
 164   //      A request was received whose bits in the Diameter header were set
 165   //      either to an invalid combination or to a value that is
 166   //      inconsistent with the Command Code's definition.
 167   bool ok = true;
 168
 169   if(stackCommand->isRequest() != isRequest()) ok = false;  // en teoria es imposible salir por aqui: blindado en la dtd
 170
 171   if(isRequest() && errorBit()) {
 172     anna::Logger::error("E(rror) bit is not allowed at diameter requests", ANNA_FILE_LOCATION);
 173     ok = false;
 174   }
 175
 176   if(isAnswer() && potentiallyReTransmittedMessageBit()) {
 177     anna::Logger::error("T(Potentially re-transmitted message) bit is not allowed at diameter answers", ANNA_FILE_LOCATION);
 178     ok = false;
 179   }
 180
 181   if(!ok) {
 182     rc = helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_HDR_BITS;
 183     return false;
 184   }
 185
 186   // DIAMETER_INVALID_BIT_IN_HEADER 5013
 187   //
 188   //      This error is returned when a reserved bit in the Diameter header
 189   //      is set to one (1) or the bits in the Diameter header are set
 190   //      incorrectly.
 191   if((a_flags & 0x0f) != 0x00) {
 192     anna::Logger::error("Any (or more than one) of the reserved message flags bit has been activated. Reserved bits must be null", ANNA_FILE_LOCATION);
 193     rc = helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_BIT_IN_HEADER;
 194     return false;
 195   }
 196
 197   return true;
 198 }
 199
 200
 201 //------------------------------------------------------------------------------
 202 //------------------------------------------------------------- Message::setId()
 203 //------------------------------------------------------------------------------
 204 void Message::setId(CommandId id, bool _clear) throw(anna::RuntimeException) {
 205   // Clear class content:
 206   if(_clear) clear();
 207
 208   // Id assignment:
 209   a_id = id;
 210   // Dictionary stack command:
 211   const stack::Command *stackCommand = getStackCommand(); // based on dictionary and a_id
 212
 213   // Dictionary flags for known types:
 214   if(stackCommand) {
 215     if(stackCommand->isRequest()) a_flags |= RBitMask;
 216   } else {
 217     if(a_id.second) a_flags |= RBitMask; else a_flags &= (~RBitMask);
 218   }
 219 }
 220
 221
 222 //------------------------------------------------------------------------------
 223 //------------------------------------------------------------- Message::setId()
 224 //------------------------------------------------------------------------------
 225 void Message::setId(const char *name) throw(anna::RuntimeException) {
 226   setId(getEngine()->commandIdForName(name));
 227 }
 228
 229
 230 //------------------------------------------------------------------------------
 231 //-------------------------------------------------- Message::setApplicationId()
 232 //------------------------------------------------------------------------------
 233 void Message::setApplicationId(U32 aid) throw() {
 234   a_applicationId = aid;
 235
 236   // Default behaviour:
 237   if (!getEngine()->hasSelectStackWithApplicationId()) return;
 238
 239   // Adapts for Application-ID stack identifier:
 240   getEngine()->setDictionary(aid);
 241 }
 242
 243
 244 //------------------------------------------------------------------------------
 245 //------------------------------------------------------------ Message::addAvp()
 246 //------------------------------------------------------------------------------
 247 Avp * Message::addAvp(const char *name) throw(anna::RuntimeException) {
 248   return addAvp(getEngine()->avpIdForName(name));
 249 }
 250
 251
 252 //------------------------------------------------------------------------------
 253 //--------------------------------------------------------- Message::removeAvp()
 254 //------------------------------------------------------------------------------
 255 bool Message::removeAvp(const char *name, int ocurrence) throw(anna::RuntimeException) {
 256   return removeAvp(getEngine()->avpIdForName(name), ocurrence);
 257 }
 258
 259
 260 //------------------------------------------------------------------------------
 261 //----------------------------------------------------------- Message::_getAvp()
 262 //------------------------------------------------------------------------------
 263 const Avp * Message::_getAvp(const char *name, int ocurrence, anna::Exception::Mode::_v emode) const throw(anna::RuntimeException) {
 264   return getAvp(getEngine()->avpIdForName(name), ocurrence, emode);
 265 }
 266
 267
 268 //------------------------------------------------------------------------------
 269 //---------------------------------------------------------- Message::countAvp()
 270 //------------------------------------------------------------------------------
 271 int Message::countAvp(const char *name) const throw(anna::RuntimeException) {
 272   return countAvp(getEngine()->avpIdForName(name));
 273 }
 274
 275
 276 //------------------------------------------------------------------------------
 277 //--------------------------------------------------------- Message::getLength()
 278 //------------------------------------------------------------------------------
 279 U24 Message::getLength() const throw() {
 280   U24 result;
 281   // Header length:
 282   result = HeaderLength;
 283
 284   for(const_avp_iterator it = avp_begin(); it != avp_end(); it++) result += 4 * REQUIRED_WORDS(Avp::avp(it)->getLength());
 285
 286   return result;
 287 }
 288
 289
 290 //------------------------------------------------------------------------------
 291 //------------------------------------------------------------ Message::decode()
 292 //------------------------------------------------------------------------------
 293 void Message::decode(const anna::DataBlock &db, Message *ptrAnswer) throw(anna::RuntimeException) {
 294   // Trace
 295   LOGDEBUG(
 296     anna::xml::Node root("Message::decode");
 297     std::string trace = "DataBlock to decode:\n";
 298     trace += db.asString();
 299     anna::Logger::debug(trace, ANNA_FILE_LOCATION);
 300   );
 301   clear();
 302   // EXCEPTION MANAGEMENT IN THIS METHOD
 303   // ===================================
 304   // DECODE PHASE
 305   // If an error ocurred, decoding will stop launching exception but we will catch it and go on with validation because perhaps
 306   //  the achieved message could be valid against all odds. Only fatal errors cause direct decoding exception (length problems
 307   //  at header).
 308   //
 309   // VALIDATION PHASE
 310   // Launch exception on first validation error (validateAll == false), or log warning reporting all validation errors when
 311   //  complete validation is desired (validateAll == true, engine default) launching a final exception like "the decoded message is invalid".
 312   // OAM
 313   OamModule &oamModule = OamModule::instantiate();
 314
 315   if(db.getSize() < HeaderLength) {
 316     oamModule.activateAlarm(OamModule::Alarm::MessageDecode__NotEnoughBytesToCoverMessageHeaderLength);
 317     oamModule.count(OamModule::Counter::MessageDecode__NotEnoughBytesToCoverMessageHeaderLength);
 318     // DIAMETER_INVALID_MESSAGE_LENGTH; // no podr� construir un answer fiable, as� que no registro el result-code
 319     throw anna::RuntimeException("Not enough bytes to cover message header length (20 bytes)", ANNA_FILE_LOCATION);
 320   }
 321
 322   const char * buffer = db.getData();
 323
 324   //         0                   1                   2                   3
 325   //         0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 326   //        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 327   //        |    Version    |                 Message Length                |
 328   //        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 329   //        | command flags |                  Command-Code                 |
 330   //        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 331   //        |                         Application-ID                        |
 332   //        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 333   //        |                      Hop-by-Hop Identifier                    |
 334   //        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 335   //        |                      End-to-End Identifier                    |
 336   //        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 337   //        |  AVPs ...
 338   //        +-+-+-+-+-+-+-+-+-+-+-+-+-
 339   // Header fields:
 340   a_version = (S8)buffer[0];
 341
 342   U24 length = DECODE3BYTES_INDX_VALUETYPE(buffer, 1, U24); // total length including header fields
 343
 344   a_flags = (S8)buffer[4];
 345
 346   U24 code = DECODE3BYTES_INDX_VALUETYPE(buffer, 5, U24);
 347
 348   a_id = CommandId(code, requestBit() /* based on a_flags */);
 349
 350   setApplicationId(DECODE4BYTES_INDX_VALUETYPE(buffer, 8, U32)); // centralize set, because it could be used for stack selection.
 351
 352   a_hopByHop = DECODE4BYTES_INDX_VALUETYPE(buffer, 12, U32);
 353
 354   a_endToEnd = DECODE4BYTES_INDX_VALUETYPE(buffer, 16, U32);
 355
 356   // Only build answer for a request:
 357   Message *answer = isRequest() ? ptrAnswer : NULL;
 358
 359   if(answer) answer->setHeaderToAnswer(*this);
 360
 361   // Length check:
 362   if(db.getSize() < length) {
 363     oamModule.activateAlarm(OamModule::Alarm::MessageDecode__NotEnoughBytesToCoverMessageLength);
 364     oamModule.count(OamModule::Counter::MessageDecode__NotEnoughBytesToCoverMessageLength);
 365
 366     if(answer) answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_MESSAGE_LENGTH);
 367
 368     throw anna::RuntimeException("Not enough bytes to cover message length", ANNA_FILE_LOCATION);
 369   }
 370
 371   // Message identifier
 372   // Flags could have been updated regarding dictionary, but during decoding we must respect buffer received:
 373   a_flags = (S8)buffer[4];
 374   // Avps start position:
 375   const S8 * startData = buffer + HeaderLength;
 376   U24 dataBytes = length - HeaderLength;
 377
 378   if(dataBytes < 8 /* minimum avp */) {
 379     LOGDEBUG(anna::Logger::debug("Message empty (without avps)", ANNA_FILE_LOCATION));
 380     return;
 381   }
 382
 383   int avpPos = 0;
 384   Avp* avp;
 385   anna::DataBlock db_aux;
 386
 387   // Parent information:
 388   parent_t parent;
 389   parent.setMessage(a_id);
 390
 391
 392   while(avpPos < dataBytes) {
 393     try {
 394       avp =  getEngine()->allocateAvp();
 395       db_aux.assign(startData + avpPos, dataBytes - avpPos /* is valid to pass total length (indeed i don't know the real avp length) because it will be limited and this has deep copy disabled (no memory is reserved) */);
 396       avp -> decode(db_aux, parent, answer);
 397     } catch(anna::RuntimeException &ex) {
 398       getEngine()->releaseAvp(avp);
 399       LOGWARNING(
 400         anna::Logger::warning(ex.getText(), ANNA_FILE_LOCATION);
 401         anna::Logger::warning("Although a decoding error was found, validation could be checked because message could be enough for the application", ANNA_FILE_LOCATION);
 402       );
 403       break;
 404     }
 405
 406     addChild(avp);
 407     avpPos += 4 * REQUIRED_WORDS(avp->getLength());
 408   }
 409
 410   // Post-Fixing
 411   Engine::FixMode::_v fmode = getEngine()->getFixMode();
 412
 413   if((fmode == Engine::FixMode::AfterDecoding) || (fmode == Engine::FixMode::Always)) fix();
 414
 415   // Trace
 416   LOGDEBUG(
 417     std::string trace = "Message decoded:\n";
 418     trace += asXMLString();
 419     anna::Logger::debug(trace, ANNA_FILE_LOCATION);
 420   );
 421   // Post-Validation
 422   Engine::ValidationMode::_v vmode = getEngine()->getValidationMode();
 423
 424   if((vmode == Engine::ValidationMode::AfterDecoding) || (vmode == Engine::ValidationMode::Always))
 425     if(!valid(answer))
 426       throw anna::RuntimeException("The decoded message is invalid. See previous report on warning-level traces", ANNA_FILE_LOCATION);
 427 }
 428
 429
 430 //------------------------------------------------------------------------------
 431 //--------------------------------------------------- Message::getStackCommand()
 432 //------------------------------------------------------------------------------
 433 const anna::diameter::stack::Command *Message::getStackCommand(CommandId id) const throw(anna::RuntimeException) {
 434   const stack::Dictionary * dictionary = getEngine()->getDictionary();
 435   return (dictionary ? (dictionary->getCommand(id)) : NULL);
 436 }
 437
 438
 439 //------------------------------------------------------------------------------
 440 //----------------------------------------------------- Message::setResultCode()
 441 //------------------------------------------------------------------------------
 442 void Message::setResultCode(int rc) throw(anna::RuntimeException) {
 443   if(isRequest()) return;
 444
 445   // Add Result-Code if not yet added. Even if validation depth is set to 'Complete',
 446   // the Result-Code value will be the first found during the message analysis:
 447   Avp *resultCodeAvp = getAvp(helpers::base::AVPID__Result_Code, 1, anna::Exception::Mode::Ignore);
 448
 449   if(!resultCodeAvp)
 450     addAvp(helpers::base::AVPID__Result_Code)->getUnsigned32()->setValue(rc);
 451   else if(resultCodeAvp->getUnsigned32()->getValue() == helpers::base::AVPVALUES__Result_Code::DIAMETER_SUCCESS)  // Only success could be replaced
 452     resultCodeAvp->getUnsigned32()->setValue(rc);
 453
 454   // Error bit:
 455   setErrorBit(rc >= 3001 && rc <= 3010 /* protocol errors */);
 456 }
 457
 458
 459 //------------------------------------------------------------------------------
 460 //----------------------------------------------------- Message::getResultCode()
 461 //------------------------------------------------------------------------------
 462 int Message::getResultCode() const throw() {
 463   if(isAnswer()) {
 464     const Avp *resultCodeAvp = getAvp(helpers::base::AVPID__Result_Code, 1, anna::Exception::Mode::Ignore);
 465
 466     if(resultCodeAvp)
 467       return resultCodeAvp->getUnsigned32()->getValue();
 468   }
 469
 470   return -1;
 471 }
 472
 473
 474 //------------------------------------------------------------------------------
 475 //------------------------------------------------------ Message::setFailedAvp()
 476 //------------------------------------------------------------------------------
 477 void Message::setFailedAvp(const parent_t &parent, AvpId wrong, const char *wrongName) throw(anna::RuntimeException) {
 478
 479   if(isRequest()) return;
 480
 481 // RFC 6733:
 482 //
 483 //  7.5.  Failed-AVP AVP
 484 //
 485 //     The Failed-AVP AVP (AVP Code 279) is of type Grouped and provides
 486 //     debugging information in cases where a request is rejected or not
 487 //     fully processed due to erroneous information in a specific AVP.  The
 488 //     value of the Result-Code AVP will provide information on the reason
 489 //     for the Failed-AVP AVP.  A Diameter answer message SHOULD contain an
 490 //     instance of the Failed-AVP AVP that corresponds to the error
 491 //     indicated by the Result-Code AVP.  For practical purposes, this
 492 //     Failed-AVP would typically refer to the first AVP processing error
 493 //     that a Diameter node encounters.
 494
 495   // Although the Failed-AVP definition has cardinality 1* and Failed-AVP itself is defined in
 496   // most of the command codes as *[Failed-AVP], i think this is not a deliberate ambiguity.
 497   // Probably the RFC wants to give freedom to the application layer, but it is recommended to
 498   // have only one child (wrong avp) inside a unique message Failed-AVP to ease the Result-Code
 499   // correspondence. Anyway, this behaviour could be easily  opened commenting condition block (*).
 500   Avp *theFailedAvp = getAvp(helpers::base::AVPID__Failed_AVP, 1, anna::Exception::Mode::Ignore);
 501   if (theFailedAvp) {
 502         LOGDEBUG(anna::Logger::debug("Failed-AVP has already been added. RFC 6733 Section 7.5 recommends to store only the first error found", ANNA_FILE_LOCATION));
 503     return;
 504   }
 505
 506   // Section 7.5 RFC 6733: A Diameter message SHOULD contain one Failed-AVP AVP
 507   theFailedAvp = addAvp(helpers::base::AVPID__Failed_AVP);
 508   Avp *leaf = theFailedAvp;
 509
 510   LOGDEBUG(
 511     std::string msg = "Adding to Failed-AVP, the wrong avp ";
 512     msg += wrongName ? wrongName : (anna::diameter::functions::avpIdAsPairString(wrong));
 513     msg += " found inside ";
 514     msg += parent.asString();
 515
 516     anna::Logger::debug(msg, ANNA_FILE_LOCATION);
 517   );
 518
 519   std::vector<AvpId>::const_iterator it;
 520   for(it = parent.AvpsId.begin(); it != parent.AvpsId.end(); it++)
 521         leaf = leaf->addAvp(*it);
 522
 523   leaf->addAvp(wrong);
 524 }
 525
 526
 527 //------------------------------------------------------------------------------
 528 //----------------------------------------------- Message::setStandardToAnswer()
 529 //------------------------------------------------------------------------------
 530 void Message::setStandardToAnswer(const Message &request, const std::string &originHost, const std::string &originRealm, int resultCode) throw() {
 531   if(!request.getId().second) return;
 532
 533   // Message header:
 534   setHeaderToAnswer(request);
 535   // Session-Id if exists:
 536   const Avp *reqSessionId = request.getAvp(helpers::base::AVPID__Session_Id, 1, anna::Exception::Mode::Ignore);
 537
 538   if(reqSessionId)
 539         if(!getAvp(helpers::base::AVPID__Session_Id, 1, anna::Exception::Mode::Ignore))
 540       addAvp(helpers::base::AVPID__Session_Id)->getUTF8String()->setValue(reqSessionId->getUTF8String()->getValue());
 541
 542   // Origin-Host & Realm
 543   if(!getAvp(helpers::base::AVPID__Origin_Host, 1, anna::Exception::Mode::Ignore))
 544     addAvp(helpers::base::AVPID__Origin_Host)->getDiameterIdentity()->setValue(originHost);
 545
 546   if(!getAvp(helpers::base::AVPID__Origin_Realm, 1, anna::Exception::Mode::Ignore))
 547     addAvp(helpers::base::AVPID__Origin_Realm)->getDiameterIdentity()->setValue(originRealm);
 548
 549   // Proxy-Info AVPs if exist, in the same order:
 550   for(const_avp_iterator it = request.avp_begin(); it != request.avp_end(); it++)
 551     if((*it).second->getId() == helpers::base::AVPID__Proxy_Info)
 552       addAvp((*it).second);
 553
 554   // If no Result-Code was added is because all was ok, then application could detect another problem:
 555   setResultCode(resultCode);
 556   // Fix:
 557   fix();
 558   LOGDEBUG(
 559     std::string msg = "Completed answer:\n";
 560     msg += asXMLString();
 561     anna::Logger::debug(msg, ANNA_FILE_LOCATION);
 562   );
 563 }
 564
 565
 566 //------------------------------------------------------------------------------
 567 //--------------------------------------------------------------- Message::fix()
 568 //------------------------------------------------------------------------------
 569 void Message::fix() throw() {
 570   // Dictionary stack command:
 571   const stack::Command *stackCommand = getStackCommand();
 572
 573   if(!stackCommand) {
 574     LOGDEBUG(anna::Logger::debug("No dictionary command reference found. Cannot fix.", ANNA_FILE_LOCATION));
 575     // Try to get to the first place the Session-ID (if exists) because...
 576     // RFC 6733: All messages pertaining to a specific session MUST include only one Session-Id AVP ...
 577     //           ... When present, the Session-Id SHOULD appear immediately following the Diameter header
 578     avp_iterator it = Avp::avp_find(a_avps, helpers::base::AVPID__Session_Id, 1 /* one and only */);
 579
 580     if(it != avp_end()) {
 581       int sessionPos = (*it).first;
 582       Avp *first = (*avp_begin()).second;
 583       a_avps[0] = (*it).second; // Session-Id
 584       a_avps[sessionPos] = first;
 585       LOGDEBUG(anna::Logger::debug("Session-Id has been manually fixed to the first place", ANNA_FILE_LOCATION));
 586     }
 587
 588     return;
 589   }
 590
 591   Avp::fix(a_avps, (find_container&)a_finds, a_insertionPositionForChilds, stackCommand->avprule_begin(), stackCommand->avprule_end());
 592 }
 593
 594
 595 //------------------------------------------------------------------------------
 596 //------------------------------------------------------------- Message::valid()
 597 //------------------------------------------------------------------------------
 598 bool Message::valid(Message *ptrAnswer) const throw(anna::RuntimeException) {
 599   // OAM
 600   OamModule &oamModule = OamModule::instantiate();
 601   // Dictionary stack command:
 602   const stack::Command *stackCommand = getStackCommand();
 603   // Only build answer for a request:
 604   Message *answer = isRequest() ? ptrAnswer : NULL;
 605
 606   if(answer) answer->setHeaderToAnswer(*this);
 607
 608   if(!stackCommand) {
 609     // OAM
 610     std::string me = anna::diameter::functions::commandIdAsPairString(a_id);
 611     oamModule.activateAlarm(OamModule::Alarm::MessageValidation__UnknownOperation__s__UnableToValidate, STRING_WITH_QUOTATION_MARKS__C_STR(me));
 612     oamModule.count(OamModule::Counter::MessageValidation__UnknownOperationUnableToValidate);
 613
 614     if(answer) answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_COMMAND_UNSUPPORTED);
 615
 616     getEngine()->validationAnomaly(anna::functions::asString("Unknown operation %s. Unable to validate", STRING_WITH_QUOTATION_MARKS__C_STR(me)));
 617     return false;
 618   }
 619
 620   // Parent information:
 621   parent_t me;
 622   me.setMessage(a_id, stackCommand->getName().c_str());
 623
 624   //////////////////////////////
 625   // Flags coherence checking //
 626   //////////////////////////////
 627   int rc;
 628   bool result = flagsOK(rc);
 629
 630   if(!result) {
 631     // OAM & Depth management
 632     oamModule.activateAlarm(OamModule::Alarm::MessageValidation__Operation__s__HaveIncoherentFlags__d__, STRING_WITH_QUOTATION_MARKS__C_STR(me.asString()), (int)a_flags);
 633     oamModule.count(OamModule::Counter::MessageValidation__OperationHaveIncoherentFlags);
 634
 635     if(answer) answer->setResultCode(rc);
 636
 637     getEngine()->validationAnomaly(anna::functions::asString("Operation %s have incoherent flags (%d)", STRING_WITH_QUOTATION_MARKS__C_STR(me.asString()), (int)a_flags));
 638   }
 639
 640   ////////////////////
 641   // Level checking //
 642   ////////////////////
 643   result = Avp::validLevel(a_avps, stackCommand->avprule_begin(), stackCommand->avprule_end(), getEngine(), me, answer) && result;
 644
 645   ////////////////////////
 646   // Childrens checking //
 647   ////////////////////////
 648   for(const_avp_iterator it = avp_begin(); it != avp_end(); it++)
 649     result = ((*it).second->valid(me, answer)) && result;
 650
 651   return result;
 652 }
 653
 654
 655 //------------------------------------------------------------------------------
 656 //-------------------------------------------------------------- Message::code()
 657 //------------------------------------------------------------------------------
 658 const anna::DataBlock & Message::code() throw(anna::RuntimeException) {
 659   // Pre-Validation
 660   Engine::ValidationMode::_v vmode = getEngine()->getValidationMode();
 661
 662   if((vmode == Engine::ValidationMode::BeforeCoding) || (vmode == Engine::ValidationMode::Always)) {
 663     if(!valid())
 664       throw anna::RuntimeException("Try to encode an invalid message. See previous report on warning-level traces", ANNA_FILE_LOCATION);
 665   }
 666
 667   // Pre-Fixing
 668   Engine::FixMode::_v fmode = getEngine()->getFixMode();
 669
 670   if((fmode == Engine::FixMode::BeforeCoding) || (fmode == Engine::FixMode::Always)) fix();
 671
 672   // Trace
 673   LOGDEBUG(
 674     std::string trace = "Message to code:\n";
 675     trace += asXMLString();
 676     anna::Logger::debug(trace, ANNA_FILE_LOCATION);
 677   );
 678   // Memory allocation
 679   U24 length = getLength();
 680   a_forCode.clear();
 681   a_forCode.allocate(length);
 682   char* buffer = (char*)a_forCode.getData();
 683   // Version and length
 684   buffer[0] = (S8) a_version;
 685   buffer[1] = (S8)(length >> 16);
 686   buffer[2] = (S8)(length >> 8);
 687   buffer[3] = (S8) length;
 688   // Flags and code
 689   buffer[4] = (S8) a_flags;
 690   buffer[5] = (S8)(a_id.first >> 16);
 691   buffer[6] = (S8)(a_id.first >> 8);
 692   buffer[7] = (S8) a_id.first;
 693   // Application Id
 694   buffer[8] = (S8)(a_applicationId >> 24);
 695   buffer[9] = (S8)(a_applicationId >> 16);
 696   buffer[10] = (S8)(a_applicationId >> 8);
 697   buffer[11] = (S8) a_applicationId;
 698   // Hob by hop
 699   buffer[12] = (S8)(a_hopByHop >> 24);
 700   buffer[13] = (S8)(a_hopByHop >> 16);
 701   buffer[14] = (S8)(a_hopByHop >> 8);
 702   buffer[15] = (S8) a_hopByHop;
 703   // End to end
 704   buffer[16] = (S8)(a_endToEnd >> 24);
 705   buffer[17] = (S8)(a_endToEnd >> 16);
 706   buffer[18] = (S8)(a_endToEnd >> 8);
 707   buffer[19] = (S8) a_endToEnd;
 708   // Data start position:
 709   int startDataPos = HeaderLength;
 710
 711   if(startDataPos == length) {
 712     LOGDEBUG(anna::Logger::debug("There is no Avps to encode (only-header message)", ANNA_FILE_LOCATION));
 713   } else {
 714     // Data part:
 715     S8 * dataPart = buffer + startDataPos;
 716     int dataBytes; // not used but could be useful for checking (length - startDataPos)
 717     // Each avp encoding will remain padding octets depending on format. In order to
 718     //  code avps colection (each avp will be multiple of 4) we clean the entire buffer
 719     //  to ensure padding (easier than custom-made for each format):
 720     memset(dataPart, 0, length - startDataPos); // no estoy seguro de que el clear del DataBlock haga esto...
 721
 722     for(const_avp_iterator it = avp_begin(); it != avp_end(); it++) {
 723       Avp::avp(it)->code(dataPart, dataBytes);
 724       dataPart = dataPart + 4 * REQUIRED_WORDS(dataBytes);
 725     }
 726   }
 727
 728   // Trace
 729   LOGDEBUG(
 730     std::string trace = "DataBlock encoded:\n";
 731     trace += a_forCode.asString();
 732 //      trace += "\nAs continuous hexadecimal string:\n";
 733 //      trace += anna::functions::asHexString(a_forCode);
 734     anna::Logger::debug(trace, ANNA_FILE_LOCATION);
 735   );
 736   return a_forCode;
 737 }
 738
 739
 740 //------------------------------------------------------------------------------
 741 //----------------------------------------------------- Message::fromXMLString()
 742 //------------------------------------------------------------------------------
 743 void Message::fromXMLString(const std::string &xmlString) throw(anna::RuntimeException) {
 744   LOGDEBUG(anna::Logger::debug("Reading diameter message from xml string representation", ANNA_FILE_LOCATION));
 745   anna::xml::DocumentMemory xmlDocument; // has private copy constructor defined but not implemented to avoid inhenrit/copy (is very heavy)
 746   const anna::xml::Node *rootNode;
 747   xmlDocument.initialize(xmlString.c_str());
 748   rootNode = xmlDocument.parse(getEngine()->getDTD()); // Parsing: fail here if xml violates dtd
 749   LOGDEBUG(anna::Logger::debug("Read OK from XML string representation", ANNA_FILE_LOCATION));
 750   fromXML(rootNode);
 751 }
 752
 753
 754 //------------------------------------------------------------------------------
 755 //----------------------------------------------------------- Message::fromXML()
 756 //------------------------------------------------------------------------------
 757 void Message::fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeException) {
 758   // <!ATTLIST message version CDATA #IMPLIED name CDATA #IMPLIED code CDATA #IMPLIED flags CDATA #IMPLIED p-bit (yes | no) #IMPLIED e-bit (yes | no) #IMPLIED t-bit (yes | no) #IMPLIED application-id CDATA #REQUIRED hop-by-hop-id CDATA #IMPLIED end-by-end-id CDATA #IMPLIED>
 759   const anna::xml::Attribute *version, *name, *code, *flags, *pbit, *ebit, *tbit, *appid, *hbh, *ete;
 760   version = messageNode->getAttribute("version", false /* no exception */);
 761   name = messageNode->getAttribute("name", false /* no exception */);
 762   code = messageNode->getAttribute("code", false /* no exception */);
 763   flags = messageNode->getAttribute("flags", false /* no exception */);
 764   pbit = messageNode->getAttribute("p-bit", false /* no exception */);
 765   ebit = messageNode->getAttribute("e-bit", false /* no exception */);
 766   tbit = messageNode->getAttribute("t-bit", false /* no exception */);
 767   appid = messageNode->getAttribute("application-id"); // required
 768   hbh = messageNode->getAttribute("hop-by-hop-id", false /* no exception */);
 769   ete = messageNode->getAttribute("end-by-end-id", false /* no exception */);
 770   int i_aux;
 771   unsigned int u_aux;
 772
 773   // Clear the message
 774   clear();
 775
 776   if(version) {
 777     i_aux = version->getIntegerValue();
 778
 779     if(i_aux < 0 || i_aux > 256) {
 780       std::string msg = "Error processing avp <version '"; msg += version->getValue();
 781       msg += "': out of range [0,256]";
 782       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
 783     }
 784
 785     a_version = i_aux;
 786   }
 787
 788   // Application-id
 789   // This is called before any operation which needs to know about the stack elements (this could set the dictionary)
 790   setApplicationId(appid->getIntegerValue());
 791
 792   // Dictionary
 793   const stack::Dictionary * dictionary = getEngine()->getDictionary();
 794   const stack::Command *stackCommand = NULL;
 795
 796   // Compact mode
 797   if(name) {
 798     if(!dictionary) {
 799       std::string msg = "Error processing command <name '"; msg += name->getValue();
 800       msg += "'>: no dictionary available. Load one or use <'code' + 'flags'> instead of <'name'>";
 801       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
 802     }
 803
 804     stackCommand = dictionary->getCommand(name->getValue());
 805
 806     if(!stackCommand) {
 807       std::string msg = "Error processing command <name '"; msg += name->getValue();
 808       msg += "'>: no command found for this identifier at available dictionary";
 809       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
 810     }
 811   }
 812
 813   // Check attributes exclusiveness
 814   if(name) {  // compact mode
 815     if(code || flags) {
 816       std::string msg = "Error processing command <name '"; msg += name->getValue();
 817       msg += "'>: message attributes <'code' + 'flags'> are not allowed if <'name'> is provided";
 818       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
 819     }
 820
 821     setId(stackCommand->getId(), false /* don't clear */);
 822     // 'P', 'E' and 'T' flags:
 823     bool activateP = pbit ? (pbit->getValue() == "yes") : false;
 824     bool activateE = ebit ? (ebit->getValue() == "yes") : false;
 825     bool activateT = tbit ? (tbit->getValue() == "yes") : false;
 826
 827     if(activateP) a_flags |= PBitMask;
 828
 829     if(activateE) a_flags |= EBitMask;
 830
 831     if(activateT) a_flags |= TBitMask;
 832   } else {
 833     std::string s_code = code ? code->getValue() : "?";
 834     std::string s_flags = flags ? flags->getValue() : "?";
 835
 836     if(!code || !flags) {
 837       std::string msg = "Error processing command <code '"; msg += s_code;
 838       msg += "' + flags '"; msg += s_flags;
 839       msg += "'>: both must be provided if <'name'> don't";
 840       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
 841     }
 842
 843     if(pbit || ebit || tbit) {
 844       std::string msg = "Error processing command <code '"; msg += s_code;
 845       msg += "' + flags '"; msg += s_flags;
 846       msg += "'>: neither of 'p-bit', 'e-bit' or 't-bit' fields are allowed if those are present";
 847       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
 848     }
 849
 850     // Code check
 851     i_aux = code->getIntegerValue();
 852
 853     if(i_aux < 0) {
 854       std::string msg = "Error processing command <code '"; msg += s_code;
 855       msg += "': negative values are not allowed";
 856       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
 857     }
 858
 859     U24 u_code = i_aux;
 860     // Flags check
 861     i_aux = flags->getIntegerValue();
 862
 863     if(i_aux < 0 || i_aux > 256) {
 864       std::string msg = "Error processing command <flags '"; msg += s_flags;
 865       msg += "': out of range [0,256]";
 866       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
 867     }
 868
 869     a_flags = i_aux;
 870     int flagsBCK = a_flags;
 871     // Final assignments
 872     a_id = CommandId(u_code, requestBit() /* based on a_flags */);
 873     // Flags could have been updated regarding dictionary, but during parsing we must respect xml file:
 874     a_flags = flagsBCK;
 875   }
 876
 877   // Hob-by-hop-id
 878   if(hbh) {
 879     u_aux = hbh->getIntegerValue();
 880
 881     /*
 882     if(u_aux < 0) {
 883       std::string msg = "Error processing command <hop-by-hop-id '"; msg += hbh->getValue();
 884       msg += "': negative values are not allowed";
 885       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
 886     }
 887     */
 888   } else u_aux = 0;
 889
 890   setHopByHop(u_aux);
 891
 892   // End-to-end-id
 893   if(ete) {
 894     u_aux = ete->getIntegerValue();
 895
 896     /*
 897     if(u_aux < 0) {
 898       std::string msg = "Error processing command <end-to-end-id '"; msg += ete->getValue();
 899       msg += "': negative values are not allowed";
 900       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
 901     }
 902     */
 903   } else u_aux = 0;
 904
 905   setEndToEnd(u_aux);
 906   // Childrens
 907   Avp *avp;
 908
 909   for(anna::xml::Node::const_child_iterator it = messageNode->child_begin(); it != messageNode->child_end(); it++) {
 910     std::string nodeName = (*it)->getName();
 911
 912     if(nodeName != "avp") {
 913       std::string msg = "Unsupported message child node name '"; msg += nodeName;
 914       msg += "': use 'avp'";
 915       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
 916     }
 917
 918     try {
 919       avp =  getEngine()->allocateAvp();
 920       avp -> fromXML(*it);
 921     } catch(anna::RuntimeException &ex) {
 922       getEngine()->releaseAvp(avp);
 923       throw ex;
 924     }
 925
 926     addAvp(avp);
 927   }
 928 }
 929
 930
 931 //------------------------------------------------------------------------------
 932 //----------------------------------------------------------- Message::loadXML()
 933 //------------------------------------------------------------------------------
 934 void Message::loadXML(const std::string & xmlPathFile) throw(anna::RuntimeException) {
 935   LOGDEBUG(
 936     std::string trace = "Loading diameter message from file '";
 937     trace += xmlPathFile;
 938     trace += "'";
 939     anna::Logger::debug(trace, ANNA_FILE_LOCATION);
 940   );
 941   anna::xml::DocumentFile xmlDocument; // has private copy constructor defined but not implemented to avoid inhenrit/copy (is very heavy)
 942   const anna::xml::Node *rootNode;
 943   xmlDocument.initialize(xmlPathFile.c_str()); // fail here is i/o error
 944   rootNode = xmlDocument.parse(getEngine()->getDTD()); // Parsing: fail here if xml violates dtd
 945   LOGDEBUG(
 946     std::string trace = "Loaded XML file (";
 947     trace += xmlPathFile;
 948     trace += "):\n";
 949     trace += anna::xml::Compiler().apply(rootNode);
 950     anna::Logger::debug(trace, ANNA_FILE_LOCATION);
 951   );
 952   fromXML(rootNode);
 953 }
 954
 955
 956 //------------------------------------------------------------------------------
 957 //------------------------------------------------------------- Message::asXML()
 958 //------------------------------------------------------------------------------
 959 anna::xml::Node* Message::asXML(anna::xml::Node* parent) const throw() {
 960   // <!ATTLIST message version CDATA #IMPLIED name CDATA #IMPLIED code CDATA #IMPLIED flags CDATA #IMPLIED application-id CDATA #REQUIRED hop-by-hop-id CDATA #IMPLIED end-by-end-id CDATA #IMPLIED>
 961   anna::xml::Node* result = parent->createChild("message");
 962   // Dictionary stack command:
 963   const stack::Command *stackCommand = getStackCommand();
 964   bool compactMode = stackCommand /*&& flagsOK()*/;
 965   result->createAttribute("version", anna::functions::asString((int)a_version));
 966
 967   if(compactMode) {
 968     result->createAttribute("name", stackCommand->getName());
 969
 970     if(proxiableBit()) result->createAttribute("p-bit", "yes");
 971
 972     if(errorBit()) result->createAttribute("e-bit", "yes");
 973
 974     if(potentiallyReTransmittedMessageBit()) result->createAttribute("t-bit", "yes");
 975   } else {
 976     result->createAttribute("code", a_id.first);
 977     result->createAttribute("flags", (int)a_flags);
 978   }
 979
 980   result->createAttribute("application-id", anna::functions::asString(a_applicationId));
 981   result->createAttribute("hop-by-hop-id", anna::functions::asString(a_hopByHop));
 982   result->createAttribute("end-by-end-id", anna::functions::asString(a_endToEnd));
 983
 984   // Avps:
 985   for(const_avp_iterator it = avp_begin(); it != avp_end(); it++) {
 986     Avp::avp(it)->asXML(result);
 987   }
 988
 989   return result;
 990 }
 991
 992
 993 //------------------------------------------------------------------------------
 994 //------------------------------------------------------- Message::asXMLString()
 995 //------------------------------------------------------------------------------
 996 std::string Message::asXMLString() const throw() {
 997   anna::xml::Node root("root");
 998   return anna::xml::Compiler().apply(asXML(&root));
 999 }
1000
1001
1002 //------------------------------------------------------------------------------
1003 //------------------------------------------------------------ Message::isLike()
1004 //------------------------------------------------------------------------------
1005 bool Message::isLike(const std::string &pattern) const throw() {
1006   anna::RegularExpression re(pattern);
1007   return re.isLike(asXMLString());
1008 }