sspPlugin.idl

Go to the documentation of this file.

#include "sae.idl"

#pragma prefix ""

module sspPlugin {

  enum PluginEventType {
    PE_AUTH_USER,             
    PE_AUTH_SERVICE,          
    PE_AUTH_SUBSCRIPTION,     

    PE_START_USER,            
    PE_STOP_USER,             
    PE_INTERIM_USER,          
    
    PE_START_SERVICE,         
    PE_INTERIM_SERVICE,       
    PE_STOP_SERVICE,          

    // @since 4.2
    PE_START_INTERFACE,       
    PE_INTERIM_INTERFACE,     
    PE_STOP_INTERFACE,        

    // @since 4.3
    PE_AUTH_DHCP,             

    PE_no_event
  };

  enum PluginAttribute {
    PA_SSP_HOST,
    PA_ROUTER_NAME,

    PA_INTERFACE_NAME,

    PA_INTERFACE_ALIAS,

    PA_INTERFACE_DESCR,

    PA_PORT_ID,

    PA_USER_IP_ADDRESS,

    PA_LOGIN_NAME, 

    PA_ACCOUNTING_ID,                   

    PA_AUTH_USER_ID,
    
    PA_IF_RADIUS_CLASS,

    PA_IF_SESSION_ID,

    PA_SERVICE_BUNDLE,
    
    PA_USER_DN,

    PA_UID,

    PA_DOMAIN,

    PA_RETAILER_DN,

    PA_PASSWORD,

    PA_SERVICE_NAME,

    PA_SERVICE_SCOPE,

    PA_RADIUS_CLASS,

    PA_EVENT_TIME,

    PA_SESSION_ID,

    PA_TERMINATE_CAUSE,

    PA_SESSION_TIME,

    PA_IN_OCTETS,

    PA_OUT_OCTETS,

    PA_IN_PACKETS,

    PA_OUT_PACKETS,

    PA_SESSION_TIMEOUT,

    PA_NAS_IP,

    PA_USER_MAC_ADDRESS,

    PA_DOWNSTREAM_BANDWIDTH,

    PA_UPSTREAM_BANDWIDTH,

    PA_REPLY_MESSAGE,

    PA_SERVICE_SESSION_NAME, 

    PA_SERVICE_SESSION_TAG,

    PA_DHCP_PACKET,

    PA_USER_TYPE,

    PA_USER_RADIUS_CLASS,

    PA_USER_SESSION_ID,

    PA_PRIMARY_USER_NAME,

    PA_SESSION_VOLUME_QUOTA,

    PA_SUBSCRIPTION_NAME,

    PA_LOAD_SERVICES,

    PA_LOGIN_ID,
    
    PA_POOL_NAME,

    PA_AUTH_VIRTUAL_ROUTER_NAME,

    PA_IF_INDEX,

    PA_EVENT_TIME_MILLISECOND,

    // @since 5.0
    PA_NAS_PORT,

    PA_OPERATIONAL,

    PA_IDLE_TIMEOUT,

    PA_USER_INET_ADDRESS,

    PA_NAS_INET_ADDRESS,

    PA_AGGR_SESSION_ID,

    PA_AGGR_LOGIN_NAME,

    PA_AGGR_USER_DN,

    PA_AGGR_USER_INET_ADDRESS, 

    PA_AGGR_ACCOUNTING_ID,

    PA_AGGR_AUTH_USER_ID,
    
    // @since Mars
    PA_PROPERTY,

    
    PA_ACCT_INTERIM_TIME, 

    
   PA_SUBSTITUTION,                    

    PA_TERMINATE_TIME, 

    PA_ROUTER_TYPE,

    PA_PCMM_REQUEST_TYPE,
    
    PA_PCMM_AM_ID,
    
    PA_PCMM_BC_ID,

    PA_INTERFACE_SPEED,

    PA_ACCESS_MODE,
    
    PA_ACCESS_UPSTREAM_RATE,
    
    PA_ACCESS_DOWNSTREAM_RATE,
   
        PA_MIN_UPSTREAM_RATE,

