IntrusionPrevention.idl

Go to the documentation of this file.

/**
 * @file     IntrusionPrevention.idl
 * @brief    API for Intrusion Prevention
 * @version  2
 */

#import <kerio/web/idl/SharedStructures.idl>
#import <common.idl>

module webadmin {

const long UpdateTimeNever = 0;

enum IntrusionPreventionAction {
   IntrusionPreventionActionDropAndLog, 
   IntrusionPreventionActionLog,
   IntrusionPreventionActionNothing
};

struct BlackList {
   kerio::web::KId id;
   string name;
   string url;
   IntrusionPreventionAction action;
};

struct RuleReference {
   string id;  // gid:sid format ("1:123456") - this is intentionally string, not kerio::web::KId
   string description;
};

enum IntrusionPreventionUpdatePhases {
   IntrusionPreventionUpdateOk,
   IntrusionPreventionUpdateError,
   IntrusionPreventionUpdateProgress
};

struct IntrusionPreventionInfo {
   TimeSpan lastUpdateCheck;     /**< how long is since last rules update check */
   string databaseVersion; 
   IntrusionPreventionUpdatePhases phase;
   string errorMessage;
};

typedef sequence<BlackList> BlackListList;
typedef sequence<RuleReference> RuleReferenceList;

struct IntrusionPreventionConfig {

   boolean enabled;

   IntrusionPreventionAction high;
   IntrusionPreventionAction medium;
   IntrusionPreventionAction low;

   kerio::web::OptionalLong updateCheckInterval;
   
   BlackListList blackLists;
   kerio::web::NamedValueList ports;
};
 
interface IntrusionPrevention {

   /**
    * Returns configuration
    *
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void get(out IntrusionPreventionConfig config);

   /**
    * Stores configuration
    *
    * @param  errors - list of errors \n
    *          8002  Database error.   - "Unable to modify blacklist '%1'." \n
    *          8002  Database error.   - "Unable to modify ports for service '%1'." 
    * @param config - complete configuration of Intrusion Prevention system
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void set(out kerio::web::ErrorList errors, in IntrusionPreventionConfig config);

   /**
    * Returns signature description
    *
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void getSignatureDescription(out string description, in string id);

   /**
    * Returns list of ignored signatures
    *
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void getIgnoredRules(out RuleReferenceList ignored);

   /**
    * Sets list of ignored signatures
    *
    * @param  errors - list of errors \n
    *          8002  Database error.   - "Unable to create exclusion for rule '%1'." \n
    *          8002  Database error.   - "Unable to remove exclusion for rule '%1'."   
    * @param ignored - List of rules that are excluded from usage in IPS
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void setIgnoredRules(out kerio::web::ErrorList errors, in RuleReferenceList ignored);

   /**
    * Checks new version of database and updates it
    *
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void update(in boolean force);

   /**
    * Returns actual state of Update
    *
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void getUpdateStatus(out IntrusionPreventionInfo status);
};

}; //webadmin