pana_message.h

Diameter协议栈

/* 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                               */
/* [e-mail] 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"

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

#define PANA_DICT_PROTOCOL_ID  1

// PANA DHCP AVP definitions.
// We extend open diameter AVP containers
typedef struct {
    ACE_UINT32 id;
    diameter_octetstring_t nonce;
} PANA_DhcpData_t;

// Data type assignment
#define AAA_AVP_DHCP_TYPE (AAA_AVP_CUSTOM_TYPE+1)

typedef AAATypeSpecificAvpContainerEntry<PANA_DhcpData_t> 
               AAADhcpDataAvpContainerEntry;

typedef AAA_AvpWidget<PANA_DhcpData_t, 
               AAA_AVPDataType(AAA_AVP_DHCP_TYPE)>
               PANA_DhcpAvpWidget;

typedef AAA_AvpContainerWidget<PANA_DhcpData_t, 
               AAA_AVPDataType(AAA_AVP_DHCP_TYPE)>
               PANA_DhcpAvpContainerWidget;

// PANA DHCP AVP parser
class PANA_DhcpDataParser : public AvpValueParser
{
   public:
      void parseRawToApp() throw(AAAErrorStatus) {
          AAAMessageBlock* aBuffer = (AAAMessageBlock*)getRawData();
          AAAAvpContainerEntry* e = (AAAAvpContainerEntry*)getAppData();
          PANA_DhcpData_t &dhcp = reinterpret_cast<AAADhcpDataAvpContainerEntry*>
                                                   (e)->dataRef();
          dhcp.id = *((ACE_UINT32*)aBuffer->base());
          dhcp.nonce.assign(aBuffer->base() + sizeof(ACE_UINT32), 
                            aBuffer->size() - sizeof(ACE_UINT32));
      }
      void parseAppToRaw() throw(AAAErrorStatus) {
          AAAMessageBlock* aBuffer = (AAAMessageBlock*)getRawData();
          AAAAvpContainerEntry* e = (AAAAvpContainerEntry*)getAppData();
          PANA_DhcpData_t &dhcp = reinterpret_cast<AAADhcpDataAvpContainerEntry*>
                                                   (e)->dataRef();
          AAAErrorStatus st;
          if (aBuffer->size() - (size_t)aBuffer->wr_ptr() < 
              (dhcp.nonce.size() + sizeof(ACE_UINT32))) {
              st.set(NORMAL, AAA_OUT_OF_SPACE);
              throw st;
          }
          *((ACE_UINT32*)aBuffer->wr_ptr()) = dhcp.id;
          aBuffer->wr_ptr(sizeof(ACE_UINT32));
          aBuffer->copy(dhcp.nonce.data(), dhcp.nonce.size());
      }
};

/*

6.2  PANA Header

   A summary of the PANA header format is shown below.  The fields are
   transmitted in network byte order.


          0                   1                   2                   3
       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
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |    Version    |   Reserved    |        Message Length         |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |            Flags              |         Message Type          |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |                      Sequence Number                          |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |  AVPs ...
      +-+-+-+-+-+-+-+-+-+-+-+-+-


   Version

      This Version field MUST be set to 1 to indicate PANA Version 1.

   Reserved

      This 8-bit field is reserved for future use, and MUST be set to
      zero, and ignored by the receiver.

   Message Length

      The Message Length field is three octets and indicates the length
      of the PANA message including the header fields.

   Flags

      The Flags field is eight bits.  The following bits are assigned:

       0                   1
       0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |R S N r r r r r r r r r r r r r|
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+


      R(equest)

         If set, the message is a request.  If cleared, the message is
         an answer.

      S(eparate)

         When the S-flag is set in a PANA-Start-Request message it
         indicates that PAA is willing to offer separate EAP
         authentications for NAP and ISP.  When the S-flag is set in a
         PANA-Start-Answer message it indicates that PaC accepts on
         performing separate EAP authentications for NAP and ISP.  When
         the S-flag is set in a PANA-Auth-Request/Answer,
         PANA-FirstAuth-End-Request/Answer and PANA-Bind-Request/Answer
         messages it indicates that separate authentications are being
         performed in the authentication phase.

      N(AP authentication)

         When the N-flag is set in a PANA-Auth-Request message, it
         indicates that PAA is performing NAP authentication.  When the
         N-flag is unset in a PANA-Auth-Request message, it indicates
         that PAA is performing ISP authentication.  PaC MUST copy the
         value of the flag in its requests from the last received
         request of the PAA.  The value of the flag on an answer MUST be
         copied from the request.  The N-flag MUST NOT be set when
         S-flag is not set.

      r(eserved)

         these flag bits are reserved for future use, and MUST be set to
         zero, and ignored by the receiver.

   Message Type

      The Message Type field is two octets, and is used in order to
      communicate the message type with the message.  The 16-bit address
      space is managed by IANA [ianaweb].  PANA uses its own address
      space for this field.

   Sequence Number

      The Sequence Number field contains a 32 bit value.

   AVPs

      AVPs are a method of encapsulating information relevant to the
      PANA message.  See section Section 6.3 for more information on
      AVPs.
 */
