crypto/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 .\" $Id$
  33 .\"
  34 .Dd December  8, 2004
  35 .Dt HPROP 8
  36 .Os HEIMDAL
  37 .Sh NAME
  38 .Nm hprop
  39 .Nd propagate the KDC database
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Bk -words
  43 .Oo Fl m Ar file \*(Ba Xo
  44 .Fl Fl master-key= Ns Pa file
  45 .Xc
  46 .Oc
  47 .Oo Fl d Ar file \*(Ba Xo
  48 .Fl Fl database= Ns Pa file
  49 .Xc
  50 .Oc
  51 .Op Fl Fl source= Ns Ar heimdal|mit-dump
  52 .Oo Fl r Ar string \*(Ba Xo
  53 .Fl Fl v4-realm= Ns Ar string
  54 .Xc
  55 .Oc
  56 .Oo Fl c Ar cell \*(Ba Xo
  57 .Fl Fl cell= Ns Ar cell
  58 .Xc
  59 .Oc
  60 .Oo Fl k Ar keytab \*(Ba Xo
  61 .Fl Fl keytab= Ns Ar keytab
  62 .Xc
  63 .Oc
  64 .Oo Fl R Ar string \*(Ba Xo
  65 .Fl Fl v5-realm= Ns Ar string
  66 .Xc
  67 .Oc
  68 .Op Fl D | Fl Fl decrypt
  69 .Op Fl E | Fl Fl encrypt
  70 .Op Fl n | Fl Fl stdout
  71 .Op Fl v | Fl Fl verbose
  72 .Op Fl Fl version
  73 .Op Fl h | Fl Fl help
  74 .Op Ar host Ns Op : Ns Ar port
  75 .Ar ...
  76 .Ek
  77 .Sh DESCRIPTION
  78 .Nm
  79 takes a principal database in a specified format and converts it into
  80 a stream of Heimdal database records. This stream can either be
  81 written to standard out, or (more commonly) be propagated to a
  82 .Xr hpropd 8
  83 server running on a different machine.
  84 .Pp
  85 If propagating, it connects to all
  86 .Ar hosts
  87 specified on the command by opening a TCP connection to port 754
  88 (service hprop) and sends the database in encrypted form.
  89 .Pp
  90 Supported options:
  91 .Bl -tag -width Ds
  92 .It Fl m Ar file , Fl Fl master-key= Ns Pa file
  93 Where to find the master key to encrypt or decrypt keys with.
  94 .It Fl d Ar file , Fl Fl database= Ns Pa file
  95 The database to be propagated.
  96 .It Fl Fl source= Ns Ar heimdal|mit-dump|krb4-dump|kaserver
  97 Specifies the type of the source database. Alternatives include:
  98 .Pp
  99 .Bl -tag -width mit-dump -compact -offset indent
 100 .It heimdal
 101 a Heimdal database
 102 .It mit-dump
 103 a MIT Kerberos 5 dump file
 104 .El
 105 +.It Fl k Ar keytab , Fl Fl keytab= Ns Ar keytab
 106 The keytab to use for fetching the key to be used for authenticating
 107 to the propagation daemon(s). The key
 108 .Pa hprop/hostname
 109 is used from this keytab.  The default is to fetch the key from the
 110 KDC database.
 111 .It Fl R Ar string , Fl Fl v5-realm= Ns Ar string
 112 Local realm override.
 113 .It Fl D , Fl Fl decrypt
 114 The encryption keys in the database can either be in clear, or
 115 encrypted with a master key. This option transmits the database with
 116 unencrypted keys.
 117 .It Fl E , Fl Fl encrypt
 118 This option transmits the database with encrypted keys.
 119 .It Fl n , Fl Fl stdout
 120 Dump the database on stdout, in a format that can be fed to hpropd.
 121 .El
 122 .Sh EXAMPLES
 123 The following will propagate a database to another machine (which
 124 should run
 125 .Xr hpropd 8 ) :
 126 .Bd -literal -offset indent
 127 $ hprop slave-1 slave-2
 128 .Ed
 129 .Sh SEE ALSO
 130 .Xr hpropd 8