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,
54 is the key itself, and
56 is an optional comma-separated list of IPs
60 that are allowed to serve time.
63 may contain an optional
65 specification which identifies the number of bits for
66 the desired subnet of trust.
70 any properly-authenticated message will be
75 may be given in a format
85 was built with the OpenSSL library
86 then any digest library supported by that library may be specified.
87 However, if compliance with FIPS 140-2 is required the
94 What follows are some key types, and corresponding formats:
96 .Bl -tag -width RMD160 -compact
98 The key is 1 to 16 printable characters terminated by
104 (which is the "start of comment" character).
109 The key is a hex-encoded ASCII string of 40 characters,
110 which is truncated as necessary.
113 Note that the keys used by the
117 programs are checked against passwords
118 requested by the programs and entered by hand,
119 so it is generally appropriate to specify these keys in ASCII format.
120 _END_PROG_MDOC_DESCRIP;
126 ds-text = <<- _END_MDOC_FILES
127 .Bl -tag -width /etc/ntp.keys -compact
129 the default name of the configuration file
135 ds-type = 'SEE ALSO';
137 ds-text = <<- _END_MDOC_SEE_ALSO
140 .Xr ntpdate 1ntpdatemdoc ,
141 .Xr ntpdc 1ntpdcmdoc ,
150 ds-text = <<- _END_MDOC_BUGS
152 has gotten rather fat.
153 While not huge, it has gotten larger than might
154 be desirable for an elevated-priority daemon running on a workstation,
155 particularly since many of the fancy features which consume the space
156 were designed more with a busy primary server, rather than a high
157 stratum workstation, in mind.
165 ds-text = <<- _END_MDOC_NOTES
166 This document was derived from FreeBSD.