2 .Dt NTP_KEYS 5 File Formats
4 .\" EDIT THIS FILE WITH CAUTION (ntp.mdoc)
8 .\" It has been AutoGen-ed October 21, 2015 at 12:38:28 PM 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
53 is a positive integer (between 1 and 65534),
55 is the message digest algorithm,
62 may be given in a format
72 was built with the OpenSSL library
73 then any digest library supported by that library may be specified.
74 However, if compliance with FIPS 140\-2 is required the
81 What follows are some key types, and corresponding formats:
83 .Bl -tag -width RMD160 -compact
85 The key is 1 to 16 printable characters terminated by
91 (which is the "start of comment" character).
96 The key is a hex\-encoded ASCII string of 40 characters,
97 which is truncated as necessary.
100 Note that the keys used by the
104 programs are checked against passwords
105 requested by the programs and entered by hand,
106 so it is generally appropriate to specify these keys in ASCII format.
110 Display usage information and exit.
112 Pass the extended usage information through a pager.
113 .It Fl \-version Op Brq Ar v|c|n
114 Output version of program and exit. The default mode is `v', a simple
115 version. The `c' mode will print copyright information and `n' will
116 print the full copyright notice.
119 Any option that is not marked as \fInot presettable\fP may be preset
120 by loading values from environment variables named:
122 \fBNTP_KEYS_<option\-name>\fP or \fBNTP_KEYS\fP
126 See \fBOPTION PRESETS\fP for configuration environment variables.
128 .Bl -tag -width /etc/ntp.keys -compact
130 the default name of the configuration file
133 One of the following exit values will be returned:
135 .It 0 " (EXIT_SUCCESS)"
136 Successful program execution.
137 .It 1 " (EXIT_FAILURE)"
138 The operation failed or the command syntax was not valid.
139 .It 70 " (EX_SOFTWARE)"
140 libopts had an internal operational error. Please report
141 it to autogen\-users@lists.sourceforge.net. Thank you.
150 The University of Delaware and Network Time Foundation
152 Copyright (C) 1992\-2015 The University of Delaware and Network Time Foundation all rights reserved.
153 This program is released under the terms of the NTP license, <http://ntp.org/license>.
155 Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
157 This document was derived from FreeBSD.
159 This manual page was \fIAutoGen\fP\-erated from the \fBntp.keys\fP