/* 00comp_ipcom.cdf - IPCom Component configuration file */

/*
 * Copyright (c) 2006-2010,2012 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
--------------------
02a,13mar08,rjq Detach INCLUDE_SHELL from TELNETS and SSH
01z,12nov22,j_y Added IPCOM_USER_SHELL_FUNCTION
01y,12nov12,rjq Change the default user ID to be 0xFFFFFFFF.
01x,02feb12,lzq Added INCLUDE_USE_WAITIF
01w,19aug10,ggz Added SHA256 hash and salt support
01v,08jun09,ggz Fix for defect WIND00167365
01u,01may09,ggz Added hashing capability for ipcom auth
01t,17apr09,rme Removed INCLUDE_USE_NATIVE_SHELL dependency on
                INCLUDE_SHELL_INTERP_CMD.
01s,03Sep08,brg Added ipcom_drv_mux.o for custom ARP hook support.
01r,10sep07,mze INCLUDE_IPCOM_FS_SELECTION changed to SELECT_IPCOM_FS
01q,04jul07,rme Replaced INCLUDE_IPCOM_SHELL_SELECTION with FOLDER_SHELLS
                Also updated 00comp_ipnet_apps.cdf INCLUDE_IPTELNETS
01p,07feb07,tkf Added INCLUDE_USE_NATIVE_SHELL dependency on
                INCLUDE_SHELL_INTERP_CMD.
01o,29jan07,tkf Added INCLUDE_USE_NATIVE_SHELL and
                INCLUDE_IPCOM_SHELL_SELECTION. Also changed some component
                attributes of INCLUDE_USE_IPCOM_SHELL.
01n,20jan07,tkf Remove dependency on INCLUDE_XBD_RAMDRV Not required (WIND00085813).
01m,19jan07,tkf Add INCLUDE_IPCOM_USE_RAM_DISK (WIND00085813).
01l,08jan07,kch Added ipcom_ipd_config.c configlette to INCLUDE_IPCOM.
01k,08jan07,kch Removed duplicate ipcom_config.c configlette from
                INCLUDE_IPCOM_USE_AUTH.
01j,07jan07,tkf Adjust INCLUDE_IPCOM_USE_VXSHELL_CMD component to accomodate
                changes in latest code drop.
01i,13dec06,tkf INCLUDE_IPCOM_USE_VXSHELL_CMD.
01h,23sep06,kch Moved INCLUDE_IPCOM_USE_AUTH_RADIUS to 02comp_ipnet_radius.cdf.
01g,28aug06,kch Added SELECT_IPCOM_AUTHENTICATION to corrected IPCom
                authentication configuration support.
01f,11aug06,tkf Remove INCLUDE_USE_IPCOM_SHELL dependency requirement on
                INCLUDE_IPTELNETS.
01e,10aug06,kch Moved syslogd to 'IPNet Shell Commands' folder.
01d,02jul06,kch Added ipcom_drv_eth.o module to INCLUDE_IPCOM component.
01c,30jun06,dlk Added INCLUDE_IPCOM_USE_SYSLOGD.
01b,25jun06,dlk Make INCLUDE_IPCOM require INCLUDE_SOCKLIB and
                INCLUDE_COMMON_NET. Specify initialization order for
                INCLUDE_IPCOM in 00init_usernetwork.cdf, not here.
01a,22may06,kch created.
*/

Component INCLUDE_IPCOM {
    NAME            VxWorks IPCOM
    SYNOPSIS        VxWorks IPCOM
    MODULES         ipcom_vxworks.o ipcom_drv_eth.o ipcom_drv_mux.o
    CONFIGLETTES    ipcom_config.c ipcom_ipd_config.c
    LINK_SYMS       ipcom_register_dev_name_mapping
    INIT_RTN	    ipcom_create ();
    REQUIRES	    INCLUDE_IPCOM_USR
    CFG_PARAMS      IPCOM_ENABLE_USER_SHELL \
                    IPCOM_START_SHELL
}

Parameter IPCOM_ENABLE_USER_SHELL {
    NAME        Enable IPCOM user shell
    SYNOPSIS    Enable IPCOM user shell
    TYPE        BOOL
    DEFAULT     FALSE
}

