3 <title>NTP Symmetric Key</title>
4 <meta http-equiv="Content-Type" content="text/html">
5 <meta name="description" content="NTP Symmetric Key">
6 <meta name="generator" content="makeinfo 4.7">
7 <link title="Top" rel="top" href="#Top">
8 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
9 <meta http-equiv="Content-Style-Type" content="text/css">
10 <style type="text/css"><!--
11 pre.display { font-family:inherit }
12 pre.format { font-family:inherit }
13 pre.smalldisplay { font-family:inherit; font-size:smaller }
14 pre.smallformat { font-family:inherit; font-size:smaller }
15 pre.smallexample { font-size:smaller }
16 pre.smalllisp { font-size:smaller }
17 span.sc { font-variant:small-caps }
18 span.roman { font-family: serif; font-weight: normal; }
22 <h1 class="settitle">NTP Symmetric Key</h1>
25 <a name="Top"></a>Next: <a rel="next" accesskey="n" href="#ntp_002ekeys-Description">ntp.keys Description</a>,
26 Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
27 Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
31 <h2 class="unnumbered">NTP's Symmetric Key File User Manual</h2>
33 <p>This document describes the symmetric key file for the NTP Project's
34 <code>ntpd</code> program.
36 <p>This document applies to version 4.2.8p10 of <code>ntp.keys</code>.
38 <div class="shortcontents">
39 <h2>Short Contents</h2>
41 <a href="#Top">NTP's Symmetric Key File User Manual</a>
46 <li><a accesskey="1" href="#ntp_002ekeys-Description">ntp.keys Description</a>
47 <li><a accesskey="2" href="#ntp_002ekeys-Notes">ntp.keys Notes</a>
52 <a name="ntp_002ekeys-Description"></a>Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>,
53 Up: <a rel="up" accesskey="u" href="#Top">Top</a>
57 <!-- node-name, next, previous, up -->
58 <h3 class="section">Description</h3>
60 <p>The name and location of the symmetric key file for <code>ntpd</code> can
61 be specified in a configuration file, by default <code>/etc/ntp.keys</code>.
65 <a name="ntp_002ekeys-Notes"></a>
69 <h3 class="section">Notes about ntp.keys</h3>
71 <p><a name="index-ntp_002ekeys-1"></a><a name="index-NTP-symmetric-key-file-format-2"></a>
73 <p>This document describes the format of an NTP symmetric key file.
74 For a description of the use of this type of file, see the
75 "Authentication Support"
77 <code>ntp.conf(5)</code>
80 <p><code>ntpd(8)</code>
81 reads its keys from a file specified using the
83 command line option or the
85 statement in the configuration file.
86 While key number 0 is fixed by the NTP standard
88 and may not be changed,
89 one or more keys numbered between 1 and 65534
90 may be arbitrarily set in the keys file.
92 <p>The key file uses the same comment conventions
93 as the configuration file.
94 Key entries use a fixed format of the form
96 <pre class="example"> <kbd>keyno</kbd> <kbd>type</kbd> <kbd>key</kbd> <kbd>opt_IP_list</kbd>
100 is a positive integer (between 1 and 65534),
102 is the message digest algorithm,
105 is the key itself, and
106 <kbd>opt_IP_list</kbd>
107 is an optional comma-separated list of IPs
108 that are allowed to serve time.
110 <kbd>opt_IP_list</kbd>
112 any properly-authenticated server message will be
117 may be given in a format
127 was built with the OpenSSL library
128 then any digest library supported by that library may be specified.
129 However, if compliance with FIPS 140-2 is required the
136 <p>What follows are some key types, and corresponding formats:
139 <dt><code>MD5</code><dd>The key is 1 to 16 printable characters terminated by
145 (which is the "start of comment" character).
147 <br><dt><code>SHA</code><br><dt><code>SHA1</code><br><dt><code>RMD160</code><dd>The key is a hex-encoded ASCII string of 40 characters,
148 which is truncated as necessary.
151 <p>Note that the keys used by the
154 <code>ntpdc(8)</code>
155 programs are checked against passwords
156 requested by the programs and entered by hand,
157 so it is generally appropriate to specify these keys in ASCII format.
159 <p>This section was generated by <strong>AutoGen</strong>,
160 using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntp.keys</code> program.
161 This software is released under the NTP license, <http://ntp.org/license>.
164 <li><a accesskey="1" href="#ntp_002ekeys-Files">ntp.keys Files</a>: Files
165 <li><a accesskey="2" href="#ntp_002ekeys-See-Also">ntp.keys See Also</a>: See Also
166 <li><a accesskey="3" href="#ntp_002ekeys-Notes">ntp.keys Notes</a>: Notes
171 <a name="ntp_002ekeys-Files"></a>Next: <a rel="next" accesskey="n" href="#ntp_002ekeys-See-Also">ntp.keys See Also</a>,
172 Up: <a rel="up" accesskey="u" href="#ntp_002ekeys-Notes">ntp.keys Notes</a>
176 <h4 class="subsection">ntp.keys Files</h4>
179 <dt><span class="file">/etc/ntp.keys</span><dd>the default name of the configuration file
183 <a name="ntp_002ekeys-See-Also"></a>Next: <a rel="next" accesskey="n" href="#ntp_002ekeys-Notes">ntp.keys Notes</a>,
184 Previous: <a rel="previous" accesskey="p" href="#ntp_002ekeys-Files">ntp.keys Files</a>,
185 Up: <a rel="up" accesskey="u" href="#ntp_002ekeys-Notes">ntp.keys Notes</a>
189 <h4 class="subsection">ntp.keys See Also</h4>
191 <p><code>ntp.conf(5)</code>,
192 <code>ntpd(1ntpdmdoc)</code>,
193 <code>ntpdate(1ntpdatemdoc)</code>,
194 <code>ntpdc(1ntpdcmdoc)</code>,
195 <code>sntp(1sntpmdoc)</code>
198 <a name="ntp_002ekeys-Notes"></a>Previous: <a rel="previous" accesskey="p" href="#ntp_002ekeys-See-Also">ntp.keys See Also</a>,
199 Up: <a rel="up" accesskey="u" href="#ntp_002ekeys-Notes">ntp.keys Notes</a>
203 <h4 class="subsection">ntp.keys Notes</h4>
205 <p>This document was derived from FreeBSD.