| blob | 6e7a54ffb5848374ebe790bc9151a9016cd06ce5 |
1 '\" te
2 .\" Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH KDB5_UTIL 1M "April 9, 2016"
7 .SH NAME
8 kdb5_util \- Kerberos Database maintenance utility
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/usr/sbin/kdb5_util\fR [\fB-d\fR \fIdbname\fR] [\fB-f\fR \fIstashfile_name\fR]
13 [\fB-k\fR \fImkeytype\fR] [\fB-m\fR ] [\fB-M\fR \fImkeyname\fR] [\fB-P\fR \fIpassword\fR] [\fB-r\fR \fIrealm\fR]
14 [\fB-x\fR \fIdb_args\fR]... \fIcmd\fR
15 .fi
17 .SH DESCRIPTION
18 .LP
19 The \fBkdb5_util\fR utility enables you to create, dump, load, and destroy the
20 Kerberos V5 database. You can also use \fBkdb5_util\fR to create a stash file
21 containing the Kerberos database master key.
22 .SH OPTIONS
23 .LP
24 The following options are supported:
25 .sp
26 .ne 2
27 .na
28 \fB\fB-d\fR \fIdbname\fR\fR
29 .ad
30 .sp .6
31 .RS 4n
32 Specify the database name. \fB\&.db\fR is appended to whatever name is
33 specified. You can specify an absolute path. If you do not specify the \fB-d\fR
34 option, the default database name is \fB/var/krb5/principal\fR.
35 .RE
37 .sp
38 .ne 2
39 .na
40 \fB\fB-f\fR \fIstashfile_name\fR\fR
41 .ad
42 .sp .6
43 .RS 4n
44 Specify the stash file name. You can specify an absolute path.
45 .RE
47 .sp
48 .ne 2
49 .na
50 \fB\fB-k\fR \fImkeytype\fR\fR
51 .ad
52 .sp .6
53 .RS 4n
54 Specify the master key type. Valid values are \fBdes3-cbc-sha1\fR,
55 \fBdes-cbc-crc\fR, \fBdes-cbc-md5\fR, \fBdes-cbc-raw\fR,
56 \fBarcfour-hmac-md5\fR, \fBarcfour-hmac-md5-exp\fR,
57 \fBaes128-cts-hmac-sha1-96\fR, and \fBaes256-cts-hmac-sha1-96\fR.
58 .RE
60 .sp
61 .ne 2
62 .na
63 \fB\fB-m\fR\fR
64 .ad
65 .sp .6
66 .RS 4n
67 Enter the master key manually.
68 .RE
70 .sp
71 .ne 2
72 .na
73 \fB\fB-M\fR \fImkeyname\fR\fR
74 .ad
75 .sp .6
76 .RS 4n
77 Specify the master key name.
78 .RE
80 .sp
81 .ne 2
82 .na
83 \fB\fB-P\fR \fIpassword\fR\fR
84 .ad
85 .sp .6
86 .RS 4n
87 Use the specified \fIpassword\fR instead of the stash file.
88 .RE
90 .sp
91 .ne 2
92 .na
93 \fB\fB-r\fR \fIrealm\fR\fR
94 .ad
95 .sp .6
96 .RS 4n
97 Use \fIrealm\fR as the default database realm.
98 .RE
100 .sp
101 .ne 2
102 .na
103 \fB\fB-x\fR \fIdb_args\fR\fR
104 .ad
105 .sp .6
106 .RS 4n
107 Pass database-specific arguments to \fBkadmin\fR. Supported arguments are for
108 LDAP and the \fBBerkeley-db2\fR plug-in. These arguments are:
109 .sp
110 .ne 2
111 .na
112 \fB\fBbinddn\fR=\fIbinddn\fR\fR
113 .ad
114 .sp .6
115 .RS 4n
116 LDAP simple bind DN for authorization on the directory server. Overrides the
117 \fBldap_kadmind_dn\fR parameter setting in \fBkrb5.conf\fR(4).
118 .RE
120 .sp
121 .ne 2
122 .na
123 \fB\fBbindpwd\fR=\fIbindpwd\fR\fR
124 .ad
125 .sp .6
126 .RS 4n
127 Bind password.
128 .RE
130 .sp
131 .ne 2
132 .na
133 \fB\fBdbname\fR=\fIname\fR\fR
134 .ad
135 .sp .6
136 .RS 4n
137 For the \fBBerkeley-db2\fR plug-in, specifies a name for the Kerberos database.
138 .RE
140 .sp
141 .ne 2
142 .na
143 \fB\fBnconns\fR=\fInum\fR\fR
144 .ad
145 .sp .6
146 .RS 4n
147 Maximum number of server connections.
148 .RE
150 .sp
151 .ne 2
152 .na
153 \fB\fBport\fR=\fInum\fR\fR
154 .ad
155 .sp .6
156 .RS 4n
157 Directory server connection port.
158 .RE
160 .RE
162 .SH OPERANDS
163 .LP
164 The following operands are supported:
165 .sp
166 .ne 2
167 .na
168 \fB\fIcmd\fR\fR
169 .ad
170 .sp .6
171 .RS 4n
172 Specifies whether to create, destroy, dump, or load the database, or to create
173 a stash file.
174 .sp
175 You can specify the following commands:
176 .sp
177 .ne 2
178 .na
179 \fB\fBcreate\fR \fB-s\fR\fR
180 .ad
181 .sp .6
182 .RS 4n
183 Creates the database specified by the \fB-d\fR option. You will be prompted for
184 the database master password. If you specify \fB-s\fR, a stash file is created
185 as specified by the \fB-f\fR option. If you did not specify \fB-f\fR, the
186 default stash file name is \fB/var/krb5/.k5.realm\fR. If you use the \fB-f\fR,
187 \fB-k\fR, or \fB-M\fR options when you create a database, then you must use the
188 same options when modifying or destroying the database.
189 .RE
191 .sp
192 .ne 2
193 .na
194 \fB\fBdestroy\fR\fR
195 .ad
196 .sp .6
197 .RS 4n
198 Destroys the database specified by the \fB-d\fR option.
199 .RE
201 .sp
202 .ne 2
203 .na
204 \fB\fBstash\fR\fR
205 .ad
206 .sp .6
207 .RS 4n
208 Creates a stash file. If \fB-f\fR was not specified, the default stash file
209 name is \fB/var/krb5/.k5.realm\fR. You will be prompted for the master database
210 password. This command is useful when you want to generate the stash file from
211 the password.
212 .RE
214 .sp
215 .ne 2
216 .na
217 \fB\fBdump\fR [\fB-old\fR] [\fB-b6\fR] [\fB-b7\fR] [\fB-ov\fR] [\fB-verbose\fR]
218 [\fB-mkey_convert\fR] [\fB-new_mkey_file\fR \fImkey_file\fR] [\fB-rev\fR]
219 [\fB-recurse\fR] [\fIfilename\fR [\fIprincipals\fR...]]\fR
220 .ad
221 .sp .6
222 .RS 4n
223 Dumps the current Kerberos and KADM5 database into an ASCII file. By default,
224 the database is dumped in current format, "\fBkdb5_util load_dumpversion 5\fR".
225 If \fIfilename\fR is not specified or is the string "-", the dump is sent to
226 standard output. Options are as follows:
227 .sp
228 .ne 2
229 .na
230 \fB\fB-old\fR\fR
231 .ad
232 .sp .6
233 .RS 4n
234 Causes the dump to be in the Kerberos 5 Beta 5 and earlier dump format
235 ("\fBkdb5_edit load_dump version 2.0\fR").
236 .RE
238 .sp
239 .ne 2
240 .na
241 \fB\fB-b6\fR\fR
242 .ad
243 .sp .6
244 .RS 4n
245 Causes the dump to be in the Kerberos 5 Beta 6 format ("\fBkdb5_edit load_dump
246 version 3.0\fR").
247 .RE
249 .sp
250 .ne 2
251 .na
252 \fB\fB-b7\fR\fR
253 .ad
254 .sp .6
255 .RS 4n
256 Causes the dump to be in the Kerberos 5 Beta 7 format ("\fBkdb5_util load_dump
257 version 4\fR"). This was the dump format produced on releases prior to 1.2.2.
258 .RE
260 .sp
261 .ne 2
262 .na
263 \fB\fB-ov\fR\fR
264 .ad
265 .sp .6
266 .RS 4n
267 Causes the dump to be in \fBovsec_adm_export\fR format.
268 .RE
270 .sp
271 .ne 2
272 .na
273 \fB\fB-verbose\fR\fR
274 .ad
275 .sp .6
276 .RS 4n
277 Causes the name of each principal and policy to be displayed as it is dumped.
278 .RE
280 .sp
281 .ne 2
282 .na
283 \fB\fB-mkey_convert\fR\fR
284 .ad
285 .sp .6
286 .RS 4n
287 Prompts for a new master key. This new master key will be used to re-encrypt
288 the key data in the dumpfile. The key data in the database will not be changed.
289 .RE
291 .sp
292 .ne 2
293 .na
294 \fB\fB-new_mkey_file\fR \fImkey_file\fR\fR
295 .ad
296 .sp .6
297 .RS 4n
298 The filename of a stash file. The master key in this stash file will be used to
299 re-encrypt the key data in the dumpfile. The key data in the database will not
300 be changed.
301 .RE
303 .sp
304 .ne 2
305 .na
306 \fB\fB-rev\fR\fR
307 .ad
308 .sp .6
309 .RS 4n
310 Dumps in reverse order. This might recover principals that do not dump
311 normally, in cases where database corruption has occurred.
312 .RE
314 .sp
315 .ne 2
316 .na
317 \fB\fB-recurse\fR\fR
318 .ad
319 .sp .6
320 .RS 4n
321 Causes the dump to walk the database recursively (\fBbtree\fR only). This might
322 recover principals that do not dump normally, in cases where database
323 corruption has occurred. In cases of such corruption, this option will probably
324 retrieve more principals than will the \fB-rev\fR option.
325 .RE
327 .RE
329 .sp
330 .ne 2
331 .na
332 \fB\fBload\fR [\fB-old\fR] [\fB-b6\fR] [\fB-b7\fR] [\fB-ov\fR] [\fB-hash\fR]
333 [\fB-verbose\fR] [\fB-update\fR] \fIfilename\fR \fIdbname\fR
334 [\fIadmin_dbname\fR]\fR
335 .ad
336 .sp .6
337 .RS 4n
338 Loads a database dump from \fIfilename\fR into \fIdbname\fR. Unless the
339 \fB-old\fR or \fB-b6\fR option is specified, the format of the dump file is
340 detected automatically and handled appropriately. Unless the \fB-update\fR
341 option is specified, \fBload\fR creates a new database containing only the
342 principals in the dump file, overwriting the contents of any existing database.
343 The \fB-old\fR option requires the database to be in the Kerberos 5 Beta 5 or
344 earlier format ("\fBkdb5_edit load_dump version 2.0\fR").
345 .sp
346 .ne 2
347 .na
348 \fB\fB-b6\fR\fR
349 .ad
350 .sp .6
351 .RS 4n
352 Requires the database to be in the Kerberos 5 Beta 6 format ("\fBkdb5_edit
353 load_dump version 3.0\fR").
354 .RE
356 .sp
357 .ne 2
358 .na
359 \fB\fB-b7\fR\fR
360 .ad
361 .sp .6
362 .RS 4n
363 Requires the database to be in the Kerberos 5 Beta 7 format ("\fBkdb5_util
364 load_dump version 4\fR").
365 .RE
367 .sp
368 .ne 2
369 .na
370 \fB\fB-ov\fR\fR
371 .ad
372 .sp .6
373 .RS 4n
374 Requires the database to be in \fBovsec_adm_import\fR format. Must be used with
375 the \fB-update\fR option.
376 .RE
378 .sp
379 .ne 2
380 .na
381 \fB\fB-hash\fR\fR
382 .ad
383 .sp .6
384 .RS 4n
385 Requires the database to be stored as a hash. If this option is not specified,
386 the database will be stored as a \fBbtree\fR. This option is not recommended,
387 as databases stored in hash format are known to corrupt data and lose
388 principals.
389 .RE
391 .sp
392 .ne 2
393 .na
394 \fB\fB-verbose\fR\fR
395 .ad
396 .sp .6
397 .RS 4n
398 Causes the name of each principal and policy to be displayed as it is dumped.
399 .RE
401 .sp
402 .ne 2
403 .na
404 \fB\fB-update\fR\fR
405 .ad
406 .sp .6
407 .RS 4n
408 Records from the dump file are added to or updated in the existing database.
409 Otherwise, a new database is created containing only what is in the dump file
410 and the old one is destroyed upon successful completion.
411 .RE
413 .sp
414 .ne 2
415 .na
416 \fB\fIfilename\fR\fR
417 .ad
418 .sp .6
419 .RS 4n
420 Required argument that specifies a path to a file containing database dump.
421 .RE
423 .sp
424 .ne 2
425 .na
426 \fB\fIdbname\fR\fR
427 .ad
428 .sp .6
429 .RS 4n
430 Required argument that overrides the value specified on the command line or
431 overrides the default.
432 .RE
434 .sp
435 .ne 2
436 .na
437 \fB\fIadmin_dbname\fR\fR
438 .ad
439 .sp .6
440 .RS 4n
441 Optional argument that is derived from \fIdbname\fR if not specified.
442 .RE
444 .RE
446 .RE
448 .SH EXAMPLES
449 .LP
450 \fBExample 1 \fRCreating File that Contains Information about Two Principals
451 .sp
452 .LP
453 The following example creates a file named \fBslavedata\fR that contains the
454 information about two principals, \fBjdb@ACME.COM\fR and \fBpak@ACME.COM\fR.
456 .sp
457 .in +2
458 .nf
459 # /usr/krb5/bin/kdb5_util dump -verbose slavedata
460 jdb@ACME.COM pak@ACME.COM
461 .fi
462 .in -2
463 .sp
465 .SH FILES
466 .ne 2
467 .na
468 \fB\fB/var/krb5/principal\fR\fR
469 .ad
470 .sp .6
471 .RS 4n
472 Kerberos principal database.
473 .RE
475 .sp
476 .ne 2
477 .na
478 \fB\fB/var/krb5/principal.kadm5\fR\fR
479 .ad
480 .sp .6
481 .RS 4n
482 Kerberos administrative database. Contains policy information.
483 .RE
485 .sp
486 .ne 2
487 .na
488 \fB\fB/var/krb5/principal.kadm5.lock\fR\fR
489 .ad
490 .sp .6
491 .RS 4n
492 Lock file for the Kerberos administrative database. This file works backwards
493 from most other lock files (that is, \fBkadmin\fR exits with an error if this
494 file does not exist).
495 .RE
497 .sp
498 .ne 2
499 .na
500 \fB\fB/var/krb5/principal.ulog\fR\fR
501 .ad
502 .sp .6
503 .RS 4n
504 The update log file for incremental propagation.
505 .RE
507 .SH ATTRIBUTES
508 .LP
509 See \fBattributes\fR(5) for descriptions of the following attributes:
510 .sp
512 .sp
513 .TS
514 box;
515 c | c
516 l | l .
517 ATTRIBUTE TYPE ATTRIBUTE VALUE
518 _
519 Interface Stability Evolving
520 .TE
522 .SH SEE ALSO
523 .LP
524 \fBkpasswd\fR(1), \fBkadmin\fR(1M), \fBkadmind\fR(1M),
525 \fBkadmin.local\fR(1M), \fBkdb5_ldap_util\fR(1M), \fBkproplog\fR(1M),
526 \fBkadm5.acl\fR(4), \fBkdc.conf\fR(4), \fBattributes\fR(5), \fBkerberos\fR(5)