"Fossies" - the Fresh Open Source Software Archive

Member "ntp-4.2.8p15/ntpd/ntp.keys.5mdoc" (23 Jun 2020, 4347 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.5mdoc": 4.2.8p14_vs_4.2.8p15.

    1 .Dd June 23 2020
    2 .Dt NTP_KEYS 5mdoc File Formats
    3 .Os FreeBSD 11.2-RELEASE_SI
    4 .\"  EDIT THIS FILE WITH CAUTION  (ntp.mdoc)
    5 .\"
    6 .\"  It has been AutoGen-ed  June 23, 2020 at 02:20:28 AM by AutoGen 5.18.5
    7 .\"  From the definitions    ntp.keys.def
    8 .\"  and the template file   agmdoc-file.tpl
    9 .Sh NAME
   10 .Nm ntp.keys
   11 .Nd NTP symmetric key file format
   12 
   13 .Sh NAME
   14 .Nm ntp.keys
   15 .Nd NTP symmetric key file format
   16 .Sh SYNOPSIS
   17 .Nm
   18 .Op Fl \-option\-name
   19 .Op Fl \-option\-name Ar value
   20 .Pp
   21 All arguments must be options.
   22 .Pp
   23 .Sh DESCRIPTION
   24 This document describes the format of an NTP symmetric key file.
   25 For a description of the use of this type of file, see the
   26 .Qq Authentication Support
   27 section of the
   28 .Xr ntp.conf 5
   29 page.
   30 .Pp
   31 .Xr ntpd 8
   32 reads its keys from a file specified using the
   33 .Fl k
   34 command line option or the
   35 .Ic keys
   36 statement in the configuration file.
   37 While key number 0 is fixed by the NTP standard
   38 (as 56 zero bits)
   39 and may not be changed,
   40 one or more keys numbered between 1 and 65535
   41 may be arbitrarily set in the keys file.
   42 .Pp
   43 The key file uses the same comment conventions
   44 as the configuration file.
   45 Key entries use a fixed format of the form
   46 .Pp
   47 .D1 Ar keyno type key opt_IP_list
   48 .Pp
   49 where
   50 .Ar keyno
   51 is a positive integer (between 1 and 65535),
   52 .Ar type
   53 is the message digest algorithm,
   54 .Ar key
   55 is the key itself, and
   56 .Ar opt_IP_list
   57 is an optional comma\-separated list of IPs
   58 where the
   59 .Ar keyno
   60 should be trusted.
   61 that are allowed to serve time.
   62 Each IP in
   63 .Ar opt_IP_list
   64 may contain an optional
   65 .Cm /subnetbits
   66 specification which identifies the number of bits for
   67 the desired subnet of trust.
   68 If
   69 .Ar opt_IP_list
   70 is empty,
   71 any properly\-authenticated message will be
   72 accepted.
   73 .Pp
   74 The
   75 .Ar key
   76 may be given in a format
   77 controlled by the
   78 .Ar type
   79 field.
   80 The
   81 .Ar type
   82 .Li MD5
   83 is always supported.
   84 If
   85 .Li ntpd
   86 was built with the OpenSSL library
   87 then any digest library supported by that library may be specified.
   88 However, if compliance with FIPS 140\-2 is required the
   89 .Ar type
   90 must be either
   91 .Li SHA
   92 or
   93 .Li SHA1 .
   94 .Pp
   95 What follows are some key types, and corresponding formats:
   96 .Pp
   97 .Bl -tag -width RMD160 -compact
   98 .It Li MD5
   99 The key is 1 to 16 printable characters terminated by
  100 an EOL,
  101 whitespace,
  102 or
  103 a
  104 .Li #
  105 (which is the "start of comment" character).
  106 .Pp
  107 .It Li SHA
  108 .It Li SHA1
  109 .It Li RMD160
  110 The key is a hex\-encoded ASCII string of 40 characters,
  111 which is truncated as necessary.
  112 .El
  113 .Pp
  114 Note that the keys used by the
  115 .Xr ntpq 8
  116 and
  117 .Xr ntpdc 8
  118 programs are checked against passwords
  119 requested by the programs and entered by hand,
  120 so it is generally appropriate to specify these keys in ASCII format.
  121 .Sh "OPTIONS"
  122 .Bl -tag
  123 .It Fl \-help
  124 Display usage information and exit.
  125 .It Fl \-more\-help
  126 Pass the extended usage information through a pager.
  127 .It Fl \-version Op Brq Ar v|c|n
  128 Output version of program and exit.  The default mode is `v', a simple
  129 version.  The `c' mode will print copyright information and `n' will
  130 print the full copyright notice.
  131 .El
  132 .Sh "OPTION PRESETS"
  133 Any option that is not marked as \fInot presettable\fP may be preset
  134 by loading values from environment variables named:
  135 .nf
  136   \fBNTP_KEYS_<option\-name>\fP or \fBNTP_KEYS\fP
  137 .fi
  138 .ad
  139 .Sh "ENVIRONMENT"
  140 See \fBOPTION PRESETS\fP for configuration environment variables.
  141 .Sh FILES
  142 .Bl -tag -width /etc/ntp.keys -compact
  143 .It Pa /etc/ntp.keys
  144 the default name of the configuration file
  145 .El
  146 .Sh "EXIT STATUS"
  147 One of the following exit values will be returned:
  148 .Bl -tag
  149 .It 0 " (EXIT_SUCCESS)"
  150 Successful program execution.
  151 .It 1 " (EXIT_FAILURE)"
  152 The operation failed or the command syntax was not valid.
  153 .It 70 " (EX_SOFTWARE)"
  154 libopts had an internal operational error.  Please report
  155 it to autogen\-users@lists.sourceforge.net.  Thank you.
  156 .El
  157 .Sh "SEE ALSO"
  158 .Xr ntp.conf 5 ,
  159 .Xr ntpd 1ntpdmdoc ,
  160 .Xr ntpdate 1ntpdatemdoc ,
  161 .Xr ntpdc 1ntpdcmdoc ,
  162 .Xr sntp 1sntpmdoc
  163 .Sh "AUTHORS"
  164 The University of Delaware and Network Time Foundation
  165 .Sh "COPYRIGHT"
  166 Copyright (C) 1992\-2020 The University of Delaware and Network Time Foundation all rights reserved.
  167 This program is released under the terms of the NTP license, <http://ntp.org/license>.
  168 .Sh "BUGS"
  169 Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
  170 .Sh NOTES
  171 This document was derived from FreeBSD.
  172 .Pp
  173 This manual page was \fIAutoGen\fP\-erated from the \fBntp.keys\fP
  174 option definitions.