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 August 14, 2018 at 08:29:10 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 65535
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 65535),
47 is the message digest algorithm,
49 is the key itself, and
51 is an optional comma-separated list of IPs
55 that are allowed to serve time.
58 may contain an optional
60 specification which identifies the number of bits for
61 the desired subnet of trust.
65 any properly-authenticated message will be
70 may be given in a format
80 was built with the OpenSSL library
81 then any digest library supported by that library may be specified.
82 However, if compliance with FIPS 140-2 is required the
89 What follows are some key types, and corresponding formats:
93 The key is 1 to 16 printable characters terminated by
99 (which is the "start of comment" character).
104 The key is a hex-encoded ASCII string of 40 characters,
105 which is truncated as necessary.
108 Note that the keys used by the
112 programs are checked against passwords
113 requested by the programs and entered by hand,
114 so it is generally appropriate to specify these keys in ASCII format.
116 This section was generated by @strong{AutoGen},
117 using the @code{agtexi-cmd} template and the option descriptions for the @code{ntp.keys} program.
118 This software is released under the NTP license, <http://ntp.org/license>.
121 * ntp.keys Files:: Files
122 * ntp.keys See Also:: See Also
123 * ntp.keys Notes:: Notes
127 @subsection ntp.keys Files
129 @item @file{/etc/ntp.keys}
130 the default name of the configuration file
132 @node ntp.keys See Also
133 @subsection ntp.keys See Also
135 @code{ntpd(1ntpdmdoc)},
136 @code{ntpdate(1ntpdatemdoc)},
137 @code{ntpdc(1ntpdcmdoc)},
138 @code{sntp(1sntpmdoc)}
140 @subsection ntp.keys Notes
141 This document was derived from FreeBSD.