2 .Dt NTP_KEYS 5 File Formats
4 .\" EDIT THIS FILE WITH CAUTION (ntp.mdoc)
6 .\" It has been AutoGen-ed August 14, 2018 at 08:29:18 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 65535
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 65535),
53 is the message digest algorithm,
55 is the key itself, and
57 is an optional comma\-separated list of IPs
61 that are allowed to serve time.
64 may contain an optional
66 specification which identifies the number of bits for
67 the desired subnet of trust.
71 any properly\-authenticated message will be
76 may be given in a format
86 was built with the OpenSSL library
87 then any digest library supported by that library may be specified.
88 However, if compliance with FIPS 140\-2 is required the
95 What follows are some key types, and corresponding formats:
97 .Bl -tag -width RMD160 -compact
99 The key is 1 to 16 printable characters terminated by
105 (which is the "start of comment" character).
110 The key is a hex\-encoded ASCII string of 40 characters,
111 which is truncated as necessary.
114 Note that the keys used by the
118 programs are checked against passwords
119 requested by the programs and entered by hand,
120 so it is generally appropriate to specify these keys in ASCII format.
124 Display usage information and exit.
126 Pass the extended usage information through a pager.
127 .It Fl \-version Op Brq Ar v|c|n
128 Output version of program and exit. The default mode is `v', a simple
129 version. The `c' mode will print copyright information and `n' will
130 print the full copyright notice.
133 Any option that is not marked as \fInot presettable\fP may be preset
134 by loading values from environment variables named:
136 \fBNTP_KEYS_<option\-name>\fP or \fBNTP_KEYS\fP
140 See \fBOPTION PRESETS\fP for configuration environment variables.
142 .Bl -tag -width /etc/ntp.keys -compact
144 the default name of the configuration file
147 One of the following exit values will be returned:
149 .It 0 " (EXIT_SUCCESS)"
150 Successful program execution.
151 .It 1 " (EXIT_FAILURE)"
152 The operation failed or the command syntax was not valid.
153 .It 70 " (EX_SOFTWARE)"
154 libopts had an internal operational error. Please report
155 it to autogen\-users@lists.sourceforge.net. Thank you.
160 .Xr ntpdate @NTPDATE_MS@ ,
161 .Xr ntpdc @NTPDC_MS@ ,
164 The University of Delaware and Network Time Foundation
166 Copyright (C) 1992\-2017 The University of Delaware and Network Time Foundation all rights reserved.
167 This program is released under the terms of the NTP license, <http://ntp.org/license>.
169 Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
171 This document was derived from FreeBSD.
173 This manual page was \fIAutoGen\fP\-erated from the \fBntp.keys\fP