diameter_mip4_fa_client_fsm.hxx

Diameter协议栈

/* BEGIN_COPYRIGHT                                                        */
/*                                                                        */
/* OpenDiameter: Open-source software for the Diameter protocol           */
/*                                                                        */
/* 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                                                          */
/* 
   diameter_mip4_fa_client_fsm.hxx
   Client Statemachine definition for Diameter MIP FA Application 
   Written by Miriam Tauil
   Created January 19, 2005.
*/

#ifndef __MIP4_FA_CLIENT_FSM_H__
#define __MIP4_FA_CLIENT_FSM_H__

#include "framework.h"
#include "diameter_mip4_parser.hxx"
#include "diameter_api.h"


/*!
 * Windows specific export declarations
 */
#ifdef WIN32
   #if defined(DIAMETER_MIP4_FA_CLIENT_EXPORT)
       #define DIAMETER_MIP4_FA_CLIENT_EXPORTS __declspec(dllexport)
   #else
       #define DIAMETER_MIP4_FA_CLIENT_EXPORTS __declspec(dllimport)
   #endif
#else
   #define DIAMETER_MIP4_FA_CLIENT_EXPORTS
   #define DIAMETER_MIP4_FA_CLIENT_EXPORTS
#endif

typedef AAA_JobHandle<AAA_GroupedJob> DiameterJobHandle;


