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