eap_fsm.hxx

/* 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                                                          */
// $Id: eap_fsm.hxx,v 1.37 2004/06/17 21:13:36 yohba Exp $

// eap_fsm.hxx:  header file for EAP finite state machine
// Written by Yoshihiro Ohba

#ifndef __EAP_FSM_HXX__
#define __EAP_FSM_HXX__

#include <ace/Basic_Types.h>
#include <ace/Singleton.h>
#include <ace/Synch.h>
#include <ace/Event_Handler.h>
#include <list>
#include <utility>
#include "framework.h"
#include "eap.hxx"
#include "eap_log.hxx"
#include "eap_policy.hxx"

typedef AAA_JobHandle< AAA_GroupedJob > EapJobHandle;

class EapJobMultiplexor : public AAA_JobQueueJob
{
 public:
  EapJobMultiplexor(EapJobHandle& h) : handle(h)
  {}
  ~EapJobMultiplexor() { handle.Job().Remove(this); }

  void Flush()
  {
    AAA_JobQueueJob::Flush();
    handle.Job().Remove(this);
  }

  int Serve() 
  {
    if (!ExistBacklog())
      {
        EAP_LOG(LM_ERROR, "%N: no backlog to serve.");
        return 0;
      }

    AAA_Job *job;
    Dequeue(job);
    bool existBacklog = ExistBacklog();
    job->Serve();
    return existBacklog;
  }

  // Reimplementedf from AAA_JobQueueJob
  int Schedule(AAA_Job* job, size_t=1)
  {
    Enqueue(job);
    return handle.Job().Schedule(this);
  }

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

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

 private:

  EapJobHandle handle;
};

