Timing and Synchronization Configuration Guide, Cisco IOS XE 17 (Cisco Catalyst IR8340 Rugged Series Router)
Bias-Free Language
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Network Time Protocol (NTP) is a protocol designed to time-synchronize a network of machines. NTP runs on User Datagram Protocol
(UDP), which in turn runs on IP. NTP Version 3 is documented in RFC 1305.
This chapter explains how to configure Network Time Protocol on IR8340.
NTP configuration is supported from Cisco IOS XE Release 17.7.x.
Restrictions for Network Time Protocol
The Network Time Protocol (NTP) package contains a vulnerability that could allow an unauthenticated, remote attacker to cause
a denial of service (DoS) condition. NTP versions 4.2.4p7 and earlier are vulnerable.
The vulnerability is due to an error in handling of certain malformed messages. An unauthenticated, remote attacker could
send a malicious NTP packet with a spoofed source IP address to a vulnerable host. The host that processes the packet sends
a response packet back to the transmitter. This action could start a loop of messages between the two hosts that could cause
both the hosts to consume excessive CPU resources, use up the disk space by writing messages to log files, and consume the
network bandwidth. All of these could cause a DoS condition on the affected hosts.
Cisco software releases that support NTPv4 are not affected. All other versions of Cisco software are affected.
To display whether a device is configured with NTP, use the showrunning-config | includentp command. If the output returns any of the following commands, then that device is vulnerable to the attack:
There are no workarounds for this vulnerability other than disabling NTP on the device. Only packets destined for any configured
IP address on the device can exploit this vulnerability. Transit traffic will not exploit this vulnerability.
Depending on your release, your feature will process NTP mode 7 packets and will display the message “NTP: Receive: dropping
message: Received NTP private mode 7 packet ” if debugs for NTP are enabled. Configure the ntpallowmodeprivate command to process NTP mode 7 packets. This command is disabled by default.
Note
NTP peer authentication is not a workaround and is a vulnerable configuration.
NTP services are disabled on all interfaces by default.
Networking devices running NTP can be configured to operate in a variety of association modes when synchronizing time with
reference time sources. A networking device can obtain time information on a network in two ways: by polling host servers
and by listening to NTP broadcasts.
Line Aux 0 option is disabled by default.
Information About Network Time Protocol
Network Time Protocol
Network Time Protocol (NTP) is a protocol designed to time-synchronize a network of machines. NTP runs on User Datagram Protocol
(UDP), which in turn runs on IP. NTP Version 3 is documented in RFC 1305.
An NTP network usually gets its time from an authoritative time source such as a radio clock or an atomic clock attached to
a time server. NTP then distributes this time across the network. NTP is extremely efficient; no more than one packet per
minute is necessary to synchronize two machines to the accuracy of within a millisecond of one another.
NTP uses the concept of a stratum to describe how many NTP hops away a machine is from an authoritative time source. A stratum
1 time server typically has an authoritative time source (such as a radio or atomic clock, or a Global Positioning System
(GPS) time source) directly attached, a stratum 2 time server receives its time via NTP from a stratum 1 time server, and
so on.
NTP has two ways to avoid synchronizing to a machine whose time may not be accurate. NTP will never synchronize to a machine
that is not in turn synchronized. NTP will compare the time reported by several machines, and will not synchronize to a machine
whose time is significantly different from others, even if its stratum is lower. This strategy effectively builds a self-organizing
tree of NTP servers.
The Cisco implementation of NTP does not support stratum 1 service; that is, you cannot connect to a radio or atomic clock
(for some specific platforms, however, you can connect to a GPS time-source device). Cisco recommends that the time service
for your network be derived from the public NTP servers available in the IP Internet.
If the network is isolated from the Internet, the Cisco implementation of NTP allows a machine to be configured so that it
acts as though it is synchronized via NTP, when in fact it has determined the time using other means. Other machines can then
synchronize to that machine via NTP.
A number of manufacturers include NTP software for their host systems and a publicly available version for systems running
UNIX. This software also allows UNIX-derivative servers to acquire the time directly from an atomic clock, which would subsequently
propagate time information along to Cisco routers.
The communications between machines running NTP (known as associations) are usually statically configured; each machine is
given the IP address of all machines with which it should form associations. Accurate timekeeping is made possible through
exchange of NTP messages between each pair of machines with an association.
However, in a LAN environment, NTP can be configured to use IP broadcast messages instead. This alternative reduces configuration
complexity because each machine can be configured to send or receive broadcast messages. However, the accuracy of timekeeping
is marginally reduced because the information flow is one-way only.
The time kept on a machine is a critical resource, so Cisco strongly recommends that you use the security features of NTP
to avoid the accidental or malicious setting of incorrect time. Two mechanisms are available: an access list-based restriction
scheme and an encrypted authentication mechanism.
When multiple sources of time (Virtual Integrated Network System (VINES), hardware clock, manual configuration) are available,
NTP is always considered to be more authoritative. NTP time overrides the time set by any other method.
NTP services are disabled on all interfaces by default.
For more information about NTP, see the following sections:
Poll-Based NTP Associations
Networking devices running NTP can be configured to operate in variety of association modes when synchronizing time with reference
time sources. A networking device can obtain time information on a network in two ways—by polling host servers and by listening
to NTP broadcasts. This section focuses on the poll-based association modes. Broadcast-based NTP associations are discussed
in the Broadcast-Based NTP Associations section.
The following are the two most commonly used poll-based association modes:
Client mode
Symmetric active mode
The client and the symmetric active modes should be used when NTP is required to provide a high level of time accuracy and
reliability.
When a networking device is operating in the client mode, it polls its assigned time-serving hosts for the current time. The
networking device will then pick a host from among all the polled time servers to synchronize with. Because the relationship
that is established in this case is a client-host relationship, the host will not capture or use any time information sent
by the local client device. This mode is most suited for file-server and workstation clients that are not required to provide
any form of time synchronization to other local clients. Use the ntpserver command to individually specify the time server that you want your networking device to consider synchronizing with and to
set your networking device to operate in the client mode.
When a networking device is operating in the symmetric active mode, it polls its assigned time-serving hosts for the current
time and it responds to polls by its hosts. Because this is a peer-to-peer relationship, the host will also retain time-related
information of the local networking device that it is communicating with. This mode should be used when a number of mutually
redundant servers are interconnected via diverse network paths. Most stratum 1 and stratum 2 servers on the Internet adopt
this form of network setup. Use the ntppeer command to individually specify the time serving hosts that you want your networking device to consider synchronizing with
and to set your networking device to operate in the symmetric active mode.
The specific mode that you should set for each of your networking devices depends primarily on the role that you want them
to assume as a timekeeping device (server or client) and the device’s proximity to a stratum 1 timekeeping server.
A networking device engages in polling when it is operating as a client or a host in the client mode or when it is acting
as a peer in the symmetric active mode. Although polling does not usually place a burden on memory and CPU resources such
as bandwidth, an exceedingly large number of ongoing and simultaneous polls on a system can seriously impact the performance
of a system or slow the performance of a given network. To avoid having an excessive number of ongoing polls on a network,
you should limit the number of direct, peer-to-peer or client-to-server associations. Instead, you should consider using NTP
broadcasts to propagate time information within a localized network.
Broadcast-Based NTP Associations
Broadcast-based NTP associations should be used when time accuracy and reliability requirements are modest and if your network
is localized and has more than 20 clients. Broadcast-based NTP associations are also recommended for use on networks that
have limited bandwidth, system memory, or CPU resources.
A networking device operating in the broadcast client mode does not engage in any polling. Instead, it listens for NTP broadcast
packets that are transmitted by broadcast time servers. Consequently, time accuracy can be marginally reduced because time
information flows only one way.
Use the ntpbroadcastclient command to set your networking device to listen for NTP broadcast packets propagated through a network. For broadcast client
mode to work, the broadcast server and its clients must be located on the same subnet. You must enable the time server that
transmits NTP broadcast packets on the interface of the given device by using the ntpbroadcast command.
NTP Access Group
The access list-based restriction scheme allows you to grant or deny certain access privileges to an entire network, a subnet
within a network, or a host within a subnet. To define an NTP access group, use the ntpaccess-group command in global configuration mode.
The access group options are scanned in the following order, from least restrictive to the most restrictive:
ipv4 —Configures IPv4 access lists.
ipv6 —Configures IPv6 access lists.
peer —Allows time requests and NTP control queries, and allows the system to synchronize itself to a system whose address passes
the access list criteria.
serve —Allows time requests and NTP control queries, but does not allow the system to synchronize itself to a system whose address
passes the access list criteria.
serve-only —Allows only time requests from a system whose address passes the access list criteria.
query-only —Allows only NTP control queries from a system whose address passes the access list criteria.
If the source IP address matches the access lists for more than one access type, the first type is granted access. If no access
groups are specified, all access types are granted access to all systems. If any access groups are specified, only the specified
access types will be granted access.
For details on NTP control queries, see RFC 1305 (NTP Version 3).
The encrypted NTP authentication scheme should be used when a reliable form of access control is required. Unlike the access
list-based restriction scheme that is based on IP addresses, the encrypted authentication scheme uses authentication keys
and an authentication process to determine if NTP synchronization packets sent by designated peers or servers on a local network
are deemed as trusted before the time information that they carry along with them is accepted.
The authentication process begins from the moment an NTP packet is created. Cryptographic checksum keys are generated using
the message digest algorithm 5 (MD5) and are embedded into the NTP synchronization packet that is sent to a receiving client.
Once a packet is received by a client, its cryptographic checksum key is decrypted and checked against a list of trusted keys.
If the packet contains a matching authentication key, the time-stamp information that is contained within the packet is accepted
by the receiving client. NTP synchronization packets that do not contain a matching authenticator key are ignored.
Note
In large networks, where many trusted keys must be configured, the Range of Trusted Key Configuration feature enables configuring
multiple keys simultaneously.
It is important to note that the encryption and decryption processes used in NTP authentication can be very CPU-intensive
and can seriously degrade the accuracy of the time that is propagated within a network. If your network setup permits a more
comprehensive model of access control, you should consider the use of the access list-based form of control.
After NTP authentication is properly configured, your networking device will synchronize with and provide synchronization
only to trusted time sources.
NTP Services on a Specific Interface
Network Time Protocol (NTP) services are disabled on all interfaces by default. NTP is enabled globally when any NTP commands
are entered. You can selectively prevent NTP packets from being received through a specific interface by using the ntpdisable command in interface configuration mode.
Source IP Address for NTP Packets
When the system sends an NTP packet, the source IP address is normally set to the address of the interface through which the
NTP packet is sent. Use the ntpsource interface command in global configuration mode to configure a specific interface from which the IP source address will be
taken.
This interface will be used for the source address for all packets sent to all destinations. If a source address is to be
used for a specific association, use the source keyword in the ntppeer or ntpserver command.
System as an Authoritative NTP Server
Use the ntp command in global configuration mode if you want the system to be an authoritative NTP server, even if the system is not
synchronized to an outside time source.
Note
Use the ntpprimary command with caution. It is very easy to override valid time sources using this command, especially if a low stratum number
is configured. Configuring multiple machines in the same network with the ntpprimary command can cause instability in timekeeping if the machines do not agree on the time.
Router(config)# ntp server 192.168.10.1 version 2 prefer
Forms a server association with another system.
Step 5
end
Example:
Router(config)# end
Exits global configuration mode and returns to privileged EXEC mode.
Configuring Broadcast-Based NTP Associations
SUMMARY STEPS
enable
configure terminal
interfacetype number
ntp broadcast versionnumber
ntp broadcast client
ntp broadcastdelaymicroseconds
end
DETAILED STEPS
Command or Action
Purpose
Step 1
enable
Example:
Router> enable
Enables privileged EXEC mode.
Enter your password if prompted.
Step 2
configure terminal
Example:
Router# configure terminal
Enter global configuration mode.
Step 3
interfacetype number
Example:
Router(config)# interface GigabitEthernet 0/0/0
Configures an interface and enters interface configuration mode.
Step 4
ntp broadcast versionnumber
Example:
Router(config-if)# ntp broadcast version 2
Configures the specified interface to send NTP broadcast packets.
Step 5
ntp broadcast client
Example:
Router(config-if)# ntp broadcast client
Configures the specified interface to receive NTP broadcast packets.
Step 6
ntp broadcastdelaymicroseconds
Example:
Router(config-if)# ntp broadcastdelay 100
Adjusts the estimated round-trip delay for NTP broadcasts.
Step 7
end
Example:
Router(config)# end
Exits interface configuration mode and returns to privileged EXEC mode.
Configuring an External Reference Clock
SUMMARY STEPS
enable
configure terminal
line auxline-number
end
show ntp associations
show ntp status
debug ntp refclock
DETAILED STEPS
Command or Action
Purpose
Step 1
enable
Example:
Router> enable
Enables privileged EXEC mode.
Enter your password if prompted.
Step 2
configure terminal
Example:
Router# configure terminal
Enter global configuration mode.
Step 3
line auxline-number
Example:
Router(config)# line aux 0
Enters line configuration mode for the auxiliary port 0.
Step 4
end
Example:
Router(config-line)# end
Exits line configuration mode and returns to privileged EXEC mode.
Step 5
show ntp associations
Example:
Router# show ntp associations
Displays the status of NTP associations, including the status of the GPS reference clock.
Step 6
show ntp status
Example:
Router# show ntp status
Displays the status of NTP.
Step 7
debug ntp refclock
Example:
Router# debug ntp refclock
Allows advanced monitoring of reference clock activities for the purposes of debugging.
Configuring NTP Authentication
SUMMARY STEPS
enable
configure terminal
ntp authenticate
ntp authentication-keynumbermd5key
ntp authentication-keynumbermd5key
ntp authentication-keynumbermd5key
ntp trusted-keykey-number [- end-key]
ntp serverip-addresskeykey-id
end
DETAILED STEPS
Command or Action
Purpose
Step 1
enable
Example:
Router> enable
Enables privileged EXEC mode.
Enter your password if prompted.
Step 2
configure terminal
Example:
Router# configure terminal
Enter global configuration mode.
Step 3
ntp authenticate
Example:
Router(config)# ntp authenticate
Enables the NTP Authentication feature.
Step 4
ntp authentication-keynumbermd5key
Example:
Router(config)# ntp authentication-key 1 md5 key1
Defines authentication keys.
Each key has a key number, a type, and a value.
Step 5
ntp authentication-keynumbermd5key
Example:
Router(config)# ntp authentication-key 2 md5 key2
Defines authentication keys.
Each key has a key number, a type, and a value.
Step 6
ntp authentication-keynumbermd5key
Example:
Router(config)# ntp authentication-key 3 md5 key3
Defines authentication keys.
Each key has a key number, a type, and a value.
Step 7
ntp trusted-keykey-number [- end-key]
Example:
Router(config)# ntp trusted-key 1 - 3
Defines trusted authentication keys.
If a key is trusted, this device will be ready to synchronize to a system that uses this key in its NTP packets.
Step 8
ntp serverip-addresskeykey-id
Example:
Router(config)# ntp server 172.16.22.44 key 2
Allows the software clock to be synchronized by an NTP time server.
Step 9
end
Example:
Router(config)# end
Exits global configuration mode and returns to privileged EXEC mode.
Verifying Network Time Protocol
show clock [detail]
This command displays the current software clock time. The following is sample output from this command.
Example:
Device# show clock detail
*18:38:21.655 UTC Tue Jan 4 2011
Time source is hardware calendar
show ntp associations detail
This command displays the status of NTP associations. The following is sample output from this command.
Example:
Device# show ntp associations detail
192.168.10.1 configured, insane, invalid, unsynced, stratum 16
ref ID .INIT., time 00000000.00000000 (00:00:00.000 UTC Mon Jan 1 1900)
our mode active, peer mode unspec, our poll intvl 64, peer poll intvl 1024
root delay 0.00 msec, root disp 0.00, reach 0, sync dist 15940.56
delay 0.00 msec, offset 0.0000 msec, dispersion 15937.50
precision 2**24, version 4
org time 00000000.00000000 (00:00:00.000 UTC Mon Jan 1 1900)
rec time 00000000.00000000 (00:00:00.000 UTC Mon Jan 1 1900)
xmt time D0CDE881.9A6A9005 (18:42:09.603 UTC Tue Jan 4 2011)
filtdelay = 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00
filtoffset = 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00
filterror = 16000.0 16000.0 16000.0 16000.0 16000.0 16000.0 16000.0 16000.0
minpoll = 6, maxpoll = 10
192.168.45.1 configured, insane, invalid, unsynced, stratum 16
ref ID .INIT., time 00000000.00000000 (00:00:00.000 UTC Mon Jan 1 1900)
our mode client, peer mode unspec, our poll intvl 64, peer poll intvl 1024
root delay 0.00 msec, root disp 0.00, reach 0, sync dist 16003.08
delay 0.00 msec, offset 0.0000 msec, dispersion 16000.00
precision 2**24, version 4
org time 00000000.00000000 (00:00:00.000 UTC Mon Jan 1 1900)
rec time 00000000.00000000 (00:00:00.000 UTC Mon Jan 1 1900)
xmt time 00000000.00000000 (00:00:00.000 UTC Mon Jan 1 1900)
filtdelay = 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00
filtoffset = 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00
filterror = 16000.0 16000.0 16000.0 16000.0 16000.0 16000.0 16000.0 16000.0
minpoll = 6, maxpoll = 10
show ntp status
This command displays the status of NTP. The following is sample output from this command.
Example:
Device# show ntp status
Clock is synchronized, stratum 8, reference is 127.127.1.1
nominal freq is 250.0000 Hz, actual freq is 250.0000 Hz, precision is 2**10
reference time is D25AF07C.4B439650 (15:26:04.294 PDT Tue Oct 21 2011)
clock offset is 0.0000 msec, root delay is 0.00 msec
root dispersion is 2.31 msec, peer dispersion is 1.20 msec
loopfilter state is 'CTRL' (Normal Controlled Loop), drift is 0.000000000 s/s
system poll interval is 16, last update was 10 sec ago.
Configuration Examples for Network Time Protocol
Example: Configuring Network Time Protocol
In the following example, a device with a hardware clock that has server associations with two other systems sends broadcast
NTP packets, periodically updates the hardware clock, and redistributes time into VINES:
clock timezone PST -8
clock summer-time PDT recurring
ntp server 192.168.13.57
ntp server 192.168.11.58
interface GigabitEthernet 0/0
ntp broadcast
vines time use-system
In the following example, a device with a hardware clock has no outside time source, so it uses the hardware clock as an authoritative time source and distributes the time via NTP broadcast packets:
clock timezone MET 2
clock calendar-valid
ntp master
interface vlan 3
ntp broadcast
The following example shows Line Aux 0 option is disabled by default.
config-register 0x0
reload
rommon 1 > set
rommon 2 > AUX_PORT=1
rommon 3 > SYNC
rommon 4 > reset
rommon 1 > set
rommon 2 > confreg 0x2102
rommon 3 > reset
Network Time Protocol Package Remote Message Loop Denial of Service Vulnerability
Cisco IOS and NX-OS software releases
'White Paper: Cisco IOS and NX-OS Software Reference Guide
Standards and RFCs
Standard/RFCs
Title
RFC 1305
Network Time Protocol (Version 3) Specification, Implementation and Analysis
Technical Assistance
Description
Link
The Cisco Support and Documentation website provides online resources to download documentation, software, and tools. Use
these resources to install and configure the software and to troubleshoot and resolve technical issues with Cisco products
and technologies. Access to most tools on the Cisco Support and Documentation website requires a Cisco.com user ID and password.
The following table provides release information about the feature or features described in this module. This table lists
only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise,
subsequent releases of that software release train also support that feature.
Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature
Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required.
Table 1. Feature Information for Network Time Protocol
Feature Name
Feature Information
Network Time Protocol
NTP is a protocol designed to time-synchronize a network of machines. NTP runs on UDP, which in turn runs on IP. NTP is documented
in RFC 1305.
Feedback