1 // ANNA - Anna is Not Nothingness Anymore
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
5 // https://bitbucket.org/testillano/anna
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 Google Inc. 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/Avp.hpp>
39 #include <anna/diameter/codec/Format.hpp>
41 #include <anna/config/defines.hpp> // general types, decoding helpers (DECODE[2/3/4]BYTES_INDX_VALUETYPE), etc.
42 #include <anna/diameter/functions.hpp>
43 #include <anna/diameter/helpers/defines.hpp>
44 #include <anna/diameter/codec/basetypes/basetypes.hpp>
45 #include <anna/diameter/codec/functions.hpp> // REQUIRED_WORDS
46 #include <anna/diameter/codec/OamModule.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/diameter/codec/Engine.hpp>
52 #include <anna/core/functions.hpp>
54 #include <anna/core/tracing/Logger.hpp>
55 #include <anna/core/functions.hpp>
56 #include <anna/core/tracing/TraceMethod.hpp>
57 #include <anna/xml/xml.hpp>
64 using namespace anna::diameter::codec;
73 const int Avp::HeaderLengthVactive(12);
74 const int Avp::HeaderLengthVinactive(8);
75 const U8 Avp::VBitMask(0x80);
76 const U8 Avp::MBitMask(0x40);
77 const U8 Avp::PBitMask(0x20);
82 //------------------------------------------------------------------------------
83 //------------------------------------------------------------------- Avp::Avp()
84 //------------------------------------------------------------------------------
90 //------------------------------------------------------------------------------
91 //------------------------------------------------------------------- Avp::Avp()
92 //------------------------------------------------------------------------------
99 //------------------------------------------------------------------------------
100 //------------------------------------------------------------------ Avp::~Avp()
101 //------------------------------------------------------------------------------
107 //------------------------------------------------------------------------------
108 //------------------------------------------------------------- Avp::getEngine()
109 //------------------------------------------------------------------------------
110 Engine * Avp::getEngine() const throw(anna::RuntimeException) {
111 return a_engine ? a_engine : (a_engine = anna::functions::component <Engine> (ANNA_FILE_LOCATION));
115 //------------------------------------------------------------------------------
116 //------------------------------------------------------------ Avp::initialize()
117 //------------------------------------------------------------------------------
118 void Avp::initialize() throw() {
120 a_id = helpers::AVPID__AVP; // (0,0)
122 a_insertionPositionForChilds = 0;
123 a_OctetString = NULL;
134 a_DiameterIdentity = NULL;
135 a_DiameterURI = NULL;
137 a_IPFilterRule = NULL;
138 a_QoSFilterRule = NULL;
141 /////////////////////
142 // Format specific //
143 /////////////////////
144 initializeByFormat();
148 //------------------------------------------------------------------------------
149 //----------------------------------------------------------------- Avp::clear()
150 //------------------------------------------------------------------------------
151 void Avp::clear() throw(anna::RuntimeException) {
152 delete a_OctetString;
160 for(avp_iterator it = avp_begin(); it != avp_end(); it++) { /*avp(it)->clear(); */getEngine()->releaseAvp(avp(it)); }
166 delete a_DiameterIdentity;
167 delete a_DiameterURI;
169 delete a_IPFilterRule;
170 delete a_QoSFilterRule;
174 /////////////////////
175 // Format specific //
176 /////////////////////
183 //------------------------------------------------------------------------------
184 //-------------------------------------------------------------- Avp::avp_find()
185 //------------------------------------------------------------------------------
186 avp_iterator Avp::avp_find(avp_container &avps, AvpId id, unsigned int position) throw() {
190 for(avp_iterator it = avps.begin(); it != avps.end(); it++) {
193 if(aux && (aux->getId() == id)) {
196 if(match == position) return it;
204 //------------------------------------------------------------------------------
205 //---------------------------------------------------------------- Avp::addAvp()
206 //------------------------------------------------------------------------------
207 Avp * Avp::addAvp(avp_container &avps, int &insertionPositionForChilds, AvpId id, Engine *engine) throw() {
208 Avp * result = engine->allocateAvp();
210 addChild(avps, insertionPositionForChilds, result);
215 //------------------------------------------------------------------------------
216 //------------------------------------------------------------- Avp::removeAvp()
217 //------------------------------------------------------------------------------
218 bool Avp::removeAvp(avp_container &avps, find_container &finds, AvpId id, int ocurrence, Engine *engine) throw() {
219 bool removed = false;
220 bool do_remove = true;
221 int position = ocurrence;
223 if(position < 0) { /* reversed access */
224 position = countAvp(avps, id) + 1 + position;
226 // Special cases -> 0 and negative results:
227 // (1) User wants to remove the last, but no avp is found: position = 0 + 1 - 1 = 0 (would removes all but, no avp will be found: return now)
228 // (2) User wants to remove some intermediate avp, i.e. '-5', but only 4 avps are found: 4 + 1 - 5 = 0 (would removes all !!!: return to avoid unexpected behaviour)
229 // (2) User wants to remove some intermediate avp, i.e. '-5', but only 3 avps are found: 3 + 1 - 5 = -1 (can't find negative positions ...)
230 if(position <= 0) do_remove = false;
234 int n = position ? position : 1 /* will search always the first and remove, the first and remove, the first and remove ... */;
237 while((it = avp_find(avps, id, n)) != avps.end()) {
238 engine->releaseAvp((*it).second);
247 // Cache system reset (remove will invalidate cached findings):
250 const stack::Avp *stackAvp = getStackAvp(id, engine);
251 std::string msg = "Removed Avp "; msg += stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id));
252 msg += anna::functions::asString(" with provided ocurrence (%d)", ocurrence);
253 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
257 const stack::Avp *stackAvp = getStackAvp(id, engine);
258 std::string msg = "Can't found Avp "; msg += stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id));
259 msg += anna::functions::asString(" with provided ocurrence (%d), in order to be removed", ocurrence);
260 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
268 //------------------------------------------------------------------------------
269 //-------------------------------------------------------------- Avp::countAvp()
270 //------------------------------------------------------------------------------
271 int Avp::countAvp(const avp_container &avps, AvpId id) throw() {
273 const_avp_iterator it;
275 while((it = avp_find(avps, id, result + 1)) != avps.end()) result++;
281 //------------------------------------------------------------------------------
282 //-------------------------------------------------------------- Avp::firstAvp()
283 //------------------------------------------------------------------------------
284 const Avp* Avp::firstAvp(const avp_container &avps, AvpId id) throw() {
285 const_avp_iterator it = avp_find(avps, id, 1);
294 //------------------------------------------------------------------------------
295 //----------------------------------------------------------- Avp::countChilds()
296 //------------------------------------------------------------------------------
297 int Avp::countChilds(const avp_container &avps) throw() {
302 //------------------------------------------------------------------------------
303 //---------------------------------------------------------------- Avp::getAvp()
304 //------------------------------------------------------------------------------
305 const Avp *Avp::getAvp(const avp_container &avps, find_container &finds, AvpId id, int ocurrence, Engine *engine, anna::Exception::Mode::_v emode) throw(anna::RuntimeException) {
307 LOGDEBUG(anna::Logger::debug("Ocurrence number zero has no sense. NULL returned.", ANNA_FILE_LOCATION));
311 bool do_search = true;
313 int position = ocurrence;
315 if(position < 0) { /* reversed access */
316 position = countAvp(avps, id) + 1 + position;
318 // Special cases -> 0 and negative results:
319 // (1) User wants to get the last, but no avp is found: position = 0 + 1 - 1 = 0 (can't find 0-position ...)
320 // (2) User wants to get some intermediate avp, i.e. '-5', but only 4 avps are found: 4 + 1 - 5 = 0 (can't find 0-position ...)
321 // (2) User wants to get some intermediate avp, i.e. '-5', but only 3 avps are found: 3 + 1 - 5 = -1 (can't find negative positions ...)
322 if(position <= 0) do_search = false;
325 const Avp * result = NULL;
328 // Search at cache finds:
329 find_key key(id, position);
330 find_iterator fit = finds.find(key);
331 cached = (fit != finds.end());
334 result = (*fit).second;
336 const_avp_iterator it = avp_find(avps, id, position);
338 if(it != avps.end()) {
339 result = (*it).second;
340 finds[key] = const_cast<Avp*>(result); // store in cache
348 const stack::Avp *stackAvp = getStackAvp(id, engine);
349 std::string msg = "Found Avp "; msg += stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id));
350 msg += anna::functions::asString(" with provided ocurrence (%d) which was ", ocurrence);
351 msg += cached ? "already cached:\n" : "the first search, now cached:\n";
352 msg += result->asXMLString();
353 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
360 case anna::Exception::Mode::Throw: {
361 const stack::Avp *stackAvp = getStackAvp(id, engine);
362 std::string msg = "Can't found Avp "; msg += stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id));
363 msg += anna::functions::asString(" with provided ocurrence (%d)", ocurrence);
364 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
367 case anna::Exception::Mode::Trace: {
369 const stack::Avp *stackAvp = getStackAvp(id, engine);
370 std::string msg = "Can't found Avp "; msg += stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id));
371 msg += anna::functions::asString(" with provided ocurrence (%d)", ocurrence);
372 anna::Logger::warning(msg, ANNA_FILE_LOCATION);
376 case anna::Exception::Mode::Ignore: {
378 const stack::Avp *stackAvp = getStackAvp(id, engine);
379 std::string msg = "Can't found Avp "; msg += stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id));
380 msg += anna::functions::asString(" with provided ocurrence (%d)", ocurrence);
381 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
391 //------------------------------------------------------------------------------
392 //--------------------------------------------------------------- Avp::_getAvp()
393 //------------------------------------------------------------------------------
394 const Avp *Avp::_getAvp(AvpId id, int ocurrence, anna::Exception::Mode::_v emode) const throw(anna::RuntimeException) {
395 // Dictionary stack avp and format (this):
396 const stack::Avp *stackAvp = getStackAvp();
397 const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
399 if(!stackFormat || !stackFormat->isGrouped())
400 throw anna::RuntimeException("This method only applies over grouped avps.", ANNA_FILE_LOCATION);
402 return getAvp(a_avps, (find_container&)a_finds, id, ocurrence, getEngine(), emode);
406 //------------------------------------------------------------------------------
407 //---------------------------------------------------------- Avp::assertFormat()
408 //------------------------------------------------------------------------------
409 void Avp::assertFormat(const std::string &name) const throw(anna::RuntimeException) {
410 // Dictionary stack avp and format:
411 const stack::Avp *stackAvp = getStackAvp();
412 const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
413 std::string format = stackFormat ? stackFormat->getName() : "Unknown";
416 std::string msg = "The Avp ";
417 msg += anna::diameter::functions::avpIdAsPairString(a_id);
418 msg += " with format '";
420 msg += "' is not compatible with the API method used (";
423 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
428 //------------------------------------------------------------------------------
429 //--------------------------------------------------------------- Avp::flagsOK()
430 //------------------------------------------------------------------------------
431 bool Avp::flagsOK() const throw() {
432 // Dictionary stack avp:
433 const stack::Avp *stackAvp = getStackAvp();
436 anna::Logger::error("Impossible to decide if flags are correct because stack avp is not identified. Assume flags ok", ANNA_FILE_LOCATION);
441 bool Vnone = (stackAvp->getVbit() == stack::Avp::FlagRule::None);
443 bool Vmust = (stackAvp->getVbit() == stack::Avp::FlagRule::must);
445 bool Vmustnot = (stackAvp->getVbit() == stack::Avp::FlagRule::mustnot);
447 bool Mnone = (stackAvp->getMbit() == stack::Avp::FlagRule::None);
449 bool Mmust = (stackAvp->getMbit() == stack::Avp::FlagRule::must);
451 bool Mmustnot = (stackAvp->getMbit() == stack::Avp::FlagRule::mustnot);
453 bool Pnone = (stackAvp->getPbit() == stack::Avp::FlagRule::None);
455 bool Pmust = (stackAvp->getPbit() == stack::Avp::FlagRule::must);
457 bool Pmustnot = (stackAvp->getPbit() == stack::Avp::FlagRule::mustnot);
460 if((Vnone && Mnone && Pnone && vendorBit()) || (Vmust && !vendorBit()) || (Vmustnot && vendorBit())) {
461 anna::Logger::error("Vendor Bit (V) incoherence found", ANNA_FILE_LOCATION);
465 // Exit on permissive mode:
466 if(getEngine()->ignoreFlagsOnValidation()) return true; // Ignore checking for AVP 'M' & 'P' bits
469 if((Mmust && !mandatoryBit()) || (Mmustnot && mandatoryBit())) {
470 anna::Logger::error("Mandatory Bit (M) incoherence found", ANNA_FILE_LOCATION);
475 if((Pmust && !encryptionBit()) || (Pmustnot && encryptionBit())) {
476 anna::Logger::error("Encryption Bit (P) incoherence found", ANNA_FILE_LOCATION);
481 if((a_flags & 0x1f) != 0x00) {
482 anna::Logger::error("Any (or more than one) of the reserved avp flags bit has been activated. Reserved bits must be null", ANNA_FILE_LOCATION);
490 //------------------------------------------------------------------------------
491 //----------------------------------------------------------------- Avp::setId()
492 //------------------------------------------------------------------------------
493 void Avp::setId(AvpId id) throw(anna::RuntimeException) {
494 // Generic AVP assignment has no sense
495 if(id == helpers::AVPID__AVP) return;
497 // Clear class content:
501 // Dictionary stack avp and format:
502 const stack::Avp *stackAvp = getStackAvp(); // based on dictionary and a_id
503 const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
505 // Dictionary flags for known types:
507 if(stackAvp->getVbit() == stack::Avp::FlagRule::must) a_flags |= VBitMask;
509 if(stackAvp->getMbit() == stack::Avp::FlagRule::must) a_flags |= MBitMask;
511 if(stackAvp->getPbit() == stack::Avp::FlagRule::must) a_flags |= PBitMask;
513 if(a_id.second != 0) a_flags |= VBitMask; else a_flags &= (~VBitMask);
516 if(!stackFormat) { // Unknown Avp
518 std::string msg = "Unknown format for AVP identifier ";
519 msg += anna::diameter::functions::avpIdAsPairString(id);
520 msg += ". Raw data without specific format will be managed";
521 anna::Logger::debug(msg, ANNA_FILE_LOCATION);
523 a_Unknown = new Unknown();
527 // Avp class formats (Avp child classes should implement this source code block for application-specific formats):
528 if(stackFormat->isOctetString()) a_OctetString = new OctetString();
529 else if(stackFormat->isInteger32()) a_Integer32 = new Integer32();
530 else if(stackFormat->isInteger64()) a_Integer64 = new Integer64();
531 else if(stackFormat->isUnsigned32()) a_Unsigned32 = new Unsigned32();
532 else if(stackFormat->isUnsigned64()) a_Unsigned64 = new Unsigned64();
533 else if(stackFormat->isFloat32()) a_Float32 = new Float32();
534 else if(stackFormat->isFloat64()) a_Float64 = new Float64();
535 //else if (stackFormat->isGrouped())
536 else if(stackFormat->isAddress()) a_Address = new Address();
537 else if(stackFormat->isTime()) a_Time = new Time();
538 else if(stackFormat->isUTF8String()) a_UTF8String = new UTF8String();
539 else if(stackFormat->isDiameterIdentity()) a_DiameterIdentity = new DiameterIdentity();
540 else if(stackFormat->isDiameterURI()) a_DiameterURI = new DiameterURI();
541 else if(stackFormat->isEnumerated()) a_Enumerated = new Enumerated();
542 else if(stackFormat->isIPFilterRule()) a_IPFilterRule = new IPFilterRule();
543 else if(stackFormat->isQoSFilterRule()) a_QoSFilterRule = new QoSFilterRule();
545 /////////////////////
546 // Format specific //
547 /////////////////////
548 allocationByFormat(stackFormat);
552 //------------------------------------------------------------------------------
553 //----------------------------------------------------------------- Avp::setId()
554 //------------------------------------------------------------------------------
555 void Avp::setId(const char *name) throw(anna::RuntimeException) {
556 setId(getEngine()->avpIdForName(name));
560 //------------------------------------------------------------------------------
561 //---------------------------------------------------------------- Avp::addAvp()
562 //------------------------------------------------------------------------------
563 Avp * Avp::addAvp(const char *name) throw(anna::RuntimeException) {
564 return addAvp(getEngine()->avpIdForName(name));
568 //------------------------------------------------------------------------------
569 //------------------------------------------------------------- Avp::removeAvp()
570 //------------------------------------------------------------------------------
571 bool Avp::removeAvp(const char *name, int ocurrence) throw(anna::RuntimeException) {
572 return removeAvp(getEngine()->avpIdForName(name), ocurrence);
576 //------------------------------------------------------------------------------
577 //--------------------------------------------------------------- Avp::_getAvp()
578 //------------------------------------------------------------------------------
579 const Avp *Avp::_getAvp(const char *name, int ocurrence, anna::Exception::Mode::_v emode) const throw(anna::RuntimeException) {
580 return getAvp(getEngine()->avpIdForName(name), ocurrence, emode);
584 //------------------------------------------------------------------------------
585 //-------------------------------------------------------------- Avp::countAvp()
586 //------------------------------------------------------------------------------
587 int Avp::countAvp(const char *name) const throw(anna::RuntimeException) {
588 return countAvp(getEngine()->avpIdForName(name));
591 //------------------------------------------------------------------------------
592 //------------------------------------------------------------- Avp::getLength()
593 //------------------------------------------------------------------------------
594 U24 Avp::getLength() const throw() {
597 const stack::Avp *stackAvp = getStackAvp();
598 const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
600 result = vendorBit() ? HeaderLengthVactive : HeaderLengthVinactive;
603 result += a_Unknown->getSize();
607 if(stackFormat->isOctetString()) result += a_OctetString->getSize();
608 else if(stackFormat->isInteger32()) result += a_Integer32->getSize();
609 else if(stackFormat->isInteger64()) result += a_Integer64->getSize();
610 else if(stackFormat->isUnsigned32()) result += a_Unsigned32->getSize();
611 else if(stackFormat->isUnsigned64()) result += a_Unsigned64->getSize();
612 else if(stackFormat->isFloat32()) result += a_Float32->getSize();
613 else if(stackFormat->isFloat64()) result += a_Float64->getSize();
614 else if(stackFormat->isGrouped()) for(const_avp_iterator it = avp_begin(); it != avp_end(); it++) result += 4 * REQUIRED_WORDS(avp(it)->getLength());
615 else if(stackFormat->isAddress()) result += a_Address->getSize();
616 else if(stackFormat->isTime()) result += a_Time->getSize();
617 else if(stackFormat->isUTF8String()) result += a_UTF8String->getSize();
618 else if(stackFormat->isDiameterIdentity()) result += a_DiameterIdentity->getSize();
619 else if(stackFormat->isDiameterURI()) result += a_DiameterURI->getSize();
620 else if(stackFormat->isEnumerated()) result += a_Enumerated->getSize();
621 else if(stackFormat->isIPFilterRule()) result += a_IPFilterRule->getSize();
622 else if(stackFormat->isQoSFilterRule()) result += a_QoSFilterRule->getSize();
624 /////////////////////
625 // Format specific //
626 /////////////////////
627 result += getLengthByFormat(stackFormat);
632 //------------------------------------------------------------------------------
633 //-------------------------------------------- Avp::unknownAvpWithMandatoryBit()
634 //------------------------------------------------------------------------------
635 void Avp::unknownAvpWithMandatoryBit(Message *answer) const throw(anna::RuntimeException) {
636 OamModule &oamModule = OamModule::instantiate();
637 const char *c_aid = STRING_WITH_QUOTATION_MARKS__C_STR(anna::diameter::functions::avpIdAsPairString(a_id));
638 oamModule.activateAlarm(OamModule::Alarm::AvpDecode__UnknownAvp__s__WithMandatoryBit, c_aid);
639 oamModule.count(OamModule::Counter::AvpDecode__UnknownAvpWithMandatoryBit);
641 std::string msg = anna::functions::asString("Detected unknown Avp %s with mandatory bit activated", c_aid);
642 anna::Logger::warning(msg, ANNA_FILE_LOCATION);
646 answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_AVP_UNSUPPORTED);
647 answer->setNewFailedAvp((Avp*)this);
651 //------------------------------------------------------------------------------
652 //-------------------------------------------------------- Avp::decodeDataPart()
653 //------------------------------------------------------------------------------
654 void Avp::decodeDataPart(const char * buffer, int size, Message *answer) throw(anna::RuntimeException) {
656 OamModule &oamModule = OamModule::instantiate();
657 // Dictionary stack avp and format:
658 const stack::Avp *stackAvp = getStackAvp();
659 const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
662 a_Unknown->decode(buffer, size);
666 if(stackFormat->isOctetString()) a_OctetString->decode(buffer, size);
667 else if(stackFormat->isInteger32()) a_Integer32->decode(buffer, size);
668 else if(stackFormat->isInteger64()) a_Integer64->decode(buffer, size);
669 else if(stackFormat->isUnsigned32()) a_Unsigned32->decode(buffer, size);
670 else if(stackFormat->isUnsigned64()) a_Unsigned64->decode(buffer, size);
671 else if(stackFormat->isFloat32()) a_Float32->decode(buffer, size);
672 else if(stackFormat->isFloat64()) a_Float64->decode(buffer, size);
673 else if(stackFormat->isGrouped()) {
675 LOGDEBUG(anna::Logger::debug("Grouped Avp has empty data part", ANNA_FILE_LOCATION));
679 if((size % 4) != 0) {
680 oamModule.activateAlarm(OamModule::Alarm::AvpDecode__IncorrectLength);
681 oamModule.count(OamModule::Counter::AvpDecode__IncorrectLength);
682 throw anna::RuntimeException("Avp format error, the avp length is incorrect (must be multiple of 4 on grouped type)", ANNA_FILE_LOCATION);
689 while(avpPos < size) {
691 avp = getEngine()->allocateAvp();
692 db.assign(buffer + avpPos, size - avpPos /* is valid to pass total size (indeed i don't know the real avp size) because it will be limited and this has deep copy disabled (no memory is reserved) */);
693 avp -> decode(db, answer);
694 } catch(anna::RuntimeException &ex) {
695 getEngine()->releaseAvp(avp);
700 avpPos += 4 * REQUIRED_WORDS(avp->getLength());
702 } else if(stackFormat->isAddress()) a_Address->decode(buffer, size);
703 else if(stackFormat->isTime()) a_Time->decode(buffer, size);
704 else if(stackFormat->isUTF8String()) a_UTF8String->decode(buffer, size);
705 else if(stackFormat->isDiameterIdentity()) a_DiameterIdentity->decode(buffer, size);
706 else if(stackFormat->isDiameterURI()) a_DiameterURI->decode(buffer, size);
707 else if(stackFormat->isEnumerated()) a_Enumerated->decode(buffer, size);
708 else if(stackFormat->isIPFilterRule()) a_IPFilterRule->decode(buffer, size);
709 else if(stackFormat->isQoSFilterRule()) a_QoSFilterRule->decode(buffer, size);
711 /////////////////////
712 // Format specific //
713 /////////////////////
714 decodeDataPartByFormat(buffer, size, stackFormat);
717 //------------------------------------------------------------------------------
718 //---------------------------------------------------------------- Avp::decode()
719 //------------------------------------------------------------------------------
720 void Avp::decode(const anna::DataBlock &db, Message *answer) throw(anna::RuntimeException) {
722 OamModule &oamModule = OamModule::instantiate();
724 if(db.getSize() < HeaderLengthVinactive) {
725 oamModule.activateAlarm(OamModule::Alarm::AvpDecode__NotEnoughBytesToCoverAvpHeaderLength);
726 oamModule.count(OamModule::Counter::AvpDecode__NotEnoughBytesToCoverAvpHeaderLength);
727 // DIAMETER_INVALID_AVP_LENGTH; // no podré construir un avp fiable, asà que no registro el result-code
728 throw anna::RuntimeException("Not enough bytes to cover avp header length", ANNA_FILE_LOCATION);
731 const char * buffer = db.getData();
734 // 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
735 // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
737 // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
738 // | AVP Flags | AVP Length |
739 // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
740 // | Vendor-ID (opt) |
741 // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
744 // Code flags and vendor-id
745 U32 code = DECODE4BYTES_INDX_VALUETYPE(buffer, 0, U32);
747 a_flags = (S8)buffer[4];
749 U32 vendorID = helpers::VENDORID__base;
752 if(db.getSize() < HeaderLengthVactive) {
753 oamModule.activateAlarm(OamModule::Alarm::AvpDecode__NotEnoughBytesToCoverAvpHeaderLength);
754 oamModule.count(OamModule::Counter::AvpDecode__NotEnoughBytesToCoverAvpHeaderLength);
755 // DIAMETER_INVALID_AVP_LENGTH; // no podré construir un avp fiable, asà que no registro el result-code
756 throw anna::RuntimeException(anna::functions::asString("Not enough bytes to cover avp header length (avp code = %u)", code), ANNA_FILE_LOCATION);
759 vendorID = DECODE4BYTES_INDX_VALUETYPE(buffer, 8, U32);
761 if(vendorID == helpers::VENDORID__base) {
762 // A vendor ID value of zero (0) corresponds to the IETF adopted AVP
763 // values, as managed by the IANA. Since the absence of the vendor
764 // ID field implies that the AVP in question is not vendor specific,
766 // implementations MUST NOT use the zero (0) vendor ID.
767 oamModule.activateAlarm(OamModule::Alarm::AvpDecode__IncoherenceBetweenActivatedVBitAndZeroedVendorIDValueReceived);
768 oamModule.count(OamModule::Counter::AvpDecode__IncoherenceBetweenActivatedVBitAndZeroedVendorIDValueReceived);
769 throw anna::RuntimeException(anna::functions::asString("Incoherence between activated V bit and zeroed vendor-id value received (avp code = %u)", code), ANNA_FILE_LOCATION);
774 setId(AvpId(code, vendorID));
775 // Flags could have been updated regarding dictionary, but during decoding we must respect buffer received:
776 a_flags = (S8)buffer[4];
778 // Here i know id and flags:
779 // The 'M' Bit, known as the Mandatory bit, indicates whether support of the AVP is required. If an AVP with the 'M' bit set is received by
780 // a Diameter client, server, proxy, or translation agent and either the AVP or its value is unrecognized, the message MUST be rejected.
781 // Diameter Relay and redirect agents MUST NOT reject messages with unrecognized AVPs.
782 if(!getStackAvp() && mandatoryBit()) unknownAvpWithMandatoryBit(answer);
785 U24 length = DECODE3BYTES_INDX_VALUETYPE(buffer, 5, U24);
786 // Data start position:
787 int startDataPos = vendorBit() ? HeaderLengthVactive : HeaderLengthVinactive;
789 int dataBytes = length - startDataPos;
792 oamModule.activateAlarm(OamModule::Alarm::AvpDecode__IncorrectLength);
793 oamModule.count(OamModule::Counter::AvpDecode__IncorrectLength);
796 answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_AVP_LENGTH);
797 answer->setNewFailedAvp(a_id);
800 throw anna::RuntimeException(anna::functions::asString("Avp format error, the avp length is incorrect (avp code = %u)", code), ANNA_FILE_LOCATION);
804 decodeDataPart(buffer + startDataPos, dataBytes, answer);
805 } catch(anna::RuntimeException &ex) {
806 oamModule.activateAlarm(OamModule::Alarm::AvpDecode__DataPartInconsistence);
807 oamModule.count(OamModule::Counter::AvpDecode__DataPartInconsistence);
810 answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_AVP_VALUE); // unspecified error ...
811 answer->setNewFailedAvp((Avp*)this);
814 throw anna::RuntimeException(anna::functions::asString("Internal Avp decoding error (avp code = %u): %s", code, ex.getText().c_str()), ANNA_FILE_LOCATION);
819 //------------------------------------------------------------------------------
820 //----------------------------------------------------------- Avp::getStackAvp()
821 //------------------------------------------------------------------------------
822 const anna::diameter::stack::Avp *Avp::getStackAvp(AvpId id, Engine *engine) throw() {
823 const stack::Dictionary * dictionary = engine->getDictionary();
824 return (dictionary ? (dictionary->getAvp(id)) : NULL);
828 //------------------------------------------------------------------------------
829 //------------------------------------------------------------------- Avp::fix()
830 //------------------------------------------------------------------------------
831 void Avp::fix(avp_container &avps, find_container &finds, int &insertionPositionForChilds, anna::diameter::stack::const_avprule_iterator ruleBegin, anna::diameter::stack::const_avprule_iterator ruleEnd) throw() {
833 if(avps.size() == 0) return; // empty content, nothing to fix
835 if(ruleBegin == ruleEnd) return; // no reference. Cannot fix
837 // Copy reference container and clear internal map in order to build a fixed version:
838 avp_container unfixedAvps;
840 for(const_avp_iterator it = avps.begin(); it != avps.end(); it++)
841 unfixedAvps[(*it).first] = (*it).second;
844 // Cache system reset (fix probably will invalidate cached findings):
846 insertionPositionForChilds = 0;
850 for(anna::diameter::stack::const_avprule_iterator rule_it = ruleBegin; rule_it != ruleEnd; rule_it++) {
851 while((avp_it = Avp::avp_find(unfixedAvps, (*rule_it).second.getId(), 1)) != unfixedAvps.end()) {
852 avp = (*avp_it).second;
853 addChild(avps, insertionPositionForChilds, avp);
854 unfixedAvps.erase(avp_it); // processed
858 // Add remaining avps:
859 for(avp_it = unfixedAvps.begin(); avp_it != unfixedAvps.end(); avp_it++) {
860 avp = (*avp_it).second;
862 if(avp) addChild(avps, insertionPositionForChilds, avp);
866 for(avp_iterator it = avps.begin(); it != avps.end(); it++) {
869 if(avp->hasChildren()) avp->fix();
874 //------------------------------------------------------------------------------
875 //------------------------------------------------------------------- Avp::fix()
876 //------------------------------------------------------------------------------
877 void Avp::fix() throw() {
878 // Dictionary stack avp:
879 const stack::Avp *stackAvp = getStackAvp();
880 const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
883 //LOGDEBUG(anna::Logger::debug("No dictionary avp reference found. Cannot fix.", ANNA_FILE_LOCATION));
887 if(!stackFormat || !stackFormat->isGrouped()) {
888 //LOGDEBUG(anna::Logger::debug("Avp is not grouped. Nothing fix.", ANNA_FILE_LOCATION));
892 fix(a_avps, (find_container&)a_finds, a_insertionPositionForChilds, stackAvp->avprule_begin(), stackAvp->avprule_end());
896 //------------------------------------------------------------------------------
897 //------------------------------------------------------------ Avp::validLevel()
898 //------------------------------------------------------------------------------
899 bool Avp::validLevel(const avp_container &avps, anna::diameter::stack::const_avprule_iterator ruleBegin, anna::diameter::stack::const_avprule_iterator ruleEnd, Engine * engine, const std::string & parentDescription, Message *answer) throw(anna::RuntimeException) {
902 OamModule &oamModule = OamModule::instantiate();
908 const_avp_iterator avp_it = avps.begin();
909 anna::diameter::stack::const_avprule_iterator rule_it;
912 for(rule_it = ruleBegin; rule_it != ruleEnd; rule_it++) {
915 if((*rule_it).second.isFixed()) {
916 if(avps.size() == 0) break; // cardinality checking will show this anomaly
918 if(avp_it != avps.end()) {
919 id = Avp::avp(avp_it)->getId();
921 if(id != (*rule_it).second.getId()) {
923 // Missing fixed rule: %s
924 } else if(Avp::avp_find(avps, id, 2) != avps.end()) {
926 // More than one fixed ocurrency for rule %s (*)
930 // (*) for (register int k = 0; k < (*rule_it).second.getQualMax(); k++) avp_it++
936 // OAM & Depth management
937 oamModule.activateAlarm(OamModule::Alarm::LevelValidation__MissingFixedRule__s__Inside__s__, STRING_WITH_QUOTATION_MARKS__C_STR((*rule_it).second.asString(false /*ommit dots & pair*/)));
938 oamModule.count(OamModule::Counter::LevelValidation__MissingFixedRule);
941 answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_MISSING_AVP);
942 answer->setNewFailedAvp((*rule_it).second.getId());
945 engine->validationAnomaly(anna::functions::asString("Missing fixed rule %s inside %s", STRING_WITH_QUOTATION_MARKS__C_STR((*rule_it).second.asString(false /*ommit dots & pair*/)), STRING_WITH_QUOTATION_MARKS__C_STR(parentDescription)));
947 } else break; // finish fixed
951 // Cardinality // Mandatory control is implicit here
953 anna::diameter::stack::const_avprule_iterator generic_rule_it = ruleEnd;
954 int min, max, amount;
956 for(rule_it = ruleBegin; rule_it != ruleEnd; rule_it++) {
957 if((*rule_it).second.isAny()) { generic_rule_it = rule_it; continue; } // generic Avp will be managed after
959 id = (*rule_it).second.getId();
960 min = (*rule_it).second.getQualMin();
961 max = (*rule_it).second.getQualMax(); // -1 means infinite
962 amount = Avp::countAvp(avps, id);
964 if((amount < min) || ((max != -1) && (amount > max))) {
965 // Failed rule %s for cardinality (found %d items)
967 // OAM & Depth management
968 oamModule.activateAlarm(OamModule::Alarm::LevelValidation__FailedRule__s__ForCardinality_Found__d__ItemsInside__s__, STRING_WITH_QUOTATION_MARKS__C_STR((*rule_it).second.asString(false /*ommit dots & pair*/)), amount, STRING_WITH_QUOTATION_MARKS__C_STR(parentDescription));
969 oamModule.count(OamModule::Counter::LevelValidation__FailedRuleForCardinality);
972 oamModule.count(OamModule::Counter::LevelValidation__FailedRuleForCardinalityLessThanNeeded);
975 answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_MISSING_AVP);
976 answer->setNewFailedAvp(id);
979 oamModule.count(OamModule::Counter::LevelValidation__FailedRuleForCardinalityMoreThanNeeded);
982 answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_AVP_OCCURS_TOO_MANY_TIMES);
983 answer->setNewFailedAvp((Avp*)firstAvp(avps, id) /* first instance */);
987 engine->validationAnomaly(anna::functions::asString("Failed rule %s for cardinality (found %d items inside %s)", STRING_WITH_QUOTATION_MARKS__C_STR((*rule_it).second.asString(false /*ommit dots & pair*/)), amount, STRING_WITH_QUOTATION_MARKS__C_STR(parentDescription)));
991 bool haveGeneric = (generic_rule_it != ruleEnd);
996 std::map < AvpId, int /* dummy */ > disregarded; // 'Disregardeds' are Avps not in rules list
997 std::map < AvpId, int /* dummy */ >::const_iterator disregarded_it;
999 for(avp_it = avps.begin(); avp_it != avps.end(); avp_it++) {
1000 id = Avp::avp(avp_it)->getId();
1001 // Find rule for the child:
1002 foundInRules = false;
1004 for(rule_it = ruleBegin; rule_it != ruleEnd; rule_it++) {
1005 if((*rule_it).second.getId() == id) {
1006 foundInRules = true;
1012 disregarded[id] = 0;
1016 // Generic AVP cardinality checkings
1017 int disregardeds = disregarded.size();
1020 min = (*generic_rule_it).second.getQualMin();
1021 max = (*generic_rule_it).second.getQualMax(); // -1 means infinite
1022 amount = disregardeds;
1024 if((amount < min) || ((max != -1) && (amount > max))) {
1025 // Failed Generic AVP rule %s for cardinality (found %d disregarded items inside %s)
1027 // OAM & Depth management
1028 oamModule.activateAlarm(OamModule::Alarm::LevelValidation__FailedGenericAvpRule__s__ForCardinality_Found__d__DisregardedItemsInside__s__, STRING_WITH_QUOTATION_MARKS__C_STR((*generic_rule_it).second.asString(false /*ommit dots & pair*/)), amount, STRING_WITH_QUOTATION_MARKS__C_STR(parentDescription));
1029 oamModule.count(OamModule::Counter::LevelValidation__FailedGenericAvpRuleForCardinalityFoundDisregardedItem);
1032 answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_AVP_NOT_ALLOWED);
1033 //answer->setNewFailedAvp((Avp*)firstAvp(avps, id) /* first instance */); // NO SENSE... what to put ?
1036 engine->validationAnomaly(anna::functions::asString("Failed Generic AVP rule %s for cardinality (found %d disregarded items inside %s)", STRING_WITH_QUOTATION_MARKS__C_STR((*generic_rule_it).second.asString(false /*ommit dots & pair*/)), amount, STRING_WITH_QUOTATION_MARKS__C_STR(parentDescription)));
1038 } else if(disregardeds) { // When Generic AVP missing, no disregarded Avps are allowed
1039 // Found %d disregarded items inside %s and Generic AVP was not specified
1041 // Build disregarded list as string (unknown as avp id pair):
1042 std::string s_disregardeds = "";
1043 const stack::Avp *stackAvp;
1045 for(disregarded_it = disregarded.begin(); disregarded_it != disregarded.end(); disregarded_it++) {
1046 id = (*disregarded_it).first;
1047 stackAvp = getStackAvp(id, engine);
1048 s_disregardeds += (stackAvp ? (stackAvp->getName()) : (anna::diameter::functions::avpIdAsPairString(id)));
1049 s_disregardeds += ", ";
1051 // We wouldn't know where are these disregarded, but...
1053 answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_AVP_NOT_ALLOWED);
1054 answer->setNewFailedAvp((Avp*)firstAvp(avps, id) /* first instance */);
1058 s_disregardeds.erase(s_disregardeds.size() - 2, 2); // remove last ', '
1059 // OAM & Depth management
1060 oamModule.activateAlarm(OamModule::Alarm::LevelValidation__FoundDisregardedItemsInside__s__AndGenericAVPWasNotSpecified__s__, STRING_WITH_QUOTATION_MARKS__C_STR(parentDescription), STRING_WITH_QUOTATION_MARKS__C_STR(s_disregardeds));
1061 oamModule.count(OamModule::Counter::LevelValidation__FoundDisregardedItemsAndGenericAVPWasNotSpecified);
1062 engine->validationAnomaly(anna::functions::asString("Found disregarded items inside %s and Generic AVP was not specified: %s", STRING_WITH_QUOTATION_MARKS__C_STR(parentDescription), STRING_WITH_QUOTATION_MARKS__C_STR(s_disregardeds)));
1069 //------------------------------------------------------------------------------
1070 //----------------------------------------------------------------- Avp::valid()
1071 //------------------------------------------------------------------------------
1072 bool Avp::valid(const std::string & parentDescription, Message *answer) const throw(anna::RuntimeException) {
1074 OamModule &oamModule = OamModule::instantiate();
1075 // Dictionary stack avp:
1076 const stack::Avp *stackAvp = getStackAvp();
1077 const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
1081 // No dictionary avp reference found. Cannot validate
1082 return true; // perhaps a unknown Avp
1085 me = parentDescription + "->" + stackAvp->getName();
1088 // No format avp reference found. Cannot validate
1089 return true; // perhaps a unknown Avp
1092 //////////////////////////////
1093 // Flags coherence checking //
1094 //////////////////////////////
1095 bool result = flagsOK();
1098 // OAM & Depth management
1099 oamModule.activateAlarm(OamModule::Alarm::AvpValidation__Avp__s__Flags__d__DoesNotFulfillTheDefinedFlagRules__s__, STRING_WITH_QUOTATION_MARKS__C_STR(me), (int)a_flags, STRING_WITH_QUOTATION_MARKS__C_STR(stackAvp->getFlagRulesDescription()));
1100 oamModule.count(OamModule::Counter::AvpValidation__AvpFlagsDoesNotFulfillTheDefinedFlagRules);
1103 answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_AVP_BITS);
1104 //answer->setNewFailedAvp((Avp*)this); RFC 6733 says nothing about Failed-AVP in this case...
1107 getEngine()->validationAnomaly(anna::functions::asString("The AVP %s flags (%d) does not fulfill the defined flag rules: %s", STRING_WITH_QUOTATION_MARKS__C_STR(me), (int)a_flags, STRING_WITH_QUOTATION_MARKS__C_STR(stackAvp->getFlagRulesDescription())));
1110 //////////////////////
1111 // Enumerated range //
1112 //////////////////////
1113 if(stackFormat->isEnumerated()) {
1114 if(!stackAvp->allowEnum(a_Enumerated->getValue())) {
1116 // OAM & Depth management
1117 oamModule.activateAlarm(OamModule::Alarm::AvpValidation__EnumeratedAvp__s__WithValue__d__DoesNotComplyRestriction__s__, STRING_WITH_QUOTATION_MARKS__C_STR(me), a_Enumerated->getValue(), stackAvp->getEnums());
1118 oamModule.count(OamModule::Counter::AvpValidation__EnumeratedAvpWithValueDoesNotComplyRestriction);
1121 answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_AVP_VALUE);
1122 answer->setNewFailedAvp((Avp*)this);
1125 getEngine()->validationAnomaly(anna::functions::asString("Enumerated AVP %s with value %d does not comply to restriction: %s", STRING_WITH_QUOTATION_MARKS__C_STR(me), a_Enumerated->getValue(), stackAvp->getEnums()));
1129 ////////////////////
1130 // Level checking //
1131 ////////////////////
1132 result = Avp::validLevel(a_avps, stackAvp->avprule_begin(), stackAvp->avprule_end(), getEngine(), me, answer) && result;
1134 ////////////////////////
1135 // Childrens checking //
1136 ////////////////////////
1137 if(a_id == helpers::base::AVPID__Failed_AVP) return result; // DON'T VALIDATE CONTENT FOR Failed-AVP, because it won't be valid...
1139 for(const_avp_iterator it = avp_begin(); it != avp_end(); it++)
1140 result = ((*it).second->valid(me, answer)) && result;
1146 //------------------------------------------------------------------------------
1147 //------------------------------------------------------------------ Avp::code()
1148 //------------------------------------------------------------------------------
1149 void Avp::code(char* buffer, int &size) const throw(anna::RuntimeException) {
1151 buffer[0] = (S8)(a_id.first >> 24);
1152 buffer[1] = (S8)(a_id.first >> 16);
1153 buffer[2] = (S8)(a_id.first >> 8);
1154 buffer[3] = (S8) a_id.first;
1157 buffer[4] = (S8) a_flags;
1158 buffer[5] = (S8)(size >> 16);
1159 buffer[6] = (S8)(size >> 8);
1160 buffer[7] = (S8) size;
1164 buffer[8] = (S8)(a_id.second >> 24);
1165 buffer[9] = (S8)(a_id.second >> 16);
1166 buffer[10] = (S8)(a_id.second >> 8);
1167 buffer[11] = (S8) a_id.second;
1170 // Data start position:
1171 int startDataPos = vendorBit() ? HeaderLengthVactive : HeaderLengthVinactive;
1173 S8 * dataPart = buffer + startDataPos;
1174 int dataBytes; // not used but could be useful for checking (size - startDataPos)
1176 if(startDataPos == size) {
1177 LOGDEBUG(anna::Logger::debug("There is no data part to encode", ANNA_FILE_LOCATION));
1182 const stack::Avp *stackAvp = getStackAvp();
1183 const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
1186 a_Unknown->code(dataPart, dataBytes);
1190 if(stackFormat->isOctetString()) a_OctetString->code(dataPart, dataBytes);
1191 else if(stackFormat->isInteger32()) a_Integer32->code(dataPart, dataBytes);
1192 else if(stackFormat->isInteger64()) a_Integer64->code(dataPart, dataBytes);
1193 else if(stackFormat->isUnsigned32()) a_Unsigned32->code(dataPart, dataBytes);
1194 else if(stackFormat->isUnsigned64()) a_Unsigned64->code(dataPart, dataBytes);
1195 else if(stackFormat->isFloat32()) a_Float32->code(dataPart, dataBytes);
1196 else if(stackFormat->isFloat64()) a_Float64->code(dataPart, dataBytes);
1197 else if(stackFormat->isGrouped()) {
1198 // // Each avp encoding will remain padding octets depending on format. In order to
1199 // // code grouped content (each avp will be multiple of 4) we clean the entire buffer
1200 // // to ensure padding (easier than custom-made for each format):
1201 // memset(dataPart, 0, size - startDataPos);
1202 char *dataPartGrouped = dataPart;
1203 int dataBytesGrouped;
1205 for(const_avp_iterator it = avp_begin(); it != avp_end(); it++) {
1206 avp(it)->code(dataPartGrouped, dataBytesGrouped);
1207 dataPartGrouped = dataPartGrouped + 4 * REQUIRED_WORDS(dataBytesGrouped);
1209 } else if(stackFormat->isAddress()) a_Address->code(dataPart, dataBytes);
1210 else if(stackFormat->isTime()) a_Time->code(dataPart, dataBytes);
1211 else if(stackFormat->isUTF8String()) a_UTF8String->code(dataPart, dataBytes);
1212 else if(stackFormat->isDiameterIdentity()) a_DiameterIdentity->code(dataPart, dataBytes);
1213 else if(stackFormat->isDiameterURI()) a_DiameterURI->code(dataPart, dataBytes);
1214 else if(stackFormat->isEnumerated()) a_Enumerated->code(dataPart, dataBytes);
1215 else if(stackFormat->isIPFilterRule()) a_IPFilterRule->code(dataPart, dataBytes);
1216 else if(stackFormat->isQoSFilterRule()) a_QoSFilterRule->code(dataPart, dataBytes);
1218 /////////////////////
1219 // Format specific //
1220 /////////////////////
1221 codeByFormat(dataPart, stackFormat);
1225 //------------------------------------------------------------------------------
1226 //------------------------------------------------------------ Avp::getXMLdata()
1227 //------------------------------------------------------------------------------
1228 std::string Avp::getXMLdata(bool & isHex, const stack::Format *stackFormat) const throw() {
1229 std::string result = "";
1233 // if (!stackFormat) {
1235 // return a_Unknown->asHexString();
1237 // } catch (anna::RuntimeException &ex) {
1243 return a_Unknown->asHexString(); // el asHexString del OctetString no puede lanzar una excepcion en realidad
1246 // Special case for Address: could launch exception if not printable
1248 if(stackFormat->isAddress()) return a_Address->asPrintableString();
1249 } catch(anna::RuntimeException&) {
1252 return a_Address->asHexString();
1256 if(stackFormat->isOctetString()) {
1258 return a_OctetString->asHexString();
1262 if(stackFormat->isInteger32()) return a_Integer32->asPrintableString();
1264 if(stackFormat->isInteger64()) return a_Integer64->asPrintableString();
1266 if(stackFormat->isUnsigned32()) return a_Unsigned32->asPrintableString();
1268 if(stackFormat->isUnsigned64()) return a_Unsigned64->asPrintableString();
1270 if(stackFormat->isFloat32()) return a_Float32->asPrintableString();
1272 if(stackFormat->isFloat64()) return a_Float64->asPrintableString();
1274 //if (stackFormat->isAddress()) return a_Address->asPrintableString();
1276 if(stackFormat->isTime()) return a_Time->asPrintableString();
1278 if(stackFormat->isUTF8String()) return a_UTF8String->asPrintableString();
1280 if(stackFormat->isDiameterIdentity()) return a_DiameterIdentity->asPrintableString();
1282 if(stackFormat->isDiameterURI()) return a_DiameterURI->asPrintableString();
1284 if(stackFormat->isEnumerated()) return a_Enumerated->asPrintableString();
1286 if(stackFormat->isIPFilterRule()) return a_IPFilterRule->asPrintableString();
1288 if(stackFormat->isQoSFilterRule()) return a_QoSFilterRule->asPrintableString();
1290 /////////////////////
1291 // Format specific //
1292 /////////////////////
1293 return getXMLdataByFormat(isHex, stackFormat);
1294 } catch(anna::RuntimeException &ex) {
1302 //------------------------------------------------------------------------------
1303 //--------------------------------------------------------------- Avp::fromXML()
1304 //------------------------------------------------------------------------------
1305 void Avp::fromXML(const anna::xml::Node* avpNode) throw(anna::RuntimeException) {
1306 // <!ATTLIST avp id CDATA #IMPLIED code CDATA #IMPLIED vendor-code CDATA #IMPLIED flags CDATA #IMPLIED data CDATA #IMPLIED hex-data CDATA #IMPLIED>
1307 const anna::xml::Attribute *name, *code, *vendorCode, *flags, *data, *hexData;
1308 name = avpNode->getAttribute("name", false /* no exception */);
1309 code = avpNode->getAttribute("code", false /* no exception */);
1310 vendorCode = avpNode->getAttribute("vendor-code", false /* no exception */);
1311 flags = avpNode->getAttribute("flags", false /* no exception */);
1312 data = avpNode->getAttribute("data", false /* no exception */);
1313 hexData = avpNode->getAttribute("hex-data", false /* no exception */);
1315 const stack::Dictionary * dictionary = getEngine()->getDictionary();
1316 const stack::Avp *stackAvp = NULL;
1317 const stack::Format *stackFormat = NULL;
1322 std::string msg = "Error processing avp <name '"; msg += name->getValue();
1323 msg += "'>: no dictionary available. Load one or use <'code' + 'flags' + 'vendorCode'> instead of <'name'>";
1324 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1327 stackAvp = dictionary->getAvp(name->getValue());
1330 std::string msg = "Error processing avp <name '"; msg += name->getValue();
1331 msg += "'>: no avp found for this identifier at available dictionary";
1332 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1335 stackFormat = stackAvp->getFormat();
1338 // Check attributes exclusiveness
1339 if(name) { // compact mode
1340 if(code || flags || vendorCode) {
1341 std::string msg = "Error processing avp <name '"; msg += name->getValue();
1342 msg += "'>: avp attributes <'code' + 'flags' + 'vendorCode'> are not allowed if <'name'> is provided";
1343 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1346 setId(stackAvp->getId());
1348 if(!code || !flags || !vendorCode) {
1349 std::string s_code = code ? code->getValue() : "?";
1350 std::string s_flags = flags ? flags->getValue() : "?";
1351 std::string s_vendorCode = vendorCode ? vendorCode->getValue() : "?";
1352 std::string msg = "Error processing avp <code '"; msg += s_code;
1353 msg += "' + flags '"; msg += s_flags;
1354 msg += "' + vendorCode '"; msg += s_vendorCode;
1355 msg += "'>: all must be provided if <'name'> don't";
1356 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1360 int i_aux = code->getIntegerValue();
1363 std::string msg = "Error processing avp <code '"; msg += code->getValue();
1364 msg += "': negative values are not allowed";
1365 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1370 i_aux = flags->getIntegerValue();
1372 if(i_aux < 0 || i_aux > 256) {
1373 std::string msg = "Error processing avp <flags '"; msg += flags->getValue();
1374 msg += "': out of range [0,256]";
1375 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1379 int flagsBCK = a_flags;
1380 // VendorCode checks
1381 i_aux = vendorCode->getIntegerValue();
1384 std::string msg = "Error processing avp <vendorCode '"; msg += vendorCode->getValue();
1385 msg += "': negative values are not allowed";
1386 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1389 U32 u_vendorCode = i_aux;
1390 bool vendorSpecific1 = (u_vendorCode != 0);
1391 bool vendorSpecific2 = (((a_flags) & VBitMask) != 0x00);
1393 if(vendorSpecific1 != vendorSpecific2) {
1394 std::string msg = "Error processing avp <vendorCode '"; msg += vendorCode->getValue();
1395 msg += "' and avp <flags '"; msg += flags->getValue();
1396 msg += "': incompatible vendor-specific properties";
1397 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1400 // Final assignments
1401 setId(AvpId(u_code, u_vendorCode));
1402 // Flags could have been updated regarding dictionary, but during parsing we must respect xml file:
1404 stackAvp = getStackAvp();
1405 stackFormat = stackAvp ? stackAvp->getFormat() : NULL;
1409 // Check if grouped not confirmed
1410 anna::xml::Node::const_child_iterator it;
1411 anna::xml::Node::const_child_iterator minii = avpNode->child_begin();
1412 anna::xml::Node::const_child_iterator maxii = avpNode->child_end();
1413 const bool hasChildren(minii != maxii);
1416 // We need to confirm is grouped
1418 throw anna::RuntimeException("An xml avp node with children nodes could not confirmed as Grouped", ANNA_FILE_LOCATION);
1420 if(!stackFormat->isGrouped())
1421 throw anna::RuntimeException("An xml avp node with children nodes is not grouped type", ANNA_FILE_LOCATION);
1424 throw anna::RuntimeException("An xml avp node with children nodes has 'data' or 'hex-data' field", ANNA_FILE_LOCATION);
1428 std::string s_avp = name ? (name->getValue()) : (anna::diameter::functions::avpIdAsPairString(a_id));
1430 if(data && hexData) {
1431 std::string msg = "Not allowed both 'data' and 'hex-data' definitions. Avp ";
1433 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1437 bool unknown = !stackFormat;
1438 bool octetString = stackFormat && (stackFormat->isOctetString());
1440 if(data && (unknown || octetString)) {
1441 std::string msg = "Not recommended 'data' field at ";
1442 msg += unknown ? "Unknown" : "OctetString";
1443 msg += "-format Avp "; msg += s_avp;
1444 msg += ". Use better 'hex-data' or omit content fields if empty";
1445 anna::Logger::warning(msg, ANNA_FILE_LOCATION);
1450 if(data) a_Unknown->fromPrintableString(data->getValue().c_str());
1451 else if(hexData) a_Unknown->fromHexString(hexData->getValue());
1456 if(stackFormat->isOctetString()) {
1457 if(data) a_OctetString->fromPrintableString(data->getValue().c_str());
1458 else if(hexData) a_OctetString->fromHexString(hexData->getValue());
1459 } else if(stackFormat->isInteger32()) {
1460 if(data) a_Integer32->fromPrintableString(data->getValue().c_str());
1461 else if(hexData) a_Integer32->fromHexString(hexData->getValue());
1462 } else if(stackFormat->isInteger64()) {
1463 if(data) a_Integer64->fromPrintableString(data->getValue().c_str());
1464 else if(hexData) a_Integer64->fromHexString(hexData->getValue());
1465 } else if(stackFormat->isUnsigned32()) {
1466 if(data) a_Unsigned32->fromPrintableString(data->getValue().c_str());
1467 else if(hexData) a_Unsigned32->fromHexString(hexData->getValue());
1468 } else if(stackFormat->isUnsigned64()) {
1469 if(data) a_Unsigned64->fromPrintableString(data->getValue().c_str());
1470 else if(hexData) a_Unsigned64->fromHexString(hexData->getValue());
1471 } else if(stackFormat->isFloat32()) {
1472 if(data) a_Float32->fromPrintableString(data->getValue().c_str());
1473 else if(hexData) a_Float32->fromHexString(hexData->getValue());
1474 } else if(stackFormat->isFloat64()) {
1475 if(data) a_Float64->fromPrintableString(data->getValue().c_str());
1476 else if(hexData) a_Float64->fromHexString(hexData->getValue());
1477 } else if(stackFormat->isGrouped()) {
1481 for(it = minii; it != maxii; it++) {
1482 std::string nodeName = (*it)->getName();
1484 if(nodeName != "avp") {
1485 std::string msg = "Unsupported grouped avp child node name '"; msg += nodeName;
1486 msg += "': use 'avp'";
1487 throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
1491 avp = getEngine()->allocateAvp();
1492 avp -> fromXML(*it);
1493 } catch(anna::RuntimeException &ex) {
1494 getEngine()->releaseAvp(avp);
1500 } else if(stackFormat->isAddress()) {
1501 if(data) a_Address->fromPrintableString(data->getValue().c_str());
1502 else if(hexData) a_Address->fromHexString(hexData->getValue());
1503 } else if(stackFormat->isTime()) {
1504 if(data) a_Time->fromPrintableString(data->getValue().c_str());
1505 else if(hexData) a_Time->fromHexString(hexData->getValue());
1506 } else if(stackFormat->isUTF8String()) {
1507 if(data) a_UTF8String->fromPrintableString(data->getValue().c_str());
1508 else if(hexData) a_UTF8String->fromHexString(hexData->getValue());
1509 } else if(stackFormat->isDiameterIdentity()) {
1510 if(data) a_DiameterIdentity->fromPrintableString(data->getValue().c_str());
1511 else if(hexData) a_DiameterIdentity->fromHexString(hexData->getValue());
1512 } else if(stackFormat->isDiameterURI()) {
1513 if(data) a_DiameterURI->fromPrintableString(data->getValue().c_str());
1514 else if(hexData) a_DiameterURI->fromHexString(hexData->getValue());
1515 } else if(stackFormat->isEnumerated()) {
1516 if(data) a_Enumerated->fromPrintableString(data->getValue().c_str());
1517 else if(hexData) a_Enumerated->fromHexString(hexData->getValue());
1518 } else if(stackFormat->isIPFilterRule()) {
1519 if(data) a_IPFilterRule->fromPrintableString(data->getValue().c_str());
1520 else if(hexData) a_IPFilterRule->fromHexString(hexData->getValue());
1521 } else if(stackFormat->isQoSFilterRule()) {
1522 if(data) a_QoSFilterRule->fromPrintableString(data->getValue().c_str());
1523 else if(hexData) a_QoSFilterRule->fromHexString(hexData->getValue());
1526 /////////////////////
1527 // Format specific //
1528 /////////////////////
1529 fromXMLByFormat(data, hexData, stackFormat);
1532 //------------------------------------------------------------------------------
1533 //----------------------------------------------------------------- Avp::asXML()
1534 //------------------------------------------------------------------------------
1535 anna::xml::Node* Avp::asXML(anna::xml::Node* parent) const throw() {
1536 // <!ATTLIST avp id CDATA #IMPLIED code CDATA #IMPLIED vendor-code CDATA #IMPLIED flags CDATA #IMPLIED data CDATA #IMPLIED hex-data CDATA #IMPLIED>
1537 anna::xml::Node* result = parent->createChild("avp");
1538 // Dictionary stack avp and format:
1539 const stack::Avp *stackAvp = getStackAvp();
1540 const stack::Format *stackFormat = stackAvp ? (stackAvp->getFormat()) : NULL /*Unknown*/;
1541 bool compactMode = (stackAvp && flagsOK());
1544 result->createAttribute("name", stackAvp->getName());
1546 result->createAttribute("code", a_id.first);
1547 result->createAttribute("vendor-code", a_id.second);
1548 result->createAttribute("flags", (int)a_flags);
1551 // Grouped special case:
1552 if(stackFormat && stackFormat->isGrouped()) {
1553 for(const_avp_iterator it = avp_begin(); it != avp_end(); it++) avp(it)->asXML(result);
1558 // Data part literals:
1560 std::string value = getXMLdata(isHex, stackFormat);
1563 result->createAttribute("hex-data", value);
1565 result->createAttribute("data", value);
1566 const char *alias = stackAvp->getAlias(value);
1568 if(alias) result->createAttribute("alias", alias); // additional information
1574 //------------------------------------------------------------------------------
1575 //----------------------------------------------------------- Avp::asXMLString()
1576 //------------------------------------------------------------------------------
1577 std::string Avp::asXMLString() const throw() {
1578 anna::xml::Node root("root");
1579 return anna::xml::Compiler().apply(asXML(&root));