Parameter IPCOM_START_SHELL {
    NAME        IPCOM user start shell function
    SYNOPSIS    IPCOM user start shell function
    TYPE        FUNCPTR
    DEFAULT     NULL
}

Component INCLUDE_IPCOM_USE_AUTH {
    NAME            Use Authentication
    SYNOPSIS        Use Authentication
    MODULES         ipcom_auth.o ipcom_auth_login.o
    REQUIRES	    INCLUDE_IPCOM_USR
}

Component INCLUDE_CUSTOM_PW_HASH {
    NAME            Use Custom Password Hash Function
    SYNOPSIS        Use Custom Password Hash Function
    REQUIRES        INCLUDE_IPCOM_USE_AUTH
    CFG_PARAMS	    IPCOM_AUTH_HASH_HOOK
}

Selection SELECT_IPCOM_AUTHENTICATION {
    NAME            IPCOM authentication configurations
    SYNOPSIS        IPCOM authentication configurations
    COUNT           0-
    CHILDREN        INCLUDE_IPCOM_AUTH_1 \
                    INCLUDE_IPCOM_AUTH_2 \
                    INCLUDE_IPCOM_AUTH_3 \
                    INCLUDE_IPCOM_AUTH_4 \
                    INCLUDE_IPCOM_AUTH_5 \
                    INCLUDE_IPCOM_AUTH_6
}

Component INCLUDE_IPCOM_AUTH_1 {
    NAME            Auth configuration #1
    SYNOPSIS        Auth configuration #1
    REQUIRES        INCLUDE_IPCOM_USE_AUTH
    CFG_PARAMS      AUTH_USER_NAME1 AUTH_USER_PASSWD1 AUTH_USER_PASSWD1_SALT \
                    AUTH_USER_ID1 AUTH_USER_PASSWD1_HASH
}

Component INCLUDE_IPCOM_AUTH_2 {
    NAME            Auth configuration #2
    SYNOPSIS        Auth configuration #2
    REQUIRES        INCLUDE_IPCOM_USE_AUTH
    CFG_PARAMS      AUTH_USER_NAME2 AUTH_USER_PASSWD2 AUTH_USER_PASSWD2_SALT \
                    AUTH_USER_ID2 AUTH_USER_PASSWD2_HASH
}

Component INCLUDE_IPCOM_AUTH_3 {
    NAME            Auth configuration #3
    SYNOPSIS        Auth configuration #3
    REQUIRES        INCLUDE_IPCOM_USE_AUTH
    CFG_PARAMS      AUTH_USER_NAME3 AUTH_USER_PASSWD3 AUTH_USER_PASSWD3_SALT \
                    AUTH_USER_ID3 AUTH_USER_PASSWD3_HASH
}

Component INCLUDE_IPCOM_AUTH_4 {
    NAME            Auth configuration #4
    SYNOPSIS        Auth configuration #4
    REQUIRES        INCLUDE_IPCOM_USE_AUTH
    CFG_PARAMS      AUTH_USER_NAME4 AUTH_USER_PASSWD4 AUTH_USER_PASSWD4_SALT \
                    AUTH_USER_ID4 AUTH_USER_PASSWD4_HASH
}

Component INCLUDE_IPCOM_AUTH_5 {
    NAME            Auth configuration #5
    SYNOPSIS        Auth configuration #5
    REQUIRES        INCLUDE_IPCOM_USE_AUTH
    CFG_PARAMS      AUTH_USER_NAME5 AUTH_USER_PASSWD5 AUTH_USER_PASSWD5_SALT \
                    AUTH_USER_ID5 AUTH_USER_PASSWD5_HASH
}

Component INCLUDE_IPCOM_AUTH_6 {
    NAME            Auth configuration #6
    SYNOPSIS        Auth configuration #6
    REQUIRES        INCLUDE_IPCOM_USE_AUTH
    CFG_PARAMS      AUTH_USER_NAME6 AUTH_USER_PASSWD6 AUTH_USER_PASSWD6_SALT \
                    AUTH_USER_ID6 AUTH_USER_PASSWD6_HASH
}

Component INCLUDE_USE_IPCOM_SHELL {
    NAME            Uses IPCOM-specific shell
    SYNOPSIS        Uses IPCOM-specific shell
    MODULES         ipcom_shell.o
    LINK_SYMS       ipcom_start_shell
    REQUIRES        INCLUDE_IPCOM
    CFG_PARAMS      IPCOM_SHELL_PROMPT
}

