This document describes the configuration file for the NTP Project's -ntpd program. -

Short Contents

NTP's Configuration File User Manual

+ + + + + +

NTP’s Configuration File User Manual

ntp.conf Description -

ntp.conf Notes +

This document describes the configuration file for the NTP Project’s +ntpd program. +

This document applies to version 4.2.8p9-win of ntp.conf. +

+ +

Short Table of Contents

+ +

1 Description

- -

-Previous: Top, -Up: Top -

- -

Description

+ + + + + + +

+ + + +

1 Description

The behavior of ntpd can be changed by a configuration file, by default ntp.conf. - -

-
+ + +

1.1 Notes about ntp.conf

+ + -

Notes about ntp.conf

The +

The ntp.conf configuration file is read at initial startup by the ntpd(1ntpdmdoc) daemon in order to specify the synchronization sources, -modes and other related information. +modes and other related information. Usually, it is installed in the -/etc +/etc directory, but could be installed elsewhere -(see the daemon's +(see the daemon’s -c command line option). - -

The file format is similar to other -unix -configuration files. +

The file format is similar to other +UNIX +configuration files. Comments begin with a -# +‘#’ character and extend to the end of the line; -blank lines are ignored. +blank lines are ignored. Configuration commands consist of an initial keyword followed by a list of arguments, -some of which may be optional, separated by whitespace. -Commands may not be continued over multiple lines. +some of which may be optional, separated by whitespace. +Commands may not be continued over multiple lines. Arguments may be host names, host addresses written in numeric, dotted-quad form, integers, floating point numbers (when specifying times in seconds) and text strings. - -

The rest of this page describes the configuration and control options. +

The rest of this page describes the configuration and control options. The -"Notes on Configuring NTP and Setting up an NTP Subnet" +"Notes on Configuring NTP and Setting up an NTP Subnet" page (available as part of the HTML documentation provided in -/usr/share/doc/ntp) -contains an extended discussion of these options. +/usr/share/doc/ntp) +contains an extended discussion of these options. In addition to the discussion of general -Configuration Options, +‘Configuration Options’, there are sections describing the following supported functionality and the options used to control it: -

Authentication Support -
Monitoring Support -
Access Control Support -
Automatic NTP Configuration Options -
Reference Clock Support -
Miscellaneous Options -

- -

Following these is a section describing -Miscellaneous Options. +

Authentication Support +
Monitoring Support +
Access Control Support +
Automatic NTP Configuration Options +
Reference Clock Support +
Miscellaneous Options +

+ +

Following these is a section describing +Miscellaneous Options. While there is a rich set of options available, the only required option is one or more pool, @@ -131,42 +167,41 @@ the only required option is one or more broadcast or manycastclient -commands. -

+commands. +

-
+ - -

Configuration Support

- + +

1.1.1 Configuration Support

Following is a description of the configuration commands in -NTPv4. +NTPv4. These commands have the same basic functions as in NTPv3 and -in some cases new functions and new arguments. +in some cases new functions and new arguments. There are two classes of commands, configuration commands that configure a persistent association with a remote server or peer or reference clock, and auxiliary commands that specify environmental variables that control various related operations. - -

Configuration Commands

- +

1.1.1.1 Configuration Commands

The various modes are determined by the command keyword and the -type of the required IP address. +type of the required IP address. Addresses are classed by type as (s) a remote server or peer (IPv4 class A, B and C), (b) the broadcast address of a local interface, (m) a multicast address (IPv4 -class D), or (r) a reference clock address (127.127.x.x). +class D), or (r) a reference clock address (127.127.x.x). Note that -only those options applicable to each command are listed below. +only those options applicable to each command are listed below. Use of options not listed may not be caught as an error, but may result in some weird and even destructive behavior. - -

If the Basic Socket Interface Extensions for IPv6 (RFC-2553) +

If the Basic Socket Interface Extensions for IPv6 (RFC-2553) is detected, support for the IPv6 address family is generated -in addition to the default support of the IPv4 address family. +in addition to the default support of the IPv4 address family. In a few cases, including the reslist billboard generated @@ -174,84 +209,96 @@ by ntpq(1ntpqmdoc) or ntpdc(1ntpdcmdoc), -IPv6 addresses are automatically generated. +IPv6 addresses are automatically generated. IPv6 addresses can be identified by the presence of colons -: -in the address field. +“:” +in the address field. IPv6 addresses can be used almost everywhere where IPv4 addresses can be used, with the exception of reference clock addresses, which are always IPv4. - -

Note that in contexts where a host name is expected, a +

Note that in contexts where a host name is expected, a -4 qualifier preceding the host name forces DNS resolution to the IPv4 namespace, while a -6 -qualifier forces DNS resolution to the IPv6 namespace. +qualifier forces DNS resolution to the IPv6 namespace. See IPv6 references for the equivalent classes for that address family. -

pool address [burst] [iburst] [version version] [prefer] [minpoll minpoll] [maxpoll maxpoll]
server address [key key | autokey] [burst] [iburst] [version version] [prefer] [minpoll minpoll] [maxpoll maxpoll] [true]
peer address [key key | autokey] [version version] [prefer] [minpoll minpoll] [maxpoll maxpoll] [true] [xleave]
broadcast address [key key | autokey] [version version] [prefer] [minpoll minpoll] [ttl ttl] [xleave]
manycastclient address [key key | autokey] [version version] [prefer] [minpoll minpoll] [maxpoll maxpoll] [ttl ttl]

pool address [burst] [iburst] [version version] [prefer] [minpoll minpoll] [maxpoll maxpoll]
server address [key key | autokey] [burst] [iburst] [version version] [prefer] [minpoll minpoll] [maxpoll maxpoll] [true]
peer address [key key | autokey] [version version] [prefer] [minpoll minpoll] [maxpoll maxpoll] [true] [xleave]
broadcast address [key key | autokey] [version version] [prefer] [minpoll minpoll] [ttl ttl] [xleave]
manycastclient address [key key | autokey] [version version] [prefer] [minpoll minpoll] [maxpoll maxpoll] [ttl ttl]

These five commands specify the time server name or address to -be used and the mode in which to operate. +

These five commands specify the time server name or address to +be used and the mode in which to operate. The address can be -either a DNS name or an IP address in dotted-quad notation. +either a DNS name or an IP address in dotted-quad notation. Additional information on association behavior can be found in the -"Association Management" +"Association Management" page (available as part of the HTML documentation provided in -/usr/share/doc/ntp). -

pool

For type s addresses, this command mobilizes a persistent -client mode association with a number of remote servers. +/usr/share/doc/ntp). +

pool: For type s addresses, this command mobilizes a persistent +client mode association with a number of remote servers. In this mode the local clock can synchronized to the remote server, but the remote server can never be synchronized to -the local clock. -
server: For type s and r addresses, this command mobilizes a persistent +the local clock. +
server: For type s and r addresses, this command mobilizes a persistent client mode association with the specified remote server or local -radio clock. +radio clock. In this mode the local clock can synchronized to the remote server, but the remote server can never be synchronized to -the local clock. +the local clock. This command should not be used for type -b or m addresses. -
peer: For type s addresses (only), this command mobilizes a +b or m addresses. +
peer: For type s addresses (only), this command mobilizes a persistent symmetric-active mode association with the specified -remote peer. +remote peer. In this mode the local clock can be synchronized to the remote peer or the remote peer can be synchronized to the local -clock. +clock. This is useful in a network of servers where, depending on various failure scenarios, either the local or remote peer may be -the better source of time. +the better source of time. This command should NOT be used for type -b, m or r addresses. -
broadcast: For type b and m addresses (only), this -command mobilizes a persistent broadcast mode association. +b, m or r addresses. +
broadcast: For type b and m addresses (only), this +command mobilizes a persistent broadcast mode association. Multiple commands can be used to specify multiple local broadcast interfaces -(subnets) and/or multiple multicast groups. +(subnets) and/or multiple multicast groups. Note that local broadcast messages go only to the interface associated with the -subnet specified, but multicast messages go to all interfaces. +subnet specified, but multicast messages go to all interfaces. In broadcast mode the local server sends periodic broadcast messages to a client population at the address specified, which is usually the broadcast address on (one of) the -local network(s) or a multicast address assigned to NTP. +local network(s) or a multicast address assigned to NTP. The IANA has assigned the multicast group address IPv4 224.0.1.1 and IPv6 ff05::101 (site local) exclusively to NTP, but other nonconflicting addresses can be used to contain the -messages within administrative boundaries. +messages within administrative boundaries. Ordinarily, this specification applies only to the local server operating as a sender; for operation as a broadcast client, see the @@ -259,65 +306,73 @@ sender; for operation as a broadcast client, see the or multicastclient commands -below. -
manycastclient: For type m addresses (only), this command mobilizes a +below. +
manycastclient: For type m addresses (only), this command mobilizes a manycast client mode association for the multicast address -specified. +specified. In this case a specific address must be supplied which matches the address used on the manycastserver command for -the designated manycast servers. +the designated manycast servers. The NTP multicast address 224.0.1.1 assigned by the IANA should NOT be used, unless specific means are taken to avoid spraying large areas of the Internet with these messages and causing a possibly massive implosion of replies -at the sender. +at the sender. The manycastserver command specifies that the local server is to operate in client mode with the remote servers that are -discovered as the result of broadcast/multicast messages. +discovered as the result of broadcast/multicast messages. The client broadcasts a request message to the group address associated with the specified address and specifically enabled -servers respond to these messages. +servers respond to these messages. The client selects the servers providing the best time and continues as with the server -command. +command. The remaining servers are discarded as if never -heard. +heard. +

Options: -

autokey

All packets sent to and received from the server or peer are to +

Options: +

autokey: All packets sent to and received from the server or peer are to include authentication fields encrypted using the autokey scheme described in -Authentication Options. -
burst: when the server is reachable, send a burst of eight packets -instead of the usual one. +‘Authentication Options’. +
burst: when the server is reachable, send a burst of eight packets +instead of the usual one. The packet spacing is normally 2 s; however, the spacing between the first and second packets can be changed with the calldelay command to allow -additional time for a modem or ISDN call to complete. +additional time for a modem or ISDN call to complete. This is designed to improve timekeeping quality with the server -command and s addresses. -
iburst: When the server is unreachable, send a burst of eight packets -instead of the usual one. +command and s addresses. +
iburst: When the server is unreachable, send a burst of eight packets +instead of the usual one. The packet spacing is normally 2 s; however, the spacing between the first two packets can be changed with the calldelay command to allow -additional time for a modem or ISDN call to complete. +additional time for a modem or ISDN call to complete. This is designed to speed the initial synchronization acquisition with the server @@ -325,167 +380,196 @@ command and s addresses and when ntpd(1ntpdmdoc) is started with the -q -option. -
key key: All packets sent to and received from the server or peer are to +option. +
key key: All packets sent to and received from the server or peer are to include authentication fields encrypted using the specified key -identifier with values from 1 to 65534, inclusive. +identifier with values from 1 to 65534, inclusive. The -default is to include no encryption field. -
minpoll minpoll
maxpoll maxpoll: These options specify the minimum and maximum poll intervals +default is to include no encryption field. +
minpoll minpoll
maxpoll maxpoll: These options specify the minimum and maximum poll intervals for NTP messages, as a power of 2 in seconds The maximum poll interval defaults to 10 (1,024 s), but can be increased by the maxpoll -option to an upper limit of 17 (36.4 h). +option to an upper limit of 17 (36.4 h). The minimum poll interval defaults to 6 (64 s), but can be decreased by the minpoll -option to a lower limit of 4 (16 s). -
noselect: Marks the server as unused, except for display purposes. -The server is discarded by the selection algroithm. -
preempt: Says the association can be preempted. -
true: Marks the server as a truechimer. -Use this option only for testing. -
prefer: Marks the server as preferred. +option to a lower limit of 4 (16 s). +
noselect: Marks the server as unused, except for display purposes. +The server is discarded by the selection algroithm. +
preempt: Says the association can be preempted. +
true: Marks the server as a truechimer. +Use this option only for testing. +
prefer: Marks the server as preferred. All other things being equal, this host will be chosen for synchronization among a set of -correctly operating hosts. +correctly operating hosts. See the -"Mitigation Rules and the prefer Keyword" +"Mitigation Rules and the prefer Keyword" page (available as part of the HTML documentation provided in -/usr/share/doc/ntp) -for further information. -
true: Forces the association to always survive the selection and clustering algorithms. +/usr/share/doc/ntp) +for further information. +
true: Forces the association to always survive the selection and clustering algorithms. This option should almost certainly only -be used while testing an association. -
ttl ttl: This option is used only with broadcast server and manycast -client modes. +be used while testing an association. +
ttl ttl: This option is used only with broadcast server and manycast +client modes. It specifies the time-to-live ttl to use on broadcast server and multicast server and the maximum ttl for the expanding ring search with manycast -client packets. +client packets. Selection of the proper value, which defaults to 127, is something of a black art and should be coordinated with the -network administrator. -
version version: Specifies the version number to be used for outgoing NTP -packets. +network administrator. +
version version: Specifies the version number to be used for outgoing NTP +packets. Versions 1-4 are the choices, with version 4 the -default. -
xleave: Valid in +default. +
xleave: Valid in peer and broadcast -modes only, this flag enables interleave mode. +modes only, this flag enables interleave mode. +

- -

Auxiliary Commands

- -

broadcastclient

This command enables reception of broadcast server messages to -any local interface (type b) address. + +

1.1.1.2 Auxiliary Commands

broadcastclient: This command enables reception of broadcast server messages to +any local interface (type b) address. Upon receiving a message for the first time, the broadcast client measures the nominal server propagation delay using a brief client/server exchange with the server, then enters the broadcast client mode, in which it -synchronizes to succeeding broadcast messages. +synchronizes to succeeding broadcast messages. Note that, in order to avoid accidental or malicious disruption in this mode, both the server and client should operate using symmetric-key or public-key authentication as described in -Authentication Options. -
manycastserver address ...: This command enables reception of manycast client messages to -the multicast group address(es) (type m) specified. +‘Authentication Options’. +
manycastserver address ...: This command enables reception of manycast client messages to +the multicast group address(es) (type m) specified. At least one address is required, but the NTP multicast address 224.0.1.1 assigned by the IANA should NOT be used, unless specific means are taken to limit the span of the reply and avoid a possibly massive -implosion at the original sender. +implosion at the original sender. Note that, in order to avoid accidental or malicious disruption in this mode, both the server and client should operate using symmetric-key or public-key authentication as described in -Authentication Options. -
multicastclient address ...: This command enables reception of multicast server messages to -the multicast group address(es) (type m) specified. +‘Authentication Options’. +
multicastclient address ...: This command enables reception of multicast server messages to +the multicast group address(es) (type m) specified. Upon receiving a message for the first time, the multicast client measures the nominal server propagation delay using a brief client/server exchange with the server, then enters the broadcast client mode, in -which it synchronizes to succeeding multicast messages. +which it synchronizes to succeeding multicast messages. Note that, in order to avoid accidental or malicious disruption in this mode, both the server and client should operate using symmetric-key or public-key authentication as described in -Authentication Options. -
mdnstries number: If we are participating in mDNS, +‘Authentication Options’. +
mdnstries number: If we are participating in mDNS, after we have synched for the first time -we attempt to register with the mDNS system. +we attempt to register with the mDNS system. If that registration attempt fails, we try again at one minute intervals for up to mdnstries -times. +times. After all, ntpd -may be starting before mDNS. +may be starting before mDNS. The default value for mdnstries -is 5. +is 5. +

-
+ - -

Authentication Support

- + +

1.1.2 Authentication Support

Authentication support allows the NTP client to verify that the server is in fact known and trusted and not an intruder intending -accidentally or on purpose to masquerade as that server. +accidentally or on purpose to masquerade as that server. The NTPv3 specification RFC-1305 defines a scheme which provides -cryptographic authentication of received NTP packets. +cryptographic authentication of received NTP packets. Originally, this was done using the Data Encryption Standard (DES) algorithm operating in Cipher Block Chaining (CBC) mode, commonly called -DES-CBC. +DES-CBC. Subsequently, this was replaced by the RSA Message Digest -5 (MD5) algorithm using a private key, commonly called keyed-MD5. +5 (MD5) algorithm using a private key, commonly called keyed-MD5. Either algorithm computes a message digest, or one-way hash, which can be used to verify the server has the correct private key and key identifier. - -

NTPv4 retains the NTPv3 scheme, properly described as symmetric key +

NTPv4 retains the NTPv3 scheme, properly described as symmetric key cryptography and, in addition, provides a new Autokey scheme -based on public key cryptography. +based on public key cryptography. Public key cryptography is generally considered more secure than symmetric key cryptography, since the security is based on a private value which is generated by each server and -never revealed. +never revealed. With Autokey all key distribution and management functions involve only public values, which -considerably simplifies key distribution and storage. +considerably simplifies key distribution and storage. Public key management is based on X.509 certificates, which can be provided by commercial services or produced by utility programs in the OpenSSL software library or the NTPv4 distribution. - -

While the algorithms for symmetric key cryptography are +

While the algorithms for symmetric key cryptography are included in the NTPv4 distribution, public key cryptography requires the OpenSSL software library to be installed -before building the NTP distribution. +before building the NTP distribution. Directions for doing that are on the Building and Installing the Distribution page. - -

Authentication is configured separately for each association +

Authentication is configured separately for each association using the key or @@ -497,36 +581,36 @@ subcommand on the and manycastclient configuration commands as described in -Configuration Options -page. +‘Configuration Options’ +page. The authentication options described below specify the locations of the key files, if other than default, which symmetric keys are trusted and the interval between various operations, if other than default. - -

Authentication is always enabled, +

Authentication is always enabled, although ineffective if not configured as -described below. +described below. If a NTP packet arrives including a message authentication code (MAC), it is accepted only if it -passes all cryptographic checks. +passes all cryptographic checks. The checks require correct key ID, key value -and message digest. +and message digest. If the packet has been modified in any way or replayed by an intruder, it will fail one or more -of these checks and be discarded. +of these checks and be discarded. Furthermore, the Autokey scheme requires a preliminary protocol exchange to obtain the server certificate, verify its credentials and initialize the protocol - -

The +

The auth flag controls whether new associations or -remote configuration commands require cryptographic authentication. +remote configuration commands require cryptographic authentication. This flag can be set or reset by the enable and @@ -535,22 +619,22 @@ commands and also by remote configuration commands sent by a ntpdc(1ntpdcmdoc) program running on -another machine. +another machine. If this flag is enabled, which is the default case, new broadcast client and symmetric passive associations and remote configuration commands must be cryptographically -authenticated using either symmetric key or public key cryptography. +authenticated using either symmetric key or public key cryptography. If this flag is disabled, these operations are effective even if not cryptographic -authenticated. +authenticated. It should be understood that operating with the auth flag disabled invites a significant vulnerability where a rogue hacker can masquerade as a falseticker and seriously -disrupt system timekeeping. +disrupt system timekeeping. It is important to note that this flag has no purpose other than to allow or disallow @@ -559,42 +643,41 @@ and symmetric active messages and remote configuration commands and, in particular, the flag has no effect on the authentication process itself. - -

An attractive alternative where multicast support is available +

An attractive alternative where multicast support is available is manycast mode, in which clients periodically troll for servers as described in the Automatic NTP Configuration Options -page. +page. Either symmetric key or public key -cryptographic authentication can be used in this mode. +cryptographic authentication can be used in this mode. The principle advantage of manycast mode is that potential servers need not be configured in advance, since the client finds them during regular operation, and the configuration files for all clients can be identical. - -

The security model and protocol schemes for +

The security model and protocol schemes for both symmetric key and public key cryptography are summarized below; further details are in the briefings, papers and reports at the NTP project page linked from http://www.ntp.org/. - -

Symmetric-Key Cryptography

- +

1.1.2.1 Symmetric-Key Cryptography

The original RFC-1305 specification allows any one of possibly 65,534 keys, each distinguished by a 32-bit key identifier, to -authenticate an association. +authenticate an association. The servers and clients involved must agree on the key and key identifier to -authenticate NTP packets. +authenticate NTP packets. Keys and related information are specified in a key file, usually called -ntp.keys, +ntp.keys, which must be distributed and stored using -secure means beyond the scope of the NTP protocol itself. +secure means beyond the scope of the NTP protocol itself. Besides the keys used for ordinary NTP associations, additional keys can be used as passwords for the @@ -602,25 +685,25 @@ additional keys can be used as passwords for the and ntpdc(1ntpdcmdoc) utility programs. - -

When +

When ntpd(1ntpdmdoc) is first started, it reads the key file specified in the keys configuration command and installs the keys -in the key cache. +in the key cache. However, individual keys must be activated with the trusted -command before use. +command before use. This allows, for instance, the installation of possibly several batches of keys and then activating or deactivating each batch remotely using -ntpdc(1ntpdcmdoc). +ntpdc(1ntpdcmdoc). This also provides a revocation capability that can be used -if a key becomes compromised. +if a key becomes compromised. The requestkey command selects the key used as the password for the @@ -630,121 +713,118 @@ utility, while the command selects the key used as the password for the ntpq(1ntpqmdoc) utility. - -

Public Key Cryptography

- +

1.1.2.2 Public Key Cryptography

NTPv4 supports the original NTPv3 symmetric key scheme described in RFC-1305 and in addition the Autokey protocol, -which is based on public key cryptography. +which is based on public key cryptography. The Autokey Version 2 protocol described on the Autokey Protocol page verifies packet integrity using MD5 message digests and verifies the source with digital signatures and any of several -digest/signature schemes. +digest/signature schemes. Optional identity schemes described on the Identity Schemes page and based on cryptographic challenge/response algorithms -are also available. +are also available. Using all of these schemes provides strong security against replay with or without modification, spoofing, masquerade and most forms of clogging attacks. - -

The Autokey protocol has several modes of operation -corresponding to the various NTP modes supported. +

The Autokey protocol has several modes of operation +corresponding to the various NTP modes supported. Most modes use a special cookie which can be computed independently by the client and server, -but encrypted in transmission. +but encrypted in transmission. All modes use in addition a variant of the S-KEY scheme, in which a pseudo-random key list is generated and used -in reverse order. +in reverse order. These schemes are described along with an executive summary, current status, briefing slides and reading list on the -Autonomous Authentication +‘Autonomous Authentication’ page. - -

The specific cryptographic environment used by Autokey servers +

The specific cryptographic environment used by Autokey servers and clients is determined by a set of files and soft links generated by the ntp-keygen(1ntpkeygenmdoc) -program. +program. This includes a required host key file, required certificate file and optional sign key file, -leapsecond file and identity scheme files. +leapsecond file and identity scheme files. The digest/signature scheme is specified in the X.509 certificate -along with the matching sign key. +along with the matching sign key. There are several schemes available in the OpenSSL software library, each identified by a specific string such as md5WithRSAEncryption, which stands for the MD5 message digest with RSA -encryption scheme. +encryption scheme. The current NTP distribution supports all the schemes in the OpenSSL library, including those based on RSA and DSA digital signatures. - -

NTP secure groups can be used to define cryptographic compartments -and security hierarchies. +

NTP secure groups can be used to define cryptographic compartments +and security hierarchies. It is important that every host in the group be able to construct a certificate trail to one -or more trusted hosts in the same group. +or more trusted hosts in the same group. Each group host runs the Autokey protocol to obtain the certificates -for all hosts along the trail to one or more trusted hosts. +for all hosts along the trail to one or more trusted hosts. This requires the configuration file in all hosts to be engineered so that, even under anticipated failure conditions, the NTP subnet will form such that every group host can find a trail to at least one trusted host. - -

Naming and Addressing

- +

1.1.2.3 Naming and Addressing

It is important to note that Autokey does not use DNS to -resolve addresses, since DNS can't be completely trusted -until the name servers have synchronized clocks. +resolve addresses, since DNS can’t be completely trusted +until the name servers have synchronized clocks. The cryptographic name used by Autokey to bind the host identity credentials and cryptographic values must be independent -of interface, network and any other naming convention. +of interface, network and any other naming convention. The name appears in the host certificate in either or both the subject and issuer fields, so protection against DNS compromise is essential. - -

By convention, the name of an Autokey host is the name returned +

By convention, the name of an Autokey host is the name returned by the Unix gethostname(2) -system call or equivalent in other systems. +system call or equivalent in other systems. By the system design -model, there are no provisions to allow alternate names or aliases. +model, there are no provisions to allow alternate names or aliases. However, this is not to say that DNS aliases, different names for each interface, etc., are constrained in any way. - -

It is also important to note that Autokey verifies authenticity +

It is also important to note that Autokey verifies authenticity using the host name, network address and public keys, all of which are bound together by the protocol specifically -to deflect masquerade attacks. +to deflect masquerade attacks. For this reason Autokey includes the source and destination IP addresses in message digest computations and so the same addresses must be available -at both the server and client. +at both the server and client. For this reason operation -with network address translation schemes is not possible. +with network address translation schemes is not possible. This reflects the intended robust security model where government and corporate NTP servers are operated outside firewall perimeters. - -

Operation

- +

1.1.2.4 Operation

A specific combination of authentication scheme (none, symmetric key, public key) and identity scheme is called -a cryptotype, although not all combinations are compatible. +a cryptotype, although not all combinations are compatible. There may be management configurations where the clients, -servers and peers may not all support the same cryptotypes. +servers and peers may not all support the same cryptotypes. A secure NTPv4 subnet can be configured in many ways while keeping in mind the principles explained above and -in this section. +in this section. Note however that some cryptotype combinations may successfully interoperate with each other, but may not represent good security practice. - -

The cryptotype of an association is determined at the time +

The cryptotype of an association is determined at the time of mobilization, either at configuration time or some time -later when a message of appropriate cryptotype arrives. +later when a message of appropriate cryptotype arrives. When mobilized by a server or @@ -761,513 +841,609 @@ using the symmetric key ID specified; if the autokey subcommand is present, the association is authenticated using Autokey. - -

When multiple identity schemes are supported in the Autokey -protocol, the first message exchange determines which one is used. +

When multiple identity schemes are supported in the Autokey +protocol, the first message exchange determines which one is used. The client request message contains bits corresponding -to which schemes it has available. +to which schemes it has available. The server response message -contains bits corresponding to which schemes it has available. +contains bits corresponding to which schemes it has available. Both server and client match the received bits with their own and select a common scheme. - -

Following the principle that time is a public value, +

Following the principle that time is a public value, a server responds to any client packet that matches -its cryptotype capabilities. +its cryptotype capabilities. Thus, a server receiving an unauthenticated packet will respond with an unauthenticated packet, while the same server receiving a packet of a cryptotype -it supports will respond with packets of that cryptotype. +it supports will respond with packets of that cryptotype. However, unconfigured broadcast or manycast client associations or symmetric passive associations will not be mobilized unless the server supports a cryptotype compatible -with the first packet received. +with the first packet received. By default, unauthenticated associations will not be mobilized unless overridden in a decidedly dangerous way. - -

Some examples may help to reduce confusion. -Client Alice has no specific cryptotype selected. -Server Bob has both a symmetric key file and minimal Autokey files. -Alice's unauthenticated messages arrive at Bob, who replies with -unauthenticated messages. -Cathy has a copy of Bob's symmetric -key file and has selected key ID 4 in messages to Bob. -Bob verifies the message with his key ID 4. -If it's the +

Some examples may help to reduce confusion. +Client Alice has no specific cryptotype selected. +Server Bob has both a symmetric key file and minimal Autokey files. +Alice’s unauthenticated messages arrive at Bob, who replies with +unauthenticated messages. +Cathy has a copy of Bob’s symmetric +key file and has selected key ID 4 in messages to Bob. +Bob verifies the message with his key ID 4. +If it’s the same key and the message is verified, Bob sends Cathy a reply -authenticated with that key. +authenticated with that key. If verification fails, Bob sends Cathy a thing called a crypto-NAK, which tells her -something broke. +something broke. She can see the evidence using the ntpq(1ntpqmdoc) program. - -

Denise has rolled her own host key and certificate. -She also uses one of the identity schemes as Bob. +

Denise has rolled her own host key and certificate. +She also uses one of the identity schemes as Bob. She sends the first Autokey message to Bob and they -both dance the protocol authentication and identity steps. +both dance the protocol authentication and identity steps. If all comes out okay, Denise and Bob continue as described above. - -

It should be clear from the above that Bob can support +

It should be clear from the above that Bob can support all the girls at the same time, as long as he has compatible -authentication and identity credentials. +authentication and identity credentials. Now, Bob can act just like the girls in his own choice of servers; he can run multiple configured associations with multiple different -servers (or the same server, although that might not be useful). +servers (or the same server, although that might not be useful). But, wise security policy might preclude some cryptotype combinations; for instance, running an identity scheme with one server and no authentication with another might not be wise. - -

Key Management

- +

1.1.2.5 Key Management

The cryptographic values used by the Autokey protocol are incorporated as a set of files generated by the ntp-keygen(1ntpkeygenmdoc) utility program, including symmetric key, host key and public certificate files, as well as sign key, identity parameters -and leapseconds files. +and leapseconds files. Alternatively, host and sign keys and certificate files can be generated by the OpenSSL utilities and certificates can be imported from public certificate -authorities. +authorities. Note that symmetric keys are necessary for the ntpq(1ntpqmdoc) and ntpdc(1ntpdcmdoc) -utility programs. +utility programs. The remaining files are necessary only for the Autokey protocol. - -

Certificates imported from OpenSSL or public certificate -authorities have certian limitations. +

Certificates imported from OpenSSL or public certificate +authorities have certian limitations. The certificate should be in ASN.1 syntax, X.509 Version 3 format and encoded in PEM, which is the same format -used by OpenSSL. +used by OpenSSL. The overall length of the certificate encoded -in ASN.1 must not exceed 1024 bytes. +in ASN.1 must not exceed 1024 bytes. The subject distinguished name field (CN) is the fully qualified name of the host -on which it is used; the remaining subject fields are ignored. +on which it is used; the remaining subject fields are ignored. The certificate extension fields must not contain either a subject key identifier or a issuer key identifier field; however, an extended key usage field for a trusted host must contain the value -trustRoot;. +trustRoot;. Other extension fields are ignored. - -

Authentication Commands

- -

autokey [logsec]

Specifies the interval between regenerations of the session key -list used with the Autokey protocol. +

1.1.2.6 Authentication Commands

autokey [logsec]

Specifies the interval between regenerations of the session key +list used with the Autokey protocol. Note that the size of the key list for each association depends on this interval and the current -poll interval. -The default value is 12 (4096 s or about 1.1 hours). +poll interval. +The default value is 12 (4096 s or about 1.1 hours). For poll intervals above the specified interval, a session key list with a single entry will be regenerated for every message -sent. -

controlkey key

Specifies the key identifier to use with the +sent. +

controlkey key

Specifies the key identifier to use with the ntpq(1ntpqmdoc) utility, which uses the standard -protocol defined in RFC-1305. +protocol defined in RFC-1305. The key argument is the key identifier for a trusted key, where the value can be in the -range 1 to 65,534, inclusive. -

crypto [cert file] [leap file] [randfile file] [host file] [sign file] [gq file] [gqpar file] [iffpar file] [mvpar file] [pw password]

This command requires the OpenSSL library. +range 1 to 65,534, inclusive. +

crypto [cert file] [leap file] [randfile file] [host file] [sign file] [gq file] [gqpar file] [iffpar file] [mvpar file] [pw password]

This command requires the OpenSSL library. It activates public key cryptography, selects the message digest and signature encryption scheme and loads the required private and public -values described above. +values described above. If one or more files are left unspecified, -the default names are used as described above. +the default names are used as described above. Unless the complete path and name of the file are specified, the location of a file is relative to the keys directory specified in the keysdir command or default -/usr/local/etc. +/usr/local/etc. Following are the subcommands: -

cert file

Specifies the location of the required host public certificate file. +

cert file: Specifies the location of the required host public certificate file. This overrides the link -ntpkey_cert_hostname -in the keys directory. -
gqpar file: Specifies the location of the optional GQ parameters file. +ntpkey_cert_hostname +in the keys directory. +
gqpar file: Specifies the location of the optional GQ parameters file. This overrides the link -ntpkey_gq_hostname -in the keys directory. -
host file: Specifies the location of the required host key file. +ntpkey_gq_hostname +in the keys directory. +
host file: Specifies the location of the required host key file. This overrides the link -ntpkey_key_hostname -in the keys directory. -
iffpar file: Specifies the location of the optional IFF parameters file. +ntpkey_key_hostname +in the keys directory. +
iffpar file: Specifies the location of the optional IFF parameters file. This overrides the link -ntpkey_iff_hostname -in the keys directory. -
leap file: Specifies the location of the optional leapsecond file. +ntpkey_iff_hostname +in the keys directory. +
leap file: Specifies the location of the optional leapsecond file. This overrides the link -ntpkey_leap -in the keys directory. -
mvpar file: Specifies the location of the optional MV parameters file. +ntpkey_leap +in the keys directory. +
mvpar file: Specifies the location of the optional MV parameters file. This overrides the link -ntpkey_mv_hostname -in the keys directory. -
pw password: Specifies the password to decrypt files containing private keys and -identity parameters. +ntpkey_mv_hostname +in the keys directory. +
pw password: Specifies the password to decrypt files containing private keys and +identity parameters. This is required only if these files have been -encrypted. -
randfile file: Specifies the location of the random seed file used by the OpenSSL -library. -The defaults are described in the main text above. -
sign file: Specifies the location of the optional sign key file. +encrypted. +
randfile file: Specifies the location of the random seed file used by the OpenSSL +library. +The defaults are described in the main text above. +
sign file: Specifies the location of the optional sign key file. This overrides the link -ntpkey_sign_hostname -in the keys directory. +ntpkey_sign_hostname +in the keys directory. If this file is -not found, the host key is also the sign key. +not found, the host key is also the sign key. +

keys keyfile

Specifies the complete path and location of the MD5 key file +

keys keyfile

Specifies the complete path and location of the MD5 key file containing the keys and key identifiers used by ntpd(1ntpdmdoc), ntpq(1ntpqmdoc) and ntpdc(1ntpdcmdoc) -when operating with symmetric key cryptography. +when operating with symmetric key cryptography. This is the same operation as the -k -command line option. -

keysdir path

This command specifies the default directory path for -cryptographic keys, parameters and certificates. +command line option. +

keysdir path

This command specifies the default directory path for +cryptographic keys, parameters and certificates. The default is -/usr/local/etc/. -

requestkey key

Specifies the key identifier to use with the +/usr/local/etc/. +

requestkey key

Specifies the key identifier to use with the ntpdc(1ntpdcmdoc) utility program, which uses a proprietary protocol specific to this implementation of -ntpd(1ntpdmdoc). +ntpd(1ntpdmdoc). The key argument is a key identifier for the trusted key, where the value can be in the range 1 to -65,534, inclusive. -

revoke logsec

Specifies the interval between re-randomization of certain +65,534, inclusive. +

revoke logsec

Specifies the interval between re-randomization of certain cryptographic values used by the Autokey scheme, as a power of 2 in -seconds. +seconds. These values need to be updated frequently in order to deflect brute-force attacks on the algorithms of the scheme; -however, updating some values is a relatively expensive operation. -The default interval is 16 (65,536 s or about 18 hours). +however, updating some values is a relatively expensive operation. +The default interval is 16 (65,536 s or about 18 hours). For poll intervals above the specified interval, the values will be updated -for every message sent. -

trustedkey key ...

Specifies the key identifiers which are trusted for the +for every message sent. +

trustedkey key ...

Specifies the key identifiers which are trusted for the purposes of authenticating peers with symmetric key cryptography, as well as keys used by the ntpq(1ntpqmdoc) and ntpdc(1ntpdcmdoc) -programs. +programs. The authentication procedures require that both the local and remote servers share the same key and key identifier for this purpose, although different keys can be used with different -servers. +servers. The key arguments are 32-bit unsigned -integers with values from 1 to 65,534. +integers with values from 1 to 65,534. +

- -

Error Codes

- + +

1.1.2.7 Error Codes

The following error codes are reported via the NTP control and monitoring protocol trap mechanism. -

101

(bad field format or length) -The packet has invalid version, length or format. -

102

(bad timestamp) -The packet timestamp is the same or older than the most recent received. -This could be due to a replay or a server clock time step. -

103

(bad filestamp) -The packet filestamp is the same or older than the most recent received. -This could be due to a replay or a key file generation error. -

104

(bad or missing public key) -The public key is missing, has incorrect format or is an unsupported type. -

105

(unsupported digest type) -The server requires an unsupported digest/signature scheme. -

106

(mismatched digest types) -Not used. -

107

(bad signature length) -The signature length does not match the current public key. -

108

(signature not verified) -The message fails the signature check. +

101: (bad field format or length) +The packet has invalid version, length or format. +
102: (bad timestamp) +The packet timestamp is the same or older than the most recent received. +This could be due to a replay or a server clock time step. +
103: (bad filestamp) +The packet filestamp is the same or older than the most recent received. +This could be due to a replay or a key file generation error. +
104: (bad or missing public key) +The public key is missing, has incorrect format or is an unsupported type. +
105: (unsupported digest type) +The server requires an unsupported digest/signature scheme. +
106: (mismatched digest types) +Not used. +
107: (bad signature length) +The signature length does not match the current public key. +
108: (signature not verified) +The message fails the signature check. It could be bogus or signed by a -different private key. -
109: (certificate not verified) -The certificate is invalid or signed with the wrong key. -
110: (certificate not verified) +different private key. +
109: (certificate not verified) +The certificate is invalid or signed with the wrong key. +
110: (certificate not verified) The certificate is not yet valid or has expired or the signature could not -be verified. -
111: (bad or missing cookie) -The cookie is missing, corrupted or bogus. -
112: (bad or missing leapseconds table) -The leapseconds table is missing, corrupted or bogus. -
113: (bad or missing certificate) -The certificate is missing, corrupted or bogus. -
114: (bad or missing identity) -The identity key is missing, corrupt or bogus. +be verified. +
111: (bad or missing cookie) +The cookie is missing, corrupted or bogus. +
112: (bad or missing leapseconds table) +The leapseconds table is missing, corrupted or bogus. +
113: (bad or missing certificate) +The certificate is missing, corrupted or bogus. +
114: (bad or missing identity) +The identity key is missing, corrupt or bogus. +

-
+ - -

Monitoring Support

- + +

1.1.3 Monitoring Support

ntpd(1ntpdmdoc) includes a comprehensive monitoring facility suitable for continuous, long term recording of server and client -timekeeping performance. +timekeeping performance. See the statistics command below for a listing and example of each type of statistics currently -supported. +supported. Statistic files are managed using file generation sets and scripts in the -./scripts -directory of the source code distribution. +./scripts +directory of the source code distribution. Using these facilities and -unix +UNIX cron(8) jobs, the data can be automatically summarized and archived for retrospective analysis. - -

Monitoring Commands

- -

statistics name ...

Enables writing of statistics records. +

1.1.3.1 Monitoring Commands

statistics name ...

Enables writing of statistics records. Currently, eight kinds of name statistics are supported. -

clockstats

Enables recording of clock driver statistics information. +

clockstats

Enables recording of clock driver statistics information. Each update received from a clock driver appends a line of the following form to the file generation set named clockstats: -

          
-          49213 525.624 127.127.4.1 93 226 00:08:29.606 D
-

- -

The first two fields show the date (Modified Julian Day) and time -(seconds and fraction past UTC midnight). +

49213 525.624 127.127.4.1 93 226 00:08:29.606 D
+

The first two fields show the date (Modified Julian Day) and time +(seconds and fraction past UTC midnight). The next field shows the -clock address in dotted-quad notation. +clock address in dotted-quad notation. The final field shows the last timecode received from the clock in decoded ASCII format, where -meaningful. +meaningful. In some clock drivers a good deal of additional information -can be gathered and displayed as well. +can be gathered and displayed as well. See information specific to each -clock for further details. -

cryptostats

This option requires the OpenSSL cryptographic software library. +clock for further details. +

cryptostats

This option requires the OpenSSL cryptographic software library. It -enables recording of cryptographic public key protocol information. +enables recording of cryptographic public key protocol information. Each message received by the protocol module appends a line of the following form to the file generation set named cryptostats: -

          
-          49213 525.624 127.127.4.1 message
-

- -

The first two fields show the date (Modified Julian Day) and time -(seconds and fraction past UTC midnight). +

49213 525.624 127.127.4.1 message
+

The first two fields show the date (Modified Julian Day) and time +(seconds and fraction past UTC midnight). The next field shows the peer address in dotted-quad notation, The final message field includes the -message type and certain ancillary information. +message type and certain ancillary information. See the -Authentication Options -section for further information. -

loopstats

Enables recording of loop filter statistics information. +‘Authentication Options’ +section for further information. +

loopstats

Enables recording of loop filter statistics information. Each update of the local clock outputs a line of the following form to the file generation set named loopstats: -

          
-          50935 75440.031 0.000006019 13.778190 0.000351733 0.0133806
-

- -

The first two fields show the date (Modified Julian Day) and -time (seconds and fraction past UTC midnight). +

50935 75440.031 0.000006019 13.778190 0.000351733 0.0133806
+

The first two fields show the date (Modified Julian Day) and +time (seconds and fraction past UTC midnight). The next five fields show time offset (seconds), frequency offset (parts per million - PPM), RMS jitter (seconds), Allan deviation (PPM) and clock -discipline time constant. -

peerstats

Enables recording of peer statistics information. +discipline time constant. +

peerstats

Enables recording of peer statistics information. This includes statistics records of all peers of a NTP server and of special -signals, where present and configured. +signals, where present and configured. Each valid update appends a line of the following form to the current element of a file generation set named peerstats: -

          
-          48773 10847.650 127.127.4.1 9714 -0.001605376 0.000000000 0.001424877 0.000958674
-

- -

The first two fields show the date (Modified Julian Day) and -time (seconds and fraction past UTC midnight). +

48773 10847.650 127.127.4.1 9714 -0.001605376 0.000000000 0.001424877 0.000958674
+

The first two fields show the date (Modified Julian Day) and +time (seconds and fraction past UTC midnight). The next two fields show the peer address in dotted-quad notation and status, -respectively. +respectively. The status field is encoded in hex in the format -described in Appendix A of the NTP specification RFC 1305. +described in Appendix A of the NTP specification RFC 1305. The final four fields show the offset, -delay, dispersion and RMS jitter, all in seconds. -

rawstats

Enables recording of raw-timestamp statistics information. +delay, dispersion and RMS jitter, all in seconds. +

rawstats

Enables recording of raw-timestamp statistics information. This includes statistics records of all peers of a NTP server and of -special signals, where present and configured. +special signals, where present and configured. Each NTP message received from a peer or clock driver appends a line of the following form to the file generation set named rawstats: -

          
-          50928 2132.543 128.4.1.1 128.4.1.20 3102453281.584327000 3102453281.58622800031 02453332.540806000 3102453332.541458000
-

- -

The first two fields show the date (Modified Julian Day) and -time (seconds and fraction past UTC midnight). +

50928 2132.543 128.4.1.1 128.4.1.20 3102453281.584327000 3102453281.58622800031 02453332.540806000 3102453332.541458000
+

The first two fields show the date (Modified Julian Day) and +time (seconds and fraction past UTC midnight). The next two fields show the remote peer or clock address followed by the local address -in dotted-quad notation. +in dotted-quad notation. The final four fields show the originate, -receive, transmit and final NTP timestamps in order. +receive, transmit and final NTP timestamps in order. The timestamp values are as received and before processing by the various data -smoothing and mitigation algorithms. -

sysstats

Enables recording of ntpd statistics counters on a periodic basis. +smoothing and mitigation algorithms. +

sysstats

Enables recording of ntpd statistics counters on a periodic basis. Each hour a line of the following form is appended to the file generation set named sysstats: -

          
-          50928 2132.543 36000 81965 0 9546 56 71793 512 540 10 147
-

- -

The first two fields show the date (Modified Julian Day) and time -(seconds and fraction past UTC midnight). +

50928 2132.543 36000 81965 0 9546 56 71793 512 540 10 147
+

The first two fields show the date (Modified Julian Day) and time +(seconds and fraction past UTC midnight). The remaining ten fields show the statistics counter values accumulated since the last generated line. -

Time since restart 36000

Time in hours since the system was last rebooted. -

Packets received 81965

Total number of packets received. -

Packets processed 0

Number of packets received in response to previous packets sent -

Current version 9546

Number of packets matching the current NTP version. -

Previous version 56

Number of packets matching the previous NTP version. -

Bad version 71793

Number of packets matching neither NTP version. -

Access denied 512

Number of packets denied access for any reason. -

Bad length or format 540

Number of packets with invalid length, format or port number. -

Bad authentication 10

Number of packets not verified as authentic. -

Rate exceeded 147

Number of packets discarded due to rate limitation. +

Time since restart 36000: Time in hours since the system was last rebooted. +
Packets received 81965: Total number of packets received. +
Packets processed 0: Number of packets received in response to previous packets sent +
Current version 9546: Number of packets matching the current NTP version. +
Previous version 56: Number of packets matching the previous NTP version. +
Bad version 71793: Number of packets matching neither NTP version. +
Access denied 512: Number of packets denied access for any reason. +
Bad length or format 540: Number of packets with invalid length, format or port number. +
Bad authentication 10: Number of packets not verified as authentic. +
Rate exceeded 147: Number of packets discarded due to rate limitation. +

statsdir directory_path

Indicates the full path of a directory where statistics files -should be created (see below). +

statsdir directory_path

Indicates the full path of a directory where statistics files +should be created (see below). This keyword allows the (otherwise constant) filegen filename prefix to be modified for file generation sets, which -is useful for handling statistics logs. -

filegen name [file filename] [type typename] [link | nolink] [enable | disable]

Configures setting of generation file set name. +is useful for handling statistics logs. +

filegen name [file filename] [type typename] [link | nolink] [enable | disable]

Configures setting of generation file set name. Generation file sets provide a means for handling files that are -continuously growing during the lifetime of a server. -Server statistics are a typical example for such files. +continuously growing during the lifetime of a server. +Server statistics are a typical example for such files. Generation file sets provide access to a set of files used -to store the actual data. +to store the actual data. At any time at most one element -of the set is being written to. +of the set is being written to. The type given specifies -when and how data will be directed to a new element of the set. +when and how data will be directed to a new element of the set. This way, information stored in elements of a file set that are currently unused are available for administrational -operations without the risk of disturbing the operation of ntpd. +operations without the risk of disturbing the operation of ntpd. (Most important: they can be removed to free space for new data produced.) - -

Note that this command can be sent from the +

Note that this command can be sent from the ntpdc(1ntpdcmdoc) program running at a remote location. -

name

This is the type of the statistics records, as shown in the +

name

This is the type of the statistics records, as shown in the statistics -command. -

file filename

This is the file name for the statistics records. +command. +

file filename

This is the file name for the statistics records. Filenames of set members are built from three concatenated elements prefix, filename and suffix: -

prefix

This is a constant filename path. +

prefix: This is a constant filename path. It is not subject to modifications via the filegen -option. +option. It is defined by the -server, usually specified as a compile-time constant. +server, usually specified as a compile-time constant. It may, however, be configurable for individual file generation sets -via other commands. +via other commands. For example, the prefix used with loopstats and peerstats generation can be configured using the statsdir -option explained above. -
filename: This string is directly concatenated to the prefix mentioned +option explained above. +
filename: This string is directly concatenated to the prefix mentioned above (no intervening -/). +‘/’). This can be modified using the file argument to the filegen -statement. +statement. No -.. +.. elements are allowed in this component to prevent filenames referring to parts outside the filesystem hierarchy denoted by -prefix. -
suffix: This part is reflects individual elements of a file set. +prefix. +
suffix: This part is reflects individual elements of a file set. It is -generated according to the type of a file set. +generated according to the type of a file set. +

type typename

A file generation set is characterized by its type. +

type typename

A file generation set is characterized by its type. The following types are supported: -

none

The file set is actually a single plain file. -

pid

One element of file set is used per incarnation of a ntpd -server. +

none: The file set is actually a single plain file. +
pid: One element of file set is used per incarnation of a ntpd +server. This type does not perform any changes to file set members during runtime, however it provides an easy way of separating files belonging to different ntpd(1ntpdmdoc) -server incarnations. +server incarnations. The set member filename is built by appending a -. +‘.’ to concatenated prefix and @@ -1275,377 +1451,423 @@ and strings, and appending the decimal representation of the process ID of the ntpd(1ntpdmdoc) -server process. -
day: One file generation set element is created per day. +server process. +
day: One file generation set element is created per day. A day is -defined as the period between 00:00 and 24:00 UTC. +defined as the period between 00:00 and 24:00 UTC. The file set member suffix consists of a -. +‘.’ and a day specification in the form -YYYYMMdd. +YYYYMMdd. YYYY -is a 4-digit year number (e.g., 1992). +is a 4-digit year number (e.g., 1992). MM -is a two digit month number. +is a two digit month number. dd -is a two digit day number. +is a two digit day number. Thus, all information written at 10 December 1992 would end up in a file named prefix -filename.19921210. -
week: Any file set member contains data related to a certain week of -a year. +filename.19921210. +
week: Any file set member contains data related to a certain week of +a year. The term week is defined by computing day-of-year -modulo 7. +modulo 7. Elements of such a file generation set are distinguished by appending the following suffix to the file set filename base: A dot, a 4-digit year number, the letter W, -and a 2-digit week number. +and a 2-digit week number. For example, information from January, 10th 1992 would end up in a file with suffix -.No . Ns Ar 1992W1 . -
month: One generation file set element is generated per month. +.No . Ns Ar 1992W1 . +
month: One generation file set element is generated per month. The file name suffix consists of a dot, a 4-digit year number, and -a 2-digit month. -
year: One generation file element is generated per year. +a 2-digit month. +
year: One generation file element is generated per year. The filename -suffix consists of a dot and a 4 digit year number. -
age: This type of file generation sets changes to a new element of -the file set every 24 hours of server operation. +suffix consists of a dot and a 4 digit year number. +
age: This type of file generation sets changes to a new element of +the file set every 24 hours of server operation. The filename suffix consists of a dot, the letter a, -and an 8-digit number. +and an 8-digit number. This number is taken to be the number of seconds the server is -running at the start of the corresponding 24-hour period. +running at the start of the corresponding 24-hour period. Information is only written to a file generation by specifying enable; output is prevented by specifying -disable. +disable. +

link | nolink

It is convenient to be able to access the current element of a file -generation set by a fixed name. +

link | nolink

It is convenient to be able to access the current element of a file +generation set by a fixed name. This feature is enabled by specifying link and disabled using -nolink. +nolink. If link is specified, a hard link from the current file set element to a file without -suffix is created. +suffix is created. When there is already a file with this name and the number of links of this file is one, it is renamed appending a dot, the letter C, and the pid of the ntpd(1ntpdmdoc) -server process. +server process. When the -number of links is greater than one, the file is unlinked. +number of links is greater than one, the file is unlinked. This -allows the current file to be accessed by a constant name. -

enable | disable

Enables or disables the recording function. +allows the current file to be accessed by a constant name. +

enable | disable

Enables or disables the recording function. +

-
+ - -

Access Control Support

- + +

1.1.4 Access Control Support

The ntpd(1ntpdmdoc) daemon implements a general purpose address/mask based restriction -list. +list. The list contains address/match entries sorted first -by increasing address values and and then by increasing mask values. +by increasing address values and and then by increasing mask values. A match occurs when the bitwise AND of the mask and the packet source address is equal to the bitwise AND of the mask and -address in the list. +address in the list. The list is searched in order with the last match found defining the restriction flags associated -with the entry. +with the entry. Additional information and examples can be found in the -"Notes on Configuring NTP and Setting up a NTP Subnet" +"Notes on Configuring NTP and Setting up a NTP Subnet" page (available as part of the HTML documentation provided in -/usr/share/doc/ntp). - -

The restriction facility was implemented in conformance +/usr/share/doc/ntp). +

The restriction facility was implemented in conformance with the access policies for the original NSFnet backbone -time servers. +time servers. Later the facility was expanded to deflect -cryptographic and clogging attacks. +cryptographic and clogging attacks. While this facility may be useful for keeping unwanted or broken or malicious clients from congesting innocent servers, it should not be considered -an alternative to the NTP authentication facilities. +an alternative to the NTP authentication facilities. Source address based restrictions are easily circumvented by a determined cracker. - -

Clients can be denied service because they are explicitly +

Clients can be denied service because they are explicitly included in the restrict list created by the restrict command or implicitly as the result of cryptographic or rate limit -violations. +violations. Cryptographic violations include certificate or identity verification failure; rate limit violations generally result from defective NTP implementations that send packets -at abusive rates. +at abusive rates. Some violations cause denied service only for the offending packet, others cause denied service for a timed period and others cause the denied service for -an indefinite period. +an indefinite period. When a client or network is denied access for an indefinite period, the only way at present to remove the restrictions is by restarting the server. - -

The Kiss-of-Death Packet

- +

1.1.4.1 The Kiss-of-Death Packet

Ordinarily, packets denied service are simply dropped with no -further action except incrementing statistics counters. +further action except incrementing statistics counters. Sometimes a more proactive response is needed, such as a server message that explicitly requests the client to stop sending and leave a message -for the system operator. +for the system operator. A special packet format has been created -for this purpose called the "kiss-of-death" (KoD) packet. +for this purpose called the "kiss-of-death" (KoD) packet. KoD packets have the leap bits set unsynchronized and stratum set to zero and the reference identifier field set to a four-byte -ASCII code. +ASCII code. If the noserve or notrust flag of the matching restrict list entry is set, -the code is "DENY"; if the +the code is "DENY"; if the limited flag is set and the rate limit -is exceeded, the code is "RATE". -Finally, if a cryptographic violation occurs, the code is "CRYP". - -

A client receiving a KoD performs a set of sanity checks to +is exceeded, the code is "RATE". +Finally, if a cryptographic violation occurs, the code is "CRYP". +

A client receiving a KoD performs a set of sanity checks to minimize security exposure, then updates the stratum and reference identifier peer variables, sets the access denied (TEST4) bit in the peer flash variable and sends -a message to the log. +a message to the log. As long as the TEST4 bit is set, -the client will send no further packets to the server. +the client will send no further packets to the server. The only way at present to recover from this condition is -to restart the protocol at both the client and server. +to restart the protocol at both the client and server. This -happens automatically at the client when the association times out. +happens automatically at the client when the association times out. It will happen at the server only if the server operator cooperates. - -

Access Control Commands

- -

discard [average avg] [minimum min] [monitor prob]

Set the parameters of the +

1.1.4.2 Access Control Commands

discard [average avg] [minimum min] [monitor prob]

Set the parameters of the limited facility which protects the server from -client abuse. +client abuse. The average subcommand specifies the minimum average packet spacing, while the minimum -subcommand specifies the minimum packet spacing. +subcommand specifies the minimum packet spacing. Packets that violate these minima are discarded -and a kiss-o'-death packet returned if enabled. +and a kiss-o’-death packet returned if enabled. The default -minimum average and minimum are 5 and 2, respectively. +minimum average and minimum are 5 and 2, respectively. The monitor subcommand specifies the probability of discard -for packets that overflow the rate-control window. -

restrict address [mask mask] [flag ...]

The +for packets that overflow the rate-control window. +

restrict address [mask mask] [flag ...]

The address argument expressed in -dotted-quad form is the address of a host or network. +dotted-quad form is the address of a host or network. Alternatively, the address -argument can be a valid host DNS name. +argument can be a valid host DNS name. The mask argument expressed in dotted-quad form defaults to 255.255.255.255, meaning that the address -is treated as the address of an individual host. +is treated as the address of an individual host. A default entry (address 0.0.0.0, mask 0.0.0.0) -is always included and is always the first entry in the list. +is always included and is always the first entry in the list. Note that text string default, with no mask option, may -be used to indicate the default entry. +be used to indicate the default entry. In the current implementation, flag always restricts access, i.e., an entry with no flags indicates that free -access to the server is to be given. +access to the server is to be given. The flags are not orthogonal, in that more restrictive flags will often make less restrictive -ones redundant. +ones redundant. The flags can generally be classed into two categories, those which restrict time service and those which restrict informational queries and attempts to do run-time -reconfiguration of the server. +reconfiguration of the server. One or more of the following flags may be specified: -

ignore

Deny packets of all kinds, including +

ignore: Deny packets of all kinds, including ntpq(1ntpqmdoc) and ntpdc(1ntpdcmdoc) -queries. -
kod: If this flag is set when an access violation occurs, a kiss-o'-death -(KoD) packet is sent. +queries. +
kod: If this flag is set when an access violation occurs, a kiss-o’-death +(KoD) packet is sent. KoD packets are rate limited to no more than one -per second. +per second. If another KoD packet occurs within one second after the -last one, the packet is dropped. -
limited: Deny service if the packet spacing violates the lower limits specified +last one, the packet is dropped. +
limited: Deny service if the packet spacing violates the lower limits specified in the discard -command. +command. A history of clients is kept using the monitoring capability of -ntpd(1ntpdmdoc). +ntpd(1ntpdmdoc). Thus, monitoring is always active as long as there is a restriction entry with the limited -flag. -
lowpriotrap: Declare traps set by matching hosts to be low priority. +flag. +
lowpriotrap: Declare traps set by matching hosts to be low priority. The number of traps a server can maintain is limited (the current limit -is 3). +is 3). Traps are usually assigned on a first come, first served -basis, with later trap requestors being denied service. +basis, with later trap requestors being denied service. This flag modifies the assignment algorithm by allowing low priority traps to -be overridden by later requests for normal priority traps. -
nomodify: Deny +be overridden by later requests for normal priority traps. +
nomodify: Deny ntpq(1ntpqmdoc) and ntpdc(1ntpdcmdoc) queries which attempt to modify the state of the -server (i.e., run time reconfiguration). +server (i.e., run time reconfiguration). Queries which return -information are permitted. -
noquery: Deny +information are permitted. +
noquery: Deny ntpq(1ntpqmdoc) and ntpdc(1ntpdcmdoc) -queries. -Time service is not affected. -
nopeer: Deny packets which would result in mobilizing a new association. +queries. +Time service is not affected. +
nopeer: Deny packets which would result in mobilizing a new association. This includes broadcast and symmetric active packets when a configured -association does not exist. +association does not exist. It also includes pool -associations, so if you want to use servers from a +associations, so if you want to use servers from a pool directive and also want to use nopeer -by default, you'll want a +by default, you’ll want a restrict source ... line as well that does -
not: include the +
not: include the nopeer -directive. -
noserve: Deny all packets except +directive. +
noserve: Deny all packets except ntpq(1ntpqmdoc) and ntpdc(1ntpdcmdoc) -queries. -
notrap: Decline to provide mode 6 control message trap service to matching -hosts. +queries. +
notrap: Decline to provide mode 6 control message trap service to matching +hosts. The trap service is a subsystem of the ntpq(1ntpqmdoc) control message -protocol which is intended for use by remote event logging programs. -
notrust: Deny service unless the packet is cryptographically authenticated. -
ntpport: This is actually a match algorithm modifier, rather than a -restriction flag. +protocol which is intended for use by remote event logging programs. +
notrust: Deny service unless the packet is cryptographically authenticated. +
ntpport: This is actually a match algorithm modifier, rather than a +restriction flag. Its presence causes the restriction entry to be matched only if the source port in the packet is the standard NTP -UDP port (123). +UDP port (123). Both ntpport and non-ntpport may -be specified. +be specified. The ntpport is considered more specific and -is sorted later in the list. -
version: Deny packets that do not match the current NTP version. +is sorted later in the list. +
version: Deny packets that do not match the current NTP version. +

Default restriction list entries with the flags ignore, interface, -ntpport, for each of the local host's interface addresses are +

Default restriction list entries with the flags ignore, interface, +ntpport, for each of the local host’s interface addresses are inserted into the table at startup to prevent the server -from attempting to synchronize to its own time. +from attempting to synchronize to its own time. A default entry is also always present, though if it is otherwise unconfigured; no flags are associated with the default entry (i.e., everything besides your own -NTP server is unrestricted). +NTP server is unrestricted). +

-
+ - -

Automatic NTP Configuration Options

- -

Manycasting

- + +

1.1.5 Automatic NTP Configuration Options

+ +

1.1.5.1 Manycasting

Manycasting is a automatic discovery and configuration paradigm -new to NTPv4. +new to NTPv4. It is intended as a means for a multicast client to troll the nearby network neighborhood to find cooperating manycast servers, validate them using cryptographic means and evaluate their time values with respect to other servers -that might be lurking in the vicinity. +that might be lurking in the vicinity. The intended result is that each manycast client mobilizes -client associations with some number of the "best" +client associations with some number of the "best" of the nearby manycast servers, yet automatically reconfigures to sustain this number of servers should one or another fail. - -

Note that the manycasting paradigm does not coincide +

Note that the manycasting paradigm does not coincide with the anycast paradigm described in RFC-1546, which is designed to find a single server from a clique -of servers providing the same service. +of servers providing the same service. The manycast paradigm is designed to find a plurality of redundant servers satisfying defined optimality criteria. - -

Manycasting can be used with either symmetric key -or public key cryptography. +

Manycasting can be used with either symmetric key +or public key cryptography. The public key infrastructure (PKI) offers the best protection against compromised keys and is generally considered stronger, at least with relatively -large key sizes. +large key sizes. It is implemented using the Autokey protocol and the OpenSSL cryptographic library available from -http://www.openssl.org/. +http://www.openssl.org/. The library can also be used with other NTPv4 modes as well and is highly recommended, especially for broadcast modes. - -

A persistent manycast client association is configured +

A persistent manycast client association is configured using the manycastclient command, which is similar to the @@ -1654,62 +1876,62 @@ command but with a multicast (IPv4 class D or IPv6 prefix FF) -group address. +group address. The IANA has designated IPv4 address 224.1.1.1 -and IPv6 address FF05::101 (site local) for NTP. +and IPv6 address FF05::101 (site local) for NTP. When more servers are needed, it broadcasts manycast client messages to this address at the minimum feasible rate and minimum feasible time-to-live (TTL) hops, depending -on how many servers have already been found. +on how many servers have already been found. There can be as many manycast client associations as different group address, each one serving as a template for a future ephemeral unicast client/server association. - -

Manycast servers configured with the +

Manycast servers configured with the manycastserver command listen on the specified group address for manycast -client messages. +client messages. Note the distinction between manycast client, which actively broadcasts messages, and manycast server, -which passively responds to them. +which passively responds to them. If a manycast server is in scope of the current TTL and is itself synchronized to a valid source and operating at a stratum level equal to or lower than the manycast client, it replies to the manycast client message with an ordinary unicast server message. - -

The manycast client receiving this message mobilizes +

The manycast client receiving this message mobilizes an ephemeral client/server association according to the matching manycast client template, but only if cryptographically authenticated and the server stratum is less than or equal -to the client stratum. +to the client stratum. Authentication is explicitly required -and either symmetric key or public key (Autokey) can be used. +and either symmetric key or public key (Autokey) can be used. Then, the client polls the server at its unicast address in burst mode in order to reliably set the host clock -and validate the source. +and validate the source. This normally results in a volley of eight client/server at 2-s intervals during which both the synchronization and cryptographic -protocols run concurrently. +protocols run concurrently. Following the volley, the client runs the NTP intersection and clustering -algorithms, which act to discard all but the "best" +algorithms, which act to discard all but the "best" associations according to stratum and synchronization -distance. +distance. The surviving associations then continue in ordinary client/server mode. - -

The manycast client polling strategy is designed to reduce +

The manycast client polling strategy is designed to reduce as much as possible the volume of manycast client messages and the effects of implosion due to near-simultaneous -arrival of manycast server messages. +arrival of manycast server messages. The strategy is determined by the manycastclient, tos and ttl -configuration commands. +configuration commands. The manycast poll interval is normally eight times the system poll interval, which starts out at the @@ -1718,17 +1940,17 @@ value specified in the manycastclient, command and, under normal circumstances, increments to the maxpolll -value specified in this command. +value specified in this command. Initially, the TTL is set at the minimum hops specified by the ttl -command. +command. At each retransmission the TTL is increased until reaching the maximum hops specified by this command or a sufficient -number client associations have been found. +number client associations have been found. Further retransmissions use the same TTL. - -

The quality and reliability of the suite of associations +

The quality and reliability of the suite of associations discovered by the manycast client is determined by the NTP mitigation algorithms and the minclock @@ -1736,66 +1958,66 @@ and minsane values specified in the tos -configuration command. +configuration command. At least minsane candidate servers must be available and the mitigation algorithms produce at least minclock -survivors in order to synchronize the clock. +survivors in order to synchronize the clock. Byzantine agreement principles require at least four -candidates in order to correctly discard a single falseticker. +candidates in order to correctly discard a single falseticker. For legacy purposes, minsane defaults to 1 and minclock -defaults to 3. +defaults to 3. For manycast service minsane should be explicitly set to 4, assuming at least that number of servers are available. - -

If at least +

If at least minclock servers are found, the manycast poll interval is immediately set to eight times -maxpoll. +maxpoll. If less than minclock servers are found when the TTL has reached the maximum hops, -the manycast poll interval is doubled. +the manycast poll interval is doubled. For each transmission after that, the poll interval is doubled again until reaching the maximum of eight times -maxpoll. +maxpoll. Further transmissions use the same poll interval and -TTL values. +TTL values. Note that while all this is going on, each client/server association found is operating normally it the system poll interval. - -

Administratively scoped multicast boundaries are normally +

Administratively scoped multicast boundaries are normally specified by the network router configuration and, -in the case of IPv6, the link/site scope prefix. +in the case of IPv6, the link/site scope prefix. By default, the increment for TTL hops is 32 starting from 31; however, the ttl configuration command can be used to modify the values to match the scope rules. - -

It is often useful to narrow the range of acceptable -servers which can be found by manycast client associations. +

It is often useful to narrow the range of acceptable +servers which can be found by manycast client associations. Because manycast servers respond only when the client stratum is equal to or greater than the server stratum, primary (stratum 1) servers fill find only primary servers -in TTL range, which is probably the most common objective. +in TTL range, which is probably the most common objective. However, unless configured otherwise, all manycast clients in TTL range will eventually find all primary servers in TTL range, which is probably not the most common -objective in large networks. +objective in large networks. The tos -command can be used to modify this behavior. +command can be used to modify this behavior. Servers with stratum below floor or above @@ -1807,269 +2029,283 @@ process; however, these servers may be temporally accepted if the number of servers within TTL range is less than minclock. - -

The above actions occur for each manycast client message, -which repeats at the designated poll interval. +

The above actions occur for each manycast client message, +which repeats at the designated poll interval. However, once the ephemeral client association is mobilized, subsequent manycast server replies are discarded, -since that would result in a duplicate association. +since that would result in a duplicate association. If during a poll interval the number of client associations falls below minclock, all manycast client prototype associations are reset to the initial poll interval and TTL hops and operation -resumes from the beginning. +resumes from the beginning. It is important to avoid frequent manycast client messages, since each one requires -all manycast servers in TTL range to respond. +all manycast servers in TTL range to respond. The result could well be an implosion, either minor or major, -depending on the number of servers in range. +depending on the number of servers in range. The recommended value for maxpoll is 12 (4,096 s). - -

It is possible and frequently useful to configure a host -as both manycast client and manycast server. +

It is possible and frequently useful to configure a host +as both manycast client and manycast server. A number of hosts configured this way and sharing a common group address will automatically organize themselves in an optimum configuration based on stratum and -synchronization distance. +synchronization distance. For example, consider an NTP subnet of two primary servers and a hundred or more -dependent clients. +dependent clients. With two exceptions, all servers and clients have identical configuration files including both multicastclient and multicastserver commands using, for instance, multicast group address -239.1.1.1. +239.1.1.1. The only exception is that each primary server configuration file must include commands for the primary reference source such as a GPS receiver. - -

The remaining configuration files for all secondary +

The remaining configuration files for all secondary servers and clients have the same contents, except for the tos -command, which is specific for each stratum level. +command, which is specific for each stratum level. For stratum 1 and stratum 2 servers, that command is -not necessary. +not necessary. For stratum 3 and above servers the floor -value is set to the intended stratum number. +value is set to the intended stratum number. Thus, all stratum 3 configuration files are identical, all stratum 4 files are identical and so forth. - -

Once operations have stabilized in this scenario, +

Once operations have stabilized in this scenario, the primary servers will find the primary reference source and each other, since they both operate at the same stratum (1), but not with any secondary server or client, -since these operate at a higher stratum. +since these operate at a higher stratum. The secondary -servers will find the servers at the same stratum level. +servers will find the servers at the same stratum level. If one of the primary servers loses its GPS receiver, it will continue to operate as a client and other clients will time out the corresponding association and re-associate accordingly. - -

Some administrators prefer to avoid running +

Some administrators prefer to avoid running ntpd(1ntpdmdoc) continuously and run either sntp(1sntpmdoc) or ntpd(1ntpdmdoc) -q -as a cron job. +as a cron job. In either case the servers must be configured in advance and the program fails if none are -available when the cron job runs. +available when the cron job runs. A really slick application of manycast is with ntpd(1ntpdmdoc) --q. +-q. The program wakes up, scans the local landscape looking for the usual suspects, selects the best from among -the rascals, sets the clock and then departs. +the rascals, sets the clock and then departs. Servers do not have to be configured in advance and all clients throughout the network can have the same configuration file. - -

Manycast Interactions with Autokey

- +

1.1.5.2 Manycast Interactions with Autokey

Each time a manycast client sends a client mode packet to a multicast group address, all manycast servers in scope generate a reply including the host name -and status word. +and status word. The manycast clients then run the Autokey protocol, which collects and verifies -all certificates involved. +all certificates involved. Following the burst interval all but three survivors are cast off, -but the certificates remain in the local cache. +but the certificates remain in the local cache. It often happens that several complete signing trails from the client to the primary servers are collected in this way. - -

About once an hour or less often if the poll interval -exceeds this, the client regenerates the Autokey key list. -This is in general transparent in client/server mode. +

About once an hour or less often if the poll interval +exceeds this, the client regenerates the Autokey key list. +This is in general transparent in client/server mode. However, about once per day the server private value used to generate cookies is refreshed along with all -manycast client associations. +manycast client associations. In this case all -cryptographic values including certificates is refreshed. +cryptographic values including certificates is refreshed. If a new certificate has been generated since the last refresh epoch, it will automatically revoke all prior certificates that happen to be in the -certificate cache. +certificate cache. At the same time, the manycast scheme starts all over from the beginning and the expanding ring shrinks to the minimum and increments from there while collecting all servers in scope. - -

Broadcast Options

- -

tos [bcpollbstep gate]

This command provides a way to delay, +

1.1.5.3 Broadcast Options

tos [bcpollbstep gate]

This command provides a way to delay, by the specified number of broadcast poll intervals, -believing backward time steps from a broadcast server. -Broadcast time networks are expected to be trusted. -In the event a broadcast server's time is stepped backwards, +believing backward time steps from a broadcast server. +Broadcast time networks are expected to be trusted. +In the event a broadcast server’s time is stepped backwards, there is clear benefit to having the clients notice this change -as soon as possible. +as soon as possible. Attacks such as replay attacks can happen, however, and even though there are a number of protections built in to -broadcast mode, attempts to perform a replay attack are possible. +broadcast mode, attempts to perform a replay attack are possible. This value defaults to 0, but can be changed to any number of poll intervals between 0 and 4. - -

Manycast Options

- -

tos [ceiling ceiling | cohort { 0 | 1 } | floor floor | minclock minclock | minsane minsane]: This command affects the clock selection and clustering -algorithms. +

+ +

1.1.5.4 Manycast Options

tos [ceiling ceiling | cohort { 0 | 1 } | floor floor | minclock minclock | minsane minsane]

This command affects the clock selection and clustering +algorithms. It can be used to select the quality and quantity of peers used to synchronize the system clock -and is most useful in manycast mode. +and is most useful in manycast mode. The variables operate as follows: -

ceiling ceiling

Peers with strata above +

ceiling ceiling: Peers with strata above ceiling will be discarded if there are at least minclock -peers remaining. +peers remaining. This value defaults to 15, but can be changed -to any number from 1 to 15. -
cohort {0 | 1}: This is a binary flag which enables (0) or disables (1) +to any number from 1 to 15. +
cohort {0 | 1}: This is a binary flag which enables (0) or disables (1) manycast server replies to manycast clients with the same -stratum level. +stratum level. This is useful to reduce implosions where large numbers of clients with the same stratum level -are present. -The default is to enable these replies. -
floor floor: Peers with strata below +are present. +The default is to enable these replies. +
floor floor: Peers with strata below floor will be discarded if there are at least minclock -peers remaining. +peers remaining. This value defaults to 1, but can be changed -to any number from 1 to 15. -
minclock minclock: The clustering algorithm repeatedly casts out outlier +to any number from 1 to 15. +
minclock minclock: The clustering algorithm repeatedly casts out outlier associations until no more than minclock -associations remain. +associations remain. This value defaults to 3, but can be changed to any number from 1 to the number of -configured sources. -
minsane minsane: This is the minimum number of candidates available +configured sources. +
minsane minsane: This is the minimum number of candidates available to the clock selection algorithm in order to produce -one or more truechimers for the clustering algorithm. +one or more truechimers for the clustering algorithm. If fewer than this number are available, the clock is -undisciplined and allowed to run free. +undisciplined and allowed to run free. The default is 1 -for legacy purposes. +for legacy purposes. However, according to principles of Byzantine agreement, minsane should be at least 4 in order to detect and discard -a single falseticker. +a single falseticker. +

ttl hop ...

This command specifies a list of TTL values in increasing -order, up to 8 values can be specified. +

ttl hop ...

This command specifies a list of TTL values in increasing +order, up to 8 values can be specified. In manycast mode these values are used in turn -in an expanding-ring search. +in an expanding-ring search. The default is eight -multiples of 32 starting at 31. +multiples of 32 starting at 31. +

-
+ - -

Reference Clock Support

- -

The NTP Version 4 daemon supports some three dozen different radio, + +

1.1.6 Reference Clock Support

The NTP Version 4 daemon supports some three dozen different radio, satellite and modem reference clocks plus a special pseudo-clock -used for backup or when no other clock source is available. +used for backup or when no other clock source is available. Detailed descriptions of individual device drivers and options can be found in the -"Reference Clock Drivers" +"Reference Clock Drivers" page (available as part of the HTML documentation provided in -/usr/share/doc/ntp). +/usr/share/doc/ntp). Additional information can be found in the pages linked there, including the -"Debugging Hints for Reference Clock Drivers" +"Debugging Hints for Reference Clock Drivers" and -"How To Write a Reference Clock Driver" +"How To Write a Reference Clock Driver" pages (available as part of the HTML documentation provided in -/usr/share/doc/ntp). +/usr/share/doc/ntp). In addition, support for a PPS signal is available as described in the -"Pulse-per-second (PPS) Signal Interfacing" +"Pulse-per-second (PPS) Signal Interfacing" page (available as part of the HTML documentation provided in -/usr/share/doc/ntp). +/usr/share/doc/ntp). Many drivers support special line discipline/streams modules which can -significantly improve the accuracy using the driver. +significantly improve the accuracy using the driver. These are described in the -"Line Disciplines and Streams Drivers" +"Line Disciplines and Streams Drivers" page (available as part of the HTML documentation provided in -/usr/share/doc/ntp). - -

A reference clock will generally (though not always) be a radio +/usr/share/doc/ntp). +

A reference clock will generally (though not always) be a radio timecode receiver which is synchronized to a source of standard time such as the services offered by the NRC in Canada and NIST and -USNO in the US. +USNO in the US. The interface between the computer and the timecode -receiver is device dependent, but is usually a serial port. +receiver is device dependent, but is usually a serial port. A device driver specific to each reference clock must be selected and compiled in the distribution; however, most common radio, satellite -and modem clocks are included by default. +and modem clocks are included by default. Note that an attempt to configure a reference clock when the driver has not been compiled or the hardware port has not been appropriately configured results in a scalding remark to the system log file, but is otherwise non hazardous. - -

For the purposes of configuration, +

For the purposes of configuration, ntpd(1ntpdmdoc) treats reference clocks in a manner analogous to normal NTP peers as much -as possible. +as possible. Reference clocks are identified by a syntactically correct but invalid IP address, in order to distinguish them from -normal NTP peers. +normal NTP peers. Reference clock addresses are of the form 127.127.t.u, where @@ -2078,199 +2314,222 @@ is an integer denoting the clock type and u indicates the unit -number in the range 0-3. +number in the range 0-3. While it may seem overkill, it is in fact sometimes useful to configure multiple reference clocks of the same type, in which case the unit numbers must be unique. - -

The +

The server command is used to configure a reference clock, where the address argument in that command -is the clock address. +is the clock address. The key, version and ttl -options are not used for reference clock support. +options are not used for reference clock support. The mode option is added for reference clock support, as -described below. +described below. The prefer option can be useful to persuade the server to cherish a reference clock with somewhat more -enthusiasm than other reference clocks or peers. +enthusiasm than other reference clocks or peers. Further information on this option can be found in the -"Mitigation Rules and the prefer Keyword" +"Mitigation Rules and the prefer Keyword" (available as part of the HTML documentation provided in -/usr/share/doc/ntp) -page. +/usr/share/doc/ntp) +page. The minpoll and maxpoll options have -meaning only for selected clock drivers. +meaning only for selected clock drivers. See the individual clock driver document pages for additional information. - -

The +

The fudge command is used to provide additional information for individual clock drivers and normally follows immediately after the server -command. +command. The address -argument specifies the clock address. +argument specifies the clock address. The refid and stratum options can be used to -override the defaults for the device. +override the defaults for the device. There are two optional device-dependent time offsets and four flags that can be included in the fudge command as well. - -

The stratum number of a reference clock is by default zero. +

The stratum number of a reference clock is by default zero. Since the ntpd(1ntpdmdoc) daemon adds one to the stratum of each peer, a primary server ordinarily displays an external stratum of -one. +one. In order to provide engineered backups, it is often useful to -specify the reference clock stratum as greater than zero. +specify the reference clock stratum as greater than zero. The stratum -option is used for this purpose. +option is used for this purpose. Also, in cases involving both a reference clock and a pulse-per-second (PPS) discipline signal, it is useful to specify the reference clock -identifier as other than the default, depending on the driver. +identifier as other than the default, depending on the driver. The refid -option is used for this purpose. +option is used for this purpose. Except where noted, these options apply to all clock drivers. - -

Reference Clock Commands

- -

server 127.127.t.u [prefer] [mode int] [minpoll int] [maxpoll int]

This command can be used to configure reference clocks in -special ways. +

1.1.6.1 Reference Clock Commands

server 127.127.t.u [prefer] [mode int] [minpoll int] [maxpoll int]

This command can be used to configure reference clocks in +special ways. The options are interpreted as follows: -

prefer

Marks the reference clock as preferred. +

prefer: Marks the reference clock as preferred. All other things being equal, this host will be chosen for synchronization among a set of -correctly operating hosts. +correctly operating hosts. See the -"Mitigation Rules and the prefer Keyword" +"Mitigation Rules and the prefer Keyword" page (available as part of the HTML documentation provided in -/usr/share/doc/ntp) -for further information. -
mode int: Specifies a mode number which is interpreted in a -device-specific fashion. +/usr/share/doc/ntp) +for further information. +
mode int: Specifies a mode number which is interpreted in a +device-specific fashion. For instance, it selects a dialing protocol in the ACTS driver and a device subtype in the parse -drivers. -
minpoll int
maxpoll int: These options specify the minimum and maximum polling interval +drivers. +
minpoll int
maxpoll int: These options specify the minimum and maximum polling interval for reference clock messages, as a power of 2 in seconds For most directly connected reference clocks, both minpoll and maxpoll -default to 6 (64 s). +default to 6 (64 s). For modem reference clocks, minpoll defaults to 10 (17.1 m) and maxpoll -defaults to 14 (4.5 h). -The allowable range is 4 (16 s) to 17 (36.4 h) inclusive. +defaults to 14 (4.5 h). +The allowable range is 4 (16 s) to 17 (36.4 h) inclusive. +

fudge 127.127.t.u [time1 sec] [time2 sec] [stratum int] [refid string] [mode int] [flag1 0 | 1] [flag2 0 | 1] [flag3 0 | 1] [flag4 0 | 1]

This command can be used to configure reference clocks in -special ways. +

fudge 127.127.t.u [time1 sec] [time2 sec] [stratum int] [refid string] [mode int] [flag1 0 | 1] [flag2 0 | 1] [flag3 0 | 1] [flag4 0 | 1]

This command can be used to configure reference clocks in +special ways. It must immediately follow the server -command which configures the driver. +command which configures the driver. Note that the same capability is possible at run time using the ntpdc(1ntpdcmdoc) -program. +program. The options are interpreted as follows: -

time1 sec

Specifies a constant to be added to the time offset produced by -the driver, a fixed-point decimal number in seconds. +

time1 sec: Specifies a constant to be added to the time offset produced by +the driver, a fixed-point decimal number in seconds. This is used as a calibration constant to adjust the nominal time offset of a particular clock to agree with an external standard, such as a -precision PPS signal. +precision PPS signal. It also provides a way to correct a systematic error or bias due to serial port or operating system -latencies, different cable lengths or receiver internal delay. +latencies, different cable lengths or receiver internal delay. The specified offset is in addition to the propagation delay provided -by other means, such as internal DIPswitches. +by other means, such as internal DIPswitches. Where a calibration for an individual system and driver is available, an approximate -correction is noted in the driver documentation pages. +correction is noted in the driver documentation pages. Note: in order to facilitate calibration when more than one radio clock or PPS signal is supported, a special calibration -feature is available. +feature is available. It takes the form of an argument to the enable command described in Miscellaneous Options page and operates as described in the -"Reference Clock Drivers" +"Reference Clock Drivers" page (available as part of the HTML documentation provided in -/usr/share/doc/ntp). -
time2 secs: Specifies a fixed-point decimal number in seconds, which is -interpreted in a driver-dependent way. +/usr/share/doc/ntp). +
time2 secs: Specifies a fixed-point decimal number in seconds, which is +interpreted in a driver-dependent way. See the descriptions of specific drivers in the -"Reference Clock Drivers" +"Reference Clock Drivers" page (available as part of the HTML documentation provided in -/usr/share/doc/ntp). -
stratum int: Specifies the stratum number assigned to the driver, an integer -between 0 and 15. +/usr/share/doc/ntp). +
stratum int: Specifies the stratum number assigned to the driver, an integer +between 0 and 15. This number overrides the default stratum number -ordinarily assigned by the driver itself, usually zero. -
refid string: Specifies an ASCII string of from one to four characters which -defines the reference identifier used by the driver. +ordinarily assigned by the driver itself, usually zero. +
refid string: Specifies an ASCII string of from one to four characters which +defines the reference identifier used by the driver. This string overrides the default identifier ordinarily assigned by the driver -itself. -
mode int: Specifies a mode number which is interpreted in a -device-specific fashion. +itself. +
mode int: Specifies a mode number which is interpreted in a +device-specific fashion. For instance, it selects a dialing protocol in the ACTS driver and a device subtype in the parse -drivers. -
flag1 0 | 1
flag2 0 | 1
flag3 0 | 1
flag4 0 | 1: These four flags are used for customizing the clock driver. +drivers. +
flag1 0 | 1
flag2 0 | 1
flag3 0 | 1
flag4 0 | 1: These four flags are used for customizing the clock driver. The interpretation of these values, and whether they are used at all, -is a function of the particular clock driver. +is a function of the particular clock driver. However, by convention flag4 @@ -2279,155 +2538,186 @@ data to the clockstats file configured with the filegen -command. +command. Further information on the filegen command can be found in -Monitoring Options. +‘Monitoring Options’. +

-
+ - -

Miscellaneous Options

- -

broadcastdelay seconds

The broadcast and multicast modes require a special calibration + +

1.1.7 Miscellaneous Options

broadcastdelay seconds

The broadcast and multicast modes require a special calibration to determine the network delay between the local and remote -servers. +servers. Ordinarily, this is done automatically by the initial -protocol exchanges between the client and server. +protocol exchanges between the client and server. In some cases, the calibration procedure may fail due to network or server access -controls, for example. +controls, for example. This command specifies the default delay to -be used under these circumstances. +be used under these circumstances. Typically (for Ethernet), a -number between 0.003 and 0.007 seconds is appropriate. +number between 0.003 and 0.007 seconds is appropriate. The default -when this command is not used is 0.004 seconds. -

calldelay delay

This option controls the delay in seconds between the first and second +when this command is not used is 0.004 seconds. +

calldelay delay

This option controls the delay in seconds between the first and second packets sent in burst or iburst mode to allow additional time for a modem -or ISDN call to complete. -

driftfile driftfile

This command specifies the complete path and name of the file used to -record the frequency of the local clock oscillator. +or ISDN call to complete. +

driftfile driftfile

This command specifies the complete path and name of the file used to +record the frequency of the local clock oscillator. This is the same operation as the -f -command line option. +command line option. If the file exists, it is read at startup in order to set the initial frequency and then updated once per -hour with the current frequency computed by the daemon. +hour with the current frequency computed by the daemon. If the file name is specified, but the file itself does not exist, the starts with an initial -frequency of zero and creates the file when writing it for the first time. +frequency of zero and creates the file when writing it for the first time. If this command is not given, the daemon will always start with an initial frequency of zero. - -

The file format consists of a single line containing a single +

The file format consists of a single line containing a single floating point number, which records the frequency offset measured -in parts-per-million (PPM). +in parts-per-million (PPM). The file is updated by first writing the current drift value into a temporary file and then renaming -this file to replace the old version. +this file to replace the old version. This implies that ntpd(1ntpdmdoc) must have write permission for the directory the drift file is located in, and that file system links, symbolic or -otherwise, should be avoided. -

dscp value

This option specifies the Differentiated Services Control Point (DSCP) value, -a 6-bit code. -The default value is 46, signifying Expedited Forwarding. -

Provides a way to enable or disable various server options. -Flags not mentioned are unaffected. +otherwise, should be avoided. +

dscp value

This option specifies the Differentiated Services Control Point (DSCP) value, +a 6-bit code. +The default value is 46, signifying Expedited Forwarding. +

Provides a way to enable or disable various server options. +Flags not mentioned are unaffected. Note that all of these flags can be controlled remotely using the ntpdc(1ntpdcmdoc) utility program. -

auth

Enables the server to synchronize with unconfigured peers only if the +

auth: Enables the server to synchronize with unconfigured peers only if the peer has been correctly authenticated using either public key or -private key cryptography. +private key cryptography. The default for this flag is -enable. -
bclient: Enables the server to listen for a message from a broadcast or +enable. +
bclient: Enables the server to listen for a message from a broadcast or multicast server, as in the multicastclient command with default -address. +address. The default for this flag is -disable. -
calibrate: Enables the calibrate feature for reference clocks. +disable. +
calibrate: Enables the calibrate feature for reference clocks. The default for this flag is -disable. -
kernel: Enables the kernel time discipline, if available. +disable. +
kernel: Enables the kernel time discipline, if available. The default for this flag is enable if support is available, otherwise -disable. -
mode7: Enables processing of NTP mode 7 implementation-specific requests +disable. +
mode7: Enables processing of NTP mode 7 implementation-specific requests which are used by the deprecated ntpdc(1ntpdcmdoc) -program. -The default for this flag is disable. +program. +The default for this flag is disable. This flag is excluded from runtime configuration using -ntpq(1ntpqmdoc). +ntpq(1ntpqmdoc). The ntpq(1ntpqmdoc) program provides the same capabilities as ntpdc(1ntpdcmdoc) -using standard mode 6 requests. -
monitor: Enables the monitoring facility. +using standard mode 6 requests. +
monitor: Enables the monitoring facility. See the ntpdc(1ntpdcmdoc) program and the monlist -command or further information. +command or further information. The default for this flag is -enable. -
ntp: Enables time and frequency discipline. +enable. +
ntp: Enables time and frequency discipline. In effect, this switch opens and -closes the feedback loop, which is useful for testing. +closes the feedback loop, which is useful for testing. The default for this flag is -enable. -
peer_clear_digest_early: By default, if +enable. +
peer_clear_digest_early: By default, if ntpd(1ntpdmdoc) is using autokey and it receives a crypto-NAK packet that passes the duplicate packet and origin timestamp checks -the peer variables are immediately cleared. +the peer variables are immediately cleared. While this is generally a feature as it allows for quick recovery if a server key has changed, a properly forged and appropriately delivered crypto-NAK packet -can be used in a DoS attack. +can be used in a DoS attack. If you have active noticable problems with this type of DoS attack then you should consider -disabling this option. +disabling this option. You can check your peerstats -file for evidence of any of these attacks. +file for evidence of any of these attacks. The default for this flag is -enable. -
stats: Enables the statistics facility. +enable. +
stats: Enables the statistics facility. See the -Monitoring Options -section for further information. +‘Monitoring Options’ +section for further information. The default for this flag is -disable. -
unpeer_crypto_early: By default, if +disable. +
unpeer_crypto_early: By default, if ntpd(1ntpdmdoc) receives an autokey packet that fails TEST9, a crypto failure, -the association is immediately cleared. +the association is immediately cleared. This is almost certainly a feature, but if, in spite of the current recommendation of not using autokey, you are @@ -2437,101 +2727,112 @@ using autokey you are seeing this sort of DoS attack disabling this flag will delay tearing down the association until the reachability counter -becomes zero. +becomes zero. You can check your peerstats -file for evidence of any of these attacks. +file for evidence of any of these attacks. The default for this flag is -enable. -
unpeer_crypto_nak_early: By default, if +enable. +
unpeer_crypto_nak_early: By default, if ntpd(1ntpdmdoc) receives a crypto-NAK packet that passes the duplicate packet and origin timestamp checks -the association is immediately cleared. +the association is immediately cleared. While this is generally a feature as it allows for quick recovery if a server key has changed, a properly forged and appropriately delivered crypto-NAK packet -can be used in a DoS attack. +can be used in a DoS attack. If you have active noticable problems with this type of DoS attack then you should consider -disabling this option. +disabling this option. You can check your peerstats -file for evidence of any of these attacks. +file for evidence of any of these attacks. The default for this flag is -enable. -
unpeer_digest_early: By default, if +enable. +
unpeer_digest_early: By default, if ntpd(1ntpdmdoc) receives what should be an authenticated packet that passes other packet sanity checks but contains an invalid digest -the association is immediately cleared. +the association is immediately cleared. While this is generally a feature as it allows for quick recovery, if this type of packet is carefully forged and sent -during an appropriate window it can be used for a DoS attack. +during an appropriate window it can be used for a DoS attack. If you have active noticable problems with this type of DoS attack then you should consider -disabling this option. +disabling this option. You can check your peerstats -file for evidence of any of these attacks. +file for evidence of any of these attacks. The default for this flag is -enable. +enable. +

includefile includefile

This command allows additional configuration commands -to be included from a separate file. +

includefile includefile

This command allows additional configuration commands +to be included from a separate file. Include files may be nested to a depth of five; upon reaching the end of any include file, command processing resumes in the previous -configuration file. +configuration file. This option is useful for sites that run ntpd(1ntpdmdoc) on multiple hosts, with (mostly) common options (e.g., a -restriction list). -

leapsmearinterval seconds

This EXPERIMENTAL option is only available if +restriction list). +

leapsmearinterval seconds

This EXPERIMENTAL option is only available if ntpd(1ntpdmdoc) was built with the --enable-leap-smear option to the configure -script. -It specifies the interval over which a leap second correction will be applied. +script. +It specifies the interval over which a leap second correction will be applied. Recommended values for this option are between -7200 (2 hours) and 86400 (24 hours). -.Sy DO NOT USE THIS OPTION ON PUBLIC-ACCESS SERVERS! -See http://bugs.ntp.org/2855 for more information. -

logconfig configkeyword

This command controls the amount and type of output written to +7200 (2 hours) and 86400 (24 hours). +.Sy DO NOT USE THIS OPTION ON PUBLIC-ACCESS SERVERS! +See http://bugs.ntp.org/2855 for more information. +

logconfig configkeyword

This command controls the amount and type of output written to the system syslog(3) facility or the alternate logfile -log file. -By default, all output is turned on. +log file. +By default, all output is turned on. All configkeyword keywords can be prefixed with -=, -+ +‘=’, +‘+’ and --, +‘-’, where -= +‘=’ sets the syslog(3) priority mask, -+ +‘+’ adds and -- +‘-’ removes -messages. +messages. syslog(3) messages can be controlled in four classes -(clock, peer, sys and sync). +(clock, peer, sys and sync). Within these classes four types of messages can be controlled: informational messages (info), @@ -2542,259 +2843,307 @@ statistics messages and status messages (status). - -

Configuration keywords are formed by concatenating the message class with -the event class. +

Configuration keywords are formed by concatenating the message class with +the event class. The all -prefix can be used instead of a message class. +prefix can be used instead of a message class. A message class may also be followed by the all keyword to enable/disable all -messages of the respective message class. +messages of the respective message class. Thus, a minimal log configuration could look like this: -

          
-          logconfig =syncstatus +sysevents
-

- -

This would just list the synchronizations state of +

logconfig =syncstatus +sysevents
+

This would just list the synchronizations state of ntpd(1ntpdmdoc) -and the major system events. +and the major system events. For a simple reference server, the following minimum message configuration could be useful: -

          
-          logconfig =syncall +clockall
-

- -

This configuration will list all clock information and -synchronization information. +

logconfig =syncall +clockall
+

This configuration will list all clock information and +synchronization information. All other events and messages about -peers, system events and so on is suppressed. -

logfile logfile

This command specifies the location of an alternate log file to +peers, system events and so on is suppressed. +

logfile logfile

This command specifies the location of an alternate log file to be used instead of the default system syslog(3) -facility. +facility. This is the same operation as the -l -command line option. -

setvar variable [default]

This command adds an additional system variable. +command line option. +

setvar variable [default]

This command adds an additional system variable. These variables can be used to distribute additional information such as -the access policy. +the access policy. If the variable of the form name=value is followed by the default keyword, the variable will be listed as part of the default system variables -(rv command)). +(rv command)). These additional variables serve -informational purposes only. +informational purposes only. They are not related to the protocol -other that they can be listed. +other that they can be listed. The known protocol variables will always override any variables defined via the setvar -mechanism. +mechanism. There are three special variables that contain the names -of all variable of the same group. +of all variable of the same group. The sys_var_list holds -the names of all system variables. +the names of all system variables. The peer_var_list holds the names of all peer variables and the clock_var_list -holds the names of the reference clock variables. -

This command can be used to alter several system variables in -very exceptional circumstances. +holds the names of the reference clock variables. +

This command can be used to alter several system variables in +very exceptional circumstances. It should occur in the -configuration file before any other configuration options. +configuration file before any other configuration options. The default values of these variables have been carefully optimized for -a wide range of network speeds and reliability expectations. +a wide range of network speeds and reliability expectations. In general, they interact in intricate ways that are hard to predict -and some combinations can result in some very nasty behavior. +and some combinations can result in some very nasty behavior. Very rarely is it necessary to change the default values; but, some folks cannot resist twisting the knobs anyway and this command is -for them. +for them. Emphasis added: twisters are on their own and can expect no help from the support group. - -

The variables operate as follows: -

allan allan

The argument becomes the new value for the minimum Allan +

The variables operate as follows: +

allan allan: The argument becomes the new value for the minimum Allan intercept, which is a parameter of the PLL/FLL clock discipline -algorithm. +algorithm. The value in log2 seconds defaults to 7 (1024 s), which is also the lower -limit. -
dispersion dispersion: The argument becomes the new value for the dispersion increase rate, -normally .000015 s/s. -
freq freq: The argument becomes the initial value of the frequency offset in -parts-per-million. +limit. +
dispersion dispersion: The argument becomes the new value for the dispersion increase rate, +normally .000015 s/s. +
freq freq: The argument becomes the initial value of the frequency offset in +parts-per-million. This overrides the value in the frequency file, if -present, and avoids the initial training state if it is not. -
huffpuff huffpuff: The argument becomes the new value for the experimental -huff-n'-puff filter span, which determines the most recent interval -the algorithm will search for a minimum delay. +present, and avoids the initial training state if it is not. +
huffpuff huffpuff: The argument becomes the new value for the experimental +huff-n’-puff filter span, which determines the most recent interval +the algorithm will search for a minimum delay. The lower limit is -900 s (15 m), but a more reasonable value is 7200 (2 hours). +900 s (15 m), but a more reasonable value is 7200 (2 hours). There is no default, since the filter is not enabled unless this command -is given. -
panic panic: The argument is the panic threshold, normally 1000 s. +is given. +
panic panic: The argument is the panic threshold, normally 1000 s. If set to zero, the panic sanity check is disabled and a clock offset of any value will -be accepted. -
step step: The argument is the step threshold, which by default is 0.128 s. +be accepted. +
step step: The argument is the step threshold, which by default is 0.128 s. It can -be set to any positive number in seconds. +be set to any positive number in seconds. If set to zero, step -adjustments will never occur. +adjustments will never occur. Note: The kernel time discipline is disabled if the step threshold is set to zero or greater than the -default. -
stepback stepback: The argument is the step threshold for the backward direction, -which by default is 0.128 s. +default. +
stepback stepback: The argument is the step threshold for the backward direction, +which by default is 0.128 s. It can -be set to any positive number in seconds. +be set to any positive number in seconds. If both the forward and backward step thresholds are set to zero, step -adjustments will never occur. +adjustments will never occur. Note: The kernel time discipline is disabled if each direction of step threshold are either -set to zero or greater than .5 second. -
stepfwd stepfwd: As for stepback, but for the forward direction. -
stepout stepout: The argument is the stepout timeout, which by default is 900 s. +set to zero or greater than .5 second. +
stepfwd stepfwd: As for stepback, but for the forward direction. +
stepout stepout: The argument is the stepout timeout, which by default is 900 s. It can -be set to any positive number in seconds. +be set to any positive number in seconds. If set to zero, the stepout -pulses will not be suppressed. +pulses will not be suppressed. +

rlimit [memlock Nmegabytes | stacksize N4kPages filenum Nfiledescriptors]

memlock Nmegabytes

Specify the number of megabytes of memory that should be -allocated and locked. +

rlimit [memlock Nmegabytes | stacksize N4kPages filenum Nfiledescriptors]

memlock Nmegabytes: Specify the number of megabytes of memory that should be +allocated and locked. Probably only available under Linux, this option may be useful when dropping root (the -i -option). -The default is 32 megabytes on non-Linux machines, and -1 under Linux. --1 means "do not lock the process into memory". -0 means "lock whatever memory the process wants into memory". -
stacksize N4kPages: Specifies the maximum size of the process stack on systems with the +option). +The default is 32 megabytes on non-Linux machines, and -1 under Linux. +-1 means "do not lock the process into memory". +0 means "lock whatever memory the process wants into memory". +
stacksize N4kPages: Specifies the maximum size of the process stack on systems with the mlockall() -function. -Defaults to 50 4k pages (200 4k pages in OpenBSD). -
filenum Nfiledescriptors: Specifies the maximum number of file descriptors ntpd may have open at once. -Defaults to the system default. +function. +Defaults to 50 4k pages (200 4k pages in OpenBSD). +
filenum Nfiledescriptors: Specifies the maximum number of file descriptors ntpd may have open at once. +Defaults to the system default. +

trap host_address [port port_number] [interface interface_address]

This command configures a trap receiver at the given host +

trap host_address [port port_number] [interface interface_address]

This command configures a trap receiver at the given host address and port number for sending messages with the specified -local interface address. +local interface address. If the port number is unspecified, a value -of 18447 is used. +of 18447 is used. If the interface address is not specified, the message is sent with a source address of the local interface the -message is sent through. +message is sent through. Note that on a multihomed host the interface used may vary from time to time with routing changes. - -

The trap receiver will generally log event messages and other -information from the server in a log file. +

The trap receiver will generally log event messages and other +information from the server in a log file. While such monitor programs may also request their own trap dynamically, configuring a trap receiver will ensure that no messages are lost when the server -is started. -

hop ...

This command specifies a list of TTL values in increasing order, up to 8 -values can be specified. +is started. +

hop ...

This command specifies a list of TTL values in increasing order, up to 8 +values can be specified. In manycast mode these values are used in turn in -an expanding-ring search. +an expanding-ring search. The default is eight multiples of 32 starting at -31. +31. +

This section was generated by AutoGen, -using the agtexi-cmd template and the option descriptions for the ntp.conf program. +

This section was generated by AutoGen, +using the agtexi-cmd template and the option descriptions for the ntp.conf program. This software is released under the NTP license, <http://ntp.org/license>. - -

- -

+ + + + + + + +

-
+ - -

ntp.conf Files

- -

/etc/ntp.conf

the default name of the configuration file -

ntp.keys

private MD5 keys -

ntpkey

RSA private key -

ntpkey_host

RSA public key -

ntp_dh

Diffie-Hellman agreement parameters + +

1.1.8 ntp.conf Files

/etc/ntp.conf: the default name of the configuration file +
ntp.keys: private MD5 keys +
ntpkey: RSA private key +
ntpkey_host: RSA public key +
ntp_dh: Diffie-Hellman agreement parameters +

-
+ - -

ntp.conf See Also

- -

ntpd(1ntpdmdoc), + +

1.1.9 ntp.conf See Also

ntpd(1ntpdmdoc), ntpdc(1ntpdcmdoc), ntpq(1ntpqmdoc) - -

In addition to the manual pages provided, +

In addition to the manual pages provided, comprehensive documentation is available on the world wide web at -http://www.ntp.org/. +http://www.ntp.org/. A snapshot of this documentation is available in HTML format in -/usr/share/doc/ntp. +/usr/share/doc/ntp.
- -

-David L. Mills, Network Time Protocol (Version 4), RFC5905 -

- +

David L. Mills, Network Time Protocol (Version 4), RFC5905 +

+ + - -

ntp.conf Bugs

- -

The syntax checking is not picky; some combinations of + +

1.1.10 ntp.conf Bugs

The syntax checking is not picky; some combinations of ridiculous and even hilarious options and modes may not be detected. - -

The -ntpkey_host +

The +ntpkey_host files are really digital -certificates. +certificates. These should be obtained via secure directory -services when they become universally available. -

- -
+services when they become universally available. +

+ + +

1.1.11 ntp.conf Notes

This document was derived from FreeBSD. +

ntp.conf Notes

- -

This document was derived from FreeBSD. - + + diff --git a/ntpd/ntp.keys.html b/ntpd/ntp.keys.html index e62bd4027..613c2cbfc 100644 --- a/ntpd/ntp.keys.html +++ b/ntpd/ntp.keys.html @@ -1,101 +1,139 @@ - + + + NTP Symmetric Key - + - - - - - + + + + + + + + + + - -

NTP Symmetric Key

-Next: ntp.keys Description, -Previous: (dir), -Up: (dir) -
-

NTP's Symmetric Key File User Manual

+ +

NTP Symmetric Key

This document describes the symmetric key file for the NTP Project's -ntpd program. -

This document applies to version 4.2.8p9-win of ntp.keys. -

Short Contents

NTP's Symmetric Key File User Manual

+ + + + + +

NTP’s Symmetric Key File User Manual

ntp.keys Description -

ntp.keys Notes +

This document describes the symmetric key file for the NTP Project’s +ntpd program. +

This document applies to version 4.2.8p9-win of ntp.keys. +

+ +

Short Table of Contents

+ +

1 Description

- -

-Previous: Top, -Up: Top -

- -

Description

+ + + + + + +

+ + + +

1 Description

The name and location of the symmetric key file for ntpd can be specified in a configuration file, by default /etc/ntp.keys. - -

-
+ + +

1.1 Notes about ntp.keys

+ + -

Notes about ntp.keys

This document describes the format of an NTP symmetric key file. +

This document describes the format of an NTP symmetric key file. For a description of the use of this type of file, see the -"Authentication Support" +"Authentication Support" section of the ntp.conf(5) page. - -

ntpd(8) +

ntpd(8) reads its keys from a file specified using the -k command line option or the keys -statement in the configuration file. +statement in the configuration file. While key number 0 is fixed by the NTP standard (as 56 zero bits) and may not be changed, one or more keys numbered between 1 and 65534 may be arbitrarily set in the keys file. - -

The key file uses the same comment conventions -as the configuration file. +

The key file uses the same comment conventions +as the configuration file. Key entries use a fixed format of the form +

keyno type key opt_IP_list
+

     keyno type key opt_IP_list
-

where +

where keyno is a positive integer (between 1 and 65534), type @@ -105,104 +143,113 @@ and is the key itself, and opt_IP_list is an optional comma-separated list of IPs -that are allowed to serve time. +that are allowed to serve time. If opt_IP_list is empty, any properly-authenticated server message will be accepted. - -

The +

The key may be given in a format controlled by the type -field. +field. The type MD5 -is always supported. +is always supported. If ntpd was built with the OpenSSL library -then any digest library supported by that library may be specified. +then any digest library supported by that library may be specified. However, if compliance with FIPS 140-2 is required the type must be either SHA or SHA1. - -

What follows are some key types, and corresponding formats: - -

MD5

The key is 1 to 16 printable characters terminated by +

What follows are some key types, and corresponding formats: +

MD5: The key is 1 to 16 printable characters terminated by an EOL, whitespace, or a # -(which is the "start of comment" character). - -
SHA
SHA1
RMD160: The key is a hex-encoded ASCII string of 40 characters, -which is truncated as necessary. +(which is the "start of comment" character). +
+
SHA
SHA1
RMD160: The key is a hex-encoded ASCII string of 40 characters, +which is truncated as necessary. +

Note that the keys used by the +

Note that the keys used by the ntpq(8) and ntpdc(8) programs are checked against passwords requested by the programs and entered by hand, so it is generally appropriate to specify these keys in ASCII format. - -

This section was generated by AutoGen, -using the agtexi-cmd template and the option descriptions for the ntp.keys program. +

This section was generated by AutoGen, +using the agtexi-cmd template and the option descriptions for the ntp.keys program. This software is released under the NTP license, <http://ntp.org/license>. - -

- -

-Next: ntp.keys See Also, -Up: ntp.keys Notes -
+

+ + + + + + +

+ + - -

ntp.keys Files

- -

/etc/ntp.keys

the default name of the configuration file + +

1.1.1 ntp.keys Files

/etc/ntp.keys: the default name of the configuration file +

-Next: ntp.keys Notes, -Previous: ntp.keys Files, -Up: ntp.keys Notes -
+

+ + - -

ntp.keys See Also

- + +

1.1.2 ntp.keys See Also

ntp.conf(5), ntpd(1ntpdmdoc), ntpdate(1ntpdatemdoc), ntpdc(1ntpdcmdoc), sntp(1sntpmdoc) -

-Previous: ntp.keys See Also, -Up: ntp.keys Notes -
+

+ - -

ntp.keys Notes

- + +

1.1.3 ntp.keys Notes

This document was derived from FreeBSD. +

+ - + + diff --git a/ntpd/ntpd.html b/ntpd/ntpd.html index 557045ae7..e972adc9c 100644 --- a/ntpd/ntpd.html +++ b/ntpd/ntpd.html @@ -1,128 +1,173 @@ - + + + -ntpd: Network Time Protocol (NTP) Daemon User's Manual - - - - - - - +ntpd: Network Time Protocol (NTP) Daemon User’s Manual + + + + + + + + + + + + - -

ntpd: Network Time Protocol (NTP) Daemon User's Manual

-Next: ntpd Description, -Previous: (dir), -Up: (dir) -
-

ntpd: Network Time Protocol (NTP) Daemon User Manual

+ +

ntpd: Network Time Protocol (NTP) Daemon User’s Manual

+ + + + + + + + +

ntpd: Network Time Protocol (NTP) Daemon User Manual

The ntpd program is an operating system daemon that synchronizes the -system clock to remote NTP time servers or local reference clocks. +system clock to remote NTP time servers or local reference clocks. It is a complete implementation of NTP version 4 defined by RFC-5905, but also retains compatible with version 3 defined by RFC-1305 and versions -1 and 2, defined by RFC-1059 and RFC-1119, respectively. +1 and 2, defined by RFC-1059 and RFC-1119, respectively. The program can operate in any of several modes, including client/server, symmetric and broadcast modes, and with both symmetric-key and public-key cryptography. +

This document applies to version 4.2.8p9-win of ntpd. +

+ +

Short Table of Contents

+ +

1 Description

This document applies to version 4.2.8p9-win of ntpd. -

+ + + + + -

-
+ - - -

Description

+ +

1 Description

The ntpd program ordinarily requires -a configuration file described at ntp.conf. +a configuration file described at ‘ntp.conf’. This configuration file contains configuration commands described on -the pages listed above. +the pages listed above. However a client can discover remote servers and configure them -automatically. +automatically. This makes it possible to deploy a fleet of workstations without specifying configuration details specific to the local environment. - -

The ntpd program normally operates continuously while adjusting the +

The ntpd program normally operates continuously while adjusting the system time and frequency, but in some cases this might not be -practical. +practical. With the -q option ntpd operates as in continuous mode, but -exits just after setting the clock for the first time. +exits just after setting the clock for the first time. Most applications will probably want to specify the iburst -option with the server command. +option with the server command. With this option an initial volley of messages is exchanged to -groom the data and set the clock in about ten seconds' time. -If nothing is heard after a few minutes' time, +groom the data and set the clock in about ten seconds’ time. +If nothing is heard after a few minutes’ time, the daemon times out and exits without setting the clock. - -

-
+ + +

1.1 Invoking ntpd

+ + -

Invoking ntpd

The +

The ntpd utility is an operating system daemon which sets and maintains the system time of day in synchronism with Internet -standard time servers. +standard time servers. It is a complete implementation of the Network Time Protocol (NTP) version 4, as defined by RFC-5905, but also retains compatibility with version 3, as defined by RFC-1305, and versions 1 and 2, as defined by RFC-1059 and RFC-1119, respectively. - -

The +

The ntpd utility does most computations in 64-bit floating point arithmetic and does relatively clumsy 64-bit fixed point operations only when necessary to preserve the ultimate precision, about 232 -picoseconds. +picoseconds. While the ultimate precision is not achievable with ordinary workstations and networks of today, it may be required with future gigahertz CPU clocks and gigabit LANs. - -

Ordinarily, +

Ordinarily, ntpd reads the ntp.conf(5) configuration file at startup time in order to determine the -synchronization sources and operating modes. +synchronization sources and operating modes. It is also possible to specify a working, although limited, configuration entirely on the -command line, obviating the need for a configuration file. +command line, obviating the need for a configuration file. This may be particularly useful when the local host is to be configured as a broadcast/multicast client, with all peers being determined by listening to broadcasts at run time. - -

If NetInfo support is built into +

If NetInfo support is built into ntpd then ntpd @@ -133,8 +178,8 @@ file cannot be read and no file is specified by the -c option. - -

Various internal +

Various internal ntpd variables can be displayed and configuration options altered while the @@ -145,8 +190,8 @@ using the and ntpdc(1ntpdcmdoc) utility programs. - -

When +

When ntpd starts it looks at the value of umask(2), @@ -155,72 +200,110 @@ and if zero will set the umask(2) to 022. - -

This section was generated by AutoGen, -using the agtexi-cmd template and the option descriptions for the ntpd program. +

This section was generated by AutoGenagtexi-cmd template This software is released under the NTP - -

- -
-
-Next: --help) ipv4 option (-4) ipv6 option (-6) authreq option (-a) authnoreq: authnoreq option (-A) configfile: configfile option (-c) driftfile: driftfile option (-f) panicgate: panicgate option (-g) _002donce">ntpd force-step-once: force-step-once option (-G) jaildir option (-i) interface option (-I) keyfile option (-k) logfile option (-l) novirtualips option (-L) modifymmtimer option (-M) nice option (-N) pidfile option (-p) priority option (-P) quit option (-q) propagationdelay: propagationdelay option (-r) saveconfigquit option statsdir option (-s) trustedkey option (-t) user option (-u) updateinterval option (-U) wait-sync option (-w) slew option (-x) usepcc option pccfreq option mdns option (-m) presetting/configuring ntpd exit status Usage Files See Also Bugs Notes rel="next" accesskey="n" href="#ntpd-ipv4">ntpd ipv4, Invocation">ntpd Invocation
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
• ntpd usage:    ntpd help/usage (--help) +
• ntpd ipv4:    ipv4 option (-4) +
• ntpd ipv6:    ipv6 option (-6) +
• ntpd authreq:    authreq option (-a) +
• ntpd authnoreq:    authnoreq option (-A) +
• ntpd configfile:    configfile option (-c) +
• ntpd driftfile:    driftfile option (-f) +
• ntpd panicgate:    panicgate option (-g) +
• ntpd force-step-once:    force-step-once option (-G) +
• ntpd jaildir:    jaildir option (-i) +
• ntpd interface:    interface option (-I) +
• ntpd keyfile:    keyfile option (-k) +
• ntpd logfile:    logfile option (-l) +
• ntpd novirtualips:    novirtualips option (-L) +
• ntpd modifymmtimer:    modifymmtimer option (-M) +
• ntpd nice:    nice option (-N) +
• ntpd pidfile:    pidfile option (-p) +
• ntpd priority:    priority option (-P) +
• ntpd quit:    quit option (-q) +
• ntpd propagationdelay:    propagationdelay option (-r) +
• ntpd saveconfigquit:    saveconfigquit option +
• ntpd statsdir:    statsdir option (-s) +
• ntpd trustedkey:    trustedkey option (-t) +
• ntpd user:    user option (-u) +
• ntpd updateinterval:    updateinterval option (-U) +
• ntpd wait-sync:    wait-sync option (-w) +
• ntpd slew:    slew option (-x) +
• ntpd usepcc:    usepcc option +
• ntpd pccfreq:    pccfreq option +
• ntpd mdns:    mdns option (-m) +
• ntpd config:    presetting/configuring ntpd +
• ntpd exit status:    exit status +
• ntpd Usage:    Usage +
• ntpd Files:    Files +
• ntpd See Also:    See Also +
• ntpd Bugs:    Bugs +
• ntpd Notes:    Notes +
+ +
+ +
+
+Next: ntpd ipv4, Up: ntpd Invocation

- -
ntpd help/usage (--help)
- -
-This is the automatically generated usage text for ntpd. - -
The text printed is the same whether selected with the help option -(--help) or the more-help option (--more-help). more-help will print -the usage text by passing it through a pager program. + +
1.1.1 ntpd help/usage (--help)
+ + +
This is the automatically generated usage text for ntpd. +
+
The text printed is the same whether selected with the help option +(--help) or the more-help option (--more-help). more-help will print +the usage text by passing it through a pager program. more-help is disabled on platforms without a working fork(2) function. The PAGER environment variable is -used to select the program, defaulting to more. Both will exit +used to select the program, defaulting to more. Both will exit with a status code of 0. - -
ntpd - NTP daemon program - Ver. 4.2.8p9-win1 +
+
+
ntpd - NTP daemon program - Ver. 4.2.8p9 Usage: ntpd [ -<flag> [<val>] | --<name>[{=| }<val>] ]... \ [ <server1> ... <serverN> ] Flg Arg Option-Name Description @@ -289,149 +372,143 @@ The following option preset mechanisms are supported: - examining environment variables named NTPD_* Please send bug reports to: <http://bugs.ntp.org, bugs@ntp.org> -
-
-
-Next: ntpd ipv6, -Previous: ntpd usage, -Up: ntpd Invocation -
-
- -
ipv4 option (-4)
+
-
-This is the “force ipv4 dns name resolution” option. - -
This option has some usage constraints. It: -
-
must not appear in combination with any of the following options: -ipv6. -
- -
Force DNS resolution of following host names on the command line -to the IPv4 namespace. -
-
-Next: ntpd authreq, -Previous: ntpd ipv4, -Up: ntpd Invocation -
+
+ +
+
+Next: ntpd ipv6, Previous: ntpd usage, Up: ntpd Invocation

- -
ipv6 option (-6)
- -
-This is the “force ipv6 dns name resolution” option. - -
This option has some usage constraints. It: -
-
must not appear in combination with any of the following options: -ipv4. -
- -
Force DNS resolution of following host names on the command line -to the IPv6 namespace. -
-
-Next: ntpd authnoreq, -Previous: ntpd ipv6, -Up: ntpd Invocation -
+ +
1.1.2 ipv4 option (-4)
+ + +
This is the “force ipv4 dns name resolution” option. +
+
This option has some usage constraints. It: +
+
must not appear in combination with any of the following options: +ipv6. +
+ +
Force DNS resolution of following host names on the command line +to the IPv4 namespace. +
+ +
+
+Next: ntpd authreq, Previous: ntpd ipv4, Up: ntpd Invocation

- -
authreq option (-a)
- -
-This is the “require crypto authentication” option. - -
This option has some usage constraints. It: -
-
must not appear in combination with any of the following options: -authnoreq. -
- -
Require cryptographic authentication for broadcast client, -multicast client and symmetric passive associations. -This is the default. -
-
-Next: ntpd configfile, -Previous: ntpd authreq, -Up: ntpd Invocation -
+ +
1.1.3 ipv6 option (-6)
+ + +
This is the “force ipv6 dns name resolution” option. +
+
This option has some usage constraints. It: +
+
must not appear in combination with any of the following options: +ipv4. +
+ +
Force DNS resolution of following host names on the command line +to the IPv6 namespace. +
+ +
+
+Next: ntpd authnoreq, Previous: ntpd ipv6, Up: ntpd Invocation

- -
authnoreq option (-A)
- -
-This is the “do not require crypto authentication” option. - -
This option has some usage constraints. It: -
-
must not appear in combination with any of the following options: -authreq. -
- -
Do not require cryptographic authentication for broadcast client, -multicast client and symmetric passive associations. -This is almost never a good idea. -
-
-Next: ntpd driftfile, -Previous: ntpd authnoreq, -Up: ntpd Invocation -
+ +
1.1.4 authreq option (-a)
+ + +
This is the “require crypto authentication” option. +
+
This option has some usage constraints. It: +
+
must not appear in combination with any of the following options: +authnoreq. +
+ +
Require cryptographic authentication for broadcast client, +multicast client and symmetric passive associations. +This is the default. +
+ +
+
+Next: ntpd configfile, Previous: ntpd authreq, Up: ntpd Invocation

+ +
1.1.5 authnoreq option (-A)
+ + +
This is the “do not require crypto authentication” option. +
+
This option has some usage constraints. It: +
+
must not appear in combination with any of the following options: +authreq. +
+ +
Do not require cryptographic authentication for broadcast client, +multicast client and symmetric passive associations. +This is almost never a good idea. +
+ +
+
+Next: ntpd driftfile, Previous: ntpd authnoreq, Up: ntpd Invocation
+
+ +
1.1.6 configfile option (-c)
+ -
configfile option (-c)
- -
-This is the “configuration file name” option. -This option takes a string argument. +
This is the “configuration file name” option. +This option takes a string argument. The name and path of the configuration file, -/etc/ntp.conf -by default. -
-
-Next: ntpd panicgate, -Previous: ntpd configfile, -Up: ntpd Invocation -
+/etc/ntp.conf +by default. +
+ +
+
+Next: ntpd panicgate, Previous: ntpd configfile, Up: ntpd Invocation

+ +
1.1.7 driftfile option (-f)
+ -
driftfile option (-f)
- -
-This is the “frequency drift file name” option. -This option takes a string argument. +
This is the “frequency drift file name” option. +This option takes a string argument. The name and path of the frequency file, -/etc/ntp.drift -by default. +/etc/ntp.drift +by default. This is the same operation as the driftfile driftfile configuration specification in the -/etc/ntp.conf -file. -
-
-Next: ntpd force-step-once, -Previous: ntpd driftfile, -Up: ntpd Invocation -
+/etc/ntp.conf +file. +
+ +
+
+Next: ntpd force-step-once, Previous: ntpd driftfile, Up: ntpd Invocation

- -
panicgate option (-g)
- -
-This is the “allow the first adjustment to be big” option. - -
This option has some usage constraints. It: -
-
may appear an unlimited number of times. -
- -
Normally, + +
1.1.8 panicgate option (-g)
+ + +
This is the “allow the first adjustment to be big” option. +
+
This option has some usage constraints. It: +
+
may appear an unlimited number of times. +
+ +
Normally, ntpd exits with a message to the system log if the offset exceeds the panic threshold, which is 1000 s by default. This option allows the time to be set to any value without restriction; however, this can happen only once. If the threshold is exceeded after that, ntpd @@ -439,581 +516,579 @@ will exit with a message to the system log. This option can be used with the -q and -x -options. +options. See the tinker -configuration file directive for other options. -
-
-Next: ntpd jaildir, -Previous: ntpd panicgate, -Up: ntpd Invocation -
+configuration file directive for other options. +
+ +
+
+Next: ntpd jaildir, Previous: ntpd panicgate, Up: ntpd Invocation

+ +
1.1.9 force-step-once option (-G)
+ -
force-step-once option (-G)
- -
-This is the “step any initial offset correction.” option. +
This is the “step any initial offset correction.” option. Normally, ntpd steps the time if the time offset exceeds the step threshold, -which is 128 ms by default, and otherwise slews the time. +which is 128 ms by default, and otherwise slews the time. This option forces the initial offset correction to be stepped, -so the highest time accuracy can be achieved quickly. +so the highest time accuracy can be achieved quickly. However, this may also cause the time to be stepped back so this option must not be used if -applications requiring monotonic time are running. -See the tinker configuration file directive for other options. -
-
-Next: ntpd interface, -Previous: ntpd force-step-once, -Up: ntpd Invocation -
+applications requiring monotonic time are running. +See the tinker configuration file directive for other options. +
+ +
+
+Next: ntpd interface, Previous: ntpd force-step-once, Up: ntpd Invocation

+ +
1.1.10 jaildir option (-i)
+ -
jaildir option (-i)
- -
-This is the “jail directory” option. +
This is the “jail directory” option. This option takes a string argument. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining HAVE_DROPROOT during the compilation. +
-
This option has some usage constraints. It: -
-
must be compiled in by defining HAVE_DROPROOT during the compilation. -
- -
Chroot the server to the directory +
Chroot the server to the directory jaildir -. -This option also implies that the server attempts to drop root privileges at startup. +. +This option also implies that the server attempts to drop root privileges at startup. You may need to also specify a -u -option. +option. This option is only available if the OS supports adjusting the clock -without full root privileges. +without full root privileges. This option is supported under NetBSD (configure with --enable-clockctl) or Linux (configure with ---enable-linuxcaps) or Solaris (configure with --enable-solarisprivs). -
-
-Next: ntpd keyfile, -Previous: ntpd jaildir, -Up: ntpd Invocation -
+--enable-linuxcaps) or Solaris (configure with --enable-solarisprivs). +
+ +
+
+Next: ntpd keyfile, Previous: ntpd jaildir, Up: ntpd Invocation

- -
interface option (-I)
- -
-This is the “listen on an interface name or address” option. -This option takes a string argument iface. - -
This option has some usage constraints. It: -
-
may appear an unlimited number of times. -
- -
Open the network address given, or all the addresses associated with the + +
1.1.11 interface option (-I)
+ + +
This is the “listen on an interface name or address” option. +This option takes a string argument iface. +
+
This option has some usage constraints. It: +
+
may appear an unlimited number of times. +
+ +
Open the network address given, or all the addresses associated with the given interface name. This option may appear multiple times. This option -also implies not opening other addresses, except wildcard and localhost. +also implies not opening other addresses, except wildcard and localhost. This option is deprecated. Please consider using the configuration file -interface command, which is more versatile. -
-
-Next: ntpd logfile, -Previous: ntpd interface, -Up: ntpd Invocation -
-
- -
keyfile option (-k)
- -
-This is the “path to symmetric keys” option. -This option takes a string argument. -Specify the name and path of the symmetric key file. -/etc/ntp.keys -is the default. +interface command, which is more versatile. +
+ +
+
+Next: ntpd logfile, Previous: ntpd interface, Up: ntpd Invocation
+
+ +
1.1.12 keyfile option (-k)
+ + +
This is the “path to symmetric keys” option. +This option takes a string argument. +Specify the name and path of the symmetric key file. +/etc/ntp.keys +is the default. This is the same operation as the keys keyfile -configuration file directive. -
-
-Next: ntpd novirtualips, -Previous: ntpd keyfile, -Up: ntpd Invocation -
-
- -
logfile option (-l)
- -
-This is the “path to the log file” option. -This option takes a string argument. -Specify the name and path of the log file. -The default is the system log file. +configuration file directive. +
+ +
+
+Next: ntpd novirtualips, Previous: ntpd keyfile, Up: ntpd Invocation
+
+ +
1.1.13 logfile option (-l)
+ + +
This is the “path to the log file” option. +This option takes a string argument. +Specify the name and path of the log file. +The default is the system log file. This is the same operation as the logfile logfile -configuration file directive. -
-
-Next: ntpd modifymmtimer, -Previous: ntpd logfile, -Up: ntpd Invocation -
+configuration file directive. +
+ +
+
+Next: ntpd modifymmtimer, Previous: ntpd logfile, Up: ntpd Invocation

+ +
1.1.14 novirtualips option (-L)
+ -
novirtualips option (-L)
- -
-This is the “do not listen to virtual interfaces” option. +
This is the “do not listen to virtual interfaces” option. Do not listen to virtual interfaces, defined as those with names containing a colon. This option is deprecated. Please consider using the configuration file interface command, which -is more versatile. -
-
-Next: ntpd nice, -Previous: ntpd novirtualips, -Up: ntpd Invocation -
+is more versatile. +
+ +
+
+Next: ntpd nice, Previous: ntpd novirtualips, Up: ntpd Invocation

- -
modifymmtimer option (-M)
- -
-This is the “modify multimedia timer (windows only)” option. - -
This option has some usage constraints. It: -
-
must be compiled in by defining SYS_WINNT during the compilation. -
- -
Set the Windows Multimedia Timer to highest resolution. This + +
1.1.15 modifymmtimer option (-M)
+ + +
This is the “modify multimedia timer (windows only)” option. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining SYS_WINNT during the compilation. +
+ +
Set the Windows Multimedia Timer to highest resolution. This ensures the resolution does not change while ntpd is running, -avoiding timekeeping glitches associated with changes. -
-
-Next: ntpd pidfile, -Previous: ntpd modifymmtimer, -Up: ntpd Invocation -
+avoiding timekeeping glitches associated with changes. +
+ +
+
+Next: ntpd pidfile, Previous: ntpd modifymmtimer, Up: ntpd Invocation

+ +
1.1.16 nice option (-N)
+ -
nice option (-N)
- -
-This is the “run at high priority” option. +
This is the “run at high priority” option. To the extent permitted by the operating system, run ntpd -at the highest priority. -
-
-Next: ntpd priority, -Previous: ntpd nice, -Up: ntpd Invocation -
+at the highest priority. +
+ +
+
+Next: ntpd priority, Previous: ntpd nice, Up: ntpd Invocation

+ +
1.1.17 pidfile option (-p)
+ -
pidfile option (-p)
- -
-This is the “path to the pid file” option. -This option takes a string argument. +
This is the “path to the pid file” option. +This option takes a string argument. Specify the name and path of the file used to record -ntpd's -process ID. +ntpd’s +process ID. This is the same operation as the pidfile pidfile -configuration file directive. -
-
-Next: ntpd quit, -Previous: ntpd pidfile, -Up: ntpd Invocation -
+configuration file directive. +
+ +
+
+Next: ntpd quit, Previous: ntpd pidfile, Up: ntpd Invocation

+ +
1.1.18 priority option (-P)
+ -
priority option (-P)
- -
-This is the “process priority” option. -This option takes a number argument. +
This is the “process priority” option. +This option takes a number argument. To the extent permitted by the operating system, run ntpd at the specified sched_setscheduler(SCHED_FIFO) -priority. -
-
-Next: ntpd propagationdelay, -Previous: ntpd priority, -Up: ntpd Invocation -
+priority. +
+ +
+
+Next: ntpd propagationdelay, Previous: ntpd priority, Up: ntpd Invocation

- -
quit option (-q)
- -
-This is the “set the time and quit” option. - -
This option has some usage constraints. It: -
-
must not appear in combination with any of the following options: -saveconfigquit, wait-sync. -
- -
ntpd + +
1.1.19 quit option (-q)
+ + +
This is the “set the time and quit” option. +
+
This option has some usage constraints. It: +
+
must not appear in combination with any of the following options: +saveconfigquit, wait-sync. +
+ +
ntpd will not daemonize and will exit after the clock is first synchronized. This behavior mimics that of the ntpdate -program, which will soon be replaced with a shell script. +program, which will soon be replaced with a shell script. The -g and -x -options can be used with this option. -Note: The kernel time discipline is disabled with this option. -
-
-Next: ntpd saveconfigquit, -Previous: ntpd quit, -Up: ntpd Invocation -
-
- -
propagationdelay option (-r)
- -
-This is the “broadcast/propagation delay” option. -This option takes a string argument. -Specify the default propagation delay from the broadcast/multicast server to this client. This is necessary only if the delay cannot be computed automatically by the protocol. -
-
-Next: ntpd statsdir, -Previous: ntpd propagationdelay, -Up: ntpd Invocation -
-
- -
saveconfigquit option
- -
-This is the “save parsed configuration and quit” option. -This option takes a string argument. +options can be used with this option. +Note: The kernel time discipline is disabled with this option. +
+ +
+
+Next: ntpd saveconfigquit, Previous: ntpd quit, Up: ntpd Invocation
+
+ +
1.1.20 propagationdelay option (-r)
+ -
This option has some usage constraints. It: -
-
must be compiled in by defining SAVECONFIG during the compilation. -
must not appear in combination with any of the following options: -quit, wait-sync. -
+
This is the “broadcast/propagation delay” option. +This option takes a string argument. +Specify the default propagation delay from the broadcast/multicast server to this client. This is necessary only if the delay cannot be computed automatically by the protocol. +
+ +
+
+Next: ntpd statsdir, Previous: ntpd propagationdelay, Up: ntpd Invocation
+
+ +
1.1.21 saveconfigquit option
+ -
Cause ntpd to parse its startup configuration file and save an +
This is the “save parsed configuration and quit” option. +This option takes a string argument. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining SAVECONFIG during the compilation. +
must not appear in combination with any of the following options: +quit, wait-sync. +
+ +
Cause ntpd to parse its startup configuration file and save an equivalent to the given filename and exit. This option was -designed for automated testing. -
-
-Next: ntpd trustedkey, -Previous: ntpd saveconfigquit, -Up: ntpd Invocation -
+designed for automated testing. +
+ +
+
+Next: ntpd trustedkey, Previous: ntpd saveconfigquit, Up: ntpd Invocation

+ +
1.1.22 statsdir option (-s)
+ -
statsdir option (-s)
- -
-This is the “statistics file location” option. -This option takes a string argument. -Specify the directory path for files created by the statistics facility. +
This is the “statistics file location” option. +This option takes a string argument. +Specify the directory path for files created by the statistics facility. This is the same operation as the statsdir statsdir -configuration file directive. -
-
-Next: ntpd user, -Previous: ntpd statsdir, -Up: ntpd Invocation -
+configuration file directive. +
+ +
+
+Next: ntpd user, Previous: ntpd statsdir, Up: ntpd Invocation

- -
trustedkey option (-t)
- -
-This is the “trusted key number” option. -This option takes a string argument tkey. - -
This option has some usage constraints. It: -
-
may appear an unlimited number of times. -
- -
Add the specified key number to the trusted key list. -
-
-Next: ntpd updateinterval, -Previous: ntpd trustedkey, -Up: ntpd Invocation -
+ +
1.1.23 trustedkey option (-t)
+ + +
This is the “trusted key number” option. +This option takes a string argument tkey. +
+
This option has some usage constraints. It: +
+
may appear an unlimited number of times. +
+ +
Add the specified key number to the trusted key list. +
+ +
+
+Next: ntpd updateinterval, Previous: ntpd trustedkey, Up: ntpd Invocation

+ +
1.1.24 user option (-u)
+ -
user option (-u)
- -
-This is the “run as userid (or userid:groupid)” option. +
This is the “run as userid (or userid:groupid)” option. This option takes a string argument. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining HAVE_DROPROOT during the compilation. +
-
This option has some usage constraints. It: -
-
must be compiled in by defining HAVE_DROPROOT during the compilation. -
- -
Specify a user, and optionally a group, to switch to. +
Specify a user, and optionally a group, to switch to. This option is only available if the OS supports adjusting the clock -without full root privileges. +without full root privileges. This option is supported under NetBSD (configure with --enable-clockctl) or Linux (configure with ---enable-linuxcaps) or Solaris (configure with --enable-solarisprivs). -
-
-Next: ntpd wait-sync, -Previous: ntpd user, -Up: ntpd Invocation -
+--enable-linuxcaps) or Solaris (configure with --enable-solarisprivs). +
+ +
+
+Next: ntpd wait-sync, Previous: ntpd user, Up: ntpd Invocation

+ +
1.1.25 updateinterval option (-U)
+ -
updateinterval option (-U)
- -
-This is the “interval in seconds between scans for new or dropped interfaces” option. -This option takes a number argument. -Give the time in seconds between two scans for new or dropped interfaces. +
This is the “interval in seconds between scans for new or dropped interfaces” option. +This option takes a number argument. +Give the time in seconds between two scans for new or dropped interfaces. For systems with routing socket support the scans will be performed shortly after the interface change -has been detected by the system. -Use 0 to disable scanning. 60 seconds is the minimum time between scans. -
-
-Next: ntpd slew, -Previous: ntpd updateinterval, -Up: ntpd Invocation -
+has been detected by the system. +Use 0 to disable scanning. 60 seconds is the minimum time between scans. +
+ +
+
+Next: ntpd slew, Previous: ntpd updateinterval, Up: ntpd Invocation

+ +
1.1.26 wait-sync option (-w)
+ -
wait-sync option (-w)
- -
-This is the “seconds to wait for first clock sync” option. +
This is the “seconds to wait for first clock sync” option. This option takes a number argument. - -
This option has some usage constraints. It: -
-
must be compiled in by defining HAVE_WORKING_FORK during the compilation. -
must not appear in combination with any of the following options: -nofork, quit, saveconfigquit. -
- -
If greater than zero, alters ntpd's behavior when forking to +
+
This option has some usage constraints. It: +
+
must be compiled in by defining HAVE_WORKING_FORK during the compilation. +
must not appear in combination with any of the following options: +nofork, quit, saveconfigquit. +
+ +
If greater than zero, alters ntpd’s behavior when forking to daemonize. Instead of exiting with status 0 immediately after the fork, the parent waits up to the specified number of seconds for the child to first synchronize the clock. The exit status is zero (success) if the clock was synchronized, -otherwise it is ETIMEDOUT. +otherwise it is ETIMEDOUT. This provides the option for a script starting ntpd to easily -wait for the first set of the clock before proceeding. -
-
-Next: ntpd usepcc, -Previous: ntpd wait-sync, -Up: ntpd Invocation -
-
- -
slew option (-x)
- -
-This is the “slew up to 600 seconds” option. -Normally, the time is slewed if the offset is less than the step threshold, which is 128 ms by default, and stepped if above the threshold. -This option sets the threshold to 600 s, which is well within the accuracy window to set the clock manually. -Note: Since the slew rate of typical Unix kernels is limited to 0.5 ms/s, each second of adjustment requires an amortization interval of 2000 s. -Thus, an adjustment as much as 600 s will take almost 14 days to complete. +wait for the first set of the clock before proceeding. +
+ +
+
+Next: ntpd usepcc, Previous: ntpd wait-sync, Up: ntpd Invocation
+
+ +
1.1.27 slew option (-x)
+ + +
This is the “slew up to 600 seconds” option. +Normally, the time is slewed if the offset is less than the step threshold, which is 128 ms by default, and stepped if above the threshold. +This option sets the threshold to 600 s, which is well within the accuracy window to set the clock manually. +Note: Since the slew rate of typical Unix kernels is limited to 0.5 ms/s, each second of adjustment requires an amortization interval of 2000 s. +Thus, an adjustment as much as 600 s will take almost 14 days to complete. This option can be used with the -g and -q -options. +options. See the tinker -configuration file directive for other options. -Note: The kernel time discipline is disabled with this option. -
-
-Next: ntpd pccfreq, -Previous: ntpd slew, -Up: ntpd Invocation -
+configuration file directive for other options. +Note: The kernel time discipline is disabled with this option. +
+ +
+
+Next: ntpd pccfreq, Previous: ntpd slew, Up: ntpd Invocation

- -
usepcc option
- -
-This is the “use cpu cycle counter (windows only)” option. - -
This option has some usage constraints. It: -
-
must be compiled in by defining SYS_WINNT during the compilation. -
- -
Attempt to substitute the CPU counter for QueryPerformanceCounter. + +
1.1.28 usepcc option
+ + +
This is the “use cpu cycle counter (windows only)” option. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining SYS_WINNT during the compilation. +
+ +
Attempt to substitute the CPU counter for QueryPerformanceCounter. The CPU counter and QueryPerformanceCounter are compared, and if they have the same frequency, the CPU counter (RDTSC on x86) is -used directly, saving the overhead of a system call. -
-
-Next: ntpd mdns, -Previous: ntpd usepcc, -Up: ntpd Invocation -
+used directly, saving the overhead of a system call. +
+ +
+
+Next: ntpd mdns, Previous: ntpd usepcc, Up: ntpd Invocation

+ +
1.1.29 pccfreq option
+ -
pccfreq option
- -
-This is the “force cpu cycle counter use (windows only)” option. +
This is the “force cpu cycle counter use (windows only)” option. This option takes a string argument. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining SYS_WINNT during the compilation. +
-
This option has some usage constraints. It: -
-
must be compiled in by defining SYS_WINNT during the compilation. -
- -
Force substitution the CPU counter for QueryPerformanceCounter. +
Force substitution the CPU counter for QueryPerformanceCounter. The CPU counter (RDTSC on x86) is used unconditionally with the -given frequency (in Hz). -
-
-Next: ntpd config, -Previous: ntpd pccfreq, -Up: ntpd Invocation -
+given frequency (in Hz). +
+ +
+
+Next: ntpd config, Previous: ntpd pccfreq, Up: ntpd Invocation

- -
mdns option (-m)
- -
-This is the “register with mdns as a ntp server” option. - -
This option has some usage constraints. It: -
-
must be compiled in by defining HAVE_DNSREGISTRATION during the compilation. -
- -
Registers as an NTP server with the local mDNS server which allows + +
1.1.30 mdns option (-m)
+ + +
This is the “register with mdns as a ntp server” option. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining HAVE_DNSREGISTRATION during the compilation. +
+ +
Registers as an NTP server with the local mDNS server which allows the server to be discovered via mDNS client lookup. +
-
-
-Next: ntpd exit status, -Previous: ntpd mdns, -Up: ntpd Invocation -
+
+ +
+
+Next: ntpd exit status, Previous: ntpd mdns, Up: ntpd Invocation

- -
presetting/configuring ntpd
+ +
1.1.31 presetting/configuring ntpd

Any option that is not marked as not presettable may be preset by loading values from environment variables named NTPD and NTPD_<OPTION_NAME>. <OPTION_NAME> must be one of -the options listed above in upper case and segmented with underscores. +the options listed above in upper case and segmented with underscores. The NTPD variable will be tokenized and parsed like the command line. The remaining variables are tested for existence and their values are treated like option arguments. +
-
The command line options relating to configuration and/or usage help are: - -
version (-)
+
The command line options relating to configuration and/or usage help are: +
+ +
version (-)

Print the program version to standard out, optionally with licensing information, then exit 0. The optional argument specifies how much licensing -detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument. +detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument. Only the first letter of the argument is examined: - -
-
version
Only print the version. This is the default. -
copyright
Name the copyright usage licensing terms. -
verbose
Print the full copyright usage licensing terms. +
+
+
‘version’
+
Only print the version. This is the default. +
+
‘copyright’
+
Name the copyright usage licensing terms. +
+
‘verbose’
+
Print the full copyright usage licensing terms. +

-
-
-Next: ntpd Usage, -Previous: ntpd config, -Up: ntpd Invocation -
+
+ +
+
+Next: ntpd Usage, Previous: ntpd config, Up: ntpd Invocation

- -
ntpd exit status
+ +
1.1.32 ntpd exit status

One of the following exit values will be returned: -
-
0 (EXIT_SUCCESS)
Successful program execution. -
1 (EXIT_FAILURE)
The operation failed or the command syntax was not valid. +
+
‘0 (EXIT_SUCCESS)’
+
Successful program execution. +
+
‘1 (EXIT_FAILURE)’
+
The operation failed or the command syntax was not valid. +

-
-
-Next: ntpd Files, -Previous: ntpd exit status, -Up: ntpd Invocation -
+
+ +
+
+Next: ntpd Files, Previous: ntpd exit status, Up: ntpd Invocation

- -
ntpd Usage
- -
-
-Next: ntpd See Also, -Previous: ntpd Usage, -Up: ntpd Invocation -
+ +
1.1.33 ntpd Usage
+
+ +
+
+Next: ntpd See Also, Previous: ntpd Usage, Up: ntpd Invocation

- -
ntpd Files
- -
-
-Next: ntpd Bugs, -Previous: ntpd Files, -Up: ntpd Invocation -
+ +
1.1.34 ntpd Files
+
+ +
+
+Next: ntpd Bugs, Previous: ntpd Files, Up: ntpd Invocation

- -
ntpd See Also
- -
-
-Next: ntpd Notes, -Previous: ntpd See Also, -Up: ntpd Invocation -
+ +
1.1.35 ntpd See Also
+
+ +
+
+Next: ntpd Notes, Previous: ntpd See Also, Up: ntpd Invocation

- -
ntpd Bugs
- -
-
-Previous: ntpd Bugs, -Up: ntpd Invocation -
+ +
1.1.36 ntpd Bugs
+
+ +
+
+Previous: ntpd Bugs, Up: ntpd Invocation

+ +
1.1.37 ntpd Notes
-
ntpd Notes
- -
-
+
-
+
+
+Previous: ntpd Invocation, Up: ntpd Description

- - -
Usage
- + +
1.2 Usage
+ + + + + + + + + + + +
What Default Flag Option
configuration file /etc/ntp.conf -c conffile
frequency file none -f driftfile
leapseconds file none leapfile
process ID file none -p pidfile
log file system log -l logfile
include file none none includefile
statistics path /var/NTP -s statsdir
keys path /usr/local/etc -k keysdir
+
+ + + + + diff --git a/ntpdate/Makefile.am b/ntpdate/Makefile.am index 774cf2978..3abe27a5f 100644 --- a/ntpdate/Makefile.am +++ b/ntpdate/Makefile.am @@ -10,11 +10,14 @@ sbin_PROGRAMS = $(NTPDATE_DS) EXTRA_PROGRAMS = ntpdate AM_CFLAGS = $(CFLAGS_NTP) +AM_CFLAGS += $(NTP_HARD_CFLAGS) AM_CPPFLAGS = $(NTP_INCS) AM_CPPFLAGS += $(CPPFLAGS_NTP) +AM_CPPFLAGS += $(NTP_HARD_CPPFLAGS) AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS += $(NTP_HARD_LDFLAGS) # LDADD might need RESLIB and ADJLIB LDADD = version.o ../libntp/libntp.a diff --git a/ntpdc/Makefile.am b/ntpdc/Makefile.am index a61dab99d..30cfda046 100644 --- a/ntpdc/Makefile.am +++ b/ntpdc/Makefile.am @@ -9,12 +9,15 @@ EXTRA_DATA= check-layout BUILT_SOURCES= @MAKE_CHECK_LAYOUT@ ntpdc-opts.c ntpdc-opts.h AM_CFLAGS = $(CFLAGS_NTP) +AM_CFLAGS += $(NTP_HARD_CFLAGS) AM_CPPFLAGS = $(NTP_INCS) AM_CPPFLAGS += $(LIBOPTS_CFLAGS) AM_CPPFLAGS += $(CPPFLAGS_NTP) +AM_CPPFLAGS += $(NTP_HARD_CPPFLAGS) AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS += $(NTP_HARD_LDFLAGS) # LDADD might need RESLIB and ADJLIB ntpdc_LDADD = version.o $(LIBOPTS_LDADD) diff --git a/ntpdc/ntpdc.html b/ntpdc/ntpdc.html index 5cf93c38b..25d874bc9 100644 --- a/ntpdc/ntpdc.html +++ b/ntpdc/ntpdc.html @@ -1,163 +1,214 @@ - + + + -ntpdc: NTPD Control User's Manual - - - - - - - +ntpdc: NTPD Control User’s Manual + + + + + + + + + + + + - -
ntpdc: NTPD Control User's Manual
-
- -
-Next: ntpdc Description, -Previous: (dir), -Up: (dir) -
+ +
ntpdc: NTPD Control User’s Manual
+ + + -
ntpdc: NTPD Control User Manual
-
This document describes the use of the NTP Project's ntpdc program, + +
+
+Next: ntpdc Description, Previous: (dir), Up: (dir)
+
+ +
ntpdc: NTPD Control User Manual
+ +
This document describes the use of the NTP Project’s ntpdc program, that can be used to query a Network Time Protocol (NTP) server and display the time offset of the system clock relative to the server clock. Run as root, it can correct the system clock to this offset as well. It can be run as an interactive command or from a cron job. - -
This document applies to version 4.2.8p9-win of ntpdc. - -
The program implements the SNTP protocol as defined by RFC 5905, the NTPv4 +
+
This document applies to version 4.2.8p9-win of ntpdc. +
+
The program implements the SNTP protocol as defined by RFC 5905, the NTPv4 IETF specification. +
+ +
Short Table of Contents
-
-
Short Contents
-
-ntpdc: NTPD Control User Manual +
+
+
1 Description

-
-
ntpdc Description: Description -
ntpdc Invocation: Invoking ntpdc -
Usage: Usage -
- -
- -
+ + + + +
• ntpdc Description:    Description +
• ntpdc Invocation:    Invoking ntpdc +
• Usage:    Usage +
+
+ +
+
+Next: ntpdc Invocation, Up: Top

- - -
Description
+ +
1 Description

By default, ntpdc writes the local data and time (i.e., not UTC) to the standard output in the format: +
+
+
1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 secs +
-
1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 secs -
-
where +
where YYYY-MM-DD HH:MM:SS.SUBSEC is the local date and time, (+0800) is the local timezone adjustment (so we would add 8 hours and 0 minutes to convert the reported local time to UTC), and the +4.567 +/- 0.089 secs indicates the time offset and error bound of the system clock relative to the server clock. - -
+
+
-
- - +
+
+Next: Usage, Previous: ntpdc Description, Up: ntpdc Description

+ +
1.1 Invoking ntpdc
+ + -
Invoking ntpdc
-
-
ntpdc -is deprecated. +
ntpdc +is deprecated. Please use ntpq(1ntpqmdoc) instead - it can do everything ntpdc used to do, and it does so using a much more sane interface. - -
ntpdc +
+
ntpdc is a utility program used to query ntpd(1ntpdmdoc) about its -current state and to request changes in that state. -It uses NTP mode 7 control message formats described in the source code. +current state and to request changes in that state. +It uses NTP mode 7 control message formats described in the source code. The program may be run either in interactive mode or controlled using command line -arguments. +arguments. Extensive state and statistics information is available through the ntpdc -interface. +interface. In addition, nearly all the configuration options which can be specified at startup using -ntpd's configuration file may also be specified at run time using +ntpd’s configuration file may also be specified at run time using ntpdc - -
This section was generated by AutoGen, -using the agtexi-cmd template and the option descriptions for the ntpdc program. +
+
This section was generated by AutoGen, +using the agtexi-cmd template and the option descriptions for the ntpdc program. This software is released under the NTP license, <http://ntp.org/license>. - -
-
ntpdc usage: ntpdc help/usage (--help) -
ntpdc ipv4: ipv4 option (-4) -
ntpdc ipv6: ipv6 option (-6) -
ntpdc command: command option (-c) -
ntpdc interactive: interactive option (-i) -
ntpdc listpeers: listpeers option (-l) -
ntpdc numeric: numeric option (-n) -
ntpdc peers: peers option (-p) -
ntpdc showpeers: showpeers option (-s) -
ntpdc config: presetting/configuring ntpdc -
ntpdc exit status: exit status -
ntpdc Usage: Usage -
ntpdc See Also: See Also -
ntpdc Authors: Authors -
ntpdc Bugs: Bugs -
- -
+
+ + + + + + + + + + + + + + + + +
• ntpdc usage:    ntpdc help/usage (--help) +
• ntpdc ipv4:    ipv4 option (-4) +
• ntpdc ipv6:    ipv6 option (-6) +
• ntpdc command:    command option (-c) +
• ntpdc interactive:    interactive option (-i) +
• ntpdc listpeers:    listpeers option (-l) +
• ntpdc numeric:    numeric option (-n) +
• ntpdc peers:    peers option (-p) +
• ntpdc showpeers:    showpeers option (-s) +
• ntpdc config:    presetting/configuring ntpdc +
• ntpdc exit status:    exit status +
• ntpdc Usage:    Usage +
• ntpdc See Also:    See Also +
• ntpdc Authors:    Authors +
• ntpdc Bugs:    Bugs +
+ +
-
-Next: ntpdc ipv4, -Up: ntpdc Invocation - +
+
+Next: ntpdc ipv4, Up: ntpdc Invocation

- -
ntpdc help/usage (--help)
- -
-This is the automatically generated usage text for ntpdc. - -
The text printed is the same whether selected with the help option -(--help) or the more-help option (--more-help). more-help will print -the usage text by passing it through a pager program. + +
1.1.1 ntpdc help/usage (--help)
+ + +
This is the automatically generated usage text for ntpdc. +
+
The text printed is the same whether selected with the help option +(--help) or the more-help option (--more-help). more-help will print +the usage text by passing it through a pager program. more-help is disabled on platforms without a working fork(2) function. The PAGER environment variable is -used to select the program, defaulting to more. Both will exit +used to select the program, defaulting to more. Both will exit with a status code of 0. - -
ntpdc - vendor-specific NTPD control program - Ver. 4.2.8p9-win +
+
+
ntpdc - vendor-specific NTPD control program - Ver. 4.2.8p9 Usage: ntpdc [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [ host ...] Flg Arg Option-Name Description -4 no ipv4 Force IPv4 DNS name resolution @@ -201,335 +252,333 @@ The following option preset mechanisms are supported: - examining environment variables named NTPDC_* Please send bug reports to: <http://bugs.ntp.org, bugs@ntp.org> -
-
- -
-Next: ntpdc ipv6, -Previous: ntpdc usage, -Up: ntpdc Invocation +
+
+ +
+
+Next: ntpdc ipv6, Previous: ntpdc usage, Up: ntpdc Invocation

- -
ipv4 option (-4)
- -
-This is the “force ipv4 dns name resolution” option. - -
This option has some usage constraints. It: -
-
must not appear in combination with any of the following options: -ipv6. -
- -
Force DNS resolution of following host names on the command line -to the IPv4 namespace. -
+ +
1.1.2 ipv4 option (-4)
+ + +
This is the “force ipv4 dns name resolution” option. +
+
This option has some usage constraints. It: +
+
must not appear in combination with any of the following options: +ipv6. +
+ +
Force DNS resolution of following host names on the command line +to the IPv4 namespace. +
-
-Next: ntpdc command, -Previous: ntpdc ipv4, -Up: ntpdc Invocation - +
+
+Next: ntpdc command, Previous: ntpdc ipv4, Up: ntpdc Invocation

- -
ipv6 option (-6)
- -
-This is the “force ipv6 dns name resolution” option. - -
This option has some usage constraints. It: -
-
must not appear in combination with any of the following options: -ipv4. -
- -
Force DNS resolution of following host names on the command line -to the IPv6 namespace. -
+ +
1.1.3 ipv6 option (-6)
+ + +
This is the “force ipv6 dns name resolution” option. +
+
This option has some usage constraints. It: +
+
must not appear in combination with any of the following options: +ipv4. +
+ +
Force DNS resolution of following host names on the command line +to the IPv6 namespace. +
-
-Next: ntpdc interactive, -Previous: ntpdc ipv6, -Up: ntpdc Invocation - +
+
+Next: ntpdc interactive, Previous: ntpdc ipv6, Up: ntpdc Invocation

- -
command option (-c)
- -
-This is the “run a command and exit” option. -This option takes a string argument cmd. - -
This option has some usage constraints. It: -
-
may appear an unlimited number of times. -
- -
The following argument is interpreted as an interactive format command + +
1.1.4 command option (-c)
+ + +
This is the “run a command and exit” option. +This option takes a string argument cmd. +
+
This option has some usage constraints. It: +
+
may appear an unlimited number of times. +
+ +
The following argument is interpreted as an interactive format command and is added to the list of commands to be executed on the specified -host(s). -
+host(s). +
-
-Next: ntpdc listpeers, -Previous: ntpdc command, -Up: ntpdc Invocation - +
+
+Next: ntpdc listpeers, Previous: ntpdc command, Up: ntpdc Invocation

- -
interactive option (-i)
- -
-This is the “force ntpq to operate in interactive mode” option. - -
This option has some usage constraints. It: -
-
must not appear in combination with any of the following options: -command, listpeers, peers, showpeers. -
- -
Force ntpq to operate in interactive mode. Prompts will be written -to the standard output and commands read from the standard input. -
+ +
1.1.5 interactive option (-i)
+ + +
This is the “force ntpq to operate in interactive mode” option. +
+
This option has some usage constraints. It: +
+
must not appear in combination with any of the following options: +command, listpeers, peers, showpeers. +
+ +
Force ntpq to operate in interactive mode. Prompts will be written +to the standard output and commands read from the standard input. +
-
-Next: ntpdc numeric, -Previous: ntpdc interactive, -Up: ntpdc Invocation - +
+
+Next: ntpdc numeric, Previous: ntpdc interactive, Up: ntpdc Invocation

- -
listpeers option (-l)
- -
-This is the “print a list of the peers” option. - -
This option has some usage constraints. It: -
-
must not appear in combination with any of the following options: -command. -
- -
Print a list of the peers known to the server as well as a summary of -their state. This is equivalent to the 'listpeers' interactive command. -
+ +
1.1.6 listpeers option (-l)
+ + +
This is the “print a list of the peers” option. +
+
This option has some usage constraints. It: +
+
must not appear in combination with any of the following options: +command. +
+ +
Print a list of the peers known to the server as well as a summary of +their state. This is equivalent to the ’listpeers’ interactive command. +
-
-Next: ntpdc peers, -Previous: ntpdc listpeers, -Up: ntpdc Invocation - +
+
+Next: ntpdc peers, Previous: ntpdc listpeers, Up: ntpdc Invocation

+ +
1.1.7 numeric option (-n)
+ -
numeric option (-n)
- -
-This is the “numeric host addresses” option. +
This is the “numeric host addresses” option. Output all host addresses in dotted-quad numeric format rather than converting to the canonical host names. -
+
-
-Next: ntpdc showpeers, -Previous: ntpdc numeric, -Up: ntpdc Invocation - +
+
+Next: ntpdc showpeers, Previous: ntpdc numeric, Up: ntpdc Invocation

- -
peers option (-p)
- -
-This is the “print a list of the peers” option. - -
This option has some usage constraints. It: -
-
must not appear in combination with any of the following options: -command. -
- -
Print a list of the peers known to the server as well as a summary -of their state. This is equivalent to the 'peers' interactive command. -
+ +
1.1.8 peers option (-p)
+ + +
This is the “print a list of the peers” option. +
+
This option has some usage constraints. It: +
+
must not appear in combination with any of the following options: +command. +
+ +
Print a list of the peers known to the server as well as a summary +of their state. This is equivalent to the ’peers’ interactive command. +
-
-Next: ntpdc config, -Previous: ntpdc peers, -Up: ntpdc Invocation - +
+
+Next: ntpdc config, Previous: ntpdc peers, Up: ntpdc Invocation

- -
showpeers option (-s)
- -
-This is the “show a list of the peers” option. - -
This option has some usage constraints. It: -
-
must not appear in combination with any of the following options: -command. -
- -
Print a list of the peers known to the server as well as a summary -of their state. This is equivalent to the 'dmpeers' interactive command. - -
+ +
1.1.9 showpeers option (-s)
+ + +
This is the “show a list of the peers” option. +
+
This option has some usage constraints. It: +
+
must not appear in combination with any of the following options: +command. +
+ +
Print a list of the peers known to the server as well as a summary +of their state. This is equivalent to the ’dmpeers’ interactive command. +
+ +
-
-Next: ntpdc exit status, -Previous: ntpdc showpeers, -Up: ntpdc Invocation - +
+
+Next: ntpdc exit status, Previous: ntpdc showpeers, Up: ntpdc Invocation

- -
presetting/configuring ntpdc
+ +
1.1.10 presetting/configuring ntpdc

Any option that is not marked as not presettable may be preset by -loading values from configuration ("rc" or "ini") files, and values from environment variables named NTPDC and NTPDC_<OPTION_NAME>. <OPTION_NAME> must be one of -the options listed above in upper case and segmented with underscores. +loading values from configuration ("rc" or "ini") files, and values from environment variables named NTPDC and NTPDC_<OPTION_NAME>. <OPTION_NAME> must be one of +the options listed above in upper case and segmented with underscores. The NTPDC variable will be tokenized and parsed like the command line. The remaining variables are tested for existence and their values are treated like option arguments. - -
libopts will search in 2 places for configuration files: -
-
$HOME -
$PWD -
- The environment variables HOME, and PWD -are expanded and replaced when ntpdc runs. -For any of these that are plain files, they are simply processed. -For any that are directories, then a file named .ntprc is searched for +
+ +
libopts will search in 2 places for configuration files: +
+
$HOME +
$PWD +
+
The environment variables HOME, and PWD +are expanded and replaced when ntpdc runs. +For any of these that are plain files, they are simply processed. +For any that are directories, then a file named .ntprc is searched for within that directory and processed. - -
Configuration files may be in a wide variety of formats. +
+
Configuration files may be in a wide variety of formats. The basic format is an option name followed by a value (argument) on the same line. Values may be separated from the option name with a colon, equal sign or simply white space. Values may be continued across multiple lines by escaping the newline with a backslash. - -
Multiple programs may also share the same initialization file. +
+
Multiple programs may also share the same initialization file. Common options are collected at the top, followed by program specific segments. The segments are separated by lines like: -
[NTPDC] -
-
or by -
<?program ntpdc> -
-
Do not mix these styles within one configuration file. - -
Compound values and carefully constructed string values may also be +
+
[NTPDC] +
+
or by +
+
<?program ntpdc> +
+
Do not mix these styles within one configuration file. +
+
Compound values and carefully constructed string values may also be specified using XML syntax: -
<option-name> - <sub-opt>...<...>...</sub-opt> - </option-name> -
-
yielding an option-name.sub-opt string value of -
"...<...>..." -
-
AutoOpts does not track suboptions. You simply note that it is a +
+
<option-name> + <sub-opt>...<...>...</sub-opt> +</option-name> +
+
yielding an option-name.sub-opt string value of +
+
"...<...>..." +
+
AutoOpts does not track suboptions. You simply note that it is a hierarchicly valued option. AutoOpts does provide a means for searching the associated name/value pair list (see: optionFindValue). - -
The command line options relating to configuration and/or usage help are: - -
version (-)
+
+
The command line options relating to configuration and/or usage help are: +
+ +
version (-)

Print the program version to standard out, optionally with licensing information, then exit 0. The optional argument specifies how much licensing -detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument. +detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument. Only the first letter of the argument is examined: - -
-
‘version’
Only print the version. This is the default. -
‘copyright’
Name the copyright usage licensing terms. -
‘verbose’
Print the full copyright usage licensing terms. +
+
+
‘version’
+
Only print the version. This is the default. +
+
‘copyright’
+
Name the copyright usage licensing terms. +
+
‘verbose’
+
Print the full copyright usage licensing terms. +

-
+
-
-Next: ntpdc Usage, -Previous: ntpdc config, -Up: ntpdc Invocation - +
+
+Next: ntpdc Usage, Previous: ntpdc config, Up: ntpdc Invocation

- -
ntpdc exit status
+ +
1.1.11 ntpdc exit status

One of the following exit values will be returned: -
-
‘0 (EXIT_SUCCESS)’
Successful program execution. -
‘1 (EXIT_FAILURE)’
The operation failed or the command syntax was not valid. -
‘66 (EX_NOINPUT)’
A specified configuration file could not be loaded. -
‘70 (EX_SOFTWARE)’
libopts had an internal operational error. Please report -it to autogen-users@lists.sourceforge.net. Thank you. +
+
‘0 (EXIT_SUCCESS)’
+
Successful program execution. +
+
‘1 (EXIT_FAILURE)’
+
The operation failed or the command syntax was not valid. +
+
‘66 (EX_NOINPUT)’
+
A specified configuration file could not be loaded. +
+
‘70 (EX_SOFTWARE)’
+
libopts had an internal operational error. Please report +it to autogen-users@lists.sourceforge.net. Thank you. +

-
+
-
-Next: ntpdc See Also, -Previous: ntpdc exit status, -Up: ntpdc Invocation - +
+
+Next: ntpdc See Also, Previous: ntpdc exit status, Up: ntpdc Invocation

- -
ntpdc Usage
- -
+ +
1.1.12 ntpdc Usage
+
-
-Next: ntpdc Authors, -Previous: ntpdc Usage, -Up: ntpdc Invocation - +
+
+Next: ntpdc Authors, Previous: ntpdc Usage, Up: ntpdc Invocation

- -
ntpdc See Also
- -
+ +
1.1.13 ntpdc See Also
+
-
-Next: ntpdc Bugs, -Previous: ntpdc See Also, -Up: ntpdc Invocation - +
+
+Next: ntpdc Bugs, Previous: ntpdc See Also, Up: ntpdc Invocation

- -
ntpdc Authors
- -
+ +
1.1.14 ntpdc Authors
+
-
-Previous: ntpdc Authors, -Up: ntpdc Invocation - +
+
+Previous: ntpdc Authors, Up: ntpdc Invocation

+ +
1.1.15 ntpdc Bugs
-
ntpdc Bugs
- -
+
-
- - +
+
+Previous: ntpdc Invocation, Up: ntpdc Description

- - -
Usage
+ +
1.2 Usage

The simplest use of this program is as an unprivileged command to -check the current time, offset, and error in the local clock. +check the current time, offset, and error in the local clock. For example: +
+
+
ntpdc ntpserver.somewhere +
-
ntpdc ntpserver.somewhere -
-
With suitable privilege, it can be run as a command or in a +
With suitable privilege, it can be run as a command or in a cron job to reset the local clock from a reliable server, like -the ntpdate and rdate commands. +the ntpdate and rdate commands. For example: +
+
+
ntpdc -a ntpserver.somewhere +
+
+ -
ntpdc -a ntpserver.somewhere -
- + + diff --git a/ntpq/Makefile.am b/ntpq/Makefile.am index 50c072a0f..06018fc63 100644 --- a/ntpq/Makefile.am +++ b/ntpq/Makefile.am @@ -6,12 +6,15 @@ libexec_PROGRAMS= $(NTPQ_DL) sbin_PROGRAMS= $(NTPQ_DS) AM_CFLAGS = $(CFLAGS_NTP) +AM_CFLAGS += $(NTP_HARD_CFLAGS) AM_CPPFLAGS = $(NTP_INCS) AM_CPPFLAGS += $(LIBOPTS_CFLAGS) AM_CPPFLAGS += $(CPPFLAGS_NTP) +AM_CPPFLAGS += $(NTP_HARD_CPPFLAGS) -AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS += $(NTP_HARD_LDFLAGS) # LDADD might need RESLIB and ADJLIB ntpq_LDADD = version.o $(LIBOPTS_LDADD) diff --git a/ntpq/ntpq.html b/ntpq/ntpq.html index e4b17893e..b6370d499 100644 --- a/ntpq/ntpq.html +++ b/ntpq/ntpq.html @@ -1,201 +1,246 @@ - + + + -ntpq: Network Time Protocol Query User's Manual - - - - - - - +ntpq: Network Time Protocol Query User’s Manual + + + + + + + + + + + + - -
ntpq: Network Time Protocol Query User's Manual
-
-
Short Contents
-
-ntpq: Network Time Protocol Query User Manual -
-
+ +
ntpq: Network Time Protocol Query User’s Manual
-
-
-Next: ntpq Description, -Previous: (dir), -Up: (dir) -
+ + + + +
Short Table of Contents
+ +
+
+
1 Description
+

-
ntpq: Network Time Protocol Query User Manual
+ + +
+
+Next: ntpq Description, Previous: (dir), Up: (dir)
+
+ +
ntpq: Network Time Protocol Query User Manual

The ntpq utility program is used to monitor the operational status and determine the performance of ntpd, the NTP daemon. - -
This document applies to version 4.2.8p9-win of ntpq. - -
-
ntpq Description -
ntpq Invocation: Invoking ntpq -
Usage -
Internal Commands -
Control Message Commands -
Status Words and Kiss Codes -
System Variables -
Peer Variables -
Clock Variables -
- -
-
-Next: Usage, -Previous: Top, -Up: Top -
+
+
This document applies to version 4.2.8p9-win of ntpq. +
+ + + + + + + + + + +
• ntpq Description:    +
• ntpq Invocation:    Invoking ntpq +
• Usage:    +
• Internal Commands:    +
• Control Message Commands:    +
• Status Words and Kiss Codes:    +
• System Variables:    +
• Peer Variables:    +
• Clock Variables:    +
+ +
+ +
+
+Next: Usage, Previous: Top, Up: Top

+ +
1 Description
- -
Description
- -
The ntpq utility program is used to monitor NTP daemon ntpd operations and determine performance. +
The ntpq utility program is used to monitor NTP daemon ntpd operations and determine performance. It uses the standard NTP mode 6 control message formats defined in -Appendix B of the NTPv3 specification RFC1305. -The same formats are used in NTPv4, although some of the variable names have changed and new ones added. +Appendix B of the NTPv3 specification RFC1305. +The same formats are used in NTPv4, although some of the variable names have changed and new ones added. The description on this page is for the NTPv4 variables. - -
The program can be run either in interactive mode or controlled using command line arguments. Requests to read and write arbitrary variables can be assembled, with raw and pretty-printed output options being available. The ntpq can also obtain and print a list of peers in a common format by sending multiple queries to the server. - -
If one or more request options is included on the command line when ntpq is executed, each of the requests will be sent to the NTP servers running on each of the hosts given as command line arguments, or on localhost by default. If no request options are given, ntpq will attempt to read commands from the standard input and execute these on the NTP server running on the first host given on the command line, again defaulting to localhost when no other host is specified. ntpq will prompt for commands if the standard input is a terminal device. - -
ntpq uses NTP mode 6 packets to communicate with the NTP server, and hence can be used to query any compatible server on the network which permits it. Note that since NTP is a UDP protocol this communication will be somewhat unreliable, especially over large distances in terms of network topology. ntpq makes one attempt to retransmit requests, and will time requests out if the remote host is not heard from within a suitable timeout time. - -
Note that in contexts where a host name is expected, a -4 qualifier preceding the host name forces DNS resolution to the IPv4 namespace, while a -6 qualifier forces DNS resolution to the IPv6 namespace. - -
For examples and usage, see the NTP Debugging Techniques page. - -
-
+
+
The program can be run either in interactive mode or controlled using command line arguments. Requests to read and write arbitrary variables can be assembled, with raw and pretty-printed output options being available. The ntpq can also obtain and print a list of peers in a common format by sending multiple queries to the server. +
+
If one or more request options is included on the command line when ntpq is executed, each of the requests will be sent to the NTP servers running on each of the hosts given as command line arguments, or on localhost by default. If no request options are given, ntpq will attempt to read commands from the standard input and execute these on the NTP server running on the first host given on the command line, again defaulting to localhost when no other host is specified. ntpq will prompt for commands if the standard input is a terminal device. +
+
ntpq uses NTP mode 6 packets to communicate with the NTP server, and hence can be used to query any compatible server on the network which permits it. Note that since NTP is a UDP protocol this communication will be somewhat unreliable, especially over large distances in terms of network topology. ntpq makes one attempt to retransmit requests, and will time requests out if the remote host is not heard from within a suitable timeout time. +
+
Note that in contexts where a host name is expected, a -4 qualifier preceding the host name forces DNS resolution to the IPv4 namespace, while a -6 qualifier forces DNS resolution to the IPv6 namespace. +
+
For examples and usage, see the NTP Debugging Techniques page. +
+
-
+
+
+Next: Usage, Previous: ntpq Description, Up: ntpq Description

+ +
1.1 Invoking ntpq
+ + -
Invoking ntpq
-
- -
The +
The ntpq utility program is used to query NTP servers which implement the standard NTP mode 6 control message formats defined in Appendix B of the NTPv3 specification RFC1305, requesting -information about current state and/or changes in that state. +information about current state and/or changes in that state. The same formats are used in NTPv4, although some of the variables have changed and new ones added. The description on this -page is for the NTPv4 variables. +page is for the NTPv4 variables. The program may be run either in interactive mode or controlled using -command line arguments. +command line arguments. Requests to read and write arbitrary variables can be assembled, with raw and pretty-printed output -options being available. +options being available. The ntpq utility can also obtain and print a list of peers in a common format by sending multiple queries to the server. - -
If one or more request options is included on the command line +
+
If one or more request options is included on the command line when ntpq is executed, each of the requests will be sent to the NTP servers running on each of the hosts given as command -line arguments, or on localhost by default. +line arguments, or on localhost by default. If no request options are given, ntpq will attempt to read commands from the standard input and execute these on the NTP server running on the first host given on the command line, again defaulting to localhost -when no other host is specified. +when no other host is specified. The ntpq utility will prompt for commands if the standard input is a terminal device. - -
ntpq +
+
ntpq uses NTP mode 6 packets to communicate with the NTP server, and hence can be used to query any compatible server on -the network which permits it. +the network which permits it. Note that since NTP is a UDP protocol this communication will be somewhat unreliable, especially over -large distances in terms of network topology. +large distances in terms of network topology. The ntpq utility makes one attempt to retransmit requests, and will time requests out if the remote host is not heard from within a suitable timeout time. - -
Specifying a +
+
Specifying a command line option other than -i or -n will cause the specified query (queries) to be sent to the indicated -host(s) immediately. +host(s) immediately. Otherwise, ntpq will attempt to read interactive format commands from the standard input. - -
Internal Commands
- +
+
1.1.1 Internal Commands

Interactive format commands consist of a keyword followed by zero -to four arguments. +to four arguments. Only enough characters of the full keyword to uniquely identify the command need be typed. - -
A +
+
A number of interactive format commands are executed entirely within the ntpq utility itself and do not result in NTP mode 6 -requests being sent to a server. +requests being sent to a server. These are described following. -
-
? [command_keyword]
help [command_keyword]
A -? +
+
? [command_keyword]
+
help [command_keyword]
+
A +‘?’ by itself will print a list of all the command keywords known to this incarnation of ntpq A -? +‘?’ followed by a command keyword will print function and usage -information about the command. +information about the command. This command is probably a better source of information about ntpq than this manual -page. -
addvars variable_name[=value] ...
rmvars variable_name ...
clearvars
showvars
The data carried by NTP mode 6 messages consists of a list of +page. +
+
addvars variable_name[=value] ...
+
rmvars variable_name ...
+
clearvars
+
showvars
+
The data carried by NTP mode 6 messages consists of a list of items of the form -variable_name=value, +‘variable_name=value’, where the -=value +‘=value’ is ignored, and can be omitted, -in requests to the server to read variables. +in requests to the server to read variables. The ntpq utility maintains an internal list in which data to be included in control @@ -203,144 +248,175 @@ messages can be assembled, and sent using the readlist and writelist -commands described below. +commands described below. The addvars command allows variables and their optional values to be added to -the list. +the list. If more than one variable is to be added, the list should -be comma-separated and not contain white space. +be comma-separated and not contain white space. The rmvars command can be used to remove individual variables from the list, while the clearlist command removes all variables from the -list. +list. The showvars -command displays the current list of optional variables. -
authenticate [yes | no]
Normally +command displays the current list of optional variables. +
+
authenticate [yes | no]
+
Normally ntpq does not authenticate requests unless -they are write requests. +they are write requests. The command -authenticate yes +‘authenticate yes’ causes ntpq to send authentication with all requests it -makes. +makes. Authenticated requests causes some servers to handle requests slightly differently, and can occasionally melt the CPU in fuzzballs if you turn authentication on before doing a peer -display. +display. The command -authenticate +‘authenticate’ causes ntpq to display whether or not ntpq -is currently autheinticating requests. -
cooked
Causes output from query commands to be "cooked", so that +is currently autheinticating requests. +
+
cooked
+
Causes output from query commands to be "cooked", so that variables which are recognized by ntpq will have their -values reformatted for human consumption. +values reformatted for human consumption. Variables which ntpq -thinks should have a decodable value but didn't are +thinks should have a decodable value but didn’t are marked with a trailing -?. -
debug [more | less | off]
With no argument, displays the current debug level. -Otherwise, the debug level is changed to the indicated level. -
delay milliseconds
Specify a time interval to be added to timestamps included in -requests which require authentication. +‘?’. +
+
debug [more | less | off]
+
With no argument, displays the current debug level. +Otherwise, the debug level is changed to the indicated level. +
+
delay milliseconds
+
Specify a time interval to be added to timestamps included in +requests which require authentication. This is used to enable (unreliable) server reconfiguration over long delay network paths -or between machines whose clocks are unsynchronized. +or between machines whose clocks are unsynchronized. Actually the server does not now require timestamps in authenticated requests, -so this command may be obsolete. -
exit
Exit +so this command may be obsolete. +
+
exit
+
Exit ntpq -
host hostname
Set the host to which future queries will be sent. +
+
host hostname
+
Set the host to which future queries will be sent. hostname -may be either a host name or a numeric address. -
hostnames [yes | no]
If +may be either a host name or a numeric address. +
+
hostnames [yes | no]
+
If yes is specified, host names are printed in -information displays. +information displays. If no is specified, numeric -addresses are printed instead. +addresses are printed instead. The default is yes, unless modified using the command line -n -switch. -
keyid keyid
This command allows the specification of a key number to be -used to authenticate configuration requests. +switch. +
+
keyid keyid
+
This command allows the specification of a key number to be +used to authenticate configuration requests. This must correspond to the controlkey key number the server has been configured to use for this -purpose. -
keytype [md5 | OpenSSLDigestType]
Specify the type of key to use for authenticating requests. +purpose. +
+
keytype [md5 | OpenSSLDigestType]
+
Specify the type of key to use for authenticating requests. md5 -is alway supported. +is alway supported. If ntpq was built with OpenSSL support, -any digest type supported by OpenSSL can also be provided. +any digest type supported by OpenSSL can also be provided. If no argument is given, the current keytype -is displayed. -
ntpversion [1 | 2 | 3 | 4]
Sets the NTP version number which +is displayed. +
+
ntpversion [1 | 2 | 3 | 4]
+
Sets the NTP version number which ntpq claims in -packets. +packets. Defaults to 3, and note that mode 6 control messages (and -modes, for that matter) didn't exist in NTP version 1. +modes, for that matter) didn’t exist in NTP version 1. There appear -to be no servers left which demand version 1. +to be no servers left which demand version 1. With no argument, displays the current NTP version that will be used -when communicating with servers. -
passwd
This command prompts you to type in a password (which will not +when communicating with servers. +
+
passwd
+
This command prompts you to type in a password (which will not be echoed) which will be used to authenticate configuration -requests. +requests. The password must correspond to the key configured for use by the NTP server for this purpose if such requests are to be -successful. +successful. poll n verbose -
quit
Exit +
+
quit
+
Exit ntpq -
raw
Causes all output from query commands is printed as received -from the remote server. +
+
raw
+
Causes all output from query commands is printed as received +from the remote server. The only formating/interpretation done on the data is to transform nonascii data into a printable (but barely -understandable) form. -
timeout milliseconds
Specify a timeout period for responses to server queries. +understandable) form. +
+
timeout milliseconds
+
Specify a timeout period for responses to server queries. The -default is about 5000 milliseconds. +default is about 5000 milliseconds. Note that since ntpq retries each query once after a timeout, the total waiting time for -a timeout will be twice the timeout value set. -
version
Print the version of the +a timeout will be twice the timeout value set. +
+
version
+
Print the version of the ntpq -program. +program. +

-
Control Message Commands
- -
Association IDs are used to identify system, peer and clock variables. -System variables are assigned an association ID of zero and system name space, while each association is assigned a nonzero association ID and peer namespace. -Most control commands send a single mode-6 message to the server and expect a single response message. + +
1.1.1.1 Control Message Commands
+
Association IDs are used to identify system, peer and clock variables. +System variables are assigned an association ID of zero and system name space, while each association is assigned a nonzero association ID and peer namespace. +Most control commands send a single mode-6 message to the server and expect a single response message. The exceptions are the peers command, which sends a series of messages, @@ -349,30 +425,67 @@ and the and mreadvar commands, which iterate over a range of associations. -
-
associations
Display a list of mobilized associations in the form: -
ind assid status conf reach auth condition last_event cnt -
-
-
Sy String Ta Sy Description
ind Ta index on this list
assid Ta association ID
status Ta peer status word
conf Ta yes: persistent, no: ephemeral
reach Ta yes: reachable, no: unreachable
auth Ta ok, yes, bad and none
condition Ta selection status (see the select field of the peer status word)
last_event Ta event report (see the event field of the peer status word)
cnt Ta event count (see the count field of the peer status word)
-
authinfo
Display the authentication statistics. -
clockvar assocID [name[=value]] [...]
cv assocID [name[=value]] [...]
Display a list of clock variables for those associations supporting a reference clock. -
:config [...]
Send the remainder of the command line, including whitespace, to the server as a run-time configuration command in the same format as a line in the configuration file. This command is experimental until further notice and clarification. Authentication is of course required. -
config-from-file filename
Send the each line of +
+
associations
+
Display a list of mobilized associations in the form: +
+
ind assid status conf reach auth condition last_event cnt +
+
+
Sy String Ta Sy Description
+
ind Ta index on this list
+
assid Ta association ID
+
status Ta peer status word
+
conf Ta yes: persistent, no: ephemeral
+
reach Ta yes: reachable, no: unreachable
+
auth Ta ok, yes, bad and none
+
condition Ta selection status (see the select field of the peer status word)
+
last_event Ta event report (see the event field of the peer status word)
+
cnt Ta event count (see the count field of the peer status word)
+
+
+
authinfo
+
Display the authentication statistics. +
+
clockvar assocID [name[=value]] [...]
+
cv assocID [name[=value]] [...]
+
Display a list of clock variables for those associations supporting a reference clock. +
+
:config [...]
+
Send the remainder of the command line, including whitespace, to the server as a run-time configuration command in the same format as a line in the configuration file. This command is experimental until further notice and clarification. Authentication is of course required. +
+
config-from-file filename
+
Send the each line of filename -to the server as run-time configuration commands in the same format as a line in the configuration file. This command is experimental until further notice and clarification. Authentication is required. -
ifstats
Display statistics for each local network address. Authentication is required. -
iostats
Display network and reference clock I/O statistics. -
kerninfo
Display kernel loop and PPS statistics. As with other ntpq output, times are in milliseconds. The precision value displayed is in milliseconds as well, unlike the precision system variable. -
lassociations
Perform the same function as the associations command, except display mobilized and unmobilized associations. -
lopeers [-4 | -6]
Obtain and print a list of all peers and clients showing +to the server as run-time configuration commands in the same format as a line in the configuration file. This command is experimental until further notice and clarification. Authentication is required. +
+
ifstats
+
Display statistics for each local network address. Authentication is required. +
+
iostats
+
Display network and reference clock I/O statistics. +
+
kerninfo
+
Display kernel loop and PPS statistics. As with other ntpq output, times are in milliseconds. The precision value displayed is in milliseconds as well, unlike the precision system variable. +
+
lassociations
+
Perform the same function as the associations command, except display mobilized and unmobilized associations. +
+
lopeers [-4 | -6]
+
Obtain and print a list of all peers and clients showing dstadr -(associated with any given IP version). -
lpeers [-4 | -6]
Print a peer spreadsheet for the appropriate IP version(s). +(associated with any given IP version). +
+
lpeers [-4 | -6]
+
Print a peer spreadsheet for the appropriate IP version(s). dstadr -(associated with any given IP version). -
monstats
Display monitor facility statistics. -
mrulist [limited | kod | mincount=count | laddr=localaddr | sort=sortorder | resany=hexmask | resall=hexmask]
Obtain and print traffic counts collected and maintained by the monitor facility. +(associated with any given IP version). +
+
monstats
+
Display monitor facility statistics. +
+
mrulist [limited | kod | mincount=count | laddr=localaddr | sort=sortorder | resany=hexmask | resall=hexmask]
+
Obtain and print traffic counts collected and maintained by the monitor facility. With the exception of sort=sortorder, the options filter the list returned by @@ -381,23 +494,23 @@ The limited and kod -options return only entries representing client addresses from which the last packet received triggered either discarding or a KoD response. +options return only entries representing client addresses from which the last packet received triggered either discarding or a KoD response. The mincount=count option filters entries representing less than count -packets. +packets. The laddr=localaddr option filters entries for packets received on any local address other than -localaddr. +localaddr. resany=hexmask and resall=hexmask filter entries containing none or less than all, respectively, of the bits in hexmask, which must begin with -0x. +0x. The sortorder defaults to @@ -407,65 +520,106 @@ and may be any of count, avgint, lstint, -or any of those preceded by a minus sign (hyphen) to reverse the sort order. +or any of those preceded by a minus sign (hyphen) to reverse the sort order. The output columns are: -
-
Column
Description -
lstint
Interval in s between the receipt of the most recent packet from this address and the completion of the retrieval of the MRU list by +
+
Column
+
Description +
+
lstint
+
Interval in s between the receipt of the most recent packet from this address and the completion of the retrieval of the MRU list by ntpq -
avgint
Average interval in s between packets from this address. -
rstr
Restriction flags associated with this address. +
+
avgint
+
Average interval in s between packets from this address. +
+
rstr
+
Restriction flags associated with this address. Most are copied unchanged from the matching restrict -command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless the last packet from this address triggered a rate control response. -
r
Rate control indicator, either +command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless the last packet from this address triggered a rate control response. +
+
r
+
Rate control indicator, either a period, L or K for no rate control response, -rate limiting by discarding, or rate limiting with a KoD response, respectively. -
m
Packet mode. -
v
Packet version number. -
count
Packets received from this address. -
rport
Source port of last packet from this address. -
remote address
DNS name, numeric address, or address followed by -claimed DNS name which could not be verified in parentheses. +rate limiting by discarding, or rate limiting with a KoD response, respectively. +
+
m
+
Packet mode. +
+
v
+
Packet version number. +
+
count
+
Packets received from this address. +
+
rport
+
Source port of last packet from this address. +
+
remote address
+
DNS name, numeric address, or address followed by +claimed DNS name which could not be verified in parentheses. +

-
mreadvar assocID assocID [variable_name[=value] ...]
mrv assocID assocID [variable_name[=value] ...]
Perform the same function as the +
+
mreadvar assocID assocID [variable_name[=value] ...]
+
mrv assocID assocID [variable_name[=value] ...]
+
Perform the same function as the readvar -command, except for a range of association IDs. +command, except for a range of association IDs. This range is determined from the association list cached by the most recent associations -command. -
opeers [-4 | -6]
Obtain and print the old-style list of all peers and clients showing +command. +
+
opeers [-4 | -6]
+
Obtain and print the old-style list of all peers and clients showing dstadr (associated with any given IP version), rather than the -refid. -
passociations
Perform the same function as the +refid. +
+
passociations
+
Perform the same function as the associations command, -except that it uses previously stored data rather than making a new query. -
peers
Display a list of peers in the form: -
[tally]remote refid st t when pool reach delay offset jitter -
-
-
Variable
Description -
[tally]
single-character code indicating current value of the +except that it uses previously stored data rather than making a new query. +
+
peers
+
Display a list of peers in the form: +
+
[tally]remote refid st t when pool reach delay offset jitter +
+
+
Variable
+
Description +
+
[tally]
+
single-character code indicating current value of the select field of the -.Lk decode.html#peer "peer status word" -
remote
host name (or IP number) of peer. +.Lk decode.html#peer "peer status word" +
+
remote
+
host name (or IP number) of peer. The value displayed will be truncated to 15 characters unless the -w flag is given, in which case the full value will be displayed on the first line, -and the remaining data is displayed on the next line. -
refid
association ID or -.Lk decode.html#kiss "'kiss code" -
st
stratum -
t
u: +and the remaining data is displayed on the next line. +
+
refid
+
association ID or +.Lk decode.html#kiss "’kiss code" +
+
st
+
stratum +
+
t
+
u: unicast or manycast client, b: broadcast or multicast client, @@ -479,298 +633,518 @@ manycast server, broadcast server, M: multicast server -
when
sec/min/hr since last received packet -
poll
poll interval (log2 s) -
reach
reach shift register (octal) -
delay
roundtrip delay -
offset
offset of server relative to this host -
jitter
jitter +
+
when
+
sec/min/hr since last received packet +
+
poll
+
poll interval (log2 s) +
+
reach
+
reach shift register (octal) +
+
delay
+
roundtrip delay +
+
offset
+
offset of server relative to this host +
+
jitter
+
jitter +

-
apeers
Display a list of peers in the form: -
[tally]remote refid assid st t when pool reach delay offset jitter -
-
where the output is just like the +
+
apeers
+
Display a list of peers in the form: +
+
[tally]remote refid assid st t when pool reach delay offset jitter +
+
where the output is just like the peers command except that the refid -is displayed in hex format and the association number is also displayed. -
pstats assocID
Show the statistics for the peer with the given -assocID. -
readlist assocID
rl assocID
Read the system or peer variables included in the variable list. -
readvar assocID name[=value] [, ...]
rv assocID name[=value] [, ...]
Display the specified variables. +is displayed in hex format and the association number is also displayed. +
+
pstats assocID
+
Show the statistics for the peer with the given +assocID. +
+
readlist assocID
+
rl assocID
+
Read the system or peer variables included in the variable list. +
+
readvar assocID name[=value] [, ...]
+
rv assocID name[=value] [, ...]
+
Display the specified variables. If assocID is zero, the variables are from the System Variables name space, otherwise they are from the Peer Variables -name space. +name space. The assocID -is required, as the same name can occur in both spaces. +is required, as the same name can occur in both spaces. If no name is included, all operative variables in the name space are displayed. - -
In this case only, if the +
+
In this case only, if the assocID -is omitted, it is assumed zero. -Multiple names are specified with comma separators and without whitespace. +is omitted, it is assumed zero. +Multiple names are specified with comma separators and without whitespace. Note that time values are represented in milliseconds -and frequency values in parts-per-million (PPM). +and frequency values in parts-per-million (PPM). Some NTP timestamps are represented in the format YYYYMMDDTTTT , where YYYY is the year, MM the month of year, DD the day of month and -TTTT the time of day. -
reslist
Show the access control (restrict) list for +TTTT the time of day. +
+
reslist
+
Show the access control (restrict) list for ntpq - -
saveconfig filename
Write the current configuration, +
+
+
saveconfig filename
+
Write the current configuration, including any runtime modifications given with :config or config-from-file, -to the ntpd host's file -filename. +to the ntpd host’s file +filename. This command will be rejected by the server unless -.Lk miscopt.html#saveconfigdir "saveconfigdir" +.Lk miscopt.html#saveconfigdir "saveconfigdir" appears in the ntpd -configuration file. +configuration file. filename can use strftime() format specifies to substitute the current date and time, for example, -q]saveconfig ntp-%Y%m%d-%H%M%S.confq]. +q]saveconfig ntp-%Y%m%d-%H%M%S.confq]. The filename used is stored in system variable -savedconfig. -Authentication is required. -
timerstats
Display interval timer counters. -
writelist assocID
Write the system or peer variables included in the variable list. -
writevar assocID name=value [, ...]
Write the specified variables. +savedconfig. +Authentication is required. +
+
timerstats
+
Display interval timer counters. +
+
writelist assocID
+
Write the system or peer variables included in the variable list. +
+
writevar assocID name=value [, ...]
+
Write the specified variables. If the assocID is zero, the variables are from the System Variables name space, otherwise they are from the Peer Variables -name space. +name space. The assocID -is required, as the same name can occur in both spaces. -
sysinfo
Display operational summary. -
sysstats
Print statistics counters maintained in the protocol module. +is required, as the same name can occur in both spaces. +
+
sysinfo
+
Display operational summary. +
+
sysstats
+
Print statistics counters maintained in the protocol module. +

-
Status Words and Kiss Codes
+ +
1.1.1.2 Status Words and Kiss Codes

The current state of the operating program is shown in a set of status words -maintained by the system. -Status information is also available on a per-association basis. +maintained by the system. +Status information is also available on a per-association basis. These words are displayed in the rv and as -commands both in hexadecimal and in decoded short tip strings. +commands both in hexadecimal and in decoded short tip strings. The codes, tips and short explanations are documented on the -.Lk decode.html "Event Messages and Status Words" -page. +.Lk decode.html "Event Messages and Status Words" +page. The page also includes a list of system and peer messages, the code for the latest of which is included in the status word. - -
Information resulting from protocol machine state transitions +
+
Information resulting from protocol machine state transitions is displayed using an informal set of ASCII strings called -.Lk decode.html#kiss "kiss codes" . -The original purpose was for kiss-o'-death (KoD) packets -sent by the server to advise the client of an unusual condition. +.Lk decode.html#kiss "kiss codes" . +The original purpose was for kiss-o’-death (KoD) packets +sent by the server to advise the client of an unusual condition. They are now displayed, when appropriate, in the reference identifier field in various billboards. - -
System Variables
- +
+ +
1.1.1.3 System Variables

The following system variables appear in the rv -billboard. +billboard. Not all variables are displayed in some configurations. -
-
Variable
Description -
status
.Lk decode.html#sys "system status word" -
version
NTP software version and build time -
processor
hardware platform and version -
system
operating system and version -
leap
leap warning indicator (0-3) -
stratum
stratum (1-15) -
precision
precision (log2 s) -
rootdelay
total roundtrip delay to the primary reference clock -
rootdisp
total dispersion to the primary reference clock -
peer
system peer association ID -
tc
time constant and poll exponent (log2 s) (3-17) -
mintc
minimum time constant (log2 s) (3-10) -
clock
date and time of day -
refid
reference ID or -.Lk decode.html#kiss "kiss code" -
reftime
reference time -
offset
combined offset of server relative to this host -
sys_jitter
combined system jitter -
frequency
frequency offset (PPM) relative to hardware clock -
clk_wander
clock frequency wander (PPM) -
clk_jitter
clock jitter -
tai
TAI-UTC offset (s) -
leapsec
NTP seconds when the next leap second is/was inserted -
expire
NTP seconds when the NIST leapseconds file expires +
+
Variable
+
Description +
+
status
+
.Lk decode.html#sys "system status word" +
+
version
+
NTP software version and build time +
+
processor
+
hardware platform and version +
+
system
+
operating system and version +
+
leap
+
leap warning indicator (0-3) +
+
stratum
+
stratum (1-15) +
+
precision
+
precision (log2 s) +
+
rootdelay
+
total roundtrip delay to the primary reference clock +
+
rootdisp
+
total dispersion to the primary reference clock +
+
peer
+
system peer association ID +
+
tc
+
time constant and poll exponent (log2 s) (3-17) +
+
mintc
+
minimum time constant (log2 s) (3-10) +
+
clock
+
date and time of day +
+
refid
+
reference ID or +.Lk decode.html#kiss "kiss code" +
+
reftime
+
reference time +
+
offset
+
combined offset of server relative to this host +
+
sys_jitter
+
combined system jitter +
+
frequency
+
frequency offset (PPM) relative to hardware clock +
+
clk_wander
+
clock frequency wander (PPM) +
+
clk_jitter
+
clock jitter +
+
tai
+
TAI-UTC offset (s) +
+
leapsec
+
NTP seconds when the next leap second is/was inserted +
+
expire
+
NTP seconds when the NIST leapseconds file expires +

- The jitter and wander statistics are exponentially-weighted RMS averages. +
The jitter and wander statistics are exponentially-weighted RMS averages. The system jitter is defined in the NTPv4 specification; the clock jitter statistic is computed by the clock discipline module. - -
When the NTPv4 daemon is compiled with the OpenSSL software library, +
+
When the NTPv4 daemon is compiled with the OpenSSL software library, additional system variables are displayed, including some or all of the following, depending on the particular Autokey dance: - -
-
Variable
Description -
host
Autokey host name for this host -
ident
Autokey group name for this host -
flags
host flags (see Autokey specification) -
digest
OpenSSL message digest algorithm -
signature
OpenSSL digest/signature scheme -
update
NTP seconds at last signature update -
cert
certificate subject, issuer and certificate flags -
until
NTP seconds when the certificate expires +
+
+
Variable
+
Description +
+
host
+
Autokey host name for this host +
+
ident
+
Autokey group name for this host +
+
flags
+
host flags (see Autokey specification) +
+
digest
+
OpenSSL message digest algorithm +
+
signature
+
OpenSSL digest/signature scheme +
+
update
+
NTP seconds at last signature update +
+
cert
+
certificate subject, issuer and certificate flags +
+
until
+
NTP seconds when the certificate expires +

- -
Peer Variables
- + +
1.1.1.4 Peer Variables

The following peer variables appear in the rv -billboard for each association. +billboard for each association. Not all variables are displayed in some configurations. - -
-
Variable
Description -
associd
association ID -
status
.Lk decode.html#peer "peer status word" -
srcadr
source (remote) IP address -
srcport
source (remote) port -
dstadr
destination (local) IP address -
dstport
destination (local) port -
leap
leap indicator (0-3) -
stratum
stratum (0-15) -
precision
precision (log2 s) -
rootdelay
total roundtrip delay to the primary reference clock -
rootdisp
total root dispersion to the primary reference clock -
refid
reference ID or -.Lk decode.html#kiss "kiss code" -
reftime
reference time -
reach
reach register (octal) -
unreach
unreach counter -
hmode
host mode (1-6) -
pmode
peer mode (1-5) -
hpoll
host poll exponent (log2 s) (3-17) -
ppoll
peer poll exponent (log2 s) (3-17) -
headway
headway (see -.Lk rate.html "Rate Management and the Kiss-o'-Death Packet" ) -
flash
.Lk decode.html#flash "flash status word" -
offset
filter offset -
delay
filter delay -
dispersion
filter dispersion -
jitter
filter jitter -
ident
Autokey group name for this association -
bias
unicast/broadcast bias -
xleave
interleave delay (see -.Lk xleave.html "NTP Interleaved Modes" ) +
+
+
Variable
+
Description +
+
associd
+
association ID +
+
status
+
.Lk decode.html#peer "peer status word" +
+
srcadr
+
source (remote) IP address +
+
srcport
+
source (remote) port +
+
dstadr
+
destination (local) IP address +
+
dstport
+
destination (local) port +
+
leap
+
leap indicator (0-3) +
+
stratum
+
stratum (0-15) +
+
precision
+
precision (log2 s) +
+
rootdelay
+
total roundtrip delay to the primary reference clock +
+
rootdisp
+
total root dispersion to the primary reference clock +
+
refid
+
reference ID or +.Lk decode.html#kiss "kiss code" +
+
reftime
+
reference time +
+
reach
+
reach register (octal) +
+
unreach
+
unreach counter +
+
hmode
+
host mode (1-6) +
+
pmode
+
peer mode (1-5) +
+
hpoll
+
host poll exponent (log2 s) (3-17) +
+
ppoll
+
peer poll exponent (log2 s) (3-17) +
+
headway
+
headway (see +.Lk rate.html "Rate Management and the Kiss-o’-Death Packet" ) +
+
flash
+
.Lk decode.html#flash "flash status word" +
+
offset
+
filter offset +
+
delay
+
filter delay +
+
dispersion
+
filter dispersion +
+
jitter
+
filter jitter +
+
ident
+
Autokey group name for this association +
+
bias
+
unicast/broadcast bias +
+
xleave
+
interleave delay (see +.Lk xleave.html "NTP Interleaved Modes" ) +

- The +
The bias variable is calculated when the first broadcast packet is received -after the calibration volley. -It represents the offset of the broadcast subgraph relative to the unicast subgraph. +after the calibration volley. +It represents the offset of the broadcast subgraph relative to the unicast subgraph. The xleave -variable appears only for the interleaved symmetric and interleaved modes. +variable appears only for the interleaved symmetric and interleaved modes. It represents the internal queuing, buffering and transmission delays for the preceding packet. - -
When the NTPv4 daemon is compiled with the OpenSSL software library, +
+
When the NTPv4 daemon is compiled with the OpenSSL software library, additional peer variables are displayed, including the following: -
-
Variable
Description -
flags
peer flags (see Autokey specification) -
host
Autokey server name -
flags
peer flags (see Autokey specification) -
signature
OpenSSL digest/signature scheme -
initsequence
initial key ID -
initkey
initial key index -
timestamp
Autokey signature timestamp +
+
Variable
+
Description +
+
flags
+
peer flags (see Autokey specification) +
+
host
+
Autokey server name +
+
flags
+
peer flags (see Autokey specification) +
+
signature
+
OpenSSL digest/signature scheme +
+
initsequence
+
initial key ID +
+
initkey
+
initial key index +
+
timestamp
+
Autokey signature timestamp +

-
Clock Variables
- + +
1.1.1.5 Clock Variables

The following clock variables appear in the cv -billboard for each association with a reference clock. +billboard for each association with a reference clock. Not all variables are displayed in some configurations. -
-
Variable
Description -
associd
association ID -
status
.Lk decode.html#clock "clock status word" -
device
device description -
timecode
ASCII time code string (specific to device) -
poll
poll messages sent -
noreply
no reply -
badformat
bad format -
baddata
bad date or time -
fudgetime1
fudge time 1 -
fudgetime2
fudge time 2 -
stratum
driver stratum -
refid
driver reference ID -
flags
driver flags +
+
Variable
+
Description +
+
associd
+
association ID +
+
status
+
.Lk decode.html#clock "clock status word" +
+
device
+
device description +
+
timecode
+
ASCII time code string (specific to device) +
+
poll
+
poll messages sent +
+
noreply
+
no reply +
+
badformat
+
bad format +
+
baddata
+
bad date or time +
+
fudgetime1
+
fudge time 1 +
+
fudgetime2
+
fudge time 2 +
+
stratum
+
driver stratum +
+
refid
+
driver reference ID +
+
flags
+
driver flags +

-
This section was generated by AutoGen, -using the agtexi-cmd template and the option descriptions for the ntpq program. +
This section was generated by AutoGen, +using the agtexi-cmd template and the option descriptions for the ntpq program. This software is released under the NTP license, <http://ntp.org/license>. - -
-
ntpq usage: ntpq help/usage (--help) -
ntpq ipv4: ipv4 option (-4) -
ntpq ipv6: ipv6 option (-6) -
ntpq command: command option (-c) -
ntpq interactive: interactive option (-i) -
ntpq numeric: numeric option (-n) -
ntpq old-rv: old-rv option -
ntpq peers: peers option (-p) -
ntpq refid: refid option (-r) -
ntpq wide: wide option (-w) -
ntpq config: presetting/configuring ntpq -
ntpq exit status: exit status -
- -
-
-Next: ntpq ipv4, -Up: ntpq Invocation -
+
+ + + + + + + + + + + + + +
• ntpq usage:    ntpq help/usage (--help) +
• ntpq ipv4:    ipv4 option (-4) +
• ntpq ipv6:    ipv6 option (-6) +
• ntpq command:    command option (-c) +
• ntpq interactive:    interactive option (-i) +
• ntpq numeric:    numeric option (-n) +
• ntpq old-rv:    old-rv option +
• ntpq peers:    peers option (-p) +
• ntpq refid:    refid option (-r) +
• ntpq wide:    wide option (-w) +
• ntpq config:    presetting/configuring ntpq +
• ntpq exit status:    exit status +
+ +
+ +
+
+Next: ntpq ipv4, Up: ntpq Invocation

- -
ntpq help/usage (--help)
- -
-This is the automatically generated usage text for ntpq. - -
The text printed is the same whether selected with the help option -(--help) or the more-help option (--more-help). more-help will print -the usage text by passing it through a pager program. + +
1.1.2 ntpq help/usage (--help)
+ + +
This is the automatically generated usage text for ntpq. +
+
The text printed is the same whether selected with the help option +(--help) or the more-help option (--more-help). more-help will print +the usage text by passing it through a pager program. more-help is disabled on platforms without a working fork(2) function. The PAGER environment variable is -used to select the program, defaulting to more. Both will exit +used to select the program, defaulting to more. Both will exit with a status code of 0. - -
ntpq - standard NTP query program - Ver. 4.2.8p9-win1 +
+
+
ntpq - standard NTP query program - Ver. 4.2.8p9 Usage: ntpq [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [ host ...] Flg Arg Option-Name Description -4 no ipv4 Force IPv4 DNS name resolution @@ -809,1046 +1183,827 @@ The following option preset mechanisms are supported: - reading file ./.ntprc - examining environment variables named NTPQ_* -The valid "refid" option keywords are: +The valid "refid" option keywords are: hash ipv4 or an integer from 0 through 1 Please send bug reports to: <http://bugs.ntp.org, bugs@ntp.org> -
-
-
-Next: ntpq ipv6, -Previous: ntpq usage, -Up: ntpq Invocation -
-
- -
ipv4 option (-4)
+
-
-This is the “force ipv4 dns name resolution” option. - -
This option has some usage constraints. It: -
-
must not appear in combination with any of the following options: -ipv6. -
- -
Force DNS resolution of following host names on the command line -to the IPv4 namespace. -
-
-Next: ntpq command, -Previous: ntpq ipv4, -Up: ntpq Invocation -
+
+ +
+
+Next: ntpq ipv6, Previous: ntpq usage, Up: ntpq Invocation

- -
ipv6 option (-6)
- -
-This is the “force ipv6 dns name resolution” option. - -
This option has some usage constraints. It: -
-
must not appear in combination with any of the following options: -ipv4. -
- -
Force DNS resolution of following host names on the command line -to the IPv6 namespace. -
-
-Next: ntpq interactive, -Previous: ntpq ipv6, -Up: ntpq Invocation -
+ +
1.1.3 ipv4 option (-4)
+ + +
This is the “force ipv4 dns name resolution” option. +
+
This option has some usage constraints. It: +
+
must not appear in combination with any of the following options: +ipv6. +
+ +
Force DNS resolution of following host names on the command line +to the IPv4 namespace. +
+ +
+
+Next: ntpq command, Previous: ntpq ipv4, Up: ntpq Invocation

- -
command option (-c)
- -
-This is the “run a command and exit” option. -This option takes a string argument cmd. - -
This option has some usage constraints. It: -
-
may appear an unlimited number of times. -
- -
The following argument is interpreted as an interactive format command + +
1.1.4 ipv6 option (-6)
+ + +
This is the “force ipv6 dns name resolution” option. +
+
This option has some usage constraints. It: +
+
must not appear in combination with any of the following options: +ipv4. +
+ +
Force DNS resolution of following host names on the command line +to the IPv6 namespace. +
+ +
+
+Next: ntpq interactive, Previous: ntpq ipv6, Up: ntpq Invocation
+
+ +
1.1.5 command option (-c)
+ + +
This is the “run a command and exit” option. +This option takes a string argument cmd. +
+
This option has some usage constraints. It: +
+
may appear an unlimited number of times. +
+ +
The following argument is interpreted as an interactive format command and is added to the list of commands to be executed on the specified -host(s). -
-
-Next: ntpq numeric, -Previous: ntpq command, -Up: ntpq Invocation -
+host(s). +
+ +
+
+Next: ntpq numeric, Previous: ntpq command, Up: ntpq Invocation

- -
interactive option (-i)
- -
-This is the “force ntpq to operate in interactive mode” option. - -
This option has some usage constraints. It: -
-
must not appear in combination with any of the following options: -command, peers. -
- -
Force ntpq to operate in interactive mode. + +
1.1.6 interactive option (-i)
+ + +
This is the “force ntpq to operate in interactive mode” option. +
+
This option has some usage constraints. It: +
+
must not appear in combination with any of the following options: +command, peers. +
+ +
Force ntpq to operate in interactive mode. Prompts will be written to the standard output and -commands read from the standard input. -
-
-Next: ntpq old-rv, -Previous: ntpq interactive, -Up: ntpq Invocation -
+commands read from the standard input. +
+ +
+
+Next: ntpq old-rv, Previous: ntpq interactive, Up: ntpq Invocation

+ +
1.1.7 numeric option (-n)
+ -
numeric option (-n)
- -
-This is the “numeric host addresses” option. +
This is the “numeric host addresses” option. Output all host addresses in dotted-quad numeric format rather than converting to the canonical host names. -
-
-Next: ntpq peers, -Previous: ntpq numeric, -Up: ntpq Invocation -
+
+ +
+
+Next: ntpq peers, Previous: ntpq numeric, Up: ntpq Invocation

+ +
1.1.8 old-rv option
+ -
old-rv option
- -
-This is the “always output status line with readvar” option. +
This is the “always output status line with readvar” option. By default, ntpq now suppresses the associd=... line that precedes the output of readvar (alias rv) when a single variable is requested, such as -ntpq -c "rv 0 offset". +ntpq -c "rv 0 offset". This option causes ntpq to include both lines of output -for a single-variable readvar. +for a single-variable readvar. Using an environment variable to preset this option in a script will enable both older and -newer ntpq to behave identically in this regard. -
-
-Next: ntpq refid, -Previous: ntpq old-rv, -Up: ntpq Invocation -
+newer ntpq to behave identically in this regard. +
+ +
+
+Next: ntpq refid, Previous: ntpq old-rv, Up: ntpq Invocation

- -
peers option (-p)
- -
-This is the “print a list of the peers” option. - -
This option has some usage constraints. It: -
-
must not appear in combination with any of the following options: -interactive. -
- -
Print a list of the peers known to the server as well as a summary -of their state. This is equivalent to the 'peers' interactive command. -
-
-Next: ntpq wide, -Previous: ntpq peers, -Up: ntpq Invocation -
+ +
1.1.9 peers option (-p)
+ + +
This is the “print a list of the peers” option. +
+
This option has some usage constraints. It: +
+
must not appear in combination with any of the following options: +interactive. +
+ +
Print a list of the peers known to the server as well as a summary +of their state. This is equivalent to the ’peers’ interactive command. +
+ +
+
+Next: ntpq wide, Previous: ntpq peers, Up: ntpq Invocation

+ +
1.1.10 refid option (-r)
+ -
refid option (-r)
- -
-This is the “set default display type for s2+ refids” option. +
This is the “set default display type for s2+ refids” option. This option takes a keyword argument. - -
This option has some usage constraints. It: -
-
This option takes a keyword as its argument. -The argument sets an enumeration value that can be tested by comparing the option value macro (OPT_VALUE_REFID). +
+
This option has some usage constraints. It: +
+
This option takes a keyword as its argument. +The argument sets an enumeration value that can be tested by comparing the option value macro (OPT_VALUE_REFID). The available keywords are: -
hash ipv4 -
-
or their numeric equivalent.
- -
Set the default display format for S2+ refids. -
-
-Next: ntpq config, -Previous: ntpq refid, -Up: ntpq Invocation -
+
+
hash ipv4 +
+ +
or their numeric equivalent.
+ +
Set the default display format for S2+ refids. +
+ +
+
+Next: ntpq config, Previous: ntpq refid, Up: ntpq Invocation

+ +
1.1.11 wide option (-w)
+ -
wide option (-w)
- -
-This is the “display the full 'remote' value” option. -Display the full value of the 'remote' value. If this requires +
This is the “display the full ’remote’ value” option. +Display the full value of the ’remote’ value. If this requires more than 15 characters, display the full value, emit a newline, and continue the data display properly indented on the next line. +
-
-
-Next: ntpq exit status, -Previous: ntpq wide, -Up: ntpq Invocation -
+
+ +
+
+Next: ntpq exit status, Previous: ntpq wide, Up: ntpq Invocation

- -
presetting/configuring ntpq
+ +
1.1.12 presetting/configuring ntpq

Any option that is not marked as not presettable may be preset by -loading values from configuration ("rc" or "ini") files, and values from environment variables named NTPQ and NTPQ_<OPTION_NAME>. <OPTION_NAME> must be one of -the options listed above in upper case and segmented with underscores. +loading values from configuration ("rc" or "ini") files, and values from environment variables named NTPQ and NTPQ_<OPTION_NAME>. <OPTION_NAME> must be one of +the options listed above in upper case and segmented with underscores. The NTPQ variable will be tokenized and parsed like the command line. The remaining variables are tested for existence and their values are treated like option arguments. - -
libopts will search in 2 places for configuration files: -
-
$HOME -
$PWD -
- The environment variables HOME, and PWD -are expanded and replaced when ntpq runs. -For any of these that are plain files, they are simply processed. -For any that are directories, then a file named .ntprc is searched for +
+ +
libopts will search in 2 places for configuration files: +
+
$HOME +
$PWD +
+
The environment variables HOME, and PWD +are expanded and replaced when ntpq runs. +For any of these that are plain files, they are simply processed. +For any that are directories, then a file named .ntprc is searched for within that directory and processed. - -
Configuration files may be in a wide variety of formats. +
+
Configuration files may be in a wide variety of formats. The basic format is an option name followed by a value (argument) on the same line. Values may be separated from the option name with a colon, equal sign or simply white space. Values may be continued across multiple lines by escaping the newline with a backslash. - -
Multiple programs may also share the same initialization file. +
+
Multiple programs may also share the same initialization file. Common options are collected at the top, followed by program specific segments. The segments are separated by lines like: -
[NTPQ] -
-
or by -
<?program ntpq> -
-
Do not mix these styles within one configuration file. - -
Compound values and carefully constructed string values may also be +
+
[NTPQ] +
+
or by +
+
<?program ntpq> +
+
Do not mix these styles within one configuration file. +
+
Compound values and carefully constructed string values may also be specified using XML syntax: -
<option-name> - <sub-opt>...<...>...</sub-opt> - </option-name> -
-
yielding an option-name.sub-opt string value of -
"...<...>..." -
-
AutoOpts does not track suboptions. You simply note that it is a +
+
<option-name> + <sub-opt>...<...>...</sub-opt> +</option-name> +
+
yielding an option-name.sub-opt string value of +
+
"...<...>..." +
+
AutoOpts does not track suboptions. You simply note that it is a hierarchicly valued option. AutoOpts does provide a means for searching the associated name/value pair list (see: optionFindValue). - -
The command line options relating to configuration and/or usage help are: - -
version (-)
+
+
The command line options relating to configuration and/or usage help are: +
+ +
version (-)

Print the program version to standard out, optionally with licensing information, then exit 0. The optional argument specifies how much licensing -detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument. +detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument. Only the first letter of the argument is examined: - -
-
version
Only print the version. This is the default. -
copyright
Name the copyright usage licensing terms. -
verbose
Print the full copyright usage licensing terms. +
+
+
‘version’
+
Only print the version. This is the default. +
+
‘copyright’
+
Name the copyright usage licensing terms. +
+
‘verbose’
+
Print the full copyright usage licensing terms. +

-
-
-Previous: ntpq config, -Up: ntpq Invocation -
+
+ +
+
+Previous: ntpq config, Up: ntpq Invocation

- -
ntpq exit status
+ +
1.1.13 ntpq exit status

One of the following exit values will be returned: -
-
0 (EXIT_SUCCESS)
Successful program execution. -
1 (EXIT_FAILURE)
The operation failed or the command syntax was not valid. -
66 (EX_NOINPUT)
A specified configuration file could not be loaded. -
70 (EX_SOFTWARE)
libopts had an internal operational error. Please report -it to autogen-users@lists.sourceforge.net. Thank you. +
+
‘0 (EXIT_SUCCESS)’
+
Successful program execution. +
+
‘1 (EXIT_FAILURE)’
+
The operation failed or the command syntax was not valid. +
+
‘66 (EX_NOINPUT)’
+
A specified configuration file could not be loaded. +
+
‘70 (EX_SOFTWARE)’
+
libopts had an internal operational error. Please report +it to autogen-users@lists.sourceforge.net. Thank you. +

-
-
-Next: Internal Commands, -Previous: ntpq Description, -Up: Top -
+
+ +
+
+Next: Internal Commands, Previous: ntpq Description, Up: Top

- - -
Usage
- -
What Default Flag Option -
configuration file - /etc/ntp.conf - -c - conffile -
frequency file - none - -f - driftfile -
leapseconds file - none - - leapfile -
process ID file - none - -p - pidfile -
log file - system log - -l - logfile -
include file - none - none - includefile -
statistics path - /var/NTP - -s - statsdir -
keys path - /usr/local/etc - -k - keysdir -
- -
-
-Next: Control Message Commands, -Previous: Usage, -Up: Top -
+ +
1.2 Usage
+ + + + + + + + + + + +
What Default Flag Option
configuration file /etc/ntp.conf -c conffile
frequency file none -f driftfile
leapseconds file none leapfile
process ID file none -p pidfile
log file system log -l logfile
include file none none includefile
statistics path /var/NTP -s statsdir
keys path /usr/local/etc -k keysdir
+ +
+ +
+
+Next: Control Message Commands, Previous: Usage, Up: Top

- - -
Internal Commands
+ +
1.3 Internal Commands

Interactive format commands consist of a keyword followed by zero to four arguments. Only enough characters of the full keyword to uniquely identify the command need be typed. The output of a command is normally sent to the standard output, but optionally the output of individual commands may be sent to a file by appending a >, followed by a file name, to the command line. A number of interactive format commands are executed entirely within the ntpq program itself and do not result in NTP mode-6 requests being sent to a server. These are described following. - -
-
? [command_keyword]
help [command_keyword]
A ? by itself will print a list of all the command keywords known to ntpq. A ? followed by a command keyword will print function and usage information about the command. - -
>addvars name [ = value] [...]
rmvars name [...]
clearvars</dt>
The arguments to these commands consist of a list of items of the form -name = value, where the = value is ignored, -and can be omitted in read requests. +
+
+
? [command_keyword]
+
help [command_keyword]
+
A ? by itself will print a list of all the command keywords known to ntpq. A ? followed by a command keyword will print function and usage information about the command. +
+
+
>addvars name [ = value] [...]
+
rmvars name [...]
+
clearvars</dt>
+
The arguments to these commands consist of a list of items of the form +name = value, where the = value is ignored, +and can be omitted in read requests. ntpq maintains an internal list in which data to be included in control messages can be assembled, and sent using the readlist -and writelist commands described below. +and writelist commands described below. The addvars command allows variables and optional values -to be added to the list. +to be added to the list. If more than one variable is to be added -the list should be comma-separated and not contain white space. +the list should be comma-separated and not contain white space. The rmvars command can be used to remove individual variables from the list, while the clearlist command removes all variables from the list. - -
cooked
Display server messages in prettyprint format. - -
debug more | less | off
Turns internal query program debugging on and off. - -
delay milliseconds
Specify a time interval to be added to timestamps included in requests which require authentication. This is used to enable (unreliable) server reconfiguration over long delay network paths or between machines whose clocks are unsynchronized. Actually the server does not now require timestamps in authenticated requests, so this command may be obsolete. - -
host name
Set the host to which future queries will be sent. +
+
+
cooked
+
Display server messages in prettyprint format. +
+
+
debug more | less | off
+
Turns internal query program debugging on and off. +
+
+
delay milliseconds
+
Specify a time interval to be added to timestamps included in requests which require authentication. This is used to enable (unreliable) server reconfiguration over long delay network paths or between machines whose clocks are unsynchronized. Actually the server does not now require timestamps in authenticated requests, so this command may be obsolete. +
+
+
host name
+
Set the host to which future queries will be sent. The name may be either a DNS name or a numeric address. - -
hostnames [yes | no]
If yes is specified, host names are printed in information displays. -If no is specified, numeric addresses are printed instead. +
+
+
hostnames [yes | no]
+
If yes is specified, host names are printed in information displays. +If no is specified, numeric addresses are printed instead. The default is yes, unless modified using the command line -n switch. - -
keyid keyid
This command specifies the key number to be used -to authenticate configuration requests. +
+
+
keyid keyid
+
This command specifies the key number to be used +to authenticate configuration requests. This must correspond to a key ID configured in ntp.conf for this purpose. - -
keytype
Specify the digest algorithm to use for authenticated requests, -with default MD5. +
+
+
keytype
+
Specify the digest algorithm to use for authenticated requests, +with default MD5. If the OpenSSL library is installed, -digest can be be any message digest algorithm supported by the library. +digest can be be any message digest algorithm supported by the library. The current selections are: MD2, MD4, MD5, MDC2, RIPEMD160, SHA and SHA1. - -
ntpversion 1 | 2 | 3 | 4
Sets the NTP version number which ntpq claims in packets. -Defaults to 2. +
+
+
ntpversion 1 | 2 | 3 | 4
+
Sets the NTP version number which ntpq claims in packets. +Defaults to 2. Note that mode-6 control messages (and modes, for that matter) -didn't exist in NTP version 1. - -
passwd
This command prompts for a password to authenticate requests. +didn’t exist in NTP version 1. +
+
+
passwd
+
This command prompts for a password to authenticate requests. The password must correspond to the key ID configured in ntp.conf for this purpose. - -
quit
Exit ntpq. - -
raw
Display server messages as received and without reformatting. - -
timeout millseconds
Specify a timeout period for responses to server queries. -The default is about 5000 milliseconds. +
+
+
quit
+
Exit ntpq. +
+
+
raw
+
Display server messages as received and without reformatting. +
+
+
timeout millseconds
+
Specify a timeout period for responses to server queries. +The default is about 5000 milliseconds. Note that since ntpq retries each query once after a timeout the total waiting time for a timeout will be twice the timeout value set. +
+
+
-
- -
-
-Next: Status Words and Kiss Codes, -Previous: Internal Commands, -Up: Top -
+
+ +
+
+Next: Status Words and Kiss Codes, Previous: Internal Commands, Up: Top

+ +
1.4 Control Message Commands
- -
Control Message Commands
- -
Association IDs are used to identify system, peer and clock variables. +
Association IDs are used to identify system, peer and clock variables. System variables are assigned an association ID of zero and system name space, -while each association is assigned a nonzero association ID and peer namespace. +while each association is assigned a nonzero association ID and peer namespace. Most control commands send a single mode-6 message to the server -and expect a single response message. +and expect a single response message. The exceptions are the peers command, which sends a series of messages, and the mreadlist and mreadvar commands, which iterate over a range of associations. - -
-
-
associations
Display a list of mobilized associations in the form: +
+
+
associations
+
Display a list of mobilized associations in the form:
ind assid status conf reach auth condition last_event cnt - -
Variable Description - -

ind - index on this list - -

assid - association ID - -

status - peer status word - -

conf - yes: persistent, no: ephemeral - -

reach - yes: reachable, no: unreachable - -

auth - ok, yes, bad and none - -

condition - selection status (see the select field of the peer status word) - -

last_event - event report (see the event field of the peer status word) - -

cnt -event count (see the count field of the peer status word) - -
- -
clockvar assocID [name [ = value [...]] [...]]
cv assocID [name [ = value [...] ][...]]
Display a list of clock variables for those associations supporting a reference clock. - -
:config [...]
Send the remainder of the command line, including whitespace, to the server +
+ + + + + + + + + + + +
Variable Description
ind index on this list
assid association ID
status peer status word
conf yes: persistent, no: ephemeral
reach yes: reachable, no: unreachable
auth ok, yes, bad and none
condition selection status (see the select field of the peer status word)
last_event event report (see the event field of the peer status word)
cnt +event count (see the count field of the peer status word)
+ +
+
clockvar assocID [name [ = value [...]] [...]]
+
cv assocID [name [ = value [...] ][...]]
+
Display a list of ‘clock variables’ for those associations supporting a reference clock. +
+
+
:config [...]
+
Send the remainder of the command line, including whitespace, to the server as a run-time configuration command in the same format -as the configuration file. -This command is experimental until further notice and clarification. +as the configuration file. +This command is experimental until further notice and clarification. Authentication is of course required. - -
config-from-file filename
Send the each line of filename to the server as -run-time configuration commands in the same format as the configuration file. -This command is experimental until further notice and clarification. +
+
+
config-from-file filename
+
Send the each line of filename to the server as +run-time configuration commands in the same format as the configuration file. +This command is experimental until further notice and clarification. Authentication is required. - -
ifstats
Display statistics for each local network address. +
+
+
ifstats
+
Display statistics for each local network address. Authentication is required. - -
iostats
Display network and reference clock I/O statistics. - -
kerninfo
Display kernel loop and PPS statistics. -As with other ntpq output, times are in milliseconds. +
+
+
iostats
+
Display network and reference clock I/O statistics. +
+
+
kerninfo
+
Display kernel loop and PPS statistics. +As with other ntpq output, times are in milliseconds. The precision value displayed is in milliseconds as well, unlike the precision system variable. - -
lassociations
Perform the same function as the associations command, +
+
+
lassociations
+
Perform the same function as the associations command, except display mobilized and unmobilized associations. - -
monstats
Display monitor facility statistics. - -
mrulist [limited | kod | mincount=count | laddr=localaddr | sort=sortorder | resany=hexmask | resall=hexmask]
Obtain and print traffic counts collected and maintained by -the monitor facility. -With the exception of sort=sortorder, -the options filter the list returned by ntpd. +
+
+
monstats
+
Display monitor facility statistics. +
+
+
mrulist [limited | kod | mincount=count | laddr=localaddr | sort=sortorder | resany=hexmask | resall=hexmask]
+
Obtain and print traffic counts collected and maintained by +the monitor facility. +With the exception of sort=sortorder, +the options filter the list returned by ntpd. The limited and kod options return only entries representing client addresses from which the last packet received -triggered either discarding or a KoD response. -The mincount=count option filters entries representing -less than count packets. -The laddr=localaddr option filters entries for packets -received on any local address other than localaddr. -resany=hexmask and resall=hexmask +triggered either discarding or a KoD response. +The mincount=count option filters entries representing +less than count packets. +The laddr=localaddr option filters entries for packets +received on any local address other than localaddr. +resany=hexmask and resall=hexmask filter entries containing none or less than all, respectively, -of the bits in hexmask, which must begin with 0x. +of the bits in hexmask, which must begin with 0x.
-The sortorder defaults to lstint and may be any of +The sortorder defaults to lstint and may be any of addr, count, avgint, lstint, or -any of those preceded by a minus sign (hyphen) to reverse the sort order. +any of those preceded by a minus sign (hyphen) to reverse the sort order. The output columns are: - -
+ + + + + +
Column Description - -

lstint - -Interval in s between the receipt of the most recent packet from this -address and the completion of the retrieval of the MRU list by ntpq - -

avgint - -Average interval in s between packets from this address. - -

rstr - -Restriction flags associated with this address. +
+ + + + + +
Column Description
lstint Interval in s between the receipt of the most recent packet from this +address and the completion of the retrieval of the MRU list by ntpq
avgint Average interval in s between packets from this address.
rstr Restriction flags associated with this address. Most are copied unchanged from the matching restrict command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless -the last packet from this address triggered a rate control response. - -

r - -Rate control indicator, either a period, L or K for +the last packet from this address triggered a rate control response.
r Rate control indicator, either a period, L or K for no rate control response, rate limiting by discarding, or -rate limiting with a KoD response, respectively. - -

m - -Packet mode. -
v - -Packet version number. - -

count - -Packets received from this address. - -

rport - -Source port of last packet from this address. - -

remote address - -DNS name, numeric address, or address followed by claimed DNS name which -could not be verified in parentheses. - -
- -
mreadvar assocID assocID [ variable_name [ = value[ ... ]
mrv assocID assocID [ variable_name [ = value[ ... ]
Perform the same function as the readvar command, -except for a range of association IDs. +rate limiting with a KoD response, respectively.
m Packet mode.
v Packet version number.
count Packets received from this address.
rport Source port of last packet from this address.
remote address DNS name, numeric address, or address followed by claimed DNS name which +could not be verified in parentheses.
+ +
+
mreadvar assocID assocID [ variable_name [ = value[ ... ]
+
mrv assocID assocID [ variable_name [ = value[ ... ]
+
Perform the same function as the readvar command, +except for a range of association IDs. This range is determined from the association list cached by the most recent associations command. - -
passociations
Perform the same function as the associations command, except that +
+
+
passociations
+
Perform the same function as the associations command, except that it uses previously stored data rather than making a new query. - -
peers
Display a list of peers in the form: +
+
+
peers
+
Display a list of peers in the form:
[tally]remote refid st t when pool reach delay offset jitter - -
+ + + + + + +
Variable Description -
[tally] - -single-character code indicating current value of the select field -of the peer status word. - -

remote - -host name (or IP number) of peer - -

refid - -association ID or kiss code. - -

st - -stratum - -

t - -u: unicast or manycast client, +
+ + + + + + +
Variable Description
[tally] single-character code indicating current value of the select field +of the peer status word.
remote host name (or IP number) of peer
refid association ID or kiss code.
st stratum
t u: unicast or manycast client, b: broadcast or multicast client, l: local (reference clock), s: symmetric (peer), A: manycast server, B: broadcast server, -M: multicast server. - -

when - -sec/min/hr since last received packet - -

poll - -poll interval (log(2) s) - -

reach - -reach shift register (octal) - -

delay - -roundtrip delay - -

offset - -offset of server relative to this host - -

jitter - -jitter - -
- -
readvar assocID name [ = value ] [,...]
rv assocID [ name ] [,...]
Display the specified variables. -If assocID is zero, -the variables are from the system variables name space, -otherwise they are from the peer variables name space. -The assocID is required, as the same name can occur in both spaces. +M: multicast server.
when sec/min/hr since last received packet
poll poll interval (log(2) s)
reach reach shift register (octal)
delay roundtrip delay
offset offset of server relative to this host
jitter jitter
+ +
+
readvar assocID name [ = value ] [,...]
+
rv assocID [ name ] [,...]
+
Display the specified variables. +If assocID is zero, +the variables are from the ‘system variables’ name space, +otherwise they are from the ‘peer variables’ name space. +The assocID is required, as the same name can occur in both spaces. If no name is included, -all operative variables in the name space are displayed. -In this case only, if the assocID is omitted, it is assumed zero. -Multiple names are specified with comma separators and without whitespace. +all operative variables in the name space are displayed. +In this case only, if the assocID is omitted, it is assumed zero. +Multiple names are specified with comma separators and without whitespace. Note that time values are represented in milliseconds and -frequency values in parts-per-million (PPM). +frequency values in parts-per-million (PPM). Some NTP timestamps are represented in the format YYYYMMDDTTTT, where YYYY is the year, MM the month of year, DD the day of month and TTTT the time of day. - -
saveconfig filename
Write the current configuration, including any runtime modifications +
+
+
saveconfig filename
+
Write the current configuration, including any runtime modifications given with :config or config-from-file, -to the ntpd host's file filename. +to the ntpd host’s file filename. This command will be rejected by the server unless saveconfigdir -appears in the ntpd configuration file. +appears in the ntpd configuration file. filename can use strftime() format specifiers to substitute the current date and time, for example, -saveconfig ntp-%Y%m%d-%H%M%S.conf. -The filename used is stored in system variable savedconfig. +saveconfig ntp-%Y%m%d-%H%M%S.conf. +The filename used is stored in system variable savedconfig. Authentication is required. - -
writevar assocID name = value [,...]
Write the specified variables. -If the assocID is zero, the variables are from the -system variables name space, otherwise they are from the -peer variables name space. -The assocID is required, +
+
+
writevar assocID name = value [,...]
+
Write the specified variables. +If the assocID is zero, the variables are from the +‘system variables’ name space, otherwise they are from the +‘peer variables’ name space. +The assocID is required, as the same name can occur in both spaces. +
+
+
sysinfo
+
Display operational summary. +
+
+
sysstats
+
Print statistics counters maintained in the protocol module. +
+
+
-
sysinfo
Display operational summary. - -
sysstats
Print statistics counters maintained in the protocol module. - -
- -
-
-Next: System Variables, -Previous: Control Message Commands, -Up: Top -
+
+ +
+
+Next: System Variables, Previous: Control Message Commands, Up: Top

- - -
Status Words and Kiss Codes
+ +
1.5 Status Words and Kiss Codes

The current state of the operating program is shown in a set of status words maintained by the system -and each association separately. +and each association separately. These words are displayed in the rv and as commands -both in hexadecimal and decoded short tip strings. +both in hexadecimal and decoded short tip strings. The codes, tips and short explanations are on the -Event Messages and Status Words page. +Event Messages and Status Words page. The page also includes a list of system and peer messages, the code for the latest of which is included in the status word. - -
Information resulting from protocol machine state transitions +
+
Information resulting from protocol machine state transitions is displayed using an informal set of ASCII strings called -kiss codes. -The original purpose was for kiss-o'-death (KoD) packets sent -by the server to advise the client of an unusual condition. +kiss codes. +The original purpose was for kiss-o’-death (KoD) packets sent +by the server to advise the client of an unusual condition. They are now displayed, when appropriate, in the reference identifier field in various billboards. - -
-
-Next: Peer Variables, -Previous: Status Words and Kiss Codes, -Up: Top -
+
+
+ +
+
+Next: Peer Variables, Previous: Status Words and Kiss Codes, Up: Top

+ +
1.6 System Variables
- -
System Variables
- -
The following system variables appear in the rv billboard. +
The following system variables appear in the rv billboard. Not all variables are displayed in some configurations. - -
Variable Description - -

status - -system status word - -

version - -NTP software version and build time - -

processor - -hardware platform and version - -

system - -operating system and version - -

leap - -leap warning indicator (0-3) - -

stratum - -stratum (1-15) - -

precision - -precision (log(2) s) - -

rootdelay - -total roundtrip delay to the primary reference clock - -

rootdisp - -total dispersion to the primary reference clock - -

peer - -system peer association ID - -

tc -time constant and poll exponent (log(2) s) (3-17) - -

mintc -minimum time constant (log(2) s) (3-10) - -

clock - -date and time of day - -

refid -reference ID or kiss code - -

reftime - -reference time - -

offset - -combined offset of server relative to this host - -

sys_jitter - -combined system jitter - -

frequency - -frequency offset (PPM) relative to hardware clock - -

clk_wander - -clock frequency wander (PPM) - -

clk_jitter - -clock jitter - -

tai - -TAI-UTC offset (s) - -

leapsec - -NTP seconds when the next leap second is/was inserted - -

expire - -NTP seconds when the NIST leapseconds file expires - -
- -
The jitter and wander statistics are exponentially-weighted RMS averages. +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Variable Description
status system status word
version NTP software version and build time
processor hardware platform and version
system operating system and version
leap leap warning indicator (0-3)
stratum stratum (1-15)
precision precision (log(2) s)
rootdelay total roundtrip delay to the primary reference clock
rootdisp total dispersion to the primary reference clock
peer system peer association ID
tc +time constant and poll exponent (log(2) s) (3-17)
mintc +minimum time constant (log(2) s) (3-10)
clock date and time of day
refid +reference ID or kiss code
reftime reference time
offset combined offset of server relative to this host
sys_jitter combined system jitter
frequency frequency offset (PPM) relative to hardware clock
clk_wander clock frequency wander (PPM)
clk_jitter clock jitter
tai TAI-UTC offset (s)
leapsec NTP seconds when the next leap second is/was inserted
expire NTP seconds when the NIST leapseconds file expires
+ +
The jitter and wander statistics are exponentially-weighted RMS averages. The system jitter is defined in the NTPv4 specification; the clock jitter statistic is computed by the clock discipline module. - -
When the NTPv4 daemon is compiled with the OpenSSL software library, +
+
When the NTPv4 daemon is compiled with the OpenSSL software library, additional system variables are displayed, including some or all of the following, depending on the particular Autokey dance: - -
Variable Description - -

host - -Autokey host name for this host - -

ident - -Autokey group name for this host - -

flags - -host flags (see Autokey specification) - -

digest - -OpenSSL message digest algorithm - -

signature - -OpenSSL digest/signature scheme - -

update - -NTP seconds at last signature update - -

cert - -certificate subject, issuer and certificate flags - -

until - -NTP seconds when the certificate expires - -
- -
-
-Next: Clock Variables, -Previous: System Variables, -Up: Top -
+
+ + + + + + + + + + +
Variable Description
host Autokey host name for this host
ident Autokey group name for this host
flags host flags (see Autokey specification)
digest OpenSSL message digest algorithm
signature OpenSSL digest/signature scheme
update NTP seconds at last signature update
cert certificate subject, issuer and certificate flags
until NTP seconds when the certificate expires
+ +
+ +
+
+Next: Clock Variables, Previous: System Variables, Up: Top

- - -
Peer Variables
+ +
1.7 Peer Variables

The following peer variables appear in the rv billboard -for each association. +for each association. Not all variables are displayed in some configurations. - -
Variable Description - -

associd - -association ID - -

status - -peer status word - -

srcadr -
srcport - -source (remote) IP address and port - -

dstadr -
dstport - -destination (local) IP address and port - -

leap - -leap indicator (0-3) - -

stratum - -stratum (0-15) - -

precision - -precision (log(2) s) - -

rootdelay - -total roundtrip delay to the primary reference clock - -

rootdisp - total root dispersion to the primary reference clock - -

refid - -reference ID or kiss code - -

reftime - -reference time - -

reach - -reach register (octal) - -

unreach - -unreach counter - -

hmode - -host mode (1-6) - -

pmode - -peer mode (1-5) - -

hpoll - -host poll exponent (log(2) s) (3-17) -
ppoll - -peer poll exponent (log(2) s) (3-17) - -

headway - -headway (see Rate Management and the Kiss-o'-Death Packet) - -

flash - -flash status word - -

offset - -filter offset - -

delay - -filter delay - -

dispersion - -filter dispersion - -

jitter - -filter jitter - -

ident - -Autokey group name for this association - -

bias - -unicast/broadcast bias - -

xleave - -interleave delay (see NTP Interleaved Modes) - -
- -
The bias variable is calculated when the first broadcast packet is received +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Variable Description
associd association ID
status peer status word
srcadr +
srcport +
source (remote) IP address and port
dstadr +
dstport +
destination (local) IP address and port
leap leap indicator (0-3)
stratum stratum (0-15)
precision precision (log(2) s)
rootdelay total roundtrip delay to the primary reference clock
rootdisp total root dispersion to the primary reference clock
refid reference ID or kiss code
reftime reference time
reach reach register (octal)
unreach unreach counter
hmode host mode (1-6)
pmode peer mode (1-5)
hpoll host poll exponent (log(2) s) (3-17)
ppoll peer poll exponent (log(2) s) (3-17)
headway headway (see Rate Management and the Kiss-o’-Death Packet)
flash flash status word
offset filter offset
delay filter delay
dispersion filter dispersion
jitter filter jitter
ident Autokey group name for this association
bias unicast/broadcast bias
xleave interleave delay (see NTP Interleaved Modes)
+ +
The bias variable is calculated when the first broadcast packet is received after the calibration volley. It represents the offset of the broadcast subgraph relative to the unicast subgraph. The xleave variable appears only the interleaved symmetric and interleaved modes. It represents the internal queuing, buffering and transmission delays for the preceding packet. - -
When the NTPv4 daemon is compiled with the OpenSSL software library, +
+
When the NTPv4 daemon is compiled with the OpenSSL software library, additional peer variables are displayed, including the following: - -
Variable Description - -

flags - -peer flags (see Autokey specification) - -

host - -Autokey server name - -

flags - -peer flags (see Autokey specification) - -

signature - -OpenSSL digest/signature scheme - -

initsequence - -initial key ID - -

initkey - -initial key index - -

timestamp - -Autokey signature timestamp - -
- -
-
-Previous: Peer Variables, -Up: Top -
+
+ + + + + + + + + +
Variable Description
flags peer flags (see Autokey specification)
host Autokey server name
flags peer flags (see Autokey specification)
signature OpenSSL digest/signature scheme
initsequence initial key ID
initkey initial key index
timestamp Autokey signature timestamp
+ +
+ +
+
+Previous: Peer Variables, Up: Top

- - -
Clock Variables
+ +
1.8 Clock Variables

The following clock variables appear in the cv billboard for each association with a reference clock. Not all variables are displayed in some configurations. - -
Variable Description -
associd - association ID -
status - clock status word -
device - device description -
timecode - ASCII time code string (specific to device) -
poll - poll messages sent -
noreply - no reply -
badformat - bad format -
baddata - bad date or time -
fudgetime1 - fudge time 1 -
fudgetime2 - fudge time 2 -
stratum - driver stratum -
refid - driver reference ID -
flags - driver flags -
- - - +
+ + + + + + + + + + + + + + + +
Variable Description
associd association ID
status clock status word
device device description
timecode ASCII time code string (specific to device)
poll poll messages sent
noreply no reply
badformat bad format
baddata bad date or time
fudgetime1 fudge time 1
fudgetime2 fudge time 2
stratum driver stratum
refid driver reference ID
flags driver flags
+
+ + + + + diff --git a/ntpsnmpd/Makefile.am b/ntpsnmpd/Makefile.am index 11ecf1b0d..e63098cd3 100644 --- a/ntpsnmpd/Makefile.am +++ b/ntpsnmpd/Makefile.am @@ -13,15 +13,18 @@ LDADD = ../ntpq/libntpq.a ../libntp/libntp.a LDADD += $(SNMP_LIBS) $(LDADD_LIBNTP) $(LIBM) LDADD += $(PTHREAD_LIBS) $(LDADD_NTP) $(LIBOPTS_LDADD) -AM_CFLAGS = $(SNMP_CFLAGS) $(CFLAGS_NTP) +AM_CFLAGS = $(SNMP_CFLAGS) $(CFLAGS_NTP) +AM_CFLAGS += $(NTP_HARD_CFLAGS) AM_CPPFLAGS = -I$(top_srcdir)/ntpq AM_CPPFLAGS += $(NTP_INCS) AM_CPPFLAGS += $(LIBOPTS_CFLAGS) AM_CPPFLAGS += $(SNMP_CPPFLAGS) AM_CPPFLAGS += $(CPPFLAGS_NTP) +AM_CPPFLAGS += $(NTP_HARD_CPPFLAGS) -AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS += $(NTP_HARD_LDFLAGS) EXTRA_DIST= \ invoke-ntpsnmpd.menu \ diff --git a/ntpsnmpd/ntpsnmpd.html b/ntpsnmpd/ntpsnmpd.html index ffd0707ae..bc0ec9e38 100644 --- a/ntpsnmpd/ntpsnmpd.html +++ b/ntpsnmpd/ntpsnmpd.html @@ -1,79 +1,112 @@ - + + + -ntpsnmpd: Network Time Protocol SNMP Daemon User's Manual - - - - - - - +ntpsnmpd: Network Time Protocol SNMP Daemon User’s Manual + + + + + + + + + + + + - -
ntpsnmpd: Network Time Protocol SNMP Daemon User's Manual
-
-
Short Contents
-
-ntpsnmpd: Network Time Protocol Query User Manual -
-
+ +
ntpsnmpd: Network Time Protocol SNMP Daemon User’s Manual
-
-
-Next: ntpsnmpd Description, -Previous: (dir), -Up: (dir) -
-
-
ntpsnmpd: Network Time Protocol Query User Manual
-
The ntpsnmpd utility program is used to monitor NTP daemon ntpd -operations and determine performance. It uses the standard NTP mode 6 control -
This document applies to version 4.2.8p9-win of ntpsnmpd. + +
Short Table of Contents
-
-
ntpsnmpd Description: Description -
ntpsnmpd Invocation: Invoking ntpsnmpd -
Usage: Usage +
+
+
1 Description

- -
-
-Next: Usage, -Previous: Top, -Up: Top -

- -
Description
-
The ntpsnmpd utility program provides an SNMP MIB agent for ntpd. + +
+
+Next: ntpsnmpd Description, Previous: (dir), Up: (dir)
+
+ +
ntpsnmpd: Network Time Protocol Query User Manual
+ +
The ntpsnmpd utility program is used to monitor NTP daemon ntpd +operations and determine performance. It uses the standard NTP mode 6 control +
+
This document applies to version 4.2.8p9-win of ntpsnmpd. +
+ + + + +
• ntpsnmpd Description:    Description +
• ntpsnmpd Invocation:    Invoking ntpsnmpd +
• Usage:    Usage +
-
-
-Previous: ntpsnmpd Description, -Up: Top -
+
+ +
+
+Next: Usage, Previous: Top, Up: Top

+ +
1 Description
- -
Usage
+
The ntpsnmpd utility program provides an SNMP MIB agent for ntpd. +
+
+ +
+
+Previous: ntpsnmpd Description, Up: Top
+
+ +
1.1 Usage

(what should we say here?) +
+ - + + diff --git a/parseutil/Makefile.am b/parseutil/Makefile.am index 99fb3d196..ee2e1b6d7 100644 --- a/parseutil/Makefile.am +++ b/parseutil/Makefile.am @@ -5,10 +5,14 @@ CLEANFILES = noinst_PROGRAMS = @TESTDCF@ @DCFD@ EXTRA_PROGRAMS = testdcf dcfd -AM_CFLAGS = $(CFLAGS_NTP) +AM_CFLAGS = $(CFLAGS_NTP) +AM_CFLAGS += $(NTP_HARD_CFLAGS) AM_CPPFLAGS = $(NTP_INCS) AM_CPPFLAGS += $(CPPFLAGS_NTP) +AM_CPPFLAGS += $(NTP_HARD_CPPFLAGS) + +AM_LDFLAGS = $(NTP_HARD_LDFLAGS) LDADD = ../libntp/libntp.a $(LDADD_LIBNTP) $(LIBM) diff --git a/scripts/ntp-wait/ntp-wait.html b/scripts/ntp-wait/ntp-wait.html index 226b3db71..d6a0306b6 100644 --- a/scripts/ntp-wait/ntp-wait.html +++ b/scripts/ntp-wait/ntp-wait.html @@ -1,72 +1,106 @@ - + + + -Ntp-wait User's Manual - - - - - - - +Ntp-wait User’s Manual + + + + + + + + + + + + - -
Ntp-wait User's Manual
-
- -
-Next: ntp-wait Description, -Previous: (dir), -Up: (dir) -
+ +
Ntp-wait User’s Manual
+ -
This document describes the use of the NTP Project's ntp-wait program. -
If there are time-sensitive applications, + + + +
+
+Previous: (dir), Up: (dir)
+
+
Top
+ +
This document describes the use of the NTP Project’s ntp-wait program. +
+
If there are time-sensitive applications, the proper sequence of events is to run ntpd -g as early as possible, then invoke all of the non-time-sensitive process, run ntp-wait to block -until the system's time has stabilized and synchronized, +until the system’s time has stabilized and synchronized, and only then start any applicaitons (like database servers) that require accurate and stable time. - -
This document applies to version 4.2.8p9-win of ntp-wait. +
+
This document applies to version 4.2.8p9-win of ntp-wait. +
+ +
Short Table of Contents

-
Short Contents
-
-
+
1 Invoking ntp-wait
+
-
-
ntp-wait Description: Description -
ntp-wait Invocation: Invoking ntp-wait -
- -
- - -
+ + + +
• ntp-wait Description:    Description +
• ntp-wait Invocation:    Invoking ntp-wait +
+
+ +
+
+Up: Top

+ +
1 Invoking ntp-wait
+ + -
0.1 Invoking ntp-wait
-
-
ntp-wait +
ntp-wait will send at most num-tries queries to @@ -76,52 +110,58 @@ sleeping for after each status return that says ntpd(8) has not yet produced a synchronized and stable system clock. - -
ntp-wait +
+
ntp-wait will do this quietly, unless the -v -flag is provided. +flag is provided. This can be useful at boot time, to delay the boot sequence until after ntpd -g has set the time. - -
This section was generated by AutoGen, +
+
This section was generated by AutoGen, using the agtexi-cmd template and the option descriptions for the ntp-wait program. - -
-
ntp-wait usage: ntp-wait help/usage (--help) -
ntp-wait tries: tries option (-n) -
ntp-wait sleep: sleep option (-s) -
ntp-wait verbose: verbose option (-v) -
ntp-wait exit status: exit status -
ntp-wait Authors: Authors -
ntp-wait Notes: Notes -
- -
- +
+ + + + + + + + +
• ntp-wait usage:    ntp-wait help/usage (--help) +
• ntp-wait tries:    tries option (-n) +
• ntp-wait sleep:    sleep option (-s) +
• ntp-wait verbose:    verbose option (-v) +
• ntp-wait exit status:    exit status +
• ntp-wait Authors:    Authors +
• ntp-wait Notes:    Notes +
+ +
-
-Next: ntp-wait tries, -Up: ntp-wait Invocation - +
+
+Next: ntp-wait tries, Up: ntp-wait Invocation

- -
0.1.1 ntp-wait help/usage (--help)
- -
-This is the automatically generated usage text for ntp-wait. - -
The text printed is the same whether selected with the help option -(--help) or the more-help option (--more-help). more-help will print -the usage text by passing it through a pager program. + +
1.1 ntp-wait help/usage (--help)
+ + +
This is the automatically generated usage text for ntp-wait. +
+
The text printed is the same whether selected with the help option +(--help) or the more-help option (--more-help). more-help will print +the usage text by passing it through a pager program. more-help is disabled on platforms without a working fork(2) function. The PAGER environment variable is -used to select the program, defaulting to more. Both will exit +used to select the program, defaulting to more. Both will exit with a status code of 0. - -
ntp-wait - Wait for ntpd to stabilize the system clock - Ver. 4.2.8p9-win -USAGE: ntp-wait [ -<flag> [<val>] | --<name>[{=| }<val>] ]... +
+
+
ntp-wait - Wait for ntpd to stabilize the system clock - Ver. 4.2.8p9 +USAGE: ntp-wait [ -<flag> [<val>] | --<name>[{=| }<val>] ]... -n, --tries=num Number of times to check ntpd -s, --sleep=num How long to sleep between tries @@ -131,96 +171,86 @@ USAGE: ntp-wait [ -<flag> [<val>] | --<name>[{=| }<val>] Options are specified by doubled hyphens and their name or by a single hyphen and the flag character. -
-
- - -
-Next: ntp-wait sleep, -Previous: ntp-wait usage, -Up: ntp-wait Invocation +
+
+ +
+
+Next: ntp-wait sleep, Previous: ntp-wait usage, Up: ntp-wait Invocation

+ +
1.2 tries option (-n)
+ -
0.1.2 tries option (-n)
- -
-This is the “number of times to check ntpd” option. -This option takes a number argument. +
This is the “number of times to check ntpd” option. +This option takes a number argument. The maximum number of times we will check ntpd to see if - it has been able to synchronize and stabilize the system clock. -
- + it has been able to synchronize and stabilize the system clock. +
-
-Next: ntp-wait verbose, -Previous: ntp-wait tries, -Up: ntp-wait Invocation - +
+
+Next: ntp-wait verbose, Previous: ntp-wait tries, Up: ntp-wait Invocation

- -
0.1.3 sleep option (-s)
- -
-This is the “how long to sleep between tries” option. -This option takes a number argument secs-between-tries. - We will sleep for secs-between-tries after each query - of ntpd that returns "the time is not yet stable". -
- + +
1.3 sleep option (-s)
+ + +
This is the “how long to sleep between tries” option. +This option takes a number argument secs-between-tries. + We will sleep for secs-between-tries after each query + of ntpd that returns "the time is not yet stable". +
-
-Next: ntp-wait exit status, -Previous: ntp-wait sleep, -Up: ntp-wait Invocation - +
+
+Next: ntp-wait exit status, Previous: ntp-wait sleep, Up: ntp-wait Invocation

- -
0.1.4 verbose option (-v)
- -
-This is the “be verbose” option. - By default, ntp-wait is silent. - With this option, ntp-wait will provide status information. -
- + +
1.4 verbose option (-v)
+ + +
This is the “be verbose” option. + By default, ntp-wait is silent. + With this option, ntp-wait will provide status information. +
-
-Next: ntp-wait Authors, -Previous: ntp-wait verbose, -Up: ntp-wait Invocation - +
+
+Next: ntp-wait Authors, Previous: ntp-wait verbose, Up: ntp-wait Invocation

- -
0.1.5 ntp-wait exit status
+ +
1.5 ntp-wait exit status

One of the following exit values will be returned: -
-
‘0 (EXIT_SUCCESS)’
Successful program execution. -
‘1 (EXIT_FAILURE)’
The operation failed or the command syntax was not valid. +
+
‘0 (EXIT_SUCCESS)’
+
Successful program execution. +
+
‘1 (EXIT_FAILURE)’
+
The operation failed or the command syntax was not valid. +

-
- +
-
-Next: ntp-wait Notes, -Previous: ntp-wait exit status, -Up: ntp-wait Invocation - +
+
+Next: ntp-wait Notes, Previous: ntp-wait exit status, Up: ntp-wait Invocation

- -
0.1.6 ntp-wait Authors
- -
- + +
1.6 ntp-wait Authors
+
-
-Previous: ntp-wait Authors, -Up: ntp-wait Invocation - +
+
+Previous: ntp-wait Authors, Up: ntp-wait Invocation

+ +
1.7 ntp-wait Notes
+
-
0.1.7 ntp-wait Notes
- + + diff --git a/scripts/ntpsweep/ntpsweep.html b/scripts/ntpsweep/ntpsweep.html index fa30b79de..21189953a 100644 --- a/scripts/ntpsweep/ntpsweep.html +++ b/scripts/ntpsweep/ntpsweep.html @@ -1,100 +1,141 @@ - + + + -ntpsweep User's Manual - - - - - - - +ntpsweep User’s Manual + + + + + + + + + + + + - -
ntpsweep User's Manual
-
- -
-Next: ntpsweep Description, -Previous: (dir), -Up: (dir) -
+ +
ntpsweep User’s Manual
-
This document describes the use of the NTP Project's ntpsweep program. -
This document applies to version 4.2.8p9-win of ntpsweep. -
-
Short Contents
-
-
-
-
-
ntpsweep Description: Description -
ntpsweep Invocation: Invoking ntpsweep -
-
- -
+ +
+
+Previous: (dir), Up: (dir)
+
+
Top
+
This document describes the use of the NTP Project’s ntpsweep program. +
+
This document applies to version 4.2.8p9-win of ntpsweep. +
+ +
Short Table of Contents
+ +
+
1 Invoking ntpsweep

-
0.1 Invoking ntpsweep
-
-ntpsweep + + + +
• ntpsweep Description:    Description +
• ntpsweep Invocation:    Invoking ntpsweep +
+ +
+ +
+
+Up: Top
+
+ +
1 Invoking ntpsweep
+ + + +
ntpsweep prints per host the NTP stratum level, the clock offset in seconds, the daemon version, the operating system and the processor. Optionally recursing through all peers. - -
This section was generated by AutoGen, +
+
This section was generated by AutoGen, using the agtexi-cmd template and the option descriptions for the ntpsweep program. - -
-
ntpsweep usage: ntpsweep help/usage (--help) -
ntpsweep host-list: host-list option (-l) -
ntpsweep peers: peers option (-p) -
ntpsweep maxlevel: maxlevel option (-m) -
ntpsweep strip: strip option (-s) -
ntpsweep host: host option (-h) -
ntpsweep exit status: exit status -
- -
+
+ + + + + + + + +
• ntpsweep usage:    ntpsweep help/usage (--help) +
• ntpsweep host-list:    host-list option (-l) +
• ntpsweep peers:    peers option (-p) +
• ntpsweep maxlevel:    maxlevel option (-m) +
• ntpsweep strip:    strip option (-s) +
• ntpsweep host:    host option (-h) +
• ntpsweep exit status:    exit status +
+ +
-
-Next: ntpsweep host-list, -Up: ntpsweep Invocation - +
+
+Next: ntpsweep host-list, Up: ntpsweep Invocation

- -
0.1.1 ntpsweep help/usage (--help)
- -
-This is the automatically generated usage text for ntpsweep. - -
The text printed is the same whether selected with the help option -(--help) or the more-help option (--more-help). more-help will print -the usage text by passing it through a pager program. + +
1.1 ntpsweep help/usage (--help)
+ + +
This is the automatically generated usage text for ntpsweep. +
+
The text printed is the same whether selected with the help option +(--help) or the more-help option (--more-help). more-help will print +the usage text by passing it through a pager program. more-help is disabled on platforms without a working fork(2) function. The PAGER environment variable is -used to select the program, defaulting to more. Both will exit +used to select the program, defaulting to more. Both will exit with a status code of 0. - -
ntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p9-win +
+
+
ntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p9 USAGE: ntpsweep [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [hostfile] -l, --host-list=str Host to execute actions on @@ -107,106 +148,102 @@ USAGE: ntpsweep [ -<flag> [<val>] | --<name>[{=| }<val>] Options are specified by doubled hyphens and their name or by a single hyphen and the flag character. -
-
- - -
-Next: ntpsweep peers, -Previous: ntpsweep usage, -Up: ntpsweep Invocation +
+
+ +
+
+Next: ntpsweep peers, Previous: ntpsweep usage, Up: ntpsweep Invocation

+ +
1.2 host-list option (-l)
+ -
0.1.2 host-list option (-l)
- -
-This is the “host to execute actions on” option. +
This is the “host to execute actions on” option. This option takes a string argument. - -
This option has some usage constraints. It: -
-
may appear an unlimited number of times. -
- -
Use this option to specify the host on which this script operates. - May appear multiple times. -
+
+
This option has some usage constraints. It: +
+
may appear an unlimited number of times. +
+ +
Use this option to specify the host on which this script operates. + May appear multiple times. +
-
-Next: ntpsweep maxlevel, -Previous: ntpsweep host-list, -Up: ntpsweep Invocation - +
+
+Next: ntpsweep maxlevel, Previous: ntpsweep host-list, Up: ntpsweep Invocation

+ +
1.3 peers option (-p)
+ -
0.1.3 peers option (-p)
- -
-This is the “recursively list all peers a host synchronizes to” option. -This option has no ‘doc’ documentation. -
+
This is the “recursively list all peers a host synchronizes to” option. +This option has no ‘doc’ documentation. +
-
-Next: ntpsweep strip, -Previous: ntpsweep peers, -Up: ntpsweep Invocation - +
+
+Next: ntpsweep strip, Previous: ntpsweep peers, Up: ntpsweep Invocation

- -
0.1.4 maxlevel option (-m)
- -
-This is the “traverse peers up to this level (4 is a reasonable number)” option. -This option takes a number argument. -This option has no ‘doc’ documentation. -
+ +
1.4 maxlevel option (-m)
+ + +
This is the “traverse peers up to this level (4 is a reasonable number)” option. +This option takes a number argument. +This option has no ‘doc’ documentation. +
-
-Next: ntpsweep host, -Previous: ntpsweep maxlevel, -Up: ntpsweep Invocation - +
+
+Next: ntpsweep host, Previous: ntpsweep maxlevel, Up: ntpsweep Invocation

+ +
1.5 strip option (-s)
+ -
0.1.5 strip option (-s)
- -
-This is the “strip this string from hostnames” option. -This option takes a string argument. -This option has no ‘doc’ documentation. -
+
This is the “strip this string from hostnames” option. +This option takes a string argument. +This option has no ‘doc’ documentation. +
-
-Next: ntpsweep exit status, -Previous: ntpsweep strip, -Up: ntpsweep Invocation - +
+
+Next: ntpsweep exit status, Previous: ntpsweep strip, Up: ntpsweep Invocation

+ +
1.6 host option (-h)
+ -
0.1.6 host option (-h)
- -
-This is the “specify a single host” option. -This option takes a string argument. -This option has no ‘doc’ documentation. - -
NOTE: THIS OPTION IS DEPRECATED -
+
This is the “specify a single host” option. +This option takes a string argument. +This option has no ‘doc’ documentation. +
+
NOTE: THIS OPTION IS DEPRECATED +
-
-Previous: ntpsweep host, -Up: ntpsweep Invocation - +
+
+Previous: ntpsweep host, Up: ntpsweep Invocation

- -
0.1.7 ntpsweep exit status
+ +
1.7 ntpsweep exit status

One of the following exit values will be returned: -
-
‘0 (EXIT_SUCCESS)’
Successful program execution. -
‘1 (EXIT_FAILURE)’
The operation failed or the command syntax was not valid. +
+
‘0 (EXIT_SUCCESS)’
+
Successful program execution. +
+
‘1 (EXIT_FAILURE)’
+
The operation failed or the command syntax was not valid. +

+
+ - + + diff --git a/scripts/ntptrace/ntptrace.html b/scripts/ntptrace/ntptrace.html index 7f7d3cb62..716b2d472 100644 --- a/scripts/ntptrace/ntptrace.html +++ b/scripts/ntptrace/ntptrace.html @@ -1,117 +1,157 @@ - + + + -Ntptrace User's Manual - - - - - - - +Ntptrace User’s Manual + + + + + + + + + + + + - -
Ntptrace User's Manual
-
- -
-Next: ntptrace Description, -Previous: (dir), -Up: (dir) -
+ +
Ntptrace User’s Manual
+ -
Simple Network Time Protocol User Manual
-
This document describes the use of the NTP Project's ntptrace program. + + + +
+
+Previous: (dir), Up: (dir)
+
+ +
Simple Network Time Protocol User Manual
+ +
This document describes the use of the NTP Project’s ntptrace program. This document applies to version 4.2.8p9-win of ntptrace. +
+ +
Short Table of Contents
-
-
Short Contents
-
-Simple Network Time Protocol User Manual +
+
+
1 Invoking ntptrace

-
-
ntptrace Description: Description -
ntptrace Invocation: Invoking ntptrace -
-
- -
-Previous: ntptrace Description, -Up: Top + + + +
• ntptrace Description:    Description +
• ntptrace Invocation:    Invoking ntptrace +
+
+ +
+
+Up: Top

+ +
1 Invoking ntptrace
+ + -
Invoking ntptrace
- -
-ntptrace is a perl script that uses the ntpq utility program to follow +
ntptrace is a perl script that uses the ntpq utility program to follow the chain of NTP servers from a given host back to the primary time source. For ntptrace to work properly, each of these servers must implement the NTP Control and Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets. - -
If given no arguments, ntptrace starts with localhost. Here is an example of +
+
If given no arguments, ntptrace starts with localhost. Here is an example of the output from ntptrace: - -
% ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135 - server2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu: - stratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB' -
-
On each line, the fields are (left to right): the host name, the host stratum, +
+
+
% ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135 +server2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu: +stratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB' +
+ +
On each line, the fields are (left to right): the host name, the host stratum, the time offset between that host and the local host (as measured by -ntptrace; this is why it is not always zero for "localhost"), the host +ntptrace; this is why it is not always zero for "localhost"), the host synchronization distance, and (only for stratum-1 servers) the reference clock ID. All times are given in seconds. Note that the stratum is the server hop count to the primary source, while the synchronization distance is the estimated error relative to the primary source. These terms are precisely defined in RFC-1305. +
-
This section was generated by AutoGen, +
This section was generated by AutoGen, using the agtexi-cmd template and the option descriptions for the ntptrace program. - -
-
ntptrace usage: ntptrace help/usage (--help) -
ntptrace numeric: numeric option (-n) -
ntptrace max-hosts: max-hosts option (-m) -
ntptrace host: host option (-r) -
ntptrace exit status: exit status -
- -
+
+ + + + + + +
• ntptrace usage:    ntptrace help/usage (--help) +
• ntptrace numeric:    numeric option (-n) +
• ntptrace max-hosts:    max-hosts option (-m) +
• ntptrace host:    host option (-r) +
• ntptrace exit status:    exit status +
+ +
-
-Next: ntptrace numeric, -Up: ntptrace Invocation - +
+
+Next: ntptrace numeric, Up: ntptrace Invocation

- -
ntptrace help/usage (--help)
- -
-This is the automatically generated usage text for ntptrace. - -
The text printed is the same whether selected with the help option -(--help) or the more-help option (--more-help). more-help will print -the usage text by passing it through a pager program. + +
1.1 ntptrace help/usage (--help)
+ + +
This is the automatically generated usage text for ntptrace. +
+
The text printed is the same whether selected with the help option +(--help) or the more-help option (--more-help). more-help will print +the usage text by passing it through a pager program. more-help is disabled on platforms without a working fork(2) function. The PAGER environment variable is -used to select the program, defaulting to more. Both will exit +used to select the program, defaulting to more. Both will exit with a status code of 0. - -
ntptrace - Trace peers of an NTP server - Ver. 4.2.8p9-win +
+
+
ntptrace - Trace peers of an NTP server - Ver. 4.2.8p9 USAGE: ntptrace [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [host] -n, --numeric Print IP addresses instead of hostnames @@ -122,68 +162,68 @@ USAGE: ntptrace [ -<flag> [<val>] | --<name>[{=| }<val>] Options are specified by doubled hyphens and their name or by a single hyphen and the flag character. -
-
- -
-Next: ntptrace max-hosts, -Previous: ntptrace usage, -Up: ntptrace Invocation +
+
+ +
+
+Next: ntptrace max-hosts, Previous: ntptrace usage, Up: ntptrace usage

+ +
1.1.1 numeric option (-n)
+ -
numeric option (-n)
- -
-This is the “print ip addresses instead of hostnames” option. +
This is the “print ip addresses instead of hostnames” option. Output hosts as dotted-quad numeric format rather than converting to -the canonical host names. -
- +the canonical host names. +
-
-Next: ntptrace host, -Previous: ntptrace numeric, -Up: ntptrace Invocation - +
+
+Next: ntptrace host, Previous: ntptrace numeric, Up: ntptrace usage

- -
max-hosts option (-m)
- -
-This is the “maximum number of peers to trace” option. -This option takes a number argument. -This option has no ‘doc’ documentation. -
+ +
1.1.2 max-hosts option (-m)
+ + +
This is the “maximum number of peers to trace” option. +This option takes a number argument. +This option has no ‘doc’ documentation. +
-
-Next: ntptrace exit status, -Previous: ntptrace max-hosts, -Up: ntptrace Invocation - +
+
+Next: ntptrace exit status, Previous: ntptrace max-hosts, Up: ntptrace usage

- -
host option (-r)
- -
-This is the “single remote host” option. -This option takes a string argument. -This option has no ‘doc’ documentation. -
+ +
1.1.3 host option (-r)
+ + +
This is the “single remote host” option. +This option takes a string argument. +This option has no ‘doc’ documentation. +
-
-Previous: ntptrace host, -Up: ntptrace Invocation - +
+
+Previous: ntptrace host, Up: ntptrace usage

- -
ntptrace exit status
+ +
1.1.4 ntptrace exit status

One of the following exit values will be returned: -
-
‘0 (EXIT_SUCCESS)’
Successful program execution. -
‘1 (EXIT_FAILURE)’
The operation failed or the command syntax was not valid. +
+
‘0 (EXIT_SUCCESS)’
+
Successful program execution. +
+
‘1 (EXIT_FAILURE)’
+
The operation failed or the command syntax was not valid. +

+
+ - + + diff --git a/scripts/plot_summary.html b/scripts/plot_summary.html index 093b87b15..0ef04a0ba 100644 --- a/scripts/plot_summary.html +++ b/scripts/plot_summary.html @@ -1,102 +1,139 @@ - + + + -Plot_summary User's Manual - - - - - - - +Plot_summary User’s Manual + + + + + + + + + + + + - -
Plot_summary User's Manual
-
- -
-Next: plot_summary Description, -Previous: (dir), -Up: (dir) -
+ +
Plot_summary User’s Manual
+ + -
Plot_summary User Manual
-
This document describes the use of the NTP Project's plot_summary program. + + +
+
+Previous: (dir), Up: (dir)
+
+ +
Plot_summary User Manual
+ +
This document describes the use of the NTP Project’s plot_summary program. This document applies to version 4.2.8p9-win of plot_summary. +
+ +
Short Table of Contents
-
-
Short Contents
-
-Plot_summary User Manual +
+
+
1 Invoking plot_summary

-
-
plot_summary Description: Description -
plot_summary Invocation: Invoking plot_summary -
-
- - -
-Previous: plot_summary Description, -Up: Top + + + +
• plot_summary Description:    Description +
• plot_summary Invocation:    Invoking plot_summary +
+
+ +
+
+Up: Top

+ +
1 Invoking plot_summary
+ + -
Invoking plot_summary
- -
-
This section was generated by AutoGen, +
This section was generated by AutoGen, using the agtexi-cmd template and the option descriptions for the plot_summary program. - -
-
plot_summary usage: plot_summary help/usage (--help) -
plot_summary directory: directory option -
plot_summary identifier: identifier option -
plot_summary peer: peer option -
plot_summary plot-term: plot-term option -
plot_summary output-file: output-file option -
plot_summary exit status: exit status -
- -
- +
+ + + + + + + + +
• plot_summary usage:    plot_summary help/usage (--help) +
• plot_summary directory:    directory option +
• plot_summary identifier:    identifier option +
• plot_summary peer:    peer option +
• plot_summary plot-term:    plot-term option +
• plot_summary output-file:    output-file option +
• plot_summary exit status:    exit status +
+ +
-
-Next: plot_summary directory, -Up: plot_summary Invocation - +
+
+Next: plot_summary directory, Up: plot_summary Invocation

- -
plot_summary help/usage (--help)
- -
-This is the automatically generated usage text for plot_summary. - -
The text printed is the same whether selected with the help option -(--help) or the more-help option (--more-help). more-help will print -the usage text by passing it through a pager program. + +
1.1 plot_summary help/usage (--help)
+ + +
This is the automatically generated usage text for plot_summary. +
+
The text printed is the same whether selected with the help option +(--help) or the more-help option (--more-help). more-help will print +the usage text by passing it through a pager program. more-help is disabled on platforms without a working fork(2) function. The PAGER environment variable is -used to select the program, defaulting to more. Both will exit +used to select the program, defaulting to more. Both will exit with a status code of 0. - -
plot_summary - plot statistics generated by summary script - Ver. 4.2.8p9-win -USAGE: plot_summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... +
+
+
plot_summary - plot statistics generated by summary script - Ver. 4.2.8p9 +USAGE: plot_summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... --directory=str Where the summary files are --identifier=str Origin of the data @@ -111,115 +148,106 @@ USAGE: plot_summary [ -<flag> [<val>] | --<name>[{=| }<val& Options are specified by doubled hyphens and their name or by a single hyphen and the flag character. -
-
- - -
-Next: plot_summary identifier, -Previous: plot_summary usage, -Up: plot_summary Invocation +
+
+ +
+
+Next: plot_summary identifier, Previous: plot_summary usage, Up: plot_summary usage

+ +
1.1.1 directory option
+ -
directory option
- -
-This is the “where the summary files are” option. -This option takes a string argument. +
This is the “where the summary files are” option. +This option takes a string argument. The directory where the plot_summary will search for the - *_summary files generated by summary script. -
- + *_summary files generated by summary script. +
-
-Next: plot_summary peer, -Previous: plot_summary directory, -Up: plot_summary Invocation - +
+
+Next: plot_summary peer, Previous: plot_summary directory, Up: plot_summary usage

+ +
1.1.2 identifier option
+ -
identifier option
- -
-This is the “origin of the data” option. -This option takes a string argument. - Where does the plotted data come from, default to string "host" plus +
This is the “origin of the data” option. +This option takes a string argument. + Where does the plotted data come from, default to string "host" plus current hostname -
- +
-
-Next: plot_summary plot-term, -Previous: plot_summary identifier, -Up: plot_summary Invocation - +
+
+Next: plot_summary plot-term, Previous: plot_summary identifier, Up: plot_summary usage

+ +
1.1.3 peer option
+ -
peer option
- -
-This is the “peers to generate plots for” option. +
This is the “peers to generate plots for” option. This option takes a string argument. - -
This option has some usage constraints. It: -
-
may appear an unlimited number of times. -
- -
By default the peer_summary plots are not generated. Use this option to - specify list of peers if you want to generate plots for them. -
- +
+
This option has some usage constraints. It: +
+
may appear an unlimited number of times. +
+ +
By default the peer_summary plots are not generated. Use this option to + specify list of peers if you want to generate plots for them. +
-
-Next: plot_summary output-file, -Previous: plot_summary peer, -Up: plot_summary Invocation - +
+
+Next: plot_summary output-file, Previous: plot_summary peer, Up: plot_summary usage

+ +
1.1.4 plot-term option
+ -
plot-term option
- -
-This is the “gnuplot terminal” option. -This option takes a string argument. +
This is the “gnuplot terminal” option. +This option takes a string argument. This is string is passed directly to the gnuplot set terminal command. Default is x11 if DISPLAY is set and - dumb is it's not'. See output from -e "set - terminal") for the list of available options. -
- + dumb is it’s not’. See output from (gnuplot -e "set + terminal") for the list of available options. +
-
-Next: plot_summary exit status, -Previous: plot_summary plot-term, -Up: plot_summary Invocation - +
+
+Next: plot_summary exit status, Previous: plot_summary plot-term, Up: plot_summary usage

- -
output-file option
- -
-This is the “output file” option. -This option takes a str argument. - Output file for gnuplot, default to stdout. -
- + +
1.1.5 output-file option
+ + +
This is the “output file” option. +This option takes a str argument. + Output file for gnuplot, default to stdout. +
-
-Previous: plot_summary output-file, -Up: plot_summary Invocation - +
+
+Previous: plot_summary output-file, Up: plot_summary usage

- -
plot_summary exit status
+ +
1.1.6 plot_summary exit status

One of the following exit values will be returned: -
-
‘0 (EXIT_SUCCESS)’
Successful program execution. -
‘1 (EXIT_FAILURE)’
The operation failed or the command syntax was not valid. +
+
‘0 (EXIT_SUCCESS)’
+
Successful program execution. +
+
‘1 (EXIT_FAILURE)’
+
The operation failed or the command syntax was not valid. +

+
+ - + + diff --git a/scripts/summary.html b/scripts/summary.html index 4bbbbec79..161bbf975 100644 --- a/scripts/summary.html +++ b/scripts/summary.html @@ -1,99 +1,139 @@ - + + + -Summary User's Manual - - - - - - - +Summary User’s Manual + + + + + + + + + + + + - -
Summary User's Manual
-
- -
-Next: summary Description, -Previous: (dir), -Up: (dir) -
+ +
Summary User’s Manual
+ -
Summary User Manual
-
This document describes the use of the NTP Project's summary program. + + + +
+
+Previous: (dir), Up: (dir)
+
+ +
Summary User Manual
+ +
This document describes the use of the NTP Project’s summary program. This document applies to version 4.2.8p9-win of summary. +
+ +
Short Table of Contents
-
-
Short Contents
-
-Summary User Manual +
+
+
1 Invoking summary

-
-
summary Description: Description -
summary Invocation: Invoking summary -
-
- -
-Previous: summary Description, -Up: Top + + + +
• summary Description:    Description +
• summary Invocation:    Invoking summary +
+
+ +
+
+Up: Top

+ +
1 Invoking summary
+ + -
Invoking summary
-
-
This section was generated by AutoGen, -using the agtexi-cmd template and the option descriptions for the summary program. -
-
summary usage: summary help/usage (--help) -
summary directory: directory option -
summary end-date: end-date option -
summary output-directory: output-directory option -
summary start-date: start-date option -
summary exit status: exit status -
- -
+
This section was generated by AutoGen, +using the agtexi-cmd template and the option descriptions for the summary program. +
+ + + + + + + +
• summary usage:    summary help/usage (--help) +
• summary directory:    directory option +
• summary end-date:    end-date option +
• summary output-directory:    output-directory option +
• summary start-date:    start-date option +
• summary exit status:    exit status +
+ +
-
-Next: summary directory, -Up: summary Invocation - +
+
+Next: summary directory, Up: summary Invocation

- -
summary help/usage (--help)
- -
-This is the automatically generated usage text for summary. - -
The text printed is the same whether selected with the help option -(--help) or the more-help option (--more-help). more-help will print -the usage text by passing it through a pager program. + +
1.1 summary help/usage (--help)
+ + +
This is the automatically generated usage text for summary. +
+
The text printed is the same whether selected with the help option +(--help) or the more-help option (--more-help). more-help will print +the usage text by passing it through a pager program. more-help is disabled on platforms without a working fork(2) function. The PAGER environment variable is -used to select the program, defaulting to more. Both will exit +used to select the program, defaulting to more. Both will exit with a status code of 0. - -
summary - compute various stastics from NTP stat files - Ver. 4.2.8p9-win -USAGE: summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... +
+
+
summary - compute various stastics from NTP stat files - Ver. 4.2.8p9 +USAGE: summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]... --directory=str Directory containing stat files --end-date=num End date @@ -106,89 +146,85 @@ USAGE: summary [ -<flag> [<val>] | --<name>[{=| }<val>] Options are specified by doubled hyphens and their name or by a single hyphen and the flag character. -
-
- -
-Next: summary end-date, -Previous: summary usage, -Up: summary Invocation +
+
+ +
+
+Next: summary end-date, Previous: summary usage, Up: summary usage

+ +
1.1.1 directory option
+ -
directory option
- -
-This is the “directory containing stat files” option. -This option takes a string argument. +
This is the “directory containing stat files” option. +This option takes a string argument. The directory where ntpd will search for .stat files generated - by ntpd. -
- + by ntpd. +
-
-Next: summary output-directory, -Previous: summary directory, -Up: summary Invocation - +
+
+Next: summary output-directory, Previous: summary directory, Up: summary usage

+ +
1.1.2 end-date option
+ -
end-date option
- -
-This is the “end date” option. -This option takes a number argument. +
This is the “end date” option. +This option takes a number argument. Process all files with the date suffix less or equal to value of this option. Defaults to today minus one day (Use date -u +%Y%m%d) - to get the timestamp. -
- + to get the timestamp. +
-
-Next: summary start-date, -Previous: summary end-date, -Up: summary Invocation - +
+
+Next: summary start-date, Previous: summary end-date, Up: summary usage

- -
output-directory option
- -
-This is the “output directory” option. -This option takes a str argument. - The output directory summary will write all output files to. -
- + +
1.1.3 output-directory option
+ + +
This is the “output directory” option. +This option takes a str argument. + The output directory summary will write all output files to. +
-
-Next: summary exit status, -Previous: summary output-directory, -Up: summary Invocation - +
+
+Next: summary exit status, Previous: summary output-directory, Up: summary usage

+ +
1.1.4 start-date option
+ -
start-date option
- -
-This is the “start date” option. -This option takes a num argument. +
This is the “start date” option. +This option takes a num argument. Process all files with the date suffix more or equal to value of - this option. Defaults to 197000101. -
+ this option. Defaults to 197000101. +
-
-Previous: summary start-date, -Up: summary Invocation - +
+
+Previous: summary start-date, Up: summary usage

- -
summary exit status
+ +
1.1.5 summary exit status

One of the following exit values will be returned: -
-
‘0 (EXIT_SUCCESS)’
Successful program execution. -
‘1 (EXIT_FAILURE)’
The operation failed or the command syntax was not valid. +
+
‘0 (EXIT_SUCCESS)’
+
Successful program execution. +
+
‘1 (EXIT_FAILURE)’
+
The operation failed or the command syntax was not valid. +

+
+ - + + diff --git a/scripts/update-leap/update-leap.html b/scripts/update-leap/update-leap.html index 54180944b..4aa08490b 100644 --- a/scripts/update-leap/update-leap.html +++ b/scripts/update-leap/update-leap.html @@ -1,119 +1,168 @@ - + + + -update-leap User's Manual - - - - - - - +update-leap User’s Manual + + + + + + + + + + + + - -
update-leap User's Manual
-
-
-Next: update-leap Description, -Previous: (dir), -Up: (dir) -
-
-
This document describes the use of the NTP Project's update-leap program. + +
update-leap User’s Manual
+ + + + + + +
+
+Previous: (dir), Up: (dir)
+
+
Top
-
This document applies to version 4.2.8p9-win of update-leap. +
This document describes the use of the NTP Project’s update-leap program. +
+
This document applies to version 4.2.8p9-win of update-leap. +
+ +
Short Table of Contents

-
Short Contents
-
-
+
1 Invoking update-leap
+
-
-
update-leap Description: Description -
update-leap Invocation: Invoking update-leap -
-
-
+ + + +
• update-leap Description:    Description +
• update-leap Invocation:    Invoking update-leap +
+ +
-
+
+
+Up: Top

+ +
1 Invoking update-leap
+ + -
0.1 Invoking update-leap
-
-
update-leap +
update-leap will validate the file currently on the local system and if necessary, updates leap-second definition file. - -
Ordinarily, the file is found using the "leapfile" directive in -ntp.conf(5). +
+
Ordinarily, the file is found using the "leapfile" directive in +ntp.conf(5). However, an alternate location can be specified on the command line. - -
If the file does not exist, is not valid, has expired, or is expiring soon, +
+
If the file does not exist, is not valid, has expired, or is expiring soon, a new copy will be downloaded. If the new copy validates, it is installed and NTP is (optionally) restarted. - -
If the current file is acceptable, no download or restart occurs. - -
-c can also be used to invoke another script to perform administrative -functions, e.g. to copy the file to other local systems. +
+
If the current file is acceptable, no download or restart occurs. +
+
-c can also be used to invoke another script to perform administrative +functions, e.g. to copy the file to other local systems. .PP This can be run as a cron job. As the file is rarely updated, and leap seconds are announced at least one month in advance (usually longer), it -need not be run more frequently than about once every three weeks. +need not be run more frequently than about once every three weeks. .PP -For cron-friendly behavior, define CRONJOB=1 in the crontab. +For cron-friendly behavior, define CRONJOB=1 in the crontab. .PP This script depends on$REQUIREDCMDS - -
This section was generated by AutoGen, +
+
This section was generated by AutoGen, using the agtexi-cmd template and the option descriptions for the update-leap program. - -
-
update-leap usage: update-leap help/usage (--help) -
update-leap source-url: source-url option (-s) -
update-leap ipv4: ipv4 option (-4) -
update-leap destination: destination option (-d) -
update-leap expiration: expiration option (-e) -
update-leap ntp-conf-file: ntp-conf-file option (-f) -
update-leap force-update: force-update option (-F) -
update-leap exit status: exit status -
update-leap Usage: Usage -
update-leap Authors: Authors -
- -
-
-Next: update-leap source-url, -Up: update-leap Invocation -
+
+ + + + + + + + + + + +
• update-leap usage:    update-leap help/usage (--help) +
• update-leap source-url:    source-url option (-s) +
• update-leap ipv4:    ipv4 option (-4) +
• update-leap destination:    destination option (-d) +
• update-leap expiration:    expiration option (-e) +
• update-leap ntp-conf-file:    ntp-conf-file option (-f) +
• update-leap force-update:    force-update option (-F) +
• update-leap exit status:    exit status +
• update-leap Usage:    Usage +
• update-leap Authors:    Authors +
+ +
+ +
+
+Next: update-leap source-url, Up: update-leap Invocation

- -
0.1.1 update-leap help/usage (--help)
- -
-This is the automatically generated usage text for update-leap. - -
The text printed is the same whether selected with the help option -(--help) or the more-help option (--more-help). more-help will print -the usage text by passing it through a pager program. + +
1.1 update-leap help/usage (--help)
+ + +
This is the automatically generated usage text for update-leap. +
+
The text printed is the same whether selected with the help option +(--help) or the more-help option (--more-help). more-help will print +the usage text by passing it through a pager program. more-help is disabled on platforms without a working fork(2) function. The PAGER environment variable is -used to select the program, defaulting to more. Both will exit +used to select the program, defaulting to more. Both will exit with a status code of 0. - +
+

update-leap Usage: $0 [options] [leapfile] @@ -123,7 +172,7 @@ with a status code of 0. Specify the URL of the master copy to download $LEAPSRC -d Specify the filename on the local system $LEAPFILE -e Specify how long (in days) before expiration the file is to be refreshed. Note that - larger values imply more frequent refreshes. "$PREFETCH" -f Specify + larger values imply more frequent refreshes. "$PREFETCH" -f Specify location of ntp.conf (used to make sure leapfile directive is present and to default leapfile) $NTPCONF -F Force update even if current file is OK and not close to expiring. -r Specify number of @@ -142,7 +191,7 @@ with a status code of 0. $0 will validate the file currently on the local system - Ordinarily, the file is found using the "leapfile" directive in + Ordinarily, the file is found using the "leapfile" directive in $NTPCONF. However, an alternate location can be specified on the command line. @@ -164,160 +213,159 @@ with a status code of 0. For cron-friendly behavior, define CRONJOB=1 in the crontab. Version $VERSION -
-
-
-Next: update-leap ipv4, -Previous: update-leap usage, -Up: update-leap Invocation -
-
+
-
0.1.2 source-url option (-s)
+
+ +
+
+Next: update-leap ipv4, Previous: update-leap usage, Up: update-leap Invocation
+
+ +
1.2 source-url option (-s)
+ -
-This is the “the url of the master copy of the leapseconds file” option. -This option takes a string argument. +
This is the “the url of the master copy of the leapseconds file” option. +This option takes a string argument. Specify the URL of the master copy to download $LEAPSRC -
-
-Next: update-leap destination, -Previous: update-leap source-url, -Up: update-leap Invocation -
+
+ +
+
+Next: update-leap destination, Previous: update-leap source-url, Up: update-leap Invocation

- -
0.1.3 ipv4 option (-4)
- -
-This is the “use only ipv4 addresses for dns name resolution” option. - -
This option has some usage constraints. It: -
-
must not appear in combination with any of the following options: -ipv6. -
- -
Force DNS resolution of following host names on the command line - to the IPv4 namespace. + +
1.3 ipv4 option (-4)
+ + +
This is the “use only ipv4 addresses for dns name resolution” option. +
+
This option has some usage constraints. It: +
+
must not appear in combination with any of the following options: +ipv6. +
+ +
Force DNS resolution of following host names on the command line + to the IPv4 namespace. _EndOfDoc_; ; - -
flag = +
+
flag = name = ipv6; flags-cant = ipv4, prefer; value = 6; - descrip = "Use only IPv6 addresses for DNS name resolution"; + descrip = "Use only IPv6 addresses for DNS name resolution"; doc = <<- _EndOfDoc_ Force DNS resolution of following host names on the command line - to the IPv6 namespace. + to the IPv6 namespace. _EndOfDoc_; ; - -
flag = +
+
flag = name = prefer; flags-cant = ipv4, ipv6; value = p; arg-type = keyword; keyword = 4, 6; - descrip = 'Prefer IPv4 or IPv6 (as specified) addresses, but use either'; + descrip = ’Prefer IPv4 or IPv6 (as specified) addresses, but use either’; doc = <<- _EndOfDoc_ -Prefer IPv4 or IPv6 (as specified) addresses, but use either. -
-
-Next: update-leap expiration, -Previous: update-leap ipv4, -Up: update-leap Invocation -
+Prefer IPv4 or IPv6 (as specified) addresses, but use either. +
+ +
+
+Next: update-leap expiration, Previous: update-leap ipv4, Up: update-leap Invocation

+ +
1.4 destination option (-d)
+ -
0.1.4 destination option (-d)
- -
-This is the “filename on the local system” option. -This option takes a string argument float. -The name to use to store the leapfile on the local system. +
This is the “filename on the local system” option. +This option takes a string argument float. +The name to use to store the leapfile on the local system. $LEAPFILE -
-
-Next: update-leap ntp-conf-file, -Previous: update-leap destination, -Up: update-leap Invocation -
+
+ +
+
+Next: update-leap ntp-conf-file, Previous: update-leap destination, Up: update-leap Invocation

+ +
1.5 expiration option (-e)
+ -
0.1.5 expiration option (-e)
- -
-This is the “refresh the leapfile this long before it expires” option. -This option takes a string argument. +
This is the “refresh the leapfile this long before it expires” option. +This option takes a string argument. Specify how long before expiration the file is to be refreshed -Units are required, e.g. "-e 60 days" Note that larger values -imply more frequent refreshes. -"$PREFETCH" -
-
-Next: update-leap force-update, -Previous: update-leap expiration, -Up: update-leap Invocation -
+Units are required, e.g. "-e 60 days" Note that larger values +imply more frequent refreshes. +"$PREFETCH" +
+ +
+
+Next: update-leap force-update, Previous: update-leap expiration, Up: update-leap Invocation

+ +
1.6 ntp-conf-file option (-f)
+ -
0.1.6 ntp-conf-file option (-f)
- -
-This is the “location of the ntp.conf file” option. -This option takes a string argument. +
This is the “location of the ntp.conf file” option. +This option takes a string argument. Specify location of ntp.conf (used to make sure leapfile directive is present and to default leapfile) /etc/ntp.conf -
-
-Next: update-leap exit status, -Previous: update-leap ntp-conf-file, -Up: update-leap Invocation -
+
+ +
+
+Next: update-leap exit status, Previous: update-leap ntp-conf-file, Up: update-leap Invocation

- -
0.1.7 force-update option (-F)
- -
-This is the “force update of the leapfile” option. -Force update even if current file is OK and not close to expiring. -
-
-Next: update-leap Usage, -Previous: update-leap force-update, -Up: update-leap Invocation -
+ +
1.7 force-update option (-F)
+ + +
This is the “force update of the leapfile” option. +Force update even if current file is OK and not close to expiring. +
+ +
+
+Next: update-leap Usage, Previous: update-leap force-update, Up: update-leap Invocation

- -
0.1.8 update-leap exit status
+ +
1.8 update-leap exit status

One of the following exit values will be returned: -
-
0 (EXIT_SUCCESS)
Successful program execution. -
1 (EXIT_FAILURE)
The operation failed or the command syntax was not valid. +
+
‘0 (EXIT_SUCCESS)’
+
Successful program execution. +
+
‘1 (EXIT_FAILURE)’
+
The operation failed or the command syntax was not valid. +

-
-
-Next: update-leap Authors, -Previous: update-leap exit status, -Up: update-leap Invocation -
+
+ +
+
+Next: update-leap Authors, Previous: update-leap exit status, Up: update-leap Invocation

- -
0.1.9 update-leap Usage
- -
-
-Previous: update-leap Usage, -Up: update-leap Invocation -
+ +
1.9 update-leap Usage
+
+ +
+
+Previous: update-leap Usage, Up: update-leap Invocation

+ +
1.10 update-leap Authors
+
-
0.1.10 update-leap Authors
- + + diff --git a/sntp/Makefile.am b/sntp/Makefile.am index facc07b80..7deca5a0f 100644 --- a/sntp/Makefile.am +++ b/sntp/Makefile.am @@ -4,14 +4,17 @@ ACLOCAL_AMFLAGS = -I m4 -I libevent/m4 -I libopts/m4 NULL = -AM_CFLAGS = $(CFLAGS_NTP) +AM_CFLAGS = $(CFLAGS_NTP) +AM_CFLAGS += $(NTP_HARD_CFLAGS) AM_CPPFLAGS = $(SNTP_INCS) AM_CPPFLAGS += $(LIBOPTS_CFLAGS) AM_CPPFLAGS += $(CPPFLAGS_LIBEVENT) AM_CPPFLAGS += $(CPPFLAGS_NTP) +AM_CPPFLAGS += $(NTP_HARD_CPPFLAGS) -AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS += $(NTP_HARD_LDFLAGS) LDADD = version.o LDADD += libsntp.a @@ -92,6 +95,7 @@ EXTRA_DIST = \ $(srcdir)/COPYRIGHT \ ag-tpl \ deps-ver \ + harden \ invoke-sntp.menu \ invoke-sntp.texi \ @NTP_FORCE_LIBEVENT_DIST@ \ diff --git a/sntp/configure.ac b/sntp/configure.ac index 391e5866a..b03c257bf 100644 --- a/sntp/configure.ac +++ b/sntp/configure.ac @@ -56,6 +56,8 @@ dnl AC_ARG_PROGRAM NTP_PROG_CC +NTP_HARDEN + NTP_LOCINFO() dnl AM_PROG_AR req. automake 1.12 diff --git a/sntp/harden/README b/sntp/harden/README new file mode 100644 index 000000000..ce82e4f3e --- /dev/null +++ b/sntp/harden/README @@ -0,0 +1,11 @@ +If you look at the files here you should be able to figure out what is +being done. + +../scripts/genHardFlags handles the parsing of these files. + +If no "more specific" file has been found and cvo.sh says the OS is +redhat* or fedora*, we will look for loc/redhat . + +If no "mode specific" file has been found and the "uname" command returns +"Linux", we will look for loc/linux . + diff --git a/sntp/harden/default b/sntp/harden/default new file mode 100644 index 000000000..cf0aa2cad --- /dev/null +++ b/sntp/harden/default @@ -0,0 +1,4 @@ +# Default hardening flags +NTP_HARD_CFLAGS="" +NTP_HARD_CPPFLAGS="" +NTP_HARD_LDFLAGS="" diff --git a/sntp/harden/freebsd10 b/sntp/harden/freebsd10 new file mode 100644 index 000000000..11fc3cd4e --- /dev/null +++ b/sntp/harden/freebsd10 @@ -0,0 +1,4 @@ +# FreeBSD-10 hardening flags +NTP_HARD_CFLAGS="-fstack-protector -Wformat -Wformat-security -Werror=format-security" +NTP_HARD_CPPFLAGS="" +NTP_HARD_LDFLAGS="-Wl,-z,relro" diff --git a/sntp/harden/freebsd11 b/sntp/harden/freebsd11 new file mode 100644 index 000000000..21387dab6 --- /dev/null +++ b/sntp/harden/freebsd11 @@ -0,0 +1,4 @@ +# FreeBSD-11 hardening flags +NTP_HARD_CFLAGS="-fsanitize=safe-stack -fstack-protector -Wformat -Wformat-security -Werror=format-security" +NTP_HARD_CPPFLAGS="" +NTP_HARD_LDFLAGS="-Wl,-z,relro" diff --git a/sntp/harden/freebsd12 b/sntp/harden/freebsd12 new file mode 100644 index 000000000..21387dab6 --- /dev/null +++ b/sntp/harden/freebsd12 @@ -0,0 +1,4 @@ +# FreeBSD-11 hardening flags +NTP_HARD_CFLAGS="-fsanitize=safe-stack -fstack-protector -Wformat -Wformat-security -Werror=format-security" +NTP_HARD_CPPFLAGS="" +NTP_HARD_LDFLAGS="-Wl,-z,relro" diff --git a/sntp/harden/linux b/sntp/harden/linux new file mode 100644 index 000000000..db235446e --- /dev/null +++ b/sntp/harden/linux @@ -0,0 +1,4 @@ +# generic linux hardening flags +NTP_HARD_CFLAGS="-pie -fPIE -fPIC -fstack-protector-all -O1" +NTP_HARD_CPPFLAGS="-D_FORTIFY_SOURCE=2" +NTP_HARD_LDFLAGS="-z relro -z now" diff --git a/sntp/libevent/Makefile.am b/sntp/libevent/Makefile.am index 1300e8f9d..0da682b5d 100644 --- a/sntp/libevent/Makefile.am +++ b/sntp/libevent/Makefile.am @@ -221,7 +221,11 @@ NO_UNDEFINED = MAYBE_CORE = endif -GENERIC_LDFLAGS = -version-info $(VERSION_INFO) $(RELEASE) $(NO_UNDEFINED) +AM_CFLAGS = $(LEP_CFLAGS) +AM_CPPFLAGS = -I$(srcdir)/compat -I$(srcdir)/include -I./include $(SYS_INCLUDES) $(LEP_CPPFLAGS) +AM_LDFLAGS = $(LEP_CFLAGS) + +GENERIC_LDFLAGS = -version-info $(VERSION_INFO) $(RELEASE) $(NO_UNDEFINED) $(AM_LDFLAGS) libevent_la_SOURCES = $(CORE_SRC) $(EXTRAS_SRC) libevent_la_LIBADD = @LTLIBOBJS@ $(SYS_LIBS) @@ -291,8 +295,6 @@ else noinst_HEADERS += $(EVENT1_HDRS) endif -AM_CPPFLAGS = -I$(srcdir)/compat -I$(srcdir)/include -I./include $(SYS_INCLUDES) - verify: check doxygen: FORCE diff --git a/sntp/libevent/configure.ac b/sntp/libevent/configure.ac index 2cdc74f16..5cb7f678b 100644 --- a/sntp/libevent/configure.ac +++ b/sntp/libevent/configure.ac @@ -912,5 +912,9 @@ AC_SUBST([LIBEVENT_GC_SECTIONS]) AM_CONDITIONAL([INSTALL_LIBEVENT], [test "$enable_libevent_install" = "yes"]) +AC_SUBST([LEP_CFLAGS]) +AC_SUBST([LEP_CPPFLAGS]) +AC_SUBST([LEP_LDFLAGS]) + AC_CONFIG_FILES( [libevent.pc libevent_openssl.pc libevent_pthreads.pc] ) AC_OUTPUT(Makefile) diff --git a/sntp/libopts/Makefile.am b/sntp/libopts/Makefile.am index ea1b56dfd..c67460cd6 100644 --- a/sntp/libopts/Makefile.am +++ b/sntp/libopts/Makefile.am @@ -12,6 +12,10 @@ EXTRA_DIST = BUILT_SOURCES = MOSTLYCLEANFILES = +AM_CFLAGS = $(NTP_HARD_CFLAGS) +AM_CPPFLAGS = $(NTP_HARD_CPPFLAGS) +AM_LDFLAGS = $(NTP_HARD_LDFLAGS) + libopts.c: $(BUILT_SOURCES) @: do-nothing rule to avoid default SCCS get diff --git a/sntp/m4/ntp_harden.m4 b/sntp/m4/ntp_harden.m4 new file mode 100644 index 000000000..e6d5f36a9 --- /dev/null +++ b/sntp/m4/ntp_harden.m4 @@ -0,0 +1,52 @@ +dnl ###################################################################### +dnl @synopsis NTP_HARDEN([SCRIPTSDIRPATH]) +dnl Build (compile/link) hardening information: +dnl - NTP_HARD_CFLAGS +dnl - NTP_HARD_CPPFLAGS +dnl - NTP_HARD_LDFLAGS + +AC_DEFUN([NTP_HARDEN], [ + +AC_MSG_CHECKING([for compile/link hardening flags]) + +AC_ARG_WITH( + [locfile], + [AS_HELP_STRING( + [--with-locfile=XXX], + [os-specific or "legacy"] + )], + [], + [with_locfile=no] +) + +( \ + SENTINEL_DIR="$PWD" && \ + cd $srcdir/$1 && \ + case "$with_locfile" in \ + yes|no|'') \ + scripts/genHardFlags -d "$SENTINEL_DIR" \ + ;; \ + *) \ + scripts/genHardFlags -d "$SENTINEL_DIR" -f "$with_locfile" \ + ;; \ + esac \ +) > genHardFlags.i 2> genHardFlags.err +. ./genHardFlags.i + +case "$GENHARDFLAG" in + OK) + AC_MSG_RESULT([in file $GENHARDFLAGFILE]) + rm genHardFlags.err genHardFlags.i + ;; + *) + AC_MSG_RESULT([failed.]) + AC_MSG_ERROR([Problem with genHardFlags!]) + ;; +esac + +AC_SUBST([NTP_HARD_CFLAGS]) +AC_SUBST([NTP_HARD_CPPFLAGS]) +AC_SUBST([NTP_HARD_LDFLAGS]) + +])dnl +dnl ====================================================================== diff --git a/sntp/m4/ntp_libevent.m4 b/sntp/m4/ntp_libevent.m4 index a465d9bba..69325efe7 100644 --- a/sntp/m4/ntp_libevent.m4 +++ b/sntp/m4/ntp_libevent.m4 @@ -182,6 +182,9 @@ case "$ntp_use_local_libevent" in ac_configure_args=" --disable-libevent-install${ac_configure_args}" ac_configure_args=" --enable-silent-rules${ac_configure_args}" ac_configure_args=" --enable-function-sections${ac_configure_args}" + ac_configure_args=" LEP_CFLAGS='${NTP_HARD_CFLAGS}'${ac_configure_args}" + ac_configure_args=" LEP_CPPFLAGS='${NTP_HARD_CPPFLAGS}'${ac_configure_args}" + ac_configure_args=" LEP_LDFLAGS='${NTP_HARD_LDFLAGS}'${ac_configure_args}" AC_CONFIG_SUBDIRS([libevent]) ;; *) diff --git a/sntp/scripts/Makefile.am b/sntp/scripts/Makefile.am index 52406105d..501a53aa4 100644 --- a/sntp/scripts/Makefile.am +++ b/sntp/scripts/Makefile.am @@ -2,6 +2,7 @@ NULL= EXTRA_DIST = \ cvo.sh \ + genHardFlags \ genLocInfo \ mansec2subst.sed \ $(NULL) diff --git a/sntp/scripts/genHardFlags b/sntp/scripts/genHardFlags new file mode 100755 index 000000000..5e41cba37 --- /dev/null +++ b/sntp/scripts/genHardFlags @@ -0,0 +1,152 @@ +#! /bin/sh + +args=`getopt d:f:v $*` +set -- $args + +HF= +V=": " + +for i +do + case "$i" in + -d) sdir="$2" ; shift 2 ;; + -f) hardenfile="$2" ; shift 2 ;; + -v) V= ; shift ;; + --) shift ; break ;; + esac +done + +case "$sdir" in + '') + sdir=. +esac + +case "$hardenfile" in + */*) + HF=$hardenfile + ;; + '') + ;; + *) + hf=harden/$hardenfile + if test -f $hf + then + HF=$hf + fi + ;; +esac + +# If we have a file to use (ie, HF is not empty) then look for one. +case "$HF" in + '') + PATH=$PATH:libevent/build-aux + export PATH + set `scripts/cvo.sh @osname@ @osver@` || exit 1 + + CVO_OSNAME=$1 + CVO_OSVER=$2 + + x=$CVO_OSVER + + while true + do + case "$x" in + '') break ;; + esac +hf=harden/$CVO_OSNAME$x +${V}echo "Looking for <$hf>" >&2 + if test -f $hf + then + HF=$hf + break + fi + case "$x" in + *.*) x=`echo $x | sed -e 's/\.[^.]*$//'` ;; + *) x= ;; + esac + done + case "$HF" in + '') + hf=harden/$CVO_OSNAME +${V}echo "Looking for <$hf>" >&2 + if test -f $hf + then + HF=$hf + fi + ;; + esac + # Handle some "aliases" + case "$HF" in + '') + case "$CVO_OSNAME" in + raspbian*) + hf=harden/debian +${V}echo "Looking for <$hf>" >&2 + if test -f $hf + then + HF=$hf + fi + ;; + redhat* | fedora*) + hf=harden/redhat +${V}echo "Looking for <$hf>" >&2 + if test -f $hf + then + HF=$hf + fi + ;; + esac + ;; + esac + + # This might be a good place to see if uname returns "Linux", + # and if so, use a generic file for that. + case "$HF" in + '') + case "`uname`" in + Linux) + hf=harden/linux +${V}echo "Looking for <$hf>" >&2 + if test -f $hf + then + HF=$hf + fi + ;; + esac + ;; + esac + + # Finally, 'default' + case "$HF" in + '') + hf=harden/default +${V}echo "Looking for <$hf>" >&2 + if test -f $hf + then + HF=$hf + fi + ;; + esac + + case "$HF" in + '') + echo "No harden/XXX file found!" >&2 + exit 1 + ;; + esac + ;; +esac + +${V}echo "Using <$HF>" >&2 +echo "GENHARDFLAGFILE=$HF" + +### + +. $HF + +echo "NTP_HARD_CFLAGS='$NTP_HARD_CFLAGS'" +echo "NTP_HARD_CPPFLAGS='$NTP_HARD_CPPFLAGS'" +echo "NTP_HARD_LDFLAGS='$NTP_HARD_LDFLAGS'" +echo GENHARDFLAG=OK + +exit 0 diff --git a/sntp/sntp.html b/sntp/sntp.html index 934dbe9b0..7d4e282b0 100644 --- a/sntp/sntp.html +++ b/sntp/sntp.html @@ -1,187 +1,243 @@ - + + + -Sntp User's Manual - - - - - - - +Sntp User’s Manual + + + + + + + + + + + + - -
Sntp User's Manual
-
- -
-Next: sntp Description, -Previous: (dir), -Up: (dir) -
+ +
Sntp User’s Manual
+ + + -
Simple Network Time Protocol User Manual
-
This document describes the use of the NTP Project's sntp program, + +
+
+Next: sntp Description, Previous: (dir), Up: (dir)
+
+ +
Simple Network Time Protocol User Manual
+ +
This document describes the use of the NTP Project’s sntp program, that can be used to query a Network Time Protocol (NTP) server and display the time offset of the system clock relative to the server clock. Run as root, it can correct the system clock to this offset as well. It can be run as an interactive command or from a cron job. - -
This document applies to version 4.2.8p9-win of sntp. - -
The program implements the SNTP protocol as defined by RFC 5905, the NTPv4 +
+
This document applies to version 4.2.8p9-win of sntp. +
+
The program implements the SNTP protocol as defined by RFC 5905, the NTPv4 IETF specification. +
+ +
Short Table of Contents
-
-
Short Contents
-
-Simple Network Time Protocol User Manual +
+
+
1 Description

-
-
sntp Description: Description -
sntp Invocation: Invoking sntp -
Usage: Usage -
- -
- -
+ + + + +
• sntp Description:    Description +
• sntp Invocation:    Invoking sntp +
• Usage:    Usage +
+
+ +
+
+Next: sntp Invocation, Up: Top

- - -
Description
+ +
1 Description

By default, sntp writes the local data and time (i.e., not UTC) to the standard output in the format: +
+
+
1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 secs +
-
1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 secs -
-
where +
where YYYY-MM-DD HH:MM:SS.SUBSEC is the local date and time, (+0800) is the local timezone adjustment (so we would add 8 hours and 0 minutes to convert the reported local time to UTC), and the +4.567 +/- 0.089 secs indicates the time offset and error bound of the system clock relative to the server clock. - -
+
+
-
- - +
+
+Next: Usage, Previous: sntp Description, Up: sntp Description

+ +
1.1 Invoking sntp
+ + -
Invoking sntp
-
-
sntp +
sntp can be used as an SNTP client to query a NTP or SNTP server and either display -the time or set the local system's time (given suitable privilege). It can be +the time or set the local system’s time (given suitable privilege). It can be run as an interactive command or from a cron job. - -
NTP (the Network Time Protocol) and SNTP (the Simple Network Time Protocol) +
+
NTP (the Network Time Protocol) and SNTP (the Simple Network Time Protocol) are defined and described by RFC 5905. +
-
The default is to write the estimated correct local date and time (i.e. not +
The default is to write the estimated correct local date and time (i.e. not UTC) to the standard output in a format like: - -
'1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 [host] IP sN' - -
where the +
+
'1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 [host] IP sN' +
+
where the '(+0800)' means that to get to UTC from the reported local time one must add 8 hours and 0 minutes, the '+4.567' indicates the local clock is 4.567 seconds behind the correct time -(so 4.567 seconds must be added to the local clock to get it to be correct). +(so 4.567 seconds must be added to the local clock to get it to be correct). Note that the number of decimals printed for this value will change -based on the reported precision of the server. +based on the reported precision of the server. '+/- 0.089' is the reported synchronization distance -(in seconds), which represents the maximum error due to all causes. +(in seconds), which represents the maximum error due to all causes. If the server does not report valid data needed to calculate the synchronization distance, this will be reported as -'+/- ?'. +'+/- ?'. If the host is different from the IP, -both will be displayed. -Otherwise, only the +both will be displayed. +Otherwise, only the IP -is displayed. +is displayed. Finally, the stratum of the host is reported and the leap indicator is decoded and displayed. - -
This section was generated by AutoGen, -using the agtexi-cmd template and the option descriptions for the sntp program. +
+
This section was generated by AutoGen, +using the agtexi-cmd template and the option descriptions for the sntp program. This software is released under the NTP license, <http://ntp.org/license>. - -
-
sntp usage: sntp help/usage (--help) -
sntp ipv4: ipv4 option (-4) -
sntp ipv6: ipv6 option (-6) -
sntp authentication: authentication option (-a) -
sntp broadcast: broadcast option (-b) -
sntp concurrent: concurrent option (-c) -
sntp gap: gap option (-g) -
sntp kod: kod option (-K) -
sntp keyfile: keyfile option (-k) -
sntp logfile: logfile option (-l) -
sntp steplimit: steplimit option (-M) -
sntp ntpversion: ntpversion option (-o) -
sntp usereservedport: usereservedport option (-r) -
sntp timeout: timeout option (-t) -
sntp wait: wait option -
sntp config: presetting/configuring sntp -
sntp exit status: exit status -
sntp Usage: Usage -
sntp Authors: Authors -
- -
+
+ + + + + + + + + + + + + + + + + + + + +
• sntp usage:    sntp help/usage (--help) +
• sntp ipv4:    ipv4 option (-4) +
• sntp ipv6:    ipv6 option (-6) +
• sntp authentication:    authentication option (-a) +
• sntp broadcast:    broadcast option (-b) +
• sntp concurrent:    concurrent option (-c) +
• sntp gap:    gap option (-g) +
• sntp kod:    kod option (-K) +
• sntp keyfile:    keyfile option (-k) +
• sntp logfile:    logfile option (-l) +
• sntp steplimit:    steplimit option (-M) +
• sntp ntpversion:    ntpversion option (-o) +
• sntp usereservedport:    usereservedport option (-r) +
• sntp timeout:    timeout option (-t) +
• sntp wait:    wait option +
• sntp config:    presetting/configuring sntp +
• sntp exit status:    exit status +
• sntp Usage:    Usage +
• sntp Authors:    Authors +
+ +
-
-Next: sntp ipv4, -Up: sntp Invocation - +
+
+Next: sntp ipv4, Up: sntp Invocation

- -
sntp help/usage (--help)
- -
-This is the automatically generated usage text for sntp. - -
The text printed is the same whether selected with the help option -(--help) or the more-help option (--more-help). more-help will print -the usage text by passing it through a pager program. + +
1.1.1 sntp help/usage (--help)
+ + +
This is the automatically generated usage text for sntp. +
+
The text printed is the same whether selected with the help option +(--help) or the more-help option (--more-help). more-help will print +the usage text by passing it through a pager program. more-help is disabled on platforms without a working fork(2) function. The PAGER environment variable is -used to select the program, defaulting to more. Both will exit +used to select the program, defaulting to more. Both will exit with a status code of 0. - -
sntp - standard Simple Network Time Protocol client program - Ver. 4.2.8p9-win +
+
+
sntp - standard Simple Network Time Protocol client program - Ver. 4.2.8p9 Usage: sntp [ -<flag> [<val>] | --<name>[{=| }<val>] ]... \ [ hostname-or-IP ...] Flg Arg Option-Name Description @@ -233,416 +289,408 @@ The following option preset mechanisms are supported: - examining environment variables named SNTP_* Please send bug reports to: <http://bugs.ntp.org, bugs@ntp.org> -
-
- -
-Next: sntp ipv6, -Previous: sntp usage, -Up: sntp Invocation +
+
+ +
+
+Next: sntp ipv6, Previous: sntp usage, Up: sntp Invocation

- -
ipv4 option (-4)
- -
-This is the “force ipv4 dns name resolution” option. - -
This option has some usage constraints. It: -
-
must not appear in combination with any of the following options: -ipv6. -
- -
Force DNS resolution of the following host names on the command line -to the IPv4 namespace. -
+ +
1.1.2 ipv4 option (-4)
+ + +
This is the “force ipv4 dns name resolution” option. +
+
This option has some usage constraints. It: +
+
must not appear in combination with any of the following options: +ipv6. +
+ +
Force DNS resolution of the following host names on the command line +to the IPv4 namespace. +
-
-Next: sntp authentication, -Previous: sntp ipv4, -Up: sntp Invocation - +
+
+Next: sntp authentication, Previous: sntp ipv4, Up: sntp Invocation

- -
ipv6 option (-6)
- -
-This is the “force ipv6 dns name resolution” option. - -
This option has some usage constraints. It: -
-
must not appear in combination with any of the following options: -ipv4. -
- -
Force DNS resolution of the following host names on the command line -to the IPv6 namespace. -
+ +
1.1.3 ipv6 option (-6)
+ + +
This is the “force ipv6 dns name resolution” option. +
+
This option has some usage constraints. It: +
+
must not appear in combination with any of the following options: +ipv4. +
+ +
Force DNS resolution of the following host names on the command line +to the IPv6 namespace. +
-
-Next: sntp broadcast, -Previous: sntp ipv6, -Up: sntp Invocation - +
+
+Next: sntp broadcast, Previous: sntp ipv6, Up: sntp Invocation

- -
authentication option (-a)
- -
-This is the “enable authentication with the key auth-keynumber” option. -This option takes a number argument auth-keynumber. -Enable authentication using the key specified in this option's -argument. The argument of this option is the keyid, a -number specified in the keyfile as this key's identifier. -See the keyfile option (-k) for more details. -
+ +
1.1.4 authentication option (-a)
+ + +
This is the “enable authentication with the key auth-keynumber” option. +This option takes a number argument auth-keynumber. +Enable authentication using the key specified in this option’s +argument. The argument of this option is the keyid, a +number specified in the keyfile as this key’s identifier. +See the keyfile option (-k) for more details. +
-
-Next: sntp concurrent, -Previous: sntp authentication, -Up: sntp Invocation - +
+
+Next: sntp concurrent, Previous: sntp authentication, Up: sntp Invocation

- -
broadcast option (-b)
- -
-This is the “listen to the address specified for broadcast time sync” option. -This option takes a string argument broadcast-address. - -
This option has some usage constraints. It: -
-
may appear an unlimited number of times. -
- -
If specified sntp will listen to the specified address + +
1.1.5 broadcast option (-b)
+ + +
This is the “listen to the address specified for broadcast time sync” option. +This option takes a string argument broadcast-address. +
+
This option has some usage constraints. It: +
+
may appear an unlimited number of times. +
+ +
If specified sntp will listen to the specified address for NTP broadcasts. The default maximum wait time -can (and probably should) be modified with -t. -
+can (and probably should) be modified with -t. +
-
-Next: sntp gap, -Previous: sntp broadcast, -Up: sntp Invocation - +
+
+Next: sntp gap, Previous: sntp broadcast, Up: sntp Invocation

- -
concurrent option (-c)
- -
-This is the “concurrently query all ips returned for host-name” option. -This option takes a string argument host-name. - -
This option has some usage constraints. It: -
-
may appear an unlimited number of times. -
- -
Requests from an NTP "client" to a "server" should never be sent + +
1.1.6 concurrent option (-c)
+ + +
This is the “concurrently query all ips returned for host-name” option. +This option takes a string argument host-name. +
+
This option has some usage constraints. It: +
+
may appear an unlimited number of times. +
+ +
Requests from an NTP "client" to a "server" should never be sent more rapidly than one every 2 seconds. By default, any IPs returned as part of a DNS lookup are assumed to be for a single instance of ntpd, and therefore sntp will send queries to these IPs one after another, with a 2-second gap in between each query. - -
The -c or --concurrent flag says that any IPs +
+
The -c or --concurrent flag says that any IPs returned for the DNS lookup of the supplied host-name are on -different machines, so we can send concurrent queries. -
+different machines, so we can send concurrent queries. +
-
-Next: sntp kod, -Previous: sntp concurrent, -Up: sntp Invocation - +
+
+Next: sntp kod, Previous: sntp concurrent, Up: sntp Invocation

+ +
1.1.7 gap option (-g)
+ -
gap option (-g)
- -
-This is the “the gap (in milliseconds) between time requests” option. -This option takes a number argument milliseconds. -Since we're only going to use the first valid response we get and +
This is the “the gap (in milliseconds) between time requests” option. +This option takes a number argument milliseconds. +Since we’re only going to use the first valid response we get and there is benefit to specifying a good number of servers to query, separate the queries we send out by the specified number of -milliseconds. -
+milliseconds. +
-
-Next: sntp keyfile, -Previous: sntp gap, -Up: sntp Invocation - +
+
+Next: sntp keyfile, Previous: sntp gap, Up: sntp Invocation

+ +
1.1.8 kod option (-K)
+ -
kod option (-K)
- -
-This is the “kod history filename” option. -This option takes a file argument file-name. +
This is the “kod history filename” option. +This option takes a file argument file-name. Specifies the filename to be used for the persistent history of KoD responses received from servers. If the file does not exist, a -warning message will be displayed. The file will not be created. -
+warning message will be displayed. The file will not be created. +
-
-Next: sntp logfile, -Previous: sntp kod, -Up: sntp Invocation - +
+
+Next: sntp logfile, Previous: sntp kod, Up: sntp Invocation

- -
keyfile option (-k)
- -
-This is the “look in this file for the key specified with -a” option. -This option takes a file argument file-name. -This option specifies the keyfile. -sntp will search for the key specified with -a -keyno in this file. See ntp.keys(5) for more -information. -
+ +
1.1.9 keyfile option (-k)
+ + +
This is the “look in this file for the key specified with -a” option. +This option takes a file argument file-name. +This option specifies the keyfile. +sntp will search for the key specified with -a +keyno in this file. See ntp.keys(5) for more +information. +
-
-Next: sntp steplimit, -Previous: sntp keyfile, -Up: sntp Invocation - +
+
+Next: sntp steplimit, Previous: sntp keyfile, Up: sntp Invocation

+ +
1.1.10 logfile option (-l)
+ -
logfile option (-l)
- -
-This is the “log to specified logfile” option. -This option takes a file argument file-name. +
This is the “log to specified logfile” option. +This option takes a file argument file-name. This option causes the client to write log messages to the specified -logfile. -
+logfile. +
-
-Next: sntp ntpversion, -Previous: sntp logfile, -Up: sntp Invocation - +
+
+Next: sntp ntpversion, Previous: sntp logfile, Up: sntp Invocation

- -
steplimit option (-M)
- -
-This is the “adjustments less than steplimit msec will be slewed” option. -This option takes a number argument. -If the time adjustment is less than steplimit milliseconds, -slew the amount using adjtime(2). Otherwise, step the -correction using settimeofday(2). The default value is 0, + +
1.1.11 steplimit option (-M)
+ + +
This is the “adjustments less than steplimit msec will be slewed” option. +This option takes a number argument. +If the time adjustment is less than steplimit milliseconds, +slew the amount using adjtime(2). Otherwise, step the +correction using settimeofday(2). The default value is 0, which means all adjustments will be stepped. This is a feature, as -different situations demand different values. -
+different situations demand different values. +
-
-Next: sntp usereservedport, -Previous: sntp steplimit, -Up: sntp Invocation - +
+
+Next: sntp usereservedport, Previous: sntp steplimit, Up: sntp Invocation

+ +
1.1.12 ntpversion option (-o)
+ -
ntpversion option (-o)
- -
-This is the “send int as our ntp protocol version” option. -This option takes a number argument. +
This is the “send int as our ntp protocol version” option. +This option takes a number argument. When sending requests to a remote server, tell them we are running -NTP protocol version ntpversion . -
+NTP protocol version ntpversion . +
-
-Next: sntp timeout, -Previous: sntp ntpversion, -Up: sntp Invocation - +
+
+Next: sntp timeout, Previous: sntp ntpversion, Up: sntp Invocation

+ +
1.1.13 usereservedport option (-r)
+ -
usereservedport option (-r)
- -
-This is the “use the ntp reserved port (port 123)” option. +
This is the “use the ntp reserved port (port 123)” option. Use port 123, which is reserved for NTP, for our network -communications. -
+communications. +
-
-Next: sntp wait, -Previous: sntp usereservedport, -Up: sntp Invocation - +
+
+Next: sntp wait, Previous: sntp usereservedport, Up: sntp Invocation

+ +
1.1.14 timeout option (-t)
+ -
timeout option (-t)
- -
-This is the “the number of seconds to wait for responses” option. -This option takes a number argument seconds. +
This is the “the number of seconds to wait for responses” option. +This option takes a number argument seconds. When waiting for a reply, sntp will wait the number of seconds specified before giving up. The default should be more than enough for a unicast response. If sntp is only waiting for a broadcast response a longer timeout is -likely needed. -
+likely needed. +
-
-Next: sntp config, -Previous: sntp timeout, -Up: sntp Invocation - +
+
+Next: sntp config, Previous: sntp timeout, Up: sntp Invocation

- -
wait option
- -
-This is the “wait for pending replies (if not setting the time)” option. - -
This option has some usage constraints. It: -
-
can be disabled with –no-wait. -
It is enabled by default. -
- -
If we are not setting the time, wait for all pending responses. - -
+ +
1.1.15 wait option
+ + +
This is the “wait for pending replies (if not setting the time)” option. +
+
This option has some usage constraints. It: +
+
can be disabled with –no-wait. +
It is enabled by default. +
+ +
If we are not setting the time, wait for all pending responses. +
+ +
-
-Next: sntp exit status, -Previous: sntp wait, -Up: sntp Invocation - +
+
+Next: sntp exit status, Previous: sntp wait, Up: sntp Invocation

- -
presetting/configuring sntp
+ +
1.1.16 presetting/configuring sntp

Any option that is not marked as not presettable may be preset by -loading values from configuration ("rc" or "ini") files, and values from environment variables named SNTP and SNTP_<OPTION_NAME>. <OPTION_NAME> must be one of -the options listed above in upper case and segmented with underscores. +loading values from configuration ("rc" or "ini") files, and values from environment variables named SNTP and SNTP_<OPTION_NAME>. <OPTION_NAME> must be one of +the options listed above in upper case and segmented with underscores. The SNTP variable will be tokenized and parsed like the command line. The remaining variables are tested for existence and their values are treated like option arguments. - -
libopts will search in 2 places for configuration files: -
-
$HOME -
$PWD -
- The environment variables HOME, and PWD -are expanded and replaced when sntp runs. -For any of these that are plain files, they are simply processed. -For any that are directories, then a file named .ntprc is searched for +
+ +
libopts will search in 2 places for configuration files: +
+
$HOME +
$PWD +
+
The environment variables HOME, and PWD +are expanded and replaced when sntp runs. +For any of these that are plain files, they are simply processed. +For any that are directories, then a file named .ntprc is searched for within that directory and processed. - -
Configuration files may be in a wide variety of formats. +
+
Configuration files may be in a wide variety of formats. The basic format is an option name followed by a value (argument) on the same line. Values may be separated from the option name with a colon, equal sign or simply white space. Values may be continued across multiple lines by escaping the newline with a backslash. - -
Multiple programs may also share the same initialization file. +
+
Multiple programs may also share the same initialization file. Common options are collected at the top, followed by program specific segments. The segments are separated by lines like: -
[SNTP] -
-
or by -
<?program sntp> -
-
Do not mix these styles within one configuration file. - -
Compound values and carefully constructed string values may also be +
+
[SNTP] +
+
or by +
+
<?program sntp> +
+
Do not mix these styles within one configuration file. +
+
Compound values and carefully constructed string values may also be specified using XML syntax: -
<option-name> - <sub-opt>...<...>...</sub-opt> - </option-name> -
-
yielding an option-name.sub-opt string value of -
"...<...>..." -
-
AutoOpts does not track suboptions. You simply note that it is a +
+
<option-name> + <sub-opt>...<...>...</sub-opt> +</option-name> +
+
yielding an option-name.sub-opt string value of +
+
"...<...>..." +
+
AutoOpts does not track suboptions. You simply note that it is a hierarchicly valued option. AutoOpts does provide a means for searching the associated name/value pair list (see: optionFindValue). - -
The command line options relating to configuration and/or usage help are: - -
version (-)
+
+
The command line options relating to configuration and/or usage help are: +
+ +
version (-)

Print the program version to standard out, optionally with licensing information, then exit 0. The optional argument specifies how much licensing -detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument. +detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument. Only the first letter of the argument is examined: - -
-
‘version’
Only print the version. This is the default. -
‘copyright’
Name the copyright usage licensing terms. -
‘verbose’
Print the full copyright usage licensing terms. +
+
+
‘version’
+
Only print the version. This is the default. +
+
‘copyright’
+
Name the copyright usage licensing terms. +
+
‘verbose’
+
Print the full copyright usage licensing terms. +

-
+
-
-Next: sntp Usage, -Previous: sntp config, -Up: sntp Invocation - +
+
+Next: sntp Usage, Previous: sntp config, Up: sntp Invocation

- -
sntp exit status
+ +
1.1.17 sntp exit status

One of the following exit values will be returned: -
-
‘0 (EXIT_SUCCESS)’
Successful program execution. -
‘1 (EXIT_FAILURE)’
The operation failed or the command syntax was not valid. -
‘66 (EX_NOINPUT)’
A specified configuration file could not be loaded. -
‘70 (EX_SOFTWARE)’
libopts had an internal operational error. Please report -it to autogen-users@lists.sourceforge.net. Thank you. +
+
‘0 (EXIT_SUCCESS)’
+
Successful program execution. +
+
‘1 (EXIT_FAILURE)’
+
The operation failed or the command syntax was not valid. +
+
‘66 (EX_NOINPUT)’
+
A specified configuration file could not be loaded. +
+
‘70 (EX_SOFTWARE)’
+
libopts had an internal operational error. Please report +it to autogen-users@lists.sourceforge.net. Thank you. +

-
+
-
-Next: sntp Authors, -Previous: sntp exit status, -Up: sntp Invocation - +
+
+Next: sntp Authors, Previous: sntp exit status, Up: sntp Invocation

- -
sntp Usage
- -
+ +
1.1.18 sntp Usage
+
-
-Previous: sntp Usage, -Up: sntp Invocation - +
+
+Previous: sntp Usage, Up: sntp Invocation

+ +
1.1.19 sntp Authors
-
sntp Authors
- -
+
-
- - +
+
+Previous: sntp Invocation, Up: sntp Description

- - -
Usage
+ +
1.2 Usage

The simplest use of this program is as an unprivileged command to -check the current time, offset, and error in the local clock. +check the current time, offset, and error in the local clock. For example: +
+
+
sntp ntpserver.somewhere +
-
sntp ntpserver.somewhere -
-
With suitable privilege, it can be run as a command or in a +
With suitable privilege, it can be run as a command or in a crom job to reset the local clock from a reliable server, like -the ntpdate and rdate commands. +the ntpdate and rdate commands. For example: +
+
+
sntp -a ntpserver.somewhere +
+
+ -
sntp -a ntpserver.somewhere -
- + + diff --git a/sntp/tests/Makefile.am b/sntp/tests/Makefile.am index 0e14a87b1..f7e48154d 100644 --- a/sntp/tests/Makefile.am +++ b/sntp/tests/Makefile.am @@ -97,6 +97,7 @@ LDADD = \ $(NULL) AM_CFLAGS = $(CFLAGS_NTP) +AM_CFLAGS += $(NTP_HARD_CFLAGS) AM_CPPFLAGS = $(SNTP_INCS) AM_CPPFLAGS += -I$(srcdir)/.. @@ -107,8 +108,10 @@ AM_CPPFLAGS += $(CPPFLAGS_NTP) AM_CPPFLAGS += -DUNITY_INCLUDE_CONFIG_H #AM_CPPFLAGS += -I$(top_srcdir)/sntp/unity AM_CPPFLAGS += -I$(top_srcdir)/unity +AM_CPPFLAGS += $(NTP_HARD_CPPFLAGS) -AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS += $(NTP_HARD_LDFLAGS) BUILT_SOURCES += \ $(srcdir)/run-crypto.c \ diff --git a/sntp/unity/Makefile.am b/sntp/unity/Makefile.am index 71092a0d8..24a44257a 100644 --- a/sntp/unity/Makefile.am +++ b/sntp/unity/Makefile.am @@ -3,10 +3,15 @@ NULL = BUILT_SOURCES = CLEANFILES = +AM_CFLAGS = $(NTP_HARD_CFLAGS) +AM_CPPFLAGS = $(NTP_HARD_CPPFLAGS) +AM_LDFLAGS = $(NTP_HARD_LDFLAGS) + noinst_LIBRARIES = libunity.a libunity_a_CFLAGS = \ -DUNITY_INCLUDE_CONFIG_H \ + $(AM_CFLAGS) \ $(NULL) libunity_a_SOURCES = \ diff --git a/tests/bug-2803/Makefile.am b/tests/bug-2803/Makefile.am index 1e0cd9cf3..d679ac47b 100644 --- a/tests/bug-2803/Makefile.am +++ b/tests/bug-2803/Makefile.am @@ -21,6 +21,7 @@ LDADD = \ $(NULL) AM_CFLAGS = $(CFLAGS_NTP) +AM_CFLAGS += $(NTP_HARD_CFLAGS) # HMS: we may not need some of these: AM_CPPFLAGS = $(NTP_INCS) @@ -29,8 +30,10 @@ AM_CPPFLAGS += -I$(top_srcdir)/include AM_CPPFLAGS += $(CPPFLAGS_NTP) AM_CPPFLAGS += -DUNITY_INCLUDE_CONFIG_H AM_CPPFLAGS += -I$(top_srcdir)/sntp/unity +AM_CPPFLAGS += $(NTP_HARD_CPPFLAGS) -AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS += $(NTP_HARD_LDFLAGS) bug_2803_SOURCES = \ bug-2803.c \ diff --git a/tests/libntp/Makefile.am b/tests/libntp/Makefile.am index f8360a9e2..0d76af026 100644 --- a/tests/libntp/Makefile.am +++ b/tests/libntp/Makefile.am @@ -59,15 +59,18 @@ LDADD = \ $(top_builddir)/sntp/unity/libunity.a \ $(NULL) -AM_CFLAGS = $(CFLAGS_NTP) +AM_CFLAGS = $(CFLAGS_NTP) +AM_CFLAGS += $(NTP_HARD_CFLAGS) AM_CPPFLAGS = $(NTP_INCS) AM_CPPFLAGS += -I$(top_srcdir)/sntp AM_CPPFLAGS += $(CPPFLAGS_NTP) AM_CPPFLAGS += -DUNITY_INCLUDE_CONFIG_H AM_CPPFLAGS += -I$(top_srcdir)/sntp/unity +AM_CPPFLAGS += $(NTP_HARD_CPPFLAGS) -AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS += $(NTP_HARD_LDFLAGS) BUILT_SOURCES += \ $(srcdir)/run-a_md5encrypt.c \ diff --git a/tests/ntpd/Makefile.am b/tests/ntpd/Makefile.am index 3ce512d89..02ac1a166 100644 --- a/tests/ntpd/Makefile.am +++ b/tests/ntpd/Makefile.am @@ -47,6 +47,7 @@ unity_tests_LDADD = \ $(NULL) AM_CFLAGS = $(CFLAGS_NTP) +AM_CFLAGS += $(NTP_HARD_CFLAGS) AM_CPPFLAGS = $(NTP_INCS) AM_CPPFLAGS += -I$(top_srcdir)/sntp @@ -55,8 +56,10 @@ AM_CPPFLAGS += -I$(top_srcdir)/tests/libntp AM_CPPFLAGS += $(CPPFLAGS_NTP) AM_CPPFLAGS += -DUNITY_INCLUDE_CONFIG_H AM_CPPFLAGS += -I$(top_srcdir)/sntp/unity +AM_CPPFLAGS += $(NTP_HARD_CPPFLAGS) -AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS += $(NTP_HARD_LDFLAGS) BUILT_SOURCES += \ $(srcdir)/run-leapsec.c \ diff --git a/tests/ntpq/Makefile.am b/tests/ntpq/Makefile.am index 136b8f348..9cd2de94e 100644 --- a/tests/ntpq/Makefile.am +++ b/tests/ntpq/Makefile.am @@ -28,6 +28,7 @@ unity_tests_LDADD = \ $(NULL) AM_CFLAGS = $(CFLAGS_NTP) +AM_CFLAGS += $(NTP_HARD_CFLAGS) AM_CPPFLAGS = $(NTP_INCS) AM_CPPFLAGS += -I$(top_srcdir)/ntpq @@ -35,8 +36,10 @@ AM_CPPFLAGS += $(CPPFLAGS_NTP) AM_CPPFLAGS += -DUNITY_INCLUDE_CONFIG_H AM_CPPFLAGS += -I$(top_srcdir)/sntp/unity AM_CPPFLAGS += $(LIBOPTS_CFLAGS) +AM_CPPFLAGS += $(NTP_HARD_CPPFLAGS) -AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS += $(NTP_HARD_LDFLAGS) BUILT_SOURCES += \ $(srcdir)/run-t-ntpq.c \ diff --git a/tests/sandbox/Makefile.am b/tests/sandbox/Makefile.am index c146b149a..38df52ba1 100644 --- a/tests/sandbox/Makefile.am +++ b/tests/sandbox/Makefile.am @@ -30,6 +30,7 @@ LDADD = \ $(NULL) AM_CFLAGS = $(CFLAGS_NTP) +AM_CFLAGS += $(NTP_HARD_CFLAGS) # HMS: we may not need some of these: AM_CPPFLAGS = $(NTP_INCS) @@ -38,8 +39,10 @@ AM_CPPFLAGS += -I$(top_srcdir)/include AM_CPPFLAGS += $(CPPFLAGS_NTP) AM_CPPFLAGS += -DUNITY_INCLUDE_CONFIG_H AM_CPPFLAGS += -I$(top_srcdir)/sntp/unity +AM_CPPFLAGS += $(NTP_HARD_CPPFLAGS) -AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS += $(NTP_HARD_LDFLAGS) bug_2803_SOURCES = \ bug-2803.c \ diff --git a/tests/sec-2853/Makefile.am b/tests/sec-2853/Makefile.am index 59734da1c..3f44201a1 100644 --- a/tests/sec-2853/Makefile.am +++ b/tests/sec-2853/Makefile.am @@ -21,6 +21,7 @@ LDADD = \ $(NULL) AM_CFLAGS = $(CFLAGS_NTP) +AM_CFLAGS += $(NTP_HARD_CFLAGS) # HMS: we may not need some of these: AM_CPPFLAGS = $(NTP_INCS) @@ -29,8 +30,10 @@ AM_CPPFLAGS += -I$(top_srcdir)/include AM_CPPFLAGS += $(CPPFLAGS_NTP) AM_CPPFLAGS += -DUNITY_INCLUDE_CONFIG_H AM_CPPFLAGS += -I$(top_srcdir)/sntp/unity +AM_CPPFLAGS += $(NTP_HARD_CPPFLAGS) -AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS += $(NTP_HARD_LDFLAGS) sec_2853_SOURCES = \ run-sec-2853.c \ diff --git a/util/Makefile.am b/util/Makefile.am index 8a47a3c55..8d8067d39 100644 --- a/util/Makefile.am +++ b/util/Makefile.am @@ -7,13 +7,16 @@ sbin_PROGRAMS= $(NTP_KEYGEN_DS) $(NTPTIME_DS) $(TICKADJ_DS) $(TIMETRIM_DS) EXTRA_PROGRAMS= audio-pcm byteorder hist jitter kern longsize ntp-keygen \ ntptime pps-api precision sht testrs6000 tg tg2 tickadj timetrim -AM_CFLAGS = $(CFLAGS_NTP) +AM_CFLAGS = $(CFLAGS_NTP) +AM_CFLAGS += $(NTP_HARD_CFLAGS) AM_CPPFLAGS = $(NTP_INCS) AM_CPPFLAGS += $(LIBOPTS_CFLAGS) AM_CPPFLAGS += $(CPPFLAGS_NTP) +AM_CPPFLAGS += $(NTP_HARD_CPPFLAGS) -AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS = $(LDFLAGS_NTP) +AM_LDFLAGS += $(NTP_HARD_LDFLAGS) # LDADD might need RESLIB and ADJLIB LDADD= ../libntp/libntp.a $(LDADD_LIBNTP) $(LIBM) $(PTHREAD_LIBS) diff --git a/util/ntp-keygen.html b/util/ntp-keygen.html index 57dc7e2ce..7dd9467e6 100644 --- a/util/ntp-keygen.html +++ b/util/ntp-keygen.html @@ -1,87 +1,111 @@ - + + + -Ntp-keygen User's Manual - - - - - - - +Ntp-keygen User’s Manual + + + + + + + + + + + + - -
Ntp-keygen User's Manual
-
-
Short Contents
-
-Top -NTP Key Generation Program User Manual -
-
+ +
Ntp-keygen User’s Manual
-
-
-Up: (dir) -
-
-
Top
-
-
Description -
ntp-keygen Invocation: Invoking ntp-keygen -
Running the Program -
Random Seed File -
Cryptographic Data Files -
-
-
-Next: Description, -Previous: (dir), -Up: (dir) -
+ +
Short Table of Contents
+ +
+
+
1 Description
+

-
NTP Key Generation Program User Manual
-
This document describes the use of the NTP Project's ntp-keygen + + + + + + +
• Description:    +
• ntp-keygen Invocation:    Invoking ntp-keygen +
• Running the Program:    +
• Random Seed File:    +
• Cryptographic Data Files:    +
+ + +
+
+Next: Description, Previous: (dir), Up: (dir)
+
+ +
NTP Key Generation Program User Manual
+ +
This document describes the use of the NTP Project’s ntp-keygen program, that generates cryptographic data files used by the NTPv4 -authentication and identity schemes. +authentication and identity schemes. It can generate message digest keys used in symmetric key cryptography and, if the OpenSSL software library has been installed, it can generate host keys, sign keys, certificates, and identity keys and parameters used by the Autokey -public key cryptography. +public key cryptography. The message digest keys file is generated in a -format compatible with NTPv3. +format compatible with NTPv3. All other files are in PEM-encoded printable ASCII format so they can be embedded as MIME attachments in mail to other sites. - -
This document applies to version 4.2.8p9-win of ntp-keygen. - -
-
-Next: Running the Program, -Previous: Top, -Up: Top -
+
+
This document applies to version 4.2.8p9-win of ntp-keygen. +
+
+ +
+
+Next: Running the Program, Previous: Top, Up: Top

- - -
Description
+ +
1 Description

This program generates cryptographic data files used by the NTPv4 authentication and identity schemes. It can generate message digest @@ -92,292 +116,295 @@ public key cryptography. The message digest keys file is generated in a format compatible with NTPv3. All other files are in PEM-encoded printable ASCII format so they can be embedded as MIME attachments in mail to other sites. - -
When used to generate message digest keys, the program produces a file +
+
When used to generate message digest keys, the program produces a file containing ten pseudo-random printable ASCII strings suitable for the -MD5 message digest algorithm included in the distribution. +MD5 message digest algorithm included in the distribution. If the OpenSSL library is installed, it produces an additional ten hex-encoded random bit strings suitable for the SHA1 and other message digest -algorithms. +algorithms. The message digest keys file must be distributed and stored -using secure means beyond the scope of NTP itself. +using secure means beyond the scope of NTP itself. Besides the keys used for ordinary NTP associations, additional keys can be defined as passwords for the ntpq and ntpdc utility programs. - -
The remaining generated files are compatible with other OpenSSL -applications and other Public Key Infrastructure (PKI) resources. +
+
The remaining generated files are compatible with other OpenSSL +applications and other Public Key Infrastructure (PKI) resources. Certificates generated by this program are compatible with extant industry practice, although some users might find the interpretation of -X509v3 extension fields somewhat liberal. +X509v3 extension fields somewhat liberal. However, the identity keys are probably not compatible with anything other than Autokey. - -
Some files used by this program are encrypted using a private password. +
+
Some files used by this program are encrypted using a private password. The -p option specifies the password for local encrypted files and the --q option the password for encrypted files sent to remote sites. +-q option the password for encrypted files sent to remote sites. If no password is specified, the host name returned by the Unix gethostname() function, normally the DNS name of the host, is used. - -
The pw option of the crypto configuration command -specifies the read password for previously encrypted local files. -This must match the local password used by this program. -If not specified, the host name is used. +
+
The pw option of the crypto configuration command +specifies the read password for previously encrypted local files. +This must match the local password used by this program. +If not specified, the host name is used. Thus, if files are generated by this program without password, they can be read back by ntpd without password, but only on the same host. - -
Normally, encrypted files for each host are generated by that host and +
+
Normally, encrypted files for each host are generated by that host and used only by that host, although exceptions exist as noted later on -this page. +this page. The symmetric keys file, normally called ntp.keys, is -usually installed in /etc. +usually installed in /etc. Other files and links are usually installed in /usr/local/etc, which is normally in a shared filesystem in -NFS-mounted networks and cannot be changed by shared clients. +NFS-mounted networks and cannot be changed by shared clients. The location of the keys directory can be changed by the keysdir -configuration command in such cases. +configuration command in such cases. Normally, this is in /etc. - -
This program directs commentary and error messages to the standard +
+
This program directs commentary and error messages to the standard error stream stderr and remote files to the standard output stream stdout where they can be piped to other applications or redirected to -files. +files. The names used for generated files and links all begin with the string ntpkey and include the file type, generating host and filestamp, as described in the Cryptographic Data Files section below. - -
-
-Next: Random Seed File, -Previous: Description, -Up: Top -
+
+
+ +
+
+Next: Random Seed File, Previous: Description, Up: Top

- - -
Running the Program
+ +
1.1 Running the Program

To test and gain experience with Autokey concepts, log in as root and -change to the keys directory, usually /usr/local/etc. +change to the keys directory, usually /usr/local/etc. When run for the first time, or if all files with names beginning ntpkey] have been removed, use the ntp-keygen command without arguments to generate a default RSA host key and matching RSA-MD5 certificate with expiration -date one year hence. +date one year hence. If run again without options, the program uses the existing keys and parameters and generates only a new certificate with new expiration date one year hence. - -
Run the command on as many hosts as necessary. +
+
Run the command on as many hosts as necessary. Designate one of them as the trusted host (TH) using ntp-keygen with the -T option and configure -it to synchronize from reliable Internet servers. -Then configure the other hosts to synchronize to the TH directly or indirectly. +it to synchronize from reliable Internet servers. +Then configure the other hosts to synchronize to the TH directly or indirectly. A certificate trail is created when Autokey asks the immediately ascendant host towards the TH to sign its certificate, which is then -provided to the immediately descendant host on request. +provided to the immediately descendant host on request. All group hosts should have acyclic certificate trails ending on the TH. - -
The host key is used to encrypt the cookie when required and so must be -RSA type. -By default, the host key is also the sign key used to encrypt signatures. +
+
The host key is used to encrypt the cookie when required and so must be +RSA type. +By default, the host key is also the sign key used to encrypt signatures. A different sign key can be assigned using the -S option -and this can be either RSA or DSA type. +and this can be either RSA or DSA type. By default, the signature message digest type is MD5, but any combination of sign key type and message digest type supported by the OpenSSL library can be specified using the -c option. - -
The rules say cryptographic media should be generated with proventic +
+
The rules say cryptographic media should be generated with proventic filestamps, which means the host should already be synchronized before -this program is run. +this program is run. This of course creates a chicken-and-egg problem -when the host is started for the first time. +when the host is started for the first time. Accordingly, the host time should be set by some other means, such as eyeball-and-wristwatch, at -least so that the certificate lifetime is within the current year. +least so that the certificate lifetime is within the current year. After that and when the host is synchronized to a proventic source, the certificate should be re-generated. - -
Additional information on trusted groups and identity schemes is on the +
+
Additional information on trusted groups and identity schemes is on the Autokey Public-Key Authentication page. - -
-
+
+
-
+
+
+Next: Random Seed File, Previous: Running the Program, Up: Description

+ +
1.2 Invoking ntp-keygen
+ + -
Invoking ntp-keygen
-
-
This program generates cryptographic data files used by the NTPv4 -authentication and identification schemes. -It generates MD5 key files used in symmetric key cryptography. +
This program generates cryptographic data files used by the NTPv4 +authentication and identification schemes. +It generates MD5 key files used in symmetric key cryptography. In addition, if the OpenSSL software library has been installed, it generates keys, certificate and identity files used in public key -cryptography. +cryptography. These files are used for cookie encryption, digital signature and challenge/response identification algorithms compatible with the Internet standard security infrastructure. - -
All files are in PEM-encoded printable ASCII format, +
+
All files are in PEM-encoded printable ASCII format, so they can be embedded as MIME attachments in mail to other sites -and certificate authorities. +and certificate authorities. By default, files are not encrypted. - -
When used to generate message digest keys, the program produces a file +
+
When used to generate message digest keys, the program produces a file containing ten pseudo-random printable ASCII strings suitable for the -MD5 message digest algorithm included in the distribution. +MD5 message digest algorithm included in the distribution. If the OpenSSL library is installed, it produces an additional ten hex-encoded random bit strings suitable for the SHA1 and other message -digest algorithms. +digest algorithms. The message digest keys file must be distributed and stored -using secure means beyond the scope of NTP itself. +using secure means beyond the scope of NTP itself. Besides the keys used for ordinary NTP associations, additional keys can be defined as passwords for the ntpq(1ntpqmdoc) and ntpdc(1ntpdcmdoc) utility programs. - -
The remaining generated files are compatible with other OpenSSL -applications and other Public Key Infrastructure (PKI) resources. +
+
The remaining generated files are compatible with other OpenSSL +applications and other Public Key Infrastructure (PKI) resources. Certificates generated by this program are compatible with extant industry practice, although some users might find the interpretation of -X509v3 extension fields somewhat liberal. +X509v3 extension fields somewhat liberal. However, the identity keys are probably not compatible with anything other than Autokey. - -
Some files used by this program are encrypted using a private password. +
+
Some files used by this program are encrypted using a private password. The -p option specifies the password for local encrypted files and the -q -option the password for encrypted files sent to remote sites. +option the password for encrypted files sent to remote sites. If no password is specified, the host name returned by the Unix gethostname() function, normally the DNS name of the host is used. - -
The +
+
The pw option of the crypto configuration command specifies the read -password for previously encrypted local files. -This must match the local password used by this program. -If not specified, the host name is used. +password for previously encrypted local files. +This must match the local password used by this program. +If not specified, the host name is used. Thus, if files are generated by this program without password, they can be read back by ntpd without password but only on the same host. - -
Normally, encrypted files for each host are generated by that host and +
+
Normally, encrypted files for each host are generated by that host and used only by that host, although exceptions exist as noted later on -this page. +this page. The symmetric keys file, normally called ntp.keys, is usually installed in -/etc. +/etc. Other files and links are usually installed in -/usr/local/etc, +/usr/local/etc, which is normally in a shared filesystem in -NFS-mounted networks and cannot be changed by shared clients. +NFS-mounted networks and cannot be changed by shared clients. The location of the keys directory can be changed by the keysdir -configuration command in such cases. +configuration command in such cases. Normally, this is in -/etc. - -
This program directs commentary and error messages to the standard +/etc. +
+
This program directs commentary and error messages to the standard error stream stderr and remote files to the standard output stream stdout -where they can be piped to other applications or redirected to files. +where they can be piped to other applications or redirected to files. The names used for generated files and links all begin with the string ntpkey and include the file type, generating host and filestamp, as described in the -Cryptographic Data Files +“Cryptographic Data Files” section below. - -
Running the Program
- +
+
1.2.1 Running the Program

To test and gain experience with Autokey concepts, log in as root and change to the keys directory, usually -/usr/local/etc +/usr/local/etc When run for the first time, or if all files with names beginning with ntpkey have been removed, use the ntp-keygen command without arguments to generate a default RSA host key and matching RSA-MD5 certificate with expiration -date one year hence. +date one year hence. If run again without options, the program uses the existing keys and parameters and generates only a new certificate with new expiration date one year hence. - -
Run the command on as many hosts as necessary. +
+
Run the command on as many hosts as necessary. Designate one of them as the trusted host (TH) using ntp-keygen with the -T -option and configure it to synchronize from reliable Internet servers. +option and configure it to synchronize from reliable Internet servers. Then configure the other hosts to synchronize to the TH directly or -indirectly. +indirectly. A certificate trail is created when Autokey asks the immediately ascendant host towards the TH to sign its certificate, which is then -provided to the immediately descendant host on request. +provided to the immediately descendant host on request. All group hosts should have acyclic certificate trails ending on the TH. - -
The host key is used to encrypt the cookie when required and so must be -RSA type. +
+
The host key is used to encrypt the cookie when required and so must be +RSA type. By default, the host key is also the sign key used to encrypt -signatures. +signatures. A different sign key can be assigned using the -S -option and this can be either RSA or DSA type. +option and this can be either RSA or DSA type. By default, the signature message digest type is MD5, but any combination of sign key type and message digest type supported by the OpenSSL library can be specified using the -c -option. +option. The rules say cryptographic media should be generated with proventic filestamps, which means the host should already be synchronized before -this program is run. +this program is run. This of course creates a chicken-and-egg problem -when the host is started for the first time. +when the host is started for the first time. Accordingly, the host time should be set by some other means, such as eyeball-and-wristwatch, at -least so that the certificate lifetime is within the current year. +least so that the certificate lifetime is within the current year. After that and when the host is synchronized to a proventic source, the certificate should be re-generated. - -
Additional information on trusted groups and identity schemes is on the -Autokey Public-Key Authentication +
+
Additional information on trusted groups and identity schemes is on the +“Autokey Public-Key Authentication” page. +
+ -
The +
The ntpd(1ntpdmdoc) configuration command crypto pw password -specifies the read password for previously encrypted files. +specifies the read password for previously encrypted files. The daemon expires on the spot if the password is missing -or incorrect. +or incorrect. For convenience, if a file has been previously encrypted, the default read password is the name of the host running -the program. +the program. If the previous write password is specified as the host name, these files can be read by that host with no explicit password. +
-
File names begin with the prefix +
File names begin with the prefix ntpkey_ and end with the postfix _hostname.filestamp, @@ -386,7 +413,7 @@ where is the owner name, usually the string returned by the Unix gethostname() routine, and filestamp -is the NTP seconds when the file was generated, in decimal digits. +is the NTP seconds when the file was generated, in decimal digits. This both guarantees uniqueness and simplifies maintenance procedures, since all files can be quickly removed by a @@ -395,100 +422,99 @@ command or all files generated at a specific time can be removed by a rm *filestamp -command. +command. To further reduce the risk of misconfiguration, the first two lines of a file contain the file name and generation date and time as comments. - -
All files are installed by default in the keys directory -/usr/local/etc, +
+
All files are installed by default in the keys directory +/usr/local/etc, which is normally in a shared filesystem -in NFS-mounted networks. +in NFS-mounted networks. The actual location of the keys directory and each file can be overridden by configuration commands, -but this is not recommended. +but this is not recommended. Normally, the files for each host are generated by that host and used only by that host, although exceptions exist as noted later on this page. - -
Normally, files containing private values, +
+
Normally, files containing private values, including the host key, sign key and identification parameters, are permitted root read/write-only; -while others containing public values are permitted world readable. +while others containing public values are permitted world readable. Alternatively, files containing private values can be encrypted and these files permitted world readable, -which simplifies maintenance in shared file systems. +which simplifies maintenance in shared file systems. Since uniqueness is insured by the hostname and file name extensions, the files for a NFS server and dependent clients can all be installed in the same shared directory. - -
The recommended practice is to keep the file name extensions +
+
The recommended practice is to keep the file name extensions when installing a file and to install a soft link from the generic names specified elsewhere on this page -to the generated files. +to the generated files. This allows new file generations to be activated simply -by changing the link. +by changing the link. If a link is present, ntpd follows it to the file name -to extract the filestamp. +to extract the filestamp. If a link is not present, ntpd(1ntpdmdoc) -extracts the filestamp from the file itself. +extracts the filestamp from the file itself. This allows clients to verify that the file and generation times -are always current. +are always current. The ntp-keygen program uses the same timestamp extension for all files generated at one time, so each generation is distinct and can be readily recognized in monitoring data. - -
Running the program
- +
+
1.2.1.1 Running the program

The safest way to run the ntp-keygen -program is logged in directly as root. +program is logged in directly as root. The recommended procedure is change to the keys directory, usually -/usr/local/etc, -then run the program. +/usr/local/etc, +then run the program. When run for the first time, or if all ntpkey files have been removed, the program generates a RSA host key file and matching RSA-MD5 certificate file, -which is all that is necessary in many cases. +which is all that is necessary in many cases. The program also generates soft links from the generic names -to the respective files. +to the respective files. If run again, the program uses the same host key file, but generates a new certificate file and link. - -
The host key is used to encrypt the cookie when required and so must be RSA type. -By default, the host key is also the sign key used to encrypt signatures. +
+
The host key is used to encrypt the cookie when required and so must be RSA type. +By default, the host key is also the sign key used to encrypt signatures. When necessary, a different sign key can be specified and this can be -either RSA or DSA type. +either RSA or DSA type. By default, the message digest type is MD5, but any combination of sign key type and message digest type supported by the OpenSSL library can be specified, including those using the MD2, MD5, SHA, SHA1, MDC2 -and RIPE160 message digest algorithms. +and RIPE160 message digest algorithms. However, the scheme specified in the certificate must be compatible -with the sign key. +with the sign key. Certificates using any digest algorithm are compatible with RSA sign keys; however, only SHA and SHA1 certificates are compatible with DSA sign keys. - -
Private/public key files and certificates are compatible with -other OpenSSL applications and very likely other libraries as well. +
+
Private/public key files and certificates are compatible with +other OpenSSL applications and very likely other libraries as well. Certificates or certificate requests derived from them should be compatible with extant industry practice, although some users might find -the interpretation of X509v3 extension fields somewhat liberal. +the interpretation of X509v3 extension fields somewhat liberal. However, the identification parameter files, although encoded as the other files, are probably not compatible with anything other than Autokey. - -
Running the program as other than root and using the Unix +
+
Running the program as other than root and using the Unix su command to assume root may not work properly, since by default the OpenSSL library looks for the random seed file .rnd -in the user home directory. +in the user home directory. However, there should be only one .rnd, most conveniently @@ -496,119 +522,119 @@ in the root directory, so it is convenient to define the $RANDFILE environment variable used by the OpenSSL library as the path to /.rnd. - -
Installing the keys as root might not work in NFS-mounted +
+
Installing the keys as root might not work in NFS-mounted shared file systems, as NFS clients may not be able to write -to the shared keys directory, even as root. +to the shared keys directory, even as root. In this case, NFS clients can specify the files in another directory such as -/etc +/etc using the keysdir -command. +command. There is no need for one client to read the keys and certificates of other clients or servers, as these data are obtained automatically by the Autokey protocol. - -
Ordinarily, cryptographic files are generated by the host that uses them, +
+
Ordinarily, cryptographic files are generated by the host that uses them, but it is possible for a trusted agent (TA) to generate these files -for other hosts; however, in such cases files should always be encrypted. +for other hosts; however, in such cases files should always be encrypted. The subject name and trusted name default to the hostname -of the host generating the files, but can be changed by command line options. +of the host generating the files, but can be changed by command line options. It is convenient to designate the owner name and trusted name -as the subject and issuer fields, respectively, of the certificate. +as the subject and issuer fields, respectively, of the certificate. The owner name is also used for the host and sign key files, while the trusted name is used for the identity files. +
-
All files are installed by default in the keys directory -/usr/local/etc, +
All files are installed by default in the keys directory +/usr/local/etc, which is normally in a shared filesystem -in NFS-mounted networks. +in NFS-mounted networks. The actual location of the keys directory and each file can be overridden by configuration commands, -but this is not recommended. +but this is not recommended. Normally, the files for each host are generated by that host and used only by that host, although exceptions exist as noted later on this page. - -
Normally, files containing private values, +
+
Normally, files containing private values, including the host key, sign key and identification parameters, are permitted root read/write-only; -while others containing public values are permitted world readable. +while others containing public values are permitted world readable. Alternatively, files containing private values can be encrypted and these files permitted world readable, -which simplifies maintenance in shared file systems. +which simplifies maintenance in shared file systems. Since uniqueness is insured by the hostname and file name extensions, the files for a NFS server and dependent clients can all be installed in the same shared directory. - -
The recommended practice is to keep the file name extensions +
+
The recommended practice is to keep the file name extensions when installing a file and to install a soft link from the generic names specified elsewhere on this page -to the generated files. +to the generated files. This allows new file generations to be activated simply -by changing the link. +by changing the link. If a link is present, ntpd follows it to the file name -to extract the filestamp. +to extract the filestamp. If a link is not present, ntpd(1ntpdmdoc) -extracts the filestamp from the file itself. +extracts the filestamp from the file itself. This allows clients to verify that the file and generation times -are always current. +are always current. The ntp-keygen program uses the same timestamp extension for all files generated at one time, so each generation is distinct and can be readily recognized in monitoring data. - -
Running the program
- +
+
1.2.1.2 Running the program

The safest way to run the ntp-keygen -program is logged in directly as root. +program is logged in directly as root. The recommended procedure is change to the keys directory, usually -/usr/local/etc, -then run the program. +/usr/local/etc, +then run the program. When run for the first time, or if all ntpkey files have been removed, the program generates a RSA host key file and matching RSA-MD5 certificate file, -which is all that is necessary in many cases. +which is all that is necessary in many cases. The program also generates soft links from the generic names -to the respective files. +to the respective files. If run again, the program uses the same host key file, but generates a new certificate file and link. - -
The host key is used to encrypt the cookie when required and so must be RSA type. -By default, the host key is also the sign key used to encrypt signatures. +
+
The host key is used to encrypt the cookie when required and so must be RSA type. +By default, the host key is also the sign key used to encrypt signatures. When necessary, a different sign key can be specified and this can be -either RSA or DSA type. +either RSA or DSA type. By default, the message digest type is MD5, but any combination of sign key type and message digest type supported by the OpenSSL library can be specified, including those using the MD2, MD5, SHA, SHA1, MDC2 -and RIPE160 message digest algorithms. +and RIPE160 message digest algorithms. However, the scheme specified in the certificate must be compatible -with the sign key. +with the sign key. Certificates using any digest algorithm are compatible with RSA sign keys; however, only SHA and SHA1 certificates are compatible with DSA sign keys. - -
Private/public key files and certificates are compatible with -other OpenSSL applications and very likely other libraries as well. +
+
Private/public key files and certificates are compatible with +other OpenSSL applications and very likely other libraries as well. Certificates or certificate requests derived from them should be compatible with extant industry practice, although some users might find -the interpretation of X509v3 extension fields somewhat liberal. +the interpretation of X509v3 extension fields somewhat liberal. However, the identification parameter files, although encoded as the other files, are probably not compatible with anything other than Autokey. - -
Running the program as other than root and using the Unix +
+
Running the program as other than root and using the Unix su command to assume root may not work properly, since by default the OpenSSL library looks for the random seed file .rnd -in the user home directory. +in the user home directory. However, there should be only one .rnd, most conveniently @@ -616,73 +642,73 @@ in the root directory, so it is convenient to define the $RANDFILE environment variable used by the OpenSSL library as the path to /.rnd. - -
Installing the keys as root might not work in NFS-mounted +
+
Installing the keys as root might not work in NFS-mounted shared file systems, as NFS clients may not be able to write -to the shared keys directory, even as root. +to the shared keys directory, even as root. In this case, NFS clients can specify the files in another directory such as -/etc +/etc using the keysdir -command. +command. There is no need for one client to read the keys and certificates of other clients or servers, as these data are obtained automatically by the Autokey protocol. - -
Ordinarily, cryptographic files are generated by the host that uses them, +
+
Ordinarily, cryptographic files are generated by the host that uses them, but it is possible for a trusted agent (TA) to generate these files -for other hosts; however, in such cases files should always be encrypted. +for other hosts; however, in such cases files should always be encrypted. The subject name and trusted name default to the hostname -of the host generating the files, but can be changed by command line options. +of the host generating the files, but can be changed by command line options. It is convenient to designate the owner name and trusted name -as the subject and issuer fields, respectively, of the certificate. +as the subject and issuer fields, respectively, of the certificate. The owner name is also used for the host and sign key files, -while the trusted name is used for the identity files. -seconds. +while the trusted name is used for the identity files. seconds. - -
s Trusted Hosts and Groups +seconds. +
+
s Trusted Hosts and Groups Each cryptographic configuration involves selection of a signature scheme and identification scheme, called a cryptotype, as explained in the -Authentication Options +‘Authentication Options’ section of -ntp.conf(5). +ntp.conf(5). The default cryptotype uses RSA encryption, MD5 message digest -and TC identification. +and TC identification. First, configure a NTP subnet including one or more low-stratum trusted hosts from which all other hosts derive synchronization -directly or indirectly. +directly or indirectly. Trusted hosts have trusted certificates; -all other hosts have nontrusted certificates. +all other hosts have nontrusted certificates. These hosts will automatically and dynamically build authoritative -certificate trails to one or more trusted hosts. +certificate trails to one or more trusted hosts. A trusted group is the set of all hosts that have, directly or indirectly, -a certificate trail ending at a trusted host. +a certificate trail ending at a trusted host. The trail is defined by static configuration file entries or dynamic means described on the -Automatic NTP Configuration Options +‘Automatic NTP Configuration Options’ section of ntp.conf(5). - -
On each trusted host as root, change to the keys directory. +
+
On each trusted host as root, change to the keys directory. To insure a fresh fileset, remove all ntpkey -files. +files. Then run ntp-keygen -T -to generate keys and a trusted certificate. +to generate keys and a trusted certificate. On all other hosts do the same, but leave off the -T -flag to generate keys and nontrusted certificates. +flag to generate keys and nontrusted certificates. When complete, start the NTP daemons beginning at the lowest stratum -and working up the tree. +and working up the tree. It may take some time for Autokey to instantiate the certificate trails throughout the subnet, but setting up the environment is completely automatic. - -
If it is necessary to use a different sign key or different digest/signature +
+
If it is necessary to use a different sign key or different digest/signature scheme than the default, run ntp-keygen with the @@ -692,8 +718,8 @@ option, where is either RSA or -DSA. -The most often need to do this is when a DSA-signed certificate is used. +DSA. +The most often need to do this is when a DSA-signed certificate is used. If it is necessary to use a different certificate scheme than the default, run ntp-keygen @@ -701,138 +727,137 @@ with the -c scheme option and selected scheme -as needed. +as needed. f ntp-keygen is run again without these options, it generates a new certificate using the same scheme and sign key. - -
After setting up the environment it is advisable to update certificates -from time to time, if only to extend the validity interval. +
+
After setting up the environment it is advisable to update certificates +from time to time, if only to extend the validity interval. Simply run ntp-keygen with the same flags as before to generate new certificates -using existing keys. +using existing keys. However, if the host or sign key is changed, ntpd(1ntpdmdoc) -should be restarted. +should be restarted. When ntpd(1ntpdmdoc) -is restarted, it loads any new files and restarts the protocol. +is restarted, it loads any new files and restarts the protocol. Other dependent hosts will continue as usual until signatures are refreshed, at which time the protocol is restarted. - -
Identity Schemes
- +
+
1.2.1.3 Identity Schemes

As mentioned on the Autonomous Authentication page, -the default TC identity scheme is vulnerable to a middleman attack. +the default TC identity scheme is vulnerable to a middleman attack. However, there are more secure identity schemes available, including PC, IFF, GQ and MV described on the -"Identification Schemes" +"Identification Schemes" page (maybe available at -http://www.eecis.udel.edu/%7emills/keygen.html). +http://www.eecis.udel.edu/%7emills/keygen.html). These schemes are based on a TA, one or more trusted hosts -and some number of nontrusted hosts. +and some number of nontrusted hosts. Trusted hosts prove identity using values provided by the TA, while the remaining hosts prove identity using values provided -by a trusted host and certificate trails that end on that host. +by a trusted host and certificate trails that end on that host. The name of a trusted host is also the name of its sugroup -and also the subject and issuer name on its trusted certificate. +and also the subject and issuer name on its trusted certificate. The TA is not necessarily a trusted host in this sense, but often is. - -
In some schemes there are separate keys for servers and clients. +
+
In some schemes there are separate keys for servers and clients. A server can also be a client of another server, -but a client can never be a server for another client. +but a client can never be a server for another client. In general, trusted hosts and nontrusted hosts that operate as both server and client have parameter files that contain -both server and client keys. +both server and client keys. Hosts that operate only as clients have key files that contain only client keys. - -
The PC scheme supports only one trusted host in the group. +
+
The PC scheme supports only one trusted host in the group. On trusted host alice run ntp-keygen -P -p password to generate the host key file -ntpkey_RSAkey_alice.filestamp +ntpkey_RSAkey_alice.filestamp and trusted private certificate file -ntpkey_RSA-MD5_cert_alice.filestamp. +ntpkey_RSA-MD5_cert_alice.filestamp. Copy both files to all group hosts; -they replace the files which would be generated in other schemes. +they replace the files which would be generated in other schemes. On each host bob install a soft link from the generic name -ntpkey_host_bob +ntpkey_host_bob to the host key file and soft link -ntpkey_cert_bob -to the private certificate file. +ntpkey_cert_bob +to the private certificate file. Note the generic links are on bob, but point to files generated -by trusted host alice. +by trusted host alice. In this scheme it is not possible to refresh either the keys or certificates without copying them to all other hosts in the group. - -
For the IFF scheme proceed as in the TC scheme to generate keys +
+
For the IFF scheme proceed as in the TC scheme to generate keys and certificates for all group hosts, then for every trusted host in the group, -generate the IFF parameter file. +generate the IFF parameter file. On trusted host alice run ntp-keygen -T -I -p password to produce her parameter file -ntpkey_IFFpar_alice.filestamp, -which includes both server and client keys. +ntpkey_IFFpar_alice.filestamp, +which includes both server and client keys. Copy this file to all group hosts that operate as both servers and clients and install a soft link from the generic -ntpkey_iff_alice -to this file. +ntpkey_iff_alice +to this file. If there are no hosts restricted to operate only as clients, -there is nothing further to do. +there is nothing further to do. As the IFF scheme is independent of keys and certificates, these files can be refreshed as needed. - -
If a rogue client has the parameter file, it could masquerade -as a legitimate server and present a middleman threat. +
+
If a rogue client has the parameter file, it could masquerade +as a legitimate server and present a middleman threat. To eliminate this threat, the client keys can be extracted -from the parameter file and distributed to all restricted clients. +from the parameter file and distributed to all restricted clients. After generating the parameter file, on alice run ntp-keygen -e -and pipe the output to a file or mail program. -Copy or mail this file to all restricted clients. +and pipe the output to a file or mail program. +Copy or mail this file to all restricted clients. On these clients install a soft link from the generic -ntpkey_iff_alice -to this file. +ntpkey_iff_alice +to this file. To further protect the integrity of the keys, each file can be encrypted with a secret password. - -
For the GQ scheme proceed as in the TC scheme to generate keys +
+
For the GQ scheme proceed as in the TC scheme to generate keys and certificates for all group hosts, then for every trusted host -in the group, generate the IFF parameter file. +in the group, generate the IFF parameter file. On trusted host alice run ntp-keygen -T -G -p password to produce her parameter file -ntpkey_GQpar_alice.filestamp, -which includes both server and client keys. +ntpkey_GQpar_alice.filestamp, +which includes both server and client keys. Copy this file to all group hosts and install a soft link from the generic -ntpkey_gq_alice -to this file. +ntpkey_gq_alice +to this file. In addition, on each host bob install a soft link from generic -ntpkey_gq_bob -to this file. +ntpkey_gq_bob +to this file. As the GQ scheme updates the GQ parameters file and certificate at the same time, keys and certificates can be regenerated as needed. - -
For the MV scheme, proceed as in the TC scheme to generate keys -and certificates for all group hosts. +
+
For the MV scheme, proceed as in the TC scheme to generate keys +and certificates for all group hosts. For illustration assume trish is the TA, alice one of several trusted hosts -and bob one of her clients. +and bob one of her clients. On TA trish run ntp-keygen -V n @@ -841,113 +866,143 @@ where n is the number of revokable keys (typically 5) to produce the parameter file -ntpkeys_MVpar_trish.filestamp +ntpkeys_MVpar_trish.filestamp and client key files -ntpkeys_MVkeyd_trish.filestamp +ntpkeys_MVkeyd_trish.filestamp where d is the key number (0 < d < -n). +n). Copy the parameter file to alice and install a soft link from the generic -ntpkey_mv_alice -to this file. +ntpkey_mv_alice +to this file. Copy one of the client key files to alice for later distribution -to her clients. -It doesn't matter which client key file goes to alice, -since they all work the same way. -Alice copies the client key file to all of her cliens. +to her clients. +It doesn’t matter which client key file goes to alice, +since they all work the same way. +Alice copies the client key file to all of her cliens. On client bob install a soft link from generic -ntpkey_mvkey_bob -to the client key file. +ntpkey_mvkey_bob +to the client key file. As the MV scheme is independent of keys and certificates, these files can be refreshed as needed. - -
Command Line Options
- -
-
-c scheme
Select certificate message digest/signature encryption scheme. +
+
1.2.1.4 Command Line Options
+
+
-c scheme
+
Select certificate message digest/signature encryption scheme. The scheme can be one of the following: . Cm RSA-MD2 , RSA-MD5 , RSA-SHA , RSA-SHA1 , RSA-MDC2 , RSA-RIPEMD160 , DSA-SHA , or -DSA-SHA1. +DSA-SHA1. Note that RSA schemes must be used with a RSA sign key and DSA -schemes must be used with a DSA sign key. +schemes must be used with a DSA sign key. The default without this option is -RSA-MD5. -
-d
Enable debugging. -This option displays the cryptographic data produced in eye-friendly billboards. -
-e
Write the IFF client keys to the standard output. -This is intended for automatic key distribution by mail. -
-G
Generate parameters and keys for the GQ identification scheme, -obsoleting any that may exist. -
-g
Generate keys for the GQ identification scheme -using the existing GQ parameters. -If the GQ parameters do not yet exist, create them first. -
-H
Generate new host keys, obsoleting any that may exist. -
-I
Generate parameters for the IFF identification scheme, -obsoleting any that may exist. -
-i name
Set the suject name to -name. +RSA-MD5. +
+
-d
+
Enable debugging. +This option displays the cryptographic data produced in eye-friendly billboards. +
+
-e
+
Write the IFF client keys to the standard output. +This is intended for automatic key distribution by mail. +
+
-G
+
Generate parameters and keys for the GQ identification scheme, +obsoleting any that may exist. +
+
-g
+
Generate keys for the GQ identification scheme +using the existing GQ parameters. +If the GQ parameters do not yet exist, create them first. +
+
-H
+
Generate new host keys, obsoleting any that may exist. +
+
-I
+
Generate parameters for the IFF identification scheme, +obsoleting any that may exist. +
+
-i name
+
Set the suject name to +name. This is used as the subject field in certificates -and in the file name for host and sign keys. -
-M
Generate MD5 keys, obsoleting any that may exist. -
-P
Generate a private certificate. -By default, the program generates public certificates. -
-p password
Encrypt generated files containing private data with +and in the file name for host and sign keys. +
+
-M
+
Generate MD5 keys, obsoleting any that may exist. +
+
-P
+
Generate a private certificate. +By default, the program generates public certificates. +
+
-p password
+
Encrypt generated files containing private data with password -and the DES-CBC algorithm. -
-q
Set the password for reading files to password. -
-S [RSA | DSA]
Generate a new sign key of the designated type, -obsoleting any that may exist. -By default, the program uses the host key as the sign key. -
-s name
Set the issuer name to -name. +and the DES-CBC algorithm. +
+
-q
+
Set the password for reading files to password. +
+
-S [RSA | DSA]
+
Generate a new sign key of the designated type, +obsoleting any that may exist. +By default, the program uses the host key as the sign key. +
+
-s name
+
Set the issuer name to +name. This is used for the issuer field in certificates -and in the file name for identity files. -
-T
Generate a trusted certificate. -By default, the program generates a non-trusted certificate. -
-V nkeys
Generate parameters and keys for the Mu-Varadharajan (MV) identification scheme. +and in the file name for identity files. +
+
-T
+
Generate a trusted certificate. +By default, the program generates a non-trusted certificate. +
+
-V nkeys
+
Generate parameters and keys for the Mu-Varadharajan (MV) identification scheme. +

- -
Random Seed File
- + +
1.2.1.5 Random Seed File

All cryptographically sound key generation schemes must have means to randomize the entropy seed used to initialize the internal pseudo-random number generator used -by the library routines. -The OpenSSL library uses a designated random seed file for this purpose. +by the library routines. +The OpenSSL library uses a designated random seed file for this purpose. The file must be available when starting the NTP daemon and ntp-keygen -program. +program. If a site supports OpenSSL or its companion OpenSSH, it is very likely that means to do this are already available. - -
It is important to understand that entropy must be evolved +
+
It is important to understand that entropy must be evolved for each generation, for otherwise the random number sequence -would be predictable. +would be predictable. Various means dependent on external events, such as keystroke intervals, -can be used to do this and some systems have built-in entropy sources. +can be used to do this and some systems have built-in entropy sources. Suitable means are described in the OpenSSL software documentation, but are outside the scope of this page. - -
The entropy seed used by the OpenSSL library is contained in a file, +
+
The entropy seed used by the OpenSSL library is contained in a file, usually called .rnd, which must be available when starting the NTP daemon or the ntp-keygen -program. +program. The NTP daemon will first look for the file using the path specified by the randfile subcommand of the crypto -configuration command. +configuration command. If not specified in this way, or when starting the ntp-keygen program, @@ -955,54 +1010,54 @@ the OpenSSL library will look for the file using the path specified by the .Ev RANDFILE environment variable in the user home directory, -whether root or some other user. +whether root or some other user. If the .Ev RANDFILE environment variable is not present, the library will look for the .rnd -file in the user home directory. +file in the user home directory. If the file is not available or cannot be written, the daemon exits with a message to the system log and the program exits with a suitable error message. - -
Cryptographic Data Files
- -
All other file formats begin with two lines. +
+
1.2.1.6 Cryptographic Data Files
+
All other file formats begin with two lines. The first contains the file name, including the generated host name -and filestamp. -The second contains the datestamp in conventional Unix date format. +and filestamp. +The second contains the datestamp in conventional Unix date format. Lines beginning with # are considered comments and ignored by the ntp-keygen program and ntpd(1ntpdmdoc) -daemon. +daemon. Cryptographic values are encoded first using ASN.1 rules, then encrypted if necessary, and finally written PEM-encoded printable ASCII format preceded and followed by MIME content identifier lines. - -
The format of the symmetric keys file is somewhat different -than the other files in the interest of backward compatibility. +
+
The format of the symmetric keys file is somewhat different +than the other files in the interest of backward compatibility. Since DES-CBC is deprecated in NTPv4, the only key format of interest -is MD5 alphanumeric strings. +is MD5 alphanumeric strings. Following hte heard the keys are entered one per line in the format -
keyno type key -
-
where +
+
keyno type key +
+
where keyno is a positive integer in the range 1-65,535, type is the string MD5 defining the key format and key is the key itself, -which is a printable ASCII string 16 characters or less in length. +which is a printable ASCII string 16 characters or less in length. Each character is chosen from the 93 printable characters in the range 0x21 through 0x7f excluding space and the -# +‘#’ character. - -
Note that the keys used by the +
+
Note that the keys used by the ntpq(1ntpqmdoc) and ntpdc(1ntpdcmdoc) @@ -1010,21 +1065,21 @@ programs are checked against passwords requested by the programs and entered by hand, so it is generally appropriate to specify these keys in human readable ASCII format. - -
The +
+
The ntp-keygen program generates a MD5 symmetric keys file -ntpkey_MD5key_hostname.filestamp. +ntpkey_MD5key_hostname.filestamp. Since the file contains private shared keys, it should be visible only to root and distributed by secure means -to other subnet hosts. +to other subnet hosts. The NTP daemon loads the file -ntp.keys, +ntp.keys, so ntp-keygen -installs a soft link from this name to the generated file. +installs a soft link from this name to the generated file. Subsequently, similar soft links must be installed by manual -or automated means on the other subnet hosts. +or automated means on the other subnet hosts. While this file is not used with the Autokey Version 2 protocol, it is needed to authenticate some remote configuration commands used by the @@ -1032,60 +1087,86 @@ used by the and ntpdc(1ntpdcmdoc) utilities. - -
This section was generated by AutoGen, -using the agtexi-cmd template and the option descriptions for the ntp-keygen program. +
+
This section was generated by AutoGen, +using the agtexi-cmd template and the option descriptions for the ntp-keygen program. This software is released under the NTP license, <http://ntp.org/license>. - -
-
ntp-keygen usage: ntp-keygen help/usage (--help) -
ntp-keygen imbits: imbits option (-b) -
ntp-keygen certificate: certificate option (-c) -
ntp-keygen cipher: cipher option (-C) -
ntp-keygen id-key: id-key option (-e) -
ntp-keygen gq-params: gq-params option (-G) -
ntp-keygen host-key: host-key option (-H) -
ntp-keygen iffkey: iffkey option (-I) -
ntp-keygen ident: ident option (-i) -
ntp-keygen lifetime: lifetime option (-l) -
ntp-keygen md5key: md5key option (-M) -
ntp-keygen modulus: modulus option (-m) -
ntp-keygen pvt-cert: pvt-cert option (-P) -
ntp-keygen password: password option (-p) -
ntp-keygen export-passwd: export-passwd option (-q) -
ntp-keygen sign-key: sign-key option (-S) -
ntp-keygen subject-name: subject-name option (-s) -
ntp-keygen trusted-cert: trusted-cert option (-T) -
ntp-keygen mv-params: mv-params option (-V) -
ntp-keygen mv-keys: mv-keys option (-v) -
ntp-keygen config: presetting/configuring ntp-keygen -
ntp-keygen exit status: exit status -
ntp-keygen Usage: Usage -
ntp-keygen Notes: Notes -
ntp-keygen Bugs: Bugs -
- -
-
-Next: ntp-keygen imbits, -Up: ntp-keygen Invocation -
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
• ntp-keygen usage:    ntp-keygen help/usage (--help) +
• ntp-keygen imbits:    imbits option (-b) +
• ntp-keygen certificate:    certificate option (-c) +
• ntp-keygen cipher:    cipher option (-C) +
• ntp-keygen id-key:    id-key option (-e) +
• ntp-keygen gq-params:    gq-params option (-G) +
• ntp-keygen host-key:    host-key option (-H) +
• ntp-keygen iffkey:    iffkey option (-I) +
• ntp-keygen ident:    ident option (-i) +
• ntp-keygen lifetime:    lifetime option (-l) +
• ntp-keygen md5key:    md5key option (-M) +
• ntp-keygen modulus:    modulus option (-m) +
• ntp-keygen pvt-cert:    pvt-cert option (-P) +
• ntp-keygen password:    password option (-p) +
• ntp-keygen export-passwd:    export-passwd option (-q) +
• ntp-keygen sign-key:    sign-key option (-S) +
• ntp-keygen subject-name:    subject-name option (-s) +
• ntp-keygen trusted-cert:    trusted-cert option (-T) +
• ntp-keygen mv-params:    mv-params option (-V) +
• ntp-keygen mv-keys:    mv-keys option (-v) +
• ntp-keygen config:    presetting/configuring ntp-keygen +
• ntp-keygen exit status:    exit status +
• ntp-keygen Usage:    Usage +
• ntp-keygen Notes:    Notes +
• ntp-keygen Bugs:    Bugs +
+ +
+ +
+
+Next: ntp-keygen imbits, Up: ntp-keygen Invocation

- -
ntp-keygen help/usage (--help)
- -
-This is the automatically generated usage text for ntp-keygen. - -
The text printed is the same whether selected with the help option -(--help) or the more-help option (--more-help). more-help will print -the usage text by passing it through a pager program. + +
1.2.2 ntp-keygen help/usage (--help)
+ + +
This is the automatically generated usage text for ntp-keygen. +
+
The text printed is the same whether selected with the help option +(--help) or the more-help option (--more-help). more-help will print +the usage text by passing it through a pager program. more-help is disabled on platforms without a working fork(2) function. The PAGER environment variable is -used to select the program, defaulting to more. Both will exit +used to select the program, defaulting to more. Both will exit with a status code of 0. - -
ntp-keygen (ntp) - Create a NTP host key - Ver. 4.2.8p9-win1 +
+
+
ntp-keygen (ntp) - Create a NTP host key - Ver. 4.2.8p9 Usage: ntp-keygen [ -<flag> [<val>] | --<name>[{=| }<val>] ]... Flg Arg Option-Name Description -b Num imbits identity modulus bits @@ -1133,679 +1214,674 @@ The following option preset mechanisms are supported: - examining environment variables named NTP_KEYGEN_* Please send bug reports to: <http://bugs.ntp.org, bugs@ntp.org> -
-
-
-Next: ntp-keygen certificate, -Previous: ntp-keygen usage, -Up: ntp-keygen Invocation -
-
- -
imbits option (-b)
+
-
-This is the “identity modulus bits” option. -This option takes a number argument imbits. - -
This option has some usage constraints. It: -
-
must be compiled in by defining AUTOKEY during the compilation. -
- -
The number of bits in the identity modulus. The default is 256. -
-
-Next: ntp-keygen cipher, -Previous: ntp-keygen imbits, -Up: ntp-keygen Invocation -
+
+ +
+
+Next: ntp-keygen certificate, Previous: ntp-keygen usage, Up: ntp-keygen Invocation

- -
certificate option (-c)
- -
-This is the “certificate scheme” option. -This option takes a string argument scheme. - -
This option has some usage constraints. It: -
-
must be compiled in by defining AUTOKEY during the compilation. -
- -
scheme is one of + +
1.2.3 imbits option (-b)
+ + +
This is the “identity modulus bits” option. +This option takes a number argument imbits. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining AUTOKEY during the compilation. +
+ +
The number of bits in the identity modulus. The default is 256. +
+ +
+
+Next: ntp-keygen cipher, Previous: ntp-keygen imbits, Up: ntp-keygen Invocation
+
+ +
1.2.4 certificate option (-c)
+ + +
This is the “certificate scheme” option. +This option takes a string argument scheme. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining AUTOKEY during the compilation. +
+ +
scheme is one of RSA-MD2, RSA-MD5, RSA-SHA, RSA-SHA1, RSA-MDC2, RSA-RIPEMD160, DSA-SHA, or DSA-SHA1. - -
Select the certificate message digest/signature encryption scheme. +
+
Select the certificate message digest/signature encryption scheme. Note that RSA schemes must be used with a RSA sign key and DSA schemes must be used with a DSA sign key. The default without -this option is RSA-MD5. -
-
-Next: ntp-keygen id-key, -Previous: ntp-keygen certificate, -Up: ntp-keygen Invocation -
+this option is RSA-MD5. +
+ +
+
+Next: ntp-keygen id-key, Previous: ntp-keygen certificate, Up: ntp-keygen Invocation

- -
cipher option (-C)
- -
-This is the “privatekey cipher” option. -This option takes a string argument cipher. - -
This option has some usage constraints. It: -
-
must be compiled in by defining AUTOKEY during the compilation. -
- -
Select the cipher which is used to encrypt the files containing + +
1.2.5 cipher option (-C)
+ + +
This is the “privatekey cipher” option. +This option takes a string argument cipher. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining AUTOKEY during the compilation. +
+ +
Select the cipher which is used to encrypt the files containing private keys. The default is three-key triple DES in CBC mode, -equivalent to "-C des-ede3-cbc". The openssl tool lists ciphers -available in "openssl -h" output. -
-
-Next: ntp-keygen gq-params, -Previous: ntp-keygen cipher, -Up: ntp-keygen Invocation -
+equivalent to "-C des-ede3-cbc". The openssl tool lists ciphers +available in "openssl -h" output. +
+ +
+
+Next: ntp-keygen gq-params, Previous: ntp-keygen cipher, Up: ntp-keygen Invocation

- -
id-key option (-e)
- -
-This is the “write iff or gq identity keys” option. - -
This option has some usage constraints. It: -
-
must be compiled in by defining AUTOKEY during the compilation. -
- -
Write the IFF or GQ client keys to the standard output. This is -intended for automatic key distribution by mail. -
-
-Next: ntp-keygen host-key, -Previous: ntp-keygen id-key, -Up: ntp-keygen Invocation -
+ +
1.2.6 id-key option (-e)
+ + +
This is the “write iff or gq identity keys” option. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining AUTOKEY during the compilation. +
+ +
Write the IFF or GQ client keys to the standard output. This is +intended for automatic key distribution by mail. +
+ +
+
+Next: ntp-keygen host-key, Previous: ntp-keygen id-key, Up: ntp-keygen Invocation

- -
gq-params option (-G)
- -
-This is the “generate gq parameters and keys” option. - -
This option has some usage constraints. It: -
-
must be compiled in by defining AUTOKEY during the compilation. -
- -
Generate parameters and keys for the GQ identification scheme, -obsoleting any that may exist. -
-
-Next: ntp-keygen iffkey, -Previous: ntp-keygen gq-params, -Up: ntp-keygen Invocation -
+ +
1.2.7 gq-params option (-G)
+ + +
This is the “generate gq parameters and keys” option. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining AUTOKEY during the compilation. +
+ +
Generate parameters and keys for the GQ identification scheme, +obsoleting any that may exist. +
+ +
+
+Next: ntp-keygen iffkey, Previous: ntp-keygen gq-params, Up: ntp-keygen Invocation

- -
host-key option (-H)
- -
-This is the “generate rsa host key” option. - -
This option has some usage constraints. It: -
-
must be compiled in by defining AUTOKEY during the compilation. -
- -
Generate new host keys, obsoleting any that may exist. -
-
-Next: ntp-keygen ident, -Previous: ntp-keygen host-key, -Up: ntp-keygen Invocation -
+ +
1.2.8 host-key option (-H)
+ + +
This is the “generate rsa host key” option. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining AUTOKEY during the compilation. +
+ +
Generate new host keys, obsoleting any that may exist. +
+ +
+
+Next: ntp-keygen ident, Previous: ntp-keygen host-key, Up: ntp-keygen Invocation

- -
iffkey option (-I)
- -
-This is the “generate iff parameters” option. - -
This option has some usage constraints. It: -
-
must be compiled in by defining AUTOKEY during the compilation. -
- -
Generate parameters for the IFF identification scheme, obsoleting -any that may exist. -
-
-Next: ntp-keygen lifetime, -Previous: ntp-keygen iffkey, -Up: ntp-keygen Invocation -
+ +
1.2.9 iffkey option (-I)
+ + +
This is the “generate iff parameters” option. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining AUTOKEY during the compilation. +
+ +
Generate parameters for the IFF identification scheme, obsoleting +any that may exist. +
+ +
+
+Next: ntp-keygen lifetime, Previous: ntp-keygen iffkey, Up: ntp-keygen Invocation

- -
ident option (-i)
- -
-This is the “set autokey group name” option. -This option takes a string argument group. - -
This option has some usage constraints. It: -
-
must be compiled in by defining AUTOKEY during the compilation. -
- -
Set the optional Autokey group name to name. This is used in + +
1.2.10 ident option (-i)
+ + +
This is the “set autokey group name” option. +This option takes a string argument group. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining AUTOKEY during the compilation. +
+ +
Set the optional Autokey group name to name. This is used in the file name of IFF, GQ, and MV client parameters files. In that role, the default is the host name if this option is not provided. The group name, if specified using -i/--ident or -using -s/--subject-name following an '}' character, +using -s/--subject-name following an ’}' character, is also a part of the self-signed host certificate's subject and -issuer names in the form host -
'crypto ident' or 'server ident' configuration in -ntpd's configuration file. -
- -Next: ntp-keygen md5key, -Previous: ntp-keygen ident, -Up: ntp-keygen Invocation - +issuer names in the form host
’crypto ident’ or ’server ident’ configuration in +ntpd’s configuration file. +
+ +
+
+Next: ntp-keygen md5key, Previous: ntp-keygen ident, Up: ntp-keygen Invocation

- -
lifetime option (-l)
- -
-This is the ``set certificate lifetime'' option. -This option takes a number argument lifetime. - -
This option has some usage constraints. It: -
-
must be compiled in by defining AUTOKEY during the compilation. -
- -
Set the certificate expiration to lifetime days from now. -
-
-Next: ntp-keygen modulus, -Previous: ntp-keygen lifetime, -Up: ntp-keygen Invocation -
+ +
1.2.11 lifetime option (-l)
+ + +
This is the “set certificate lifetime” option. +This option takes a number argument lifetime. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining AUTOKEY during the compilation. +
+ +
Set the certificate expiration to lifetime days from now. +
+ +
+
+Next: ntp-keygen modulus, Previous: ntp-keygen lifetime, Up: ntp-keygen Invocation

- -
md5key option (-M)
- -
-This is the ``generate md5 keys'' option. -Generate MD5 keys, obsoleting any that may exist. -
-
-Next: ntp-keygen pvt-cert, -Previous: ntp-keygen md5key, -Up: ntp-keygen Invocation -
+ +
1.2.12 md5key option (-M)
+ + +
This is the “generate md5 keys” option. +Generate MD5 keys, obsoleting any that may exist. +
+ +
+
+Next: ntp-keygen pvt-cert, Previous: ntp-keygen md5key, Up: ntp-keygen Invocation

- -
modulus option (-m)
- -
-This is the ``modulus'' option. -This option takes a number argument modulus. - -
This option has some usage constraints. It: -
-
must be compiled in by defining AUTOKEY during the compilation. -
- -
The number of bits in the prime modulus. The default is 512. -
-
-Next: ntp-keygen password, -Previous: ntp-keygen modulus, -Up: ntp-keygen Invocation -
+ +
1.2.13 modulus option (-m)
+ + +
This is the “modulus” option. +This option takes a number argument modulus. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining AUTOKEY during the compilation. +
+ +
The number of bits in the prime modulus. The default is 512. +
+ +
+
+Next: ntp-keygen password, Previous: ntp-keygen modulus, Up: ntp-keygen Invocation

- -
pvt-cert option (-P)
- -
-This is the ``generate pc private certificate'' option. - -
This option has some usage constraints. It: -
-
must be compiled in by defining AUTOKEY during the compilation. -
- -
Generate a private certificate. By default, the program generates -public certificates. -
-
-Next: ntp-keygen export-passwd, -Previous: ntp-keygen pvt-cert, -Up: ntp-keygen Invocation -
+ +
1.2.14 pvt-cert option (-P)
+ + +
This is the “generate pc private certificate” option. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining AUTOKEY during the compilation. +
+ +
Generate a private certificate. By default, the program generates +public certificates. +
+ +
+
+Next: ntp-keygen export-passwd, Previous: ntp-keygen pvt-cert, Up: ntp-keygen Invocation

- -
password option (-p)
- -
-This is the ``local private password'' option. -This option takes a string argument passwd. - -
This option has some usage constraints. It: -
-
must be compiled in by defining AUTOKEY during the compilation. -
- -
Local files containing private data are encrypted with the + +
1.2.15 password option (-p)
+ + +
This is the “local private password” option. +This option takes a string argument passwd. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining AUTOKEY during the compilation. +
+ +
Local files containing private data are encrypted with the DES-CBC algorithm and the specified password. The same password -must be specified to the local ntpd via the "crypto pw password" +must be specified to the local ntpd via the "crypto pw password" configuration command. The default password is the local -hostname. -
-
-Next: ntp-keygen sign-key, -Previous: ntp-keygen password, -Up: ntp-keygen Invocation -
+hostname. +
+ +
+
+Next: ntp-keygen sign-key, Previous: ntp-keygen password, Up: ntp-keygen Invocation

- -
export-passwd option (-q)
- -
-This is the ``export iff or gq group keys with password'' option. -This option takes a string argument passwd. - -
This option has some usage constraints. It: -
-
must be compiled in by defining AUTOKEY during the compilation. -
- -
Export IFF or GQ identity group keys to the standard output, -encrypted with the DES-CBC algorithm and the specified password. + +
1.2.16 export-passwd option (-q)
+ + +
This is the “export iff or gq group keys with password” option. +This option takes a string argument passwd. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining AUTOKEY during the compilation. +
+ +
Export IFF or GQ identity group keys to the standard output, +encrypted with the DES-CBC algorithm and the specified password. The same password must be specified to the remote ntpd via the -"crypto pw password" configuration command. See also the option ---id-key (-e) for unencrypted exports. -
-
-Next: ntp-keygen subject-name, -Previous: ntp-keygen export-passwd, -Up: ntp-keygen Invocation -
+"crypto pw password" configuration command. See also the option +–id-key (-e) for unencrypted exports. +
+ +
+
+Next: ntp-keygen subject-name, Previous: ntp-keygen export-passwd, Up: ntp-keygen Invocation

- -
sign-key option (-S)
- -
-This is the ``generate sign key (rsa or dsa)'' option. -This option takes a string argument sign. - -
This option has some usage constraints. It: -
-
must be compiled in by defining AUTOKEY during the compilation. -
- -
Generate a new sign key of the designated type, obsoleting any + +
1.2.17 sign-key option (-S)
+ + +
This is the “generate sign key (rsa or dsa)” option. +This option takes a string argument sign. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining AUTOKEY during the compilation. +
+ +
Generate a new sign key of the designated type, obsoleting any that may exist. By default, the program uses the host key as the -sign key. -
-
-Next: ntp-keygen trusted-cert, -Previous: ntp-keygen sign-key, -Up: ntp-keygen Invocation -
+sign key. +
+ +
+
+Next: ntp-keygen trusted-cert, Previous: ntp-keygen sign-key, Up: ntp-keygen Invocation

- -
subject-name option (-s)
- -
-This is the ``set host and optionally group name'' option. -This option takes a string argument host@group. - -
This option has some usage constraints. It: -
-
must be compiled in by defining AUTOKEY during the compilation. -
- -
Set the Autokey host name, and optionally, group name specified -following an '}' character. The host name is used in the file + +
1.2.18 subject-name option (-s)
+ + +This is the “set host and optionally group name” option. +This option takes a string argument host@group. + +This option has some usage constraints. It: + + must be compiled in by defining AUTOKEY during the compilation. + + +Set the Autokey host name, and optionally, group name specified +following an ’}' character. The host name is used in the file name of generated host and signing certificates, without the group name. The host name, and if provided, group name are used -in host - fields. Specifying '-s - leaving the host name unchanged while appending - subject and issuer fields, as with -i group. The group name, or +in host fields. Specifying ’-s leaving the host name unchanged while appending
subject and issuer fields, as with -i group. The group name, or if not provided, the host name are also used in the file names -of IFF, GQ, and MV client parameter files. -
-
-Next: ntp-keygen mv-params, -Previous: ntp-keygen subject-name, -Up: ntp-keygen Invocation -
+of IFF, GQ, and MV client parameter files. +
+ +
+
+Next: ntp-keygen mv-params, Previous: ntp-keygen subject-name, Up: ntp-keygen Invocation

- -
trusted-cert option (-T)
- -
-This is the ``trusted certificate (tc scheme)'' option. - -
This option has some usage constraints. It: -
-
must be compiled in by defining AUTOKEY during the compilation. -
- -
Generate a trusted certificate. By default, the program generates -a non-trusted certificate. -
-
-Next: ntp-keygen mv-keys, -Previous: ntp-keygen trusted-cert, -Up: ntp-keygen Invocation -
+ +
1.2.19 trusted-cert option (-T)
+ + +
This is the “trusted certificate (tc scheme)” option. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining AUTOKEY during the compilation. +
+ +
Generate a trusted certificate. By default, the program generates +a non-trusted certificate. +
+ +
+
+Next: ntp-keygen mv-keys, Previous: ntp-keygen trusted-cert, Up: ntp-keygen Invocation

- -
mv-params option (-V)
- -
-This is the ``generate <num> mv parameters'' option. -This option takes a number argument num. - -
This option has some usage constraints. It: -
-
must be compiled in by defining AUTOKEY during the compilation. -
- -
Generate parameters and keys for the Mu-Varadharajan (MV) -identification scheme. -
-
-Next: ntp-keygen config, -Previous: ntp-keygen mv-params, -Up: ntp-keygen Invocation -
+ +
1.2.20 mv-params option (-V)
+ + +
This is the “generate <num> mv parameters” option. +This option takes a number argument num. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining AUTOKEY during the compilation. +
+ +
Generate parameters and keys for the Mu-Varadharajan (MV) +identification scheme. +
+ +
+
+Next: ntp-keygen config, Previous: ntp-keygen mv-params, Up: ntp-keygen Invocation

- -
mv-keys option (-v)
- -
-This is the ``update <num> mv keys'' option. -This option takes a number argument num. - -
This option has some usage constraints. It: -
-
must be compiled in by defining AUTOKEY during the compilation. -
- -
This option has no doc documentation. - -
-
-Next: ntp-keygen exit status, -Previous: ntp-keygen mv-keys, -Up: ntp-keygen Invocation -
+ +
1.2.21 mv-keys option (-v)
+ + +
This is the “update <num> mv keys” option. +This option takes a number argument num. +
+
This option has some usage constraints. It: +
+
must be compiled in by defining AUTOKEY during the compilation. +
+ +
This option has no ‘doc’ documentation. +
+ +
+ +
+
+Next: ntp-keygen exit status, Previous: ntp-keygen mv-keys, Up: ntp-keygen Invocation

- -
presetting/configuring ntp-keygen
+ +
1.2.22 presetting/configuring ntp-keygen

Any option that is not marked as not presettable may be preset by -loading values from configuration ("rc" or "ini") files, and values from environment variables named NTP-KEYGEN and NTP-KEYGEN_<OPTION_NAME>. <OPTION_NAME> must be one of -the options listed above in upper case and segmented with underscores. +loading values from configuration ("rc" or "ini") files, and values from environment variables named NTP-KEYGEN and NTP-KEYGEN_<OPTION_NAME>. <OPTION_NAME> must be one of +the options listed above in upper case and segmented with underscores. The NTP-KEYGEN variable will be tokenized and parsed like the command line. The remaining variables are tested for existence and their values are treated like option arguments. - -
libopts will search in 2 places for configuration files: -
-
$HOME -
$PWD -
- The environment variables HOME, and PWD -are expanded and replaced when ntp-keygen runs. -For any of these that are plain files, they are simply processed. -For any that are directories, then a file named .ntprc is searched for +
+ +
libopts will search in 2 places for configuration files: +
+
$HOME +
$PWD +
+
The environment variables HOME, and PWD +are expanded and replaced when ntp-keygen runs. +For any of these that are plain files, they are simply processed. +For any that are directories, then a file named .ntprc is searched for within that directory and processed. - -
Configuration files may be in a wide variety of formats. +
+
Configuration files may be in a wide variety of formats. The basic format is an option name followed by a value (argument) on the same line. Values may be separated from the option name with a colon, equal sign or simply white space. Values may be continued across multiple lines by escaping the newline with a backslash. - -
Multiple programs may also share the same initialization file. +
+
Multiple programs may also share the same initialization file. Common options are collected at the top, followed by program specific segments. The segments are separated by lines like: -
[NTP-KEYGEN] -
-
or by -
<?program ntp-keygen> -
-
Do not mix these styles within one configuration file. - -
Compound values and carefully constructed string values may also be +
+
[NTP-KEYGEN] +
+
or by +
+
<?program ntp-keygen> +
+
Do not mix these styles within one configuration file. +
+
Compound values and carefully constructed string values may also be specified using XML syntax: -
<option-name> - <sub-opt>...<...>...</sub-opt> - </option-name> -
-
yielding an option-name.sub-opt string value of -
"...<...>..." -
-
AutoOpts does not track suboptions. You simply note that it is a +
+
<option-name> + <sub-opt>...<...>...</sub-opt> +</option-name> +
+
yielding an option-name.sub-opt string value of +
+
"...<...>..." +
+
AutoOpts does not track suboptions. You simply note that it is a hierarchicly valued option. AutoOpts does provide a means for searching the associated name/value pair list (see: optionFindValue). - -
The command line options relating to configuration and/or usage help are: - -
version (-)
+
+
The command line options relating to configuration and/or usage help are: +
+ +
version (-)

Print the program version to standard out, optionally with licensing information, then exit 0. The optional argument specifies how much licensing -detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument. +detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument. Only the first letter of the argument is examined: - -
-
version
Only print the version. This is the default. -
copyright
Name the copyright usage licensing terms. -
verbose
Print the full copyright usage licensing terms. +
+
+
‘version’
+
Only print the version. This is the default. +
+
‘copyright’
+
Name the copyright usage licensing terms. +
+
‘verbose’
+
Print the full copyright usage licensing terms. +

-
-
-Next: ntp-keygen Usage, -Previous: ntp-keygen config, -Up: ntp-keygen Invocation -
+
+ +
+
+Next: ntp-keygen Usage, Previous: ntp-keygen config, Up: ntp-keygen Invocation

- -
ntp-keygen exit status
+ +
1.2.23 ntp-keygen exit status

One of the following exit values will be returned: -
-
0 (EXIT_SUCCESS)
Successful program execution. -
1 (EXIT_FAILURE)
The operation failed or the command syntax was not valid. -
66 (EX_NOINPUT)
A specified configuration file could not be loaded. -
70 (EX_SOFTWARE)
libopts had an internal operational error. Please report -it to autogen-users@lists.sourceforge.net. Thank you. +
+
‘0 (EXIT_SUCCESS)’
+
Successful program execution. +
+
‘1 (EXIT_FAILURE)’
+
The operation failed or the command syntax was not valid. +
+
‘66 (EX_NOINPUT)’
+
A specified configuration file could not be loaded. +
+
‘70 (EX_SOFTWARE)’
+
libopts had an internal operational error. Please report +it to autogen-users@lists.sourceforge.net. Thank you. +

-
-
-Next: ntp-keygen Notes, -Previous: ntp-keygen exit status, -Up: ntp-keygen Invocation -
+
+ +
+
+Next: ntp-keygen Notes, Previous: ntp-keygen exit status, Up: ntp-keygen Invocation

- -
ntp-keygen Usage
- -
-
-Next: ntp-keygen Bugs, -Previous: ntp-keygen Usage, -Up: ntp-keygen Invocation -
+ +
1.2.24 ntp-keygen Usage
+
+ +
+
+Next: ntp-keygen Bugs, Previous: ntp-keygen Usage, Up: ntp-keygen Invocation

- -
ntp-keygen Notes
- -
-
-Previous: ntp-keygen Notes, -Up: ntp-keygen Invocation -
+ +
1.2.25 ntp-keygen Notes
+
+ +
+
+Previous: ntp-keygen Notes, Up: ntp-keygen Invocation

- -
ntp-keygen Bugs
- -
-
-Next: Cryptographic Data Files, -Previous: Running the Program, -Up: Top -
+ +
1.2.26 ntp-keygen Bugs
+ +
+ +
+
+Next: Cryptographic Data Files, Previous: Running the Program, Up: Top

- - -
Random Seed File
+ +
1.3 Random Seed File

All cryptographically sound key generation schemes must have means to randomize the entropy seed used to initialize the internal -pseudo-random number generator used by the OpenSSL library routines. +pseudo-random number generator used by the OpenSSL library routines. If a site supports ssh, it is very likely that means to do this are -already available. +already available. The entropy seed used by the OpenSSL library is contained in a file, usually called .rnd, which must be available when starting the ntp-keygen program or ntpd daemon. - -
The OpenSSL library looks for the file using the path specified by the +
+
The OpenSSL library looks for the file using the path specified by the RANDFILE environment variable in the user home directory, whether root -or some other user. +or some other user. If the RANDFILE environment variable is not present, the library looks for the .rnd file in the user home -directory. +directory. Since both the ntp-keygen program and ntpd daemon must run as root, the logical place to put this file is in /.rnd or -/root/.rnd. +/root/.rnd. If the file is not available or cannot be written, the program exits with a message to the system log. - -
-
-Previous: Random Seed File, -Up: Top -
+
+
+ +
+
+Previous: Random Seed File, Up: Top

- - -
Cryptographic Data Files
+ +
1.4 Cryptographic Data Files

File and link names are in the form ntpkey_key_name.fstamp, where key is the key or parameter type, name is the host or group name and -fstamp is the filestamp (NTP seconds) when the file was created). +fstamp is the filestamp (NTP seconds) when the file was created). By convention, key names in generated file names include both upper and lower case characters, while key names in generated link names include only lower case characters. The filestamp is not used in generated link names. - -
The key name is a string defining the cryptographic key type. +
+
The key name is a string defining the cryptographic key type. Key types include public/private keys host and sign, certificate cert -and several challenge/response key types. +and several challenge/response key types. By convention, client files used for challenges have a par subtype, as in the IFF challenge IFFpar, while server files for responses have a key subtype, as in the GQ response GQkey. - -
All files begin with two nonencrypted lines. The first line contains -the file name in the format ntpkey_key_host.fstamp. -The second line contains the datestamp in conventional Unix date format. +
+
All files begin with two nonencrypted lines. The first line contains +the file name in the format ntpkey_key_host.fstamp. +The second line contains the datestamp in conventional Unix date format. Lines beginning with # are ignored. - -
The remainder of the file contains cryptographic data encoded first +
+
The remainder of the file contains cryptographic data encoded first using ASN.1 rules, then encrypted using the DES-CBC algorithm with given password and finally written in PEM-encoded printable ASCII text preceded and followed by MIME content identifier lines. - -
The format of the symmetric keys file, ordinarily named ntp.keys, +
+
The format of the symmetric keys file, ordinarily named ntp.keys, is somewhat different than the other files in the interest of backward -compatibility. +compatibility. Ordinarily, the file is generated by this program, but it can be constructed and edited using an ordinary text editor. - -
# ntpkey_MD5key_hms.local.3564038757 - # Sun Dec 9 02:45:57 2012 - - 1 MD5 "]!ghT%O;3)WJ,/Nc:>I # MD5 key - 2 MD5 lu+H^tF46BKR-6~pV_5 # MD5 key - 3 MD5 :lnoVsE%Yz*avh%EtNC # MD5 key - 4 MD5 |fdZrf0sF~^V # MD5 key - 5 MD5 IyAG>O"y"LmCRS!*bHC # MD5 key - 6 MD5 ">e\A # MD5 key - 7 MD5 c9x=M'CfLxax9v)PV-si # MD5 key - 8 MD5 E|=jvFVov?Bn|Ev=&aK\ # MD5 key - 9 MD5 T!c4UT&`(m$+m+B6,`Q0 # MD5 key - 10 MD5 JVF/1=)=IFbHbJQz..Cd # MD5 key - 11 SHA1 6dea311109529e436c2b4fccae9bc753c16d1b48 # SHA1 key - 12 SHA1 7076f373d86c4848c59ff8046e49cb7d614ec394 # SHA1 key - 13 SHA1 5f48b1b60591eb01b7cf1d33b7774f08d20262d3 # SHA1 key - 14 SHA1 eed5ab9d9497319ec60cf3781d52607e76720178 # SHA1 key - 15 SHA1 f283562611a04c964da8126296f5f8e58c3f85de # SHA1 key - 16 SHA1 1930da171297dd63549af50b29449de17dcf341f # SHA1 key - 17 SHA1 fee892110358cd4382322b889869e750db8e8a8f # SHA1 key - 18 SHA1 b5520c9fadd7ad3fd8bfa061c8821b65d029bb37 # SHA1 key - 19 SHA1 8c74fb440ec80f453ec6aaa62b9baed0ab723b92 # SHA1 key - 20 SHA1 6bc05f734306a189326000970c19b3910f403795 # SHA1 key -
-
Figure 1. Typical Symmetric Key File - -
Figure 1 shows a typical symmetric keys file used by the reference -implementation. +
+
+
# ntpkey_MD5key_hms.local.3564038757 +# Sun Dec 9 02:45:57 2012 + + 1 MD5 "]!ghT%O;3)WJ,/Nc:>I # MD5 key + 2 MD5 lu+H^tF46BKR-6~pV_5 # MD5 key + 3 MD5 :lnoVsE%Yz*avh%EtNC # MD5 key + 4 MD5 |fdZrf0sF~;w-i^V # MD5 key + 5 MD5 IyAG>O"y"LmCRS!*bHC # MD5 key + 6 MD5 ">e\A>hT/661ri52,,H # MD5 key + 7 MD5 c9x=M'CfLxax9v)PV-si # MD5 key + 8 MD5 E|=jvFVov?Bn|Ev=&aK\ # MD5 key + 9 MD5 T!c4UT&`(m$+m+B6,`Q0 # MD5 key +10 MD5 JVF/1=)=IFbHbJQz..Cd # MD5 key +11 SHA1 6dea311109529e436c2b4fccae9bc753c16d1b48 # SHA1 key +12 SHA1 7076f373d86c4848c59ff8046e49cb7d614ec394 # SHA1 key +13 SHA1 5f48b1b60591eb01b7cf1d33b7774f08d20262d3 # SHA1 key +14 SHA1 eed5ab9d9497319ec60cf3781d52607e76720178 # SHA1 key +15 SHA1 f283562611a04c964da8126296f5f8e58c3f85de # SHA1 key +16 SHA1 1930da171297dd63549af50b29449de17dcf341f # SHA1 key +17 SHA1 fee892110358cd4382322b889869e750db8e8a8f # SHA1 key +18 SHA1 b5520c9fadd7ad3fd8bfa061c8821b65d029bb37 # SHA1 key +19 SHA1 8c74fb440ec80f453ec6aaa62b9baed0ab723b92 # SHA1 key +20 SHA1 6bc05f734306a189326000970c19b3910f403795 # SHA1 key +
+ +
Figure 1. Typical Symmetric Key File +
+
Figure 1 shows a typical symmetric keys file used by the reference +implementation. Each line of the file contains three fields, first an integer between 1 and 65534, inclusive, representing the key identifier -used in the server and peer configuration commands. +used in the server and peer configuration commands. Next is the key type for the message digest algorithm, which in the absence of the OpenSSL library must be MD5 to designate the MD5 message digest -algorithm. +algorithm. If the OpenSSL library is installed, the key type can be any -message digest algorithm supported by that library. +message digest algorithm supported by that library. However, if compatibility with FIPS 140-2 is required, the key type must be either -SHA or SHA1. +SHA or SHA1. The key type can be changed using an ASCII text editor. - -
An MD5 key consists of a printable ASCII string less than or equal to -16 characters and terminated by whitespace or a # character. +
+
An MD5 key consists of a printable ASCII string less than or equal to +16 characters and terminated by whitespace or a # character. An OpenSSL key consists of a hex-encoded ASCII string of 40 characters, which is truncated as necessary. - -
Note that the keys used by the ntpq and ntpdc programs are +
+
Note that the keys used by the ntpq and ntpdc programs are checked against passwords requested by the programs and entered by hand, so it is generally appropriate to specify these keys in human readable ASCII format. - -
The ntp-keygen program generates a MD5 symmetric keys file -ntpkey_MD5key_hostname.filestamp. +
+
The ntp-keygen program generates a MD5 symmetric keys file +ntpkey_MD5key_hostname.filestamp. Since the file contains private shared keys, it should be visible only to root and distributed by -secure means to other subnet hosts. +secure means to other subnet hosts. The NTP daemon loads the file ntp.keys, so ntp-keygen -installs a soft link from this name to the generated file. +installs a soft link from this name to the generated file. Subsequently, similar soft links must be installed by -manual or automated means on the other subnet hosts. +manual or automated means on the other subnet hosts. While this file is not used with the Autokey Version 2 protocol, it is needed to authenticate some remote configuration commands used by the ntpq and ntpdc utilities. +
+ - + +

NTP Configuration File User's Manual