/contrib/bind9/bin/rndc/rndc.conf.html
HTML | 217 lines | 200 code | 0 blank | 17 comment | 0 complexity | 4355acb71259276d397908f593601137 MD5 | raw file
Possible License(s): MPL-2.0-no-copyleft-exception, BSD-3-Clause, LGPL-2.0, LGPL-2.1, BSD-2-Clause, 0BSD, JSON, AGPL-1.0, GPL-2.0
1<!-- 2 - Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC") 3 - Copyright (C) 2000, 2001 Internet Software Consortium. 4 - 5 - Permission to use, copy, modify, and/or distribute this software for any 6 - purpose with or without fee is hereby granted, provided that the above 7 - copyright notice and this permission notice appear in all copies. 8 - 9 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH 10 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 11 - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, 12 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 13 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE 14 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 15 - PERFORMANCE OF THIS SOFTWARE. 16--> 17<!-- $Id$ --> 18<html> 19<head> 20<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> 21<title>rndc.conf</title> 22<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> 23</head> 24<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> 25<a name="man.rndc.conf"></a><div class="titlepage"></div> 26<div class="refnamediv"> 27<h2>Name</h2> 28<p><code class="filename">rndc.conf</code> — rndc configuration file</p> 29</div> 30<div class="refsynopsisdiv"> 31<h2>Synopsis</h2> 32<div class="cmdsynopsis"><p><code class="command">rndc.conf</code> </p></div> 33</div> 34<div class="refsect1" lang="en"> 35<a name="id2543354"></a><h2>DESCRIPTION</h2> 36<p><code class="filename">rndc.conf</code> is the configuration file 37 for <span><strong class="command">rndc</strong></span>, the BIND 9 name server control 38 utility. This file has a similar structure and syntax to 39 <code class="filename">named.conf</code>. Statements are enclosed 40 in braces and terminated with a semi-colon. Clauses in 41 the statements are also semi-colon terminated. The usual 42 comment styles are supported: 43 </p> 44<p> 45 C style: /* */ 46 </p> 47<p> 48 C++ style: // to end of line 49 </p> 50<p> 51 Unix style: # to end of line 52 </p> 53<p><code class="filename">rndc.conf</code> is much simpler than 54 <code class="filename">named.conf</code>. The file uses three 55 statements: an options statement, a server statement 56 and a key statement. 57 </p> 58<p> 59 The <code class="option">options</code> statement contains five clauses. 60 The <code class="option">default-server</code> clause is followed by the 61 name or address of a name server. This host will be used when 62 no name server is given as an argument to 63 <span><strong class="command">rndc</strong></span>. The <code class="option">default-key</code> 64 clause is followed by the name of a key which is identified by 65 a <code class="option">key</code> statement. If no 66 <code class="option">keyid</code> is provided on the rndc command line, 67 and no <code class="option">key</code> clause is found in a matching 68 <code class="option">server</code> statement, this default key will be 69 used to authenticate the server's commands and responses. The 70 <code class="option">default-port</code> clause is followed by the port 71 to connect to on the remote name server. If no 72 <code class="option">port</code> option is provided on the rndc command 73 line, and no <code class="option">port</code> clause is found in a 74 matching <code class="option">server</code> statement, this default port 75 will be used to connect. 76 The <code class="option">default-source-address</code> and 77 <code class="option">default-source-address-v6</code> clauses which 78 can be used to set the IPv4 and IPv6 source addresses 79 respectively. 80 </p> 81<p> 82 After the <code class="option">server</code> keyword, the server 83 statement includes a string which is the hostname or address 84 for a name server. The statement has three possible clauses: 85 <code class="option">key</code>, <code class="option">port</code> and 86 <code class="option">addresses</code>. The key name must match the 87 name of a key statement in the file. The port number 88 specifies the port to connect to. If an <code class="option">addresses</code> 89 clause is supplied these addresses will be used instead of 90 the server name. Each address can take an optional port. 91 If an <code class="option">source-address</code> or <code class="option">source-address-v6</code> 92 of supplied then these will be used to specify the IPv4 and IPv6 93 source addresses respectively. 94 </p> 95<p> 96 The <code class="option">key</code> statement begins with an identifying 97 string, the name of the key. The statement has two clauses. 98 <code class="option">algorithm</code> identifies the encryption algorithm 99 for <span><strong class="command">rndc</strong></span> to use; currently only HMAC-MD5 100 is 101 supported. This is followed by a secret clause which contains 102 the base-64 encoding of the algorithm's encryption key. The 103 base-64 string is enclosed in double quotes. 104 </p> 105<p> 106 There are two common ways to generate the base-64 string for the 107 secret. The BIND 9 program <span><strong class="command">rndc-confgen</strong></span> 108 can 109 be used to generate a random key, or the 110 <span><strong class="command">mmencode</strong></span> program, also known as 111 <span><strong class="command">mimencode</strong></span>, can be used to generate a 112 base-64 113 string from known input. <span><strong class="command">mmencode</strong></span> does 114 not 115 ship with BIND 9 but is available on many systems. See the 116 EXAMPLE section for sample command lines for each. 117 </p> 118</div> 119<div class="refsect1" lang="en"> 120<a name="id2543502"></a><h2>EXAMPLE</h2> 121<pre class="programlisting"> 122 options { 123 default-server localhost; 124 default-key samplekey; 125 }; 126</pre> 127<p> 128 </p> 129<pre class="programlisting"> 130 server localhost { 131 key samplekey; 132 }; 133</pre> 134<p> 135 </p> 136<pre class="programlisting"> 137 server testserver { 138 key testkey; 139 addresses { localhost port 5353; }; 140 }; 141</pre> 142<p> 143 </p> 144<pre class="programlisting"> 145 key samplekey { 146 algorithm hmac-md5; 147 secret "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz"; 148 }; 149</pre> 150<p> 151 </p> 152<pre class="programlisting"> 153 key testkey { 154 algorithm hmac-md5; 155 secret "R3HI8P6BKw9ZwXwN3VZKuQ=="; 156 }; 157 </pre> 158<p> 159 </p> 160<p> 161 In the above example, <span><strong class="command">rndc</strong></span> will by 162 default use 163 the server at localhost (127.0.0.1) and the key called samplekey. 164 Commands to the localhost server will use the samplekey key, which 165 must also be defined in the server's configuration file with the 166 same name and secret. The key statement indicates that samplekey 167 uses the HMAC-MD5 algorithm and its secret clause contains the 168 base-64 encoding of the HMAC-MD5 secret enclosed in double quotes. 169 </p> 170<p> 171 If <span><strong class="command">rndc -s testserver</strong></span> is used then <span><strong class="command">rndc</strong></span> will 172 connect to server on localhost port 5353 using the key testkey. 173 </p> 174<p> 175 To generate a random secret with <span><strong class="command">rndc-confgen</strong></span>: 176 </p> 177<p><strong class="userinput"><code>rndc-confgen</code></strong> 178 </p> 179<p> 180 A complete <code class="filename">rndc.conf</code> file, including 181 the 182 randomly generated key, will be written to the standard 183 output. Commented-out <code class="option">key</code> and 184 <code class="option">controls</code> statements for 185 <code class="filename">named.conf</code> are also printed. 186 </p> 187<p> 188 To generate a base-64 secret with <span><strong class="command">mmencode</strong></span>: 189 </p> 190<p><strong class="userinput"><code>echo "known plaintext for a secret" | mmencode</code></strong> 191 </p> 192</div> 193<div class="refsect1" lang="en"> 194<a name="id2543594"></a><h2>NAME SERVER CONFIGURATION</h2> 195<p> 196 The name server must be configured to accept rndc connections and 197 to recognize the key specified in the <code class="filename">rndc.conf</code> 198 file, using the controls statement in <code class="filename">named.conf</code>. 199 See the sections on the <code class="option">controls</code> statement in the 200 BIND 9 Administrator Reference Manual for details. 201 </p> 202</div> 203<div class="refsect1" lang="en"> 204<a name="id2543616"></a><h2>SEE ALSO</h2> 205<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>, 206 <span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</span>, 207 <span class="citerefentry"><span class="refentrytitle">mmencode</span>(1)</span>, 208 <em class="citetitle">BIND 9 Administrator Reference Manual</em>. 209 </p> 210</div> 211<div class="refsect1" lang="en"> 212<a name="id2543654"></a><h2>AUTHOR</h2> 213<p><span class="corpauthor">Internet Systems Consortium</span> 214 </p> 215</div> 216</div></body> 217</html>