/* 02comp_ipnet_macsec.cdf - IPNet MACsec configuration file */

/*
 * Copyright (c) 2010 Wind River Systems, Inc.
 *
 * The right to copy, distribute or otherwise make use of this software
 * may be licensed only pursuant to the terms of an applicable Wind River
 * license agreement. No license to Wind River intellectual property rights
 * is granted herein. All rights not licensed by Wind River are reserved
 * by Wind River.
 */

/*
modification history
--------------------
01a,09feb10,mry  created.
*/

#ifdef _WRS_CONFIG_COMPONENT_IPMACSEC
Folder FOLDER_IPMACSEC {
    NAME        MAC Security (MACsec) Components
    SYNOPSIS    MACsec folder.
    _CHILDREN	FOLDER_NET_L2_LINK
}

/*---------------------------------------------------------------------------*/
Component INCLUDE_IPMACSEC {
	NAME            MAC Security (MACsec) support
    SYNOPSIS        Include MAC Security (MACsec) support.
    CONFIGLETTES    ipmacsec_config.c
    MODULES         ipmacsec.o
    LINK_SYMS       ipmacsec_secy_init
    REQUIRES        INCLUDE_IPNET \
					INCLUDE_IPCOM_USE_ETHERNET \
					INCLUDE_IPCRYPTO \
					INCLUDE_IPNET_USE_NETLINKSOCK
    _CHILDREN       FOLDER_IPMACSEC
    CFG_PARAMS		IPMACSEC_SECY_ENABLE \
					IPMACSEC_SECY_INTERFACES \
					IPMACSEC_SECY_PROTECTFRAMES \
					IPMACSEC_SECY_ALWAYSINCSCI \
					IPMACSEC_SECY_USE_ES \
					IPMACSEC_SECY_USE_SCB \
					IPMACSEC_SECY_CONFIDENTIALITY \
					IPMACSEC_SECY_CONFIDENTIALITY_OFFSET \
					IPMACSEC_SECY_VALIDATEFRAMES \
					IPMACSEC_SECY_REPLAYPROTECT \
					IPMACSEC_SECY_REPLAYWINDOW \
					IPMACSEC_GCMAES_ACCEL_LEVEL \
					IPMACSEC_LOG_LEVEL
}

Parameter IPMACSEC_SECY_ENABLE {
    NAME        Enable MAC Security Entity (SecY)
    SYNOPSIS    Enable(1)/Disable(0) MACsec functionality on specified interfaces.
    TYPE        char *
    DEFAULT     "0"
}

Parameter IPMACSEC_SECY_INTERFACES {
    NAME        SecY Interface(s)
    SYNOPSIS    Specifies the interface(s) on which SecY will \
				be enabled (if IPMACSEC_ENABLE != 0). \
				Use "all" to enable MACsec on all Ethernet interfaces, \
				or specify a comma seperated list of interfaces. \
				e.g.: "fei1,eth1,eth2"
    TYPE        char *
    DEFAULT     ""
}

Parameter IPMACSEC_SECY_PROTECTFRAMES {
    NAME        SecY "protectFrames"
    SYNOPSIS    Specifies the default value for the SecY "protectFrames" control \
				Valid values: "0" for False, "1" for True.
    TYPE        char *
    DEFAULT     "1"
}
Parameter IPMACSEC_SECY_ALWAYSINCSCI {
    NAME        SecY "alwayIncludeSCI"
    SYNOPSIS    Specifies the default value for the SecY "alwayIncludeSCI" control \
				Valid values: "0" for False, "1" for True.
    TYPE        char *
    DEFAULT     "0"
}

Parameter IPMACSEC_SECY_USE_ES {
    NAME        SecY "useES"
    SYNOPSIS    Specifies the default value for the SecY "useES" control \
				Valid values: "0" for False, "1" for True.
    TYPE        char *
    DEFAULT     "0"
}

Parameter IPMACSEC_SECY_USE_SCB { 
    NAME        SecY "useSCB"
    SYNOPSIS    Specifies the default value for the SecY "useSCB" control \
				Valid values: "0" for False, "1" for True.
    TYPE        char *
    DEFAULT     "0"
}

Parameter IPMACSEC_SECY_VALIDATEFRAMES {
    NAME        SecY "validateFrames"
    SYNOPSIS    Specifies the default value for the SecY "validateFrames" control \
				Valid values: "Disabled", "Check", "Strict".
    TYPE        char *
    DEFAULT     "Strict"
}

Parameter IPMACSEC_SECY_REPLAYPROTECT {
    NAME        SecY "replayProtect"
    SYNOPSIS    Specifies the default value for the SecY "replayProtect" control \
				Valid values: "0" for False, "1" for True.
    TYPE        char *
    DEFAULT     "1"
}

Parameter IPMACSEC_SECY_REPLAYWINDOW {
    NAME        SecY "replayWindow"
    SYNOPSIS    Specifies the default value for the SecY "replayWindow" control\
				Valid values: A string contaning an integer value \
				between 0 and 2^32-1 (inclusive). 
    TYPE        char *
    DEFAULT     "0"
}

Parameter IPMACSEC_SECY_CONFIDENTIALITY {
    NAME        SecY Confidentiality setting
    SYNOPSIS    Specifies the default value for the Confidentiality setting \
				of newly created Tx SAs. This default can be overriden at \
				SA ceation time. \
				Valid values: "0" means only integrity is used on Tx SA, \
				              "1" means both integrity and confidentiality are used.
    TYPE        char *
    DEFAULT     "0"
}

Parameter IPMACSEC_SECY_CONFIDENTIALITY_OFFSET {
    NAME        SecY Confidentiality Offset value
    SYNOPSIS    Specifies the default value of the Confidentiality Offset \
				for the selected cipher suite (if supported by the cipher suite). \
				It indicates the number of initial octets of each MSDU without \
				confidentiality protection. The confidentialityOffset applies to all \
				frames transmitted and received with confidentiality protection. \
				Valid values: "0", "30" or "50".
    TYPE        char *
    DEFAULT     "0"
}

Parameter IPMACSEC_LOG_LEVEL {
    NAME        IPMACSEC Syslog Level
    SYNOPSIS    Syslog Level for the IPMACSEC module. \
                One of: IPCOM_LOG_EMERG, IPCOM_LOG_CRIT, IPCOM_LOG_ERR, \
                IPCOM_LOG_WARNING, IPCOM_LOG_NOTICE, IPCOM_LOG_INFO, \
                IPCOM_LOG_DEBUG, IPCOM_LOG_DEBUG2
    TYPE        int
    DEFAULT     IPCOM_LOG_INFO
}

Parameter IPMACSEC_GCMAES_ACCEL_LEVEL {
    NAME        IPMACSEC GCM-AES Acceleration Level
    SYNOPSIS    Acceleration Level for the GCM-AES cipher used by IPMACSEC. \
                This specifies the tradeoff between space and performance \
                (refer to "openssl/aes_gcm.h" for more details). \
                Valid values: "0" (off) , "1" (level 1) , "2" (level 2), \
                "3" (level 3), "4" (level 4).
    TYPE        char *
    DEFAULT     "4"
}

/*---------------------------------------------------------------------------*/
Component INCLUDE_IPMACSEC_CMD {
	NAME 		MACsec IPCOM Commands Component
	SYNOPSIS 	Include this component to get access to "macsec" commands \
				from the ipcom command shell.
	MODULES     ipmacsec_cmd.o
	REQUIRES 	INCLUDE_IPCOM_SHELL_CMD
    _CHILDREN   FOLDER_IPMACSEC
}

#endif