This module describes the commands used to configure keychain management.
For detailed information about keychain management concepts, configuration tasks, and examples, see the Implementing Keychain Management on the Cisco IOS XR Software configuration module in the
Cisco IOS XR System Security Configuration
Guide for the Cisco CRS Router.
To set the time period during which the authentication key on a keychain is received as
valid, use the accept-lifetime command in key configuration
mode. To revert to the default value, use the no form of this command.
Start time, in hh:mm:ss day month year format, in which the key
becomes valid. The range is from 0:0:0 to 23:59:59.
The range for the number of days of the month is from 1 to 31.
The range for the years is from 1993 to 2035.
durationduration value
(Optional) Determines the lifetime of the key in seconds. The range is from
1-2147483646.
infinite
(Optional) Specifies that the key never expires after it becomes valid.
end-time
(Optional) Time, in hh:mm:ss day month year format, after which the
key expires. The range is from 0:0:0 to 23:59:59.
Command Default
None
Command Modes
Key configuration
Command History
Release
Modification
Release 3.3.0
This command was introduced.
Release 3.6.0
The range values were added for the start-time argument.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
Task ID
Task ID
Operations
system
read, write
Examples
The following example shows how to use the accept-lifetime
command:
To specify the tolerance or acceptance limit, in seconds, for an accept key that is used
by a peer, use the accept-tolerance command in keychain
configuration mode. To disable this feature, use the no form
of this command.
accept-tolerance
[ value | infinite ]
noaccept-tolerance
[ value | infinite ]
Syntax Description
value
(Optional) Tolerance range, in seconds. The range is from 1 to 8640000.
infinite
(Optional) Specifies that the tolerance specification is infinite. The
accept key never expires. The tolerance limit of infinite indicates that an
accept key is always acceptable and validated when used by a peer.
Command Default
The default value is 0, which is no tolerance.
Command Modes
Keychain configuration
Command History
Release
Modification
Release 3.4.0
This command was introduced.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
If you do not configure the accept-tolerance command, the
tolerance value is set to zero.
Even though the key is outside the active lifetime, the key is deemed acceptable as long
as it is within the tolerance limit (for example, either prior to the start of the
lifetime, or after the end of the lifetime).
Task ID
Task ID
Operations
system
read, write
Examples
The following example shows how to use the accept-tolerance
command:
To create or modify a keychain key, use the key command in
keychain-key configuration mode. To disable this feature, use the
no form of this command.
keykey-id
nokeykey-id
Syntax Description
key-id
48-bit integer key identifier of from 0 to 281474976710655.
Command Default
No default behavior or values
Command Modes
Keychain-key configuration
Command History
Release
Modification
Release 3.3.0
This command was introduced.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
For a Border Gateway Protocol (BGP) keychain configuration, the
range for the key-id argument must be from 0 to 63. If the
range is above the value of 63, the BGP keychain operation is rejected.
Task ID
Task ID
Operations
system
read, write
Examples
The following example shows how to use the
key command:
To create or modify a keychain, use the key chain command in
global configuration mode. To disable this feature, use the no form of this
command.
keychainkey-chain-name
nokeychainkey-chain-name
Syntax Description
key-chain-name
Specifies the name of the keychain. The maximum number of characters is
48.
Command Default
No default behavior or values
Command Modes
Global configuration
Command History
Release
Modification
Release 3.3.0
This command was introduced.
Release 3.4.1
The maximum number of characters allowed in the keychain name was changed
from 32 to 48.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
You can configure a keychain for Border Gateway Protocol (BGP) as a neighbor,
session
group, or neighbor group. BGP can use the keychain to implement a hitless key
rollover for authentication.
Task ID
Task ID
Operations
system
read, write
Examples
The following example shows that the name of the keychain
isis-keys is for the key chain command:
To specify the text string for the key, use the key-string
command in keychain-key configuration mode. To disable this feature, use the
no form of this command.
key-string
[ clear | password ]
key-string-text
nokey-string
[ clear | password ]
key-string-text
Syntax Description
clear
Specifies the key string in clear-text form.
password
Specifies the key in encrypted form.
key-string-text
Text string for the key, which is encrypted by the parser process before
being saved to the configuration. The text string has the following
character limitations:
Plain-text key strings—Minimum of 1 character and a maximum of 32.
Encrypted key strings—Minimum of 4 characters and no maximum.
Command Default
The default value is clear.
Command Modes
Keychain-key configuration
Command History
Release
Modification
Release 3.7.2
This command was introduced.
Command History
Release
Modification
Release 3.3.0
This command was introduced.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
For an encrypted password to be valid, the following statements
must be true:
String must contain an even number of characters, with a minimum of four.
The first two characters in the password string must be decimal numbers and the rest
must be hexadecimals.
The first two digits must not be a number greater than 53.
Either of the following examples would be valid encrypted
passwords:
1234abcd
or
50aefd
Task ID
Task ID
Operations
system
read, write
Examples
The following example shows how to use the
keystring command:
To send the valid key and to authenticate information from the local host to the peer,
use the send-lifetime command in keychain-key configuration
mode. To disable this feature, use the no form of this
command.
Start time, in hh:mm:ss day month year format, in which the key
becomes valid. The range is from 0:0:0 to 23:59:59.
The range for the number of days of the month to start is from 1 to 31.
The range for the years is from 1993 to 2035.
durationduration value
(Optional) Determines the lifetime of the key in seconds.
infinite
(Optional) Specifies that the key never expires once it becomes valid.
end-time
(Optional) Time, in hh:mm:ss day month year format, after which the
key expires. The range is from 0:0:0 to 23:59:59
Command Default
No default behavior or values
Command Modes
Keychain-key configuration
Command History
Release
Modification
Release 3.3.0
This command was introduced.
Release 3.6.0
The range values were added for the start-time argument.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
Task ID
Task ID
Operations
system
read, write
Examples
The following example shows how to use the
send-lifetime command:
To display the keychain, use the show key chain command in
EXEC mode.
showkeychainkey-chain-name
Syntax Description
key-chain-name
Names of the keys in the specified keychain. The maximum number of
characters is 32.
Command Default
No default behavior or values
Command Modes
EXEC
Command History
Release
Modification
Release 3.3.0
This command was introduced.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
Task ID
Task ID
Operations
system
read
Examples
When a secure key storage becomes available, it is desirable for
keychain management to alternatively prompt you for a master password and display the
key label after decryption. The following example displays only the encrypted key label
for the show key chain command: