ntp.keys.5mdoc revision 285612 
1353940Sdim.Dd June 29 2015
2353940Sdim.Dt NTP_KEYS 5mdoc File Formats
3353940Sdim.Os SunOS 5.10
4353940Sdim.\"  EDIT THIS FILE WITH CAUTION  (ntp.mdoc)
5353940Sdim.\"
6353940Sdim.\"  It has been AutoGen-ed  June 29, 2015 at 04:30:39 PM by AutoGen 5.18.5
7353940Sdim.\"  From the definitions    ntp.keys.def
8353940Sdim.\"  and the template file   agmdoc-file.tpl
9353940Sdim.Sh NAME
10353940Sdim.Nm ntp.keys
11353940Sdim.Nd NTP symmetric key file format
12353940Sdim
13353940Sdim.Sh NAME
14353940Sdim.Nm ntp.keys
15353940Sdim.Nd NTP symmetric key file format
16357095Sdim.Sh SYNOPSIS
17353940Sdim.Nm
18357095Sdim.Op Fl \-option\-name
19357095Sdim.Op Fl \-option\-name Ar value
20353940Sdim.Pp
21357095SdimAll arguments must be options.
22357095Sdim.Pp
23357095Sdim.Sh DESCRIPTION
24353940SdimThis document describes the format of an NTP symmetric key file.
25353940SdimFor a description of the use of this type of file, see the
26357095Sdim.Qq Authentication Support
27357095Sdimsection of the
28353940Sdim.Xr ntp.conf 5
29357095Sdimpage.
30357095Sdim.Pp
31353940Sdim.Xr ntpd 8
32357095Sdimreads its keys from a file specified using the
33353940Sdim.Fl k
34357095Sdimcommand line option or the
35357095Sdim.Ic keys
36357095Sdimstatement in the configuration file.
37357095SdimWhile key number 0 is fixed by the NTP standard
38357095Sdim(as 56 zero bits)
39357095Sdimand may not be changed,
40353940Sdimone or more keys numbered between 1 and 65534
41357095Sdimmay be arbitrarily set in the keys file.
42357095Sdim.Pp
43357095SdimThe key file uses the same comment conventions
44357095Sdimas the configuration file.
45353940SdimKey entries use a fixed format of the form
46357095Sdim.Pp
47353940Sdim.D1 Ar keyno type key
48353940Sdim.Pp
49357095Sdimwhere
50357095Sdim.Ar keyno
51357095Sdimis a positive integer (between 1 and 65534),
52353940Sdim.Ar type
53357095Sdimis the message digest algorithm,
54357095Sdimand
55357095Sdim.Ar key
56357095Sdimis the key itself.
57357095Sdim.Pp
58357095SdimThe
59357095Sdim.Ar key
60357095Sdimmay be given in a format
61357095Sdimcontrolled by the
62357095Sdim.Ar type
63357095Sdimfield.
64357095SdimThe
65357095Sdim.Ar type
66357095Sdim.Li MD5
67357095Sdimis always supported.
68357095SdimIf
69357095Sdim.Li ntpd
70357095Sdimwas built with the OpenSSL library
71357095Sdimthen any digest library supported by that library may be specified.
72357095SdimHowever, if compliance with FIPS 140\-2 is required the
73353940Sdim.Ar type
74357095Sdimmust be either
75357095Sdim.Li SHA
76357095Sdimor
77357095Sdim.Li SHA1 .
78357095Sdim.Pp
79353940SdimWhat follows are some key types, and corresponding formats:
80357095Sdim.Pp
81357095Sdim.Bl -tag -width RMD160 -compact
82357095Sdim.It Li MD5
83357095SdimThe key is 1 to 16 printable characters terminated by
84357095Sdiman EOL,
85357095Sdimwhitespace,
86357095Sdimor
87353940Sdima
88357095Sdim.Li #
89357095Sdim(which is the "start of comment" character).
90357095Sdim.Pp
91357095Sdim.It Li SHA
92357095Sdim.It Li SHA1
93357095Sdim.It Li RMD160
94357095SdimThe key is a hex\-encoded ASCII string of 40 characters,
95357095Sdimwhich is truncated as necessary.
96357095Sdim.El
97357095Sdim.Pp
98357095SdimNote that the keys used by the
99357095Sdim.Xr ntpq 8
100357095Sdimand
101353940Sdim.Xr ntpdc 8
102357095Sdimprograms are checked against passwords
103357095Sdimrequested by the programs and entered by hand,
104353940Sdimso it is generally appropriate to specify these keys in ASCII format.
105357095Sdim.Sh "OPTIONS"
106357095Sdim.Bl -tag
107353940Sdim.It Fl \-help
108357095SdimDisplay usage information and exit.
109357095Sdim.It Fl \-more\-help
110357095SdimPass the extended usage information through a pager.
111357095Sdim.It Fl \-version Op Brq Ar v|c|n
112357095SdimOutput version of program and exit.  The default mode is `v', a simple
113357095Sdimversion.  The `c' mode will print copyright information and `n' will
114357095Sdimprint the full copyright notice.
115357095Sdim.El
116357095Sdim.Sh "OPTION PRESETS"
117357095SdimAny option that is not marked as \fInot presettable\fP may be preset
118353940Sdimby loading values from environment variables named:
119357095Sdim.nf
120357095Sdim  \fBNTP_KEYS_<option\-name>\fP or \fBNTP_KEYS\fP
121357095Sdim.fi
122353940Sdim.ad
123357095Sdim.Sh "ENVIRONMENT"
124357095SdimSee \fBOPTION PRESETS\fP for configuration environment variables.
125357095Sdim.Sh FILES
126357095Sdim.Bl -tag -width /etc/ntp.keys -compact
127353940Sdim.It Pa /etc/ntp.keys
128353940Sdimthe default name of the configuration file
129357095Sdim.El
130357095Sdim.Sh "EXIT STATUS"
131357095SdimOne of the following exit values will be returned:
132357095Sdim.Bl -tag
133357095Sdim.It 0 " (EXIT_SUCCESS)"
134357095SdimSuccessful program execution.
135353940Sdim.It 1 " (EXIT_FAILURE)"
136357095SdimThe operation failed or the command syntax was not valid.
137353940Sdim.It 70 " (EX_SOFTWARE)"
138357095Sdimlibopts had an internal operational error.  Please report
139357095Sdimit to autogen\-users@lists.sourceforge.net.  Thank you.
140357095Sdim.El
141357095Sdim.Sh "SEE ALSO"
142353940Sdim.Xr ntp.conf 5 ,
143357095Sdim.Xr ntpd 1ntpdmdoc ,
144357095Sdim.Xr ntpdate 1ntpdatemdoc ,
145353940Sdim.Xr ntpdc 1ntpdcmdoc ,
146353940Sdim.Xr sntp 1sntpmdoc
147357095Sdim.Sh "AUTHORS"
148353940SdimThe University of Delaware and Network Time Foundation
149353940Sdim.Sh "COPYRIGHT"
150357095SdimCopyright (C) 1992\-2015 The University of Delaware and Network Time Foundation all rights reserved.
151357095SdimThis program is released under the terms of the NTP license, <http://ntp.org/license>.
152357095Sdim.Sh "BUGS"
153357095SdimPlease send bug reports to: http://bugs.ntp.org, bugs@ntp.org
154357095Sdim.Sh NOTES
155357095SdimThis document was derived from FreeBSD.
156353940Sdim.Pp
157This manual page was \fIAutoGen\fP\-erated from the \fBntp.keys\fP
158option definitions.
159