s4:torture: Adapt KDC canon test to Heimdal upstream changes
[samba.git] / third_party / heimdal / kuser / kimpersonate.8
1 .\" Copyright (c) 2002 - 2007 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 September 18, 2006
35 .Dt KIMPERSONATE 8
36 .Os
37 .Sh NAME
38 .Nm kimpersonate
39 .Nd impersonate a user when there exist a keyfile or KeyFile
40 .Sh SYNOPSIS
41 .Nm
42 .Op Fl s Ar string \*(Ba Fl Fl ccache= Ns Ar string
43 .Op Fl s Ar string \*(Ba Fl Fl server= Ns Ar string
44 .Op Fl c Ar string \*(Ba Fl Fl client= Ns Ar string
45 .Op Fl k Ar string \*(Ba Fl Fl keytab= Ns Ar string
46 .Op Fl 5 | Fl Fl krb5
47 .Op Fl A | Fl Fl add
48 .Op Fl R | Fl Fl referral
49 .Op Fl e Ar integer \*(Ba Fl Fl expire-time= Ns Ar integer
50 .Op Fl a Ar string \*(Ba Fl Fl client-address= Ns Ar string
51 .Op Fl t Ar string \*(Ba Fl Fl enc-type= Ns Ar string
52 .Op Fl Fl session-enc-type= Ns Ar string
53 .Op Fl f Ar string \*(Ba Fl Fl ticket-flags= Ns Ar string
54 .Op Fl Fl verbose
55 .Op Fl Fl version
56 .Op Fl Fl help
57 .Sh DESCRIPTION
58 The
59 .Nm
60 program creates a "fake" ticket using the service-key of the service and
61 stores it in the given (or default) ccache.  This is useful for testing.
62 The service key can be read from a Kerberos 5 keytab or AFS KeyFile.
63 Supported options:
64 .Bl -tag -width Ds
65 .It Fl Fl ccache= Ns Ar string
66 ccache into which to store the ticket
67 .It Fl s Ar string Ns , Fl Fl server= Ns Ar string
68 name of server principal
69 .It Fl c Ar string Ns , Fl Fl client= Ns Ar string
70 name of client principal
71 .It Fl k Ar string Ns , Fl Fl keytab= Ns Ar string
72 name of keytab file
73 .It Fl 5 Ns , Fl Fl krb5
74 create a Kerberos 5 ticket
75 .It Fl A Ns , Fl Fl add
76 don't re-initialize the ccache, instead add the ticket to an existing
77 ccache.
78 .It Fl R Ns , Fl Fl referral
79 simulate a referrals-based KDC client by storing two entries, one with
80 the empty realm for the service principal name.
81 .It Fl e Ar integer Ns , Fl Fl expire-time= Ns Ar integer
82 lifetime of ticket in seconds
83 .It Fl a Ar string Ns , Fl Fl client-address= Ns Ar string
84 address of client
85 .It Fl t Ar string Ns , Fl Fl enc-type= Ns Ar string
86 encryption type (defaults to "aes256-cts-hmac-sha1-96")
87 .It Fl Fl session-enc-type= Ns Ar string
88 session encryption type (defaults to enc-type or "des-cbc-crc" for afs service tickets)
89 .It Fl f Ar string Ns , Fl Fl ticket-flags= Ns Ar string
90 ticket flags for krb5 ticket
91 .It Fl Fl verbose
92 Verbose output
93 .It Fl Fl version
94 Print version
95 .It Fl Fl help
96 .El
97 .Sh FILES
98 Uses
99 .Pa /etc/krb5.keytab,
100 and
101 .Pa /usr/afs/etc/KeyFile
102 when available and the
103 .Fl k
104 option is used with an appropriate prefix.
105 .Sh EXAMPLES
106 .Nm
107 can be used in
108 .Nm samba
109 root preexec option
110 or for debugging.
111 .Nm
112 -s host/hummel.e.kth.se@E.KTH.SE -c lha@E.KTH.SE -5
113 will create a Kerberos 5 ticket for lha@E.KTH.SE for the host
114 hummel.e.kth.se if there exists a keytab entry for it in
115 .Pa /etc/krb5.keytab .
116 .Pp
117 In combination with the
118 .Nm ktutil
119 command, this is useful for testing.  For example, 
120 .Pp
121 .Nm ktutil
122 -k tkt add -p host/foo.test@TEST -V2 -e aes256-cts-hmac-sha1-96 -r
123 .Pp
124 .Nm
125 --cache=tcc -s host/foo.test@TEST -c jdoe@TEST -k tkt --referral
126 .Sh SEE ALSO
127 .Xr kinit 1 ,
128 .Xr klist 1
129 .Sh AUTHORS
130 Love Hornquist Astrand <lha@kth.se>