2 @section Notes about ntp.keys
4 @cindex NTP symmetric key file format
7 # EDIT THIS FILE WITH CAUTION (invoke-ntp.keys.texi)
9 # It has been AutoGen-ed November 21, 2016 at 08:01:58 AM by AutoGen 5.18.5
10 # From the definitions ntp.keys.def
11 # and the template file agtexi-file.tpl
16 This document describes the format of an NTP symmetric key file.
17 For a description of the use of this type of file, see the
18 "Authentication Support"
24 reads its keys from a file specified using the
26 command line option or the
28 statement in the configuration file.
29 While key number 0 is fixed by the NTP standard
31 and may not be changed,
32 one or more keys numbered between 1 and 65534
33 may be arbitrarily set in the keys file.
35 The key file uses the same comment conventions
36 as the configuration file.
37 Key entries use a fixed format of the form
40 @kbd{keyno} @kbd{type} @kbd{key} @kbd{opt_IP_list}
45 is a positive integer (between 1 and 65534),
47 is the message digest algorithm,
50 is the key itself, and
52 is an optional comma-separated list of IPs
53 that are allowed to serve time.
57 any properly-authenticated server message will be
62 may be given in a format
72 was built with the OpenSSL library
73 then any digest library supported by that library may be specified.
74 However, if compliance with FIPS 140-2 is required the
81 What follows are some key types, and corresponding formats:
85 The key is 1 to 16 printable characters terminated by
91 (which is the "start of comment" character).
96 The key is a hex-encoded ASCII string of 40 characters,
97 which is truncated as necessary.
100 Note that the keys used by the
104 programs are checked against passwords
105 requested by the programs and entered by hand,
106 so it is generally appropriate to specify these keys in ASCII format.
108 This section was generated by @strong{AutoGen},
109 using the @code{agtexi-cmd} template and the option descriptions for the @code{ntp.keys} program.
110 This software is released under the NTP license, <http://ntp.org/license>.
113 * ntp.keys Files:: Files
114 * ntp.keys See Also:: See Also
115 * ntp.keys Notes:: Notes
119 @subsection ntp.keys Files
121 @item @file{/etc/ntp.keys}
122 the default name of the configuration file
124 @node ntp.keys See Also
125 @subsection ntp.keys See Also
127 @code{ntpd(1ntpdmdoc)},
128 @code{ntpdate(1ntpdatemdoc)},
129 @code{ntpdc(1ntpdcmdoc)},
130 @code{sntp(1sntpmdoc)}
132 @subsection ntp.keys Notes
133 This document was derived from FreeBSD.