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

243 lines
5.0 KiB
Groff
Raw Normal View History

.\" $Id: kinit.1,v 1.20 2002/08/28 16:09:36 joda Exp $
.\"
.Dd May 29, 1998
2000-02-24 11:07:16 +00:00
.Dt KINIT 1
.Os HEIMDAL
.Sh NAME
.Nm kinit
.Nm kauth
2001-05-08 14:57:13 +00:00
.Nd acquire initial tickets
.Sh SYNOPSIS
2000-02-24 11:07:16 +00:00
.Nm kinit
2001-02-13 16:46:19 +00:00
.Op Fl 4 | Fl -524init
.Op Fl 9 | Fl -524convert
.Op Fl -afslog
2001-02-13 16:46:19 +00:00
.Oo Fl c Ar cachename \*(Ba Xo
2001-06-21 02:12:07 +00:00
.Fl -cache= Ns Ar cachename
2001-02-13 16:46:19 +00:00
.Xc
2001-06-21 02:12:07 +00:00
.Oc
2001-02-13 16:46:19 +00:00
.Op Fl f | Fl -forwardable
.Oo Fl t Ar keytabname \*(Ba Xo
2001-06-21 02:12:07 +00:00
.Fl -keytab= Ns Ar keytabname
2001-02-13 16:46:19 +00:00
.Xc
2001-06-21 02:12:07 +00:00
.Oc
2001-02-13 16:46:19 +00:00
.Oo Fl l Ar time \*(Ba Xo
2001-06-21 02:12:07 +00:00
.Fl -lifetime= Ns Ar time
2001-02-13 16:46:19 +00:00
.Xc
2001-06-21 02:12:07 +00:00
.Oc
2001-02-13 16:46:19 +00:00
.Op Fl p | Fl -proxiable
.Op Fl R | Fl -renew
.Op Fl -renewable
2001-02-13 16:46:19 +00:00
.Oo Fl r Ar time \*(Ba Xo
2001-06-21 02:12:07 +00:00
.Fl -renewable-life= Ns Ar time
2001-02-13 16:46:19 +00:00
.Xc
2001-06-21 02:12:07 +00:00
.Oc
2001-02-13 16:46:19 +00:00
.Oo Fl S Ar principal \*(Ba Xo
2001-06-21 02:12:07 +00:00
.Fl -server= Ns Ar principal
2001-02-13 16:46:19 +00:00
.Xc
2001-06-21 02:12:07 +00:00
.Oc
2001-02-13 16:46:19 +00:00
.Oo Fl s Ar time \*(Ba Xo
2001-06-21 02:12:07 +00:00
.Fl -start-time= Ns Ar time
2001-02-13 16:46:19 +00:00
.Xc
2001-06-21 02:12:07 +00:00
.Oc
2001-02-13 16:46:19 +00:00
.Op Fl k | Fl -use-keytab
.Op Fl v | Fl -validate
.Oo Fl e Ar enctypes \*(Ba Xo
.Fl -enctypes= Ns Ar enctypes
2001-02-13 16:46:19 +00:00
.Xc
2001-06-21 02:12:07 +00:00
.Oc
.Oo Fl a Ar addresses \*(Ba Xo
.Fl -extra-addresses= Ns Ar addresses
.Xc
.Oc
2001-02-13 16:46:19 +00:00
.Op Fl -fcache-version= Ns Ar integer
2000-02-24 11:07:16 +00:00
.Op Fl -no-addresses
2001-02-13 16:46:19 +00:00
.Op Fl -anonymous
.Op Fl -version
.Op Fl -help
2001-06-21 02:12:07 +00:00
.Op Ar principal Op Ar command
.Sh DESCRIPTION
.Nm
is used to authenticate to the kerberos server as
.Ar principal ,
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
If you have compiled
.Nm kinit
with Kerberos 4 support and you have a
2001-02-13 16:46:19 +00:00
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 ,
.Fl -forwardable
.Xc
Get ticket that can be forwarded to another host.
.It Xo
.Fl t Ar keytabname ,
.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 ,
2001-02-13 16:46:19 +00:00
.Fl -lifetime= Ns Ar time
.Xc
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 .
.It Xo
.Fl p ,
.Fl -proxiable
.Xc
Request tickets with the proxiable flag set.
.It Xo
.Fl R ,
.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 ,
2001-02-13 16:46:19 +00:00
.Fl -renewable-life= Ns Ar time
.Xc
The max renewable ticket life.
.It Xo
.Fl S Ar principal ,
.Fl -server= Ns Ar principal
.Xc
Get a ticket for a service other than krbtgt/LOCAL.REALM.
.It Xo
.Fl s Ar time ,
2001-02-13 16:46:19 +00:00
.Fl -start-time= Ns Ar time
.Xc
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.
.It Xo
.Fl k ,
.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 ,
.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 a ,
.Fl -extra-addresses= Ns Ar enctypes
.Xc
Adds a set of addresses that will, in addition to the systems local
addresses, be put in the ticket. This can be useful if all addresses a
client can use can't be automatically figured out. One such example is
if the client is behind a firewall. Also settable via
.Li libdefaults/extra_addresses
in
.Xr krb5.conf 5 .
.It Xo
2000-02-24 11:07:16 +00:00
.Fl -no-addresses
.Xc
Request a ticket with no addresses.
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 ) .
.El
2001-02-13 16:46:19 +00:00
.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 ,
.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 ,
.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
2001-02-13 16:46:19 +00:00
.Pp
The
2001-02-13 16:46:19 +00:00
.Ar forwardable ,
.Ar proxiable ,
.Ar ticket_life ,
and
.Ar renewable_life
2001-02-13 16:46:19 +00:00
options can be set to a default value from the
.Dv appdefaults
section in krb5.conf, see
.Xr krb5_appdefault 3 .
2001-06-21 02:12:07 +00:00
.Pp
If a
.Ar command
is given,
2001-06-21 02:12:07 +00:00
.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
2001-02-13 16:46:19 +00:00
.Xr kdestroy 1 ,
.Xr klist 1 ,
.Xr krb5_appdefault 3 ,
.Xr krb5.conf 5
.\".Sh STANDARDS
.\".Sh HISTORY
.\".Sh AUTHORS
.\".Sh BUGS