2 .Dt NTP_KEYS 5 File Formats
4 .\" EDIT THIS FILE WITH CAUTION (ntp.mdoc)
8 .\" It has been AutoGen-ed June 2, 2016 at 07:36:20 AM by AutoGen 5.18.5
9 .\" From the definitions ntp.keys.def
10 .\" and the template file agmdoc-file.tpl
13 .Nd NTP symmetric key file format
17 .Nd NTP symmetric key file format
21 .Op Fl \-option\-name Ar value
23 All arguments must be options.
26 This document describes the format of an NTP symmetric key file.
27 For a description of the use of this type of file, see the
28 .Qq Authentication Support
34 reads its keys from a file specified using the
36 command line option or the
38 statement in the configuration file.
39 While key number 0 is fixed by the NTP standard
41 and may not be changed,
42 one or more keys numbered between 1 and 65534
43 may be arbitrarily set in the keys file.
45 The key file uses the same comment conventions
46 as the configuration file.
47 Key entries use a fixed format of the form
49 .D1 Ar keyno type key opt_IP_list
53 is a positive integer (between 1 and 65534),
55 is the message digest algorithm,
58 is the key itself, and
60 is an optional comma\-separated list of IPs
61 that are allowed to serve time.
65 any properly\-authenticated server message will be
70 may be given in a format
80 was built with the OpenSSL library
81 then any digest library supported by that library may be specified.
82 However, if compliance with FIPS 140\-2 is required the
89 What follows are some key types, and corresponding formats:
91 .Bl -tag -width RMD160 -compact
93 The key is 1 to 16 printable characters terminated by
99 (which is the "start of comment" character).
104 The key is a hex\-encoded ASCII string of 40 characters,
105 which is truncated as necessary.
108 Note that the keys used by the
112 programs are checked against passwords
113 requested by the programs and entered by hand,
114 so it is generally appropriate to specify these keys in ASCII format.
118 Display usage information and exit.
120 Pass the extended usage information through a pager.
121 .It Fl \-version Op Brq Ar v|c|n
122 Output version of program and exit. The default mode is `v', a simple
123 version. The `c' mode will print copyright information and `n' will
124 print the full copyright notice.
127 Any option that is not marked as \fInot presettable\fP may be preset
128 by loading values from environment variables named:
130 \fBNTP_KEYS_<option\-name>\fP or \fBNTP_KEYS\fP
134 See \fBOPTION PRESETS\fP for configuration environment variables.
136 .Bl -tag -width /etc/ntp.keys -compact
138 the default name of the configuration file
141 One of the following exit values will be returned:
143 .It 0 " (EXIT_SUCCESS)"
144 Successful program execution.
145 .It 1 " (EXIT_FAILURE)"
146 The operation failed or the command syntax was not valid.
147 .It 70 " (EX_SOFTWARE)"
148 libopts had an internal operational error. Please report
149 it to autogen\-users@lists.sourceforge.net. Thank you.
158 The University of Delaware and Network Time Foundation
160 Copyright (C) 1992\-2016 The University of Delaware and Network Time Foundation all rights reserved.
161 This program is released under the terms of the NTP license, <http://ntp.org/license>.
163 Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
165 This document was derived from FreeBSD.
167 This manual page was \fIAutoGen\fP\-erated from the \fBntp.keys\fP