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