usr.bin/su/su.1

   1 .\" Copyright (c) 1988, 1990, 1993, 1994
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University 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 REGENTS 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 REGENTS 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 .\"     @(#)su.1        8.2 (Berkeley) 4/18/94
  33 .\" $FreeBSD: src/usr.bin/su/su.1,v 1.17.2.6 2002/06/21 15:29:18 charnier Exp $
  34 .\" $DragonFly: src/usr.bin/su/su.1,v 1.3 2004/05/21 05:27:12 cpressey Exp $
  35 .\"
  36 .Dd April 18, 1994
  37 .Dt SU 1
  38 .Os
  39 .Sh NAME
  40 .Nm su
  41 .Nd substitute user identity
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl
  45 .Op Fl Kflm
  46 .Op Fl c Ar class
  47 .Op Ar login Op Ar args
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 utility requests the Kerberos password for
  52 .Ar login
  53 (or for
  54 .Dq Ar login Ns .root ,
  55 if no login is provided), and switches to
  56 that user and group ID after obtaining a Kerberos ticket granting ticket.
  57 A shell is then executed.
  58 The
  59 .Nm
  60 utility will resort to the local password file to find the password for
  61 .Ar login
  62 if there is a Kerberos error.
  63 If
  64 .Nm
  65 is executed by root, no password is requested and a shell
  66 with the appropriate user ID is executed; no additional Kerberos tickets
  67 are obtained.
  68 .Pp
  69 By default, the environment is unmodified with the exception of
  70 .Ev USER ,
  71 .Ev HOME ,
  72 and
  73 .Ev SHELL .
  74 .Ev HOME
  75 and
  76 .Ev SHELL
  77 are set to the target login's default values.
  78 .Ev USER
  79 is set to the target login, unless the target login has a user ID of 0,
  80 in which case it is unmodified.
  81 The invoked shell is the target login's.
  82 This is the traditional behavior of
  83 .Nm .
  84 Resource limits and session priority applicable to the original user's
  85 login class (See
  86 .Xr login.conf 5 )
  87 are also normally retained unless the target login has a user ID of 0.
  88 .Pp
  89 The options are as follows:
  90 .Bl -tag -width Ds
  91 .It Fl K
  92 Do not attempt to use Kerberos to authenticate the user.
  93 .It Fl f
  94 If the invoked shell is
  95 .Xr csh 1 ,
  96 this option prevents it from reading the
  97 .Dq Pa .cshrc
  98 file.
  99 .It Fl l
 100 Simulate a full login.
 101 The environment is discarded except for
 102 .Ev HOME ,
 103 .Ev SHELL ,
 104 .Ev PATH ,
 105 .Ev TERM ,
 106 and
 107 .Ev USER .
 108 .Ev HOME
 109 and
 110 .Ev SHELL
 111 are modified as above.
 112 .Ev USER
 113 is set to the target login.
 114 .Ev PATH
 115 is set to
 116 .Dq Pa /bin:/usr/bin .
 117 .Ev TERM
 118 is imported from your current environment.
 119 Environment variables may be set or overridden from the login class
 120 capabilities database according to the class of the target login.
 121 The invoked shell is the target login's, and
 122 .Nm
 123 will change directory to the target login's home directory.
 124 Resource limits and session priority are modified to that for the
 125 target account's login class.
 126 .It Fl
 127 (no letter) The same as
 128 .Fl l .
 129 .It Fl m
 130 Leave the environment unmodified.
 131 The invoked shell is your login shell, and no directory changes are made.
 132 As a security precaution, if the target user's shell is a non-standard
 133 shell (as defined by
 134 .Xr getusershell 3 )
 135 and the caller's real uid is
 136 non-zero,
 137 .Nm
 138 will fail.
 139 .It Fl c Ar class
 140 Use the settings of the specified login class.
 141 Only allowed for the super-user.
 142 .El
 143 .Pp
 144 The
 145 .Fl l
 146 (or
 147 .Fl )
 148 and
 149 .Fl m
 150 options are mutually exclusive; the last one specified
 151 overrides any previous ones.
 152 .Pp
 153 If the optional
 154 .Ar args
 155 are provided on the command line, they are passed to the login shell of
 156 the target login.
 157 .Pp
 158 Only users who are a member of group 0 (normally
 159 .Dq wheel )
 160 can
 161 .Nm
 162 to
 163 .Dq root .
 164 \ If group 0 is missing or empty, any user can
 165 .Nm
 166 to
 167 .Dq root .
 168 .Pp
 169 By default (unless the prompt is reset by a startup file) the super-user
 170 prompt is set to
 171 .Dq Sy \&#
 172 to remind one of its awesome power.
 173 .Sh FILES
 174 .Bl -tag -width /etc/auth.conf -compact
 175 .It Pa /etc/auth.conf
 176 configure authentication services
 177 .El
 178 .Sh SEE ALSO
 179 .Xr csh 1 ,
 180 .Xr kerberos 1 ,
 181 .Xr kinit 1 ,
 182 .Xr login 1 ,
 183 .Xr sh 1 ,
 184 .Xr group 5 ,
 185 .Xr login.conf 5 ,
 186 .Xr passwd 5 ,
 187 .Xr environ 7 ,
 188 .Xr nologin 8
 189 .Sh ENVIRONMENT
 190 Environment variables used by
 191 .Nm :
 192 .Bl -tag -width HOME
 193 .It Ev HOME
 194 Default home directory of real user ID unless modified as
 195 specified above.
 196 .It Ev PATH
 197 Default search path of real user ID unless modified as specified above.
 198 .It Ev TERM
 199 Provides terminal type which may be retained for the substituted
 200 user ID.
 201 .It Ev USER
 202 The user ID is always the effective ID (the target user ID) after an
 203 .Nm
 204 unless the user ID is 0 (root).
 205 .El
 206 .Sh EXAMPLES
 207 .Bl -tag -width 5n -compact
 208 .It Li "su man -c catman"
 209 Runs the command
 210 .Li catman
 211 as user
 212 .Li man ,
 213 assuming man's shell supports the
 214 .Fl c
 215 option.
 216 You will be asked for man's password unless your real UID is 0.
 217 .It Li "su -m man -c catman"
 218 Same as above, but use the shell and environment of the current
 219 user instead of those of man.
 220 This allows commands to be executed as user man even when man's shell is
 221 .Xr nologin 8 .
 222 .It Li "su -mf man -c catman"
 223 Same as above, but do not re-evaluate the current user's
 224 .Pa .cshrc
 225 either.
 226 .It Li "su -mf man -c 'catman /usr/share/man /usr/local/man /usr/X11R6/man'"
 227 Same as above, but the target command consists of more than a
 228 single word and hence is quoted for use with the
 229 .Fl c
 230 option being passed to the shell.  (Most shells expect the argument to
 231 .Fl c
 232 to be a single word).
 233 .It Li "su -mf -c staff man -c 'catman /usr/share/man /usr/local/man /usr/X11R6/man'"
 234 Same as above, but the target command is run with the resource limits of
 235 the login class
 236 .Dq staff .
 237 Note: in this example, the first
 238 .Fl c
 239 option applies to
 240 .Nm
 241 while the second is an argument to the shell being invoked.
 242 .It Li "su -l foo"
 243 Simulate a login for user foo.
 244 .It Li "su - foo"
 245 Same as above.
 246 .It Li "su -  "
 247 Simulate a login for root.
 248 .El
 249 .Sh HISTORY
 250 A
 251 .Nm
 252 command appeared in
 253 .At v1 .