crypto/dist/heimdal/kdc/hprop.8

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