original/man2/setresuid.2

   1 .\" Copyright (C) 1997 Andries Brouwer (aeb@cwi.nl)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" Modified, 2003-05-26, Michael Kerrisk, <mtk.manpages@gmail.com>
  26 .TH SETRESUID 2 2014-09-21 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 setresuid, setresgid \- set real, effective and saved user or group ID
  29 .SH SYNOPSIS
  30 .BR "#define _GNU_SOURCE" "         /* See feature_test_macros(7) */"
  31 .br
  32 .B #include <unistd.h>
  33 .sp
  34 .BI "int setresuid(uid_t " ruid ", uid_t " euid ", uid_t " suid );
  35 .br
  36 .BI "int setresgid(gid_t " rgid ", gid_t " egid ", gid_t " sgid );
  37 .SH DESCRIPTION
  38 .BR setresuid ()
  39 sets the real user ID, the effective user ID, and the
  40 saved set-user-ID of the calling process.
  41
  42 Unprivileged user processes
  43 may change the real UID,
  44 effective UID, and saved set-user-ID, each to one of:
  45 the current real UID, the current effective UID or the
  46 current saved set-user-ID.
  47
  48 Privileged processes (on Linux, those having the \fBCAP_SETUID\fP capability)
  49 may set the real UID, effective UID, and
  50 saved set-user-ID to arbitrary values.
  51
  52 If one of the arguments equals \-1, the corresponding value is not changed.
  53
  54 Regardless of what changes are made to the real UID, effective UID,
  55 and saved set-user-ID, the filesystem UID is always set to the same
  56 value as the (possibly new) effective UID.
  57
  58 Completely analogously,
  59 .BR setresgid ()
  60 sets the real GID, effective GID, and saved set-group-ID
  61 of the calling process (and always modifies the filesystem GID
  62 to be the same as the effective GID),
  63 with the same restrictions for unprivileged processes.
  64 .SH RETURN VALUE
  65 On success, zero is returned.
  66 On error, \-1 is returned, and
  67 .I errno
  68 is set appropriately.
  69
  70 .IR Note :
  71 there are cases where
  72 .BR setresuid ()
  73 can fail even when the caller is UID 0;
  74 it is a grave security error to omit checking for a failure return from
  75 .BR setresuid ().
  76 .SH ERRORS
  77 .TP
  78 .B EAGAIN
  79 The call would change the caller's real UID (i.e.,
  80 .I ruid
  81 does not match the caller's real UID),
  82 but there was a temporary failure allocating the
  83 necessary kernel data structures.
  84 .TP
  85 .B EAGAIN
  86 .I ruid
  87 does not match the caller's real UID and this call would
  88 bring the number of processes belonging to the real user ID
  89 .I ruid
  90 over the caller's
  91 .B RLIMIT_NPROC
  92 resource limit.
  93 Since Linux 3.1, this error case no longer occurs
  94 (but robust applications should check for this error);
  95 see the description of
  96 .B EAGAIN
  97 in
  98 .BR execve (2).
  99 .TP
 100 .B EINVAL
 101 One or more of the target user or group IDs
 102 is not valid in this user namespace.
 103 .TP
 104 .B EPERM
 105 The calling process is not privileged (did not have the \fBCAP_SETUID\fP
 106 capability) and tried to change the IDs to values that are not permitted.
 107 .SH VERSIONS
 108 These calls are available under Linux since Linux 2.1.44.
 109 .SH CONFORMING TO
 110 These calls are nonstandard;
 111 they also appear on HP-UX and some of the BSDs.
 112 .SH NOTES
 113 Under HP-UX and FreeBSD, the prototype is found in
 114 .IR <unistd.h> .
 115 Under Linux, the prototype is provided by glibc since version 2.3.2.
 116
 117 The original Linux
 118 .BR setresuid ()
 119 and
 120 .BR setresgid ()
 121 system calls supported only 16-bit user and group IDs.
 122 Subsequently, Linux 2.4 added
 123 .BR setresuid32 ()
 124 and
 125 .BR setresgid32 (),
 126 supporting 32-bit IDs.
 127 The glibc
 128 .BR setresuid ()
 129 and
 130 .BR setresgid ()
 131 wrapper functions transparently deal with the variations across kernel versions.
 132 .SH SEE ALSO
 133 .BR getresuid (2),
 134 .BR getuid (2),
 135 .BR setfsgid (2),
 136 .BR setfsuid (2),
 137 .BR setreuid (2),
 138 .BR setuid (2),
 139 .BR capabilities (7),
 140 .BR credentials (7),
 141 .BR user_namespaces (7)
 142 .SH COLOPHON
 143 This page is part of release 3.79 of the Linux
 144 .I man-pages
 145 project.
 146 A description of the project,
 147 information about reporting bugs,
 148 and the latest version of this page,
 149 can be found at
 150 \%http://www.kernel.org/doc/man\-pages/.