2 .Dt NTP_KEYS 5 File Formats
4 .\" EDIT THIS FILE WITH CAUTION (ntp.mdoc)
10 .\" It has been AutoGen-ed February 4, 2015 at 02:42:10 AM by AutoGen 5.18.5pre4
11 .\" From the definitions ntp.keys.def
12 .\" and the template file agmdoc-file.tpl
15 .Nd NTP symmetric key file format
19 .Nd NTP symmetric key file format
23 .Op Fl \-option\-name Ar value
25 All arguments must be options.
28 This document describes the format of an NTP symmetric key file.
29 For a description of the use of this type of file, see the
30 .Qq Authentication Support
36 reads its keys from a file specified using the
38 command line option or the
40 statement in the configuration file.
41 While key number 0 is fixed by the NTP standard
43 and may not be changed,
44 one or more keys numbered between 1 and 65534
45 may be arbitrarily set in the keys file.
47 The key file uses the same comment conventions
48 as the configuration file.
49 Key entries use a fixed format of the form
55 is a positive integer (between 1 and 65534),
57 is the message digest algorithm,
64 may be given in a format
74 was built with the OpenSSL library
75 then any digest library supported by that library may be specified.
76 However, if compliance with FIPS 140\-2 is required the
83 What follows are some key types, and corresponding formats:
85 .Bl -tag -width RMD160 -compact
87 The key is 1 to 16 printable characters terminated by
93 (which is the "start of comment" character).
98 The key is a hex\-encoded ASCII string of 40 characters,
99 which is truncated as necessary.
102 Note that the keys used by the
106 programs are checked against passwords
107 requested by the programs and entered by hand,
108 so it is generally appropriate to specify these keys in ASCII format.
112 Display usage information and exit.
114 Pass the extended usage information through a pager.
115 .It Fl \-version Op Brq Ar v|c|n
116 Output version of program and exit. The default mode is `v', a simple
117 version. The `c' mode will print copyright information and `n' will
118 print the full copyright notice.
121 Any option that is not marked as \fInot presettable\fP may be preset
122 by loading values from environment variables named:
124 \fBNTP_KEYS_<option\-name>\fP or \fBNTP_KEYS\fP
128 See \fBOPTION PRESETS\fP for configuration environment variables.
130 .Bl -tag -width /etc/ntp.keys -compact
132 the default name of the configuration file
135 One of the following exit values will be returned:
137 .It 0 " (EXIT_SUCCESS)"
138 Successful program execution.
139 .It 1 " (EXIT_FAILURE)"
140 The operation failed or the command syntax was not valid.
141 .It 70 " (EX_SOFTWARE)"
142 libopts had an internal operational error. Please report
143 it to autogen\-users@lists.sourceforge.net. Thank you.
152 The University of Delaware and Network Time Foundation
154 Copyright (C) 1992\-2015 The University of Delaware and Network Time Foundation all rights reserved.
155 This program is released under the terms of the NTP license, <http://ntp.org/license>.
157 Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
159 This document was derived from FreeBSD.
161 This manual page was \fIAutoGen\fP\-erated from the \fBntp.keys\fP