xref: /freebsd/contrib/ntp/html/accopt.html (revision 7263c8c0998402e9860a0865013fbec4ece98cd4)
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
5<meta name="generator" content="HTML Tidy, see www.w3.org">
6<title>Access Control Commands and Options</title>
7<!-- Changed by: Harlan &, 13-Nov-2014 -->
8<link href="scripts/style.css" type="text/css" rel="stylesheet">
9<style type="text/css">
10<!--
11<style1 {
12color: #FF0000;
13 font-weight: bold;
14}
15-->
16</style>
17</head>
18<body>
19<h3>Access Control Commands and Options</h3>
20<img src="pic/pogo6.gif" alt="gif" align="left"><a href="http://www.eecis.udel.edu/~mills/pictures.html">from <i>Pogo</i>, Walt Kelly</a>
21<p>The skunk watches for intruders and sprays.</p>
22<p>Last update:
23  <!-- #BeginDate format:En2m -->13-Nov-2014  03:00<!-- #EndDate -->
24  UTC</p>
25<br clear="left">
26<h4>Related Links</h4>
27<script type="text/javascript" language="javascript" src="scripts/command.txt"></script>
28<script type="text/javascript" language="javascript" src="scripts/accopt.txt"></script>
29<hr>
30<h4>Commands and Options</h4>
31<p>Unless noted otherwise, further information about these ccommands is on the <a href="accopt.html">Access Control Support</a> page.</p>
32<dl>
33  <dt id="discard"><tt>discard [ average <i>avg</i> ][ minimum <i>min</i> ] [ monitor <i>prob</i> ]</tt></dt>
34  <dd>Set the parameters of the rate control facility which protects the server from client abuse. If the <tt>limited</tt> flag is present in the ACL, packets that violate these limits are discarded. If, in addition, the <tt>kod</tt> flag is present, a kiss-o'-death packet is returned. See the <a href="rate.html">Rate Management</a> page for further information. The options are:
35    <dl>
36      <dt><tt>average <i>avg</i></tt></dt>
37      <dd>Specify the minimum average interpacket spacing (minimum average headway
38        time) in log<sub>2</sub> s with default 3.</dd>
39      <dt><tt>minimum <i>min</i></tt></dt>
40      <dd>Specify the minimum interpacket spacing (guard time) in seconds with default 2.</dd>
41      <dt><tt>monitor</tt></dt>
42      <dd>Specify the probability of being recorded for packets that overflow the MRU list size limit set by <tt>mru maxmem</tt> or <tt>mru maxdepth</tt>. This is a performance optimization for servers with aggregate arrivals of 1000 packets per second or more.</dd>
43    </dl>
44  </dd>
45  <dt id="restrict"><tt>restrict default [<i>flag</i>][...]<br>
46    restrict source [<i>flag</i>][...]<br>
47    restrict <i>address</i> [mask <i>mask</i>] [<i>flag</i>][...]</tt></dt>
48  <dd>The <tt><i>address</i></tt> argument expressed in dotted-quad form is the address of a host or network. Alternatively, the <tt><i>address</i></tt> argument can be a valid host DNS name. The <tt><i>mask</i></tt> argument expressed in IPv4 or IPv6 numeric address form defaults to all mask bits on, meaning that the <tt><i>address</i></tt> is treated as the address of an individual host. A default entry (address 0.0.0.0,	mask 0.0.0.0 for IPv4 and address :: mask :: for IPv6) is always the first entry in the list. <tt>restrict default</tt>, with no mask option, modifies both IPv4 and IPv6 default entries. <tt>restrict source</tt> configures a template restriction automatically added at runtime for each association, whether configured, ephemeral, or preemptible, and removed when the association is demobilized.</dd>
49  <dd>Some flags have the effect to deny service, some  have the effect to enable service and some are  conditioned by other flags. The  flags. are not orthogonal, in that more restrictive flags will often make less restrictive ones redundant. The flags that deny service are classed in two categories, those that restrict time service and those that restrict informational queries and attempts to do run-time reconfiguration of the server. One or more of the following flags may be specified:</dd>
50  <dd>
51    <dl>
52      <dt><tt>flake</tt></dt>
53      <dd>Discard received NTP packets with probability 0.1; that is, on average drop one packet in ten. This is for testing and amusement. The name comes from Bob Braden's <i>flakeway</i>, which once did a similar thing for early Internet testing.</dd>
54      <dt><tt>ignore</tt></dt>
55      <dd>Deny packets of all kinds, including <tt>ntpq</tt> and <tt>ntpdc</tt> queries.</dd>
56      <dt><tt>kod</tt></dt>
57      <dd>Send a kiss-o'-death (KoD) packet if the <tt>limited</tt> flag is present and a packet violates the rate limits established by the <tt>discard</tt> command. KoD packets are themselves rate limited for each source address separately. If the <tt>kod</tt> flag is used in a restriction which does not have the <tt>limited</tt> flag, no KoD responses will result.</dd>
58      <dt id="limited"><tt>limited</tt></dt>
59      <dd>Deny time service if the packet violates the rate limits established by the <tt>discard</tt> command. This does not apply to <tt>ntpq</tt> and <tt>ntpdc</tt> queries.</dd>
60      <dt><tt>lowpriotrap</tt></dt>
61      <dd>Declare traps set by matching hosts to be low priority. The number of traps a server can maintain is limited (the current limit is 3). Traps are usually assigned on a first come, first served basis, with later trap requestors being denied service. This flag modifies the assignment algorithm by allowing low priority traps to be overridden by later requests for normal priority traps.</dd>
62      <dt><tt>mssntp</tt></dt>
63      <dd>Enable Microsoft Windows MS-SNTP authentication using Active Directory services. <span class="style1"><b>Note: Potential users should be aware that these services involve a TCP connection to another process that could potentially block, denying services to other users. Therefore, this flag should be used only for a dedicated  server with no clients other than MS-SNTP.</b></span></dd>
64      <dt><tt>nomodify</tt></dt>
65      <dd>Deny <tt>ntpq</tt> and <tt>ntpdc</tt> queries which attempt to modify the state of the server (i.e., run time reconfiguration). Queries which return information are permitted.</dd>
66      <dt><tt>noquery</tt></dt>
67      <dd>Deny <tt>ntpq</tt> and <tt>ntpdc</tt> queries. Time service is not affected.</dd>
68      <dt><tt>nopeer</tt></dt>
69      <dd>Deny packets that might mobilize an association unless authenticated. This includes broadcast, symmetric-active and manycast server packets when a configured association does not exist. It also includes <tt>pool</tt> associations, so if you want to use servers from a <tt>pool</tt> directive and also want to use <tt>nopeer</tt> by default, you'll want a <tt>"restrict source ..."</tt> line as well that does <i>not</i> include the <tt>nopeer</tt> directive.  Note that this flag does not apply to packets that do not attempt to mobilize an association. </dd>
70      <dt><tt>noserve</tt></dt>
71      <dd>Deny all packets except <tt>ntpq</tt> and <tt>ntpdc</tt> queries.</dd>
72      <dt><tt>notrap</tt></dt>
73      <dd>Decline to provide mode 6 control message trap service to matching hosts. The trap service is a subsystem of the <tt>ntpdc</tt> control message protocol which is intended for use by remote event logging programs.</dd>
74      <dt><tt>notrust</tt></dt>
75      <dd>Deny packets that are not cryptographically authenticated. Note carefully how this flag interacts with the <tt>auth</tt> option of the <tt>enable</tt> and <tt>disable</tt> commands. If <tt>auth</tt> is enabled, which is the default, authentication is required for all packets that might mobilize  an association. If <tt>auth</tt> is disabled, but the <tt>notrust</tt> flag is not present, an association can be mobilized whether or not authenticated. If <tt>auth</tt> is disabled, but the <tt>notrust</tt> flag is present, authentication is required only for the specified address/mask range. </dd>
76      <dt><tt>ntpport</tt></dt>
77      <dd>This is actually a match algorithm modifier, rather than a restriction
78        flag. Its presence causes the restriction entry to be matched only if the
79        source port in the packet is the standard NTP UDP port (123). A restrict line
80        containing <tt>ntpport</tt> is considered more specific than one with the
81        same address and mask, but lacking <tt>ntpport</tt>.</dd>
82      <dt><tt>version</tt></dt>
83      <dd>Deny packets that do not match the current NTP version.</dd>
84    </dl>
85  </dd>
86  <dd>Default restriction list entries with the flags <tt>ignore, ntpport</tt>, for each of the local host's interface addresses are inserted into the table at startup to prevent the server from attempting to synchronize to its own time. A default entry is also always present, though if it is otherwise unconfigured; no flags are associated with the default entry (i.e., everything besides your own NTP server is unrestricted).</dd>
87</dl>
88<hr>
89<script type="text/javascript" language="javascript" src="scripts/footer.txt"></script>
90</body>
91</html>
92