crypto/dist/heimdal/kcm/kcm.8

   1 .\" Copyright (c) 2005 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: kcm.8 15497 2005-06-20 13:32:44Z lha $
  33 .\" $NetBSD: kcm.8,v 1.1 2008/03/22 09:29:56 mlelstv Exp $
  34 .\"
  35 .Dd May 29, 2005
  36 .Dt KCM 8
  37 .Os Heimdal
  38 .Sh NAME
  39 .Nm kcm
  40 .Nd
  41 is a process based credential cache for Kerberos tickets.
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl -cache-name= Ns Ar cachename
  45 .Oo Fl c Ar file \*(Ba Xo
  46 .Fl -config-file= Ns Ar file
  47 .Xc
  48 .Oc
  49 .Oo Fl g Ar group \*(Ba Xo
  50 .Fl -group= Ns Ar group
  51 .Xc
  52 .Oc
  53 .Op Fl -max-request= Ns Ar size
  54 .Op Fl -disallow-getting-krbtgt
  55 .Op Fl -detach
  56 .Op Fl h | Fl -help
  57 .Oo Fl k Ar principal \*(Ba Xo
  58 .Fl -system-principal= Ns Ar principal
  59 .Xc
  60 .Oc
  61 .Oo Fl l Ar time \*(Ba Xo
  62 .Fl -lifetime= Ns Ar time
  63 .Xc
  64 .Oc
  65 .Oo Fl m Ar mode \*(Ba Xo
  66 .Fl -mode= Ns Ar mode
  67 .Xc
  68 .Oc
  69 .Op Fl n | Fl -no-name-constraints
  70 .Oo Fl r Ar time \*(Ba Xo
  71 .Fl -renewable-life= Ns Ar time
  72 .Xc
  73 .Oc
  74 .Oo Fl s Ar path \*(Ba Xo
  75 .Fl -socket-path= Ns Ar path
  76 .Xc
  77 .Oc
  78 .Oo Xo
  79 .Fl -door-path= Ns Ar path
  80 .Xc
  81 .Oc
  82 .Oo Fl S Ar principal \*(Ba Xo
  83 .Fl -server= Ns Ar principal
  84 .Xc
  85 .Oc
  86 .Oo Fl t Ar keytab \*(Ba Xo
  87 .Fl -keytab= Ns Ar keytab
  88 .Xc
  89 .Oc
  90 .Oo Fl u Ar user \*(Ba Xo
  91 .Fl -user= Ns Ar user
  92 .Xc
  93 .Oc
  94 .Op Fl v | Fl -version
  95 .Sh DESCRIPTION
  96 .Nm
  97 is a process based credential cache.
  98 To use it, set the
  99 .Ev KRB5CCNAME
 100 enviroment variable to
 101 .Ql KCM: Ns Ar uid
 102 or add the stanza
 103 .Bd -literal
 104
 105 [libdefaults]
 106         default_cc_name = KCM:%{uid}
 107
 108 .Ed
 109 to the
 110 .Pa /etc/krb5.conf
 111 configuration file and make sure
 112 .Nm kcm
 113 is started in the system startup files.
 114 .Pp
 115 The
 116 .Nm
 117 daemon can hold the credentials for all users in the system.  Access
 118 control is done with Unix-like permissions.  The daemon checks the
 119 access on all operations based on the uid and gid of the user.  The
 120 tickets are renewed as long as is permitted by the KDC's policy.
 121 .Pp
 122 The
 123 .Nm
 124 daemon can also keep a SYSTEM credential that server processes can
 125 use to access services.  One example of usage might be an nss_ldap
 126 module that quickly needs to get credentials and doesn't want to renew
 127 the ticket itself.
 128 .Pp
 129 Supported options:
 130 .Bl -tag -width Ds
 131 .It Fl -cache-name= Ns Ar cachename
 132 system cache name
 133 .It Fl c Ar file , Fl -config-file= Ns Ar file
 134 location of config file
 135 .It Fl g Ar group , Fl -group= Ns Ar group
 136 system cache group
 137 .It Fl -max-request= Ns Ar size
 138 max size for a kcm-request
 139 .It Fl -disallow-getting-krbtgt
 140 disallow extracting any krbtgt from the
 141 .Nm kcm
 142 daemon.
 143 .It Fl -detach
 144 detach from console
 145 .It Fl h , Fl -help
 146 .It Fl k Ar principal , Fl -system-principal= Ns Ar principal
 147 system principal name
 148 .It Fl l Ar time , Fl -lifetime= Ns Ar time
 149 lifetime of system tickets
 150 .It Fl m Ar mode , Fl -mode= Ns Ar mode
 151 octal mode of system cache
 152 .It Fl n , Fl -no-name-constraints
 153 disable credentials cache name constraints
 154 .It Fl r Ar time , Fl -renewable-life= Ns Ar time
 155 renewable lifetime of system tickets
 156 .It Fl s Ar path , Fl -socket-path= Ns Ar path
 157 path to kcm domain socket
 158 .It Fl -door-path= Ns Ar path
 159 path to kcm door socket
 160 .It Fl S Ar principal , Fl -server= Ns Ar principal
 161 server to get system ticket for
 162 .It Fl t Ar keytab , Fl -keytab= Ns Ar keytab
 163 system keytab name
 164 .It Fl u Ar user , Fl -user= Ns Ar user
 165 system cache owner
 166 .It Fl v , Fl -version
 167 .El
 168 .\".Sh ENVIRONMENT
 169 .\".Sh FILES
 170 .\".Sh EXAMPLES
 171 .\".Sh DIAGNOSTICS
 172 .\".Sh SEE ALSO
 173 .\".Sh STANDARDS
 174 .\".Sh HISTORY
 175 .\".Sh AUTHORS
 176 .\".Sh BUGS