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
50 is a positive integer (between 1 and 65534),
52 is the message digest algorithm,
59 may be given in a format
69 was built with the OpenSSL library
70 then any digest library supported by that library may be specified.
71 However, if compliance with FIPS 140-2 is required the
78 What follows are some key types, and corresponding formats:
80 .Bl -tag -width RMD160 -compact
82 The key is 1 to 16 printable characters terminated by
88 (which is the "start of comment" character).
93 The key is a hex-encoded ASCII string of 40 characters,
94 which is truncated as necessary.
97 Note that the keys used by the
101 programs are checked against passwords
102 requested by the programs and entered by hand,
103 so it is generally appropriate to specify these keys in ASCII format.
104 _END_PROG_MDOC_DESCRIP;
110 ds-text = <<- _END_MDOC_FILES
111 .Bl -tag -width /etc/ntp.keys -compact
113 the default name of the configuration file
119 ds-type = 'SEE ALSO';
121 ds-text = <<- _END_MDOC_SEE_ALSO
124 .Xr ntpdate 1ntpdatemdoc ,
125 .Xr ntpdc 1ntpdcmdoc ,
134 ds-text = <<- _END_MDOC_BUGS
136 has gotten rather fat.
137 While not huge, it has gotten larger than might
138 be desirable for an elevated-priority daemon running on a workstation,
139 particularly since many of the fancy features which consume the space
140 were designed more with a busy primary server, rather than a high
141 stratum workstation, in mind.
149 ds-text = <<- _END_MDOC_NOTES
150 This document was derived from FreeBSD.