        PA_MIN_DOWNSTREAM_RATE,

        PA_ATTAINABLE_UPSTREAM_RATE,

        PA_ATTAINABLE_DOWNSTREAM_RATE,

        PA_MAXIMUM_UPSTREAM_RATE,

        PA_MAXIMUM_DOWNSTREAM_RATE,

        PA_MINIMUM_LOW_POWER_UPSTREAM_RATE,

        PA_MINIMUM_LOW_POWER_DOWNSTREAM_RATE,

        PA_MAXIMUM_INTERLEAVING_UPSTREAM_DELAY,

        PA_ACTUAL_INTERLEAVING_UPSTREAM_DELAY,

        PA_MAXIMUM_INTERLEAVING_DOWNSTREAM_DELAY,

        PA_ACTUAL_INTERLEAVING_DOWNSTREAM_DELAY,

        PA_DSL_LINE_STAT,
   
    // @since SRC 3.1
    // unique user session handle
    PA_USER_SESSION_HANDLE,

    PA_TUNNEL_ID,

    PA_TUNNEL_SESSION_ID,

    PA_LAC_IP,

    PA_CALLING_STATION_ID,

    PA_USER_PROPERTY,

    PA_VPN_ID,
    
    // @since Bitter
    PA_LOCAL_QOS_PROFILE,
         PA_IDLE_TIMEOUT_INPUT,

    PA_IDLE_TIMEOUT_OUTPUT,

    PA_last                             // dummy: end-of-list
  };

  enum PluginAttributeType {
    PAT_LONG,      
    PAT_LONG_LONG, 
    PAT_STRING,    
    PAT_OPAQUE     
  };
  
  union AttributeUnion switch (PluginAttributeType) {
    case PAT_LONG:
      long longVal;               
    case PAT_LONG_LONG:
      long long longLongVal;      
    case PAT_STRING:
      string stringVal;           
    case PAT_OPAQUE:
      sequence<octet> opaqueVal;  
  };
  struct NameValue {
    PluginAttribute name;             
    AttributeUnion  value;            
  };
  typedef sequence<NameValue> NameValueList;

  struct SubscriptionInfo {
    long sessionTimeout;                

    long interimTime;                   

  };

  struct DirectoryAccessInfo {
    sequence<string> ldapHost;        
    string baseDN;                    
  };

  interface PluginContext {
    DirectoryAccessInfo getServiceDirectory();
    DirectoryAccessInfo getUserDirectory();   
    sae::ServiceActivationEngine getSAE();     
  };

  interface PluginInterface {
    exception MethodNotImplemented {};

    exception AuthorizationDenied {
      string message; 

    };
#ifndef NO_WSTRING

    exception AuthorizationDeniedW {
      wstring message; 

    };
#endif

    exception OutOfSync {};

    NameValueList authorize(in PluginEventType pet,
                            in PluginContext ctx,
                            in NameValueList attr)
      raises (MethodNotImplemented, 
#ifndef NO_WSTRING
              AuthorizationDeniedW,
#endif
              AuthorizationDenied,
              OutOfSync
              );

    void track (in PluginEventType pet,
                in PluginContext ctx,
                in NameValueList nvl,
                inout SubscriptionInfo subscription)
      raises (MethodNotImplemented,
              OutOfSync);
  };

  interface SyncPluginInterface: PluginInterface {
    void restart(in string pepId);

    void restartComplete(in string pepId, in boolean isPepReset)
      raises (OutOfSync);

    void stop(in string pepId);
  };

  interface StateSyncPlugin: SyncPluginInterface {

    typedef sequence<string> StringSeq;
    
    long readyToSync(in StringSeq pepIds,
                     in boolean queueValid);

    struct PluginEvent {
      PluginEventType pet;      
      NameValueList nvl;        
    };

    typedef sequence<PluginEvent> PluginEventSeq;

    void trackBulk(in PluginEventSeq events)
      raises (OutOfSync);

    void syncComplete(in StringSeq pepIds);

    void ping(in StringSeq pepIds) raises(OutOfSync);

  };
  
};

---