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