"Fossies" - the Fresh Open Source Software Archive

Member "ntp-4.2.8p15/ntpd/ntp.keys.man.in" (23 Jun 2020, 4083 Bytes) of package /linux/misc/ntp-4.2.8p15.tar.gz:

As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "ntp.keys.man.in": 4.2.8p14_vs_4.2.8p15.

    1 .TH ntp.keys 5 "23 Jun 2020" "4.2.8p15" "File Formats"
    2 .\"
    3 .\"  EDIT THIS FILE WITH CAUTION  (ntp.man)
    4 .\"
    5 .\"  It has been AutoGen-ed  June 23, 2020 at 02:20:38 AM 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 65535
   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 65535),
   77 \f\*[I-Font]type\f[]
   78 is the message digest algorithm,
   79 \f\*[I-Font]key\f[]
   80 is the key itself, and
   81 \f\*[I-Font]opt_IP_list\f[]
   82 is an optional comma-separated list of IPs
   83 where the
   84 \f\*[I-Font]keyno\f[]
   85 should be trusted.
   86 that are allowed to serve time.
   87 Each IP in
   88 \f\*[I-Font]opt_IP_list\f[]
   89 may contain an optional
   90 \f\*[B-Font]/subnetbits\f[]
   91 specification which identifies the number of bits for
   92 the desired subnet of trust.
   93 If
   94 \f\*[I-Font]opt_IP_list\f[]
   95 is empty,
   96 any properly-authenticated message will be
   97 accepted.
   98 .sp \n(Ppu
   99 .ne 2
  100 
  101 The
  102 \f\*[I-Font]key\f[]
  103 may be given in a format
  104 controlled by the
  105 \f\*[I-Font]type\f[]
  106 field.
  107 The
  108 \f\*[I-Font]type\f[]
  109 \f[C]MD5\f[]
  110 is always supported.
  111 If
  112 \f[C]ntpd\f[]
  113 was built with the OpenSSL library
  114 then any digest library supported by that library may be specified.
  115 However, if compliance with FIPS 140-2 is required the
  116 \f\*[I-Font]type\f[]
  117 must be either
  118 \f[C]SHA\f[]
  119 or
  120 \f[C]SHA1\f[].
  121 .sp \n(Ppu
  122 .ne 2
  123 
  124 What follows are some key types, and corresponding formats:
  125 .sp \n(Ppu
  126 .ne 2
  127 
  128 .TP 7
  129 .NOP \f[C]MD5\f[]
  130 The key is 1 to 16 printable characters terminated by
  131 an EOL,
  132 whitespace,
  133 or
  134 a
  135 \f[C]#\f[]
  136 (which is the "start of comment" character).
  137 .sp \n(Ppu
  138 .ne 2
  139 
  140 .br
  141 .ns
  142 .TP 7
  143 .NOP \f[C]SHA\f[]
  144 .br
  145 .ns
  146 .TP 7
  147 .NOP \f[C]SHA1\f[]
  148 .br
  149 .ns
  150 .TP 7
  151 .NOP \f[C]RMD160\f[]
  152 The key is a hex-encoded ASCII string of 40 characters,
  153 which is truncated as necessary.
  154 .PP
  155 .sp \n(Ppu
  156 .ne 2
  157 
  158 Note that the keys used by the
  159 \fCntpq\f[]\fR(8)\f[]
  160 and
  161 \fCntpdc\f[]\fR(8)\f[]
  162 programs are checked against passwords
  163 requested by the programs and entered by hand,
  164 so it is generally appropriate to specify these keys in ASCII format.
  165 .SH FILES
  166 .TP 14
  167 .NOP \fI/etc/ntp.keys\f[]
  168 the default name of the configuration file
  169 .PP
  170 .SH "SEE ALSO"
  171 \fCntp.conf\f[]\fR(5)\f[],
  172 \fCntpd\f[]\fR(@NTPD_MS@)\f[],
  173 \fCntpdate\f[]\fR(@NTPDATE_MS@)\f[],
  174 \fCntpdc\f[]\fR(@NTPDC_MS@)\f[],
  175 \fCsntp\f[]\fR(@SNTP_MS@)\f[]
  176 .SH "AUTHORS"
  177 The University of Delaware and Network Time Foundation
  178 .SH "COPYRIGHT"
  179 Copyright (C) 1992-2020 The University of Delaware and Network Time Foundation all rights reserved.
  180 This program is released under the terms of the NTP license, <http://ntp.org/license>.
  181 .SH "BUGS"
  182 Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
  183 .SH NOTES
  184 This document was derived from FreeBSD.
  185 .sp \n(Ppu
  186 .ne 2
  187 
  188 This manual page was \fIAutoGen\fP-erated from the \fBntp.keys\fP
  189 option definitions.