template <class ARG>
class EapStateMachine : 
  public AAA_StateMachineWithTimer<ARG>, 
  private AAA_EventQueueJob
{
 public:
  EapStateMachine(ARG& arg, AAA_StateTable<ARG> &table, ACE_Reactor &r, 
                  EapJobMultiplexor &mux, char *name=0)
    : AAA_StateMachineWithTimer<ARG>(arg, table, r, name),
      mux(mux)
  {}
  
  void Stop()
  {
    AAA_StateMachineWithTimer<ARG>::Stop();
    mux.Flush();
  }

  inline int Serve()
  {
    // Obtain the event to execute.
    AAA_Event ev;
    AAA_EventQueueJob::Dequeue(ev);

    bool existBacklog = AAA_EventQueueJob::ExistBacklog();

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

  inline void Timeout(AAA_Event ev) { Notify(ev); }

  // Store an event and notify the session.  An integer -1 is thrown
  // when job scheduling fails.
  inline void Notify(AAA_Event ev) throw (int) {
    // Enqueue the event.
    if (AAA_EventQueueJob::Enqueue(ev) <= 0)
      throw -1;

    // Schedule me to the mux.
    if (mux.Schedule(this) < 0)
      throw -1;
  }

 private:

  int Schedule(AAA_Job*, size_t=1) { return (-1); }  // Not used.

  EapJobMultiplexor& mux;
};

typedef ACE_Message_Queue<ACE_MT_SYNCH> EapMessageQueue;

class EapMethodStateMachine;


class EAP_EXPORTS EapSwitchStateMachine : public EapJobMultiplexor
{
public:

  virtual void Notify(AAA_Event ev)=0;

  virtual void Send(AAAMessageBlock *b)=0;

  virtual void Abort()=0;

  inline EapType& CurrentMethod() { return currentMethod; }

  virtual void Receive(AAAMessageBlock*)=0;

  virtual void ReceiveFromAAA(AAAMessageBlock *msg) throw(int)
  {
    EAP_LOG(LM_ERROR, "ReceiveFromAAA Operation not allowed.");
    throw -1;
  }

  inline ACE_Byte& CurrentIdentifier() { return currentIdentifier; }


  inline AAAMessageBlock* GetRxMessage() {return rxMessage; }

  inline void SetRxMessage(AAAMessageBlock *p) { 
    if (rxMessage) rxMessage->release();
    rxMessage=p; 
  }

  inline void DeleteRxMessage() { SetRxMessage(0); }

  inline AAAMessageBlock* GetTxMessage() { return txMessage; }

  inline void SetTxMessage(AAAMessageBlock *p) { 
    if (txMessage) txMessage->release(); 
    txMessage=p; 
  }

  inline void DeleteTxMessage() { SetTxMessage(0); }

  inline std::string& PeerIdentity() { return peerIdentity; } 

  inline std::string& AuthenticatorIdentity() 
  { return authenticatorIdentity; } 

  inline bool& KeyAvailable() { return keyAvailable; }
  
  inline std::string& KeyData() { return keyData; } 
  
  bool IsEapTunneled() { return eapTunneled; }

  inline EapPolicy& Policy(void) { return policy; } 

  void CreateMethodStateMachine(EapType t, EapRole role);

  void DeleteMethodStateMachine();

  inline EapMethodStateMachine& MethodStateMachine() 
  { return *methodStateMachine; }

  EapMessageQueue& RxQueue() { return rxQueue; }

  int& DiscardCount() { return discardCount; }

  ACE_Reactor& Reactor() { return reactor; }

protected:
  EapSwitchStateMachine(ACE_Reactor &r, EapJobHandle &h) : 
    EapJobMultiplexor(h),
    currentMethod(EapType(0)),
    txMessage(0), rxMessage(0), eapTunneled(false), 
    methodStateMachine(0), discardCount(0), keyAvailable(false),
    reactor(r)
  {
    keyData.resize(0);
  }

  virtual ~EapSwitchStateMachine() 
  {
    DeleteMethodStateMachine();
    DeleteRxMessage();
    DeleteTxMessage();
  }

  EapType currentMethod;

  AAAMessageBlock *txMessage;

  AAAMessageBlock *rxMessage;

  EapMessageQueue rxQueue;

  ACE_Byte currentIdentifier;

  std::string peerIdentity;

  std::string authenticatorIdentity;

  bool eapTunneled;

  EapPolicy policy;

  EapMethodStateMachine* methodStateMachine;

  int discardCount;

  bool keyAvailable;

  std::string keyData;

  ACE_Reactor &reactor;
};

class EapPeerSwitchStateMachine;
class EapAuthSwitchStateMachine;


class EAP_EXPORTS EapMethodStateMachine
{
public:

  virtual ~EapMethodStateMachine() {}

  virtual void Start() throw(AAA_Error)=0;

  virtual void Notify(AAA_Event)=0;

  inline bool KeyAvailable() { return (keyData.size()>0); }
  
  inline std::string& KeyData() { return keyData; } 
  
  inline AAA_JobData& JobData() { return switchStateMachine.JobData(); }

  template <class T> inline T& JobData(Type2Type<T>) 
  { return switchStateMachine.JobData(t); }

  bool& IsDone() { return isDone; }

  inline EapSwitchStateMachine& SwitchStateMachine() 
  { return switchStateMachine; }

  virtual ACE_Byte GetNextIdentifier(ACE_Byte id) { return id + 1; }

  enum event {
    EvSgIntegrityCheck=-1, // Integrity check
  };

  inline EapPeerSwitchStateMachine& PeerSwitchStateMachine() 
  { 
    return (EapPeerSwitchStateMachine&)switchStateMachine;
  }

  inline EapAuthSwitchStateMachine& AuthSwitchStateMachine() 
  { 
    return (EapAuthSwitchStateMachine&)switchStateMachine;
  }

  template <class T> 
  inline T& SwitchStateMachine(Type2Type<T>) 
  { return (T&)switchStateMachine; }

protected:
  EapMethodStateMachine(EapSwitchStateMachine &s)
    : switchStateMachine(s), isDone(false)
  {
    keyData.resize(0);
  }


  EapSwitchStateMachine& switchStateMachine;
  
  bool isDone;

  std::string keyData;

 private:
};

#endif // __EAP_FSM_HXX__

---