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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)su.1        8.2 (Berkeley) 4/18/94
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd June 6, 2011
  32 .Dt SU 1
  33 .Os
  34 .Sh NAME
  35 .Nm su
  36 .Nd substitute user identity
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl
  40 .Op Fl flms
  41 .Op Fl c Ar class
  42 .Op Ar login Op Ar args
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 utility requests appropriate user credentials via PAM
  47 and switches to that user ID
  48 (the default user is the superuser).
  49 A shell is then executed.
  50 .Pp
  51 PAM is used to set the policy
  52 .Xr su 1
  53 will use.
  54 In particular, by default only users in the
  55 .Dq Li wheel
  56 group can switch to UID 0
  57 .Pq Dq Li root .
  58 This group requirement may be changed by modifying the
  59 .Dq Li pam_group
  60 section of
  61 .Pa /etc/pam.d/su .
  62 See
  63 .Xr pam_group 8
  64 for details on how to modify this setting.
  65 .Pp
  66 By default, the environment is unmodified with the exception of
  67 .Ev USER ,
  68 .Ev HOME ,
  69 and
  70 .Ev SHELL .
  71 .Ev HOME
  72 and
  73 .Ev SHELL
  74 are set to the target login's default values.
  75 .Ev USER
  76 is set to the target login, unless the target login has a user ID of 0,
  77 in which case it is unmodified.
  78 The invoked shell is the one belonging to the target login.
  79 This is the traditional behavior of
  80 .Nm .
  81 Resource limits and session priority applicable to the original user's
  82 login class (see
  83 .Xr login.conf 5 )
  84 are also normally retained unless the target login has a user ID of 0.
  85 .Pp
  86 The options are as follows:
  87 .Bl -tag -width Ds
  88 .It Fl f
  89 If the invoked shell is
  90 .Xr csh 1 ,
  91 this option prevents it from reading the
  92 .Dq Pa .cshrc
  93 file.
  94 .It Fl l
  95 Simulate a full login.
  96 The environment is discarded except for
  97 .Ev HOME ,
  98 .Ev SHELL ,
  99 .Ev PATH ,
 100 .Ev TERM ,
 101 and
 102 .Ev USER .
 103 .Ev HOME
 104 and
 105 .Ev SHELL
 106 are modified as above.
 107 .Ev USER
 108 is set to the target login.
 109 .Ev PATH
 110 is set to
 111 .Dq Pa /bin:/usr/bin .
 112 .Ev TERM
 113 is imported from your current environment.
 114 Environment variables may be set or overridden from the login class
 115 capabilities database according to the class of the target login.
 116 The invoked shell is the target login's, and
 117 .Nm
 118 will change directory to the target login's home directory.
 119 Resource limits and session priority are modified to that for the
 120 target account's login class.
 121 .It Fl
 122 (no letter) The same as
 123 .Fl l .
 124 .It Fl m
 125 Leave the environment unmodified.
 126 The invoked shell is your login shell, and no directory changes are made.
 127 As a security precaution, if the target user's shell is a non-standard
 128 shell (as defined by
 129 .Xr getusershell 3 )
 130 and the caller's real uid is
 131 non-zero,
 132 .Nm
 133 will fail.
 134 .It Fl s
 135 Set the MAC label to the user's default label as part of the user
 136 credential setup.
 137 Setting the MAC label may fail if the MAC label of the invoking process
 138 is not sufficient to transition to the user's default MAC label.
 139 If the label cannot be set,
 140 .Nm
 141 will fail.
 142 .It Fl c Ar class
 143 Use the settings of the specified login class.
 144 Only allowed for the super-user.
 145 .El
 146 .Pp
 147 The
 148 .Fl l
 149 (or
 150 .Fl )
 151 and
 152 .Fl m
 153 options are mutually exclusive; the last one specified
 154 overrides any previous ones.
 155 .Pp
 156 If the optional
 157 .Ar args
 158 are provided on the command line, they are passed to the login shell of
 159 the target login.
 160 Note that all command line arguments before the target login name are
 161 processed by
 162 .Nm
 163 itself, everything after the target login name gets passed to the login
 164 shell.
 165 .Pp
 166 By default (unless the prompt is reset by a startup file) the super-user
 167 prompt is set to
 168 .Dq Sy \&#
 169 to remind one of its awesome power.
 170 .Sh ENVIRONMENT
 171 Environment variables used by
 172 .Nm :
 173 .Bl -tag -width HOME
 174 .It Ev HOME
 175 Default home directory of real user ID unless modified as
 176 specified above.
 177 .It Ev PATH
 178 Default search path of real user ID unless modified as specified above.
 179 .It Ev TERM
 180 Provides terminal type which may be retained for the substituted
 181 user ID.
 182 .It Ev USER
 183 The user ID is always the effective ID (the target user ID) after an
 184 .Nm
 185 unless the user ID is 0 (root).
 186 .El
 187 .Sh FILES
 188 .Bl -tag -width ".Pa /etc/pam.d/su" -compact
 189 .It Pa /etc/pam.d/su
 190 PAM configuration for
 191 .Nm .
 192 .El
 193 .Sh EXAMPLES
 194 .Bl -tag -width 5n -compact
 195 .It Li "su -m man -c catman"
 196 Starts a shell as user
 197 .Li man ,
 198 and runs the command
 199 .Li catman .
 200 You will be asked for man's password unless your real UID is 0.
 201 Note that the
 202 .Fl m
 203 option is required since user
 204 .Dq man
 205 does not have a valid shell by default.
 206 In this example,
 207 .Fl c
 208 is passed to the shell of the user
 209 .Dq man ,
 210 and is not interpreted as an argument to
 211 .Nm .
 212 .It Li "su -m man -c 'catman /usr/share/man /usr/local/man'"
 213 Same as above, but the target command consists of more than a
 214 single word and hence is quoted for use with the
 215 .Fl c
 216 option being passed to the shell.
 217 (Most shells expect the argument to
 218 .Fl c
 219 to be a single word).
 220 .It Li "su -m -c staff man -c 'catman /usr/share/man /usr/local/man'"
 221 Same as above, but the target command is run with the resource limits of
 222 the login class
 223 .Dq staff .
 224 Note: in this example, the first
 225 .Fl c
 226 option applies to
 227 .Nm
 228 while the second is an argument to the shell being invoked.
 229 .It Li "su -l foo"
 230 Simulate a login for user foo.
 231 .It Li "su - foo"
 232 Same as above.
 233 .It Li "su -"
 234 Simulate a login for root.
 235 .El
 236 .Sh SEE ALSO
 237 .Xr csh 1 ,
 238 .Xr sh 1 ,
 239 .Xr group 5 ,
 240 .Xr login.conf 5 ,
 241 .Xr passwd 5 ,
 242 .Xr environ 7 ,
 243 .Xr pam_group 8
 244 .Sh HISTORY
 245 A
 246 .Nm
 247 command appeared in
 248 .At v1 .