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 dynamic parameters for cryptographic and authentication algorithms. A security gateway service will not function without a configured crypto template. Only one crypto template can be configured per service.


Mode:

Exec > Global Configuration > Context Configuration > Crypto Template Configuration

configure > context context_name > crypto template template_name ikev2-dynamic

Entering the above command sequence results in the following prompt:

[context_name]host_name(crf-crypto-tmp1-ikev2-tunnel)#

IMPORTANT:

Available commands or keywords/variables vary based on platform type, product version, and installed license(s).

allow-cert-enc cert-hash-url

Enables support for a certificate encoding type other than the default. When enabled hash and URL encoding type are supported in CERT and CERTREQ payloads.

Product:

Security gateway products

IMPORTANT:

This command appears in the CLI for this release. However, it has not been qualified for use with any current Cisco StarOS gateway products.


Privilege:

Security Administrator


Syntax
allow-cert-enc cert-hash-url
no allow-cert-enc cert-hash-url
no

Disables support for hash and URL encoding type in CERT and CERTREQ payloads.


Usage:

Enable support for a certificate encoding type other than the default. When enabled hash and URL encoding type are supported in CERT and CERTREQ payloads.


Example:
The following command enables hash and URL encoding type in CERT and CERTREQ payloads:
allow-cert-enc cert-hash-url
allow-custom-fqdn-idr

Allows non-standard FQDN (Fully Qualified Domain Name) strings in the IDr (Identification - Responder) payload of IKE_AUTH messages received from the UE with the payload type as FQDN.

Product:

All services using IKEv2 IPSec


Privilege:

Security Administrator


Syntax
allow-custom-fqdn-idrno allow-custom-fqdn-idrdefault allow-custom-fqdn-idr
no

Does not allow non-standard FQDN strings in the IDr payload of IKE_AUTH messages received from the UE with the payload type as FQDN.

default

Restores the default setting, which does not allow non-standard FQDN strings in the IDr payload of IKE_AUTH messages received from the UE with the payload type as FQDN.

You can chain multiple CA-CRLs in a single command instance.


Usage:

Use this command to configure the system to skip the syntax check for the IDr payload in IKE_AUTH messages received from the UE with the payload type as FQDN. This allows non-standard FQDN strings such as APN names in the IDr payload.


Example:
The following command configures the system to allow non-standard FQDN strings in the IDr payload of IKE_AUTH messages received from the UE with the payload type as FQDN:
allow-custom-fqdn-idr
authentication

Configures the gateway and subscriber authentication methods to be used by this crypto template.

Product:

All IPSec-related services


Privilege:

Security Administrator


Syntax
authentication { eap-profile name [ second-phase eap-profile name ] | local { certificate | pre-shared-key { encrypted key value | key clear_text } } |  pre-shared-key { encrypted key value | key  clear_text [ second-phase eap-profile name ] } | remote { certificate | eap-profile  name [ second-phase eap-profile name ] | pre-shared-key { encrypted key value | key clear_text [ second-phase eap-profile name ] } } }no authentication
local { certificate | pre-shared-key }default authentication 
default

Returns the command to its default setting.

no

Removes the authentication parameters from the configuration.

eap-profile name [ second-phase eap-profile name ]

Specifies that authentication is to be performed using a named Extensible Authentication Protocol (EAP) profile. name is an alphanumeric string of 1 through 127 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 an alphanumeric string of 1 through 127 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 an alphanumeric string of 16 through 255 characters for releases prior to 15.0, or 15 through 444 characters for release 15.0 and higher. key clear_text configures a clear text pre-shared key used for authentication. clear_text must be an alphanumeric string of 1 through 255 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 an alphanumeric string of 1 through 255 characters for releases prior to 15.0, or 15 through 444 characters for release 15.0 and higher.

