1 // ANNA - Anna is Not Nothingness Anymore
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
5 // http://redmine.teslayout.com/projects/anna-suite
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
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
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.
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.
33 // Authors: eduardo.ramos.testillano@gmail.com
34 // cisco.tierra@gmail.com
38 #include <anna/diameter/codec/Message.hpp>
39 #include <anna/diameter/codec/Format.hpp>
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>
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>
66 using namespace anna::diameter::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);
84 //------------------------------------------------------------------------------
85 //----------------------------------------------------------- Message::Message()
86 //------------------------------------------------------------------------------
87 Message::Message() : a_forCode(true) {
92 //------------------------------------------------------------------------------
93 //----------------------------------------------------------- Message::Message()
94 //------------------------------------------------------------------------------
95 Message::Message(CommandId id) : a_forCode(true) {
101 //------------------------------------------------------------------------------
102 //---------------------------------------------------------- Message::~Message()
103 //------------------------------------------------------------------------------
104 Message::~Message() {
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));
117 //------------------------------------------------------------------------------
118 //-------------------------------------------------------- Message::initialize()
119 //------------------------------------------------------------------------------
120 void Message::initialize() throw() {
123 a_id = CommandId(0, false);
129 a_insertionPositionForChilds = 0;
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)); }
149 //------------------------------------------------------------------------------
150 //----------------------------------------------------------- Message::flagsOK()
151 //------------------------------------------------------------------------------
152 bool Message::flagsOK(int &rc) const throw() {
153 // Dictionary stack command:
154 const stack::Command *stackCommand = getStackCommand();
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::?????;
162 // DIAMETER_INVALID_HDR_BITS 3008
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.
169 if(stackCommand->isRequest() != isRequest()) ok = false; // en teoria es imposible salir por aqui: blindado en la dtd
171 if(isRequest() && errorBit()) {
172 anna::Logger::error("E(rror) bit is not allowed at diameter requests", ANNA_FILE_LOCATION);
176 if(isAnswer() && potentiallyReTransmittedMessageBit()) {
177 anna::Logger::error("T(Potentially re-transmitted message) bit is not allowed at diameter answers", ANNA_FILE_LOCATION);
182 rc = helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_HDR_BITS;
186 // DIAMETER_INVALID_BIT_IN_HEADER 5013
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
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;
201 //------------------------------------------------------------------------------
202 //------------------------------------------------------------- Message::setId()
203 //------------------------------------------------------------------------------
204 void Message::setId(CommandId id, bool _clear) throw(anna::RuntimeException) {
205 // Clear class content:
210 // Dictionary stack command:
211 const stack::Command *stackCommand = getStackCommand(); // based on dictionary and a_id
213 // Dictionary flags for known types:
215 if(stackCommand->isRequest()) a_flags |= RBitMask;
217 if(a_id.second) a_flags |= RBitMask; else a_flags &= (~RBitMask);
222 //------------------------------------------------------------------------------
223 //------------------------------------------------------------- Message::setId()
224 //------------------------------------------------------------------------------
225 void Message::setId(const char *name) throw(anna::RuntimeException) {
226 setId(getEngine()->commandIdForName(name));
230 //------------------------------------------------------------------------------
231 //-------------------------------------------------- Message::setApplicationId()
232 //------------------------------------------------------------------------------
233 void Message::setApplicationId(U32 aid) throw() {
234 a_applicationId = aid;
236 // Default behaviour:
237 if (!getEngine()->selectStackWithApplicationId()) return;
239 // Adapts for Application-ID stack identifier:
240 getEngine()->setDictionary(aid);
244 //------------------------------------------------------------------------------
245 //------------------------------------------------------------ Message::addAvp()
246 //------------------------------------------------------------------------------
247 Avp * Message::addAvp(const char *name) throw(anna::RuntimeException) {
248 return addAvp(getEngine()->avpIdForName(name));
252 //------------------------------------------------------------------------------
253 //--------------------------------------------------------- Message::removeAvp()
254 //------------------------------------------------------------------------------
255 bool Message::removeAvp(const char *name, int ocurrence) throw(anna::RuntimeException) {
256 return removeAvp(getEngine()->avpIdForName(name), ocurrence);
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);
268 //------------------------------------------------------------------------------
269 //---------------------------------------------------------- Message::countAvp()
270 //------------------------------------------------------------------------------
271 int Message::countAvp(const char *name) const throw(anna::RuntimeException) {
272 return countAvp(getEngine()->avpIdForName(name));
276 //------------------------------------------------------------------------------
277 //--------------------------------------------------------- Message::getLength()
278 //------------------------------------------------------------------------------
279 U24 Message::getLength() const throw() {
282 result = HeaderLength;
284 for(const_avp_iterator it = avp_begin(); it != avp_end(); it++) result += 4 * REQUIRED_WORDS(Avp::avp(it)->getLength());
290 //------------------------------------------------------------------------------
291 //------------------------------------------------------------ Message::decode()
292 //------------------------------------------------------------------------------
293 void Message::decode(const anna::DataBlock &db, Message *ptrAnswer) throw(anna::RuntimeException) {
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);
302 // EXCEPTION MANAGEMENT IN THIS METHOD
303 // ===================================
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
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".
313 OamModule &oamModule = OamModule::instantiate();
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);
322 const char * buffer = db.getData();
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 // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
338 // +-+-+-+-+-+-+-+-+-+-+-+-+-
340 a_version = (S8)buffer[0];
342 U24 length = DECODE3BYTES_INDX_VALUETYPE(buffer, 1, U24); // total length including header fields
344 a_flags = (S8)buffer[4];
346 U24 code = DECODE3BYTES_INDX_VALUETYPE(buffer, 5, U24);
348 // This is called before setId, and in general before any operation which needs to know about the stack elements.
349 setApplicationId(DECODE4BYTES_INDX_VALUETYPE(buffer, 8, U32)); // centralize set, because it could be used for stack selection.
351 setId(CommandId(code, requestBit() /* based on a_flags */));
353 a_hopByHop = DECODE4BYTES_INDX_VALUETYPE(buffer, 12, U32);
355 a_endToEnd = DECODE4BYTES_INDX_VALUETYPE(buffer, 16, U32);
357 // Only build answer for a request:
358 Message *answer = isRequest() ? ptrAnswer : NULL;
360 if(answer) answer->setHeaderToAnswer(*this);
363 if(db.getSize() < length) {
364 oamModule.activateAlarm(OamModule::Alarm::MessageDecode__NotEnoughBytesToCoverMessageLength);
365 oamModule.count(OamModule::Counter::MessageDecode__NotEnoughBytesToCoverMessageLength);
367 if(answer) answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_MESSAGE_LENGTH);
369 throw anna::RuntimeException("Not enough bytes to cover message length", ANNA_FILE_LOCATION);
372 // Message identifier
373 // Flags could have been updated regarding dictionary, but during decoding we must respect buffer received:
374 a_flags = (S8)buffer[4];
375 // Avps start position:
376 const S8 * startData = buffer + HeaderLength;
377 U24 dataBytes = length - HeaderLength;
379 if(dataBytes < 8 /* minimum avp */) {
380 LOGDEBUG(anna::Logger::debug("Message empty (without avps)", ANNA_FILE_LOCATION));
386 anna::DataBlock db_aux;
388 // Parent information:
390 parent.setMessage(a_id);
393 while(avpPos < dataBytes) {
395 avp = getEngine()->allocateAvp();
396 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) */);
397 avp -> decode(db_aux, parent, answer);
398 } catch(anna::RuntimeException &ex) {
399 getEngine()->releaseAvp(avp);
401 anna::Logger::warning(ex.getText(), ANNA_FILE_LOCATION);
402 anna::Logger::warning("Although a decoding error was found, validation could be checked because message could be enough for the application", ANNA_FILE_LOCATION);
408 avpPos += 4 * REQUIRED_WORDS(avp->getLength());
412 Engine::FixMode::_v fmode = getEngine()->getFixMode();
414 if((fmode == Engine::FixMode::AfterDecoding) || (fmode == Engine::FixMode::Always)) fix();
418 std::string trace = "Message decoded:\n";
419 trace += asXMLString();
420 anna::Logger::debug(trace, ANNA_FILE_LOCATION);
423 Engine::ValidationMode::_v vmode = getEngine()->getValidationMode();
425 if((vmode == Engine::ValidationMode::AfterDecoding) || (vmode == Engine::ValidationMode::Always))
427 throw anna::RuntimeException("The decoded message is invalid. See previous report on warning-level traces", ANNA_FILE_LOCATION);
431 //------------------------------------------------------------------------------
432 //--------------------------------------------------- Message::getStackCommand()
433 //------------------------------------------------------------------------------
434 const anna::diameter::stack::Command *Message::getStackCommand(CommandId id) const throw(anna::RuntimeException) {
435 const stack::Dictionary * dictionary = getEngine()->getDictionary();
436 return (dictionary ? (dictionary->getCommand(id)) : NULL);
440 //------------------------------------------------------------------------------
441 //----------------------------------------------------- Message::setResultCode()
442 //------------------------------------------------------------------------------
443 void Message::setResultCode(int rc) throw(anna::RuntimeException) {
444 if(isRequest()) return;
446 // Add Result-Code if not yet added. Even if validation depth is set to 'Complete',
447 // the Result-Code value will be the first found during the message analysis:
448 Avp *resultCodeAvp = getAvp(helpers::base::AVPID__Result_Code, 1, anna::Exception::Mode::Ignore);
451 addAvp(helpers::base::AVPID__Result_Code)->getUnsigned32()->setValue(rc);
452 else if(resultCodeAvp->getUnsigned32()->getValue() == helpers::base::AVPVALUES__Result_Code::DIAMETER_SUCCESS) // Only success could be replaced
453 resultCodeAvp->getUnsigned32()->setValue(rc);
456 setErrorBit(rc >= 3001 && rc <= 3010 /* protocol errors */);
460 //------------------------------------------------------------------------------
461 //----------------------------------------------------- Message::getResultCode()
462 //------------------------------------------------------------------------------
463 int Message::getResultCode() const throw() {
465 const Avp *resultCodeAvp = getAvp(helpers::base::AVPID__Result_Code, 1, anna::Exception::Mode::Ignore);
468 return resultCodeAvp->getUnsigned32()->getValue();
475 //------------------------------------------------------------------------------
476 //------------------------------------------------------ Message::setFailedAvp()
477 //------------------------------------------------------------------------------
478 void Message::setFailedAvp(const parent_t &parent, AvpId wrong, const char *wrongName) throw(anna::RuntimeException) {
480 if(isRequest()) return;
484 // 7.5. Failed-AVP AVP
486 // The Failed-AVP AVP (AVP Code 279) is of type Grouped and provides
487 // debugging information in cases where a request is rejected or not
488 // fully processed due to erroneous information in a specific AVP. The
489 // value of the Result-Code AVP will provide information on the reason
490 // for the Failed-AVP AVP. A Diameter answer message SHOULD contain an
491 // instance of the Failed-AVP AVP that corresponds to the error
492 // indicated by the Result-Code AVP. For practical purposes, this
493 // Failed-AVP would typically refer to the first AVP processing error
494 // that a Diameter node encounters.
496 // Although the Failed-AVP definition has cardinality 1* and Failed-AVP itself is defined in
497 // most of the command codes as *[Failed-AVP], i think this is not a deliberate ambiguity.
498 // Probably the RFC wants to give freedom to the application layer, but it is recommended to
499 // have only one child (wrong avp) inside a unique message Failed-AVP to ease the Result-Code
500 // correspondence. Anyway, this behaviour could be easily opened commenting condition block (*).
501 Avp *theFailedAvp = getAvp(helpers::base::AVPID__Failed_AVP, 1, anna::Exception::Mode::Ignore);
503 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));
507 // Section 7.5 RFC 6733: A Diameter message SHOULD contain one Failed-AVP AVP
508 theFailedAvp = addAvp(helpers::base::AVPID__Failed_AVP);
509 Avp *leaf = theFailedAvp;
512 std::string msg = "Adding to Failed-AVP, the wrong avp ";
513 msg += wrongName ? wrongName : (anna::diameter::functions::avpIdAsPairString(wrong));
514 msg += " found inside ";
515 msg += parent.asString();
517 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
520 std::vector<AvpId>::const_iterator it;
521 for(it = parent.AvpsId.begin(); it != parent.AvpsId.end(); it++)
522 leaf = leaf->addAvp(*it);
528 //------------------------------------------------------------------------------
529 //----------------------------------------------- Message::setStandardToAnswer()
530 //------------------------------------------------------------------------------
531 void Message::setStandardToAnswer(const Message &request, const std::string &originHost, const std::string &originRealm, int resultCode) throw() {
532 if(!request.getId().second) return;
535 setHeaderToAnswer(request);
536 // Session-Id if exists:
537 const Avp *reqSessionId = request.getAvp(helpers::base::AVPID__Session_Id, 1, anna::Exception::Mode::Ignore);
540 if(!getAvp(helpers::base::AVPID__Session_Id, 1, anna::Exception::Mode::Ignore))
541 addAvp(helpers::base::AVPID__Session_Id)->getUTF8String()->setValue(reqSessionId->getUTF8String()->getValue());
543 // Origin-Host & Realm
544 if(!getAvp(helpers::base::AVPID__Origin_Host, 1, anna::Exception::Mode::Ignore))
545 addAvp(helpers::base::AVPID__Origin_Host)->getDiameterIdentity()->setValue(originHost);
547 if(!getAvp(helpers::base::AVPID__Origin_Realm, 1, anna::Exception::Mode::Ignore))
548 addAvp(helpers::base::AVPID__Origin_Realm)->getDiameterIdentity()->setValue(originRealm);
550 // Proxy-Info AVPs if exist, in the same order:
551 for(const_avp_iterator it = request.avp_begin(); it != request.avp_end(); it++)
552 if((*it).second->getId() == helpers::base::AVPID__Proxy_Info)
553 addAvp((*it).second);
555 // If no Result-Code was added is because all was ok, then application could detect another problem:
556 setResultCode(resultCode);
560 std::string msg = "Completed answer:\n";
561 msg += asXMLString();
562 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
567 //------------------------------------------------------------------------------
568 //--------------------------------------------------------------- Message::fix()
569 //------------------------------------------------------------------------------
570 void Message::fix() throw() {
571 // Dictionary stack command:
572 const stack::Command *stackCommand = getStackCommand();
575 LOGDEBUG(anna::Logger::debug("No dictionary command reference found. Cannot fix.", ANNA_FILE_LOCATION));
576 // Try to get to the first place the Session-ID (if exists) because...
577 // RFC 6733: All messages pertaining to a specific session MUST include only one Session-Id AVP ...
578 // ... When present, the Session-Id SHOULD appear immediately following the Diameter header
579 avp_iterator it = Avp::avp_find(a_avps, helpers::base::AVPID__Session_Id, 1 /* one and only */);
581 if(it != avp_end()) {
582 int sessionPos = (*it).first;
583 Avp *first = (*avp_begin()).second;
584 a_avps[0] = (*it).second; // Session-Id
585 a_avps[sessionPos] = first;
586 LOGDEBUG(anna::Logger::debug("Session-Id has been manually fixed to the first place", ANNA_FILE_LOCATION));
592 Avp::fix(a_avps, (find_container&)a_finds, a_insertionPositionForChilds, stackCommand->avprule_begin(), stackCommand->avprule_end());
596 //------------------------------------------------------------------------------
597 //------------------------------------------------------------- Message::valid()
598 //------------------------------------------------------------------------------
599 bool Message::valid(Message *ptrAnswer) const throw(anna::RuntimeException) {
601 OamModule &oamModule = OamModule::instantiate();
602 // Dictionary stack command:
603 const stack::Command *stackCommand = getStackCommand();
604 // Only build answer for a request:
605 Message *answer = isRequest() ? ptrAnswer : NULL;
607 if(answer) answer->setHeaderToAnswer(*this);
611 std::string me = anna::diameter::functions::commandIdAsPairString(a_id);
612 oamModule.activateAlarm(OamModule::Alarm::MessageValidation__UnknownOperation__s__UnableToValidate, STRING_WITH_QUOTATION_MARKS__C_STR(me));
613 oamModule.count(OamModule::Counter::MessageValidation__UnknownOperationUnableToValidate);
615 if(answer) answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_COMMAND_UNSUPPORTED);
617 getEngine()->validationAnomaly(anna::functions::asString("Unknown operation %s. Unable to validate", STRING_WITH_QUOTATION_MARKS__C_STR(me)));
621 // Parent information:
623 me.setMessage(a_id, stackCommand->getName().c_str());
625 //////////////////////////////
626 // Flags coherence checking //
627 //////////////////////////////
629 bool result = flagsOK(rc);
632 // OAM & Depth management
633 oamModule.activateAlarm(OamModule::Alarm::MessageValidation__Operation__s__HaveIncoherentFlags__d__, STRING_WITH_QUOTATION_MARKS__C_STR(me.asString()), (int)a_flags);
634 oamModule.count(OamModule::Counter::MessageValidation__OperationHaveIncoherentFlags);
636 if(answer) answer->setResultCode(rc);
638 getEngine()->validationAnomaly(anna::functions::asString("Operation %s have incoherent flags (%d)", STRING_WITH_QUOTATION_MARKS__C_STR(me.asString()), (int)a_flags));
644 result = Avp::validLevel(a_avps, stackCommand->avprule_begin(), stackCommand->avprule_end(), getEngine(), me, answer) && result;
646 ////////////////////////
647 // Childrens checking //
648 ////////////////////////
649 for(const_avp_iterator it = avp_begin(); it != avp_end(); it++)
650 result = ((*it).second->valid(me, answer)) && result;
656 //------------------------------------------------------------------------------
657 //-------------------------------------------------------------- Message::code()
658 //------------------------------------------------------------------------------
659 const anna::DataBlock & Message::code() throw(anna::RuntimeException) {
661 Engine::ValidationMode::_v vmode = getEngine()->getValidationMode();
663 if((vmode == Engine::ValidationMode::BeforeCoding) || (vmode == Engine::ValidationMode::Always)) {
665 throw anna::RuntimeException("Try to encode an invalid message. See previous report on warning-level traces", ANNA_FILE_LOCATION);
669 Engine::FixMode::_v fmode = getEngine()->getFixMode();
671 if((fmode == Engine::FixMode::BeforeCoding) || (fmode == Engine::FixMode::Always)) fix();
675 std::string trace = "Message to code:\n";
676 trace += asXMLString();
677 anna::Logger::debug(trace, ANNA_FILE_LOCATION);
680 U24 length = getLength();
682 a_forCode.allocate(length);
683 char* buffer = (char*)a_forCode.getData();
684 // Version and length
685 buffer[0] = (S8) a_version;
686 buffer[1] = (S8)(length >> 16);
687 buffer[2] = (S8)(length >> 8);
688 buffer[3] = (S8) length;
690 buffer[4] = (S8) a_flags;
691 buffer[5] = (S8)(a_id.first >> 16);
692 buffer[6] = (S8)(a_id.first >> 8);
693 buffer[7] = (S8) a_id.first;
695 buffer[8] = (S8)(a_applicationId >> 24);
696 buffer[9] = (S8)(a_applicationId >> 16);
697 buffer[10] = (S8)(a_applicationId >> 8);
698 buffer[11] = (S8) a_applicationId;
700 buffer[12] = (S8)(a_hopByHop >> 24);
701 buffer[13] = (S8)(a_hopByHop >> 16);
702 buffer[14] = (S8)(a_hopByHop >> 8);
703 buffer[15] = (S8) a_hopByHop;
705 buffer[16] = (S8)(a_endToEnd >> 24);
706 buffer[17] = (S8)(a_endToEnd >> 16);
707 buffer[18] = (S8)(a_endToEnd >> 8);
708 buffer[19] = (S8) a_endToEnd;
709 // Data start position:
710 int startDataPos = HeaderLength;
712 if(startDataPos == length) {
713 LOGDEBUG(anna::Logger::debug("There is no Avps to encode (only-header message)", ANNA_FILE_LOCATION));
716 S8 * dataPart = buffer + startDataPos;
717 int dataBytes; // not used but could be useful for checking (length - startDataPos)
718 // Each avp encoding will remain padding octets depending on format. In order to
719 // code avps colection (each avp will be multiple of 4) we clean the entire buffer
720 // to ensure padding (easier than custom-made for each format):
721 memset(dataPart, 0, length - startDataPos); // no estoy seguro de que el clear del DataBlock haga esto...
723 for(const_avp_iterator it = avp_begin(); it != avp_end(); it++) {
724 Avp::avp(it)->code(dataPart, dataBytes);
725 dataPart = dataPart + 4 * REQUIRED_WORDS(dataBytes);
731 std::string trace = "DataBlock encoded:\n";
732 trace += a_forCode.asString();
733 // trace += "\nAs continuous hexadecimal string:\n";
734 // trace += anna::functions::asHexString(a_forCode);
735 anna::Logger::debug(trace, ANNA_FILE_LOCATION);
741 //------------------------------------------------------------------------------
742 //----------------------------------------------------- Message::fromXMLString()
743 //------------------------------------------------------------------------------
744 void Message::fromXMLString(const std::string &xmlString) throw(anna::RuntimeException) {
745 LOGDEBUG(anna::Logger::debug("Reading diameter message from xml string representation", ANNA_FILE_LOCATION));
746 anna::xml::DocumentMemory xmlDocument; // has private copy constructor defined but not implemented to avoid inhenrit/copy (is very heavy)
747 const anna::xml::Node *rootNode;
748 xmlDocument.initialize(xmlString.c_str());
749 rootNode = xmlDocument.parse(getEngine()->getDTD()); // Parsing: fail here if xml violates dtd
750 LOGDEBUG(anna::Logger::debug("Read OK from XML string representation", ANNA_FILE_LOCATION));
755 //------------------------------------------------------------------------------
756 //----------------------------------------------------------- Message::fromXML()
757 //------------------------------------------------------------------------------
758 void Message::fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeException) {
759 // <!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>
760 const anna::xml::Attribute *version, *name, *code, *flags, *pbit, *ebit, *tbit, *appid, *hbh, *ete;
761 version = messageNode->getAttribute("version", false /* no exception */);
762 name = messageNode->getAttribute("name", false /* no exception */);
763 code = messageNode->getAttribute("code", false /* no exception */);
764 flags = messageNode->getAttribute("flags", false /* no exception */);
765 pbit = messageNode->getAttribute("p-bit", false /* no exception */);
766 ebit = messageNode->getAttribute("e-bit", false /* no exception */);
767 tbit = messageNode->getAttribute("t-bit", false /* no exception */);
768 appid = messageNode->getAttribute("application-id"); // required
769 hbh = messageNode->getAttribute("hop-by-hop-id", false /* no exception */);
770 ete = messageNode->getAttribute("end-by-end-id", false /* no exception */);
775 i_aux = version->getIntegerValue();
777 if(i_aux < 0 || i_aux > 256) {
778 std::string msg = "Error processing avp <version '"; msg += version->getValue();
779 msg += "': out of range [0,256]";
780 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
787 // This is called before setId, and in general before any operation which needs to know about the stack elements.
788 setApplicationId(appid->getIntegerValue()); // this could set the dictionary...
791 const stack::Dictionary * dictionary = getEngine()->getDictionary();
792 const stack::Command *stackCommand = NULL;
797 std::string msg = "Error processing command <name '"; msg += name->getValue();
798 msg += "'>: no dictionary available. Load one or use <'code' + 'flags'> instead of <'name'>";
799 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
802 stackCommand = dictionary->getCommand(name->getValue());
805 std::string msg = "Error processing command <name '"; msg += name->getValue();
806 msg += "'>: no command found for this identifier at available dictionary";
807 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
811 // Check attributes exclusiveness
812 if(name) { // compact mode
814 std::string msg = "Error processing command <name '"; msg += name->getValue();
815 msg += "'>: message attributes <'code' + 'flags'> are not allowed if <'name'> is provided";
816 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
819 setId(stackCommand->getId());
820 // 'P', 'E' and 'T' flags:
821 bool activateP = pbit ? (pbit->getValue() == "yes") : false;
822 bool activateE = ebit ? (ebit->getValue() == "yes") : false;
823 bool activateT = tbit ? (tbit->getValue() == "yes") : false;
825 if(activateP) a_flags |= PBitMask;
827 if(activateE) a_flags |= EBitMask;
829 if(activateT) a_flags |= TBitMask;
831 std::string s_code = code ? code->getValue() : "?";
832 std::string s_flags = flags ? flags->getValue() : "?";
834 if(!code || !flags) {
835 std::string msg = "Error processing command <code '"; msg += s_code;
836 msg += "' + flags '"; msg += s_flags;
837 msg += "'>: both must be provided if <'name'> don't";
838 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
841 if(pbit || ebit || tbit) {
842 std::string msg = "Error processing command <code '"; msg += s_code;
843 msg += "' + flags '"; msg += s_flags;
844 msg += "'>: neither of 'p-bit', 'e-bit' or 't-bit' fields are allowed if those are present";
845 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
849 i_aux = code->getIntegerValue();
852 std::string msg = "Error processing command <code '"; msg += s_code;
853 msg += "': negative values are not allowed";
854 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
859 i_aux = flags->getIntegerValue();
861 if(i_aux < 0 || i_aux > 256) {
862 std::string msg = "Error processing command <flags '"; msg += s_flags;
863 msg += "': out of range [0,256]";
864 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
868 int flagsBCK = a_flags;
870 setId(CommandId(u_code, requestBit() /* based on a_flags */));
871 // Flags could have been updated regarding dictionary, but during parsing we must respect xml file:
877 u_aux = hbh->getIntegerValue();
881 std::string msg = "Error processing command <hop-by-hop-id '"; msg += hbh->getValue();
882 msg += "': negative values are not allowed";
883 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
892 u_aux = ete->getIntegerValue();
896 std::string msg = "Error processing command <end-to-end-id '"; msg += ete->getValue();
897 msg += "': negative values are not allowed";
898 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
907 for(anna::xml::Node::const_child_iterator it = messageNode->child_begin(); it != messageNode->child_end(); it++) {
908 std::string nodeName = (*it)->getName();
910 if(nodeName != "avp") {
911 std::string msg = "Unsupported message child node name '"; msg += nodeName;
912 msg += "': use 'avp'";
913 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
917 avp = getEngine()->allocateAvp();
919 } catch(anna::RuntimeException &ex) {
920 getEngine()->releaseAvp(avp);
929 //------------------------------------------------------------------------------
930 //----------------------------------------------------------- Message::loadXML()
931 //------------------------------------------------------------------------------
932 void Message::loadXML(const std::string & xmlPathFile) throw(anna::RuntimeException) {
934 std::string trace = "Loading diameter message from file '";
935 trace += xmlPathFile;
937 anna::Logger::debug(trace, ANNA_FILE_LOCATION);
939 anna::xml::DocumentFile xmlDocument; // has private copy constructor defined but not implemented to avoid inhenrit/copy (is very heavy)
940 const anna::xml::Node *rootNode;
941 xmlDocument.initialize(xmlPathFile.c_str()); // fail here is i/o error
942 rootNode = xmlDocument.parse(getEngine()->getDTD()); // Parsing: fail here if xml violates dtd
944 std::string trace = "Loaded XML file (";
945 trace += xmlPathFile;
947 trace += anna::xml::Compiler().apply(rootNode);
948 anna::Logger::debug(trace, ANNA_FILE_LOCATION);
954 //------------------------------------------------------------------------------
955 //------------------------------------------------------------- Message::asXML()
956 //------------------------------------------------------------------------------
957 anna::xml::Node* Message::asXML(anna::xml::Node* parent) const throw() {
958 // <!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>
959 anna::xml::Node* result = parent->createChild("message");
960 // Dictionary stack command:
961 const stack::Command *stackCommand = getStackCommand();
962 bool compactMode = stackCommand /*&& flagsOK()*/;
963 result->createAttribute("version", anna::functions::asString((int)a_version));
966 result->createAttribute("name", stackCommand->getName());
968 if(proxiableBit()) result->createAttribute("p-bit", "yes");
970 if(errorBit()) result->createAttribute("e-bit", "yes");
972 if(potentiallyReTransmittedMessageBit()) result->createAttribute("t-bit", "yes");
974 result->createAttribute("code", a_id.first);
975 result->createAttribute("flags", (int)a_flags);
978 result->createAttribute("application-id", anna::functions::asString(a_applicationId));
979 result->createAttribute("hop-by-hop-id", anna::functions::asString(a_hopByHop));
980 result->createAttribute("end-by-end-id", anna::functions::asString(a_endToEnd));
983 for(const_avp_iterator it = avp_begin(); it != avp_end(); it++) {
984 Avp::avp(it)->asXML(result);
991 //------------------------------------------------------------------------------
992 //------------------------------------------------------- Message::asXMLString()
993 //------------------------------------------------------------------------------
994 std::string Message::asXMLString() const throw() {
995 anna::xml::Node root("root");
996 return anna::xml::Compiler().apply(asXML(&root));
1000 //------------------------------------------------------------------------------
1001 //------------------------------------------------------------ Message::isLike()
1002 //------------------------------------------------------------------------------
1003 bool Message::isLike(const std::string &pattern) const throw() {
1004 anna::RegularExpression re(pattern);
1005 return re.isLike(asXMLString());