contrib/ntp/ntpd/ntp.keys.5man

   1 .TH ntp.keys 5man "26 Apr 2016" "4.2.8p7" "File Formats"
   2 .\"
   3 .\"  EDIT THIS FILE WITH CAUTION  (ntp.man)
   4 .\"
   5 .\"  It has been AutoGen-ed  April 26, 2016 at 08:28:19 PM by AutoGen 5.18.5
   6 .\"  From the definitions    ntp.keys.def
   7 .\"  and the template file   agman-file.tpl
   8 .Sh NAME
   9 .Nm ntp.keys
  10 .Nd NTP symmetric key file format
  11
  12 .\"
  13 .SH NAME
  14 ntp.keys \- NTP symmetric key file format configuration file
  15 .de1 NOP
  16 .  it 1 an-trap
  17 .  if \\n[.$] \,\\$*\/
  18 ..
  19 .ie t \
  20 .ds B-Font [CB]
  21 .ds I-Font [CI]
  22 .ds R-Font [CR]
  23 .el \
  24 .ds B-Font B
  25 .ds I-Font I
  26 .ds R-Font R
  27 .SH SYNOPSIS
  28 \f\*[B-Font]\fP
  29 [\f\*[B-Font]\-\-option-name\f[]]
  30 [\f\*[B-Font]\-\-option-name\f[] \f\*[I-Font]value\f[]]
  31 .sp \n(Ppu
  32 .ne 2
  33
  34 All arguments must be options.
  35 .sp \n(Ppu
  36 .ne 2
  37
  38 .SH DESCRIPTION
  39 This document describes the format of an NTP symmetric key file.
  40 For a description of the use of this type of file, see the
  41 "Authentication Support"
  42 section of the
  43 \fCntp.conf\f[]\fR(5)\f[]
  44 page.
  45 .sp \n(Ppu
  46 .ne 2
  47
  48 \fCntpd\f[]\fR(8)\f[]
  49 reads its keys from a file specified using the
  50 \f\*[B-Font]\-k\f[]
  51 command line option or the
  52 \f\*[B-Font]keys\f[]
  53 statement in the configuration file.
  54 While key number 0 is fixed by the NTP standard
  55 (as 56 zero bits)
  56 and may not be changed,
  57 one or more keys numbered between 1 and 65534
  58 may be arbitrarily set in the keys file.
  59 .sp \n(Ppu
  60 .ne 2
  61
  62 The key file uses the same comment conventions
  63 as the configuration file.
  64 Key entries use a fixed format of the form
  65 .sp \n(Ppu
  66 .ne 2
  67
  68 .in +4
  69 \f\*[I-Font]keyno\f[] \f\*[I-Font]type\f[] \f\*[I-Font]key\f[] \f\*[I-Font]opt_IP_list\f[]
  70 .in -4
  71 .sp \n(Ppu
  72 .ne 2
  73
  74 where
  75 \f\*[I-Font]keyno\f[]
  76 is a positive integer (between 1 and 65534),
  77 \f\*[I-Font]type\f[]
  78 is the message digest algorithm,
  79 and
  80 \f\*[I-Font]key\f[]
  81 is the key itself, and
  82 \f\*[I-Font]opt_IP_list\f[]
  83 is an optional comma-separated list of IPs
  84 that are allowed to serve time.
  85 If
  86 \f\*[I-Font]opt_IP_list\f[]
  87 is empty,
  88 any properly-authenticated server message will be
  89 accepted.
  90 .sp \n(Ppu
  91 .ne 2
  92
  93 The
  94 \f\*[I-Font]key\f[]
  95 may be given in a format
  96 controlled by the
  97 \f\*[I-Font]type\f[]
  98 field.
  99 The
 100 \f\*[I-Font]type\f[]
 101 \f[C]MD5\f[]
 102 is always supported.
 103 If
 104 \f[C]ntpd\f[]
 105 was built with the OpenSSL library
 106 then any digest library supported by that library may be specified.
 107 However, if compliance with FIPS 140-2 is required the
 108 \f\*[I-Font]type\f[]
 109 must be either
 110 \f[C]SHA\f[]
 111 or
 112 \f[C]SHA1\f[].
 113 .sp \n(Ppu
 114 .ne 2
 115
 116 What follows are some key types, and corresponding formats:
 117 .sp \n(Ppu
 118 .ne 2
 119
 120 .TP 7
 121 .NOP \f[C]MD5\f[]
 122 The key is 1 to 16 printable characters terminated by
 123 an EOL,
 124 whitespace,
 125 or
 126 a
 127 \f[C]#\f[]
 128 (which is the "start of comment" character).
 129 .sp \n(Ppu
 130 .ne 2
 131
 132 .br
 133 .ns
 134 .TP 7
 135 .NOP \f[C]SHA\f[]
 136 .br
 137 .ns
 138 .TP 7
 139 .NOP \f[C]SHA1\f[]
 140 .br
 141 .ns
 142 .TP 7
 143 .NOP \f[C]RMD160\f[]
 144 The key is a hex-encoded ASCII string of 40 characters,
 145 which is truncated as necessary.
 146 .PP
 147 .sp \n(Ppu
 148 .ne 2
 149
 150 Note that the keys used by the
 151 \fCntpq\f[]\fR(8)\f[]
 152 and
 153 \fCntpdc\f[]\fR(8)\f[]
 154 programs are checked against passwords
 155 requested by the programs and entered by hand,
 156 so it is generally appropriate to specify these keys in ASCII format.
 157 .SH FILES
 158 .TP 14
 159 .NOP \fI/etc/ntp.keys\f[]
 160 the default name of the configuration file
 161 .PP
 162 .SH "SEE ALSO"
 163 \fCntp.conf\f[]\fR(5)\f[],
 164 \fCntpd\f[]\fR(1ntpdmdoc)\f[],
 165 \fCntpdate\f[]\fR(1ntpdatemdoc)\f[],
 166 \fCntpdc\f[]\fR(1ntpdcmdoc)\f[],
 167 \fCsntp\f[]\fR(1sntpmdoc)\f[]
 168 .SH "AUTHORS"
 169 The University of Delaware and Network Time Foundation
 170 .SH "COPYRIGHT"
 171 Copyright (C) 1992-2016 The University of Delaware and Network Time Foundation all rights reserved.
 172 This program is released under the terms of the NTP license, <http://ntp.org/license>.
 173 .SH "BUGS"
 174 Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
 175 .SH NOTES
 176 This document was derived from FreeBSD.
 177 .sp \n(Ppu
 178 .ne 2
 179
 180 This manual page was \fIAutoGen\fP-erated from the \fBntp.keys\fP
 181 option definitions.