1 .TH ntp.keys 5man "02 Jun 2016" "4.2.8p8" "File Formats"
3 .\" EDIT THIS FILE WITH CAUTION (ntp.man)
5 .\" It has been AutoGen-ed June 2, 2016 at 07:35:57 AM by AutoGen 5.18.5
6 .\" From the definitions ntp.keys.def
7 .\" and the template file agman-file.tpl
10 .Nd NTP symmetric key file format
14 ntp.keys \- NTP symmetric key file format configuration file
29 [\f\*[B-Font]\-\-option-name\f[]]
30 [\f\*[B-Font]\-\-option-name\f[] \f\*[I-Font]value\f[]]
34 All arguments must be options.
39 This document describes the format of an NTP symmetric key file.
40 For a description of the use of this type of file, see the
41 "Authentication Support"
43 \fCntp.conf\f[]\fR(5)\f[]
49 reads its keys from a file specified using the
51 command line option or the
53 statement in the configuration file.
54 While key number 0 is fixed by the NTP standard
56 and may not be changed,
57 one or more keys numbered between 1 and 65534
58 may be arbitrarily set in the keys file.
62 The key file uses the same comment conventions
63 as the configuration file.
64 Key entries use a fixed format of the form
69 \f\*[I-Font]keyno\f[] \f\*[I-Font]type\f[] \f\*[I-Font]key\f[] \f\*[I-Font]opt_IP_list\f[]
76 is a positive integer (between 1 and 65534),
78 is the message digest algorithm,
81 is the key itself, and
82 \f\*[I-Font]opt_IP_list\f[]
83 is an optional comma-separated list of IPs
84 that are allowed to serve time.
86 \f\*[I-Font]opt_IP_list\f[]
88 any properly-authenticated server message will be
95 may be given in a format
105 was built with the OpenSSL library
106 then any digest library supported by that library may be specified.
107 However, if compliance with FIPS 140-2 is required the
116 What follows are some key types, and corresponding formats:
122 The key is 1 to 16 printable characters terminated by
128 (which is the "start of comment" character).
144 The key is a hex-encoded ASCII string of 40 characters,
145 which is truncated as necessary.
150 Note that the keys used by the
151 \fCntpq\f[]\fR(8)\f[]
153 \fCntpdc\f[]\fR(8)\f[]
154 programs are checked against passwords
155 requested by the programs and entered by hand,
156 so it is generally appropriate to specify these keys in ASCII format.
159 .NOP \fI/etc/ntp.keys\f[]
160 the default name of the configuration file
163 \fCntp.conf\f[]\fR(5)\f[],
164 \fCntpd\f[]\fR(1ntpdmdoc)\f[],
165 \fCntpdate\f[]\fR(1ntpdatemdoc)\f[],
166 \fCntpdc\f[]\fR(1ntpdcmdoc)\f[],
167 \fCsntp\f[]\fR(1sntpmdoc)\f[]
169 The University of Delaware and Network Time Foundation
171 Copyright (C) 1992-2016 The University of Delaware and Network Time Foundation all rights reserved.
172 This program is released under the terms of the NTP license, <http://ntp.org/license>.
174 Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
176 This document was derived from FreeBSD.
180 This manual page was \fIAutoGen\fP-erated from the \fBntp.keys\fP