key clear_text: Specifies that the pre-shared key used for authentication is clear text. clear_text must be an alphanumeric string of 1 through 255 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 an alphanumeric string of 1 through 127 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 an alphanumeric string of 1 through 127 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 an alphanumeric string of 1 through 255 characters for releases prior to 15.0, or 15 through 444 characters for release 15.0 and higher. key value configures a clear text pre-shared key used for authentication. clear_text must be an alphanumeric string of 1 through 255 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
blacklist

Enables the use of a blacklist (access denied) file to be used by a security gateway.

Product:

All products supporting IPSec blacklisting

IMPORTANT:

This command appears in the CLI for this release. However, it has not been qualified for use with any current Cisco StarOS gateway products.


Privilege:

Security Administrator


Syntax
blacklist
no blacklist
no

Disables the use of a blacklist.


Usage:

Enable the use of a previously created blacklist to deny access to prohibited peers via a security gateway.

A blacklist is a list or register of entities that are being denied a particular privilege, service, mobility, access or recognition. With blacklisting, any peer is allowed to connect as long as it does not appear in the list.

Each entry in the blacklist file should contain the ID type so that the validation is performed for that ID type. In every entry, the ID type and ID value should be separated by a space. Only DOS and UNIX file formatting are supported. For additional information, refer to the System Administration Guide.


Example:
blacklist
ca-certificate list

Used to bind an X.509 Certificate Authority (CA) certificate to a crypto template.

Product:

All IPSec-related services


Privilege:

Security Administrator, Administrator


Syntax
ca-certificate list
ca-cert-name name[ ca-cert-name  name ]
no ca-certificate
no

Unbinds the ca-certificate(s) bound to the crypto template.

ca-cert-name name

Binds the named X.509 Certificate Authority (CA) root certificate to a crypto template. name is an alphanumeric string of 1 through 129 characters.

You can chain multiple certificates(max 4) in a single command instance.


Usage:

Used to bind an X.509 CA certificate to a template.


Example:
Use the following example to add a CA certificate to a list:
ca-certificate list CA_list1
ca-crl list

Binds one or more Certificate Authority-Certificate Revocation Lists (CA-CRLs) to this crypto template.

Product:

All IPSec-related services


Privilege:

Security 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 the name of an existing CA-CRL expressed as an alphanumeric string of 1 through 129 characters. Multiple lists (max 4) can be configured for a crypto template.

You can chain multiple CA-CRLs in a single command instance.


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 a single X.509 trusted certificate to a crypto template.

Product:

All IPSec-related services


Privilege:

Security Administrator


Syntax
[ no ] certificate name  validate 
no

Removes any applied certificate or prevents the certificate from being included in the Auth Exchange response payload.

name

Specifies the name of a X.509 trusted certificate to bind to a crypto template. name is an alphanumeric string of 1 through 129 characters.

validate

Enable validations for the self-certificate.


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 IPSec-related services


Privilege:

Security 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 IPSec-related services


Privilege:

Security Administrator


Syntax
default { allow-custom-fqdn-idr | authentication | certificate | control-dont-fragment| dns-handling | dos { cookie-challenge
detect-dos-attack } | ikev2-ikesa { allow-empty-ikesa | cert-sign | ignore-notify-protocol-id | ignore-rekeying-requests | keepalive-user-activity | max-retransmission | mobike | policy | rekey | retransmission-timeout | setup-timer } | keepalive | nai
idr | natt [ include-header | send-keepalive ] }
authentication

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.

keepalive

Enables Dead Peer Detection for all SAs derived from this crypto template.

nai idr

Sets the default NAI parameters to be used for the crypto template (IDr) to none.

natt

Enables 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


Syntax
[ default ] dns-handling { custom | normal }
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.

dns-handling custom

Configures the PDIF to behave as described in the Usage section below.

dns-handling normal