Component INCLUDE_USE_NATIVE_SHELL {
    NAME            Uses native VxWorks shell
    SYNOPSIS        Uses native VxWorks shell
    MODULES         ipcom_pshell.o
    LINK_SYMS       ipcom_start_shell_native
    REQUIRES        INCLUDE_IPCOM INCLUDE_SHELL INCLUDE_SHELL_INTERP_CMD
    CFG_PARAMS      IPCOM_SHELL_PROMPT
}

Component INCLUDE_IPCOM_USE_VXSHELL_CMD {
    NAME            IPCOM VxShell Command
    SYNOPSIS        IP shell command to enter the VxWorks shell. The command blocks \
                    until the VxWorks shell exits.
    MODULES         ipcom_cmd_vxshell.o
    LINK_SYMS       ipcom_cmd_vxshell
    REQUIRES        INCLUDE_SHELL
}

Selection SELECT_IPCOM_SHELL {
        NAME            Select the shell type to use
        SYNOPSIS        Select the shell type to use
        COUNT           1-1
        CHILDREN        INCLUDE_USE_IPCOM_SHELL \
                        INCLUDE_USE_NATIVE_SHELL
        DEFAULTS        INCLUDE_USE_NATIVE_SHELL
}

Component INCLUDE_IPCOM_USE_RAM_DISK {
    NAME            IPCOM RAM Disk Support
    SYNOPSIS        Initialize VxWorks RAM Disk.
    MODULES         ipcom_ramdisk.o
    LINK_SYMS       vxfs_ramdisk_init
}

Component INCLUDE_IPCOM_FS_IPCOM {
    NAME            IPCOM uses IPCOM-specific file system
    SYNOPSIS        IPCOM uses IPCOM-specific file system
    MODULES         ipcom_file.o
    LINK_SYMS       ipcom_file_proc_exit
}

Component INCLUDE_IPCOM_FS_NATIVE {
    NAME            IPCOM uses native VxWorks file system
    SYNOPSIS        IPCOM uses native VxWorks file system
    REQUIRES        INCLUDE_IPCOM_USE_RAM_DISK
}

Selection SELECT_IPCOM_FS {
        NAME            IPCOM File System
        SYNOPSIS        Select the IPCOM File System Type to use
        COUNT           1-1
        CHILDREN        INCLUDE_IPCOM_FS_NATIVE \
                        INCLUDE_IPCOM_FS_IPCOM
        DEFAULTS        INCLUDE_IPCOM_FS_NATIVE
}

Component INCLUDE_IPTELNETS {
    NAME            TELNET Server
    SYNOPSIS        TELNET Server
    MODULES         ipcom_telnet.o
    REQUIRES        INCLUDE_IPCOM INCLUDE_IPNET
    _CHILDREN       FOLDER_TELNET
    CONFIGLETTES    ipcom_telnets_config.c
    CFG_PARAMS      IPCOM_TELNET_PORT \
                    IPCOM_TELNET_MAX_CLIENTS \
                    IPCOM_TELNET_IDLE_TIMEOUT
}


Component INCLUDE_IPCOM_USR {
    NAME            IPCOM user side functions
    SYNOPSIS        IPCOM user side functions
    INIT_RTN	    ipcom_usr_create ();
    _CHILDREN       FOLDER_NOT_VISIBLE
}


Component INCLUDE_USE_WAITIF {
    NAME        Wait for an address available
    SYNOPSIS    Wait for an address at VxWorks startup
    MODULES     ipcom_waitif.o
    INIT_RTN    ipcom_waitif_address ();
    REQUIRES    INCLUDE_IPCOM
    _CHILDREN   FOLDER_NET_CORE
}


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

/* INCLUDE_IPCOM_AUTH_1 configuration parameters */
Parameter AUTH_USER_NAME1 {
    NAME        User name #1
    SYNOPSIS    User name
    TYPE        char *
    DEFAULT     NULL
}

Parameter AUTH_USER_PASSWD1 {
    NAME        Password #1
    SYNOPSIS    Password
    TYPE        char *
    DEFAULT     NULL
}

Parameter AUTH_USER_PASSWD1_SALT {
    NAME        Password salt #1
    SYNOPSIS    Password salt
    TYPE        char *
    DEFAULT     NULL
}