class PANA_EXPORT PANA_MsgHeader 
{
    public:
       typedef struct {
          ACE_UINT16 request   : 1;  // Request flag
          ACE_UINT16 separate  : 1;  // Separate flag
          ACE_UINT16 nap       : 1;  // Nap flag 
          ACE_UINT16 reserved  : 13;  
       } Flags;

       // Default header length definition 
       typedef enum {
          HeaderLength = 16 // length in octet
       };

    public:
       PANA_MsgHeader();
       virtual ~PANA_MsgHeader() { 
       }
       inline UCHAR &version() { 
           return m_Version; 
       }
       inline ACE_UINT16 &length() { 
           return m_Length; 
       }
       inline PANA_MsgHeader::Flags &flags() { 
           return m_Flags; 
       }
       inline ACE_UINT16 &type() { 
           return m_Type; 
       }
       inline ACE_UINT32 &seq() { 
           return m_SeqNum; 
       }
       inline AAADictionaryHandle *getDictHandle() { 
           return m_DictHandle; 
       }
       inline void setDictHandle(AAADictionaryHandle *handle) { 
           m_DictHandle = handle; 
       }

    protected:
       // flat header members
       UCHAR m_Version;
       ACE_UINT16 m_Length;
       PANA_MsgHeader::Flags m_Flags;
       ACE_UINT16 m_Type;
       ACE_UINT32 m_SeqNum;

       // auxillary
       AAADictionaryHandle* m_DictHandle;
};

// PANA Message Header parser
typedef AAAParser<AAAMessageBlock*,
                  PANA_MsgHeader*,
                  AAADictionaryOption*> PANA_HeaderParser;

// PANA Message definition
class PANA_EXPORT PANA_Message : public PANA_MsgHeader
{
     public:
         PANA_Message() : 
             m_SrcPort(0) {
         }
         virtual ~PANA_Message() {
             m_AvpList.releaseContainers();
         }
         AAAAvpContainerList &avpList() { 
             return m_AvpList; 
         }
         PANA_DeviceIdContainer &srcDevices() { 
             return m_SrcDevices; 
         }
         ACE_UINT32 &srcPort() { 
             return m_SrcPort; 
         }

     protected:
         AAAAvpContainerList m_AvpList;
         PANA_DeviceIdContainer m_SrcDevices;
         ACE_UINT32 m_SrcPort;
};

// AVP codec definition
class PANA_EXPORT PANA_AvpHeaderCodec : public AvpHeaderCodec
{
    public:
      virtual void parseRawToApp();
      virtual void parseAppToRaw();
};

// Alias
typedef PayloadParserWithCodec<PANA_AvpHeaderCodec> PANA_PayloadParser;

#endif /* __PANA_MESSAGE_H__ */