/* 02comp_ipnet_diameter.cdf - IPNet Diameter Components configuration file */

/*
 * Copyright (c) 2007 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
--------------------
01p,16noc10,tlu  Set the default value of DIAMETER_TLS_ROOT_DIR to ""
01o,16jul10,hfc	 secureKeyDB support for diameter
01n,08dec08,tlu  Add component for Diameter EAP
01m,28nov07,tlu  Fix typos
01l,12nov07,tlu  Rename proxy agent shell command file name
01k,08nov07,tlu  Add component for Diameter proxy agent
01j,19jul07,cwu  Add component for Diameter proxy agent shell command
01i,24sep07,tlu  Modify component names
01h,07sep07,tlu  Modify configuration parameter names for visual improvement
01g,17aug07,tlu  Update after code inspection
01f,09jul07,tlu  Add TLS configuration parameters
01e,10jul07,tlu  Add local node TCP listening port as a configuration parameter
01d,04jul07,tlu  Add supported application IDs as a configuration parameter
01c,28jun07,tlu  Add local host IP address as configuration parameters
01b,06jun07,tlu  Update after code inspection
01a,04apr07,tlu  Created.
*/
#if defined(_WRS_CONFIG_COMPONENT_IPDIAMETERC) ||  defined(_WRS_CONFIG_COMPONENT_IPDIAMETERP)
Component INCLUDE_IPDIAMETERC {
    NAME            Diameter Client
    SYNOPSIS        Diameter client component
    MODULES         ipdiameter_client.o 
    CONFIGLETTES    ipdiameterc_config.c
    CFG_PARAMS      DIAMETER_IDENTIFIER \
		    DIAMETER_HOST_REALM \
		    DIAMETER_HOST_DOMAIN \
		    DIAMETER_HOST_IPV4_ADDRESS \
		    DIAMETER_HOST_IPV6_ADDRESS \
		    DIAMETER_HOST_TCP_PORT \
		    DIAMETER_APPLICATION_LIST \
		    DIAMETER_VENDOR_ID \
		    DIAMETER_ASR_COMPLY \
		    DIAMETER_SESSION_TIMEOUT \
		    DIAMETER_AUTH_LIFETIME \
		    DIAMETER_AUTH_GRACE_PERIOD \
		    DIAMETER_PEER_RECONN_INTERVAL \
		    DIAMETER_PEER_MAX_RECONN_ATTEMPT \
		    DIAMETER_WATCHDOG_TIMEOUT \
		    DIAMETER_REQ_RETX_INTERVAL \
		    DIAMETER_REQ_MAX_RETX 
    REQUIRES        INCLUDE_IPDIAMETER_TLS_CFG
}



Component INCLUDE_IPDIAMETERP {
    NAME            Diameter Proxy Agent
    SYNOPSIS        Diameter proxy agent component
    MODULES         ipdiameter_pagent.o 
    CONFIGLETTES    ipdiameterp_config.c
    CFG_PARAMS      DIAMETER_IDENTIFIER \
                    DIAMETER_HOST_REALM \
                    DIAMETER_HOST_DOMAIN \
                    DIAMETER_HOST_IPV4_ADDRESS \
                    DIAMETER_HOST_IPV6_ADDRESS \
                    DIAMETER_HOST_TCP_PORT \
		    DIAMETER_APPLICATION_LIST \
                    DIAMETER_VENDOR_ID \
                    DIAMETER_PEER_RECONN_INTERVAL \
                    DIAMETER_PEER_MAX_RECONN_ATTEMPT \
                    DIAMETER_WATCHDOG_TIMEOUT \
                    DIAMETER_REQ_RETX_INTERVAL \
                    DIAMETER_REQ_MAX_RETX 
    REQUIRES        INCLUDE_IPDIAMETER_TLS_CFG
}



Component INCLUDE_IPDIAMETERC_CMD {
    NAME        Diameter Client Commands
    SYNOPSIS    IPCOM shell commands for diameter client
    MODULES     ipdiameter_cmd_diameterc.o
    REQUIRES    INCLUDE_IPCOM_SHELL_CMD
}



Component INCLUDE_IPDIAMETERP_CMD {
    NAME        Diameter Proxy Agent Commands
    SYNOPSIS    IPCOM shell commands for diameter proxy agent
    MODULES     ipdiameter_cmd_diameterp.o
    REQUIRES    INCLUDE_IPCOM_SHELL_CMD
}



