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$
  34 .\"
  35 .Dd September 28, 2003
  36 .Dt SU 1
  37 .Os
  38 .Sh NAME
  39 .Nm su
  40 .Nd substitute user identity
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl
  44 .Op Fl flms
  45 .Op Fl c Ar class
  46 .Op Ar login Op Ar args
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility requests appropriate user credentials via PAM
  51 and switches to that user ID
  52 (the default user is the superuser).
  53 A shell is then executed.
  54 .Pp
  55 PAM is used to set all policy.
  56 .Pp
  57 By default, the environment is unmodified with the exception of
  58 .Ev USER ,
  59 .Ev HOME ,
  60 and
  61 .Ev SHELL .
  62 .Ev HOME
  63 and
  64 .Ev SHELL
  65 are set to the target login's default values.
  66 .Ev USER
  67 is set to the target login, unless the target login has a user ID of 0,
  68 in which case it is unmodified.
  69 The invoked shell is the one belonging to the target login.
  70 This is the traditional behavior of
  71 .Nm .
  72 Resource limits and session priority applicable to the original user's
  73 login class (see
  74 .Xr login.conf 5 )
  75 are also normally retained unless the target login has a user ID of 0.
  76 .Pp
  77 The options are as follows:
  78 .Bl -tag -width Ds
  79 .It Fl f
  80 If the invoked shell is
  81 .Xr csh 1 ,
  82 this option prevents it from reading the
  83 .Dq Pa .cshrc
  84 file.
  85 .It Fl l
  86 Simulate a full login.
  87 The environment is discarded except for
  88 .Ev HOME ,
  89 .Ev SHELL ,
  90 .Ev PATH ,
  91 .Ev TERM ,
  92 and
  93 .Ev USER .
  94 .Ev HOME
  95 and
  96 .Ev SHELL
  97 are modified as above.
  98 .Ev USER
  99 is set to the target login.
 100 .Ev PATH
 101 is set to
 102 .Dq Pa /bin:/usr/bin .
 103 .Ev TERM
 104 is imported from your current environment.
 105 Environment variables may be set or overridden from the login class
 106 capabilities database according to the class of the target login.
 107 The invoked shell is the target login's, and
 108 .Nm
 109 will change directory to the target login's home directory.
 110 Resource limits and session priority are modified to that for the
 111 target account's login class.
 112 .It Fl
 113 (no letter) The same as
 114 .Fl l .
 115 .It Fl m
 116 Leave the environment unmodified.
 117 The invoked shell is your login shell, and no directory changes are made.
 118 As a security precaution, if the target user's shell is a non-standard
 119 shell (as defined by
 120 .Xr getusershell 3 )
 121 and the caller's real uid is
 122 non-zero,
 123 .Nm
 124 will fail.
 125 .It Fl s
 126 Set the MAC label to the user's default label as part of the user
 127 credential setup.
 128 Setting the MAC label may fail if the MAC label of the invoking process
 129 is not sufficient to transition to the user's default MAC label.
 130 If the label cannot be set,
 131 .Nm
 132 will fail.
 133 .It Fl c Ar class
 134 Use the settings of the specified login class.
 135 Only allowed for the super-user.
 136 .El
 137 .Pp
 138 The
 139 .Fl l
 140 (or
 141 .Fl )
 142 and
 143 .Fl m
 144 options are mutually exclusive; the last one specified
 145 overrides any previous ones.
 146 .Pp
 147 If the optional
 148 .Ar args
 149 are provided on the command line, they are passed to the login shell of
 150 the target login.
 151 Note that all command line arguments before the target login name are
 152 processed by
 153 .Nm
 154 itself, everything after the target login name gets passed to the login
 155 shell.
 156 .Pp
 157 By default (unless the prompt is reset by a startup file) the super-user
 158 prompt is set to
 159 .Dq Sy \&#
 160 to remind one of its awesome power.
 161 .Sh FILES
 162 .Bl -tag -width /etc/pam.conf -compact
 163 .It Pa /etc/pam.conf
 164 .Nm
 165 is configured with PAM support; it uses
 166 .Pa /etc/pam.conf
 167 entries with service name
 168 .Dq su
 169 .El
 170 .Sh SEE ALSO
 171 .Xr csh 1 ,
 172 .Xr sh 1 ,
 173 .Xr group 5 ,
 174 .Xr login.conf 5 ,
 175 .Xr passwd 5 ,
 176 .Xr environ 7 ,
 177 .Xr pam 8
 178 .Sh ENVIRONMENT
 179 Environment variables used by
 180 .Nm :
 181 .Bl -tag -width HOME
 182 .It Ev HOME
 183 Default home directory of real user ID unless modified as
 184 specified above.
 185 .It Ev PATH
 186 Default search path of real user ID unless modified as specified above.
 187 .It Ev TERM
 188 Provides terminal type which may be retained for the substituted
 189 user ID.
 190 .It Ev USER
 191 The user ID is always the effective ID (the target user ID) after an
 192 .Nm
 193 unless the user ID is 0 (root).
 194 .El
 195 .Sh EXAMPLES
 196 .Bl -tag -width 5n -compact
 197 .It Li "su man -c catman"
 198 Runs the command
 199 .Li catman
 200 as user
 201 .Li man .
 202 You will be asked for man's password unless your real UID is 0.
 203 .It Li "su man -c 'catman /usr/share/man /usr/local/man /usr/X11R6/man'"
 204 Same as above, but the target command consists of more than a
 205 single word and hence is quoted for use with the
 206 .Fl c
 207 option being passed to the shell.
 208 (Most shells expect the argument to
 209 .Fl c
 210 to be a single word).
 211 .It Li "su -c staff man -c 'catman /usr/share/man /usr/local/man /usr/X11R6/man'"
 212 Same as above, but the target command is run with the resource limits of
 213 the login class
 214 .Dq staff .
 215 Note: in this example, the first
 216 .Fl c
 217 option applies to
 218 .Nm
 219 while the second is an argument to the shell being invoked.
 220 .It Li "su -l foo"
 221 Simulate a login for user foo.
 222 .It Li "su - foo"
 223 Same as above.
 224 .It Li "su -"
 225 Simulate a login for root.
 226 .El
 227 .Sh HISTORY
 228 A
 229 .Nm
 230 command appeared in
 231 .At v1 .