pana_message.h

/* BEGIN_COPYRIGHT                                                        */
/*                                                                        */
/* Open Diameter: Open-source software for the Diameter and               */
/*                Diameter related protocols                              */
/*                                                                        */
/* Copyright (C) 2002-2004 Open Diameter Project                          */
/*                                                                        */
/* This library is free software; you can redistribute it and/or modify   */
/* it under the terms of the GNU Lesser General Public License as         */
/* published by the Free Software Foundation; either version 2.1 of the   */
/* License, or (at your option) any later version.                        */
/*                                                                        */
/* This library is distributed in the hope that it will be useful,        */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of         */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU      */
/* Lesser General Public License for more details.                        */
/*                                                                        */
/* You should have received a copy of the GNU Lesser General Public       */
/* License along with this library; if not, write to the Free Software    */
/* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307    */
/* USA.                                                                   */
/*                                                                        */
/* In addition, when you copy and redistribute some or the entire part of */
/* the source code of this software with or without modification, you     */
/* MUST include this copyright notice in each copy.                       */
/*                                                                        */
/* If you make any changes that are appeared to be useful, please send    */
/* sources that include the changed part to                               */
/* diameter-developers@lists.sourceforge.net so that we can reflect your  */
/* changes to one unified version of this software.                       */
/*                                                                        */
/* END_COPYRIGHT                                                          */

#ifndef __PANA_MESSAGES_H__
#define __PANA_MESSAGES_H__

#include <list>
#include "ace/Basic_Types.h"
#include "ace/Message_Block.h"
#include "pana_defs.h"
#include "pana_exports.h"
#include "pana_device_id.h"
#include "diameter_parser_api.h"

#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000

#define PANA_DICT_PROTOCOL_ID  1

typedef struct {
    AAA_UINT8 type; 
    diameter_octetstring_t value; 
} PANA_TVData_t;

#define PANA_MACGEN_HMACSHA1   1
#define PANA_MACGEN_HMACSIZE   20

// Data type assignment
#define AAA_AVP_DEVICEID_TYPE (AAA_AVP_CUSTOM_TYPE+1)
#define AAA_AVP_MAC_TYPE      (AAA_AVP_CUSTOM_TYPE+2)

typedef AAATypeSpecificAvpContainerEntry<PANA_TVData_t> AAATVDataAvpContainerEntry;

class PANA_TVDataParser : public AvpValueParser
{
   public:
      void parseRawToApp() throw(AAAErrorStatus) {
          AAAMessageBlock* aBuffer = (AAAMessageBlock*)getRawData();
          AAAAvpContainerEntry* e = (AAAAvpContainerEntry*)getAppData();
          PANA_TVData_t &tve = reinterpret_cast<AAATVDataAvpContainerEntry*>(e)->dataRef();
          tve.type = *((AAA_UINT8*)aBuffer->base());
          tve.value.assign(aBuffer->base() + 1, aBuffer->size() - 1);
      }

      void parseAppToRaw() throw(AAAErrorStatus) {
          AAAMessageBlock* aBuffer = (AAAMessageBlock*)getRawData();
          AAAAvpContainerEntry* e = (AAAAvpContainerEntry*)getAppData();
          PANA_TVData_t &tve = reinterpret_cast<AAATVDataAvpContainerEntry*>(e)->dataRef();
          AAAErrorStatus st;
          if (aBuffer->size() - (size_t)aBuffer->wr_ptr() < (tve.value.size() + sizeof(AAA_UINT8))) {
              st.set(NORMAL, DIAMETER_OUT_OF_SPACE);
              throw st;
          }
          *((AAA_UINT8*)aBuffer->wr_ptr()) = tve.type;
          aBuffer->wr_ptr(sizeof(AAA_UINT8));
          aBuffer->copy(tve.value.data(), tve.value.size());
      }
};

class PANA_EXPORT PANA_MsgHeader 
{
    public:
       typedef struct {
           UCHAR request   : 1;  
           UCHAR reserved1 : 3;  
           UCHAR separate  : 1;  
           UCHAR reserved2 : 3;  
       } Flags;

       typedef enum {
           HeaderLength = 16 // length in UCHAR
       };

    public:
       PANA_MsgHeader();

       virtual ~PANA_MsgHeader() { }

       inline UCHAR version() { return version_; }

       inline void version(UCHAR ver) { version_ = ver; }

       inline ACE_UINT32 length() { return length_; }

       inline void length(ACE_UINT32 len) { length_ = len; }

       inline PANA_MsgHeader::Flags &flags() { return flags_; }

       inline void flags(PANA_MsgHeader::Flags flg) { flags_ = flg; }

       inline ACE_UINT32 type() { return type_; }

       inline void type(ACE_UINT32 typ) { type_ = typ; }

       inline ACE_UINT32 tseq() { return tseq_; }

       inline void tseq(ACE_UINT32 seq) { tseq_ = seq; }

       inline ACE_UINT32 rseq() { return rseq_; }

       inline void rseq(ACE_UINT32 seq) { rseq_ = seq; }

       inline AAADictionaryHandle *getDictHandle() { return dictHandle_; }

       inline void setDictHandle(AAADictionaryHandle *handle) { dictHandle_ = handle; }

    protected:

       UCHAR version_; 
       ACE_UINT32 length_:24; 
       PANA_MsgHeader::Flags flags_; 
       ACE_UINT32 type_:24; 
       ACE_UINT32 tseq_; 
       ACE_UINT32 rseq_; 
       AAADictionaryHandle* dictHandle_; 
};

/* \brief PANA Message Header parser
 *
 */

typedef AAAParser<AAAMessageBlock*,
                  PANA_MsgHeader*,
                  AAADictionaryOption*> PANA_HeaderParser;

/*\brief PANA Message definition
 *
 */
class PANA_EXPORT PANA_Message : public PANA_MsgHeader
{
     public:
         PANA_Message();

        virtual ~PANA_Message();

        AAAAvpContainerList &avpList() { return avpList_; }

       PANA_DeviceIdContainer &srcDevices() { return srcDevices_; }

       ACE_UINT32 &srcPort() { return srcPort_; }

       void srcPort(ACE_UINT32 port) { srcPort_ = port; }

     protected:

        AAAAvpContainerList avpList_;

        PANA_DeviceIdContainer srcDevices_;

        ACE_UINT32 srcPort_;
};

typedef PayloadParser PANA_PayloadParser;

#endif /* __PANA_MESSAGE_H__ */

---