Component INCLUDE_IPDIAMETER_TLS_CFG {
    NAME            Diameter TLS Configuration
    SYNOPSIS        Diameter TLS configuration parameters
    REQUIRES        INCLUDE_IPSSL
    CFG_PARAMS	    DIAMETER_TLS_ENABLED \
                    DIAMETER_TLS_CERTIFICATE \
                    DIAMETER_TLS_ROOT_CERTIFICATE \
                    DIAMETER_TLS_ROOT_DIR
}

#ifdef _WRS_CONFIG_IPDIAMETER_SEC_KEY_DB
Component INCLUDE_IPDIAMETER_TLS_CFG {
	REQUIRES+= INCLUDE_IPCOM_USE_KEY_DB
}
#endif

Component INCLUDE_IPDIAMETER_EAP {
    NAME        Diameter EAP 
    SYNOPSIS    Diameter EAP application component
    MODULES     ipdiameter_eap.o
    REQUIRES    INCLUDE_IPDIAMETERC
}



/******************** Configuration Parameters *****************************/

Parameter DIAMETER_IDENTIFIER {
    NAME        Entity Identifier 
    SYNOPSIS    DIAMETER entity identity, which is the node's FQDN. \
		This identity string is used to get the node's address \
		via getaddrinfo function.  Hence, users MUST enter a \
		valid resolvable entry for this string.
    TYPE        char *
    DEFAULT     "apple.example.com"
}

Parameter DIAMETER_HOST_REALM {
    NAME        Realm 
    SYNOPSIS    DIAMETER realm to which the Diameter node belongs.
    TYPE        char *
    DEFAULT     "example.com"
}

Parameter DIAMETER_HOST_DOMAIN {
    NAME        Domain
    SYNOPSIS    DIAMETER local node address family, IP_AF_INET=2 \
                or IP_AF_INET6=28.
    TYPE        char *
    DEFAULT     "2"
}

Parameter DIAMETER_HOST_IPV4_ADDRESS {
    NAME        IPv4 Address
    SYNOPSIS    DIAMETER local node's IPv4 address.
    TYPE        char *
    DEFAULT     "10.1.2.1"
}

Parameter DIAMETER_HOST_IPV6_ADDRESS {
    NAME        IPv6 Address
    SYNOPSIS    DIAMETER local node's IPv6 address.
    TYPE        char *
    DEFAULT     "3ffe:300::5"
}

Parameter DIAMETER_HOST_TCP_PORT {
    NAME        TCP Port 
    SYNOPSIS    DIAMETER local node's TCP listening port number.
    TYPE        char *
    DEFAULT     "3868"
}

Parameter DIAMETER_APPLICATION_LIST {
    NAME        Application List 
    SYNOPSIS    List of application IDs that Diameter local node supports. \
		Refer to RFC 3588, section 2.4. The Format is a \
		comma-separated list of application IDs, e.g. "1,2", where \
		1 represents Diameter NASREQ, and 2 represents Diameter \
		Mobile-IP. 
    TYPE        char *
    DEFAULT     "2"
}

Parameter DIAMETER_VENDOR_ID {
    NAME        Vendor ID
    SYNOPSIS    Specifies the IANA "SMI Network Management Private Enterprise \
		Codes" [ASSIGNNO] value assigned to the vendor of the \
		Diameter application. Refer to RFC 3588, section 5.3.3.
    TYPE        char *
    DEFAULT     "0"
}

Parameter DIAMETER_ASR_COMPLY {
    NAME        ASR Compliance 
    SYNOPSIS    Specifies whether to terminate a session when receiving an ASR. \
		Specify 1 to terminate the sesion upcon receiving an ASR, \
		and 0 to ignore the ASR.  Refer to RFC 3588, section 8.5.2.
    TYPE        char *
    DEFAULT     "1"
}

Parameter DIAMETER_SESSION_TIMEOUT {
    NAME        Session Timeout Interval 
    SYNOPSIS    Specifies the timeout in seconds before a session requires \
              	re-authentication. Refer to RFC 3588, section 8.13.
    TYPE        char *
    DEFAULT     "30"
}

Parameter DIAMETER_AUTH_LIFETIME {
    NAME        Authorization Lifetime 
    SYNOPSIS    Specifies the maximum number of seconds of service to \
		be provided to the user before the user is to be \
		re-authenticated and/or re-authorized. Refer to RFC 3588, \
		section 8.9.
    TYPE        char *
    DEFAULT     "360"
}

