mirror of
https://github.com/plappermaul/realtek-doc.git
synced 2025-12-10 07:44:41 +01:00
212 lines
5 KiB
C
212 lines
5 KiB
C
/*
|
|
* Copyright (C) 2012 Realtek Semiconductor Corp.
|
|
* All Rights Reserved.
|
|
*
|
|
* This program is the proprietary software of Realtek Semiconductor
|
|
* Corporation and/or its licensors, and only be used, duplicated,
|
|
* modified or distributed under the authorized license from Realtek.
|
|
*
|
|
* ANY USE OF THE SOFTWARE OTHER THAN AS AUTHORIZED UNDER
|
|
* THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.
|
|
*
|
|
* $Revision$
|
|
* $Date$
|
|
*
|
|
* Purpose : Definition of Security API
|
|
*
|
|
* Feature : The file includes the following modules and sub-modules
|
|
* (1) attack prevention
|
|
*/
|
|
|
|
#ifndef __DAL_APOLLOMP_SEC_H__
|
|
#define __DAL_APOLLOMP_SEC_H__
|
|
|
|
/*
|
|
* Include Files
|
|
*/
|
|
#include <common/rt_type.h>
|
|
#include <common/rt_error.h>
|
|
/*
|
|
* Symbol Definition
|
|
*/
|
|
|
|
/*
|
|
* Data Declaration
|
|
*/
|
|
|
|
typedef enum apollomp_raw_dosAction_e
|
|
{
|
|
DAL_APOLLOMP_DOS_ACT_DROP = 0,
|
|
DAL_APOLLOMP_DOS_ACT_TRAP,
|
|
|
|
} apollomp_raw_dosAction_t;
|
|
|
|
/*
|
|
* Function Declaration
|
|
*/
|
|
|
|
/* Module Name : Security */
|
|
|
|
/* Function Name:
|
|
* dal_apollomp_sec_init
|
|
* Description:
|
|
* Initialize security module.
|
|
* Input:
|
|
* None
|
|
* Output:
|
|
* None
|
|
* Return:
|
|
* RT_ERR_OK
|
|
* RT_ERR_FAILED
|
|
* Note:
|
|
* Must initialize security module before calling any sec APIs.
|
|
*/
|
|
extern int32
|
|
dal_apollomp_sec_init(void);
|
|
|
|
/* Module Name : Security */
|
|
/* Sub-module Name: Attack prevention */
|
|
|
|
|
|
/* Function Name:
|
|
* dal_apollomp_sec_portAttackPreventState_get
|
|
* Description:
|
|
* Per port get attack prevention confi state
|
|
* Input:
|
|
* port - port id
|
|
* Output:
|
|
* pEnable - status attack prevention
|
|
* Return:
|
|
* RT_ERR_OK
|
|
* RT_ERR_FAILED
|
|
* RT_ERR_PORT_ID - Invalid port id
|
|
* RT_ERR_NULL_POINTER - NULL pointer
|
|
* Note:
|
|
* The status attack prevention:
|
|
* - DISABLED
|
|
* - ENABLED
|
|
*/
|
|
extern int32
|
|
dal_apollomp_sec_portAttackPreventState_get(rtk_port_t port, rtk_enable_t *pEnable);
|
|
|
|
/* Function Name:
|
|
* dal_apollomp_sec_portAttackPreventState_set
|
|
* Description:
|
|
* Per port set attack prevention confi state
|
|
* Input:
|
|
* port - port id.
|
|
* enable - status attack prevention
|
|
* Output:
|
|
* None.
|
|
* Return:
|
|
* RT_ERR_OK
|
|
* RT_ERR_FAILED
|
|
* RT_ERR_PORT_ID - Invalid port id
|
|
* Note:
|
|
* The status attack prevention:
|
|
* - DISABLED
|
|
* - ENABLED
|
|
*/
|
|
extern int32
|
|
dal_apollomp_sec_portAttackPreventState_set(rtk_port_t port, rtk_enable_t enable);
|
|
|
|
|
|
|
|
/* Function Name:
|
|
* dal_apollomp_sec_attackPrevent_get
|
|
* Description:
|
|
* Get action for each kind of attack on specified port.
|
|
* Input:
|
|
* attackType - type of attack
|
|
* Output:
|
|
* pAction - pointer to action for attack
|
|
* Return:
|
|
* RT_ERR_OK
|
|
* RT_ERR_FAILED
|
|
* RT_ERR_NOT_INIT - The module is not initial
|
|
* RT_ERR_INPUT - invalid input parameter
|
|
* RT_ERR_NULL_POINTER - input parameter may be null pointer
|
|
* Note:
|
|
* Action is as following:
|
|
* - ACTION_TRAP2CPU
|
|
* - ACTION_DROP
|
|
* - ACTION_FORWARD
|
|
*/
|
|
extern int32
|
|
dal_apollomp_sec_attackPrevent_get(
|
|
rtk_sec_attackType_t attackType,
|
|
rtk_action_t *pAction);
|
|
|
|
/* Function Name:
|
|
* dal_apollomp_sec_attackPrevent_set
|
|
* Description:
|
|
* Set action for each kind of attack.
|
|
* Input:
|
|
* attack_type - type of attack
|
|
* action - action for attack
|
|
* Output:
|
|
* None
|
|
* Return:
|
|
* RT_ERR_OK
|
|
* RT_ERR_FAILED
|
|
* RT_ERR_NOT_INIT - The module is not initial
|
|
* RT_ERR_FWD_ACTION - invalid forwarding action
|
|
* RT_ERR_INPUT - invalid input parameter
|
|
* Note:
|
|
* Action is as following:
|
|
* - ACTION_TRAP2CPU
|
|
* - ACTION_DROP
|
|
* - ACTION_FORWARD
|
|
*/
|
|
extern int32
|
|
dal_apollomp_sec_attackPrevent_set(
|
|
rtk_sec_attackType_t attackType,
|
|
rtk_action_t action);
|
|
|
|
|
|
/* Function Name:
|
|
* dal_apollomp_sec_attackFloodThresh_get
|
|
* Description:
|
|
* Get flood threshold, time unit 1ms.
|
|
* Input:
|
|
* None
|
|
* Output:
|
|
* pFloodThresh - pointer to flood threshold
|
|
* Return:
|
|
* RT_ERR_OK
|
|
* RT_ERR_FAILED
|
|
* RT_ERR_NOT_INIT - The module is not initial
|
|
* RT_ERR_NULL_POINTER - input parameter may be null pointer
|
|
* Note:
|
|
* Flood type is as following:
|
|
* - SEC_ICMPFLOOD
|
|
* - SEC_SYNCFLOOD
|
|
* - SEC_FINFLOOD
|
|
*/
|
|
extern int32
|
|
dal_apollomp_sec_attackFloodThresh_get(rtk_sec_attackFloodType_t type, uint32 *pFloodThresh);
|
|
|
|
/* Function Name:
|
|
* dal_apollomp_sec_attackFloodThresh_set
|
|
* Description:
|
|
* Set flood threshold, time unit 1ms.
|
|
* Input:
|
|
* floodThresh - flood threshold
|
|
* Output:
|
|
* None
|
|
* Return:
|
|
* RT_ERR_OK
|
|
* RT_ERR_FAILED
|
|
* RT_ERR_NOT_INIT - The module is not initial
|
|
* RT_ERR_NULL_POINTER - input parameter may be null pointer
|
|
* Note:
|
|
* Flood type is as following:
|
|
* - SEC_ICMPFLOOD
|
|
* - SEC_SYNCFLOOD
|
|
* - SEC_FINFLOOD
|
|
*/
|
|
extern int32
|
|
dal_apollomp_sec_attackFloodThresh_set(rtk_sec_attackFloodType_t type, uint32 floodThresh);
|
|
|
|
#endif /* __DAL_APOLLOMP_SEC_H__ */
|
|
|