]> CyberLeo.Net >> Repos - FreeBSD/releng/9.3.git/blob - contrib/ntp/ntpd/invoke-ntp.keys.texi
o Fix invalid TCP checksums with pf(4). [EN-16:02.pf]
[FreeBSD/releng/9.3.git] / contrib / ntp / ntpd / invoke-ntp.keys.texi
1 @node ntp.keys Notes
2 @section Notes about ntp.keys
3 @pindex ntp.keys
4 @cindex NTP symmetric key file format
5 @ignore
6 #
7 # EDIT THIS FILE WITH CAUTION  (invoke-ntp.keys.texi)
8 #
9 # It has been AutoGen-ed  January  7, 2016 at 11:30:52 PM by AutoGen 5.18.5
10 # From the definitions    ntp.keys.def
11 # and the template file   agtexi-file.tpl
12 @end ignore
13
14
15
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"
19 section of the
20 @code{ntp.conf(5)}
21 page.
22
23 @code{ntpd(8)}
24 reads its keys from a file specified using the
25 @code{-k}
26 command line option or the
27 @code{keys}
28 statement in the configuration file.
29 While key number 0 is fixed by the NTP standard
30 (as 56 zero bits)
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.
34
35 The key file uses the same comment conventions
36 as the configuration file.
37 Key entries use a fixed format of the form
38
39 @example
40 @kbd{keyno} @kbd{type} @kbd{key}
41 @end example
42
43 where
44 @kbd{keyno}
45 is a positive integer (between 1 and 65534),
46 @kbd{type}
47 is the message digest algorithm,
48 and
49 @kbd{key}
50 is the key itself.
51
52 The
53 @kbd{key}
54 may be given in a format
55 controlled by the
56 @kbd{type}
57 field.
58 The
59 @kbd{type}
60 @code{MD5}
61 is always supported.
62 If
63 @code{ntpd}
64 was built with the OpenSSL library
65 then any digest library supported by that library may be specified.
66 However, if compliance with FIPS 140-2 is required the
67 @kbd{type}
68 must be either
69 @code{SHA}
70 or
71 @code{SHA1}.
72
73 What follows are some key types, and corresponding formats:
74
75 @table @asis
76 @item @code{MD5}
77 The key is 1 to 16 printable characters terminated by
78 an EOL,
79 whitespace,
80 or
81 a
82 @code{#}
83 (which is the "start of comment" character).
84
85 @item @code{SHA}
86 @item @code{SHA1}
87 @item @code{RMD160}
88 The key is a hex-encoded ASCII string of 40 characters,
89 which is truncated as necessary.
90 @end table
91
92 Note that the keys used by the
93 @code{ntpq(8)}
94 and
95 @code{ntpdc(8)}
96 programs are checked against passwords
97 requested by the programs and entered by hand,
98 so it is generally appropriate to specify these keys in ASCII format.
99
100 This section was generated by @strong{AutoGen},
101 using the @code{agtexi-cmd} template and the option descriptions for the @code{ntp.keys} program.
102 This software is released under the NTP license, <http://ntp.org/license>.
103
104 @menu
105 * ntp.keys Files::                  Files
106 * ntp.keys See Also::               See Also
107 * ntp.keys Notes::                  Notes
108 @end menu
109
110 @node ntp.keys Files
111 @subsection ntp.keys Files
112 @table @asis
113 @item @file{/etc/ntp.keys}
114 the default name of the configuration file
115 @end table
116 @node ntp.keys See Also
117 @subsection ntp.keys See Also
118 @code{ntp.conf(5)},
119 @code{ntpd(1ntpdmdoc)},
120 @code{ntpdate(1ntpdatemdoc)},
121 @code{ntpdc(1ntpdcmdoc)},
122 @code{sntp(1sntpmdoc)}
123 @node ntp.keys Notes
124 @subsection ntp.keys Notes
125 This document was derived from FreeBSD.