freebsd-dev/crypto/heimdal/kuser/kinit.1

.\" $Id: kinit.1,v 1.16 2002/01/24 15:30:45 assar Exp $
.\"
.Dd May 29, 1998
.Dt KINIT 1
.Os HEIMDAL
.Sh NAME
.Nm kinit
.Nm kauth
.Nd acquire initial tickets
.Sh SYNOPSIS
.Nm kinit
.Op Fl 4 | Fl -524init
.Op Fl 9 | Fl -524convert
.Op Fl -afslog
.Oo Fl c Ar cachename \*(Ba Xo
.Fl -cache= Ns Ar cachename
.Xc
.Oc
.Op Fl f | Fl -forwardable
.Oo Fl t Ar keytabname \*(Ba Xo
.Fl -keytab= Ns Ar keytabname
.Xc
.Oc
.Oo Fl l Ar time \*(Ba Xo
.Fl -lifetime= Ns Ar time
.Xc
.Oc
.Op Fl p | Fl -proxiable
.Op Fl R | Fl -renew
.Op Fl -renewable
.Oo Fl r Ar time \*(Ba Xo
.Fl -renewable-life= Ns Ar time
.Xc
.Oc
.Oo Fl S Ar principal \*(Ba Xo
.Fl -server= Ns Ar principal
.Xc
.Oc
.Oo Fl s Ar time \*(Ba Xo
.Fl -start-time= Ns Ar time
.Xc
.Oc
.Op Fl k | Fl -use-keytab
.Op Fl v | Fl -validate
.Oo Fl e Ar enctypes \*(Ba Xo
.Fl -enctypes= Ns Ar enctypes
.Xc
.Oc
.Op Fl -fcache-version= Ns Ar integer
.Op Fl -no-addresses
.Op Fl -anonymous
.Op Fl -version
.Op Fl -help
.Op Ar principal Op Ar command
.Sh DESCRIPTION
.Nm
is used to authenticate to the kerberos server as
.Ar principal ,
or if none is given, a system generated default (typically your login
name at the default realm), and acquire a ticket granting ticket that
can later be used to obtain tickets for other services.
.Pp
If you have compiled
.Nm kinit
with Kerberos 4 support and you have a
Kerberos 4 server,
.Nm
will detect this and get you Kerberos 4 tickets.
.Pp
Supported options:
.Bl -tag -width Ds
.It Xo
.Fl c Ar cachename
.Fl -cache= Ns Ar cachename
.Xc
The credentials cache to put the acquired ticket in, if other than
default.
.It Xo
.Fl f Ns ,
.Fl -forwardable
.Xc
Get ticket that can be forwarded to another host.
.It Xo
.Fl t Ar keytabname Ns ,
.Fl -keytab= Ns Ar keytabname
.Xc
Don't ask for a password, but instead get the key from the specified
keytab.
.It Xo 
.Fl l Ar time Ns , 
.Fl -lifetime= Ns Ar time
.Xc
Specifies the lifetime of the ticket. The argument can either be in
seconds, or a more human readable string like
.Sq 1h .
.It Xo
.Fl p Ns ,
.Fl -proxiable
.Xc
Request tickets with the proxiable flag set.
.It Xo
.Fl R Ns ,
.Fl -renew
.Xc
Try to renew ticket. The ticket must have the
.Sq renewable
flag set, and must not be expired.
.It Fl -renewable
The same as
.Fl -renewable-life ,
with an infinite time.
.It Xo
.Fl r Ar time Ns ,
.Fl -renewable-life= Ns Ar time
.Xc
The max renewable ticket life.
.It Xo
.Fl S Ar principal Ns ,
.Fl -server= Ns Ar principal
.Xc
Get a ticket for a service other than krbtgt/LOCAL.REALM.
.It Xo
.Fl s Ar time Ns ,
.Fl -start-time= Ns Ar time
.Xc
Obtain a ticket that starts to be valid
.Ar time
(which can really be a generic time specification, like
.Sq 1h )
seconds into the future.
.It Xo
.Fl k Ns ,
.Fl -use-keytab
.Xc
The same as
.Fl -keytab ,
but with the default keytab name (normally
.Ar FILE:/etc/krb5.keytab ) .
.It Xo
.Fl v Ns ,
.Fl -validate
.Xc
Try to validate an invalid ticket.
.It Xo
.Fl e ,
.Fl -enctypes= Ns Ar enctypes
.Xc
Request tickets with this particular enctype.
.It Xo
.Fl -fcache-version= Ns Ar version
.Xc
Create a credentials cache of version
.Nm version .
.It Xo
.Fl -no-addresses
.Xc
Request a ticket with no addresses.
.It Xo
.Fl -anonymous
.Xc
Request an anonymous ticket (which means that the ticket will be
issued to an anonymous principal, typically 
.Dq anonymous@REALM).
.El
.Pp
The following options are only available if
.Nm 
has been compiled with support for Kerberos 4. 
.Bl -tag -width Ds
.It Xo
.Fl 4 Ns ,
.Fl -524init
.Xc
Try to convert the obtained Kerberos 5 krbtgt to a version 4
compatible ticket. It will store this ticket in the default Kerberos 4
ticket file.
.It Xo
.Fl 9 Ns ,
.Fl -524convert
.Xc
only convert ticket to version 4
.It Fl -afslog
Gets AFS tickets, converts them to version 4 format, and stores them
in the kernel. Only useful if you have AFS.
.El
.Pp
The 
.Ar forwardable ,
.Ar proxiable ,
.Ar ticket_life ,
and
.Ar renewable_life 
options can be set to a default value from the
.Dv appdefaults
section in krb5.conf, see
.Xr krb5_appdefault 3 .
.Pp
If  a
.Ar command
is given, 
.Nm kinit
will setup new credentials caches, and AFS PAG, and then run the given
command. When it finishes the credentials will be removed.
.Sh ENVIRONMENT
.Bl -tag -width Ds
.It Ev KRB5CCNAME
Specifies the default credentials cache.
.It Ev KRB5_CONFIG
The file name of
.Pa krb5.conf
, the default being
.Pa /etc/krb5.conf .
.It Ev KRBTKFILE
Specifies the Kerberos 4 ticket file to store version 4 tickets in.
.El
.\".Sh FILES
.\".Sh EXAMPLES
.\".Sh DIAGNOSTICS
.Sh SEE ALSO
.Xr kdestroy 1 ,
.Xr klist 1 ,
.Xr krb5_appdefault 3 ,
.Xr krb5.conf 5
.\".Sh STANDARDS
.\".Sh HISTORY
.\".Sh AUTHORS
.\".Sh BUGS
Import of Heimdal Kerberos from KTH repository circa 2002/02/17. 2002-02-19 15:46:56 +00:00			`.\" $Id: kinit.1,v 1.16 2002/01/24 15:30:45 assar Exp $`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.\"`
			`.Dd May 29, 1998`
Vendor import of Heimdal 0.2n 2000-02-24 11:07:16 +00:00			`.Dt KINIT 1`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.Os HEIMDAL`
			`.Sh NAME`
Import of Heimdal Kerberos from KTH repository circa 2002/02/17. 2002-02-19 15:46:56 +00:00			`.Nm kinit`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.Nm kauth`
mdoc(ng) fixes Submitted by: ru 2001-05-08 14:57:13 +00:00			`.Nd acquire initial tickets`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.Sh SYNOPSIS`
Vendor import of Heimdal 0.2n 2000-02-24 11:07:16 +00:00			`.Nm kinit`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Op Fl 4 \| Fl -524init`
Import of Heimdal Kerberos from KTH repository circa 2002/02/17. 2002-02-19 15:46:56 +00:00			`.Op Fl 9 \| Fl -524convert`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.Op Fl -afslog`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Oo Fl c Ar cachename \*(Ba Xo`
import of heimdal 0.3f 2001-06-21 02:12:07 +00:00			`.Fl -cache= Ns Ar cachename`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Xc`
import of heimdal 0.3f 2001-06-21 02:12:07 +00:00			`.Oc`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Op Fl f \| Fl -forwardable`
			`.Oo Fl t Ar keytabname \*(Ba Xo`
import of heimdal 0.3f 2001-06-21 02:12:07 +00:00			`.Fl -keytab= Ns Ar keytabname`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Xc`
import of heimdal 0.3f 2001-06-21 02:12:07 +00:00			`.Oc`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Oo Fl l Ar time \*(Ba Xo`
import of heimdal 0.3f 2001-06-21 02:12:07 +00:00			`.Fl -lifetime= Ns Ar time`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Xc`
import of heimdal 0.3f 2001-06-21 02:12:07 +00:00			`.Oc`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Op Fl p \| Fl -proxiable`
			`.Op Fl R \| Fl -renew`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.Op Fl -renewable`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Oo Fl r Ar time \*(Ba Xo`
import of heimdal 0.3f 2001-06-21 02:12:07 +00:00			`.Fl -renewable-life= Ns Ar time`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Xc`
import of heimdal 0.3f 2001-06-21 02:12:07 +00:00			`.Oc`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Oo Fl S Ar principal \*(Ba Xo`
import of heimdal 0.3f 2001-06-21 02:12:07 +00:00			`.Fl -server= Ns Ar principal`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Xc`
import of heimdal 0.3f 2001-06-21 02:12:07 +00:00			`.Oc`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Oo Fl s Ar time \*(Ba Xo`
import of heimdal 0.3f 2001-06-21 02:12:07 +00:00			`.Fl -start-time= Ns Ar time`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Xc`
import of heimdal 0.3f 2001-06-21 02:12:07 +00:00			`.Oc`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Op Fl k \| Fl -use-keytab`
			`.Op Fl v \| Fl -validate`
Import of Heimdal Kerberos from KTH repository circa 2002/02/17. 2002-02-19 15:46:56 +00:00			`.Oo Fl e Ar enctypes \*(Ba Xo`
			`.Fl -enctypes= Ns Ar enctypes`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Xc`
import of heimdal 0.3f 2001-06-21 02:12:07 +00:00			`.Oc`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Op Fl -fcache-version= Ns Ar integer`
Vendor import of Heimdal 0.2n 2000-02-24 11:07:16 +00:00			`.Op Fl -no-addresses`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Op Fl -anonymous`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.Op Fl -version`
			`.Op Fl -help`
import of heimdal 0.3f 2001-06-21 02:12:07 +00:00			`.Op Ar principal Op Ar command`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.Sh DESCRIPTION`
			`.Nm`
			`is used to authenticate to the kerberos server as`
			`.Ar principal ,`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`or if none is given, a system generated default (typically your login`
			`name at the default realm), and acquire a ticket granting ticket that`
			`can later be used to obtain tickets for other services.`
			`.Pp`
Import of Heimdal Kerberos from KTH repository circa 2002/02/17. 2002-02-19 15:46:56 +00:00			`If you have compiled`
			`.Nm kinit`
			`with Kerberos 4 support and you have a`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`Kerberos 4 server,`
			`.Nm`
			`will detect this and get you Kerberos 4 tickets.`
			`.Pp`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`Supported options:`
			`.Bl -tag -width Ds`
			`.It Xo`
			`.Fl c Ar cachename`
			`.Fl -cache= Ns Ar cachename`
			`.Xc`
			`The credentials cache to put the acquired ticket in, if other than`
			`default.`
			`.It Xo`
			`.Fl f Ns ,`
			`.Fl -forwardable`
			`.Xc`
			`Get ticket that can be forwarded to another host.`
			`.It Xo`
			`.Fl t Ar keytabname Ns ,`
			`.Fl -keytab= Ns Ar keytabname`
			`.Xc`
			`Don't ask for a password, but instead get the key from the specified`
			`keytab.`
			`.It Xo`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Fl l Ar time Ns ,`
			`.Fl -lifetime= Ns Ar time`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.Xc`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`Specifies the lifetime of the ticket. The argument can either be in`
			`seconds, or a more human readable string like`
			`.Sq 1h .`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.It Xo`
			`.Fl p Ns ,`
			`.Fl -proxiable`
			`.Xc`
			`Request tickets with the proxiable flag set.`
			`.It Xo`
			`.Fl R Ns ,`
			`.Fl -renew`
			`.Xc`
			`Try to renew ticket. The ticket must have the`
			`.Sq renewable`
			`flag set, and must not be expired.`
			`.It Fl -renewable`
			`The same as`
			`.Fl -renewable-life ,`
			`with an infinite time.`
			`.It Xo`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Fl r Ar time Ns ,`
			`.Fl -renewable-life= Ns Ar time`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.Xc`
			`The max renewable ticket life.`
			`.It Xo`
			`.Fl S Ar principal Ns ,`
			`.Fl -server= Ns Ar principal`
			`.Xc`
			`Get a ticket for a service other than krbtgt/LOCAL.REALM.`
			`.It Xo`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Fl s Ar time Ns ,`
			`.Fl -start-time= Ns Ar time`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.Xc`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`Obtain a ticket that starts to be valid`
			`.Ar time`
			`(which can really be a generic time specification, like`
			`.Sq 1h )`
			`seconds into the future.`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.It Xo`
			`.Fl k Ns ,`
			`.Fl -use-keytab`
			`.Xc`
			`The same as`
			`.Fl -keytab ,`
			`but with the default keytab name (normally`
			`.Ar FILE:/etc/krb5.keytab ) .`
			`.It Xo`
			`.Fl v Ns ,`
			`.Fl -validate`
			`.Xc`
			`Try to validate an invalid ticket.`
			`.It Xo`
			`.Fl e ,`
			`.Fl -enctypes= Ns Ar enctypes`
			`.Xc`
			`Request tickets with this particular enctype.`
			`.It Xo`
			`.Fl -fcache-version= Ns Ar version`
			`.Xc`
			`Create a credentials cache of version`
			`.Nm version .`
			`.It Xo`
Vendor import of Heimdal 0.2n 2000-02-24 11:07:16 +00:00			`.Fl -no-addresses`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.Xc`
			`Request a ticket with no addresses.`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.It Xo`
			`.Fl -anonymous`
			`.Xc`
			`Request an anonymous ticket (which means that the ticket will be`
			`issued to an anonymous principal, typically`
			`.Dq anonymous@REALM).`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.El`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Pp`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`The following options are only available if`
			`.Nm`
Import of Heimdal Kerberos from KTH repository circa 2002/02/17. 2002-02-19 15:46:56 +00:00			`has been compiled with support for Kerberos 4.`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.Bl -tag -width Ds`
			`.It Xo`
			`.Fl 4 Ns ,`
			`.Fl -524init`
			`.Xc`
Import of Heimdal Kerberos from KTH repository circa 2002/02/17. 2002-02-19 15:46:56 +00:00			`Try to convert the obtained Kerberos 5 krbtgt to a version 4`
			`compatible ticket. It will store this ticket in the default Kerberos 4`
			`ticket file.`
			`.It Xo`
			`.Fl 9 Ns ,`
			`.Fl -524convert`
			`.Xc`
			`only convert ticket to version 4`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.It Fl -afslog`
			`Gets AFS tickets, converts them to version 4 format, and stores them`
			`in the kernel. Only useful if you have AFS.`
			`.El`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Pp`
			`The`
			`.Ar forwardable ,`
			`.Ar proxiable ,`
			`.Ar ticket_life ,`
			`and`
			`.Ar renewable_life`
			`options can be set to a default value from the`
			`.Dv appdefaults`
			`section in krb5.conf, see`
			`.Xr krb5_appdefault 3 .`
import of heimdal 0.3f 2001-06-21 02:12:07 +00:00			`.Pp`
			`If a`
			`.Ar command`
			`is given,`
			`.Nm kinit`
			`will setup new credentials caches, and AFS PAG, and then run the given`
			`command. When it finishes the credentials will be removed.`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.Sh ENVIRONMENT`
			`.Bl -tag -width Ds`
			`.It Ev KRB5CCNAME`
Import of Heimdal Kerberos from KTH repository circa 2002/02/17. 2002-02-19 15:46:56 +00:00			`Specifies the default credentials cache.`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.It Ev KRB5_CONFIG`
Import of Heimdal Kerberos from KTH repository circa 2002/02/17. 2002-02-19 15:46:56 +00:00			`The file name of`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.Pa krb5.conf`
Import of Heimdal Kerberos from KTH repository circa 2002/02/17. 2002-02-19 15:46:56 +00:00			`, the default being`
			`.Pa /etc/krb5.conf .`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.It Ev KRBTKFILE`
			`Specifies the Kerberos 4 ticket file to store version 4 tickets in.`
			`.El`
			`.\".Sh FILES`
			`.\".Sh EXAMPLES`
			`.\".Sh DIAGNOSTICS`
			`.Sh SEE ALSO`
import of heimdal 0.3e 2001-02-13 16:46:19 +00:00			`.Xr kdestroy 1 ,`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.Xr klist 1 ,`
Import of Heimdal Kerberos from KTH repository circa 2002/02/17. 2002-02-19 15:46:56 +00:00			`.Xr krb5_appdefault 3 ,`
			`.Xr krb5.conf 5`
Import KTH Heimdal, which will be the core of our Kerberos5. Userland to follow. 2000-01-09 20:58:00 +00:00			`.\".Sh STANDARDS`
			`.\".Sh HISTORY`
			`.\".Sh AUTHORS`
			`.\".Sh BUGS`