/// State machine for Diameter MIP FA clients.  It has many member
/// functions for enforcement of attributes (i.e., EnforceXYZ) and 
/// for setting attributes (i.e., SetXYX).  Arguments of enforcement
/// functions are not enveloped with AAA_ScholorAttribute or
/// AAA_VectorAttributes since they are intended to be unmodified.
class DIAMETER_MIP4_FA_CLIENT_EXPORTS DiameterMip4FaClientStateMachine 
  : public AAA_StateMachine<DiameterMip4FaClientStateMachine>,
    public AAA_EventQueueJob
{
  friend class DiameterJobMultiplexor;

 public:
  /// Constructor.
  DiameterMip4FaClientStateMachine( AAAClientSession& s,
				    DiameterJobHandle &h); 

  ~DiameterMip4FaClientStateMachine() 
  {
    handle.Job().Remove(this); 
  }
  
  // expose value of protected variable from  DiameterMip4FaClientStateMachine
  
  AAA_State State()
  {
    return AAA_StateMachine<DiameterMip4FaClientStateMachine>::state; 
  }
  
  static AAA_State InitialState()
  {
    return StInitialize;
  }
  
  enum {
    EvRxMipRegReq,
    EvRxAMA,
    EvSgSuccess,
    EvSgFailure,
    EvSgSessionTimeout,
    EvSgAuthLifetimeTimeout,
    EvSgAuthGracePeriodTimeout,
    EvSgTimeout,
    EvSgDisconnect,
    EvSgReset
  };
  
  // This is a copy from diameter_mip4_fa_client_fsm.cxx
  // DiameterMip4FaClientStateTable_S, since I couldn't expose StInitialize
  // to be retuned to the application as a sign for a free session object.
  enum state {
    StInitialize //,
    //StWaitAMA,
    //StCheckResultCode,
    //StAccepted,
    //StRejected,
    //StTerminated
  };

  /// Store an event and notify the session.
  inline void Notify(AAA_Event ev) {
    // Enqueue the event.
    AAA_EventQueueJob::Enqueue(ev);

    // Notify the session.
    handle.Job().Schedule(this);
  }

  //inline DiameterMip4FaClientSession& Session() { return session; }
  inline AAAClientSession& Session() { return session; }

  /// This is used for constructing and sending a
  /// Diameter-AMR-Request.
  void SendAMR();

  inline AAA_JobData& JobData() { return *handle.Job().Data(); }

  template <class T> inline T& JobData(Type2Type<T>) 
  { return (T&)*handle.Job().Data(); }

  // Insert-AVP member functions.

  /// This function is used for setting User-Name AVP contents.
  virtual void
 SetUserName(AAA_ScholarAttribute<diameter_utf8string_t> &userName)=0; 
  

  /// This function is used for setting Destination-Realm AVP
  /// contents.  
  virtual void SetDestinationRealm
  (AAA_ScholarAttribute<diameter_utf8string_t> &destinationRealm)=0; 

  // OriginHost & OriginRealm --> this will be populated from the config file


  virtual void SetMipMnAaaAuth
  (AAA_ScholarAttribute<mip_mn_aaa_auth_info_t> &mipMnAaaAuth)=0; 

  //optional AVPs

  /// This function is used for setting Destination-Host AVP
  /// contents.  
  virtual void SetDestinationHost
  (AAA_ScholarAttribute<diameter_utf8string_t> &destinationHost)=0; 
  

  virtual void SetMipMobileNodeAddress
  (AAA_ScholarAttribute<diameter_address_t> &mipMobileNodeAddress)=0;
  

  virtual void SetMipHomeAgentAddress
  (AAA_ScholarAttribute<diameter_address_t> &mipHomeAgentAddress)=0; 
  
 
  // return 1 if the relevant key/address was requested in MIP reg req
  // return 0 - otherwise
  virtual int IsMnHaKeyRequested() =0;
  virtual int IsMnFaKeyRequested() =0;
  virtual int IsFaHaKeyRequested() =0;
  virtual int IsMnHomeAddrRequested() =0;
  virtual int IsMnHomeAgentRequested() =0;


  // SetMipFeatureVector for FA Client 
  virtual void SetMipFeatureVector 
  (AAA_ScholarAttribute<diameter_unsigned32_t> &mipFeatureVector)
  {
    diameter_unsigned32_t _mipFeatureVector;
    _mipFeatureVector = 0;
    _mipFeatureVector |= FV_HOME_ADDR_ALLOC_ONLY_IN_HOME_REALM;
    _mipFeatureVector |= (IsMnHomeAddrRequested()| FV_MN_HOME_ADDR_REQUESTED);
    _mipFeatureVector |= (IsMnHomeAgentRequested() | FV_MN_HA_REQUESTED);
    _mipFeatureVector |= (IsMnHaKeyRequested() |  FV_MN_HA_KEY_REQUESTED );  
    _mipFeatureVector |= (IsMnFaKeyRequested() |  FV_MN_FA_KEY_REQUESTED );  
    _mipFeatureVector |= (IsFaHaKeyRequested() |  FV_FA_HA_KEY_REQUESTED );  

    mipFeatureVector.Set(_mipFeatureVector);

  }

  //AAA_ScholarAttribute<mip_originating_foreign_aaa_info_t> MipOriginatingForeignAaa;

  
  virtual void
  SetAuthorizationLifetime
  (AAA_ScholarAttribute<diameter_unsigned32_t> &authorizationLifetime)=0;

  // fn not needed - parameter is taken from configuration file
  //  virtual void  SetAuthSessionState
  //(AAA_ScholarAttribute<diameter_enumerated_t> &authSessionState) {  }

  virtual void SetMipHomeAgentHost
  (AAA_ScholarAttribute<mip_home_agent_host_info_t> &mipHomeAgentHost)=0;


  /// This function is used for setting Auth-Request-Type AVP
  /// contents.  
  virtual void SetAuthRequestType
  (AAA_ScholarAttribute<diameter_enumerated_t> &authRequestType)
  {
    authRequestType = AUTH_REQUEST_TYPE_AUTHORIZE_AUTHENTICATE;
  }
 

  virtual int SetMipFaChallenge
  (AAA_ScholarAttribute<diameter_octetstring_t> &mipFaChallenge)=0;
 

  virtual void SetMipCandidateHomeAgentHost
  (AAA_ScholarAttribute<diameter_identity_t> &mipCandidateHomeAgentHost)
  {
  }

  virtual int SetMipHaToFaSpi
  (AAA_ScholarAttribute<diameter_unsigned32_t> &mipHaToFaSpi)=0;

  // Enforcement member functions - FA will act according the values of 
  // these AVPs

  /// This function is used for enforcing Authorization-Lifetime AVP
  /// contents.
  virtual void EnforceAuthorizationLifetime
  (const diameter_unsigned32_t &authorizationLifetime)=0;

  /// This function is used for enforcing Auth-Session-State AVP
  /// contents.
  virtual void EnforceAuthSessionState
  (const diameter_enumerated_t &authSessionState)
  {
  }

  virtual void EnforceReAuthRequestType
  (const diameter_enumerated_t &reAuthReqType)
  {
  }

  virtual void EnforceMipMnToFaMsa 
  (const mip_mn_to_fa_msa_info_t &mipMnToFaMsa)=0;
  
  virtual void EnforceMipMnToHaMsa 
  ( const mip_mn_to_ha_msa_info_t &mipMnToHaMsa)=0;

  virtual void EnforceMipFaToMnMsa 
  ( const mip_fa_to_mn_msa_info_t &mipFaToMnMsa)=0;

  virtual void EnforceMipFaToHaMsa 
  ( const mip_fa_to_ha_msa_info_t &mipFaToHaMsa)=0;

  virtual void EnforceMipHaToMnMsa 
  ( const mip_ha_to_mn_msa_info_t &mipHaToMnMsa)=0;

  virtual void EnforceMipMsaLifetime 
  ( const diameter_unsigned32_t &mipMsaLifetime)=0;

  virtual void EnforceErrorMessage
  ( const diameter_utf8string_t &errorMessage)=0;

   virtual void EnforceMipFilterRule
   (const  AAA_VectorAttribute<diameter_ipfilter_rule_t> &mipFilterRule)=0;
  
  virtual AMR_Data& AMR()=0; //implemented in DiameterMip4FaClientSession class
  virtual AMA_Data& AMA()=0; //implemented in DiameterMip4FaClientSession class

  /// This virtual function is called when a AMA response is received 
  /// As part of the MIP FA application
  /// (not the diameter part), the MIP answer needs to be sent. 
  //implemented in DiameterMip4FaClientSession class
  virtual void SendMipRegReply( diameter_unsigned32_t &amaResultCode)=0;
  virtual void SendMipRegReply( diameter_unsigned32_t &amaResultCode,
				diameter_octetstring_t &mipRegReply)=0;

  //implemented in DiameterMip4FaClientSession class, to reuse the session
  // object. Needs to be called in the state machine.
  virtual AAAReturnCode Reset()=0;  

 protected:
 private:
  /// Inherited from AAA_EventQueueJob.
  int Schedule(AAA_Job *job, size_t=1) { return (-1); }

  /// Inherited from AAA_EventQueueJob.
  inline int Serve()
  {
    if (!AAA_EventQueueJob::ExistBacklog())
      {
	AAA_LOG(LM_ERROR, "%N: no backlog to serve.");
	return 0;
      }

    // Obtain the event to execute.
    AAA_Event ev = 0;
    AAA_EventQueueJob::Dequeue(ev);

    bool existBacklog = AAA_EventQueueJob::ExistBacklog();

    // Execute it.
    Event(ev);
    return existBacklog ? 1 : 0;
  }

  AAAClientSession &session;

  /// Job handle.
  DiameterJobHandle handle;

};

#endif //  __MIP4_FA_CLIENT_FSM_H__