1 /* -*- Mode: Text -*- */
3 autogen definitions options;
8 // We want the synopsis to be "/etc/ntp.keys" but we need the prog-name
9 // to be ntp.keys - the latter is also how autogen produces the output
11 prog-name = "ntp.keys";
12 file-path = "/etc/ntp.keys";
13 prog-title = "NTP symmetric key file format";
15 /* explain: Additional information whenever the usage routine is invoked */
16 explain = <<- _END_EXPLAIN
20 ds-type = 'DESCRIPTION';
22 ds-text = <<- _END_PROG_MDOC_DESCRIP
23 This document describes the format of an NTP symmetric key file.
24 For a description of the use of this type of file, see the
25 .Qq Authentication Support
31 reads its keys from a file specified using the
33 command line option or the
35 statement in the configuration file.
36 While key number 0 is fixed by the NTP standard
38 and may not be changed,
39 one or more keys numbered between 1 and 65534
40 may be arbitrarily set in the keys file.
42 The key file uses the same comment conventions
43 as the configuration file.
44 Key entries use a fixed format of the form
46 .D1 Ar keyno type key opt_IP_list
50 is a positive integer (between 1 and 65534),
52 is the message digest algorithm,
55 is the key itself, and
57 is an optional comma-separated list of IPs
58 that are allowed to serve time.
62 any properly-authenticated server message will be
67 may be given in a format
77 was built with the OpenSSL library
78 then any digest library supported by that library may be specified.
79 However, if compliance with FIPS 140-2 is required the
86 What follows are some key types, and corresponding formats:
88 .Bl -tag -width RMD160 -compact
90 The key is 1 to 16 printable characters terminated by
96 (which is the "start of comment" character).
101 The key is a hex-encoded ASCII string of 40 characters,
102 which is truncated as necessary.
105 Note that the keys used by the
109 programs are checked against passwords
110 requested by the programs and entered by hand,
111 so it is generally appropriate to specify these keys in ASCII format.
112 _END_PROG_MDOC_DESCRIP;
118 ds-text = <<- _END_MDOC_FILES
119 .Bl -tag -width /etc/ntp.keys -compact
121 the default name of the configuration file
127 ds-type = 'SEE ALSO';
129 ds-text = <<- _END_MDOC_SEE_ALSO
132 .Xr ntpdate 1ntpdatemdoc ,
133 .Xr ntpdc 1ntpdcmdoc ,
142 ds-text = <<- _END_MDOC_BUGS
144 has gotten rather fat.
145 While not huge, it has gotten larger than might
146 be desirable for an elevated-priority daemon running on a workstation,
147 particularly since many of the fancy features which consume the space
148 were designed more with a busy primary server, rather than a high
149 stratum workstation, in mind.
157 ds-text = <<- _END_MDOC_NOTES
158 This document was derived from FreeBSD.