This is the default action. The service 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.


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 does not return any INTERNAL_IP4_DNS option to MS, whether or not PDIF has received one 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 the Primary DNS is a.a.a.a and the Secondary DNS is 0.0.0.0, then a.a.a.a is returned (only one instance of DNS attribute present in the config payload).
  • If the Primary DNS is 0.0.0.0 and the Secondary DNS is a.a.a.a, then a.a.a.a is returned (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 parameters for IKEv2 INFO Exchange notify payloads for the given crypto template.

Product:

All IPSec-related services


Privilege:

Security 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 considered 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: Starts when the current half-open-sess-count exceeds the start count. The start count is an integer from 0 to 100000.
  • stop: Stops 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 configuration mode and returns to the Exec mode.

Product:

All


Privilege:

Security Administrator, Administrator


Syntax
end

Usage:

Use this command to return to the Exec mode.

exit

Exits the current mode and returns to the parent configuration mode.

Product:

All


Privilege:

Security Administrator, Administrator


Syntax
exit

Usage:

Use this command to return to the parent configuration mode.

identity local

Configures the identity of the local IPSec Client (IKE ID).

Product:

All Security Gateway products

IMPORTANT:

This command appears in the CLI for this release. However, it has not been qualified for use with any current Cisco StarOS gateway products.


Privilege:

Security Administrator


Syntax
identity local id-type type id name
no identity local
no

Resets the ID to the IP address of the interface to which the crypto template is associated (type = IPv4 or IPv6).

id-type type
Configures the IKE identity that the local client uses when authenticating to the gateway. Valid values are:
  • der-ans1-dn: configures NAI Type DER_ASN1_DN (Distinguished Encoding Rules, ASN.1 encoding, Distinguished Name)
  • fqdn: configures NAI Type ID_FQDN (Internet Fully Qualified Domain Name).
  • ip-addr: configures NAI Type ID_IP_ADDR (IP Address).
  • key-id: configures NAI Type ID_KEY_ID (opaque octet string).
  • rfc822-addr: configures NAI Type ID_RFC822_ADDR (RFC 822 email address).
id name

Specifies the identifier for the local IKE client as an alphanumeric string of 1 through 127 characters.


Usage:

Use this command to configure the identity of the local IPSec Client.


Example:
The following command configures the local IPSec Client.
identity local id-type
der-asn1-dn id system14
ikev2-ikesa

Configures parameters for the IKEv2 IKE Security Associations within this crypto template.

Product:

All IPSec-related services


Privilege:

Security Administrator


Syntax
ikev2-ikesa { allow-empty-ikesa | cert-sign { pkcs1.5 | pkcs2.0 } | ignore-notify-protocol-id | ignore-rekeying-requests | keepalive-user-activity | max-retransmissions number  | policy { congestion-rejection [ notify-status-value  value  ] | error-notification [ invalid-major-version ] [ invalid-message-id [ invalid-major-version | invalid-syntax ] ] | invalid-syntax [ invalid-major-version ] | use-rfc5996-notification  } | rekey [ disallow-param-change ] | retransmission-timeout msec | setup-timer sec | transform-set
list name1 name2 name3 name4 name5 name6  }default ikev2-ikesa { allow-empty-ikesa | cert-sign | ignore-notify-protocol-id | ignore-rekeying-requests | keepalive-user-activity | max-retransmissions | mobike | policy
error-notification | rekey [ disallow-param-change ] | retransmission-timeout | setup-timer }no ikev2-ikesa { allow-empty-ikesa | ignore-notify-protocol-id | ignore-rekeying-requests | | keepalive-user-activity | list name | mobike | policy
error-notification | rekey }
no ikev2-ikesa

Disables a previously enabled parameter.

allow-empty-ikesa

Default is not to allow-empty-ikesa. Activate to have the IKEv2 stack keep the IKE SA when all the Child SAs have been deleted.

cert-sign { pkcs1.5 | pkcs2.0 }

Specifies the certificate sign to be used. Default: pkcs1.5

pkcs1.5: Use the Public-Key Cryptography Standards (PKCS) version 1.5, RSA Encryption Standard.

pkcs2.0:: Use the PKCS version 2.0, RSA Encryption Standard.

ignore-notify-protocol-id

Ignores IKEv2 Informational Exchange Notify Payload Protocol-ID values for strict RFC 4306 compliance.

ignore-rekeying-requests

Ignores received IKE_SA Rekeying Requests.

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

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 through 8. Default: 5

mobike

IKEv2 Mobility and Multihoming Protocol: MOBIKE allows the IP addresses associated with IKEv2 and tunnel mode IPSec Security Associations to change. A mobile Virtual Private Network (VPN) client could use MOBIKE to keep the connection with the VPN gateway active while moving from one address to another. Similarly, a multihomed host could use MOBIKE to move the traffic to a different interface if, for instance, the one currently being used stops working. Default: disable

policy { congestion-rejection [ notify-status-value value ] | error-notification [ invalid-major-version ] [ invalid-message-id [ invalid-major-version | invalid-syntax ] ] | invalid-syntax [ invalid-major-version ] | use-rfc5996-notification }

Specifies the default policy for generating an IKEv2 Invalid Message ID error when PDIF receives an out-of-sequence packet.

congestion-rejection: Sends an Error Notify Message to the MS as a reply to an IKE_SA_INIT Exchange when no more IKE_SA sessions can be established.

notify-status-value value: Notify Message will be sent to MS as a reply to an IKE_SA_INIT Exchange when no more IKE_SA sessions can be established. value is RFC 4306 IKEv2 Private Use Status Range - integer 40960..65535.

error-notification: Sends an Error Notify Message to the MS for Invalid IKEv2 Exchange Message ID and Invalid IKEv2 Exchange Syntax for the IKE_SA_INIT Exchange.

[invalid-major-version]: Sends an Error Notify Message for Invalid Major Version

[invalid-message-id]: Sends an Error Notify Message for Invalid IKEv2 Exchange Message ID.

[invalid-syntax]: Sends an Error Notify Message for Invalid IKEv2 Exchange Syntax.

use-rfc5996-notification: Enable sending and receive processing for RFC 5996 notifications - TEMPORARY_FAILURE and CHILD_SA_NOT_FOUND

rekey [ disallow-param-change ]

Specifies if IKESA rekeying should occur before the configured lifetime expires (at approximately 90% of the lifetime interval). Default is not to re-key.

The disallow-param-change option prevents changes in negotiation parameters during rekey.

retransmission-timeout msec

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 an integer from 300 to 15000. Default: 500

setup-timer sec

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 through 3600. Default: 16

transform-set list name1

Specifies the name of a context-level configured IKEv2 IKE Security Association transform set. name1 ...name6 must be an existing IKEv2 IKESA Transform Set expressed as an alphanumeric string of 1 through 127 characters.

The transform set is 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 milli seconds:
ikev2-ikesa retransmission-timeout 400
The following command configures the IKEv2 IKESA list, consisting of a transform set named as ikesa43:
ikev2-ikesa transform-set
list ikesa43
keepalive

Configures keepalive or dead peer detection for security associations used within this crypto template.

Product:

All products supporting IPSec


Privilege:

Security Administrator


Syntax
keepalive [ interval sec ] default keepalive [ interval ] no keepalive
no

Disables keepalive messaging.

interval sec

Specifies the amount of time (in seconds) that must elapse before the next keepalive request is sent. sec must be an integer from 10 through 3600. Default: 10


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 (180 seconds):
keepalive interval 180
max-childsa

Defines a soft limit for the number of child Security Associations (SAs) per IKEv2 policy.

Product:

All products supporting IPSEcv2


Privilege:

Security Administrator


Syntax
max-childsa <numbr> [ overload-action { ignore | terminate } ]
max-childsa <numbr>

Specifies a soft limit for the maximum number of Child SAs per IKEv2 policy. <numbr> can be an integer from 1 to 4 for releases prior to 15.0, or 1 to 5 for 15.0 and higher. Default = 2.

overload-action { ignore | terminate }
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 four Child SAs with the overload action of terminate.
max-childsa 4 overload
action terminate
nai

Configures the Network Access Identifier (NAI) parameters to be used for the crypto template IDr (recipient’s identity).

Product:

IMPORTANT:

This command is deprecated from 15.0 and later releases.

All Security Gateway products


Privilege:

Security Administrator


Syntax
nai { idr name [ id-type { der-asn1-dn | der-asn1-gn | fqdn | ip-addr | key-id | rfc822-addr } ] | use-received-idr }  
default nai idr
no nai { idr | use-received-idr } 
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 service IP address is sent as the IDr value with the type ID_IP_ADDR. This is the default condition.

idr name

Specifies the name of the IDr crypto template as an alphanumeric string of 1 through 79 characters.

id-type { der-asn1-dn | der-asn1-gn | fqdn | ip-addr | key-id | rfc822-addr }
Configures the NAI IDr type parameter. If no id-type is specified, then rfc822-addr is assumed.
  • der-asn1-dn: configures NAI Type DER_ASN1_DN (Distinguished Encoding Rules, ASN.1 encoding, Distinguished Name)
  • der-asn1-gn: configures NAI Type DER_ASN1_GN (Distinguished Encoding Rules, ASN.1 encoding, General Name)
  • fqdn: configures NAI Type ID_FQDN (Internet Fully Qualified Domain Name).
  • ip-addr: configures NAI Type ID_IP_ADDR (IP Address).
  • key-id: configures NAI Type ID_KEY_ID (opaque octet string).
  • rfc822-addr: configures NAI Type ID_RFC822_ADDR (RFC 822 email address).
use-received-idr

Specifies that the received IDr be used in the crypto template.


Usage:

The configured IDr is sent 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:

All Security Gateway products


Privilege:

Security Administrator


Syntax
[ default | no ] natt [ include-header ] [ send-keepalive [ idle-interval idle_secs ] [ interval interval_secs ] ]
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.

include-header

Includes the NAT-T header in IPSec packets.

send-keepalive [ idle-interval idle_secs ] [ interval interval_secs ]

Sends NAT-Traversal keepalive messages.

idle-interval idle_secs: Specifies the number of seconds that can elapse without sending NAT keepalive packets before sending NAT keepalive packets is started. idle_secs is an integer from 20 to 86400. Default: 60.

interval interval_secs: Specifies the number of seconds between the sending of NAT keepalive packets. interval_secs is an integer from 20 to 86400. Default: 60.


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
ocsp

Enables use of Online Certificate Status Protocol (OCSP) from a crypto template. OCSP provides a facility to obtain timely information on the status of a certificate.

Product:

All products supporting IPSec

IMPORTANT:

This command appears in the CLI for this release. However, it has not been qualified for use with any current Cisco StarOS gateway products.


Privilege:

Security Administrator


Syntax
ocsp [ nonce | responder-address ipV4_address [ port port_value ] ]
no ocsp [ nonce | responder-address [ port ] ]
default ocsp [ nonce ]
no

Disables the use of OCSP.

default

Sets / Restores default value assigned for ocsp nonce.

nonce

Enables sending nonce (unique identifier) in OCSP requests.

responder-address ipV4_address

Configures the OCSP responder address(IPv4), used when absent in peer (device) certificate.

IPv4_address is an IPv4 address specified in dotted decimal format.

port port_value

Configures the port for OCSP responder.

port_value is an integer value between 1 and 65535. The default port is 8889.


Usage:

This command enables the use of Online Certificate Protocol (OCSP) from a crypto map/template. OCSP provides a facility to obtain timely information on the status of a certificate.

OCSP messages are exchanged between a gateway and an OCSP responder during a certificate transaction. The responder immediately provides the status of the presented certificate. The status can be good, revoked or unknown. The gateway can then proceed based on the response.


Example:
ocsp
payload

Creates a new, or specifies an existing, crypto template payload and enters the Crypto Template Payload Configuration Mode.

Product:

All Security Gateway products


Privilege:

Security Administrator


Syntax
[ no ] payload name match childsa [ match { any | ipv4 | ipv6 } ]
no

Removes a currently configured crypto template payload.

payload name

Specifies the name of a new or existing crypto template payload as an alphanumeric string of 1 through 127 characters.

match childsa [ match { any |ipv4 | ipv6 }
Filters IPSec Child Security Association creation requests for subscriber calls using this payload. Further filtering can be performed by applying the following:
  • match any: Configures this payload to be applicable to IPSec Child Security Association requests for IPv4 and/or IPv6.
  • match ipv4: Configures this payload to be applicable to IPSec Child Security Association requests for IPv4 only.
  • match ipv6: Configures this payload to be applicable to IPSec Child Security Association requests for IPv6 only.

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 IPSec-related services


Privilege:

Security 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.

peer network ip_address {/mask | mask ip_mask }

Specifies the IP address of the peer network in IPv4 dotted-decimal or IPv6 colon-separated-hexadecimal 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 (CIDR notation).

mask ip_mask specifies the subnet mask in IPv4 dotted-decimal or IPv6 colon-separated-hexadecimal notations.

[ 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 an alphanumeric string or hexadecimal sequence from 16 to 64.

preshared key key: Specifies that a clear text pre-shared key is to be used for IPSec authentication for the address range. key must be an alphanumeric string or hexadecimal 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 10.2.3.4 and a bit mask of 8:
peer network 10.2.3.4/8
remote-secret-list

Enables the use of a Remote Secret List containing up to 1000 pre-shared keys.

Product:

All Security Gateway products

IMPORTANT:

This command appears in the CLI for this release. However, it has not been qualified for use with any current Cisco StarOS gateway products.


Privilege:

Security Administrator


Syntax
remote-secret-list list_name
no remote-secret-list
no

Disables use of a Remote Secret List.

list_name

Specifies the name of an existing Remote Secret List as an alphanumeric string of 1 through127 characters.


Usage:

Enable the use of a Remote Secret List containing up to 1000 pre-shared keys.

Only one active remote-secret-list is supported per system.

For additional information, refer to the Remote Secret List Configuration Commands chapter of the Command Line Interface Reference and the System Administration Guide.


Example:
The following command enables a remote-secret-list named rs-list:
remote-secret-list
rs-list

timeout

Sets the OCSP Certificate Server timeout interval in seconds. This is the interval within which the response from an external OCSP or HASH-url server should be received.

Product:

Privilege:

Administrator


Mode:

Exec > Global Configuration > Context Configuration > Crypto Template Configuration

configure > context context_name > crypto template template_name ikev2-dynamic

Entering the above command sequence results in the following prompt:

[context_name]host_name(crf-crypto-tmp1-ikev2-tunnel)#

Syntax
timeout cert-server timeout_value
 default timeout cert-server
default

Sets / Restores default value assigned for Certificate Server timeout in seconds. Default is 20 seconds.

timeout_value

Specifies the timeout value in seconds which is an integer between 1 through 60.


Usage:

Use this command to configure Certificate Server timeout in seconds.


Example:
The following command configures Certificate Server timeout as 50 seconds:
timeout cert-server 50
whitelist

Enables the use of an existing whitelist (access permitted) file by a security gateway.

Product:

All products supporting IPSec whitelisting

IMPORTANT:

This command appears in the CLI for this release. However, it has not been qualified for use with any current Cisco StarOS gateway products.


Privilege:

Security Administrator


Syntax
whitelist
no whitelist
no

Disables the use of a whitelist.


Usage:

Enable the use of a previously created whitelist to allow privileged peers access via a security gateway.

A whitelist is a list or register of entities that are being provided a particular privilege, service, mobility, access or recognition. With whitelisting, no peer is allowed to connect unless it appears in the list.

Each entry in the whitelist file should contain the ID type so that the validation is performed for that ID type. In every entry, the ID type and ID value should be separated by a space. Only DOS and UNIX file formatting are supported. For additional information, refer to the System Administration Guide.


Example:
whitelist