xref: /freebsd/crypto/heimdal/kuser/kinit.1 (revision 5e9cd1ae3e10592ed70e7575551cba1bbab04d84)
1.\" $Id: kinit.1,v 1.8 2001/01/28 21:44:56 assar Exp $
2.\"
3.Dd May 29, 1998
4.Dt KINIT 1
5.Os HEIMDAL
6.Sh NAME
7.Nm kinit ,
8.Nm kauth
9.Nd
10acquire initial tickets
11.Sh SYNOPSIS
12.Nm kinit
13.Op Fl 4 | Fl -524init
14.Op Fl -afslog
15.Oo Fl c Ar cachename \*(Ba Xo
16.Fl -cache= Ns Ar cachename Oc
17.Xc
18.Op Fl f | Fl -forwardable
19.Oo Fl t Ar keytabname \*(Ba Xo
20.Fl -keytab= Ns Ar keytabname Oc
21.Xc
22.Oo Fl l Ar time \*(Ba Xo
23.Fl -lifetime= Ns Ar time Oc
24.Xc
25.Op Fl p | Fl -proxiable
26.Op Fl R | Fl -renew
27.Op Fl -renewable
28.Oo Fl r Ar time \*(Ba Xo
29.Fl -renewable-life= Ns Ar time Oc
30.Xc
31.Oo Fl S Ar principal \*(Ba Xo
32.Fl -server= Ns Ar principal Oc
33.Xc
34.Oo Fl s Ar time \*(Ba Xo
35.Fl -start-time= Ns Ar time Oc
36.Xc
37.Op Fl k | Fl -use-keytab
38.Op Fl v | Fl -validate
39.Oo Fl e Ar enctype \*(Ba Xo
40.Fl -enctypes= Ns Ar enctype Oc
41.Xc
42.Op Fl -fcache-version= Ns Ar integer
43.Op Fl -no-addresses
44.Op Fl -anonymous
45.Op Fl -version
46.Op Fl -help
47.Op Ar principal
48.Sh DESCRIPTION
49.Nm
50is used to authenticate to the kerberos server as
51.Ar principal ,
52or if none is given, a system generated default (typically your login
53name at the default realm), and acquire a ticket granting ticket that
54can later be used to obtain tickets for other services.
55.Pp
56If you have compiled kinit with Kerberos 4 support and you have a
57Kerberos 4 server,
58.Nm
59will detect this and get you Kerberos 4 tickets.
60.Pp
61Supported options:
62.Bl -tag -width Ds
63.It Xo
64.Fl c Ar cachename
65.Fl -cache= Ns Ar cachename
66.Xc
67The credentials cache to put the acquired ticket in, if other than
68default.
69.It Xo
70.Fl f Ns ,
71.Fl -forwardable
72.Xc
73Get ticket that can be forwarded to another host.
74.It Xo
75.Fl t Ar keytabname Ns ,
76.Fl -keytab= Ns Ar keytabname
77.Xc
78Don't ask for a password, but instead get the key from the specified
79keytab.
80.It Xo
81.Fl l Ar time Ns ,
82.Fl -lifetime= Ns Ar time
83.Xc
84Specifies the lifetime of the ticket. The argument can either be in
85seconds, or a more human readable string like
86.Sq 1h .
87.It Xo
88.Fl p Ns ,
89.Fl -proxiable
90.Xc
91Request tickets with the proxiable flag set.
92.It Xo
93.Fl R Ns ,
94.Fl -renew
95.Xc
96Try to renew ticket. The ticket must have the
97.Sq renewable
98flag set, and must not be expired.
99.It Fl -renewable
100The same as
101.Fl -renewable-life ,
102with an infinite time.
103.It Xo
104.Fl r Ar time Ns ,
105.Fl -renewable-life= Ns Ar time
106.Xc
107The max renewable ticket life.
108.It Xo
109.Fl S Ar principal Ns ,
110.Fl -server= Ns Ar principal
111.Xc
112Get a ticket for a service other than krbtgt/LOCAL.REALM.
113.It Xo
114.Fl s Ar time Ns ,
115.Fl -start-time= Ns Ar time
116.Xc
117Obtain a ticket that starts to be valid
118.Ar time
119(which can really be a generic time specification, like
120.Sq 1h )
121seconds into the future.
122.It Xo
123.Fl k Ns ,
124.Fl -use-keytab
125.Xc
126The same as
127.Fl -keytab ,
128but with the default keytab name (normally
129.Ar FILE:/etc/krb5.keytab ) .
130.It Xo
131.Fl v Ns ,
132.Fl -validate
133.Xc
134Try to validate an invalid ticket.
135.It Xo
136.Fl e ,
137.Fl -enctypes= Ns Ar enctypes
138.Xc
139Request tickets with this particular enctype.
140.It Xo
141.Fl -fcache-version= Ns Ar version
142.Xc
143Create a credentials cache of version
144.Nm version .
145.It Xo
146.Fl -no-addresses
147.Xc
148Request a ticket with no addresses.
149.It Xo
150.Fl -anonymous
151.Xc
152Request an anonymous ticket (which means that the ticket will be
153issued to an anonymous principal, typically
154.Dq anonymous@REALM).
155.El
156.Pp
157The following options are only available if
158.Nm
159has been compiled with support for Kerberos 4. The
160.Nm kauth
161program is identical to
162.Nm kinit ,
163but has these options enabled by
164default.
165.Bl -tag -width Ds
166.It Xo
167.Fl 4 Ns ,
168.Fl -524init
169.Xc
170Try to convert the obtained Kerberos 5 krbtgt to a version 4 compatible
171ticket. It will store this ticket in the default Kerberos 4 ticket
172file.
173.It Fl -afslog
174Gets AFS tickets, converts them to version 4 format, and stores them
175in the kernel. Only useful if you have AFS.
176.El
177.Pp
178The
179.Ar forwardable ,
180.Ar proxiable ,
181.Ar ticket_life ,
182and
183.Ar renewable_life
184options can be set to a default value from the
185.Dv appdefaults
186section in krb5.conf, see
187.Xr krb5_appdefault 3 .
188.Sh ENVIRONMENT
189.Bl -tag -width Ds
190.It Ev KRB5CCNAME
191Specifies the default cache file.
192.It Ev KRB5_CONFIG
193The directory where the
194.Pa krb5.conf
195can be found, default is
196.Pa /etc .
197.It Ev KRBTKFILE
198Specifies the Kerberos 4 ticket file to store version 4 tickets in.
199.El
200.\".Sh FILES
201.\".Sh EXAMPLES
202.\".Sh DIAGNOSTICS
203.Sh SEE ALSO
204.Xr kdestroy 1 ,
205.Xr klist 1 ,
206.Xr krb5.conf 5 ,
207.Xr krb5_appdefault 3
208.\".Sh STANDARDS
209.\".Sh HISTORY
210.\".Sh AUTHORS
211.\".Sh BUGS
212