Files
2026-07-30 11:19:44 +05:30

558 lines
23 KiB
Mathematica

/* 00comp_ipnet_mobility.cdf - IPNet Mobility configuration file */
/*
* Copyright (c) 2006-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
--------------------
01i,11oct07,jho Fixed defect 106455; confusing naming and synopsis updated.
01h,19sep07,rme Added missing backslash (line:137, 304)
01f,27feb07,kch Added MIPMN_IPSEC_PROTECTED configuration parameter for
mobile node. Also renamed MIPMN_IFNAME_LIST to MIPMN_IFNAME
since only one interface can be configured at any time in
the mobile node (WIND00089286).
01e,23jan06,tlu Fix MIP CDF defects (85299, 85297, 85290)
01d,25nov06,kch Added MIPHA_IF_NAT_T_KEEPALIVE_LIST configuration parameter.
01c,23sep06,kch Fixed IPCOM shell commands description.
01b,26aug06,kch Added support for configuration parameters.
01a,22may06,kch created.
*/
#ifdef _WRS_CONFIG_COMPONENT_IPMIPMN
Component INCLUDE_IPMIPMN {
NAME IPv4 Mobile Node
SYNOPSIS IPv4 Mobile Node
MODULES ipmipmn.o
REQUIRES INCLUDE_IPCOM INCLUDE_IPNET INCLUDE_IPMIP4
_CHILDREN FOLDER_MOBILITY_MN
CONFIGLETTES ipmipmn_config.c
CFG_PARAMS MIPMN_IFNAME \
MIPMN_HOME_AGENT \
MIPMN_MTU_REDUCTION \
MIPMN_HOME_ADDRESS \
MIPMN_HOME_MASK \
MIPMN_HOME_GATEWAY \
MIPMN_SOL_ADDRESS \
MIPMN_HA_AUTH_SECRET \
MIPMN_HA_AUTH_SPI \
MIPMN_HA_AUTH_METHOD \
MIPMN_RUN_MODE \
MIPMN_FA_AUTH_SECRET \
MIPMN_FA_AUTH_SPI \
MIPMN_FA_AUTH_METHOD \
MIPMN_REG_LIFETIME \
MIPMN_RECV_BROADCASTS \
MIPMN_TUNNEL_TYPE \
MIPMN_REVERSE_TUNNELING \
MIPMN_NAI \
MIPMN_DYNAMIC_HOME_AGENT_ASSIGNMENT \
MIPMN_SOLICIT \
MIPMN_IPSEC_PROTECTED \
MIPMN_IPIKE_RECONFIGURE \
MIPMN_IPIKE_SECURE \
MIPMN_NAT_T_ENABLED \
MIPMN_NAT_T_FORCED \
MIPMN_NAT_T_KEEPALIVE \
MIPMN_NAT_T_TUNNEL_TYPE \
MIPMN_FA_SPI_SECRET_LIST \
MIPMN_FA_SPI_METHOD_LIST \
MIPMN_HA_SPI_SECRET_LIST \
MIPMN_HA_SPI_METHOD_LIST \
MIPMN_FA_SA_ADDRESS_LIST \
MIPMN_HA_SA_ADDRESS_LIST \
MIPMN_AAA_SECRET \
MIPMN_AAA_SPI \
MIPMN_AAA_METHOD \
MIPMN_SIMBIND \
MIPMN_TUNNEL_REORDERING \
MIPMN_REVOCATION \
MIPMN_IPIKE_MOBIKE
}
Component INCLUDE_IPMIPMN_FEATURE_EXTENSION {
NAME IPv4 Mobile Node Feature Extension Registration Hook
SYNOPSIS IPv4 Mobile Node Feature Extension allows you provide \
an additional registration hook for registration of \
external functions.
REQUIRES INCLUDE_IPMIPMN
_CHILDREN FOLDER_MOBILITY_HA
CFG_PARAMS MIPMN_FEATURE_INITIALIZATION_HOOK
}
Parameter MIPMN_FEATURE_INITIALIZATION_HOOK {
NAME Mobile Node Feature Initialization Hook
SYNOPSIS This is the function hook that you may define in order to \
register extra functional extensions to the Mobile Node
TYPE FUNCPTR
DEFAULT your_function_here
}
/* INCLUDE_IPMIPMN configuration parameters */
Parameter MIPMN_IFNAME {
NAME Mobile Node Interface
SYNOPSIS Specifies network interface that should be managed by the \
mobile IP node implementation, e.g. "eth0".
TYPE char *
DEFAULT ""
}
Parameter MIPMN_HOME_AGENT {
NAME Home Agent IPv4 Address
SYNOPSIS The IPv4 address of the mobile node home agent, \
e.g. "10.1.2.42".
TYPE char *
DEFAULT ""
}
Parameter MIPMN_MTU_REDUCTION {
NAME Mtu Reduction
SYNOPSIS Set to "1" to reserve MTU for headers beyond the mobile \
nodes control, such as IPSEC or other security releated \
protocols. This is useful to avoid needless fragmentation.
TYPE char *
DEFAULT "0"
}
Parameter MIPMN_HOME_ADDRESS {
NAME Home Address
SYNOPSIS The mobile node IPv4 address on the home network. By \
choosing the IP address any (i.e. "0.0.0.0"), the mobile \
node will read the IP address and netmask from the \
configured interface (set by MIPMN_IFNAME) at start and \
use as mobile node home address and netmask.
TYPE char *
DEFAULT "0.0.0.0"
}
Parameter MIPMN_HOME_MASK {
NAME Home Netmask
SYNOPSIS The mobile node home network (sub)netmask in "a.b.c.d" \
format, e.g."255.255.0.0".
TYPE char *
DEFAULT ""
}
Parameter MIPMN_DYNAMIC_HOME_AGENT_ASSIGNMENT {
NAME Dynamic Home Agent Assignment
SYNOPSIS Enables Dynamic Home Agent Assignment (DHAA) as per RFC4433. \
When DHAA is used, if an address is specified in the \
MIPMN_HOME_AGENT configuration parameter, it will be used \
as a 'initial' home agent to query. If the mobile node is \
run in co-located mode, the MIPMN_HOME_AGENT must still \
be specified, since there's no way for the mobile node to \
resolve the home agent. If foreign agent's are being used, \
depending on the configuration of the foreign agent, the \
mobile node may actually not specify a home agent at all, \
since the foreign agent may resolve the proper one, or assign \
one depending on the type home agent assignment. Values for \
this configuration item are: 'disabled', 'enabled' or 'home'. \
When 'enabled', the mobile node may be assigned a home agent \
either in its home domain, or in the foreign domain depending \
on the policy of the foreign agent. When 'home' the mobile \
node requires a home agent in its own domain.
TYPE char *
DEFAULT "disabled"
}
Parameter MIPMN_HOME_GATEWAY {
NAME Home Gateway
SYNOPSIS If set, the mobile node will update the default gateway upon \
reaching the home network. If not set, it is outside the \
scope of IPMIPMN how to update the default gateway upon \
returning home with a possibly unreachable default gateway. \
E.g. "10.1.1.1".
TYPE char *
DEFAULT ""
}
Parameter MIPMN_SOL_ADDRESS {
NAME Router Solicitation Address
SYNOPSIS Configures the destination address of outgoing router \
solicitation messages from the mobile node. If not set, \
set to invalid IP address or 0.0.0.0 IP address, the mobile \
node will not send ICMP router solicitations. \
E.g. "224.0.0.11".
TYPE char *
DEFAULT ""
}
Parameter MIPMN_HA_AUTH_SECRET {
NAME Default Home Agent Shared Secret
SYNOPSIS This parameter specifies the default secret to be used when \
authenticating towards home agents. If you need to configure \
secrets on a per home agent basis, you must use the \
MIPMN_HA_SPI_METHOD_LIST, MIPMN_HA_SPI_SECRET_LIST and \
MIPMN_HA_SA_ADDRESS_LIST parameters. An example configuration \
is "test0"
TYPE char *
DEFAULT ""
}
Parameter MIPMN_HA_AUTH_SPI {
NAME Default Home Agent SPI
SYNOPSIS This is the default home agent SPI parameter when \
authenticating towards home agents. If you need to configure \
SPI's on a per home agent basis, you must use the \
MIPMN_HA_SPI_METHOD_LIST, MIPMN_HA_SPI_SECRET_LIST and \
MIPMN_HA_SA_ADDRESS_LIST parameters. An example configuration \
is "1000"
TYPE char *
DEFAULT ""
}
Parameter MIPMN_HA_AUTH_METHOD {
NAME Default Home Agent Security Method
SYNOPSIS The default home agent authentication method, which specifies \
what type of security verification mechanism should be used. \
There are two different values available, md5-hmac and keygen, \
where md5-hmac is the default MIPv4 authentication method, \
and keygen will tell the mobile node to generate keys using \
RFC3957. Note that you MUST configure MIPMN_AAA_SPI, \
MIPMN_AAA_SECRET and MIPMN_AAA_METHOD when using keygen. If \
you need to configure auth methods on a per home agent basis, \
you must use the MIPMN_HA_SPI_METHOD_LIST, \
MIPMN_HA_SPI_SECRET_LIST and MIPMN_HA_SA_ADDRESS_LIST
TYPE char *
DEFAULT ""
}
Parameter MIPMN_RUN_MODE {
NAME Mobile Node Run Mode
SYNOPSIS Whether to use a foreign agent ("fa") or a co-located \
("co") address.
TYPE char *
DEFAULT "fa"
}
Parameter MIPMN_FA_AUTH_SECRET {
NAME Default Foreign Agent Shared Secret
SYNOPSIS This parameter specifies the default secret to be used when \
authenticating towards foreign agents. If you need to configure \
secrets on a per foreign agent basis, you must use the \
MIPMN_FA_SPI_METHOD_LIST, MIPMN_FA_SPI_SECRET_LIST and \
MIPMN_FA_SA_ADDRESS_LIST parameters. An example configuration \
is "test1"
TYPE char *
DEFAULT ""
}
Parameter MIPMN_FA_AUTH_SPI {
NAME Default Foreign Agent SPI
SYNOPSIS This is the default foreign agent SPI parameter when \
authenticating towards foreign agents. If you need to configure \
SPI's on a per foreign agent basis, you must use the \
MIPMN_FA_SPI_METHOD_LIST, MIPMN_FA_SPI_SECRET_LIST and \
MIPMN_FA_SA_ADDRESS_LIST parameters. An example configuration \
is "1001"
TYPE char *
DEFAULT ""
}
Parameter MIPMN_FA_AUTH_METHOD {
NAME Default Foreign Agent Security Method
SYNOPSIS The default foreign agent authentication method, which \
specifies what type of security verification mechanism should \
be used. There are two different values available, md5-hmac \
and keygen, where md5-hmac is the default MIPv4 authentication \
method, and keygen will tell the mobile node to generate keys \
using RFC3957. Note that you MUST configure MIPMN_AAA_SPI, \
MIPMN_AAA_SECRET and MIPMN_AAA_METHOD when using keygen. If \
you need to configure auth methods on a per foreign agent basis, \
you must use the MIPMN_FA_SPI_METHOD_LIST, \
MIPMN_FA_SPI_SECRET_LIST and MIPMN_FA_SA_ADDRESS_LIST
TYPE char *
DEFAULT ""
}
Parameter MIPMN_REG_LIFETIME {
NAME Registration Lifetime
SYNOPSIS Registration lifetime in seconds where 0 means infinite \
lifetime. When on foreign networks, the mobile node will \
attempt to reregister after half the lifetime.
TYPE char *
DEFAULT "30"
}
Parameter MIPMN_RECV_BROADCASTS {
NAME Receive Broadcasts
SYNOPSIS Setting this configuration option to "1" enables the \
reception of broadcast packets from the home network \
(assuming the home agent supports forwarding of such \
packets). "0" means disable.
TYPE char *
DEFAULT "0"
}
Parameter MIPMN_TUNNEL_TYPE {
NAME Tunnel Type
SYNOPSIS The type of tunnel negotiated between the mobile node and \
foreign agent is chosen by setting this configuration \
option to "ipip", "gre" or "min" for IPIP, GRE or Minimal \
Encapsulation respectively. If the home agent does not \
support GRE or MIN, IPIP will be tried. If IPIP is not \
supported as well, the registration operation will fail and \
the mobile node must be reconfigured.
TYPE char *
DEFAULT "ipip"
}
Parameter MIPMN_REVERSE_TUNNELING {
NAME Reverse Tunneling
SYNOPSIS By setting this configuration option to "required" the mobile node \
will require the use of reverse tunneling. "optional" will enable \
the node to try to negotiate the use of reverse tunnelling, i.e. \
the mobile node will tunnel all outgoing packets to the \
home agent. If the home agent does not support reverse \
tunnelling, the mobile node will automatically retry the \
registration request without the use of reverse tunnelling \
(i.e. use normal triangular routing).
TYPE char *
DEFAULT "optional"
}
Parameter MIPMN_NAI {
NAME Network Access Identifier
SYNOPSIS Specify the network access identity as according to RFC 2794.
TYPE char *
DEFAULT ""
}
Parameter MIPMN_SOLICIT {
NAME Solicitations
SYNOPSIS Set to "required" to force the mobile node to always solicit \
routers on L2-LU. This is the default behaviour but it may \
be unset in order to allow transparent POST Low Latency \
Handovers without the mobile node re-registering until the \
registration time out occurs, or the FA forces the \
re-registration. Other values are "optional", which \
will try to keep solicitations to a minimum, and "disabled" \
which do not solicit at all.
TYPE char *
DEFAULT "required"
}
Parameter MIPMN_IPSEC_PROTECTED {
NAME IPSEC Protected CoA Only
SYNOPSIS This configuration parameter defines whether or not the \
mobile node should only use addresses which has SPD's \
specified which covers them. It requires that IPIPSEC or \
IPIKE has set up the required security policies and \
associations prior to any mobile IP registration. If \
MIPMN_IPIKE_SECURE is set, it takes precedense, and this \
configuration variable will be ignored.
TYPE char *
DEFAULT "0"
}
Parameter MIPMN_IPIKE_RECONFIGURE {
NAME IPIKE Reconfiguration On Movement
SYNOPSIS Specifies whether or not the mobile node should send a \
reconfiguration request to the IPIKE process when it moves. \
This is so that the IPIKE daemon may re-read its \
configuration file, re-acquire any primary addresses on the \
selected interface and renegotiate security associations.
TYPE char *
DEFAULT "0"
}
Parameter MIPMN_IPIKE_SECURE {
NAME IPIKE Secure Address Only
SYNOPSIS Specifies whether or not the mobile node should only use \
addresses allocated by IPIKE during its negotiation process. \
If set, the mobile node will scan its configured interface \
for addresses which IPIKE has reported are secure, and use \
them.
TYPE char *
DEFAULT "0"
}
Parameter MIPMN_IPIKE_MOBIKE {
NAME IPIKE Mobike On Movement
SYNOPSIS Specifies whether or not the mobile node should use \
mobike when roaming, in order to re-establish the encrypted \
channel previously created by IPIKE. Only addresses allocated \
by IPIKE are subjected to mobike, and therefore \
MIPMN_IPIKE_SECURE should usually also be enabled when this \
option is used.
TYPE char *
DEFAULT "0"
}
Parameter MIPMN_NAT_T_ENABLED {
NAME NAT Traversal
SYNOPSIS Enables or disables NAT Traversal according to RFC 3519.
TYPE char *
DEFAULT "1"
}
Parameter MIPMN_NAT_T_FORCED {
NAME Forced NAT Traversal
SYNOPSIS Enables forcing of NAT traversal (RFC 3519), regardless \
what the home agent NAT detection decides.
TYPE char *
DEFAULT "0"
}
Parameter MIPMN_NAT_T_KEEPALIVE {
NAME NAT Traversal Keepalive
SYNOPSIS Decides the keepalive timeout to use for NAT Traversal \
ICMP keepalive messages in order to maintain a NAT device \
UDP port mapping.
TYPE char *
DEFAULT "120"
}
Parameter MIPMN_NAT_T_TUNNEL_TYPE {
NAME NAT Traversal Tunnel Type
SYNOPSIS Allows for specifying a different tunnel type if NAT \
traversal is used. Ordinarily, the tunnel type specified \
by the mobile node base configuration is used, it may be \
overriden for NAT Traversal tunneling, if for example only \
IPIP is specified to work. Allowed values are "min", "gre" \
and "ipip". If not specified or empty, the mobile node \
base configuration will take precedence.
TYPE char *
DEFAULT ""
}
Parameter MIPMN_HA_SPI_SECRET_LIST {
NAME Home Agent Security Association Secrets
SYNOPSIS These keys specify the secrets associated with specific SPI's \
for use when communicating with home agents. The syntax is \
"<spi value>=<secret>" and multiple entries are separated \
by a semicolon. E.g. "1003=firstsecret;1004=secondsecret"
TYPE char *
DEFAULT ""
}
Parameter MIPMN_HA_SPI_METHOD_LIST {
NAME Home Agent Security Association Methods
SYNOPSIS These keys specify the security method associated with specific \
SPI's for use when communicating with home agents. The syntax \
is "<spi value>=<method>" and multiple entries are separated \
by a semicolon. Valid methods are: \
md5-hmac - The default MIPv4 hash mechanism. \
keygen - AAA key generation. If this method has been \
specified, keys will be generated according to \
RFC3957. You must configure MIPMN_AAA_SPI, \
MIPMN_AAA_SECRET and MIPMN_AAA_METHOD as well.
TYPE char *
DEFAULT ""
}
Parameter MIPMN_FA_SPI_SECRET_LIST {
NAME Foreign Agent Security Association Secrets
SYNOPSIS These keys specify the secrets associated with specific SPI's \
for use when communicating with foreign agents. The syntax is \
"<spi value>=<secret>" and multiple entries are separated\
by a semicolon. E.g. "1003=firstsecret;1004=secondsecret"
TYPE char *
DEFAULT ""
}
Parameter MIPMN_FA_SPI_METHOD_LIST {
NAME Foreign Agent Security Association Methods
SYNOPSIS These keys specify the security method associated with specific \
SPI's for use when communicating with foreign agents. The syntax \
is "<spi value>=<method>" and multiple entries are separated\
by a semicolon. Valid methods are: \
md5-hmac - The default MIPv4 hash mechanism. \
keygen - AAA key generation. If this method has been\
specified, keys will be generated according to\
RFC3957. You must configure MIPMN_AAA_SPI,\
MIPMN_AAA_SECRET and MIPMN_AAA_METHOD as well.
TYPE char *
DEFAULT ""
}
Parameter MIPMN_FA_SA_ADDRESS_LIST {
NAME Foreign Agent Security Association Selection
SYNOPSIS These keys specify what security association should be used \
when communicating with foreign agents. There may be multiple \
selection directives specified, each separated by a semicolon. \
The syntax for the directives is "<network[/prefix]>=<spi>".\
E.g. "10.1.2.3=1004;10.2.0.0/16=1005"
TYPE char *
DEFAULT ""
}
Parameter MIPMN_HA_SA_ADDRESS_LIST {
NAME Home Agent Security Association Selection
SYNOPSIS These keys specify what security association should be used \
when communicating with home agents. There may be multiple \
selection directives specified, each separated by a semicolon. \
The syntax for the directives is "<network[/prefix]>=<spi>". \
E.g. "10.1.2.3=1004;10.2.0.0/16=1005"
TYPE char *
DEFAULT ""
}
Parameter MIPMN_AAA_SECRET {
NAME AAA Shared Secret
SYNOPSIS The shared secret used when authenticating towards a AAA \
infrastructure. E.g. "myaaasecret".
TYPE char *
DEFAULT ""
}
Parameter MIPMN_AAA_SPI {
NAME AAA SPI
SYNOPSIS The Security Parameter Index (SPI) used when authenticating \
towards a AAA infrastructure. If set to the pre-defined \
value of "2", will indicate that RADIUS CHAP authentication \
should be used.
TYPE char *
DEFAULT ""
}
Parameter MIPMN_AAA_METHOD {
NAME AAA Security Association Method
SYNOPSIS Indicates what kind of HASH or authentication method should \
be used when calculating the authentication extensions. May \
be set to either md5-hmac or chap.
TYPE char *
DEFAULT ""
}
Parameter MIPMN_SIMBIND {
NAME Simultaneous Bindings
SYNOPSIS Enables or disables simultaneous bindings.
TYPE char *
DEFAULT "0"
}
Parameter MIPMN_TUNNEL_REORDERING {
NAME Tunnel Reordering
SYNOPSIS Disabled(0)/Enabled(1) tunnel reordering. When enabled, any \
tunneltype such as GRE that supports it will guarantee in-order \
packet delivery
TYPE char *
DEFAULT "0"
}
Parameter MIPMN_REVOCATION {
NAME Registration Revocation
SYNOPSIS Disabled(0)/Enabled(1) registration revocation. When enabled \
the mobile node will indicate to the home agent that it \
supports the usage of registration revocation.
TYPE char *
DEFAULT "1"
}
#endif