Fixed multiple AVP error. Missing fix RFC 6733 section 7.5 regarding avps within...
[anna.git] / source / diameter / codec / Message.cpp
index 5fe2724..7fc92e8 100644 (file)
@@ -2,7 +2,7 @@
 //
 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
 //
-// https://bitbucket.org/testillano/anna
+// http://redmine.teslayout.com/projects/anna-suite
 //
 // Redistribution and use in source and binary forms, with or without
 // modification, are permitted provided that the following conditions
@@ -14,7 +14,7 @@
 // copyright notice, this list of conditions and the following disclaimer
 // in the documentation and/or other materials provided with the
 // distribution.
-//     * Neither the name of Google Inc. nor the names of its
+//     *  Neither the name of the copyright holder nor the names of its
 // contributors may be used to endorse or promote products derived from
 // this software without specific prior written permission.
 //
@@ -300,7 +300,7 @@ void Message::decode(const anna::DataBlock &db, Message *ptrAnswer) throw(anna::
   if(db.getSize() < HeaderLength) {
     oamModule.activateAlarm(OamModule::Alarm::MessageDecode__NotEnoughBytesToCoverMessageHeaderLength);
     oamModule.count(OamModule::Counter::MessageDecode__NotEnoughBytesToCoverMessageHeaderLength);
-    // DIAMETER_INVALID_MESSAGE_LENGTH; // no podré construir un answer fiable, así que no registro el result-code
+    // DIAMETER_INVALID_MESSAGE_LENGTH; // no podr� construir un answer fiable, as� que no registro el result-code
     throw anna::RuntimeException("Not enough bytes to cover message header length (20 bytes)", ANNA_FILE_LOCATION);
   }
 
@@ -376,10 +376,9 @@ void Message::decode(const anna::DataBlock &db, Message *ptrAnswer) throw(anna::
       avp -> decode(db_aux, answer);
     } catch(anna::RuntimeException &ex) {
       if(answer) {
-        answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_AVP_VALUE); // unspecified error ...
-        answer->setNewFailedAvp(avp->getId());
+        //answer->setResultCode(helpers::base::AVPVALUES__Result_Code::DIAMETER_INVALID_AVP_VALUE); // unspecified error ...
+        answer->setFailedAvp(avp->getId());
       }
-
       getEngine()->releaseAvp(avp);
       LOGWARNING(
         anna::Logger::warning(ex.getText(), ANNA_FILE_LOCATION);
@@ -457,17 +456,85 @@ int Message::getResultCode() const throw() {
 
 
 //------------------------------------------------------------------------------
-//------------------------------------------------------ Message::addFailedAVP()
+//--------------------------------------------------- Message::addTheFailedAVP()
 //------------------------------------------------------------------------------
-Avp * Message::addFailedAVP() throw() {
+Avp * Message::addTheFailedAVP() throw() {
   Avp *result = getAvp(helpers::base::AVPID__Failed_AVP, 1, anna::Exception::Mode::Ignore);
 
+  // Section 7.5 RFC 6733: A Diameter message SHOULD contain one Failed-AVP AVP
   if(!result) result = addAvp(helpers::base::AVPID__Failed_AVP);
 
   return result;
 }
 
 
+//------------------------------------------------------------------------------
+//------------------------------------------------------ Message::setFailedAvp()
+//------------------------------------------------------------------------------
+Avp * Message::setFailedAvp(AvpId id) throw(anna::RuntimeException) {
+
+  if(isRequest()) return NULL;
+
+// RFC 6733:
+//
+//  7.5.  Failed-AVP AVP
+//
+//     The Failed-AVP AVP (AVP Code 279) is of type Grouped and provides
+//     debugging information in cases where a request is rejected or not
+//     fully processed due to erroneous information in a specific AVP.  The
+//     value of the Result-Code AVP will provide information on the reason
+//     for the Failed-AVP AVP.  A Diameter answer message SHOULD contain an
+//     instance of the Failed-AVP AVP that corresponds to the error
+//     indicated by the Result-Code AVP.  For practical purposes, this
+//     Failed-AVP would typically refer to the first AVP processing error
+//     that a Diameter node encounters.
+
+  // Although the Failed-AVP definition has cardinality 1* and Failed-AVP itself is defined in
+  // most of the command codes as *[Failed-AVP], i think this is not a deliberate ambiguity.
+  // Probably the RFC wants to give freedom to the application layer, but it is recommended to
+  // have only one child (wrong avp) inside a unique message Failed-AVP to ease the Result-Code
+  // correspondence. Anyway, this behaviour could be easily  opened commenting condition block (*).
+  Avp *theFailedAvp = addTheFailedAVP();
+  LOGDEBUG(
+    std::string msg = "Adding wrong avp ";
+    msg += anna::diameter::functions::avpIdAsPairString(id);
+    msg += " within the message Failed-AVP ...";
+    anna::Logger::debug(msg, ANNA_FILE_LOCATION);
+  );
+
+  if (theFailedAvp->countChilds()) { // (*)
+       LOGDEBUG(anna::Logger::debug("Discarding wrong avp. A previous wrong avp was already added into the Failed-AVP. RFC 6733 Section 7.5 recommends to store only the first.", ANNA_FILE_LOCATION));
+       return NULL;
+  }
+
+  return (theFailedAvp->addAvp(id));
+}
+
+
+//------------------------------------------------------------------------------
+//------------------------------------------------------ Message::setFailedAvp()
+//------------------------------------------------------------------------------
+Avp * Message::setFailedAvp(Avp *avp) throw(anna::RuntimeException) {
+
+  if(!avp || isRequest()) return NULL;
+
+  Avp *theFailedAvp = addTheFailedAVP();
+  LOGDEBUG(
+    std::string msg = "Adding wrong avp ";
+    msg += anna::diameter::functions::avpIdAsPairString(avp->getId());
+    msg += " within the message Failed-AVP ...";
+    anna::Logger::debug(msg, ANNA_FILE_LOCATION);
+  );
+
+  if (theFailedAvp->countChilds()) { // (*)
+       LOGDEBUG(anna::Logger::debug("Discarding wrong avp. A previous wrong avp was already added into the Failed-AVP. RFC 6733 Section 7.5 recommends to store only the first.", ANNA_FILE_LOCATION));
+       return NULL;
+  }
+
+  return (theFailedAvp->addAvp(avp));
+}
+
+
 //------------------------------------------------------------------------------
 //----------------------------------------------- Message::setStandardToAnswer()
 //------------------------------------------------------------------------------
@@ -480,7 +547,8 @@ void Message::setStandardToAnswer(const Message &request, const std::string &ori
   const Avp *reqSessionId = request.getAvp(helpers::base::AVPID__Session_Id, 1, anna::Exception::Mode::Ignore);
 
   if(reqSessionId)
-    addAvp(helpers::base::AVPID__Session_Id)->getUTF8String()->setValue(reqSessionId->getUTF8String()->getValue());
+       if(!getAvp(helpers::base::AVPID__Session_Id, 1, anna::Exception::Mode::Ignore))
+      addAvp(helpers::base::AVPID__Session_Id)->getUTF8String()->setValue(reqSessionId->getUTF8String()->getValue());
 
   // Origin-Host & Realm
   if(!getAvp(helpers::base::AVPID__Origin_Host, 1, anna::Exception::Mode::Ignore))
@@ -811,11 +879,13 @@ void Message::fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeExc
   // Application-id
   u_aux = appid->getIntegerValue();
 
+  /*
   if(u_aux < 0) {
     std::string msg = "Error processing command <application-id '"; msg += appid->getValue();
     msg += "': negative values are not allowed";
     throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
   }
+  */
 
   setApplicationId(u_aux);
 
@@ -823,11 +893,13 @@ void Message::fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeExc
   if(hbh) {
     u_aux = hbh->getIntegerValue();
 
+    /*
     if(u_aux < 0) {
       std::string msg = "Error processing command <hop-by-hop-id '"; msg += hbh->getValue();
       msg += "': negative values are not allowed";
       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
     }
+    */
   } else u_aux = 0;
 
   setHopByHop(u_aux);
@@ -836,11 +908,13 @@ void Message::fromXML(const anna::xml::Node* messageNode) throw(anna::RuntimeExc
   if(ete) {
     u_aux = ete->getIntegerValue();
 
+    /*
     if(u_aux < 0) {
       std::string msg = "Error processing command <end-to-end-id '"; msg += ete->getValue();
       msg += "': negative values are not allowed";
       throw anna::RuntimeException(msg, ANNA_FILE_LOCATION);
     }
+    */
   } else u_aux = 0;
 
   setEndToEnd(u_aux);