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