> Crypto Template Configuration Mode Commands
> The Crypto Template Configuration Mode is used to configure an IKEv2 IPSec policy. It includes most of the IPSec parameters and IKEv2 parameters for cryptographic and authentication algorithms etc. A security gateway service will not function without a configured crypto template. Only one crypto template can be configured per service.
> Important: The commands or keywords/variables that are available are dependent on platform type, product version, and installed license(s).
> authentication
> Configures the authentication method used for services using the crypto template.
> Product
> All
> Privilege
> Security Administrator, Administrator
> Syntax
> authentication { eap-profile name [ second-phase eap-profile name ] | gateway { encrypted key value | key clear_text } | local { certificate | pre-shared-key { encrypted key value | key clear_text } | pre-shared-key { encrypted key value | key clear_text } | remote { certificate | eap-profile name [ second-phase eap-profile name ] | pre-shared-key { encrypted key value | key clear_text } }
> [ default | no ] authentication gateway
> default
> Returns the command to its default setting.
> no
> Removes the authentication gateway form the configuration.
> eap-profile name [ second-phase eap-profile name ]
> Specifies that authentication is to be performed using a named EAP profile. name must be from 1 to 127 alpha and/or numeric characters. Entering this keyword places the CLI in the EAP Authentication Configuration Mode.
> The second-phase eap-profile name is only required for installations using multiple authentications. name must be from 1 to 127 alpha and/or numeric characters.
> gateway { encrypted key value | key clear_text }
> Specifies the pre-shared gateway key used for gateway authentication.
> encrypted key value: Specifies that the pre-shared key used for authentication is encrypted. value must be between 1 and 255 alpha and/or numeric characters.
> key clear_text: Specifies that the pre-shared key used for authentication is clear text. clear_text must be between 1 and 255 alpha and/or numeric characters.
> local { certificate | pre-shared-key { encrypted key value | key clear_text }
> Specifies the local authentication method required for services using the crypto template.
> certificate: Specifies that the certificate method of authentication must be used for services using the crypto template.
> pre-shared-key { encrypted key value | key clear_text }: Specifies that a pre-shared key is to be used for services using the crypto template. encrypted key value configures an encrypted pre-shared key used for authentication. value must be between 1 and 255 alpha and/or numeric characters. key clear_text configures a clear text pre-shared key used for authentication. clear_text must be between 1 and 255 alpha and/or numeric characters.
> pre-shared-key { encrypted key value | key clear_text }
> Specifies that a pre-shared key is to be used for services using the crypto template.
> encrypted key value: Specifies that the pre-shared key used for authentication is encrypted. value must be between 1 and 255 alpha and/or numeric characters.
> key clear_text: Specifies that the pre-shared key used for authentication is clear text. clear_text must be between 1 and 255 alpha and/or numeric characters.
> remote { certificate | eap-profile name [ second-phase eap-profile name ] | pre-shared-key { encrypted key value | key clear_text }
> Specifies the remote authentication method required for services using the crypto template.
> certificate: Specifies that the certificate method of remote authentication must be used for services using the crypto template.
> eap-profile name [ second-phase eap-profile name ]: Specifies that remote authentication is to be performed using a named EAP profile. name must be from 1 to 127 alpha and/or numeric characters. Entering this keyword places the CLI in the EAP Authentication Configuration Mode.
> The second-phase eap-profile name is only required for installations using multiple authentications. name must be from 1 to 127 alpha and/or numeric characters.
> pre-shared-key { encrypted key value | key clear_text }: Specifies that a pre-shared key is to be used for services using the crypto template. encrypted key value configures an encrypted pre-shared key used for authentication. value must be between 1 and 255 alpha and/or numeric characters. key value configures a clear text pre-shared key used for authentication. clear_text must be between 1 and 255 alpha and/or numeric characters.
> Usage
> Use this command to specify the type of authentication performed for subscribers or gateways attempting to access the service using this crypto template.
> Entering the authentication eap-profile command results in the following prompt:
> [context_name]hostname(cfg-crypto-tmpl-eap-key)#
> EAP Authentication Configuration Mode commands are defined in the “EAP Authentication Configuration Mode Commands” chapter.
> Example
> The following command enables authentication via an EAP profile named eap23 for subscribers using the service with this crypto template:
> authentication eap-profile eap23
> ca-certificate list
> Used to bind an X.509 CA root certificate to a crypto template.
> Product
> All
> Privilege
> Administrator
> Syntax
> ca-certificate list ca-cert-name name[ ca-cert-name name ]
> no ca-certificate
> no
> Removes a CA root certificate from the list.
> name
> An alpha and/or numeric string of 1 - 127 characters.
> Usage
> Used to bind an X.509 CA root certificate to a template.
> Example
> Use the following example to add a CA root certificate to a list:
> ca-certificate list name
> ca-crl list
> Binds one or more Certificate Authority-Certificate Revocation Lists (CA-CRLs) to this crypto template.
> Product
> All
> Privilege
> Administrator
> Syntax
> ca-crl list ca-crl-name name [ ca-crl-name name ] +
> no ca-crl
> no
> Removes the CA-CRL configuration from this template.
> ca-crl-name name
> Specifies the CA-CRL to associate with this crypto template. name must be an existing CA-CRL name and br from 1 to 129 alpha and/or numeric characters. Multiple lists can be configured for a crypto template.
> Usage
> Use this command to associate a CA-CRL name with this crypto template.
> CA-CRLs are configured in the Global Configuration Mode. For more information about configuring CA-CRLs, refer to the ca-crl name command in the Global Configuration Mode Commands chapter.
> Example
> The following example binds CA-CRLs named CRL-5 and CRL-7 to this crypto template:
> ca-crl list ca-crl-name CRL-5 ca-crl-name CRL-7
> certificate
> Used to bind an X.509 trusted certificate to a crypto template.
> Product
> All
> Privilege
> Administrator
> Syntax
> [ no ] certificate name name
> no
> Removes any applied certificate or prevents the certificate from being included in the Auth Exchange response payload.
> name name
> An alpha and/or numeric string of 1 - 127 characters.
> Usage
> Can be used to bind an X.509 certificate to a template, or include or exclude it from the Auth Exchange response payload.
> Example
> Use the following example to prevent a certificate from being included in the Auth Exchange payload:
> no certificate
> control-dont-fragment
> Controls the don’t fragment (DF) bit in the outer IP header of the IPsec tunnel data packet.
> Product
> All
> Privilege
> Administrator
> Syntax
> control-dont-fragment { clear-bit | copy-bit | set-bit }
> { clear-bit | copy-bit | set-bit }
> Configures the option to perform on the DF bit.

> • | clear-bit: Clears the DF bit from the outer IP header (sets it to 0).

> • | copy-bit: Copies the DF bit from the inner IP header to the outer IP header. This is the default action.

> • | set-bit: Sets the DF bit in the outer IP header (sets it to 1).

> Usage
> A packet is encapsulated in IPSec headers at both ends. The new packet can copy the DF bit from the original unencapsulated packet into the outer IP header, or it can set the DF bit if there is not one in the original packet. It can also clear a DF bit that it does not need.
> Example
> The following command sets the DF bit in the outer IP header:
> control-dont-fragment set-bit
> default
> Restores the default values for the selected parameter.
> Product
> All
> Privilege
> Security Administrator, Administrator
> Syntax
> default { authentication gateway | certificate | dns-handling | dos cookie-challenge detect-dos-attack | ikev2-ikesa { ignore-rekeying-requests | keepalive-user-activity | max-retransmission | mobike | policy error-notification | rekey | retransmission-timeout | setup-timer } | keepalive | nai | natt }
> authentication gateway
> Configures the default pre-shared gateway key used for authentication.
> certificate
> Configures the system to remove the certificate for a given crypto template.
> dns-handling
> Configures the system to use normal dns handling.
> dos cookie-challenge detect-dos-attack
> Configures the system to disable any Denial of Service attacks.
> ikev2-ikesa { ignore-rekeying-requests | keepalive | max-retransmission | mobike | policy error-notification | rekey | retransmission-timeout | setup-timer }
> Configures the system to use the following ikev2-ikesa defaults:

> • | ignore-rekeying-requests: Ignore any IKE_SA rekeying requests received.

> • | keepalive-user-activity: Keepalive messages received from peer will not reset the user inactivity timer.

> • | max-retransmission: Set the number of IKEv2 IKE exchange request retransmissions if the corresponding response has not been received. Deault is 5.

> • | mobike: Set MOBIKE to disable.

> • | policy error-notification: Set the default policy error notification method to send error notify messages to the MS.

> • | rekey: Set the default rekeying of IKE_SA to disabled.

> • | retransmission-timeout: Set the maximum number of milliseconds to elapse before an IKEv2 IKE exchange request is retransmitted if the corresponding IKEv2 IKE exchange response has not been received to 500.

> • | setup timer: Set the number of seconds to elapse before a non-fully-established IKEv2 IKE SA is terminated to 60.

> keepalive
> Enable Dead Peer Detection for all SAs derived from this crypto template.
> nai
> Set the default NAI parameters to be used for the crypto template (IDr) to none
> natt
> Enable NAT-T initiation for all SAs derived from this crypto template.
> Usage
> Use these commands to restore default parameters.
> Example
> Use the following command to disable MOBIKE by default:
> default mobike
> dns-handling
> Adds a custom option to define the ways a DNS address is returned based on proscribed circumstances described below.
> Product
> PDIF
> Privilege
> Security Administrator, Administrator
> Syntax
> [ default ] dns-handling { normal | custom }
> default
> Configures the default condition as normal. By default, PDIF always returns the DNS address in the config payload in the second authentication phase if one is received from either the configuration or the HA.
> normal
> This is the default action. PDIF always returns the DNS address in the config payload in the second authentication phase if one is received from either the configuration or the HA.
> custom
> Configures the PDIF to behave as described in the Usage section below.
> Usage
> During IKEv2 session setup, MS may or may not include INTERNAL_IP4_DNS in the Config Payload (CP). PDIF may obtain one or more DNS addresses for the subscriber in DNS NVSE from a proxy-MIP Registration Reply message. If Multiple Authentication is used, these DNS addresses may be also received in Diameter AVPs during the first authentication phase, or in RADIUS attributes in the Access Accept messages during the second authentication phase.
> In normal mode, by default PDIF always returns the DNS address in the config payload in the second authentication phase if one is received from either the configuration or the HA.
> In custom mode, depending on the number of INTERNAL_IP4_DNS, PDIF supports the following behaviors:

> • | If MS includes no INTERNAL_IP4_DNS in Config Payload: PDIF doesn't return any INTERNAL_IP4_DNS option to MS, whether or not PDIF has received one(s) in DNS NVSE from HA or from local configurations.

> • | If MS requests one or more INTERNAL_IP4_DNS(s) in Config Payload, and if P-MIP NVSE doesn't contain any DNS address or DNS address not present in any config, PDIF omits INTERNAL_IP4_DNS option to MS in the Config Payload.

> • | And if P-MIP NVSE includes one DNS address (a.a.a.a / 0.0.0.0), then PDIF sends one INTERNAL_IP4_DNS option in Config Payload back to the MS.

> • | If Primary DNS is a.a.a.a and Secondary DNS is 0.0.0.0, then a.a.a.a is returned (i.e. only one instance of DNS attribute present in the config payload).

> • | If Primary DNS is 0.0.0.0 and Secondary DNS is a.a.a.a, then a.a.a.a is returned (i.e. only one instance of DNS attribute present in the config payload). PDIF does not take 0.0.0.0 as a valid DNS address that can be assigned to the MS.

> • | And if P-MIP NVSE includes two DNS addresses (a.a.a.a and b.b.b.b) or configurations exists for these two addresses, then PDIF sends two INTERNAL_IP4_DNSs in the CP for the MS (typically known as primary and secondary DNS addresses).

> Example
> The following configuration applies the custom dns-handling mode:
> dns-handling custom
> dos cookie-challenge notify-payload
> Configure the cookie challenge params for IKEv2 INFO Exchange notify payloads for the given crypto template.
> Product
> All
> Privilege
> Administrator
> Syntax
> dos cookie-challenge notify-payload [ half-open-sess-count { start integer | stop integer } ]
> [ default | no ] cookie-challenge detect-dos-attack
> default
> Default is to disabled condition.
> no
> Prevents Denial of Service cookie transmission. This is the default condition.
> half-open-sess-count start | stop
> The half-open-sess-count is the number of half-open sessions per IPsec
> manager. A session is defined as half-open if a PDIF has responded to an IKEv2 INIT Request with an IKEv2 INIT Response, but no further message was received on that particular IKE SA.

> • | start: The functionality will start when the current half-open-sess-count exceeds the start count. The start count is an integer from 0 to 100000.

> • | stop: The functionality will stop when the current half-open-sess-count drops below the stop count. The stop count number is an integer from 0 to 100000. It is always less than or equal to the start count number

> Important: The start count value 0 is a special case whereby this feature is always enabled. In this event, both Start and Stop must be 0.
> Usage
> This feature (which is disabled by default) helps prevent malicious Denial of Service attacks against the server by sending a challenge cookie. If the response from the sender does not incorporate the expected cookie data, the packets are dropped.
> Example
> The following example configures the cookie challenge to begin when the half-open-sess-count reaches 50000 and stops when it drops below 20000:
> dos cookie-challenge notify-payload half-open-sess-count start 50000 stop 20000
> end
> Exits the current mode and returns to the Exec Mode.
> Product
> All
> Privilege
> Security Administrator, Administrator
> Syntax
> end
> Usage
> Change the mode back to the Exec Mode.
> exit
> Exits the current mode and returns to the previous mode.
> Product
> All
> Privilege
> Security Administrator, Administrator
> Syntax
> exit
> Usage
> Returns to the previous mode.
> ikev2-ikesa
> Configures parameters for the IKEv2 IKE Security Associations within this crypto template.
> Product
> All
> Privilege
> Administrator
> Syntax
> ikev2-ikesa { allow-empty-ikesa | keepalive-user-activity | max-retransmissions number | retransmission-timeout msec | policy error-notification [ invalid-message-id | invalid-syntax ] rekey | setup-timer sec | transform-set list name }
> default ikev2-ikesa { allow-empty-ikesa | max-retransmissions | policy error-notification [ invalid-message-id | invalid-syntax ] rekey | retransmission-timeout | setup-timer }
> no ikev2-ikesa { allow-empty-ikesa | keepalive-user-activity | list name | policy error-notification [ invalid-message-id | invalid-syntax ] | rekey }
> no ikev2-ikesa
> Disables a previously enabled parameter.
> allow-empty-ikesa
> Default is no allow-empty-ikesa. Activate to have the IKEv2 stack keep the IKE SA when all the Child SAs have been deleted.
> keepalive-user-activity
> Default is no keepalive-user-activity. Activate to reset the user inactivity timer when keepalive messages are received from peer.
> max-retransmissions number
> Default: 5
> Specifies the maximum number of retransmissions of an IKEv2 IKE exchange request if a response has not been received. number must be an integer from 1 to 8.
> policy error-notification
> Default is to enable. Default policy is to generate an IKEv2 Invalid Message ID error when PDIF receives an out-of-sequence packet.
> retransmission-timeout msec
> Default: 500
> Specifies the timeout period in milliseconds before a retransmission of an IKEv2 IKE exchange request is sent (if the corresponding response has not been received). msec must be and integer from 300 to 15000.
> rekey
> Specifies if IKESA rekeying should occur before the configured lifetime expires (at approximately 90% of the lifetime interval). Default is not to re-key.
> setup-timer sec
> Default: 16
> Specifies the number of seconds before a IKEv2 IKE Security Association, that is not fully established, is terminated. sec must be an integer from 1 to 3600.
> transform-set list name
> Specifies the name of context-level configured IKEv2 IKE Security Association transform set. name must be an existing IKEv2 IKESA Transform Set and be from 1 to 127 alpha and/or numeric characters.
> list
> A space-separated list of IKEv2-IKESA SA transform sets to be used for deriving IKEv2 IKE Security Associations from this crypto template. A minimum of one transform-set is required; maximum configurable is six.
> Usage
> Use this command to configure parameters for the IKEv2 IKE Security Associations within this crypto template.
> Example
> The following command configures the maximum number of IKEv2 IKESA request retransmissions to 7:
> ikev2-ikesa max-retransmissions 7
> The following command configures the IKEv2 IKESA request retransmission timeout to 400:
> ikev2-ikesa retransmission-timeout 400
> The following command configures the IKEv2 IKESA transform set list name to ikesa43:
> ikev2-ikesa transform-set list ikesa43
> keepalive
> Configures keepalive or dead peer detection for security associations used within this crypto template.
> Product
> All
> Privilege
> Security Administrator, Administrator
> Syntax
> keepalive [ interval sec ] [ timeout sec ] [ num-retry num ]
> default keepalive [ interval ] [ timeout ] [ num-retry ]
> no keepalive
> no
> Disables keepalive messaging.
> interval sec
> Default: 10
> Specifies the amount of time in seconds that must elapse before the next keepalive request is sent. sec must be an integer from 10 to 3600.
> timeout sec
> Default: 10
> Specifies the amount of time in seconds that the system will wait without receiving a reply before retrying the keepalive request. sec must be an integer from 10 to 3600.
> num-retry num
> Default: 2
> Specifies the number of times the system will retry a non-responsive peer before defining the peer as off-line or out-of-service. num must be an integer from 1 to 100.
> Usage
> Use this command to set parameters associated with determining the availability of peer servers.
> Example
> The following command sets a keepalive interval to three minutes, the timeout to 30 seconds, and the retry attempts number to 5:
> keepalive interval 180 timeout 30 num-retry 5
> max-childsa
> Defines a soft limit for the number of Child SAs Child SAs per IKEv2 policy.
> Product
> FNG
> Privilege
> Security Administrator, Administrator
> Syntax
> max-childsa <1 . . 4> [ overload action < ignore | terminate > ]
> max-childsa < 1 . . 4 >
> Specifies a soft limit for the maximum number of Child SAs per IKEv2 policy, which can be from 1 to 4.
> overload-action
> The action taken when the specified soft limit for the maximum number of Child SAs is reached, as follows:

> • | ignore: The IKEv2 stack ignores the specified soft limit for Child SAs.

> • | terminate: The IKEv2 stack rejects any new Child SAs if the specified soft limit is reached.

> Usage
> The FNG maintains two maximum Child SA values per IKEv2 policy. The first is a system-enforced maximum value, which is four Child SAs per IKEv2 policy. The second is a configurable soft maximum value, which can be a value between one and four. This command defines the soft limit for the maximum number of Child SAs per IKEv2 policy.
> Example
> The following command specifies a soft limit of 2 Child SAs with the overload action of terminate.
> max-childsa 2 overload action terminate
> nai
> Configures the NAI parameters to be used for the crypto template IDr.
> Product
> PDIF
> Privilege
> Security Administrator, Administrator
> Syntax
> [ default | no ] nai idr name id-type {rfc822-addr | fqdn | ip-addr | key-id }
> default
> Configures the default command no nai idr. As a result, the default behavior is for the PDIF-service IP address to be sent as the IDr value of type ID_IP_ADDR.
> no
> no nai idr configures the value whereby the PDIF service IP address is sent as the IDr value with the type ID_IP_ADDR. This is the default condition.
> idr name
> name is a string of up to 79 alpha and/or numeric characters.
> id-type { rfc822-addr | fqdn | ip-addr | key-id }
> Configures the NAI IDr id-type parameter. If no id-type is specified, then rfc822-addr is assumed.

> • | rfc822-addr: configures NAI Type ID_RFC822_ADDR.

> • | fqdn: configures NAI Type ID_FQDN.

> • | ip-addr: configures NAI Type ID_IP_ADDR.

> • | key-id: configures NAI Type ID_KEY_ID.

> Usage
> The configured IDr is sent from the PDIF to the MS in the first IKEv2 AUTH response.
> Example
> The following command configures the NAI IDr to the default condition.
> no naiidr
> natt
> Configures Network Address Translation - Traversal (NAT-T) for all security associations associated with this crypto template. This feature is disabled by default.
> Product
> PDIF
> Privilege
> Security Administrator, Administrator
> Syntax
> [ default | no ] natt [ send-keepalive ]
> default
> Disables NAT-T for all security associations associated with this crypto template.
> no
> Disables NAT-T for all security associations associated with this crypto template.
> send-keepalive
> Sends NAT-Traversal keepalive messages.
> Usage
> Use this command to configure NAT-T for security associations within this crypto template.
> Example
> The following command disables NAT-T for this crypto template:
> no natt
> payload
> Creates a new, or specifies an existing, crypto template payload and enters the Crypto Template Payload Configuration Mode.
> Product
> PDIF
> Privilege
> Security Administrator, Administrator
> Syntax
> [ no ] payload name match childsa [ match { ipv4 | ipv6 } ]
> no
> Removes a currently configured crypto template payload.
> name
> Specifies the name of a new or existing crypto template payload. name must be from 1 to 127 alpha and/or numeric characters.
> match childsa [ match { ipv4 | ipv6 }
> Filters IPSec Child Security Association creation requests for subscriber calls using this payload. Further filtering can be performed by applying the following:

> • | ipv4: Configures this payload to be applicable to IPSec Child Security Association requests for IPv4.

> • | ipv6: Configures this payload to be applicable to IPSec Child Security Association requests for IPv6.

> Usage
> Use this command to create a new or enter an existing crypto template payload. The payload mechanism is a means of associating parameters for the Security Association (SA) being negotiated.
> Two payloads are required: one each for MIP and IKEv2. The first payload is used for establishing the initial Child SA Tunnel Inner Address (TIA) which will be torn down. The second payload is used for establishing the remaining Child SAs. Note that if there is no second payload defined with home-address as the ip-address-allocation then no MIP call can be established, just a Simple IP call.
> Currently, the only available match is for ChildSA, although other matches are planned for future releases. Omitting the second match parameter for either IPv4 or IPv6 will make the payload applicable to all IP address pools.
> Crypto Template Payload Configuration Mode commands are defined in the Crypto Template IKEv2-Dynamic Payload Configuration Mode Commands chapter.
> Example
> The following command configures a crypto template payload called payload5 and enters the Crypto Template Payload Configuration Mode:
> payload payload5 match childsa
> peer network
> Configures a list of allowed peer addresses on this crypto template.
> Product
> All
> Privilege
> Administrator
> Syntax
> peer network ip_address {/mask | mask ip_mask } [ encrypted pre-shared-key key | pre-shared-key key ]
> no peer network ip_address mask ip_mask
> no
> Removes the specified peer network IP address from this crypto template.
> network ip_address {/mask | mask ip_mask }
> Specifies the IP address of the peer network in IPv4 dotted decimal notation or IPv6 colon separated notation.
> /mask specifies the subnet mask bits. mask must be and integer value from 1 to 32 for IPv4 addresses and 1 to 128 for IPv6 addresses.
> mask ip_mask specifies the subnet mask in dotted decimal notation for IPv4 addresses and colon-separated notation for IPv6 addresses.
> [ encrypted pre-shared-key key | pre-shared-key key ]
> encrypted preshared key key: Specifies that an encrypted pre-shared key is to be used for IPSec authentication for the address range. key must be a string or hexidecimal sequence from 16 to 64.
> preshared key key: Specifies that a pre-shared key is to be used for IPSec authentication for the address range. key must be a string or hexidecimal sequence from 1 to 32.
> Usage
> Use this command to configure a list or range of allowed peer network IP addresses for this template.
> Example
> The following command configures a set of IP addresses with starting address of 1.2.3.4 and a bit mask of 8:
> peer network 1.2.3.4/8

Cisco Systems Inc.
Tel: 408-526-4000
Fax: 408-527-0883