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