Parameter AUTH_USER_ID1 {
    NAME        Userid #1
    SYNOPSIS    Userid. If userid is 0xFFFFFFFF then next available \
                user ID will automatically be allocated.
    TYPE        uint
    DEFAULT     0xFFFFFFFF
}

Parameter AUTH_USER_PASSWD1_HASH {
    NAME        Password #1 format
    SYNOPSIS    Use this  parameter to specify the type of the entred password. \
                Set to TRUE if the password is hashed. Set to FALSE if the password \
                is in a cleartext format.
    TYPE        BOOL
    DEFAULT     FALSE
}

/* INCLUDE_IPCOM_AUTH_2 configuration parameters */
Parameter AUTH_USER_NAME2 {
    NAME        User name #2
    SYNOPSIS    User name
    TYPE        char *
    DEFAULT     NULL
}

Parameter AUTH_USER_PASSWD2 {
    NAME        Password #2
    SYNOPSIS    Password
    TYPE        char *
    DEFAULT     NULL
}

Parameter AUTH_USER_PASSWD2_SALT {
    NAME        Password salt #2
    SYNOPSIS    Password salt
    TYPE        char *
    DEFAULT     NULL
}

Parameter AUTH_USER_ID2 {
    NAME        Userid #2
    SYNOPSIS    Userid. If userid is 0xFFFFFFFF then next available \
                user ID will automatically be allocated.
    TYPE        uint
    DEFAULT     0xFFFFFFFF
}

Parameter AUTH_USER_PASSWD2_HASH {
    NAME        Password #2 format
    SYNOPSIS    Use this  parameter to specify the type of the entred password. \
                Set to TRUE if the password is hashed. Set to FALSE if the password \
                is in a cleartext format.
    TYPE        BOOL
    DEFAULT     FALSE
}

/* INCLUDE_IPCOM_AUTH_3 configuration parameters */
Parameter AUTH_USER_NAME3 {
    NAME        User name #3
    SYNOPSIS    User name
    TYPE        char *
    DEFAULT     NULL
}

Parameter AUTH_USER_PASSWD3 {
    NAME        Password #3
    SYNOPSIS    Password
    TYPE        char *
    DEFAULT     NULL
}

Parameter AUTH_USER_PASSWD3_SALT {
    NAME        Password salt #3
    SYNOPSIS    Password salt
    TYPE        char *
    DEFAULT     NULL
}

Parameter AUTH_USER_ID3 {
    NAME        Userid #3
    SYNOPSIS    Userid. If userid is 0xFFFFFFFF then next available \
                user ID will automatically be allocated.
    TYPE        uint
    DEFAULT     0xFFFFFFFF
}

Parameter AUTH_USER_PASSWD3_HASH {
    NAME        Password #3 format
    SYNOPSIS    Use this  parameter to specify the type of the entred password. \
                Set to TRUE if the password is hashed. Set to FALSE if the password \
                is in a cleartext format.
    TYPE        BOOL
    DEFAULT     FALSE
}

/* INCLUDE_IPCOM_AUTH_4 configuration parameters */
Parameter AUTH_USER_NAME4 {
    NAME        User name #4
    SYNOPSIS    User name
    TYPE        char *
    DEFAULT     NULL
}

Parameter AUTH_USER_PASSWD4 {
    NAME        Password #4
    SYNOPSIS    Password
    TYPE        char *
    DEFAULT     NULL
}

Parameter AUTH_USER_PASSWD4_SALT {
    NAME        Password salt #4
    SYNOPSIS    Password salt
    TYPE        char *
    DEFAULT     NULL
}

Parameter AUTH_USER_ID4 {
    NAME        Userid #4
    SYNOPSIS    Userid. If userid is 0xFFFFFFFF then next available \
                user ID will automatically be allocated.
    TYPE        uint
    DEFAULT     0xFFFFFFFF
}

Parameter AUTH_USER_PASSWD4_HASH {
    NAME        Password #4 format
    SYNOPSIS    Use this  parameter to specify the type of the entred password. \
                Set to TRUE if the password is hashed. Set to FALSE if the password \
                is in a cleartext format.
    TYPE        BOOL
    DEFAULT     FALSE
}

