1<html lang="en"> 2<head> 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.8"> 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; } 19 span.sansserif { font-family:sans-serif; font-weight:normal; } 20--></style> 21</head> 22<body> 23<h1 class="settitle">NTP Symmetric Key</h1> 24<div class="node"> 25<p><hr> 26<a name="Top"></a> 27Next: <a rel="next" accesskey="n" href="#ntp_002ekeys-Description">ntp.keys Description</a>, 28Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 29Up: <a rel="up" accesskey="u" href="#dir">(dir)</a> 30 31</div> 32 33<h2 class="unnumbered">NTP's Symmetric Key File User Manual</h2> 34 35<p>This document describes the symmetric key file for the NTP Project's 36<code>ntpd</code> program. 37 38 <p>This document applies to version 4.2.8p5 of <code>ntp.keys</code>. 39 40 <div class="shortcontents"> 41<h2>Short Contents</h2> 42<ul> 43<a href="#Top">NTP's Symmetric Key File User Manual</a> 44</ul> 45</div> 46 47<ul class="menu"> 48<li><a accesskey="1" href="#ntp_002ekeys-Description">ntp.keys Description</a> 49<li><a accesskey="2" href="#ntp_002ekeys-Notes">ntp.keys Notes</a> 50</ul> 51 52<div class="node"> 53<p><hr> 54<a name="ntp.keys-Description"></a> 55<a name="ntp_002ekeys-Description"></a> 56Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>, 57Up: <a rel="up" accesskey="u" href="#Top">Top</a> 58 59</div> 60 61<!-- node-name, next, previous, up --> 62<h3 class="section">Description</h3> 63 64<p>The name and location of the symmetric key file for <code>ntpd</code> can 65be specified in a configuration file, by default <code>/etc/ntp.keys</code>. 66 67<div class="node"> 68<p><hr> 69<a name="ntp.keys-Notes"></a> 70<a name="ntp_002ekeys-Notes"></a> 71 72 73</div> 74 75<h3 class="section">Notes about ntp.keys</h3> 76 77<p><a name="index-ntp_002ekeys-1"></a><a name="index-NTP-symmetric-key-file-format-2"></a> 78 79 <p>This document describes the format of an NTP symmetric key file. 80For a description of the use of this type of file, see the 81"Authentication Support" 82section of the 83<code>ntp.conf(5)</code> 84page. 85 86 <p><code>ntpd(8)</code> 87reads its keys from a file specified using the 88<code>-k</code> 89command line option or the 90<code>keys</code> 91statement in the configuration file. 92While key number 0 is fixed by the NTP standard 93(as 56 zero bits) 94and may not be changed, 95one or more keys numbered between 1 and 65534 96may be arbitrarily set in the keys file. 97 98 <p>The key file uses the same comment conventions 99as the configuration file. 100Key entries use a fixed format of the form 101 102<pre class="example"> <kbd>keyno</kbd> <kbd>type</kbd> <kbd>key</kbd> 103</pre> 104 <p>where 105<kbd>keyno</kbd> 106is a positive integer (between 1 and 65534), 107<kbd>type</kbd> 108is the message digest algorithm, 109and 110<kbd>key</kbd> 111is the key itself. 112 113 <p>The 114<kbd>key</kbd> 115may be given in a format 116controlled by the 117<kbd>type</kbd> 118field. 119The 120<kbd>type</kbd> 121<code>MD5</code> 122is always supported. 123If 124<code>ntpd</code> 125was built with the OpenSSL library 126then any digest library supported by that library may be specified. 127However, if compliance with FIPS 140-2 is required the 128<kbd>type</kbd> 129must be either 130<code>SHA</code> 131or 132<code>SHA1</code>. 133 134 <p>What follows are some key types, and corresponding formats: 135 136 <dl> 137<dt><code>MD5</code><dd>The key is 1 to 16 printable characters terminated by 138an EOL, 139whitespace, 140or 141a 142<code>#</code> 143(which is the "start of comment" character). 144 145 <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, 146which is truncated as necessary. 147</dl> 148 149 <p>Note that the keys used by the 150<code>ntpq(8)</code> 151and 152<code>ntpdc(8)</code> 153programs are checked against passwords 154requested by the programs and entered by hand, 155so it is generally appropriate to specify these keys in ASCII format. 156 157 <p>This section was generated by <strong>AutoGen</strong>, 158using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntp.keys</code> program. 159This software is released under the NTP license, <http://ntp.org/license>. 160 161<ul class="menu"> 162<li><a accesskey="1" href="#ntp_002ekeys-Files">ntp.keys Files</a>: Files 163<li><a accesskey="2" href="#ntp_002ekeys-See-Also">ntp.keys See Also</a>: See Also 164<li><a accesskey="3" href="#ntp_002ekeys-Notes">ntp.keys Notes</a>: Notes 165</ul> 166 167<div class="node"> 168<p><hr> 169<a name="ntp.keys-Files"></a> 170<a name="ntp_002ekeys-Files"></a> 171Next: <a rel="next" accesskey="n" href="#ntp_002ekeys-See-Also">ntp.keys See Also</a>, 172Up: <a rel="up" accesskey="u" href="#ntp_002ekeys-Notes">ntp.keys Notes</a> 173 174</div> 175 176<h4 class="subsection">ntp.keys Files</h4> 177 178 <dl> 179<dt><samp><span class="file">/etc/ntp.keys</span></samp><dd>the default name of the configuration file 180</dl> 181<div class="node"> 182<p><hr> 183<a name="ntp.keys-See-Also"></a> 184<a name="ntp_002ekeys-See-Also"></a> 185Next: <a rel="next" accesskey="n" href="#ntp_002ekeys-Notes">ntp.keys Notes</a>, 186Previous: <a rel="previous" accesskey="p" href="#ntp_002ekeys-Files">ntp.keys Files</a>, 187Up: <a rel="up" accesskey="u" href="#ntp_002ekeys-Notes">ntp.keys Notes</a> 188 189</div> 190 191<h4 class="subsection">ntp.keys See Also</h4> 192 193<p><code>ntp.conf(5)</code>, 194<code>ntpd(1ntpdmdoc)</code>, 195<code>ntpdate(1ntpdatemdoc)</code>, 196<code>ntpdc(1ntpdcmdoc)</code>, 197<code>sntp(1sntpmdoc)</code> 198<div class="node"> 199<p><hr> 200<a name="ntp.keys-Notes"></a> 201<a name="ntp_002ekeys-Notes"></a> 202Previous: <a rel="previous" accesskey="p" href="#ntp_002ekeys-See-Also">ntp.keys See Also</a>, 203Up: <a rel="up" accesskey="u" href="#ntp_002ekeys-Notes">ntp.keys Notes</a> 204 205</div> 206 207<h4 class="subsection">ntp.keys Notes</h4> 208 209<p>This document was derived from FreeBSD. 210 211</body></html> 212 213