original/man2/setreuid.2

   1 .\" Copyright (c) 1983, 1991 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by the University of
  16 .\"     California, Berkeley and its contributors.
  17 .\" 4. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\" %%%LICENSE_END
  33 .\"
  34 .\"     @(#)setregid.2  6.4 (Berkeley) 3/10/91
  35 .\"
  36 .\" Modified Sat Jul 24 09:08:49 1993 by Rik Faith <faith@cs.unc.edu>
  37 .\" Portions extracted from linux/kernel/sys.c:
  38 .\"             Copyright (C) 1991, 1992  Linus Torvalds
  39 .\"             May be distributed under the GNU General Public License
  40 .\" Changes: 1994-07-29 by Wilf <G.Wilford@ee.surrey.ac.uk>
  41 .\"          1994-08-02 by Wilf due to change in kernel.
  42 .\"          2004-07-04 by aeb
  43 .\"          2004-05-27 by Michael Kerrisk
  44 .\"
  45 .TH SETREUID 2 2010-11-22 "Linux" "Linux Programmer's Manual"
  46 .SH NAME
  47 setreuid, setregid \- set real and/or effective user or group ID
  48 .SH SYNOPSIS
  49 .B #include <sys/types.h>
  50 .br
  51 .B #include <unistd.h>
  52 .sp
  53 .BI "int setreuid(uid_t " ruid ", uid_t " euid );
  54 .br
  55 .BI "int setregid(gid_t " rgid ", gid_t " egid );
  56 .sp
  57 .in -4n
  58 Feature Test Macro Requirements for glibc (see
  59 .BR feature_test_macros (7)):
  60 .in
  61 .sp
  62 .BR setreuid (),
  63 .BR setregid ():
  64 .RS 4
  65 .ad l
  66 _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  67 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
  68 .ad
  69 .RE
  70 .SH DESCRIPTION
  71 .BR setreuid ()
  72 sets real and effective user IDs of the calling process.
  73
  74 Supplying a value of \-1 for either the real or effective user ID forces
  75 the system to leave that ID unchanged.
  76
  77 Unprivileged processes may only set the effective user ID to the real user ID,
  78 the effective user ID, or the saved set-user-ID.
  79
  80 Unprivileged users may only set the real user ID to
  81 the real user ID or the effective user ID.
  82
  83 If the real user ID is set or the effective user ID is set to a value
  84 not equal to the previous real user ID,
  85 the saved set-user-ID will be set to the new effective user ID.
  86
  87 Completely analogously,
  88 .BR setregid ()
  89 sets real and effective group ID's of the calling process,
  90 and all of the above holds with "group" instead of "user".
  91 .SH RETURN VALUE
  92 On success, zero is returned.
  93 On error, \-1 is returned, and
  94 .I errno
  95 is set appropriately.
  96 .SH ERRORS
  97 .TP
  98 .B EPERM
  99 The calling process is not privileged
 100 (Linux: does not have the
 101 .B CAP_SETUID
 102 capability in the case of
 103 .BR setreuid (),
 104 or the
 105 .B CAP_SETGID
 106 capability in the case of
 107 .BR setregid ())
 108 and a change other than (i)
 109 swapping the effective user (group) ID with the real user (group) ID,
 110 or (ii) setting one to the value of the other or (iii) setting the
 111 effective user (group) ID to the value of the
 112 saved set-user-ID (saved set-group-ID) was specified.
 113 .SH CONFORMING TO
 114 POSIX.1-2001, 4.3BSD (the
 115 .BR setreuid ()
 116 and
 117 .BR setregid ()
 118 function calls first appeared in 4.2BSD).
 119 .SH NOTES
 120 Setting the effective user (group) ID to the
 121 saved set-user-ID (saved set-group-ID) is
 122 possible since Linux 1.1.37 (1.1.38).
 123
 124 POSIX.1 does not specify all of possible ID changes that are permitted
 125 on Linux for an unprivileged process.
 126 For
 127 .BR setreuid (),
 128 the effective user ID can be made the same as the
 129 real user ID or the save set-user-ID,
 130 and it is unspecified whether unprivileged processes may set the
 131 real user ID to the real user ID, the effective user ID, or the
 132 saved set-user-ID.
 133 For
 134 .BR setregid (),
 135 the real group ID can be changed to the value of the saved set-group-ID,
 136 and the effective group ID can be changed to the value of
 137 the real group ID or the saved set-group-ID.
 138 The precise details of what ID changes are permitted vary
 139 across implementations.
 140
 141 POSIX.1 makes no specification about the effect of these calls
 142 on the saved set-user-ID and saved set-group-ID.
 143
 144 The original Linux
 145 .BR setreuid ()
 146 and
 147 .BR setregid ()
 148 system calls supported only 16-bit user and group IDs.
 149 Subsequently, Linux 2.4 added
 150 .BR setreuid32 ()
 151 and
 152 .BR setregid32 (),
 153 supporting 32-bit IDs.
 154 The glibc
 155 .BR setreuid ()
 156 and
 157 .BR setregid ()
 158 wrapper functions transparently deal with the variations across kernel versions.
 159 .SH SEE ALSO
 160 .BR getgid (2),
 161 .BR getuid (2),
 162 .BR seteuid (2),
 163 .BR setgid (2),
 164 .BR setresuid (2),
 165 .BR setuid (2),
 166 .BR capabilities (7)