/* INCLUDE_IPCOM_AUTH_5 configuration parameters */
Parameter AUTH_USER_NAME5 {
    NAME        User name #5
    SYNOPSIS    User name
    TYPE        char *
    DEFAULT     NULL
}

Parameter AUTH_USER_PASSWD5 {
    NAME        Password #5
    SYNOPSIS    Password
    TYPE        char *
    DEFAULT     NULL
}

Parameter AUTH_USER_PASSWD5_SALT {
    NAME        Password salt #5
    SYNOPSIS    Password salt
    TYPE        char *
    DEFAULT     NULL
}

Parameter AUTH_USER_ID5 {
    NAME        Userid #5
    SYNOPSIS    Userid. If userid is 0xFFFFFFFF then next available \
                user ID will automatically be allocated.
    TYPE        uint
    DEFAULT     0xFFFFFFFF
}

Parameter AUTH_USER_PASSWD5_HASH {
    NAME        Password #5 format
    SYNOPSIS    Use this  parameter to specify the type of the entred password. \
                Set to TRUE if the password is hashed. Set to FALSE if the password \
                is in a cleartext format.
    TYPE        BOOL
    DEFAULT     FALSE
}

/* INCLUDE_IPCOM_AUTH_6 configuration parameters */
Parameter AUTH_USER_NAME6 {
    NAME        User name #6
    SYNOPSIS    User name
    TYPE        char *
    DEFAULT     NULL
}

Parameter AUTH_USER_PASSWD6 {
    NAME        Password #6
    SYNOPSIS    Password
    TYPE        char *
    DEFAULT     NULL
}

Parameter AUTH_USER_PASSWD6_SALT {
    NAME        Password salt #6
    SYNOPSIS    Password salt
    TYPE        char *
    DEFAULT     NULL
}

Parameter AUTH_USER_ID6 {
    NAME        Userid #6
    SYNOPSIS    Userid. If userid is 0xFFFFFFFF then next available \
                user ID will automatically be allocated.
    TYPE        uint
    DEFAULT     0xFFFFFFFF
}

Parameter AUTH_USER_PASSWD6_HASH {
    NAME        Password #6 format
    SYNOPSIS    Use this  parameter to specify the type of the entred password. \
                Set to TRUE if the password is hashed. Set to FALSE if the password \
                is in a cleartext format.
    TYPE        BOOL
    DEFAULT     FALSE
}

Parameter IPCOM_AUTH_HASH_HOOK {
    NAME        User defined hash routine
    SYNOPSIS    Use this pointer to define a user defined hashing function. \
                The default function is ipcom_auth_default_hash_rtn, the \
                same function used when INCLUDE_CUSTOM_PW_HASH is not \
                included.
    TYPE        Ipcom_auth_hash_hook
    DEFAULT     ipcom_auth_default_hash_rtn
}

/* INCLUDE_USE_IPCOM_SHELL configuration parameters */

Parameter IPCOM_SHELL_PROMPT {
    NAME        IPCOM Shell Prompt
    SYNOPSIS    The prompt displayed by the shell when it is waiting for \
                commands. Supported special characters are: \
                "\p" - shell process name \
                "\P" - shell process id \
                "\i" - the IP address of the target \
                "\w" - the current working directory \
                "\W" - the basename of the current working directory \
                "\V" - ipcom_getenv("VR")
    TYPE        char *
    DEFAULT     "\\i$\\w>"
}

/* INCLUDE_IPTELNETS configuration parameters */
Parameter IPCOM_TELNET_PORT {
    NAME        IPCOM TELNET port
    SYNOPSIS    IPCOM TELNET server port in host endian.
    TYPE        char *
    DEFAULT     "23"
}

Parameter IPCOM_TELNET_MAX_CLIENTS {
    NAME        Maximum number of simultaneous TELNET clients
    SYNOPSIS    IPCOM_TELNET_MAX_CLIENTS controls the maximum number of simultaneous \
                telnet clients. If set to 0, the number is unlimited.
    TYPE        char *
    DEFAULT     "0"
}

Parameter IPCOM_TELNET_IDLE_TIMEOUT {
    NAME        Idle timeout for telnet client
    SYNOPSIS    Idle timeout(in minutes) for telnet client. If no any input during \
                this period, the telnet client will be auto logout. If set to 0, the \
                telnet client won't be logout.
    TYPE        char *
    DEFAULT     "360"
}