xref: /minix/crypto/external/bsd/heimdal/dist/kdc/hprop.8 (revision 0a6a1f1d)
1.\"	$NetBSD: hprop.8,v 1.4 2014/04/24 13:45:34 pettai Exp $
2.\"
3.\" Copyright (c) 2000 - 2004 Kungliga Tekniska Högskolan
4.\" (Royal Institute of Technology, Stockholm, Sweden).
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\"
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\"
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" 3. Neither the name of the Institute nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\" Id
35.\"
36.Dd December  8, 2004
37.Dt HPROP 8
38.Os
39.Sh NAME
40.Nm hprop
41.Nd propagate the KDC database
42.Sh SYNOPSIS
43.Nm
44.Bk -words
45.Oo Fl m Ar file \*(Ba Xo
46.Fl Fl master-key= Ns Pa file
47.Xc
48.Oc
49.Oo Fl d Ar file \*(Ba Xo
50.Fl Fl database= Ns Pa file
51.Xc
52.Oc
53.Op Fl Fl source= Ns Ar heimdal|mit-dump
54.Oo Fl r Ar string \*(Ba Xo
55.Fl Fl v4-realm= Ns Ar string
56.Xc
57.Oc
58.Oo Fl c Ar cell \*(Ba Xo
59.Fl Fl cell= Ns Ar cell
60.Xc
61.Oc
62.Oo Fl k Ar keytab \*(Ba Xo
63.Fl Fl keytab= Ns Ar keytab
64.Xc
65.Oc
66.Oo Fl R Ar string \*(Ba Xo
67.Fl Fl v5-realm= Ns Ar string
68.Xc
69.Oc
70.Op Fl D | Fl Fl decrypt
71.Op Fl E | Fl Fl encrypt
72.Op Fl n | Fl Fl stdout
73.Op Fl v | Fl Fl verbose
74.Op Fl Fl version
75.Op Fl h | Fl Fl help
76.Op Ar host Ns Op : Ns Ar port
77.Ar ...
78.Ek
79.Sh DESCRIPTION
80.Nm
81takes a principal database in a specified format and converts it into
82a stream of Heimdal database records. This stream can either be
83written to standard out, or (more commonly) be propagated to a
84.Xr hpropd 8
85server running on a different machine.
86.Pp
87If propagating, it connects to all
88.Ar hosts
89specified on the command by opening a TCP connection to port 754
90(service hprop) and sends the database in encrypted form.
91.Pp
92Supported options:
93.Bl -tag -width Ds
94.It Fl m Ar file , Fl Fl master-key= Ns Pa file
95Where to find the master key to encrypt or decrypt keys with.
96.It Fl d Ar file , Fl Fl database= Ns Pa file
97The database to be propagated.
98.It Fl Fl source= Ns Ar heimdal|mit-dump|krb4-dump|kaserver
99Specifies the type of the source database. Alternatives include:
100.Pp
101.Bl -tag -width mit-dump -compact -offset indent
102.It heimdal
103a Heimdal database
104.It mit-dump
105a MIT Kerberos 5 dump file
106.El
107+.It Fl k Ar keytab , Fl Fl keytab= Ns Ar keytab
108The keytab to use for fetching the key to be used for authenticating
109to the propagation daemon(s). The key
110.Pa hprop/hostname
111is used from this keytab.  The default is to fetch the key from the
112KDC database.
113.It Fl R Ar string , Fl Fl v5-realm= Ns Ar string
114Local realm override.
115.It Fl D , Fl Fl decrypt
116The encryption keys in the database can either be in clear, or
117encrypted with a master key. This option transmits the database with
118unencrypted keys.
119.It Fl E , Fl Fl encrypt
120This option transmits the database with encrypted keys.
121.It Fl n , Fl Fl stdout
122Dump the database on stdout, in a format that can be fed to hpropd.
123.El
124.Sh EXAMPLES
125The following will propagate a database to another machine (which
126should run
127.Xr hpropd 8 ) :
128.Bd -literal -offset indent
129$ hprop slave-1 slave-2
130.Ed
131.Sh SEE ALSO
132.Xr hpropd 8
133