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