diff options
Diffstat (limited to 'contrib/ntp/ntpd/ntp.keys.html')
| -rw-r--r-- | contrib/ntp/ntpd/ntp.keys.html | 287 |
1 files changed, 169 insertions, 118 deletions
diff --git a/contrib/ntp/ntpd/ntp.keys.html b/contrib/ntp/ntpd/ntp.keys.html index 28a4076..08d8922 100644 --- a/contrib/ntp/ntpd/ntp.keys.html +++ b/contrib/ntp/ntpd/ntp.keys.html @@ -1,103 +1,145 @@ -<html lang="en"> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ --> <head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>NTP Symmetric Key</title> -<meta http-equiv="Content-Type" content="text/html"> + <meta name="description" content="NTP Symmetric Key"> -<meta name="generator" content="makeinfo 4.7"> -<link title="Top" rel="top" href="#Top"> -<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> -<meta http-equiv="Content-Style-Type" content="text/css"> -<style type="text/css"><!-- - pre.display { font-family:inherit } - pre.format { font-family:inherit } - pre.smalldisplay { font-family:inherit; font-size:smaller } - pre.smallformat { font-family:inherit; font-size:smaller } - pre.smallexample { font-size:smaller } - pre.smalllisp { font-size:smaller } - span.sc { font-variant:small-caps } - span.roman { font-family: serif; font-weight: normal; } ---></style> +<meta name="keywords" content="NTP Symmetric Key"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="#Top" rel="start" title="Top"> +<link href="dir.html#Top" rel="up" title="(dir)"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +blockquote.smallindentedblock {margin-right: 0em; font-size: smaller} +blockquote.smallquotation {font-size: smaller} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +div.smalldisplay {margin-left: 3.2em} +div.smallexample {margin-left: 3.2em} +div.smalllisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +pre.smalldisplay {font-family: inherit; font-size: smaller} +pre.smallexample {font-size: smaller} +pre.smallformat {font-family: inherit; font-size: smaller} +pre.smalllisp {font-size: smaller} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + </head> -<body> -<h1 class="settitle">NTP Symmetric Key</h1> -<div class="node"> -<p><hr> -<a name="Top"></a>Next: <a rel="next" accesskey="n" href="#ntp_002ekeys-Description">ntp.keys Description</a>, -Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, -Up: <a rel="up" accesskey="u" href="#dir">(dir)</a> -<br> -</div> -<h2 class="unnumbered">NTP's Symmetric Key File User Manual</h2> +<body lang="en"> +<h1 class="settitle" align="center">NTP Symmetric Key</h1> -<p>This document describes the symmetric key file for the NTP Project's -<code>ntpd</code> program. - <p>This document applies to version 4.2.8p11 of <code>ntp.keys</code>. - <div class="shortcontents"> -<h2>Short Contents</h2> -<ul> -<a href="#Top">NTP's Symmetric Key File User Manual</a> -</ul> + + +<a name="Top"></a> +<div class="header"> +<p> +Next: <a href="#ntp_002ekeys-Description" accesskey="n" rel="next">ntp.keys Description</a>, Previous: <a href="dir.html#Top" accesskey="p" rel="prev">(dir)</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> </p> </div> +<a name="NTP_0027s-Symmetric-Key-File-User-Manual"></a> +<h1 class="top">NTP’s Symmetric Key File User Manual</h1> -<ul class="menu"> -<li><a accesskey="1" href="#ntp_002ekeys-Description">ntp.keys Description</a> -<li><a accesskey="2" href="#ntp_002ekeys-Notes">ntp.keys Notes</a> -</ul> +<p>This document describes the symmetric key file for the NTP Project’s +<code>ntpd</code> program. +</p> +<p>This document applies to version 4.2.8p13 of <code>ntp.keys</code>. +</p> +<a name="SEC_Overview"></a> +<h2 class="shortcontents-heading">Short Table of Contents</h2> -<div class="node"> -<p><hr> -<a name="ntp_002ekeys-Description"></a>Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>, -Up: <a rel="up" accesskey="u" href="#Top">Top</a> -<br> +<div class="shortcontents"> +<ul class="no-bullet"> +<li><a name="stoc-Description" href="#toc-Description">1 Description</a></li> +</ul> </div> -<!-- node-name, next, previous, up --> -<h3 class="section">Description</h3> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="#ntp_002ekeys-Description" accesskey="1">ntp.keys Description</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top">• <a href="#ntp_002ekeys-Notes" accesskey="2">ntp.keys Notes</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + +<hr> +<a name="ntp_002ekeys-Description"></a> +<div class="header"> +<p> +Previous: <a href="#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p> +</div> +<a name="Description"></a> +<h2 class="chapter">1 Description</h2> <p>The name and location of the symmetric key file for <code>ntpd</code> can be specified in a configuration file, by default <code>/etc/ntp.keys</code>. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="#ntp_002ekeys-Notes" accesskey="1">ntp.keys Notes</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +</table> -<div class="node"> -<p><hr> +<hr> <a name="ntp_002ekeys-Notes"></a> -<br> +<div class="header"> +<p> +Previous: <a href="#ntp_002ekeys-See-Also" accesskey="p" rel="prev">ntp.keys See Also</a>, Up: <a href="#ntp_002ekeys-Description" accesskey="u" rel="up">ntp.keys Description</a> </p> </div> +<a name="Notes-about-ntp_002ekeys"></a> +<h3 class="section">1.1 Notes about ntp.keys</h3> +<a name="index-ntp_002ekeys"></a> +<a name="index-NTP-symmetric-key-file-format"></a> -<h3 class="section">Notes about ntp.keys</h3> -<p><a name="index-ntp_002ekeys-1"></a><a name="index-NTP-symmetric-key-file-format-2"></a> - <p>This document describes the format of an NTP symmetric key file. +<p>This document describes the format of an NTP symmetric key file. For a description of the use of this type of file, see the -"Authentication Support" +"Authentication Support" section of the <code>ntp.conf(5)</code> page. - - <p><code>ntpd(8)</code> +</p> +<p><code>ntpd(8)</code> reads its keys from a file specified using the <code>-k</code> command line option or the <code>keys</code> -statement in the configuration file. +statement in the configuration file. While key number 0 is fixed by the NTP standard (as 56 zero bits) and may not be changed, -one or more keys numbered between 1 and 65534 +one or more keys numbered between 1 and 65535 may be arbitrarily set in the keys file. - - <p>The key file uses the same comment conventions -as the configuration file. +</p> +<p>The key file uses the same comment conventions +as the configuration file. Key entries use a fixed format of the form +</p> +<div class="example"> +<pre class="example"><kbd>keyno</kbd> <kbd>type</kbd> <kbd>key</kbd> <kbd>opt_IP_list</kbd> +</pre></div> -<pre class="example"> <kbd>keyno</kbd> <kbd>type</kbd> <kbd>key</kbd> <kbd>opt_IP_list</kbd> -</pre> - <p>where +<p>where <kbd>keyno</kbd> -is a positive integer (between 1 and 65534), +is a positive integer (between 1 and 65535), <kbd>type</kbd> is the message digest algorithm, <kbd>key</kbd> @@ -106,111 +148,120 @@ is the key itself, and is an optional comma-separated list of IPs where the <kbd>keyno</kbd> -should be trusted. -that are allowed to serve time. +should be trusted. +that are allowed to serve time. Each IP in <kbd>opt_IP_list</kbd> may contain an optional <code>/subnetbits</code> specification which identifies the number of bits for -the desired subnet of trust. +the desired subnet of trust. If <kbd>opt_IP_list</kbd> is empty, any properly-authenticated message will be accepted. - - <p>The +</p> +<p>The <kbd>key</kbd> may be given in a format controlled by the <kbd>type</kbd> -field. +field. The <kbd>type</kbd> <code>MD5</code> -is always supported. +is always supported. If <code>ntpd</code> was built with the OpenSSL library -then any digest library supported by that library may be specified. +then any digest library supported by that library may be specified. However, if compliance with FIPS 140-2 is required the <kbd>type</kbd> must be either <code>SHA</code> or <code>SHA1</code>. - - <p>What follows are some key types, and corresponding formats: - - <dl> -<dt><code>MD5</code><dd>The key is 1 to 16 printable characters terminated by +</p> +<p>What follows are some key types, and corresponding formats: +</p> +<dl compact="compact"> +<dt><code>MD5</code></dt> +<dd><p>The key is 1 to 16 printable characters terminated by an EOL, whitespace, or a <code>#</code> -(which is the "start of comment" character). - - <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, -which is truncated as necessary. +(which is the "start of comment" character). +</p> +</dd> +<dt><code>SHA</code></dt> +<dt><code>SHA1</code></dt> +<dt><code>RMD160</code></dt> +<dd><p>The key is a hex-encoded ASCII string of 40 characters, +which is truncated as necessary. +</p></dd> </dl> - <p>Note that the keys used by the +<p>Note that the keys used by the <code>ntpq(8)</code> and <code>ntpdc(8)</code> programs are checked against passwords requested by the programs and entered by hand, so it is generally appropriate to specify these keys in ASCII format. - - <p>This section was generated by <strong>AutoGen</strong>, -using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntp.keys</code> program. +</p> +<p>This section was generated by <strong>AutoGen</strong>, +using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntp.keys</code> program. This software is released under the NTP license, <http://ntp.org/license>. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="#ntp_002ekeys-Files" accesskey="1">ntp.keys Files</a>:</td><td> </td><td align="left" valign="top">Files +</td></tr> +<tr><td align="left" valign="top">• <a href="#ntp_002ekeys-See-Also" accesskey="2">ntp.keys See Also</a>:</td><td> </td><td align="left" valign="top">See Also +</td></tr> +<tr><td align="left" valign="top">• <a href="#ntp_002ekeys-Notes" accesskey="3">ntp.keys Notes</a>:</td><td> </td><td align="left" valign="top">Notes +</td></tr> +</table> -<ul class="menu"> -<li><a accesskey="1" href="#ntp_002ekeys-Files">ntp.keys Files</a>: Files -<li><a accesskey="2" href="#ntp_002ekeys-See-Also">ntp.keys See Also</a>: See Also -<li><a accesskey="3" href="#ntp_002ekeys-Notes">ntp.keys Notes</a>: Notes -</ul> - -<div class="node"> -<p><hr> -<a name="ntp_002ekeys-Files"></a>Next: <a rel="next" accesskey="n" href="#ntp_002ekeys-See-Also">ntp.keys See Also</a>, -Up: <a rel="up" accesskey="u" href="#ntp_002ekeys-Notes">ntp.keys Notes</a> -<br> +<hr> +<a name="ntp_002ekeys-Files"></a> +<div class="header"> +<p> +Next: <a href="#ntp_002ekeys-See-Also" accesskey="n" rel="next">ntp.keys See Also</a>, Up: <a href="#ntp_002ekeys-Notes" accesskey="u" rel="up">ntp.keys Notes</a> </p> </div> - -<h4 class="subsection">ntp.keys Files</h4> - - <dl> -<dt><span class="file">/etc/ntp.keys</span><dd>the default name of the configuration file +<a name="ntp_002ekeys-Files-1"></a> +<h4 class="subsection">1.1.1 ntp.keys Files</h4> +<dl compact="compact"> +<dt><samp>/etc/ntp.keys</samp></dt> +<dd><p>the default name of the configuration file +</p></dd> </dl> -<div class="node"> -<p><hr> -<a name="ntp_002ekeys-See-Also"></a>Next: <a rel="next" accesskey="n" href="#ntp_002ekeys-Notes">ntp.keys Notes</a>, -Previous: <a rel="previous" accesskey="p" href="#ntp_002ekeys-Files">ntp.keys Files</a>, -Up: <a rel="up" accesskey="u" href="#ntp_002ekeys-Notes">ntp.keys Notes</a> -<br> +<hr> +<a name="ntp_002ekeys-See-Also"></a> +<div class="header"> +<p> +Previous: <a href="#ntp_002ekeys-Files" accesskey="p" rel="prev">ntp.keys Files</a>, Up: <a href="#ntp_002ekeys-Notes" accesskey="u" rel="up">ntp.keys Notes</a> </p> </div> - -<h4 class="subsection">ntp.keys See Also</h4> - +<a name="ntp_002ekeys-See-Also-1"></a> +<h4 class="subsection">1.1.2 ntp.keys See Also</h4> <p><code>ntp.conf(5)</code>, <code>ntpd(1ntpdmdoc)</code>, <code>ntpdate(1ntpdatemdoc)</code>, <code>ntpdc(1ntpdcmdoc)</code>, <code>sntp(1sntpmdoc)</code> -<div class="node"> -<p><hr> -<a name="ntp_002ekeys-Notes"></a>Previous: <a rel="previous" accesskey="p" href="#ntp_002ekeys-See-Also">ntp.keys See Also</a>, -Up: <a rel="up" accesskey="u" href="#ntp_002ekeys-Notes">ntp.keys Notes</a> -<br> +</p><hr> +<div class="header"> +<p> + </p> </div> - -<h4 class="subsection">ntp.keys Notes</h4> - +<a name="ntp_002ekeys-Notes-1"></a> +<h4 class="subsection">1.1.3 ntp.keys Notes</h4> <p>This document was derived from FreeBSD. +</p><hr> + -</body></html> +</body> +</html> |
