source/diameter/codec/functions.cpp

   1 // ANNA - Anna is Not Nothingness Anymore                                                         //
   2 //                                                                                                //
   3 // (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo                         //
   4 //                                                                                                //
   5 // See project site at http://redmine.teslayout.com/projects/anna-suite                           //
   6 // See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
   7
   8
   9 // Local
  10 #include <anna/diameter/codec/functions.hpp>
  11 #include <anna/diameter/codec/Message.hpp>
  12 #include <anna/diameter/codec/Avp.hpp>
  13 #include <anna/diameter/defines.hpp>
  14 #include <anna/diameter/functions.hpp>
  15 #include <anna/config/defines.hpp> // general types, decoding helpers (DECODE[2/3/4]BYTES_INDX_VALUETYPE), etc.
  16
  17 #include <anna/core/DataBlock.hpp>
  18 #include <anna/core/functions.hpp>
  19 #include <anna/core/tracing/Logger.hpp>
  20
  21 // STL
  22 #include <string>
  23
  24
  25 using namespace anna::diameter::codec;
  26
  27
  28
  29
  30 // Parent struct helper /////////////////////////////////////////////////////////////////////////////
  31 void parent::setMessage(const anna::diameter::CommandId & mid, const char *mname) throw() {
  32   MessageId = mid;
  33   if (mname) {
  34     MessageName = mname;
  35   }
  36   else {
  37         MessageName = "Message";
  38     MessageName += anna::diameter::functions::commandIdAsPairString(mid);
  39   }
  40 }
  41
  42 void parent::addAvp(const anna::diameter::AvpId & aid, const char *aname) throw() {
  43   AvpsId.push_back(aid);
  44   std::string name;
  45   if (aname) {
  46         name = aname;
  47   }
  48   else {
  49     name = "Avp";
  50         name += anna::diameter::functions::avpIdAsPairString(aid);
  51   }
  52   AvpsName.push_back(name);
  53 }
  54
  55 std::string parent::asString() const throw() { // "<command><avp 1>-><avp 2>->...-><avp N>"
  56   std::string result = MessageName;
  57   for (std::vector<std::string>::const_iterator it = AvpsName.begin(); it != AvpsName.end(); it++) {
  58         result += "->";
  59         result += (*it);
  60   }
  61
  62   return result;
  63 }
  64 /////////////////////////////////////////////////////////////////////////////////////////////////////
  65
  66
  67
  68
  69 // getters
  70 anna::diameter::CommandId functions::getCommandId(const anna::DataBlock & db) throw(anna::RuntimeException) {
  71   if(db.getSize() < Message::HeaderLength)
  72     throw anna::RuntimeException("Not enough bytes to cover command header length", ANNA_FILE_LOCATION);
  73
  74   const char * data = db.getData();
  75   U8 flags =  data[4];
  76   U24 code = DECODE3BYTES_INDX_VALUETYPE(data, 5, U24);
  77 //   U24 code = (((U24)data[5] << 16) & 0xFF0000) +
  78 //              (((U24)data[6] << 8)  & 0x00FF00) +
  79 //              (((U24)data[7]) & 0x0000FF);
  80   return (anna::diameter::CommandId(code, (flags & Message::RBitMask) != 0x00));
  81 }
  82
  83
  84 bool functions::isRequest(const anna::DataBlock & db) throw(anna::RuntimeException) {
  85   if(db.getSize() < Message::HeaderLength)
  86     throw anna::RuntimeException("Not enough bytes to cover command header length", ANNA_FILE_LOCATION);
  87
  88   return (((db.getData())[4] & Message::RBitMask) != 0x00);
  89 }
  90
  91 anna::diameter::ApplicationId functions::getApplicationId(const anna::DataBlock & db) throw(anna::RuntimeException) {
  92   if(db.getSize() < Message::HeaderLength)
  93     throw anna::RuntimeException("Not enough bytes to cover command header length", ANNA_FILE_LOCATION);
  94
  95   const char * appidPtr = db.getData() + 8;
  96   anna::diameter::ApplicationId result = DECODE4BYTES_INDX_VALUETYPE(appidPtr, 0, U32);
  97 //   anna::diameter::ApplicationId result = (((U32)appidPtr[0] << 24) & 0xFF000000) +
  98 //                               (((U32)appidPtr[1] << 16) & 0x00FF0000) +
  99 //                               (((U32)appidPtr[2] << 8) & 0x0000FF00) +
 100 //                               (((U32)appidPtr[3]) & 0x000000FF);
 101   return result;
 102 }
 103
 104 anna::diameter::HopByHop functions::getHopByHop(const anna::DataBlock & db) throw(anna::RuntimeException) {
 105   if(db.getSize() < Message::HeaderLength)
 106     throw anna::RuntimeException("Not enough bytes to cover command header length", ANNA_FILE_LOCATION);
 107
 108   const char * hbhPtr = db.getData() + 12;
 109   anna::diameter::HopByHop result = DECODE4BYTES_INDX_VALUETYPE(hbhPtr, 0, U32);
 110 //   anna::diameter::HopByHop result = (((U32)hbhPtr[0] << 24) & 0xFF000000) +
 111 //                               (((U32)hbhPtr[1] << 16) & 0x00FF0000) +
 112 //                               (((U32)hbhPtr[2] << 8) & 0x0000FF00) +
 113 //                               (((U32)hbhPtr[3]) & 0x000000FF);
 114   return result;
 115 }
 116
 117 anna::diameter::EndToEnd functions::getEndToEnd(const anna::DataBlock & db) throw(anna::RuntimeException) {
 118   if(db.getSize() < Message::HeaderLength)
 119     throw anna::RuntimeException("Not enough bytes to cover command header length", ANNA_FILE_LOCATION);
 120
 121   const char * etePtr = db.getData() + 16;
 122   anna::diameter::EndToEnd result = DECODE4BYTES_INDX_VALUETYPE(etePtr, 0, U32);
 123 //   anna::diameter::EndToEnd result = (((U32)etePtr[0] << 24) & 0xFF000000) +
 124 //                               (((U32)etePtr[1] << 16) & 0x00FF0000) +
 125 //                               (((U32)etePtr[2] << 8) & 0x0000FF00) +
 126 //                               (((U32)etePtr[3]) & 0x000000FF);
 127   return result;
 128 }
 129
 130 void functions::decodeCommandHeader(const char *start, char & version, U24 & length, char & flags, diameter::CommandId & id, int & appId, int & hbh, int & ete) throw(anna::RuntimeException) {
 131   if(start == NULL)
 132     throw anna::RuntimeException("NULL provided start pointer", ANNA_FILE_LOCATION);
 133
 134   //      0                   1                   2                   3
 135   //      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
 136   //      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 137   //      |    Version    |                 Message Length                |
 138   //      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 139   //      | command flags |                  Command-Code                 |
 140   //      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 141   //      |                         Application-ID                        |
 142   //      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 143   //      |                      Hop-by-Hop Identifier                    |
 144   //      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 145   //      |                      End-to-End Identifier                    |
 146   //      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 147   //      |  AVPs ...
 148   //      +-+-+-+-+-+-+-+-+-+-+-+-+-
 149   version = start[0]; // Version
 150   //length = (start[1] << 16) + (start[2] << 8) + start[3]; // Message Length
 151   length = DECODE3BYTES_INDX_VALUETYPE(start, 1, U24);
 152   flags = start[4]; // command flags
 153   //id.first = (start[5] << 16) + (start[6] << 8) + start[7]; // Command-Code
 154   id.first = DECODE3BYTES_INDX_VALUETYPE(start, 5, U24);
 155   id.second = ((flags & Message::RBitMask) != 0x00); // Command-Code is a request
 156   //appId = (start[8] << 24) + (start[9] << 16) + (start[10] << 8) + start[11]; // Application-ID
 157   appId = DECODE4BYTES_INDX_VALUETYPE(start, 8, U32);
 158   //hbh = (start[12] << 24) + (start[13] << 16) + (start[14] << 8) + start[15]; // Hop-by-Hop Identifier
 159   hbh = DECODE4BYTES_INDX_VALUETYPE(start, 12, U32);
 160   //ete = (start[16] << 24) + (start[17] << 16) + (start[18] << 8) + start[19]; // End-to-End Identifier
 161   ete = DECODE4BYTES_INDX_VALUETYPE(start, 16, U32);
 162 }
 163
 164 void functions::decodeAVP(const char *start, diameter::AvpId & id, char & flags, int & length, std::string & data) throw(anna::RuntimeException) {
 165   if(start == NULL)
 166     throw anna::RuntimeException("NULL provided start pointer", ANNA_FILE_LOCATION);
 167
 168   //       0                   1                   2                   3
 169   //       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
 170   //      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 171   //      |                           AVP Code                            |
 172   //      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 173   //      |   AVP Flags   |                  AVP Length                   |
 174   //      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 175   //      |                        Vendor-ID (opt)                        |
 176   //      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 177   //      |    Data ...
 178   //      +-+-+-+-+-+-+-+-+
 179   //id.first = (start[0] << 24) + (start[1] << 16) + (start[2] << 8) + start[3]; // AVP Code
 180   id.first = DECODE4BYTES_INDX_VALUETYPE(start, 0, S32);
 181   flags = start[4]; // AVP Flags
 182   //length = (start[5] << 16) + (start[6] << 8) + start[7]; // AVP Length
 183   length = DECODE3BYTES_INDX_VALUETYPE(start, 5, U24);
 184   bool vendorSpecific = ((flags & Avp::VBitMask) != 0x00); // AVP Code is vendor-specific
 185   //id.second = (vendorSpecific ? ((start[8] << 24) + (start[9] << 16) + (start[10] << 8) + start[11]) : 0 /* IETF */); // Vendor-ID (opt)
 186   id.second = (vendorSpecific ? (DECODE4BYTES_INDX_VALUETYPE(start, 8, S32)) : 0 /* IETF */); // Vendor-ID (opt)
 187   int dataLength = (vendorSpecific ? (length - 12) : (length - 8)); // avp data part length
 188   const char *dataPointer = (vendorSpecific ? (start + 12) : (start + 8)); // pointer to data part
 189   data.assign(dataPointer, dataLength);
 190   LOGLOCAL3(
 191     std::string msg = anna::functions::asString("decodedAVP id (%d,%d), length %d, data length %d, data part 0x%s",
 192                       id.first, id.second, length, dataLength, anna::functions::asHexString(anna::DataBlock(dataPointer, dataLength)).c_str());
 193     anna::Logger::write(anna::Logger::Local3, msg, ANNA_FILE_LOCATION);
 194   );
 195 }
 196
 197 const char * functions::nextAVP(const anna::DataBlock & avpsDB, const char *start) throw(anna::RuntimeException) {
 198   if(start == NULL)
 199     throw anna::RuntimeException("NULL provided start pointer", ANNA_FILE_LOCATION);
 200
 201   const char *result;
 202 //   LOGDEBUG(
 203 //      std::string msg("DataBlock provided to 'nextAVP'");
 204 //      msg += avpsDB.asString();
 205 //      anna::Logger::debug(msg, ANNA_FILE_LOCATION);
 206 //   );
 207   //int avpLength = (start[5] << 16) + (start[6] << 8) + start[7]; // AVP Length
 208   int avpLength = DECODE3BYTES_INDX_VALUETYPE(start, 5, int);
 209   result = start + 4 * REQUIRED_WORDS(avpLength);
 210   const char * first = avpsDB.getData();
 211   int offset = (result - first);
 212
 213   if(offset > (avpsDB.getSize() - 1))
 214     //throw anna::RuntimeException("Start pointer out of boundaries for DataBlock", ANNA_FILE_LOCATION);
 215     return NULL; // (*)
 216
 217   return result;
 218 }
 219
 220 const char * functions::findAVP(const anna::DataBlock & avpsDB, const diameter::AvpId & id, int n) throw(anna::RuntimeException) {
 221   const char * result = avpsDB.getData(); // first avp
 222   int positives = 0;
 223   // Decoded avp information:
 224   diameter::AvpId _id;
 225   char _flags;
 226   int _length;
 227   std::string _data;
 228   decodeAVP(result, _id, _flags, _length, _data);
 229
 230   if(_id == id) positives++;
 231
 232   while((_id != id) || (positives != n)) {  // next search if not found or not ocurrence number reached
 233     result = nextAVP(avpsDB, result);
 234
 235     if(result == NULL) {  // (*)
 236       LOGDEBUG(
 237         std::string msg = "AVP ";
 238         msg += anna::diameter::functions::avpIdAsPairString(id);
 239         msg += " not found at DataBlock";
 240         anna::Logger::debug(msg, ANNA_FILE_LOCATION);
 241       );
 242       return NULL;
 243     }
 244
 245     decodeAVP(result, _id, _flags, _length, _data);
 246
 247     if(_id == id) positives++;
 248   }
 249
 250   return result;
 251 }
 252
 253
 254 // modifiers
 255 void functions::setHopByHop(anna::DataBlock & db, diameter::HopByHop hbh) throw(anna::RuntimeException) {
 256   if(db.getSize() < Message::HeaderLength) {
 257     throw anna::RuntimeException("Not enough bytes to cover command header length", ANNA_FILE_LOCATION);
 258   }
 259
 260   static char source[4];
 261   source[0] = (char)(hbh >> 24);
 262   source[1] = (char)(hbh >> 16);
 263   source[2] = (char)(hbh >> 8);
 264   source[3] = (char)hbh;
 265   memcpy((char*)(db.getData() + 12), source, 4);
 266 }
 267
 268
 269 void functions::setEndToEnd(anna::DataBlock & db, diameter::EndToEnd ete) throw(anna::RuntimeException) {
 270   if(db.getSize() < Message::HeaderLength) {
 271     throw anna::RuntimeException("Not enough bytes to cover command header length", ANNA_FILE_LOCATION);
 272   }
 273
 274   static char source[4];
 275   source[0] = (char)(ete >> 24);
 276   source[1] = (char)(ete >> 16);
 277   source[2] = (char)(ete >> 8);
 278   source[3] = (char)ete;
 279   memcpy((char *)(db.getData() + 16), source, 4);
 280 }
 281
 282