ntp-keygen.html revision 1.1.1.6
1 1.1 christos <html lang="en"> 2 1.1 christos <head> 3 1.1 christos <title>Ntp-keygen User's Manual</title> 4 1.1 christos <meta http-equiv="Content-Type" content="text/html"> 5 1.1 christos <meta name="description" content="Ntp-keygen User's Manual"> 6 1.1.1.6 christos <meta name="generator" content="makeinfo 4.8"> 7 1.1 christos <link title="Top" rel="top" href="#Top"> 8 1.1 christos <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 9 1.1 christos <meta http-equiv="Content-Style-Type" content="text/css"> 10 1.1 christos <style type="text/css"><!-- 11 1.1 christos pre.display { font-family:inherit } 12 1.1 christos pre.format { font-family:inherit } 13 1.1 christos pre.smalldisplay { font-family:inherit; font-size:smaller } 14 1.1 christos pre.smallformat { font-family:inherit; font-size:smaller } 15 1.1 christos pre.smallexample { font-size:smaller } 16 1.1 christos pre.smalllisp { font-size:smaller } 17 1.1.1.6 christos span.sc { font-variant:small-caps } 18 1.1.1.6 christos span.roman { font-family:serif; font-weight:normal; } 19 1.1.1.6 christos span.sansserif { font-family:sans-serif; font-weight:normal; } 20 1.1 christos --></style> 21 1.1 christos </head> 22 1.1 christos <body> 23 1.1 christos <h1 class="settitle">Ntp-keygen User's Manual</h1> 24 1.1 christos <div class="shortcontents"> 25 1.1 christos <h2>Short Contents</h2> 26 1.1 christos <ul> 27 1.1 christos <a href="#Top">Top</a> 28 1.1 christos <a href="#Top">NTP Key Generation Program User Manual</a> 29 1.1 christos </ul> 30 1.1 christos </div> 31 1.1 christos 32 1.1 christos 33 1.1 christos 34 1.1 christos <div class="node"> 35 1.1 christos <p><hr> 36 1.1.1.6 christos <a name="Top"></a> 37 1.1.1.6 christos Up: <a rel="up" accesskey="u" href="#dir">(dir)</a> 38 1.1.1.6 christos 39 1.1 christos </div> 40 1.1 christos 41 1.1 christos <h2 class="unnumbered">Top</h2> 42 1.1 christos 43 1.1 christos <ul class="menu"> 44 1.1 christos <li><a accesskey="1" href="#Description">Description</a> 45 1.1 christos <li><a accesskey="2" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a>: Invoking ntp-keygen 46 1.1 christos <li><a accesskey="3" href="#Running-the-Program">Running the Program</a> 47 1.1 christos <li><a accesskey="4" href="#Random-Seed-File">Random Seed File</a> 48 1.1 christos <li><a accesskey="5" href="#Cryptographic-Data-Files">Cryptographic Data Files</a> 49 1.1 christos </ul> 50 1.1 christos 51 1.1 christos <div class="node"> 52 1.1 christos <p><hr> 53 1.1.1.6 christos <a name="Top"></a> 54 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#Description">Description</a>, 55 1.1 christos Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>, 56 1.1 christos Up: <a rel="up" accesskey="u" href="#dir">(dir)</a> 57 1.1.1.6 christos 58 1.1 christos </div> 59 1.1 christos 60 1.1 christos <h2 class="unnumbered">NTP Key Generation Program User Manual</h2> 61 1.1 christos 62 1.1 christos <p>This document describes the use of the NTP Project's <code>ntp-keygen</code> 63 1.1 christos program, that generates cryptographic data files used by the NTPv4 64 1.1 christos authentication and identity schemes. 65 1.1 christos It can generate message digest keys used in symmetric key cryptography and, 66 1.1 christos if the OpenSSL software 67 1.1 christos library has been installed, it can generate host keys, sign keys, 68 1.1 christos certificates, and identity keys and parameters used by the Autokey 69 1.1 christos public key cryptography. 70 1.1 christos The message digest keys file is generated in a 71 1.1 christos format compatible with NTPv3. 72 1.1 christos All other files are in PEM-encoded 73 1.1 christos printable ASCII format so they can be embedded as MIME attachments in 74 1.1 christos mail to other sites. 75 1.1 christos 76 1.1.1.6 christos <p>This document applies to version 4.2.8p5 of <code>ntp-keygen</code>. 77 1.1 christos 78 1.1 christos <div class="node"> 79 1.1 christos <p><hr> 80 1.1.1.6 christos <a name="Description"></a> 81 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#Running-the-Program">Running the Program</a>, 82 1.1 christos Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>, 83 1.1 christos Up: <a rel="up" accesskey="u" href="#Top">Top</a> 84 1.1.1.6 christos 85 1.1 christos </div> 86 1.1 christos 87 1.1 christos <!-- node-name, next, previous, up --> 88 1.1 christos <h3 class="section">Description</h3> 89 1.1 christos 90 1.1 christos <p>This program generates cryptographic data files used by the NTPv4 91 1.1 christos authentication and identity schemes. It can generate message digest 92 1.1 christos keys used in symmetric key cryptography and, if the OpenSSL software 93 1.1 christos library has been installed, it can generate host keys, sign keys, 94 1.1 christos certificates, and identity keys and parameters used by the Autokey 95 1.1 christos public key cryptography. The message digest keys file is generated in a 96 1.1 christos format compatible with NTPv3. All other files are in PEM-encoded 97 1.1 christos printable ASCII format so they can be embedded as MIME attachments in 98 1.1 christos mail to other sites. 99 1.1 christos 100 1.1 christos <p>When used to generate message digest keys, the program produces a file 101 1.1 christos containing ten pseudo-random printable ASCII strings suitable for the 102 1.1 christos MD5 message digest algorithm included in the distribution. 103 1.1 christos If the 104 1.1 christos OpenSSL library is installed, it produces an additional ten hex-encoded 105 1.1 christos random bit strings suitable for the SHA1 and other message digest 106 1.1 christos algorithms. 107 1.1 christos The message digest keys file must be distributed and stored 108 1.1 christos using secure means beyond the scope of NTP itself. 109 1.1 christos Besides the keys 110 1.1 christos used for ordinary NTP associations, additional keys can be defined as 111 1.1 christos passwords for the ntpq and ntpdc utility programs. 112 1.1 christos 113 1.1 christos <p>The remaining generated files are compatible with other OpenSSL 114 1.1 christos applications and other Public Key Infrastructure (PKI) resources. 115 1.1 christos Certificates generated by this program are compatible with extant 116 1.1 christos industry practice, although some users might find the interpretation of 117 1.1 christos X509v3 extension fields somewhat liberal. 118 1.1 christos However, the identity keys 119 1.1 christos are probably not compatible with anything other than Autokey. 120 1.1 christos 121 1.1 christos <p>Some files used by this program are encrypted using a private password. 122 1.1 christos The <code>-p</code> option specifies the password for local encrypted files and the 123 1.1 christos <code>-q</code> option the password for encrypted files sent to remote sites. 124 1.1 christos If no password is specified, the host name returned by the Unix 125 1.1 christos <code>gethostname()</code> function, normally the DNS name of the host, is used. 126 1.1 christos 127 1.1 christos <p>The <kbd>pw</kbd> option of the <code>crypto</code> configuration command 128 1.1 christos specifies the read password for previously encrypted local files. 129 1.1 christos This must match the local password used by this program. 130 1.1 christos If not specified, the host name is used. 131 1.1 christos Thus, if files are generated by this program without password, 132 1.1 christos they can be read back by ntpd without password, but only on the same 133 1.1 christos host. 134 1.1 christos 135 1.1 christos <p>Normally, encrypted files for each host are generated by that host and 136 1.1 christos used only by that host, although exceptions exist as noted later on 137 1.1 christos this page. 138 1.1 christos The symmetric keys file, normally called <code>ntp.keys</code>, is 139 1.1 christos usually installed in <code>/etc</code>. 140 1.1 christos Other files and links are usually installed 141 1.1 christos in <code>/usr/local/etc</code>, which is normally in a shared filesystem in 142 1.1 christos NFS-mounted networks and cannot be changed by shared clients. 143 1.1 christos The location of the keys directory can be changed by the keysdir 144 1.1 christos configuration command in such cases. 145 1.1 christos Normally, this is in <code>/etc</code>. 146 1.1 christos 147 1.1 christos <p>This program directs commentary and error messages to the standard 148 1.1 christos error stream <code>stderr</code> and remote files to the standard output stream 149 1.1 christos <code>stdout</code> where they can be piped to other applications or redirected to 150 1.1 christos files. 151 1.1 christos The names used for generated files and links all begin with the 152 1.1 christos string <code>ntpkey</code> and include the file type, 153 1.1 christos generating host and filestamp, 154 1.1 christos as described in the <a href="#Cryptographic-Data-Files">Cryptographic Data Files</a> section below. 155 1.1 christos 156 1.1 christos <div class="node"> 157 1.1 christos <p><hr> 158 1.1.1.6 christos <a name="Running-the-Program"></a> 159 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#Random-Seed-File">Random Seed File</a>, 160 1.1 christos Previous: <a rel="previous" accesskey="p" href="#Description">Description</a>, 161 1.1 christos Up: <a rel="up" accesskey="u" href="#Top">Top</a> 162 1.1.1.6 christos 163 1.1 christos </div> 164 1.1 christos 165 1.1 christos <!-- node-name, next, previous, up --> 166 1.1 christos <h3 class="section">Running the Program</h3> 167 1.1 christos 168 1.1 christos <p>To test and gain experience with Autokey concepts, log in as root and 169 1.1 christos change to the keys directory, usually <code>/usr/local/etc</code>. 170 1.1 christos When run for the 171 1.1 christos first time, or if all files with names beginning <code>ntpkey</code>] have been 172 1.1 christos removed, use the <code>ntp-keygen</code> command without arguments to generate a 173 1.1 christos default RSA host key and matching RSA-MD5 certificate with expiration 174 1.1 christos date one year hence. 175 1.1 christos If run again without options, the program uses the 176 1.1 christos existing keys and parameters and generates only a new certificate with 177 1.1 christos new expiration date one year hence. 178 1.1 christos 179 1.1 christos <p>Run the command on as many hosts as necessary. 180 1.1 christos Designate one of them as the trusted host (TH) using <code>ntp-keygen</code> 181 1.1 christos with the <code>-T</code> option and configure 182 1.1 christos it to synchronize from reliable Internet servers. 183 1.1 christos Then configure the other hosts to synchronize to the TH directly or indirectly. 184 1.1 christos A certificate trail is created when Autokey asks the immediately 185 1.1 christos ascendant host towards the TH to sign its certificate, which is then 186 1.1 christos provided to the immediately descendant host on request. 187 1.1 christos All group hosts should have acyclic certificate trails ending on the TH. 188 1.1 christos 189 1.1 christos <p>The host key is used to encrypt the cookie when required and so must be 190 1.1 christos RSA type. 191 1.1 christos By default, the host key is also the sign key used to encrypt signatures. 192 1.1 christos A different sign key can be assigned using the <code>-S</code> option 193 1.1 christos and this can be either RSA or DSA type. 194 1.1 christos By default, the signature 195 1.1 christos message digest type is MD5, but any combination of sign key type and 196 1.1 christos message digest type supported by the OpenSSL library can be specified 197 1.1 christos using the <code>-c</code> option. 198 1.1 christos 199 1.1 christos <p>The rules say cryptographic media should be generated with proventic 200 1.1 christos filestamps, which means the host should already be synchronized before 201 1.1 christos this program is run. 202 1.1 christos This of course creates a chicken-and-egg problem 203 1.1 christos when the host is started for the first time. 204 1.1 christos Accordingly, the host time 205 1.1 christos should be set by some other means, such as eyeball-and-wristwatch, at 206 1.1 christos least so that the certificate lifetime is within the current year. 207 1.1 christos After that and when the host is synchronized to a proventic source, the 208 1.1 christos certificate should be re-generated. 209 1.1 christos 210 1.1 christos <p>Additional information on trusted groups and identity schemes is on the 211 1.1 christos Autokey Public-Key Authentication page. 212 1.1 christos 213 1.1 christos <div class="node"> 214 1.1 christos <p><hr> 215 1.1.1.6 christos <a name="ntp-keygen-Invocation"></a> 216 1.1 christos <a name="ntp_002dkeygen-Invocation"></a> 217 1.1.1.6 christos 218 1.1.1.6 christos 219 1.1 christos </div> 220 1.1 christos 221 1.1 christos <h3 class="section">Invoking ntp-keygen</h3> 222 1.1 christos 223 1.1 christos <p><a name="index-ntp_002dkeygen-1"></a><a name="index-Create-a-NTP-host-key-2"></a> 224 1.1 christos 225 1.1 christos <p>This program generates cryptographic data files used by the NTPv4 226 1.1 christos authentication and identification schemes. 227 1.1 christos It generates MD5 key files used in symmetric key cryptography. 228 1.1 christos In addition, if the OpenSSL software library has been installed, 229 1.1 christos it generates keys, certificate and identity files used in public key 230 1.1 christos cryptography. 231 1.1 christos These files are used for cookie encryption, 232 1.1 christos digital signature and challenge/response identification algorithms 233 1.1 christos compatible with the Internet standard security infrastructure. 234 1.1 christos 235 1.1 christos <p>All files are in PEM-encoded printable ASCII format, 236 1.1 christos so they can be embedded as MIME attachments in mail to other sites 237 1.1 christos and certificate authorities. 238 1.1 christos By default, files are not encrypted. 239 1.1 christos 240 1.1 christos <p>When used to generate message digest keys, the program produces a file 241 1.1 christos containing ten pseudo-random printable ASCII strings suitable for the 242 1.1 christos MD5 message digest algorithm included in the distribution. 243 1.1 christos If the OpenSSL library is installed, it produces an additional ten 244 1.1 christos hex-encoded random bit strings suitable for the SHA1 and other message 245 1.1 christos digest algorithms. 246 1.1 christos The message digest keys file must be distributed and stored 247 1.1 christos using secure means beyond the scope of NTP itself. 248 1.1 christos Besides the keys used for ordinary NTP associations, additional keys 249 1.1 christos can be defined as passwords for the 250 1.1 christos <code>ntpq(1ntpqmdoc)</code> 251 1.1 christos and 252 1.1 christos <code>ntpdc(1ntpdcmdoc)</code> 253 1.1 christos utility programs. 254 1.1 christos 255 1.1 christos <p>The remaining generated files are compatible with other OpenSSL 256 1.1 christos applications and other Public Key Infrastructure (PKI) resources. 257 1.1 christos Certificates generated by this program are compatible with extant 258 1.1 christos industry practice, although some users might find the interpretation of 259 1.1 christos X509v3 extension fields somewhat liberal. 260 1.1 christos However, the identity keys are probably not compatible with anything 261 1.1 christos other than Autokey. 262 1.1 christos 263 1.1 christos <p>Some files used by this program are encrypted using a private password. 264 1.1 christos The 265 1.1 christos <code>-p</code> 266 1.1 christos option specifies the password for local encrypted files and the 267 1.1 christos <code>-q</code> 268 1.1 christos option the password for encrypted files sent to remote sites. 269 1.1 christos If no password is specified, the host name returned by the Unix 270 1.1 christos <code>gethostname()</code> 271 1.1 christos function, normally the DNS name of the host is used. 272 1.1 christos 273 1.1 christos <p>The 274 1.1 christos <kbd>pw</kbd> 275 1.1 christos option of the 276 1.1 christos <kbd>crypto</kbd> 277 1.1 christos configuration command specifies the read 278 1.1 christos password for previously encrypted local files. 279 1.1 christos This must match the local password used by this program. 280 1.1 christos If not specified, the host name is used. 281 1.1 christos Thus, if files are generated by this program without password, 282 1.1 christos they can be read back by 283 1.1 christos <kbd>ntpd</kbd> 284 1.1 christos without password but only on the same host. 285 1.1 christos 286 1.1 christos <p>Normally, encrypted files for each host are generated by that host and 287 1.1 christos used only by that host, although exceptions exist as noted later on 288 1.1 christos this page. 289 1.1 christos The symmetric keys file, normally called 290 1.1 christos <kbd>ntp.keys</kbd>, 291 1.1 christos is usually installed in 292 1.1.1.6 christos <samp><span class="file">/etc</span></samp>. 293 1.1 christos Other files and links are usually installed in 294 1.1.1.6 christos <samp><span class="file">/usr/local/etc</span></samp>, 295 1.1 christos which is normally in a shared filesystem in 296 1.1 christos NFS-mounted networks and cannot be changed by shared clients. 297 1.1 christos The location of the keys directory can be changed by the 298 1.1 christos <kbd>keysdir</kbd> 299 1.1 christos configuration command in such cases. 300 1.1 christos Normally, this is in 301 1.1.1.6 christos <samp><span class="file">/etc</span></samp>. 302 1.1 christos 303 1.1 christos <p>This program directs commentary and error messages to the standard 304 1.1 christos error stream 305 1.1 christos <kbd>stderr</kbd> 306 1.1 christos and remote files to the standard output stream 307 1.1 christos <kbd>stdout</kbd> 308 1.1 christos where they can be piped to other applications or redirected to files. 309 1.1 christos The names used for generated files and links all begin with the 310 1.1 christos string 311 1.1 christos <kbd>ntpkey</kbd> 312 1.1 christos and include the file type, generating host and filestamp, 313 1.1 christos as described in the 314 1.1 christos Cryptographic Data Files 315 1.1 christos section below. 316 1.1 christos 317 1.1 christos <h5 class="subsubsection">Running the Program</h5> 318 1.1 christos 319 1.1 christos <p>To test and gain experience with Autokey concepts, log in as root and 320 1.1 christos change to the keys directory, usually 321 1.1.1.6 christos <samp><span class="file">/usr/local/etc</span></samp> 322 1.1 christos When run for the first time, or if all files with names beginning with 323 1.1 christos <kbd>ntpkey</kbd> 324 1.1 christos have been removed, use the 325 1.1 christos <code>ntp-keygen</code> 326 1.1 christos command without arguments to generate a 327 1.1 christos default RSA host key and matching RSA-MD5 certificate with expiration 328 1.1 christos date one year hence. 329 1.1 christos If run again without options, the program uses the 330 1.1 christos existing keys and parameters and generates only a new certificate with 331 1.1 christos new expiration date one year hence. 332 1.1 christos 333 1.1 christos <p>Run the command on as many hosts as necessary. 334 1.1 christos Designate one of them as the trusted host (TH) using 335 1.1 christos <code>ntp-keygen</code> 336 1.1 christos with the 337 1.1 christos <code>-T</code> 338 1.1 christos option and configure it to synchronize from reliable Internet servers. 339 1.1 christos Then configure the other hosts to synchronize to the TH directly or 340 1.1 christos indirectly. 341 1.1 christos A certificate trail is created when Autokey asks the immediately 342 1.1 christos ascendant host towards the TH to sign its certificate, which is then 343 1.1 christos provided to the immediately descendant host on request. 344 1.1 christos All group hosts should have acyclic certificate trails ending on the TH. 345 1.1 christos 346 1.1 christos <p>The host key is used to encrypt the cookie when required and so must be 347 1.1 christos RSA type. 348 1.1 christos By default, the host key is also the sign key used to encrypt 349 1.1 christos signatures. 350 1.1 christos A different sign key can be assigned using the 351 1.1 christos <code>-S</code> 352 1.1 christos option and this can be either RSA or DSA type. 353 1.1 christos By default, the signature 354 1.1 christos message digest type is MD5, but any combination of sign key type and 355 1.1 christos message digest type supported by the OpenSSL library can be specified 356 1.1 christos using the 357 1.1 christos <code>-c</code> 358 1.1 christos option. 359 1.1 christos The rules say cryptographic media should be generated with proventic 360 1.1 christos filestamps, which means the host should already be synchronized before 361 1.1 christos this program is run. 362 1.1 christos This of course creates a chicken-and-egg problem 363 1.1 christos when the host is started for the first time. 364 1.1 christos Accordingly, the host time 365 1.1 christos should be set by some other means, such as eyeball-and-wristwatch, at 366 1.1 christos least so that the certificate lifetime is within the current year. 367 1.1 christos After that and when the host is synchronized to a proventic source, the 368 1.1 christos certificate should be re-generated. 369 1.1 christos 370 1.1 christos <p>Additional information on trusted groups and identity schemes is on the 371 1.1 christos Autokey Public-Key Authentication 372 1.1 christos page. 373 1.1 christos 374 1.1 christos <p>The 375 1.1 christos <code>ntpd(1ntpdmdoc)</code> 376 1.1 christos configuration command 377 1.1 christos <code>crypto</code> <code>pw</code> <kbd>password</kbd> 378 1.1 christos specifies the read password for previously encrypted files. 379 1.1 christos The daemon expires on the spot if the password is missing 380 1.1 christos or incorrect. 381 1.1 christos For convenience, if a file has been previously encrypted, 382 1.1 christos the default read password is the name of the host running 383 1.1 christos the program. 384 1.1 christos If the previous write password is specified as the host name, 385 1.1 christos these files can be read by that host with no explicit password. 386 1.1 christos 387 1.1 christos <p>File names begin with the prefix 388 1.1 christos <code>ntpkey_</code> 389 1.1 christos and end with the postfix 390 1.1 christos <kbd>_hostname.filestamp</kbd>, 391 1.1 christos where 392 1.1 christos <kbd>hostname</kbd> 393 1.1 christos is the owner name, usually the string returned 394 1.1 christos by the Unix gethostname() routine, and 395 1.1 christos <kbd>filestamp</kbd> 396 1.1 christos is the NTP seconds when the file was generated, in decimal digits. 397 1.1 christos This both guarantees uniqueness and simplifies maintenance 398 1.1 christos procedures, since all files can be quickly removed 399 1.1 christos by a 400 1.1 christos <code>rm</code> <code>ntpkey*</code> 401 1.1 christos command or all files generated 402 1.1 christos at a specific time can be removed by a 403 1.1 christos <code>rm</code> 404 1.1 christos <kbd>*filestamp</kbd> 405 1.1 christos command. 406 1.1 christos To further reduce the risk of misconfiguration, 407 1.1 christos the first two lines of a file contain the file name 408 1.1 christos and generation date and time as comments. 409 1.1 christos 410 1.1 christos <p>All files are installed by default in the keys directory 411 1.1.1.6 christos <samp><span class="file">/usr/local/etc</span></samp>, 412 1.1 christos which is normally in a shared filesystem 413 1.1 christos in NFS-mounted networks. 414 1.1 christos The actual location of the keys directory 415 1.1 christos and each file can be overridden by configuration commands, 416 1.1 christos but this is not recommended. 417 1.1 christos Normally, the files for each host are generated by that host 418 1.1 christos and used only by that host, although exceptions exist 419 1.1 christos as noted later on this page. 420 1.1 christos 421 1.1 christos <p>Normally, files containing private values, 422 1.1 christos including the host key, sign key and identification parameters, 423 1.1 christos are permitted root read/write-only; 424 1.1 christos while others containing public values are permitted world readable. 425 1.1 christos Alternatively, files containing private values can be encrypted 426 1.1 christos and these files permitted world readable, 427 1.1 christos which simplifies maintenance in shared file systems. 428 1.1 christos Since uniqueness is insured by the hostname and 429 1.1 christos file name extensions, the files for a NFS server and 430 1.1 christos dependent clients can all be installed in the same shared directory. 431 1.1 christos 432 1.1 christos <p>The recommended practice is to keep the file name extensions 433 1.1 christos when installing a file and to install a soft link 434 1.1 christos from the generic names specified elsewhere on this page 435 1.1 christos to the generated files. 436 1.1 christos This allows new file generations to be activated simply 437 1.1 christos by changing the link. 438 1.1 christos If a link is present, ntpd follows it to the file name 439 1.1 christos to extract the filestamp. 440 1.1 christos If a link is not present, 441 1.1 christos <code>ntpd(1ntpdmdoc)</code> 442 1.1 christos extracts the filestamp from the file itself. 443 1.1 christos This allows clients to verify that the file and generation times 444 1.1 christos are always current. 445 1.1 christos The 446 1.1 christos <code>ntp-keygen</code> 447 1.1 christos program uses the same timestamp extension for all files generated 448 1.1 christos at one time, so each generation is distinct and can be readily 449 1.1 christos recognized in monitoring data. 450 1.1 christos 451 1.1 christos <h5 class="subsubsection">Running the program</h5> 452 1.1 christos 453 1.1 christos <p>The safest way to run the 454 1.1 christos <code>ntp-keygen</code> 455 1.1 christos program is logged in directly as root. 456 1.1 christos The recommended procedure is change to the keys directory, 457 1.1 christos usually 458 1.1.1.6 christos <samp><span class="file">/usr/local/etc</span></samp>, 459 1.1 christos then run the program. 460 1.1 christos When run for the first time, 461 1.1 christos or if all 462 1.1 christos <code>ntpkey</code> 463 1.1 christos files have been removed, 464 1.1 christos the program generates a RSA host key file and matching RSA-MD5 certificate file, 465 1.1 christos which is all that is necessary in many cases. 466 1.1 christos The program also generates soft links from the generic names 467 1.1 christos to the respective files. 468 1.1 christos If run again, the program uses the same host key file, 469 1.1 christos but generates a new certificate file and link. 470 1.1 christos 471 1.1 christos <p>The host key is used to encrypt the cookie when required and so must be RSA type. 472 1.1 christos By default, the host key is also the sign key used to encrypt signatures. 473 1.1 christos When necessary, a different sign key can be specified and this can be 474 1.1 christos either RSA or DSA type. 475 1.1 christos By default, the message digest type is MD5, but any combination 476 1.1 christos of sign key type and message digest type supported by the OpenSSL library 477 1.1 christos can be specified, including those using the MD2, MD5, SHA, SHA1, MDC2 478 1.1 christos and RIPE160 message digest algorithms. 479 1.1 christos However, the scheme specified in the certificate must be compatible 480 1.1 christos with the sign key. 481 1.1 christos Certificates using any digest algorithm are compatible with RSA sign keys; 482 1.1 christos however, only SHA and SHA1 certificates are compatible with DSA sign keys. 483 1.1 christos 484 1.1 christos <p>Private/public key files and certificates are compatible with 485 1.1 christos other OpenSSL applications and very likely other libraries as well. 486 1.1 christos Certificates or certificate requests derived from them should be compatible 487 1.1 christos with extant industry practice, although some users might find 488 1.1 christos the interpretation of X509v3 extension fields somewhat liberal. 489 1.1 christos However, the identification parameter files, although encoded 490 1.1 christos as the other files, are probably not compatible with anything other than Autokey. 491 1.1 christos 492 1.1 christos <p>Running the program as other than root and using the Unix 493 1.1 christos <code>su</code> 494 1.1 christos command 495 1.1 christos to assume root may not work properly, since by default the OpenSSL library 496 1.1 christos looks for the random seed file 497 1.1 christos <code>.rnd</code> 498 1.1 christos in the user home directory. 499 1.1 christos However, there should be only one 500 1.1 christos <code>.rnd</code>, 501 1.1 christos most conveniently 502 1.1 christos in the root directory, so it is convenient to define the 503 1.1 christos <code>$RANDFILE</code> 504 1.1 christos environment variable used by the OpenSSL library as the path to 505 1.1 christos <code>/.rnd</code>. 506 1.1 christos 507 1.1 christos <p>Installing the keys as root might not work in NFS-mounted 508 1.1 christos shared file systems, as NFS clients may not be able to write 509 1.1 christos to the shared keys directory, even as root. 510 1.1 christos In this case, NFS clients can specify the files in another 511 1.1 christos directory such as 512 1.1.1.6 christos <samp><span class="file">/etc</span></samp> 513 1.1 christos using the 514 1.1 christos <code>keysdir</code> 515 1.1 christos command. 516 1.1 christos There is no need for one client to read the keys and certificates 517 1.1 christos of other clients or servers, as these data are obtained automatically 518 1.1 christos by the Autokey protocol. 519 1.1 christos 520 1.1 christos <p>Ordinarily, cryptographic files are generated by the host that uses them, 521 1.1 christos but it is possible for a trusted agent (TA) to generate these files 522 1.1 christos for other hosts; however, in such cases files should always be encrypted. 523 1.1 christos The subject name and trusted name default to the hostname 524 1.1 christos of the host generating the files, but can be changed by command line options. 525 1.1 christos It is convenient to designate the owner name and trusted name 526 1.1 christos as the subject and issuer fields, respectively, of the certificate. 527 1.1 christos The owner name is also used for the host and sign key files, 528 1.1 christos while the trusted name is used for the identity files. 529 1.1 christos 530 1.1 christos <p>All files are installed by default in the keys directory 531 1.1.1.6 christos <samp><span class="file">/usr/local/etc</span></samp>, 532 1.1 christos which is normally in a shared filesystem 533 1.1 christos in NFS-mounted networks. 534 1.1 christos The actual location of the keys directory 535 1.1 christos and each file can be overridden by configuration commands, 536 1.1 christos but this is not recommended. 537 1.1 christos Normally, the files for each host are generated by that host 538 1.1 christos and used only by that host, although exceptions exist 539 1.1 christos as noted later on this page. 540 1.1 christos 541 1.1 christos <p>Normally, files containing private values, 542 1.1 christos including the host key, sign key and identification parameters, 543 1.1 christos are permitted root read/write-only; 544 1.1 christos while others containing public values are permitted world readable. 545 1.1 christos Alternatively, files containing private values can be encrypted 546 1.1 christos and these files permitted world readable, 547 1.1 christos which simplifies maintenance in shared file systems. 548 1.1 christos Since uniqueness is insured by the hostname and 549 1.1 christos file name extensions, the files for a NFS server and 550 1.1 christos dependent clients can all be installed in the same shared directory. 551 1.1 christos 552 1.1 christos <p>The recommended practice is to keep the file name extensions 553 1.1 christos when installing a file and to install a soft link 554 1.1 christos from the generic names specified elsewhere on this page 555 1.1 christos to the generated files. 556 1.1 christos This allows new file generations to be activated simply 557 1.1 christos by changing the link. 558 1.1 christos If a link is present, ntpd follows it to the file name 559 1.1 christos to extract the filestamp. 560 1.1 christos If a link is not present, 561 1.1 christos <code>ntpd(1ntpdmdoc)</code> 562 1.1 christos extracts the filestamp from the file itself. 563 1.1 christos This allows clients to verify that the file and generation times 564 1.1 christos are always current. 565 1.1 christos The 566 1.1 christos <code>ntp-keygen</code> 567 1.1 christos program uses the same timestamp extension for all files generated 568 1.1 christos at one time, so each generation is distinct and can be readily 569 1.1 christos recognized in monitoring data. 570 1.1 christos 571 1.1 christos <h5 class="subsubsection">Running the program</h5> 572 1.1 christos 573 1.1 christos <p>The safest way to run the 574 1.1 christos <code>ntp-keygen</code> 575 1.1 christos program is logged in directly as root. 576 1.1 christos The recommended procedure is change to the keys directory, 577 1.1 christos usually 578 1.1.1.6 christos <samp><span class="file">/usr/local/etc</span></samp>, 579 1.1 christos then run the program. 580 1.1 christos When run for the first time, 581 1.1 christos or if all 582 1.1 christos <code>ntpkey</code> 583 1.1 christos files have been removed, 584 1.1 christos the program generates a RSA host key file and matching RSA-MD5 certificate file, 585 1.1 christos which is all that is necessary in many cases. 586 1.1 christos The program also generates soft links from the generic names 587 1.1 christos to the respective files. 588 1.1 christos If run again, the program uses the same host key file, 589 1.1 christos but generates a new certificate file and link. 590 1.1 christos 591 1.1 christos <p>The host key is used to encrypt the cookie when required and so must be RSA type. 592 1.1 christos By default, the host key is also the sign key used to encrypt signatures. 593 1.1 christos When necessary, a different sign key can be specified and this can be 594 1.1 christos either RSA or DSA type. 595 1.1 christos By default, the message digest type is MD5, but any combination 596 1.1 christos of sign key type and message digest type supported by the OpenSSL library 597 1.1 christos can be specified, including those using the MD2, MD5, SHA, SHA1, MDC2 598 1.1 christos and RIPE160 message digest algorithms. 599 1.1 christos However, the scheme specified in the certificate must be compatible 600 1.1 christos with the sign key. 601 1.1 christos Certificates using any digest algorithm are compatible with RSA sign keys; 602 1.1 christos however, only SHA and SHA1 certificates are compatible with DSA sign keys. 603 1.1 christos 604 1.1 christos <p>Private/public key files and certificates are compatible with 605 1.1 christos other OpenSSL applications and very likely other libraries as well. 606 1.1 christos Certificates or certificate requests derived from them should be compatible 607 1.1 christos with extant industry practice, although some users might find 608 1.1 christos the interpretation of X509v3 extension fields somewhat liberal. 609 1.1 christos However, the identification parameter files, although encoded 610 1.1 christos as the other files, are probably not compatible with anything other than Autokey. 611 1.1 christos 612 1.1 christos <p>Running the program as other than root and using the Unix 613 1.1 christos <code>su</code> 614 1.1 christos command 615 1.1 christos to assume root may not work properly, since by default the OpenSSL library 616 1.1 christos looks for the random seed file 617 1.1 christos <code>.rnd</code> 618 1.1 christos in the user home directory. 619 1.1 christos However, there should be only one 620 1.1 christos <code>.rnd</code>, 621 1.1 christos most conveniently 622 1.1 christos in the root directory, so it is convenient to define the 623 1.1 christos <code>$RANDFILE</code> 624 1.1 christos environment variable used by the OpenSSL library as the path to 625 1.1 christos <code>/.rnd</code>. 626 1.1 christos 627 1.1 christos <p>Installing the keys as root might not work in NFS-mounted 628 1.1 christos shared file systems, as NFS clients may not be able to write 629 1.1 christos to the shared keys directory, even as root. 630 1.1 christos In this case, NFS clients can specify the files in another 631 1.1 christos directory such as 632 1.1.1.6 christos <samp><span class="file">/etc</span></samp> 633 1.1 christos using the 634 1.1 christos <code>keysdir</code> 635 1.1 christos command. 636 1.1 christos There is no need for one client to read the keys and certificates 637 1.1 christos of other clients or servers, as these data are obtained automatically 638 1.1 christos by the Autokey protocol. 639 1.1 christos 640 1.1 christos <p>Ordinarily, cryptographic files are generated by the host that uses them, 641 1.1 christos but it is possible for a trusted agent (TA) to generate these files 642 1.1 christos for other hosts; however, in such cases files should always be encrypted. 643 1.1 christos The subject name and trusted name default to the hostname 644 1.1 christos of the host generating the files, but can be changed by command line options. 645 1.1 christos It is convenient to designate the owner name and trusted name 646 1.1 christos as the subject and issuer fields, respectively, of the certificate. 647 1.1 christos The owner name is also used for the host and sign key files, 648 1.1 christos while the trusted name is used for the identity files. 649 1.1 christos seconds. 650 1.1 christos seconds. 651 1.1 christos 652 1.1 christos <p>s Trusted Hosts and Groups 653 1.1 christos Each cryptographic configuration involves selection of a signature scheme 654 1.1 christos and identification scheme, called a cryptotype, 655 1.1 christos as explained in the 656 1.1 christos <a href="#Authentication-Options">Authentication Options</a> 657 1.1 christos section of 658 1.1 christos <code>ntp.conf(5)</code>. 659 1.1 christos The default cryptotype uses RSA encryption, MD5 message digest 660 1.1 christos and TC identification. 661 1.1 christos First, configure a NTP subnet including one or more low-stratum 662 1.1 christos trusted hosts from which all other hosts derive synchronization 663 1.1 christos directly or indirectly. 664 1.1 christos Trusted hosts have trusted certificates; 665 1.1 christos all other hosts have nontrusted certificates. 666 1.1 christos These hosts will automatically and dynamically build authoritative 667 1.1 christos certificate trails to one or more trusted hosts. 668 1.1 christos A trusted group is the set of all hosts that have, directly or indirectly, 669 1.1 christos a certificate trail ending at a trusted host. 670 1.1 christos The trail is defined by static configuration file entries 671 1.1 christos or dynamic means described on the 672 1.1 christos <a href="#Automatic-NTP-Configuration-Options">Automatic NTP Configuration Options</a> 673 1.1 christos section of 674 1.1 christos <code>ntp.conf(5)</code>. 675 1.1 christos 676 1.1 christos <p>On each trusted host as root, change to the keys directory. 677 1.1 christos To insure a fresh fileset, remove all 678 1.1 christos <code>ntpkey</code> 679 1.1 christos files. 680 1.1 christos Then run 681 1.1 christos <code>ntp-keygen</code> 682 1.1 christos <code>-T</code> 683 1.1 christos to generate keys and a trusted certificate. 684 1.1 christos On all other hosts do the same, but leave off the 685 1.1 christos <code>-T</code> 686 1.1 christos flag to generate keys and nontrusted certificates. 687 1.1 christos When complete, start the NTP daemons beginning at the lowest stratum 688 1.1 christos and working up the tree. 689 1.1 christos It may take some time for Autokey to instantiate the certificate trails 690 1.1 christos throughout the subnet, but setting up the environment is completely automatic. 691 1.1 christos 692 1.1 christos <p>If it is necessary to use a different sign key or different digest/signature 693 1.1 christos scheme than the default, run 694 1.1 christos <code>ntp-keygen</code> 695 1.1 christos with the 696 1.1 christos <code>-S</code> <kbd>type</kbd> 697 1.1 christos option, where 698 1.1 christos <kbd>type</kbd> 699 1.1 christos is either 700 1.1 christos <code>RSA</code> 701 1.1 christos or 702 1.1 christos <code>DSA</code>. 703 1.1 christos The most often need to do this is when a DSA-signed certificate is used. 704 1.1 christos If it is necessary to use a different certificate scheme than the default, 705 1.1 christos run 706 1.1 christos <code>ntp-keygen</code> 707 1.1 christos with the 708 1.1 christos <code>-c</code> <kbd>scheme</kbd> 709 1.1 christos option and selected 710 1.1 christos <kbd>scheme</kbd> 711 1.1 christos as needed. 712 1.1 christos f 713 1.1 christos <code>ntp-keygen</code> 714 1.1 christos is run again without these options, it generates a new certificate 715 1.1 christos using the same scheme and sign key. 716 1.1 christos 717 1.1 christos <p>After setting up the environment it is advisable to update certificates 718 1.1 christos from time to time, if only to extend the validity interval. 719 1.1 christos Simply run 720 1.1 christos <code>ntp-keygen</code> 721 1.1 christos with the same flags as before to generate new certificates 722 1.1 christos using existing keys. 723 1.1 christos However, if the host or sign key is changed, 724 1.1 christos <code>ntpd(1ntpdmdoc)</code> 725 1.1 christos should be restarted. 726 1.1 christos When 727 1.1 christos <code>ntpd(1ntpdmdoc)</code> 728 1.1 christos is restarted, it loads any new files and restarts the protocol. 729 1.1 christos Other dependent hosts will continue as usual until signatures are refreshed, 730 1.1 christos at which time the protocol is restarted. 731 1.1 christos 732 1.1 christos <h5 class="subsubsection">Identity Schemes</h5> 733 1.1 christos 734 1.1 christos <p>As mentioned on the Autonomous Authentication page, 735 1.1 christos the default TC identity scheme is vulnerable to a middleman attack. 736 1.1 christos However, there are more secure identity schemes available, 737 1.1 christos including PC, IFF, GQ and MV described on the 738 1.1 christos "Identification Schemes" 739 1.1 christos page 740 1.1 christos (maybe available at 741 1.1 christos <code>http://www.eecis.udel.edu/%7emills/keygen.html</code>). 742 1.1 christos These schemes are based on a TA, one or more trusted hosts 743 1.1 christos and some number of nontrusted hosts. 744 1.1 christos Trusted hosts prove identity using values provided by the TA, 745 1.1 christos while the remaining hosts prove identity using values provided 746 1.1 christos by a trusted host and certificate trails that end on that host. 747 1.1 christos The name of a trusted host is also the name of its sugroup 748 1.1 christos and also the subject and issuer name on its trusted certificate. 749 1.1 christos The TA is not necessarily a trusted host in this sense, but often is. 750 1.1 christos 751 1.1 christos <p>In some schemes there are separate keys for servers and clients. 752 1.1 christos A server can also be a client of another server, 753 1.1 christos but a client can never be a server for another client. 754 1.1 christos In general, trusted hosts and nontrusted hosts that operate 755 1.1 christos as both server and client have parameter files that contain 756 1.1 christos both server and client keys. 757 1.1 christos Hosts that operate 758 1.1 christos only as clients have key files that contain only client keys. 759 1.1 christos 760 1.1 christos <p>The PC scheme supports only one trusted host in the group. 761 1.1 christos On trusted host alice run 762 1.1 christos <code>ntp-keygen</code> 763 1.1 christos <code>-P</code> 764 1.1 christos <code>-p</code> <kbd>password</kbd> 765 1.1 christos to generate the host key file 766 1.1.1.6 christos <samp><span class="file">ntpkey_RSAkey_</span></samp><kbd>alice.filestamp</kbd> 767 1.1 christos and trusted private certificate file 768 1.1.1.6 christos <samp><span class="file">ntpkey_RSA-MD5_cert_</span></samp><kbd>alice.filestamp</kbd>. 769 1.1 christos Copy both files to all group hosts; 770 1.1 christos they replace the files which would be generated in other schemes. 771 1.1 christos On each host bob install a soft link from the generic name 772 1.1.1.6 christos <samp><span class="file">ntpkey_host_</span></samp><kbd>bob</kbd> 773 1.1 christos to the host key file and soft link 774 1.1.1.6 christos <samp><span class="file">ntpkey_cert_</span></samp><kbd>bob</kbd> 775 1.1 christos to the private certificate file. 776 1.1 christos Note the generic links are on bob, but point to files generated 777 1.1 christos by trusted host alice. 778 1.1 christos In this scheme it is not possible to refresh 779 1.1 christos either the keys or certificates without copying them 780 1.1 christos to all other hosts in the group. 781 1.1 christos 782 1.1 christos <p>For the IFF scheme proceed as in the TC scheme to generate keys 783 1.1 christos and certificates for all group hosts, then for every trusted host in the group, 784 1.1 christos generate the IFF parameter file. 785 1.1 christos On trusted host alice run 786 1.1 christos <code>ntp-keygen</code> 787 1.1 christos <code>-T</code> 788 1.1 christos <code>-I</code> 789 1.1 christos <code>-p</code> <kbd>password</kbd> 790 1.1 christos to produce her parameter file 791 1.1.1.6 christos <samp><span class="file">ntpkey_IFFpar_</span></samp><kbd>alice.filestamp</kbd>, 792 1.1 christos which includes both server and client keys. 793 1.1 christos Copy this file to all group hosts that operate as both servers 794 1.1 christos and clients and install a soft link from the generic 795 1.1.1.6 christos <samp><span class="file">ntpkey_iff_</span></samp><kbd>alice</kbd> 796 1.1 christos to this file. 797 1.1 christos If there are no hosts restricted to operate only as clients, 798 1.1 christos there is nothing further to do. 799 1.1 christos As the IFF scheme is independent 800 1.1 christos of keys and certificates, these files can be refreshed as needed. 801 1.1 christos 802 1.1 christos <p>If a rogue client has the parameter file, it could masquerade 803 1.1 christos as a legitimate server and present a middleman threat. 804 1.1 christos To eliminate this threat, the client keys can be extracted 805 1.1 christos from the parameter file and distributed to all restricted clients. 806 1.1 christos After generating the parameter file, on alice run 807 1.1 christos <code>ntp-keygen</code> 808 1.1 christos <code>-e</code> 809 1.1 christos and pipe the output to a file or mail program. 810 1.1 christos Copy or mail this file to all restricted clients. 811 1.1 christos On these clients install a soft link from the generic 812 1.1.1.6 christos <samp><span class="file">ntpkey_iff_</span></samp><kbd>alice</kbd> 813 1.1 christos to this file. 814 1.1 christos To further protect the integrity of the keys, 815 1.1 christos each file can be encrypted with a secret password. 816 1.1 christos 817 1.1 christos <p>For the GQ scheme proceed as in the TC scheme to generate keys 818 1.1 christos and certificates for all group hosts, then for every trusted host 819 1.1 christos in the group, generate the IFF parameter file. 820 1.1 christos On trusted host alice run 821 1.1 christos <code>ntp-keygen</code> 822 1.1 christos <code>-T</code> 823 1.1 christos <code>-G</code> 824 1.1 christos <code>-p</code> <kbd>password</kbd> 825 1.1 christos to produce her parameter file 826 1.1.1.6 christos <samp><span class="file">ntpkey_GQpar_</span></samp><kbd>alice.filestamp</kbd>, 827 1.1 christos which includes both server and client keys. 828 1.1 christos Copy this file to all group hosts and install a soft link 829 1.1 christos from the generic 830 1.1.1.6 christos <samp><span class="file">ntpkey_gq_</span></samp><kbd>alice</kbd> 831 1.1 christos to this file. 832 1.1 christos In addition, on each host bob install a soft link 833 1.1 christos from generic 834 1.1.1.6 christos <samp><span class="file">ntpkey_gq_</span></samp><kbd>bob</kbd> 835 1.1 christos to this file. 836 1.1 christos As the GQ scheme updates the GQ parameters file and certificate 837 1.1 christos at the same time, keys and certificates can be regenerated as needed. 838 1.1 christos 839 1.1 christos <p>For the MV scheme, proceed as in the TC scheme to generate keys 840 1.1 christos and certificates for all group hosts. 841 1.1 christos For illustration assume trish is the TA, alice one of several trusted hosts 842 1.1 christos and bob one of her clients. 843 1.1 christos On TA trish run 844 1.1 christos <code>ntp-keygen</code> 845 1.1 christos <code>-V</code> <kbd>n</kbd> 846 1.1 christos <code>-p</code> <kbd>password</kbd>, 847 1.1 christos where 848 1.1 christos <kbd>n</kbd> 849 1.1 christos is the number of revokable keys (typically 5) to produce 850 1.1 christos the parameter file 851 1.1.1.6 christos <samp><span class="file">ntpkeys_MVpar_</span></samp><kbd>trish.filestamp</kbd> 852 1.1 christos and client key files 853 1.1.1.6 christos <samp><span class="file">ntpkeys_MVkeyd_</span></samp><kbd>trish.filestamp</kbd> 854 1.1 christos where 855 1.1 christos <kbd>d</kbd> 856 1.1 christos is the key number (0 < 857 1.1 christos <kbd>d</kbd> 858 1.1 christos < 859 1.1 christos <kbd>n</kbd>). 860 1.1 christos Copy the parameter file to alice and install a soft link 861 1.1 christos from the generic 862 1.1.1.6 christos <samp><span class="file">ntpkey_mv_</span></samp><kbd>alice</kbd> 863 1.1 christos to this file. 864 1.1 christos Copy one of the client key files to alice for later distribution 865 1.1 christos to her clients. 866 1.1 christos It doesn't matter which client key file goes to alice, 867 1.1 christos since they all work the same way. 868 1.1 christos Alice copies the client key file to all of her cliens. 869 1.1 christos On client bob install a soft link from generic 870 1.1.1.6 christos <samp><span class="file">ntpkey_mvkey_</span></samp><kbd>bob</kbd> 871 1.1 christos to the client key file. 872 1.1 christos As the MV scheme is independent of keys and certificates, 873 1.1 christos these files can be refreshed as needed. 874 1.1 christos 875 1.1 christos <h5 class="subsubsection">Command Line Options</h5> 876 1.1 christos 877 1.1 christos <dl> 878 1.1 christos <dt><code>-c</code> <kbd>scheme</kbd><dd>Select certificate message digest/signature encryption scheme. 879 1.1 christos The 880 1.1 christos <kbd>scheme</kbd> 881 1.1 christos can be one of the following: 882 1.1 christos . Cm RSA-MD2 , RSA-MD5 , RSA-SHA , RSA-SHA1 , RSA-MDC2 , RSA-RIPEMD160 , DSA-SHA , 883 1.1 christos or 884 1.1 christos <code>DSA-SHA1</code>. 885 1.1 christos Note that RSA schemes must be used with a RSA sign key and DSA 886 1.1 christos schemes must be used with a DSA sign key. 887 1.1 christos The default without this option is 888 1.1 christos <code>RSA-MD5</code>. 889 1.1 christos <br><dt><code>-d</code><dd>Enable debugging. 890 1.1 christos This option displays the cryptographic data produced in eye-friendly billboards. 891 1.1 christos <br><dt><code>-e</code><dd>Write the IFF client keys to the standard output. 892 1.1 christos This is intended for automatic key distribution by mail. 893 1.1 christos <br><dt><code>-G</code><dd>Generate parameters and keys for the GQ identification scheme, 894 1.1 christos obsoleting any that may exist. 895 1.1 christos <br><dt><code>-g</code><dd>Generate keys for the GQ identification scheme 896 1.1 christos using the existing GQ parameters. 897 1.1 christos If the GQ parameters do not yet exist, create them first. 898 1.1 christos <br><dt><code>-H</code><dd>Generate new host keys, obsoleting any that may exist. 899 1.1 christos <br><dt><code>-I</code><dd>Generate parameters for the IFF identification scheme, 900 1.1 christos obsoleting any that may exist. 901 1.1 christos <br><dt><code>-i</code> <kbd>name</kbd><dd>Set the suject name to 902 1.1 christos <kbd>name</kbd>. 903 1.1 christos This is used as the subject field in certificates 904 1.1 christos and in the file name for host and sign keys. 905 1.1 christos <br><dt><code>-M</code><dd>Generate MD5 keys, obsoleting any that may exist. 906 1.1 christos <br><dt><code>-P</code><dd>Generate a private certificate. 907 1.1 christos By default, the program generates public certificates. 908 1.1 christos <br><dt><code>-p</code> <kbd>password</kbd><dd>Encrypt generated files containing private data with 909 1.1 christos <kbd>password</kbd> 910 1.1 christos and the DES-CBC algorithm. 911 1.1 christos <br><dt><code>-q</code><dd>Set the password for reading files to password. 912 1.1 christos <br><dt><code>-S</code> <code>[RSA | DSA]</code><dd>Generate a new sign key of the designated type, 913 1.1 christos obsoleting any that may exist. 914 1.1 christos By default, the program uses the host key as the sign key. 915 1.1 christos <br><dt><code>-s</code> <kbd>name</kbd><dd>Set the issuer name to 916 1.1 christos <kbd>name</kbd>. 917 1.1 christos This is used for the issuer field in certificates 918 1.1 christos and in the file name for identity files. 919 1.1 christos <br><dt><code>-T</code><dd>Generate a trusted certificate. 920 1.1 christos By default, the program generates a non-trusted certificate. 921 1.1 christos <br><dt><code>-V</code> <kbd>nkeys</kbd><dd>Generate parameters and keys for the Mu-Varadharajan (MV) identification scheme. 922 1.1 christos </dl> 923 1.1 christos 924 1.1 christos <h5 class="subsubsection">Random Seed File</h5> 925 1.1 christos 926 1.1 christos <p>All cryptographically sound key generation schemes must have means 927 1.1 christos to randomize the entropy seed used to initialize 928 1.1 christos the internal pseudo-random number generator used 929 1.1 christos by the library routines. 930 1.1 christos The OpenSSL library uses a designated random seed file for this purpose. 931 1.1 christos The file must be available when starting the NTP daemon and 932 1.1 christos <code>ntp-keygen</code> 933 1.1 christos program. 934 1.1 christos If a site supports OpenSSL or its companion OpenSSH, 935 1.1 christos it is very likely that means to do this are already available. 936 1.1 christos 937 1.1 christos <p>It is important to understand that entropy must be evolved 938 1.1 christos for each generation, for otherwise the random number sequence 939 1.1 christos would be predictable. 940 1.1 christos Various means dependent on external events, such as keystroke intervals, 941 1.1 christos can be used to do this and some systems have built-in entropy sources. 942 1.1 christos Suitable means are described in the OpenSSL software documentation, 943 1.1 christos but are outside the scope of this page. 944 1.1 christos 945 1.1 christos <p>The entropy seed used by the OpenSSL library is contained in a file, 946 1.1 christos usually called 947 1.1 christos <code>.rnd</code>, 948 1.1 christos which must be available when starting the NTP daemon 949 1.1 christos or the 950 1.1 christos <code>ntp-keygen</code> 951 1.1 christos program. 952 1.1 christos The NTP daemon will first look for the file 953 1.1 christos using the path specified by the 954 1.1 christos <code>randfile</code> 955 1.1 christos subcommand of the 956 1.1 christos <code>crypto</code> 957 1.1 christos configuration command. 958 1.1 christos If not specified in this way, or when starting the 959 1.1 christos <code>ntp-keygen</code> 960 1.1 christos program, 961 1.1 christos the OpenSSL library will look for the file using the path specified 962 1.1 christos by the 963 1.1 christos .Ev RANDFILE 964 1.1 christos environment variable in the user home directory, 965 1.1 christos whether root or some other user. 966 1.1 christos If the 967 1.1 christos .Ev RANDFILE 968 1.1 christos environment variable is not present, 969 1.1 christos the library will look for the 970 1.1 christos <code>.rnd</code> 971 1.1 christos file in the user home directory. 972 1.1 christos If the file is not available or cannot be written, 973 1.1 christos the daemon exits with a message to the system log and the program 974 1.1 christos exits with a suitable error message. 975 1.1 christos 976 1.1 christos <h5 class="subsubsection">Cryptographic Data Files</h5> 977 1.1 christos 978 1.1 christos <p>All other file formats begin with two lines. 979 1.1 christos The first contains the file name, including the generated host name 980 1.1 christos and filestamp. 981 1.1 christos The second contains the datestamp in conventional Unix date format. 982 1.1 christos Lines beginning with # are considered comments and ignored by the 983 1.1 christos <code>ntp-keygen</code> 984 1.1 christos program and 985 1.1 christos <code>ntpd(1ntpdmdoc)</code> 986 1.1 christos daemon. 987 1.1 christos Cryptographic values are encoded first using ASN.1 rules, 988 1.1 christos then encrypted if necessary, and finally written PEM-encoded 989 1.1 christos printable ASCII format preceded and followed by MIME content identifier lines. 990 1.1 christos 991 1.1 christos <p>The format of the symmetric keys file is somewhat different 992 1.1 christos than the other files in the interest of backward compatibility. 993 1.1 christos Since DES-CBC is deprecated in NTPv4, the only key format of interest 994 1.1 christos is MD5 alphanumeric strings. 995 1.1 christos Following hte heard the keys are 996 1.1 christos entered one per line in the format 997 1.1 christos <pre class="example"> <kbd>keyno</kbd> <kbd>type</kbd> <kbd>key</kbd> 998 1.1 christos </pre> 999 1.1 christos <p>where 1000 1.1 christos <kbd>keyno</kbd> 1001 1.1 christos is a positive integer in the range 1-65,535, 1002 1.1 christos <kbd>type</kbd> 1003 1.1 christos is the string MD5 defining the key format and 1004 1.1 christos <kbd>key</kbd> 1005 1.1 christos is the key itself, 1006 1.1 christos which is a printable ASCII string 16 characters or less in length. 1007 1.1 christos Each character is chosen from the 93 printable characters 1008 1.1 christos in the range 0x21 through 0x7f excluding space and the 1009 1.1 christos # 1010 1.1 christos character. 1011 1.1 christos 1012 1.1 christos <p>Note that the keys used by the 1013 1.1 christos <code>ntpq(1ntpqmdoc)</code> 1014 1.1 christos and 1015 1.1 christos <code>ntpdc(1ntpdcmdoc)</code> 1016 1.1 christos programs 1017 1.1 christos are checked against passwords requested by the programs 1018 1.1 christos and entered by hand, so it is generally appropriate to specify these keys 1019 1.1 christos in human readable ASCII format. 1020 1.1 christos 1021 1.1 christos <p>The 1022 1.1 christos <code>ntp-keygen</code> 1023 1.1 christos program generates a MD5 symmetric keys file 1024 1.1.1.6 christos <samp><span class="file">ntpkey_MD5key_</span></samp><kbd>hostname.filestamp</kbd>. 1025 1.1 christos Since the file contains private shared keys, 1026 1.1 christos it should be visible only to root and distributed by secure means 1027 1.1 christos to other subnet hosts. 1028 1.1 christos The NTP daemon loads the file 1029 1.1.1.6 christos <samp><span class="file">ntp.keys</span></samp>, 1030 1.1 christos so 1031 1.1 christos <code>ntp-keygen</code> 1032 1.1 christos installs a soft link from this name to the generated file. 1033 1.1 christos Subsequently, similar soft links must be installed by manual 1034 1.1 christos or automated means on the other subnet hosts. 1035 1.1 christos While this file is not used with the Autokey Version 2 protocol, 1036 1.1 christos it is needed to authenticate some remote configuration commands 1037 1.1 christos used by the 1038 1.1 christos <code>ntpq(1ntpqmdoc)</code> 1039 1.1 christos and 1040 1.1 christos <code>ntpdc(1ntpdcmdoc)</code> 1041 1.1 christos utilities. 1042 1.1 christos 1043 1.1 christos <p>This section was generated by <strong>AutoGen</strong>, 1044 1.1 christos using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntp-keygen</code> program. 1045 1.1 christos This software is released under the NTP license, <http://ntp.org/license>;. 1046 1.1 christos 1047 1.1 christos <ul class="menu"> 1048 1.1.1.6 christos <li><a accesskey="1" href="#ntp_002dkeygen-usage">ntp-keygen usage</a>: ntp-keygen help/usage (<samp><span class="option">--help</span></samp>) 1049 1.1 christos <li><a accesskey="2" href="#ntp_002dkeygen-imbits">ntp-keygen imbits</a>: imbits option (-b) 1050 1.1 christos <li><a accesskey="3" href="#ntp_002dkeygen-certificate">ntp-keygen certificate</a>: certificate option (-c) 1051 1.1 christos <li><a accesskey="4" href="#ntp_002dkeygen-cipher">ntp-keygen cipher</a>: cipher option (-C) 1052 1.1 christos <li><a accesskey="5" href="#ntp_002dkeygen-id_002dkey">ntp-keygen id-key</a>: id-key option (-e) 1053 1.1 christos <li><a accesskey="6" href="#ntp_002dkeygen-gq_002dparams">ntp-keygen gq-params</a>: gq-params option (-G) 1054 1.1 christos <li><a accesskey="7" href="#ntp_002dkeygen-host_002dkey">ntp-keygen host-key</a>: host-key option (-H) 1055 1.1 christos <li><a accesskey="8" href="#ntp_002dkeygen-iffkey">ntp-keygen iffkey</a>: iffkey option (-I) 1056 1.1 christos <li><a accesskey="9" href="#ntp_002dkeygen-ident">ntp-keygen ident</a>: ident option (-i) 1057 1.1 christos <li><a href="#ntp_002dkeygen-lifetime">ntp-keygen lifetime</a>: lifetime option (-l) 1058 1.1 christos <li><a href="#ntp_002dkeygen-md5key">ntp-keygen md5key</a>: md5key option (-M) 1059 1.1 christos <li><a href="#ntp_002dkeygen-modulus">ntp-keygen modulus</a>: modulus option (-m) 1060 1.1 christos <li><a href="#ntp_002dkeygen-pvt_002dcert">ntp-keygen pvt-cert</a>: pvt-cert option (-P) 1061 1.1.1.2 christos <li><a href="#ntp_002dkeygen-password">ntp-keygen password</a>: password option (-p) 1062 1.1.1.2 christos <li><a href="#ntp_002dkeygen-export_002dpasswd">ntp-keygen export-passwd</a>: export-passwd option (-q) 1063 1.1 christos <li><a href="#ntp_002dkeygen-sign_002dkey">ntp-keygen sign-key</a>: sign-key option (-S) 1064 1.1 christos <li><a href="#ntp_002dkeygen-subject_002dname">ntp-keygen subject-name</a>: subject-name option (-s) 1065 1.1 christos <li><a href="#ntp_002dkeygen-trusted_002dcert">ntp-keygen trusted-cert</a>: trusted-cert option (-T) 1066 1.1 christos <li><a href="#ntp_002dkeygen-mv_002dparams">ntp-keygen mv-params</a>: mv-params option (-V) 1067 1.1 christos <li><a href="#ntp_002dkeygen-mv_002dkeys">ntp-keygen mv-keys</a>: mv-keys option (-v) 1068 1.1 christos <li><a href="#ntp_002dkeygen-config">ntp-keygen config</a>: presetting/configuring ntp-keygen 1069 1.1 christos <li><a href="#ntp_002dkeygen-exit-status">ntp-keygen exit status</a>: exit status 1070 1.1 christos <li><a href="#ntp_002dkeygen-Usage">ntp-keygen Usage</a>: Usage 1071 1.1 christos <li><a href="#ntp_002dkeygen-Notes">ntp-keygen Notes</a>: Notes 1072 1.1 christos <li><a href="#ntp_002dkeygen-Bugs">ntp-keygen Bugs</a>: Bugs 1073 1.1 christos </ul> 1074 1.1 christos 1075 1.1 christos <div class="node"> 1076 1.1 christos <p><hr> 1077 1.1.1.6 christos <a name="ntp-keygen-usage"></a> 1078 1.1.1.6 christos <a name="ntp_002dkeygen-usage"></a> 1079 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-imbits">ntp-keygen imbits</a>, 1080 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1081 1.1.1.6 christos 1082 1.1 christos </div> 1083 1.1 christos 1084 1.1.1.6 christos <h4 class="subsection">ntp-keygen help/usage (<samp><span class="option">--help</span></samp>)</h4> 1085 1.1 christos 1086 1.1 christos <p><a name="index-ntp_002dkeygen-help-3"></a> 1087 1.1 christos This is the automatically generated usage text for ntp-keygen. 1088 1.1 christos 1089 1.1 christos <p>The text printed is the same whether selected with the <code>help</code> option 1090 1.1.1.6 christos (<samp><span class="option">--help</span></samp>) or the <code>more-help</code> option (<samp><span class="option">--more-help</span></samp>). <code>more-help</code> will print 1091 1.1 christos the usage text by passing it through a pager program. 1092 1.1 christos <code>more-help</code> is disabled on platforms without a working 1093 1.1 christos <code>fork(2)</code> function. The <code>PAGER</code> environment variable is 1094 1.1.1.6 christos used to select the program, defaulting to <samp><span class="file">more</span></samp>. Both will exit 1095 1.1 christos with a status code of 0. 1096 1.1 christos 1097 1.1.1.6 christos <pre class="example">ntp-keygen (ntp) - Create a NTP host key - Ver. 4.2.8p4 1098 1.1 christos Usage: ntp-keygen [ -<flag> [<val>] | --<name>[{=| }<val>] ]... 1099 1.1 christos Flg Arg Option-Name Description 1100 1.1 christos -b Num imbits identity modulus bits 1101 1.1 christos - it must be in the range: 1102 1.1 christos 256 to 2048 1103 1.1 christos -c Str certificate certificate scheme 1104 1.1 christos -C Str cipher privatekey cipher 1105 1.1 christos -d no debug-level Increase debug verbosity level 1106 1.1 christos - may appear multiple times 1107 1.1 christos -D Num set-debug-level Set the debug verbosity level 1108 1.1 christos - may appear multiple times 1109 1.1 christos -e no id-key Write IFF or GQ identity keys 1110 1.1 christos -G no gq-params Generate GQ parameters and keys 1111 1.1 christos -H no host-key generate RSA host key 1112 1.1 christos -I no iffkey generate IFF parameters 1113 1.1 christos -i Str ident set Autokey group name 1114 1.1 christos -l Num lifetime set certificate lifetime 1115 1.1 christos -M no md5key generate MD5 keys 1116 1.1 christos -m Num modulus modulus 1117 1.1 christos - it must be in the range: 1118 1.1 christos 256 to 2048 1119 1.1 christos -P no pvt-cert generate PC private certificate 1120 1.1.1.2 christos -p Str password local private password 1121 1.1.1.2 christos -q Str export-passwd export IFF or GQ group keys with password 1122 1.1 christos -S Str sign-key generate sign key (RSA or DSA) 1123 1.1 christos -s Str subject-name set host and optionally group name 1124 1.1 christos -T no trusted-cert trusted certificate (TC scheme) 1125 1.1 christos -V Num mv-params generate <num> MV parameters 1126 1.1 christos -v Num mv-keys update <num> MV keys 1127 1.1 christos opt version output version information and exit 1128 1.1 christos -? no help display extended usage information and exit 1129 1.1 christos -! no more-help extended usage information passed thru pager 1130 1.1 christos -> opt save-opts save the option state to a config file 1131 1.1 christos -< Str load-opts load options from a config file 1132 1.1 christos - disabled as '--no-load-opts' 1133 1.1 christos - may appear multiple times 1134 1.1 christos 1135 1.1 christos Options are specified by doubled hyphens and their name or by a single 1136 1.1 christos hyphen and the flag character. 1137 1.1 christos 1138 1.1 christos 1139 1.1 christos The following option preset mechanisms are supported: 1140 1.1 christos - reading file $HOME/.ntprc 1141 1.1 christos - reading file ./.ntprc 1142 1.1 christos - examining environment variables named NTP_KEYGEN_* 1143 1.1 christos 1144 1.1 christos Please send bug reports to: <http://bugs.ntp.org, bugs (a] ntp.org> 1145 1.1 christos </pre> 1146 1.1 christos <div class="node"> 1147 1.1 christos <p><hr> 1148 1.1.1.6 christos <a name="ntp-keygen-imbits"></a> 1149 1.1.1.6 christos <a name="ntp_002dkeygen-imbits"></a> 1150 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-certificate">ntp-keygen certificate</a>, 1151 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-usage">ntp-keygen usage</a>, 1152 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1153 1.1.1.6 christos 1154 1.1 christos </div> 1155 1.1 christos 1156 1.1 christos <h4 class="subsection">imbits option (-b)</h4> 1157 1.1 christos 1158 1.1 christos <p><a name="index-ntp_002dkeygen_002dimbits-4"></a> 1159 1.1 christos This is the “identity modulus bits” option. 1160 1.1.1.6 christos This option takes a number argument <samp><span class="file">imbits</span></samp>. 1161 1.1 christos 1162 1.1 christos <p class="noindent">This option has some usage constraints. It: 1163 1.1 christos <ul> 1164 1.1 christos <li>must be compiled in by defining <code>AUTOKEY</code> during the compilation. 1165 1.1 christos </ul> 1166 1.1 christos 1167 1.1 christos <p>The number of bits in the identity modulus. The default is 256. 1168 1.1 christos <div class="node"> 1169 1.1 christos <p><hr> 1170 1.1.1.6 christos <a name="ntp-keygen-certificate"></a> 1171 1.1.1.6 christos <a name="ntp_002dkeygen-certificate"></a> 1172 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-cipher">ntp-keygen cipher</a>, 1173 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-imbits">ntp-keygen imbits</a>, 1174 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1175 1.1.1.6 christos 1176 1.1 christos </div> 1177 1.1 christos 1178 1.1 christos <h4 class="subsection">certificate option (-c)</h4> 1179 1.1 christos 1180 1.1 christos <p><a name="index-ntp_002dkeygen_002dcertificate-5"></a> 1181 1.1 christos This is the “certificate scheme” option. 1182 1.1.1.6 christos This option takes a string argument <samp><span class="file">scheme</span></samp>. 1183 1.1 christos 1184 1.1 christos <p class="noindent">This option has some usage constraints. It: 1185 1.1 christos <ul> 1186 1.1 christos <li>must be compiled in by defining <code>AUTOKEY</code> during the compilation. 1187 1.1 christos </ul> 1188 1.1 christos 1189 1.1 christos <p>scheme is one of 1190 1.1 christos RSA-MD2, RSA-MD5, RSA-SHA, RSA-SHA1, RSA-MDC2, RSA-RIPEMD160, 1191 1.1 christos DSA-SHA, or DSA-SHA1. 1192 1.1 christos 1193 1.1 christos <p>Select the certificate message digest/signature encryption scheme. 1194 1.1 christos Note that RSA schemes must be used with a RSA sign key and DSA 1195 1.1 christos schemes must be used with a DSA sign key. The default without 1196 1.1 christos this option is RSA-MD5. 1197 1.1 christos <div class="node"> 1198 1.1 christos <p><hr> 1199 1.1.1.6 christos <a name="ntp-keygen-cipher"></a> 1200 1.1.1.6 christos <a name="ntp_002dkeygen-cipher"></a> 1201 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-id_002dkey">ntp-keygen id-key</a>, 1202 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-certificate">ntp-keygen certificate</a>, 1203 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1204 1.1.1.6 christos 1205 1.1 christos </div> 1206 1.1 christos 1207 1.1 christos <h4 class="subsection">cipher option (-C)</h4> 1208 1.1 christos 1209 1.1 christos <p><a name="index-ntp_002dkeygen_002dcipher-6"></a> 1210 1.1 christos This is the “privatekey cipher” option. 1211 1.1.1.6 christos This option takes a string argument <samp><span class="file">cipher</span></samp>. 1212 1.1 christos 1213 1.1 christos <p class="noindent">This option has some usage constraints. It: 1214 1.1 christos <ul> 1215 1.1 christos <li>must be compiled in by defining <code>AUTOKEY</code> during the compilation. 1216 1.1 christos </ul> 1217 1.1 christos 1218 1.1 christos <p>Select the cipher which is used to encrypt the files containing 1219 1.1 christos private keys. The default is three-key triple DES in CBC mode, 1220 1.1 christos equivalent to "<code>-C des-ede3-cbc". The openssl tool lists ciphers 1221 1.1 christos available in "openssl -h" output. 1222 1.1 christos </code><div class="node"> 1223 1.1 christos <p><hr> 1224 1.1.1.6 christos <a name="ntp-keygen-id-key"></a> 1225 1.1.1.6 christos <a name="ntp_002dkeygen-id_002dkey"></a> 1226 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-gq_002dparams">ntp-keygen gq-params</a>, 1227 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-cipher">ntp-keygen cipher</a>, 1228 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1229 1.1.1.6 christos 1230 1.1 christos </div> 1231 1.1 christos 1232 1.1 christos <h4 class="subsection">id-key option (-e)</h4> 1233 1.1 christos 1234 1.1 christos <p><a name="index-ntp_002dkeygen_002did_002dkey-7"></a> 1235 1.1 christos This is the “write iff or gq identity keys” option. 1236 1.1 christos 1237 1.1 christos <p class="noindent">This option has some usage constraints. It: 1238 1.1 christos <ul> 1239 1.1 christos <li>must be compiled in by defining <code>AUTOKEY</code> during the compilation. 1240 1.1 christos </ul> 1241 1.1 christos 1242 1.1 christos <p>Write the IFF or GQ client keys to the standard output. This is 1243 1.1 christos intended for automatic key distribution by mail. 1244 1.1 christos <div class="node"> 1245 1.1 christos <p><hr> 1246 1.1.1.6 christos <a name="ntp-keygen-gq-params"></a> 1247 1.1.1.6 christos <a name="ntp_002dkeygen-gq_002dparams"></a> 1248 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-host_002dkey">ntp-keygen host-key</a>, 1249 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-id_002dkey">ntp-keygen id-key</a>, 1250 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1251 1.1.1.6 christos 1252 1.1 christos </div> 1253 1.1 christos 1254 1.1 christos <h4 class="subsection">gq-params option (-G)</h4> 1255 1.1 christos 1256 1.1 christos <p><a name="index-ntp_002dkeygen_002dgq_002dparams-8"></a> 1257 1.1 christos This is the “generate gq parameters and keys” option. 1258 1.1 christos 1259 1.1 christos <p class="noindent">This option has some usage constraints. It: 1260 1.1 christos <ul> 1261 1.1 christos <li>must be compiled in by defining <code>AUTOKEY</code> during the compilation. 1262 1.1 christos </ul> 1263 1.1 christos 1264 1.1 christos <p>Generate parameters and keys for the GQ identification scheme, 1265 1.1 christos obsoleting any that may exist. 1266 1.1 christos <div class="node"> 1267 1.1 christos <p><hr> 1268 1.1.1.6 christos <a name="ntp-keygen-host-key"></a> 1269 1.1.1.6 christos <a name="ntp_002dkeygen-host_002dkey"></a> 1270 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-iffkey">ntp-keygen iffkey</a>, 1271 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-gq_002dparams">ntp-keygen gq-params</a>, 1272 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1273 1.1.1.6 christos 1274 1.1 christos </div> 1275 1.1 christos 1276 1.1 christos <h4 class="subsection">host-key option (-H)</h4> 1277 1.1 christos 1278 1.1 christos <p><a name="index-ntp_002dkeygen_002dhost_002dkey-9"></a> 1279 1.1 christos This is the “generate rsa host key” option. 1280 1.1 christos 1281 1.1 christos <p class="noindent">This option has some usage constraints. It: 1282 1.1 christos <ul> 1283 1.1 christos <li>must be compiled in by defining <code>AUTOKEY</code> during the compilation. 1284 1.1 christos </ul> 1285 1.1 christos 1286 1.1 christos <p>Generate new host keys, obsoleting any that may exist. 1287 1.1 christos <div class="node"> 1288 1.1 christos <p><hr> 1289 1.1.1.6 christos <a name="ntp-keygen-iffkey"></a> 1290 1.1.1.6 christos <a name="ntp_002dkeygen-iffkey"></a> 1291 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-ident">ntp-keygen ident</a>, 1292 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-host_002dkey">ntp-keygen host-key</a>, 1293 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1294 1.1.1.6 christos 1295 1.1 christos </div> 1296 1.1 christos 1297 1.1 christos <h4 class="subsection">iffkey option (-I)</h4> 1298 1.1 christos 1299 1.1 christos <p><a name="index-ntp_002dkeygen_002diffkey-10"></a> 1300 1.1 christos This is the “generate iff parameters” option. 1301 1.1 christos 1302 1.1 christos <p class="noindent">This option has some usage constraints. It: 1303 1.1 christos <ul> 1304 1.1 christos <li>must be compiled in by defining <code>AUTOKEY</code> during the compilation. 1305 1.1 christos </ul> 1306 1.1 christos 1307 1.1 christos <p>Generate parameters for the IFF identification scheme, obsoleting 1308 1.1 christos any that may exist. 1309 1.1 christos <div class="node"> 1310 1.1 christos <p><hr> 1311 1.1.1.6 christos <a name="ntp-keygen-ident"></a> 1312 1.1.1.6 christos <a name="ntp_002dkeygen-ident"></a> 1313 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-lifetime">ntp-keygen lifetime</a>, 1314 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-iffkey">ntp-keygen iffkey</a>, 1315 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1316 1.1.1.6 christos 1317 1.1 christos </div> 1318 1.1 christos 1319 1.1 christos <h4 class="subsection">ident option (-i)</h4> 1320 1.1 christos 1321 1.1 christos <p><a name="index-ntp_002dkeygen_002dident-11"></a> 1322 1.1 christos This is the “set autokey group name” option. 1323 1.1.1.6 christos This option takes a string argument <samp><span class="file">group</span></samp>. 1324 1.1 christos 1325 1.1 christos <p class="noindent">This option has some usage constraints. It: 1326 1.1 christos <ul> 1327 1.1 christos <li>must be compiled in by defining <code>AUTOKEY</code> during the compilation. 1328 1.1 christos </ul> 1329 1.1 christos 1330 1.1 christos <p>Set the optional Autokey group name to name. This is used in 1331 1.1 christos the file name of IFF, GQ, and MV client parameters files. In 1332 1.1 christos that role, the default is the host name if this option is not 1333 1.1 christos provided. The group name, if specified using <code>-i/--ident</code> or 1334 1.1 christos using <code>-s/--subject-name</code> following an '<code>}' character, 1335 1.1 christos is also a part of the self-signed host certificate's subject and 1336 1.1 christos issuer names in the form host 1337 1.1 christos <p>'crypto ident' or 'server ident' configuration in 1338 1.1 christos ntpd's configuration file. 1339 1.1 christos </code><div class="node"> 1340 1.1 christos <p><hr> 1341 1.1.1.6 christos <a name="ntp-keygen-lifetime"></a> 1342 1.1.1.6 christos <a name="ntp_002dkeygen-lifetime"></a> 1343 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-md5key">ntp-keygen md5key</a>, 1344 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-ident">ntp-keygen ident</a>, 1345 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1346 1.1.1.6 christos 1347 1.1 christos </div> 1348 1.1 christos 1349 1.1 christos <h4 class="subsection">lifetime option (-l)</h4> 1350 1.1 christos 1351 1.1 christos <p><a name="index-ntp_002dkeygen_002dlifetime-12"></a> 1352 1.1 christos This is the ``set certificate lifetime'' option. 1353 1.1.1.6 christos This option takes a number argument <samp><span class="file">lifetime</span></samp>. 1354 1.1 christos 1355 1.1 christos <p class="noindent">This option has some usage constraints. It: 1356 1.1 christos <ul> 1357 1.1 christos <li>must be compiled in by defining <code>AUTOKEY</code> during the compilation. 1358 1.1 christos </ul> 1359 1.1 christos 1360 1.1 christos <p>Set the certificate expiration to lifetime days from now. 1361 1.1 christos <div class="node"> 1362 1.1 christos <p><hr> 1363 1.1.1.6 christos <a name="ntp-keygen-md5key"></a> 1364 1.1.1.6 christos <a name="ntp_002dkeygen-md5key"></a> 1365 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-modulus">ntp-keygen modulus</a>, 1366 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-lifetime">ntp-keygen lifetime</a>, 1367 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1368 1.1.1.6 christos 1369 1.1 christos </div> 1370 1.1 christos 1371 1.1 christos <h4 class="subsection">md5key option (-M)</h4> 1372 1.1 christos 1373 1.1 christos <p><a name="index-ntp_002dkeygen_002dmd5key-13"></a> 1374 1.1 christos This is the ``generate md5 keys'' option. 1375 1.1 christos Generate MD5 keys, obsoleting any that may exist. 1376 1.1 christos <div class="node"> 1377 1.1 christos <p><hr> 1378 1.1.1.6 christos <a name="ntp-keygen-modulus"></a> 1379 1.1.1.6 christos <a name="ntp_002dkeygen-modulus"></a> 1380 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-pvt_002dcert">ntp-keygen pvt-cert</a>, 1381 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-md5key">ntp-keygen md5key</a>, 1382 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1383 1.1.1.6 christos 1384 1.1 christos </div> 1385 1.1 christos 1386 1.1 christos <h4 class="subsection">modulus option (-m)</h4> 1387 1.1 christos 1388 1.1 christos <p><a name="index-ntp_002dkeygen_002dmodulus-14"></a> 1389 1.1 christos This is the ``modulus'' option. 1390 1.1.1.6 christos This option takes a number argument <samp><span class="file">modulus</span></samp>. 1391 1.1 christos 1392 1.1 christos <p class="noindent">This option has some usage constraints. It: 1393 1.1 christos <ul> 1394 1.1 christos <li>must be compiled in by defining <code>AUTOKEY</code> during the compilation. 1395 1.1 christos </ul> 1396 1.1 christos 1397 1.1 christos <p>The number of bits in the prime modulus. The default is 512. 1398 1.1 christos <div class="node"> 1399 1.1 christos <p><hr> 1400 1.1.1.6 christos <a name="ntp-keygen-pvt-cert"></a> 1401 1.1.1.6 christos <a name="ntp_002dkeygen-pvt_002dcert"></a> 1402 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-password">ntp-keygen password</a>, 1403 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-modulus">ntp-keygen modulus</a>, 1404 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1405 1.1.1.6 christos 1406 1.1 christos </div> 1407 1.1 christos 1408 1.1 christos <h4 class="subsection">pvt-cert option (-P)</h4> 1409 1.1 christos 1410 1.1 christos <p><a name="index-ntp_002dkeygen_002dpvt_002dcert-15"></a> 1411 1.1 christos This is the ``generate pc private certificate'' option. 1412 1.1 christos 1413 1.1 christos <p class="noindent">This option has some usage constraints. It: 1414 1.1 christos <ul> 1415 1.1 christos <li>must be compiled in by defining <code>AUTOKEY</code> during the compilation. 1416 1.1 christos </ul> 1417 1.1 christos 1418 1.1 christos <p>Generate a private certificate. By default, the program generates 1419 1.1 christos public certificates. 1420 1.1 christos <div class="node"> 1421 1.1 christos <p><hr> 1422 1.1.1.6 christos <a name="ntp-keygen-password"></a> 1423 1.1.1.6 christos <a name="ntp_002dkeygen-password"></a> 1424 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-export_002dpasswd">ntp-keygen export-passwd</a>, 1425 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-pvt_002dcert">ntp-keygen pvt-cert</a>, 1426 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1427 1.1.1.6 christos 1428 1.1 christos </div> 1429 1.1 christos 1430 1.1.1.2 christos <h4 class="subsection">password option (-p)</h4> 1431 1.1 christos 1432 1.1.1.2 christos <p><a name="index-ntp_002dkeygen_002dpassword-16"></a> 1433 1.1.1.2 christos This is the ``local private password'' option. 1434 1.1.1.6 christos This option takes a string argument <samp><span class="file">passwd</span></samp>. 1435 1.1 christos 1436 1.1 christos <p class="noindent">This option has some usage constraints. It: 1437 1.1 christos <ul> 1438 1.1 christos <li>must be compiled in by defining <code>AUTOKEY</code> during the compilation. 1439 1.1 christos </ul> 1440 1.1 christos 1441 1.1.1.2 christos <p>Local files containing private data are encrypted with the 1442 1.1.1.2 christos DES-CBC algorithm and the specified password. The same password 1443 1.1.1.2 christos must be specified to the local ntpd via the "crypto pw password" 1444 1.1.1.2 christos configuration command. The default password is the local 1445 1.1.1.2 christos hostname. 1446 1.1 christos <div class="node"> 1447 1.1 christos <p><hr> 1448 1.1.1.6 christos <a name="ntp-keygen-export-passwd"></a> 1449 1.1.1.6 christos <a name="ntp_002dkeygen-export_002dpasswd"></a> 1450 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-sign_002dkey">ntp-keygen sign-key</a>, 1451 1.1.1.2 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-password">ntp-keygen password</a>, 1452 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1453 1.1.1.6 christos 1454 1.1 christos </div> 1455 1.1 christos 1456 1.1.1.2 christos <h4 class="subsection">export-passwd option (-q)</h4> 1457 1.1 christos 1458 1.1.1.2 christos <p><a name="index-ntp_002dkeygen_002dexport_002dpasswd-17"></a> 1459 1.1.1.2 christos This is the ``export iff or gq group keys with password'' option. 1460 1.1.1.6 christos This option takes a string argument <samp><span class="file">passwd</span></samp>. 1461 1.1 christos 1462 1.1 christos <p class="noindent">This option has some usage constraints. It: 1463 1.1 christos <ul> 1464 1.1 christos <li>must be compiled in by defining <code>AUTOKEY</code> during the compilation. 1465 1.1 christos </ul> 1466 1.1 christos 1467 1.1.1.2 christos <p>Export IFF or GQ identity group keys to the standard output, 1468 1.1.1.2 christos encrypted with the DES-CBC algorithm and the specified password. 1469 1.1.1.2 christos The same password must be specified to the remote ntpd via the 1470 1.1.1.2 christos "crypto pw password" configuration command. See also the option 1471 1.1.1.2 christos --id-key (-e) for unencrypted exports. 1472 1.1 christos <div class="node"> 1473 1.1 christos <p><hr> 1474 1.1.1.6 christos <a name="ntp-keygen-sign-key"></a> 1475 1.1.1.6 christos <a name="ntp_002dkeygen-sign_002dkey"></a> 1476 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-subject_002dname">ntp-keygen subject-name</a>, 1477 1.1.1.2 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-export_002dpasswd">ntp-keygen export-passwd</a>, 1478 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1479 1.1.1.6 christos 1480 1.1 christos </div> 1481 1.1 christos 1482 1.1 christos <h4 class="subsection">sign-key option (-S)</h4> 1483 1.1 christos 1484 1.1 christos <p><a name="index-ntp_002dkeygen_002dsign_002dkey-18"></a> 1485 1.1 christos This is the ``generate sign key (rsa or dsa)'' option. 1486 1.1.1.6 christos This option takes a string argument <samp><span class="file">sign</span></samp>. 1487 1.1 christos 1488 1.1 christos <p class="noindent">This option has some usage constraints. It: 1489 1.1 christos <ul> 1490 1.1 christos <li>must be compiled in by defining <code>AUTOKEY</code> during the compilation. 1491 1.1 christos </ul> 1492 1.1 christos 1493 1.1 christos <p>Generate a new sign key of the designated type, obsoleting any 1494 1.1 christos that may exist. By default, the program uses the host key as the 1495 1.1 christos sign key. 1496 1.1 christos <div class="node"> 1497 1.1 christos <p><hr> 1498 1.1.1.6 christos <a name="ntp-keygen-subject-name"></a> 1499 1.1.1.6 christos <a name="ntp_002dkeygen-subject_002dname"></a> 1500 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-trusted_002dcert">ntp-keygen trusted-cert</a>, 1501 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-sign_002dkey">ntp-keygen sign-key</a>, 1502 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1503 1.1.1.6 christos 1504 1.1 christos </div> 1505 1.1 christos 1506 1.1 christos <h4 class="subsection">subject-name option (-s)</h4> 1507 1.1 christos 1508 1.1 christos <p><a name="index-ntp_002dkeygen_002dsubject_002dname-19"></a> 1509 1.1 christos This is the ``set host and optionally group name'' option. 1510 1.1.1.6 christos This option takes a string argument <samp><span class="file">host@group</span></samp>. 1511 1.1 christos 1512 1.1 christos <p class="noindent">This option has some usage constraints. It: 1513 1.1 christos <ul> 1514 1.1 christos <li>must be compiled in by defining <code>AUTOKEY</code> during the compilation. 1515 1.1 christos </ul> 1516 1.1 christos 1517 1.1 christos <p>Set the Autokey host name, and optionally, group name specified 1518 1.1 christos following an '<code>}' character. The host name is used in the file 1519 1.1 christos name of generated host and signing certificates, without the 1520 1.1 christos group name. The host name, and if provided, group name are used 1521 1.1 christos in host 1522 1.1 christos <p>fields. Specifying '-s 1523 1.1 christos <p>leaving the host name unchanged while appending 1524 1.1 christos <p>subject and issuer fields, as with -i group. The group name, or 1525 1.1 christos if not provided, the host name are also used in the file names 1526 1.1 christos of IFF, GQ, and MV client parameter files. 1527 1.1 christos </code><div class="node"> 1528 1.1 christos <p><hr> 1529 1.1.1.6 christos <a name="ntp-keygen-trusted-cert"></a> 1530 1.1.1.6 christos <a name="ntp_002dkeygen-trusted_002dcert"></a> 1531 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-mv_002dparams">ntp-keygen mv-params</a>, 1532 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-subject_002dname">ntp-keygen subject-name</a>, 1533 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1534 1.1.1.6 christos 1535 1.1 christos </div> 1536 1.1 christos 1537 1.1 christos <h4 class="subsection">trusted-cert option (-T)</h4> 1538 1.1 christos 1539 1.1 christos <p><a name="index-ntp_002dkeygen_002dtrusted_002dcert-20"></a> 1540 1.1 christos This is the ``trusted certificate (tc scheme)'' option. 1541 1.1 christos 1542 1.1 christos <p class="noindent">This option has some usage constraints. It: 1543 1.1 christos <ul> 1544 1.1 christos <li>must be compiled in by defining <code>AUTOKEY</code> during the compilation. 1545 1.1 christos </ul> 1546 1.1 christos 1547 1.1 christos <p>Generate a trusted certificate. By default, the program generates 1548 1.1 christos a non-trusted certificate. 1549 1.1 christos <div class="node"> 1550 1.1 christos <p><hr> 1551 1.1.1.6 christos <a name="ntp-keygen-mv-params"></a> 1552 1.1.1.6 christos <a name="ntp_002dkeygen-mv_002dparams"></a> 1553 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-mv_002dkeys">ntp-keygen mv-keys</a>, 1554 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-trusted_002dcert">ntp-keygen trusted-cert</a>, 1555 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1556 1.1.1.6 christos 1557 1.1 christos </div> 1558 1.1 christos 1559 1.1 christos <h4 class="subsection">mv-params option (-V)</h4> 1560 1.1 christos 1561 1.1 christos <p><a name="index-ntp_002dkeygen_002dmv_002dparams-21"></a> 1562 1.1 christos This is the ``generate <num> mv parameters'' option. 1563 1.1.1.6 christos This option takes a number argument <samp><span class="file">num</span></samp>. 1564 1.1 christos 1565 1.1 christos <p class="noindent">This option has some usage constraints. It: 1566 1.1 christos <ul> 1567 1.1 christos <li>must be compiled in by defining <code>AUTOKEY</code> during the compilation. 1568 1.1 christos </ul> 1569 1.1 christos 1570 1.1 christos <p>Generate parameters and keys for the Mu-Varadharajan (MV) 1571 1.1 christos identification scheme. 1572 1.1 christos <div class="node"> 1573 1.1 christos <p><hr> 1574 1.1.1.6 christos <a name="ntp-keygen-mv-keys"></a> 1575 1.1.1.6 christos <a name="ntp_002dkeygen-mv_002dkeys"></a> 1576 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-config">ntp-keygen config</a>, 1577 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-mv_002dparams">ntp-keygen mv-params</a>, 1578 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1579 1.1.1.6 christos 1580 1.1 christos </div> 1581 1.1 christos 1582 1.1 christos <h4 class="subsection">mv-keys option (-v)</h4> 1583 1.1 christos 1584 1.1 christos <p><a name="index-ntp_002dkeygen_002dmv_002dkeys-22"></a> 1585 1.1 christos This is the ``update <num> mv keys'' option. 1586 1.1.1.6 christos This option takes a number argument <samp><span class="file">num</span></samp>. 1587 1.1 christos 1588 1.1 christos <p class="noindent">This option has some usage constraints. It: 1589 1.1 christos <ul> 1590 1.1 christos <li>must be compiled in by defining <code>AUTOKEY</code> during the compilation. 1591 1.1 christos </ul> 1592 1.1 christos 1593 1.1.1.6 christos <p>This option has no `<samp><span class="samp">doc</span></samp>' documentation. 1594 1.1 christos 1595 1.1 christos <div class="node"> 1596 1.1 christos <p><hr> 1597 1.1.1.6 christos <a name="ntp-keygen-config"></a> 1598 1.1.1.6 christos <a name="ntp_002dkeygen-config"></a> 1599 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-exit-status">ntp-keygen exit status</a>, 1600 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-mv_002dkeys">ntp-keygen mv-keys</a>, 1601 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1602 1.1.1.6 christos 1603 1.1 christos </div> 1604 1.1 christos 1605 1.1 christos <h4 class="subsection">presetting/configuring ntp-keygen</h4> 1606 1.1 christos 1607 1.1 christos <p>Any option that is not marked as <i>not presettable</i> may be preset by 1608 1.1 christos loading values from configuration ("rc" or "ini") files, and values from environment variables named <code>NTP-KEYGEN</code> and <code>NTP-KEYGEN_<OPTION_NAME></code>. <code><OPTION_NAME></code> must be one of 1609 1.1 christos the options listed above in upper case and segmented with underscores. 1610 1.1 christos The <code>NTP-KEYGEN</code> variable will be tokenized and parsed like 1611 1.1 christos the command line. The remaining variables are tested for existence and their 1612 1.1 christos values are treated like option arguments. 1613 1.1 christos 1614 1.1 christos <p class="noindent"><code>libopts</code> will search in 2 places for configuration files: 1615 1.1 christos <ul> 1616 1.1 christos <li>$HOME 1617 1.1 christos <li>$PWD 1618 1.1 christos </ul> 1619 1.1 christos The environment variables <code>HOME</code>, and <code>PWD</code> 1620 1.1.1.6 christos are expanded and replaced when <samp><span class="file">ntp-keygen</span></samp> runs. 1621 1.1 christos For any of these that are plain files, they are simply processed. 1622 1.1.1.6 christos For any that are directories, then a file named <samp><span class="file">.ntprc</span></samp> is searched for 1623 1.1 christos within that directory and processed. 1624 1.1 christos 1625 1.1 christos <p>Configuration files may be in a wide variety of formats. 1626 1.1 christos The basic format is an option name followed by a value (argument) on the 1627 1.1 christos same line. Values may be separated from the option name with a colon, 1628 1.1 christos equal sign or simply white space. Values may be continued across multiple 1629 1.1 christos lines by escaping the newline with a backslash. 1630 1.1 christos 1631 1.1 christos <p>Multiple programs may also share the same initialization file. 1632 1.1 christos Common options are collected at the top, followed by program specific 1633 1.1 christos segments. The segments are separated by lines like: 1634 1.1 christos <pre class="example"> [NTP-KEYGEN] 1635 1.1 christos </pre> 1636 1.1 christos <p class="noindent">or by 1637 1.1 christos <pre class="example"> <?program ntp-keygen> 1638 1.1 christos </pre> 1639 1.1 christos <p class="noindent">Do not mix these styles within one configuration file. 1640 1.1 christos 1641 1.1 christos <p>Compound values and carefully constructed string values may also be 1642 1.1 christos specified using XML syntax: 1643 1.1 christos <pre class="example"> <option-name> 1644 1.1 christos <sub-opt>...&lt;...&gt;...</sub-opt> 1645 1.1 christos </option-name> 1646 1.1 christos </pre> 1647 1.1 christos <p class="noindent">yielding an <code>option-name.sub-opt</code> string value of 1648 1.1 christos <pre class="example"> "...<...>..." 1649 1.1 christos </pre> 1650 1.1 christos <p><code>AutoOpts</code> does not track suboptions. You simply note that it is a 1651 1.1 christos hierarchicly valued option. <code>AutoOpts</code> does provide a means for searching 1652 1.1 christos the associated name/value pair list (see: optionFindValue). 1653 1.1 christos 1654 1.1 christos <p>The command line options relating to configuration and/or usage help are: 1655 1.1 christos 1656 1.1 christos <h5 class="subsubheading">version (-)</h5> 1657 1.1 christos 1658 1.1 christos <p>Print the program version to standard out, optionally with licensing 1659 1.1 christos information, then exit 0. The optional argument specifies how much licensing 1660 1.1 christos detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument. 1661 1.1 christos Only the first letter of the argument is examined: 1662 1.1 christos 1663 1.1 christos <dl> 1664 1.1.1.6 christos <dt>`<samp><span class="samp">version</span></samp>'<dd>Only print the version. This is the default. 1665 1.1.1.6 christos <br><dt>`<samp><span class="samp">copyright</span></samp>'<dd>Name the copyright usage licensing terms. 1666 1.1.1.6 christos <br><dt>`<samp><span class="samp">verbose</span></samp>'<dd>Print the full copyright usage licensing terms. 1667 1.1 christos </dl> 1668 1.1 christos 1669 1.1 christos <div class="node"> 1670 1.1 christos <p><hr> 1671 1.1.1.6 christos <a name="ntp-keygen-exit-status"></a> 1672 1.1.1.6 christos <a name="ntp_002dkeygen-exit-status"></a> 1673 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-Usage">ntp-keygen Usage</a>, 1674 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-config">ntp-keygen config</a>, 1675 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1676 1.1.1.6 christos 1677 1.1 christos </div> 1678 1.1 christos 1679 1.1 christos <h4 class="subsection">ntp-keygen exit status</h4> 1680 1.1 christos 1681 1.1 christos <p>One of the following exit values will be returned: 1682 1.1 christos <dl> 1683 1.1.1.6 christos <dt>`<samp><span class="samp">0 (EXIT_SUCCESS)</span></samp>'<dd>Successful program execution. 1684 1.1.1.6 christos <br><dt>`<samp><span class="samp">1 (EXIT_FAILURE)</span></samp>'<dd>The operation failed or the command syntax was not valid. 1685 1.1.1.6 christos <br><dt>`<samp><span class="samp">66 (EX_NOINPUT)</span></samp>'<dd>A specified configuration file could not be loaded. 1686 1.1.1.6 christos <br><dt>`<samp><span class="samp">70 (EX_SOFTWARE)</span></samp>'<dd>libopts had an internal operational error. Please report 1687 1.1 christos it to autogen-users (a] lists.sourceforge.net. Thank you. 1688 1.1 christos </dl> 1689 1.1 christos <div class="node"> 1690 1.1 christos <p><hr> 1691 1.1.1.6 christos <a name="ntp-keygen-Usage"></a> 1692 1.1.1.6 christos <a name="ntp_002dkeygen-Usage"></a> 1693 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-Notes">ntp-keygen Notes</a>, 1694 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-exit-status">ntp-keygen exit status</a>, 1695 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1696 1.1.1.6 christos 1697 1.1 christos </div> 1698 1.1 christos 1699 1.1 christos <h4 class="subsection">ntp-keygen Usage</h4> 1700 1.1 christos 1701 1.1 christos <div class="node"> 1702 1.1 christos <p><hr> 1703 1.1.1.6 christos <a name="ntp-keygen-Notes"></a> 1704 1.1.1.6 christos <a name="ntp_002dkeygen-Notes"></a> 1705 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#ntp_002dkeygen-Bugs">ntp-keygen Bugs</a>, 1706 1.1 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-Usage">ntp-keygen Usage</a>, 1707 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1708 1.1.1.6 christos 1709 1.1 christos </div> 1710 1.1 christos 1711 1.1 christos <h4 class="subsection">ntp-keygen Notes</h4> 1712 1.1 christos 1713 1.1 christos <div class="node"> 1714 1.1 christos <p><hr> 1715 1.1.1.6 christos <a name="ntp-keygen-Bugs"></a> 1716 1.1.1.6 christos <a name="ntp_002dkeygen-Bugs"></a> 1717 1.1.1.6 christos Previous: <a rel="previous" accesskey="p" href="#ntp_002dkeygen-Notes">ntp-keygen Notes</a>, 1718 1.1 christos Up: <a rel="up" accesskey="u" href="#ntp_002dkeygen-Invocation">ntp-keygen Invocation</a> 1719 1.1.1.6 christos 1720 1.1 christos </div> 1721 1.1 christos 1722 1.1 christos <h4 class="subsection">ntp-keygen Bugs</h4> 1723 1.1 christos 1724 1.1 christos <div class="node"> 1725 1.1 christos <p><hr> 1726 1.1.1.6 christos <a name="Random-Seed-File"></a> 1727 1.1.1.6 christos Next: <a rel="next" accesskey="n" href="#Cryptographic-Data-Files">Cryptographic Data Files</a>, 1728 1.1 christos Previous: <a rel="previous" accesskey="p" href="#Running-the-Program">Running the Program</a>, 1729 1.1 christos Up: <a rel="up" accesskey="u" href="#Top">Top</a> 1730 1.1.1.6 christos 1731 1.1 christos </div> 1732 1.1 christos 1733 1.1 christos <!-- node-name, next, previous, up --> 1734 1.1 christos <h3 class="section">Random Seed File</h3> 1735 1.1 christos 1736 1.1 christos <p>All cryptographically sound key generation schemes must have means to 1737 1.1 christos randomize the entropy seed used to initialize the internal 1738 1.1 christos pseudo-random number generator used by the OpenSSL library routines. 1739 1.1 christos If a site supports ssh, it is very likely that means to do this are 1740 1.1 christos already available. 1741 1.1 christos The entropy seed used by the OpenSSL library is contained in a file, 1742 1.1 christos usually called <code>.rnd</code>, which must be available when 1743 1.1 christos starting the <code>ntp-keygen</code> program or <code>ntpd</code> daemon. 1744 1.1 christos 1745 1.1 christos <p>The OpenSSL library looks for the file using the path specified by the 1746 1.1 christos <code>RANDFILE</code> environment variable in the user home directory, whether root 1747 1.1 christos or some other user. 1748 1.1 christos If the <code>RANDFILE</code> environment variable is not 1749 1.1 christos present, the library looks for the <code>.rnd</code> file in the user home 1750 1.1 christos directory. 1751 1.1 christos Since both the <code>ntp-keygen</code> program and <code>ntpd</code> daemon must run 1752 1.1 christos as root, the logical place to put this file is in <code>/.rnd</code> or 1753 1.1 christos <code>/root/.rnd</code>. 1754 1.1 christos If the file is not available or cannot be written, the program exits 1755 1.1 christos with a message to the system log. 1756 1.1 christos 1757 1.1 christos <div class="node"> 1758 1.1 christos <p><hr> 1759 1.1.1.6 christos <a name="Cryptographic-Data-Files"></a> 1760 1.1.1.6 christos Previous: <a rel="previous" accesskey="p" href="#Random-Seed-File">Random Seed File</a>, 1761 1.1 christos Up: <a rel="up" accesskey="u" href="#Top">Top</a> 1762 1.1.1.6 christos 1763 1.1 christos </div> 1764 1.1 christos 1765 1.1 christos <!-- node-name, next, previous, up --> 1766 1.1 christos <h3 class="section">Cryptographic Data Files</h3> 1767 1.1 christos 1768 1.1 christos <p>File and link names are in the <code>form ntpkey_key_name.fstamp</code>, 1769 1.1 christos where <code>key</code> is the key or parameter type, 1770 1.1 christos <code>name</code> is the host or group name and 1771 1.1 christos <code>fstamp</code> is the filestamp (NTP seconds) when the file was created). 1772 1.1 christos By convention, key names in generated file names include both upper and 1773 1.1 christos lower case characters, while key names in generated link names include 1774 1.1 christos only lower case characters. The filestamp is not used in generated link 1775 1.1 christos names. 1776 1.1 christos 1777 1.1 christos <p>The key name is a string defining the cryptographic key type. 1778 1.1 christos Key types include public/private keys host and sign, certificate cert 1779 1.1 christos and several challenge/response key types. 1780 1.1 christos By convention, client files used for 1781 1.1 christos challenges have a par subtype, as in the IFF challenge IFFpar, while 1782 1.1 christos server files for responses have a key subtype, as in the GQ response 1783 1.1 christos GQkey. 1784 1.1 christos 1785 1.1 christos <p>All files begin with two nonencrypted lines. The first line contains 1786 1.1 christos the file name in the format <code>ntpkey_key_host.fstamp</code>. 1787 1.1 christos The second line contains the datestamp in conventional Unix date format. 1788 1.1 christos Lines beginning with <code>#</code> are ignored. 1789 1.1 christos 1790 1.1 christos <p>The remainder of the file contains cryptographic data encoded first 1791 1.1 christos using ASN.1 rules, then encrypted using the DES-CBC algorithm with 1792 1.1 christos given password and finally written in PEM-encoded printable ASCII text 1793 1.1 christos preceded and followed by MIME content identifier lines. 1794 1.1 christos 1795 1.1 christos <p>The format of the symmetric keys file, ordinarily named <code>ntp.keys</code>, 1796 1.1 christos is somewhat different than the other files in the interest of backward 1797 1.1 christos compatibility. 1798 1.1 christos Ordinarily, the file is generated by this program, but 1799 1.1 christos it can be constructed and edited using an ordinary text editor. 1800 1.1 christos 1801 1.1 christos <pre class="example"> # ntpkey_MD5key_hms.local.3564038757 1802 1.1 christos # Sun Dec 9 02:45:57 2012 1803 1.1 christos 1804 1.1 christos 1 MD5 "]!ghT%O;3)WJ,/Nc:>I # MD5 key 1805 1.1 christos 2 MD5 lu+H^tF46BKR-6~pV_5 # MD5 key 1806 1.1 christos 3 MD5 :lnoVsE%Yz*avh%EtNC # MD5 key 1807 1.1 christos 4 MD5 |fdZrf0sF~^V # MD5 key 1808 1.1 christos 5 MD5 IyAG>O"y"LmCRS!*bHC # MD5 key 1809 1.1 christos 6 MD5 ">e\A # MD5 key 1810 1.1 christos 7 MD5 c9x=M'CfLxax9v)PV-si # MD5 key 1811 1.1 christos 8 MD5 E|=jvFVov?Bn|Ev=&aK\ # MD5 key 1812 1.1 christos 9 MD5 T!c4UT&`(m$+m+B6,`Q0 # MD5 key 1813 1.1 christos 10 MD5 JVF/1=)=IFbHbJQz..Cd # MD5 key 1814 1.1 christos 11 SHA1 6dea311109529e436c2b4fccae9bc753c16d1b48 # SHA1 key 1815 1.1 christos 12 SHA1 7076f373d86c4848c59ff8046e49cb7d614ec394 # SHA1 key 1816 1.1 christos 13 SHA1 5f48b1b60591eb01b7cf1d33b7774f08d20262d3 # SHA1 key 1817 1.1 christos 14 SHA1 eed5ab9d9497319ec60cf3781d52607e76720178 # SHA1 key 1818 1.1 christos 15 SHA1 f283562611a04c964da8126296f5f8e58c3f85de # SHA1 key 1819 1.1 christos 16 SHA1 1930da171297dd63549af50b29449de17dcf341f # SHA1 key 1820 1.1 christos 17 SHA1 fee892110358cd4382322b889869e750db8e8a8f # SHA1 key 1821 1.1 christos 18 SHA1 b5520c9fadd7ad3fd8bfa061c8821b65d029bb37 # SHA1 key 1822 1.1 christos 19 SHA1 8c74fb440ec80f453ec6aaa62b9baed0ab723b92 # SHA1 key 1823 1.1 christos 20 SHA1 6bc05f734306a189326000970c19b3910f403795 # SHA1 key 1824 1.1 christos </pre> 1825 1.1 christos <p>Figure 1. Typical Symmetric Key File 1826 1.1 christos 1827 1.1 christos <p>Figure 1 shows a typical symmetric keys file used by the reference 1828 1.1 christos implementation. 1829 1.1 christos Each line of the file contains three fields, first an 1830 1.1 christos integer between 1 and 65534, inclusive, representing the key identifier 1831 1.1 christos used in the server and peer configuration commands. 1832 1.1 christos Next is the key type for the message digest algorithm, 1833 1.1 christos which in the absence of the 1834 1.1 christos OpenSSL library must be MD5 to designate the MD5 message digest 1835 1.1 christos algorithm. 1836 1.1 christos If the OpenSSL library is installed, the key type can be any 1837 1.1 christos message digest algorithm supported by that library. 1838 1.1 christos However, if 1839 1.1 christos compatibility with FIPS 140-2 is required, the key type must be either 1840 1.1 christos SHA or SHA1. 1841 1.1 christos The key type can be changed using an ASCII text editor. 1842 1.1 christos 1843 1.1 christos <p>An MD5 key consists of a printable ASCII string less than or equal to 1844 1.1 christos 16 characters and terminated by whitespace or a # character. 1845 1.1 christos An OpenSSL 1846 1.1 christos key consists of a hex-encoded ASCII string of 40 characters, which is 1847 1.1 christos truncated as necessary. 1848 1.1 christos 1849 1.1 christos <p>Note that the keys used by the <code>ntpq</code> and <code>ntpdc</code> programs are 1850 1.1 christos checked against passwords requested by the programs and entered by hand, 1851 1.1 christos so it 1852 1.1 christos is generally appropriate to specify these keys in human readable ASCII 1853 1.1 christos format. 1854 1.1 christos 1855 1.1 christos <p>The <code>ntp-keygen</code> program generates a MD5 symmetric keys file 1856 1.1 christos <code>ntpkey_MD5key_hostname.filestamp</code>. 1857 1.1 christos Since the file contains private 1858 1.1 christos shared keys, it should be visible only to root and distributed by 1859 1.1 christos secure means to other subnet hosts. 1860 1.1 christos The NTP daemon loads the file <code>ntp.keys</code>, so <code>ntp-keygen</code> 1861 1.1 christos installs a soft link from this name to the generated file. 1862 1.1 christos Subsequently, similar soft links must be installed by 1863 1.1 christos manual or automated means on the other subnet hosts. 1864 1.1 christos While this file is 1865 1.1 christos not used with the Autokey Version 2 protocol, it is needed to 1866 1.1 christos authenticate some remote configuration commands used by the <code>ntpq</code> and 1867 1.1 christos <code>ntpdc</code> utilities. 1868 1.1 christos 1869 1.1 christos </body></html> 1870 1.1 christos 1871
Indexes created Wed Aug 26 00:26:28 UTC 2026