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