ntp.keys.5mdoc revision 309007 
1.Dd November 21 2016
2.Dt NTP_KEYS 5mdoc File Formats
3.Os SunOS 5.10
4.\"  EDIT THIS FILE WITH CAUTION  (ntp.mdoc)
5.\"
6.\"  It has been AutoGen-ed  November 21, 2016 at 08:02:06 AM by AutoGen 5.18.5
7.\"  From the definitions    ntp.keys.def
8.\"  and the template file   agmdoc-file.tpl
9.Sh NAME
10.Nm ntp.keys
11.Nd NTP symmetric key file format
12
13.Sh NAME
14.Nm ntp.keys
15.Nd NTP symmetric key file format
16.Sh SYNOPSIS
17.Nm
18.Op Fl \-option\-name
19.Op Fl \-option\-name Ar value
20.Pp
21All arguments must be options.
22.Pp
23.Sh DESCRIPTION
24This document describes the format of an NTP symmetric key file.
25For a description of the use of this type of file, see the
26.Qq Authentication Support
27section of the
28.Xr ntp.conf 5
29page.
30.Pp
31.Xr ntpd 8
32reads its keys from a file specified using the
33.Fl k
34command line option or the
35.Ic keys
36statement in the configuration file.
37While key number 0 is fixed by the NTP standard
38(as 56 zero bits)
39and may not be changed,
40one or more keys numbered between 1 and 65534
41may be arbitrarily set in the keys file.
42.Pp
43The key file uses the same comment conventions
44as the configuration file.
45Key entries use a fixed format of the form
46.Pp
47.D1 Ar keyno type key opt_IP_list
48.Pp
49where
50.Ar keyno
51is a positive integer (between 1 and 65534),
52.Ar type
53is the message digest algorithm,
54and
55.Ar key
56is the key itself, and
57.Ar opt_IP_list
58is an optional comma\-separated list of IPs
59that are allowed to serve time.
60If
61.Ar opt_IP_list
62is empty,
63any properly\-authenticated server message will be
64accepted.
65.Pp
66The
67.Ar key
68may be given in a format
69controlled by the
70.Ar type
71field.
72The
73.Ar type
74.Li MD5
75is always supported.
76If
77.Li ntpd
78was built with the OpenSSL library
79then any digest library supported by that library may be specified.
80However, if compliance with FIPS 140\-2 is required the
81.Ar type
82must be either
83.Li SHA
84or
85.Li SHA1 .
86.Pp
87What follows are some key types, and corresponding formats:
88.Pp
89.Bl -tag -width RMD160 -compact
90.It Li MD5
91The key is 1 to 16 printable characters terminated by
92an EOL,
93whitespace,
94or
95a
96.Li #
97(which is the "start of comment" character).
98.Pp
99.It Li SHA
100.It Li SHA1
101.It Li RMD160
102The key is a hex\-encoded ASCII string of 40 characters,
103which is truncated as necessary.
104.El
105.Pp
106Note that the keys used by the
107.Xr ntpq 8
108and
109.Xr ntpdc 8
110programs are checked against passwords
111requested by the programs and entered by hand,
112so it is generally appropriate to specify these keys in ASCII format.
113.Sh "OPTIONS"
114.Bl -tag
115.It Fl \-help
116Display usage information and exit.
117.It Fl \-more\-help
118Pass the extended usage information through a pager.
119.It Fl \-version Op Brq Ar v|c|n
120Output version of program and exit.  The default mode is `v', a simple
121version.  The `c' mode will print copyright information and `n' will
122print the full copyright notice.
123.El
124.Sh "OPTION PRESETS"
125Any option that is not marked as \fInot presettable\fP may be preset
126by loading values from environment variables named:
127.nf
128  \fBNTP_KEYS_<option\-name>\fP or \fBNTP_KEYS\fP
129.fi
130.ad
131.Sh "ENVIRONMENT"
132See \fBOPTION PRESETS\fP for configuration environment variables.
133.Sh FILES
134.Bl -tag -width /etc/ntp.keys -compact
135.It Pa /etc/ntp.keys
136the default name of the configuration file
137.El
138.Sh "EXIT STATUS"
139One of the following exit values will be returned:
140.Bl -tag
141.It 0 " (EXIT_SUCCESS)"
142Successful program execution.
143.It 1 " (EXIT_FAILURE)"
144The operation failed or the command syntax was not valid.
145.It 70 " (EX_SOFTWARE)"
146libopts had an internal operational error.  Please report
147it to autogen\-users@lists.sourceforge.net.  Thank you.
148.El
149.Sh "SEE ALSO"
150.Xr ntp.conf 5 ,
151.Xr ntpd 1ntpdmdoc ,
152.Xr ntpdate 1ntpdatemdoc ,
153.Xr ntpdc 1ntpdcmdoc ,
154.Xr sntp 1sntpmdoc
155.Sh "AUTHORS"
156The University of Delaware and Network Time Foundation
157.Sh "COPYRIGHT"
158Copyright (C) 1992\-2016 The University of Delaware and Network Time Foundation all rights reserved.
159This program is released under the terms of the NTP license, <http://ntp.org/license>.
160.Sh "BUGS"
161Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
162.Sh NOTES
163This document was derived from FreeBSD.
164.Pp
165This manual page was \fIAutoGen\fP\-erated from the \fBntp.keys\fP
166option definitions.
167