Parameter DIAMETER_AUTH_GRACE_PERIOD {
    NAME        Authorization Grace Period  
    SYNOPSIS    Specifies the number of seconds the Diameter server will \
		wait following the expiration of the Authorization-Lifetime \
		AVP before cleaning up resources for the session. Refer to \
		RFC 3588, section 8.10.
    TYPE        char *
    DEFAULT     "30"
}

Parameter DIAMETER_PEER_RECONN_INTERVAL {
    NAME        Peer Reconnection Interval 
    SYNOPSIS    Specifies the interval between reconnection attemps. \
		The recommended value is 30 seconds. Refer to \
		RFC 3588, section 12.
    TYPE        char *
    DEFAULT     "30"
}

Parameter DIAMETER_PEER_MAX_RECONN_ATTEMPT {
    NAME        Max Peer Reconnect Attempts 
    SYNOPSIS    Specifies the max number of peer reconnection attempts.
    TYPE        char *
    DEFAULT     "30"
}

Parameter DIAMETER_WATCHDOG_TIMEOUT {
    NAME        Watchdog Timeout Interval
    SYNOPSIS    Specifies the Diameter transport watchdog timeout interval \
		in seconds. Refer to RFC 3588, section 5.5.
    TYPE        char *
    DEFAULT     "30"
}

Parameter DIAMETER_REQ_RETX_INTERVAL {
    NAME        Request Retransmission Interval 
    SYNOPSIS    Specifies the number of seconds Diameter node will \
		retransmit a request before receiving the answer to the \
		request.
    TYPE        char *
    DEFAULT     "10"
}

Parameter DIAMETER_REQ_MAX_RETX {
    NAME        Max Request Retransmissions 
    SYNOPSIS    Specifies the maximum number of a request to issue \
		before declaring a request failure.
    TYPE        char *
    DEFAULT     "3"
}


Parameter DIAMETER_TLS_ENABLED {
    NAME        Enable TLS 
    SYNOPSIS    Control whether TLS is enabled or not on the local node. \
		If set to "1", TLS is enabled on the local node; if set \
		to "0", it is disabled. If TLS is enabled, IPSSL and its \
		requirements must be built, the other Diameter TLS \
		configuration parameters must be configured properly, \
		and certiface files and private key file must be loaded.
    TYPE        char *
    DEFAULT     "0"
}

Parameter DIAMETER_TLS_CERTIFICATE {
    NAME        TLS Certificate File
    SYNOPSIS	Local node's certificate file.
    TYPE        char *
    DEFAULT     "certfile.pem"
}

#ifdef _WRS_CONFIG_IPDIAMETER_SEC_KEY_DB

Parameter DIAMETER_TLS_KEY_ID {
    NAME        TLS Private Key ID
    SYNOPSIS    This KeyId will be used to retrieve private key file \
				from secure key database.If IPDIAMETER_SEC_KEY_DB is selected \
				at VSB then user has to import the private \
				key file into secure key database using this keyid inorder to \
				retrieve it at run time otherwise diameter with TLS security \
				will not work.
    TYPE        char *
    DEFAULT     "diameterTlsPKeyId"
    _CFG_PARAMS INCLUDE_IPDIAMETER_TLS_CFG
}
#else
Parameter DIAMETER_TLS_KEY_FILE {
    NAME        TLS Private Key File
    SYNOPSIS    Local node's private key file.
    TYPE        char *
    DEFAULT     "keyfile.pem"
    _CFG_PARAMS INCLUDE_IPDIAMETER_TLS_CFG
}

Parameter DIAMETER_TLS_KEY_PASSWORD {
    NAME        TLS Key File Key Password
    SYNOPSIS    Local node's private key file key password
    TYPE        char *
    DEFAULT     "clientkey"
    _CFG_PARAMS INCLUDE_IPDIAMETER_TLS_CFG
}
#endif /* _WRS_CONFIG_IPDIAMETER_SEC_KEY_DB */

Parameter DIAMETER_TLS_ROOT_CERTIFICATE {
    NAME        TLS CA Root Certificate File
    SYNOPSIS    CA root certificate file.
    TYPE        char *
    DEFAULT     "cacertfile.pem"
}

Parameter DIAMETER_TLS_ROOT_DIR {
    NAME        TLS Certificate Root Directory 
    SYNOPSIS    The root location of the CA root certificate.
    TYPE 	char *
    DEFAULT     ""
}
#endif /*  _WRS_CONFIG_COMPONENT_IPDIAMETER */