crypto/dist/heimdal/kuser/kinit.1

   1 .\" Copyright (c) 1998 - 2003, 2006 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: kinit.1 17822 2006-07-10 14:46:58Z lha $
  33 .\" $NetBSD: kinit.1,v 1.10 2008/03/22 08:37:03 mlelstv Exp $
  34 .\"
  35 .Dd April 25, 2006
  36 .Dt KINIT 1
  37 .Os
  38 .Sh NAME
  39 .Nm kinit
  40 .Nm kauth
  41 .Nd acquire initial tickets
  42 .Sh SYNOPSIS
  43 .Nm kinit
  44 .Op Fl 4 | Fl -524init
  45 .Op Fl 9 | Fl -524convert
  46 .Op Fl -afslog
  47 .Oo Fl c Ar cachename \*(Ba Xo
  48 .Fl -cache= Ns Ar cachename
  49 .Xc
  50 .Oc
  51 .Op Fl f | Fl -forwardable
  52 .Oo Fl t Ar keytabname \*(Ba Xo
  53 .Fl -keytab= Ns Ar keytabname
  54 .Xc
  55 .Oc
  56 .Oo Fl l Ar time \*(Ba Xo
  57 .Fl -lifetime= Ns Ar time
  58 .Xc
  59 .Oc
  60 .Op Fl p | Fl -proxiable
  61 .Op Fl R | Fl -renew
  62 .Op Fl -renewable
  63 .Oo Fl r Ar time \*(Ba Xo
  64 .Fl -renewable-life= Ns Ar time
  65 .Xc
  66 .Oc
  67 .Oo Fl S Ar principal \*(Ba Xo
  68 .Fl -server= Ns Ar principal
  69 .Xc
  70 .Oc
  71 .Oo Fl s Ar time \*(Ba Xo
  72 .Fl -start-time= Ns Ar time
  73 .Xc
  74 .Oc
  75 .Op Fl k | Fl -use-keytab
  76 .Op Fl v | Fl -validate
  77 .Oo Fl e Ar enctypes \*(Ba Xo
  78 .Fl -enctypes= Ns Ar enctypes
  79 .Xc
  80 .Oc
  81 .Oo Fl a Ar addresses \*(Ba Xo
  82 .Fl -extra-addresses= Ns Ar addresses
  83 .Xc
  84 .Oc
  85 .Op Fl -password-file= Ns Ar filename
  86 .Op Fl -fcache-version= Ns Ar version-number
  87 .Op Fl A | Fl -no-addresses
  88 .Op Fl -anonymous
  89 .Op Fl -version
  90 .Op Fl -help
  91 .Op Ar principal Op Ar command
  92 .Sh DESCRIPTION
  93 .Nm
  94 is used to authenticate to the Kerberos server as
  95 .Ar principal ,
  96 or if none is given, a system generated default (typically your login
  97 name at the default realm), and acquire a ticket granting ticket that
  98 can later be used to obtain tickets for other services.
  99 .Pp
 100 If you have compiled
 101 .Nm kinit
 102 with Kerberos 4 support and you have a
 103 Kerberos 4 server,
 104 .Nm
 105 will detect this and get you Kerberos 4 tickets.
 106 .Pp
 107 Supported options:
 108 .Bl -tag -width Ds
 109 .It Fl c Ar cachename , Fl -cache= Ns Ar cachename
 110 The credentials cache to put the acquired ticket in, if other than
 111 default.
 112 .It Fl f , Fl -forwardable
 113 Get ticket that can be forwarded to another host.
 114 .It Fl t Ar keytabname , Fl -keytab= Ns Ar keytabname
 115 Don't ask for a password, but instead get the key from the specified
 116 keytab.
 117 .It Fl l Ar time , Fl -lifetime= Ns Ar time
 118 Specifies the lifetime of the ticket.
 119 The argument can either be in seconds, or a more human readable string
 120 like
 121 .Sq 1h .
 122 .It Fl p , Fl -proxiable
 123 Request tickets with the proxiable flag set.
 124 .It Fl R , .Fl -renew
 125 Try to renew ticket.
 126 The ticket must have the
 127 .Sq renewable
 128 flag set, and must not be expired.
 129 .It Fl -renewable
 130 The same as
 131 .Fl -renewable-life ,
 132 with an infinite time.
 133 .It Fl r Ar time , Fl -renewable-life= Ns Ar time
 134 The max renewable ticket life.
 135 .It Fl S Ar principal , Fl -server= Ns Ar principal
 136 Get a ticket for a service other than krbtgt/LOCAL.REALM.
 137 .It Fl s Ar time , Fl -start-time= Ns Ar time
 138 Obtain a ticket that starts to be valid
 139 .Ar time
 140 (which can really be a generic time specification, like
 141 .Sq 1h )
 142 seconds into the future.
 143 .It Fl k , Fl -use-keytab
 144 The same as
 145 .Fl -keytab ,
 146 but with the default keytab name (normally
 147 .Ar FILE:/etc/krb5.keytab ) .
 148 .It Fl v , Fl -validate
 149 Try to validate an invalid ticket.
 150 .It Fl e , Fl -enctypes= Ns Ar enctypes
 151 Request tickets with this particular enctype.
 152 .It Fl -password-file= Ns Ar filename
 153 read the password from the first line of
 154 .Ar filename .
 155 If the
 156 .Ar filename
 157 is
 158 .Ar STDIN ,
 159 the password will be read from the standard input.
 160 .It Fl -fcache-version= Ns Ar version-number
 161 Create a credentials cache of version
 162 .Ar version-number .
 163 .It Fl a , Fl -extra-addresses= Ns Ar enctypes
 164 Adds a set of addresses that will, in addition to the systems local
 165 addresses, be put in the ticket.
 166 This can be useful if all addresses a client can use can't be
 167 automatically figured out.
 168 One such example is if the client is behind a firewall.
 169 Also settable via
 170 .Li libdefaults/extra_addresses
 171 in
 172 .Xr krb5.conf 5 .
 173 .It Fl A , Fl -no-addresses
 174 Request a ticket with no addresses.
 175 .It Fl -anonymous
 176 Request an anonymous ticket (which means that the ticket will be
 177 issued to an anonymous principal, typically
 178 .Dq anonymous@REALM ) .
 179 .El
 180 .Pp
 181 The following options are only available if
 182 .Nm
 183 has been compiled with support for Kerberos 4.
 184 .Bl -tag -width Ds
 185 .It Fl 4 , Fl -524init
 186 Try to convert the obtained Kerberos 5 krbtgt to a version 4
 187 compatible ticket.
 188 It will store this ticket in the default Kerberos 4 ticket file.
 189 .It Fl 9 , Fl -524convert
 190 only convert ticket to version 4
 191 .It Fl -afslog
 192 Gets AFS tickets, converts them to version 4 format, and stores them
 193 in the kernel.
 194 Only useful if you have AFS.
 195 .El
 196 .Pp
 197 The
 198 .Ar forwardable ,
 199 .Ar proxiable ,
 200 .Ar ticket_life ,
 201 and
 202 .Ar renewable_life
 203 options can be set to a default value from the
 204 .Dv appdefaults
 205 section in krb5.conf, see
 206 .Xr krb5_appdefault 3 .
 207 .Pp
 208 If  a
 209 .Ar command
 210 is given,
 211 .Nm kinit
 212 will set up new credentials caches, and AFS PAG, and then run the given
 213 command.
 214 When it finishes the credentials will be removed.
 215 .Sh ENVIRONMENT
 216 .Bl -tag -width Ds
 217 .It Ev KRB5CCNAME
 218 Specifies the default credentials cache.
 219 .It Ev KRB5_CONFIG
 220 The file name of
 221 .Pa krb5.conf ,
 222 the default being
 223 .Pa /etc/krb5.conf .
 224 .It Ev KRBTKFILE
 225 Specifies the Kerberos 4 ticket file to store version 4 tickets in.
 226 .El
 227 .\".Sh FILES
 228 .\".Sh EXAMPLES
 229 .\".Sh DIAGNOSTICS
 230 .Sh SEE ALSO
 231 .Xr kdestroy 1 ,
 232 .Xr klist 1 ,
 233 .Xr krb5_appdefault 3 ,
 234 .Xr krb5.conf 5
 235 .\".Sh STANDARDS
 236 .\".Sh HISTORY
 237 .\".Sh AUTHORS
 238 .\".Sh BUGS