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