contrib/ntp/ntpd/invoke-ntp.keys.texi

   1 @node ntp.keys Notes
   2 @section Notes about ntp.keys
   3 @pindex ntp.keys
   4 @cindex NTP symmetric key file format
   5 @ignore
   6 #
   7 # EDIT THIS FILE WITH CAUTION  (invoke-ntp.keys.texi)
   8 #
   9 # It has been AutoGen-ed  April 26, 2016 at 08:28:30 PM by AutoGen 5.18.5
  10 # From the definitions    ntp.keys.def
  11 # and the template file   agtexi-file.tpl
  12 @end ignore
  13
  14
  15
  16 This document describes the format of an NTP symmetric key file.
  17 For a description of the use of this type of file, see the
  18 "Authentication Support"
  19 section of the
  20 @code{ntp.conf(5)}
  21 page.
  22
  23 @code{ntpd(8)}
  24 reads its keys from a file specified using the
  25 @code{-k}
  26 command line option or the
  27 @code{keys}
  28 statement in the configuration file.
  29 While key number 0 is fixed by the NTP standard
  30 (as 56 zero bits)
  31 and may not be changed,
  32 one or more keys numbered between 1 and 65534
  33 may be arbitrarily set in the keys file.
  34
  35 The key file uses the same comment conventions
  36 as the configuration file.
  37 Key entries use a fixed format of the form
  38
  39 @example
  40 @kbd{keyno} @kbd{type} @kbd{key} @kbd{opt_IP_list}
  41 @end example
  42
  43 where
  44 @kbd{keyno}
  45 is a positive integer (between 1 and 65534),
  46 @kbd{type}
  47 is the message digest algorithm,
  48 and
  49 @kbd{key}
  50 is the key itself, and
  51 @kbd{opt_IP_list}
  52 is an optional comma-separated list of IPs
  53 that are allowed to serve time.
  54 If
  55 @kbd{opt_IP_list}
  56 is empty,
  57 any properly-authenticated server message will be
  58 accepted.
  59
  60 The
  61 @kbd{key}
  62 may be given in a format
  63 controlled by the
  64 @kbd{type}
  65 field.
  66 The
  67 @kbd{type}
  68 @code{MD5}
  69 is always supported.
  70 If
  71 @code{ntpd}
  72 was built with the OpenSSL library
  73 then any digest library supported by that library may be specified.
  74 However, if compliance with FIPS 140-2 is required the
  75 @kbd{type}
  76 must be either
  77 @code{SHA}
  78 or
  79 @code{SHA1}.
  80
  81 What follows are some key types, and corresponding formats:
  82
  83 @table @asis
  84 @item @code{MD5}
  85 The key is 1 to 16 printable characters terminated by
  86 an EOL,
  87 whitespace,
  88 or
  89 a
  90 @code{#}
  91 (which is the "start of comment" character).
  92
  93 @item @code{SHA}
  94 @item @code{SHA1}
  95 @item @code{RMD160}
  96 The key is a hex-encoded ASCII string of 40 characters,
  97 which is truncated as necessary.
  98 @end table
  99
 100 Note that the keys used by the
 101 @code{ntpq(8)}
 102 and
 103 @code{ntpdc(8)}
 104 programs are checked against passwords
 105 requested by the programs and entered by hand,
 106 so it is generally appropriate to specify these keys in ASCII format.
 107
 108 This section was generated by @strong{AutoGen},
 109 using the @code{agtexi-cmd} template and the option descriptions for the @code{ntp.keys} program.
 110 This software is released under the NTP license, <http://ntp.org/license>.
 111
 112 @menu
 113 * ntp.keys Files::                  Files
 114 * ntp.keys See Also::               See Also
 115 * ntp.keys Notes::                  Notes
 116 @end menu
 117
 118 @node ntp.keys Files
 119 @subsection ntp.keys Files
 120 @table @asis
 121 @item @file{/etc/ntp.keys}
 122 the default name of the configuration file
 123 @end table
 124 @node ntp.keys See Also
 125 @subsection ntp.keys See Also
 126 @code{ntp.conf(5)},
 127 @code{ntpd(1ntpdmdoc)},
 128 @code{ntpdate(1ntpdatemdoc)},
 129 @code{ntpdc(1ntpdcmdoc)},
 130 @code{sntp(1sntpmdoc)}
 131 @node ntp.keys Notes
 132 @subsection ntp.keys Notes
 133 This document was derived from FreeBSD.