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