usr.sbin/ntp/doc/ntp.keys.5

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