man2/setuid.2

   1 .\" Copyright (C), 1994, Graeme W. Wilford (Wilf).
   2 .\" and Copyright (C) 2010, 2014, 2015, Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" SPDX-License-Identifier: Linux-man-pages-copyleft
   5 .\"
   6 .\" Fri Jul 29th 12:56:44 BST 1994  Wilf. <G.Wilford@ee.surrey.ac.uk>
   7 .\" Changes inspired by patch from Richard Kettlewell
   8 .\"   <richard@greenend.org.uk>, aeb 970616.
   9 .\" Modified, 27 May 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  10 .\"     Added notes on capability requirements
  11 .TH SETUID 2 2022-09-09 "Linux man-pages (unreleased)"
  12 .SH NAME
  13 setuid \- set user identity
  14 .SH LIBRARY
  15 Standard C library
  16 .RI ( libc ", " \-lc )
  17 .SH SYNOPSIS
  18 .nf
  19 .B #include <unistd.h>
  20 .PP
  21 .BI "int setuid(uid_t " uid );
  22 .fi
  23 .SH DESCRIPTION
  24 .BR setuid ()
  25 sets the effective user ID of the calling process.
  26 If the calling process is privileged
  27 (more precisely: if the process has the
  28 .B CAP_SETUID
  29 capability in its user namespace),
  30 the real UID and saved set-user-ID are also set.
  31 .PP
  32 Under Linux,
  33 .BR setuid ()
  34 is implemented like the POSIX version with the
  35 .B _POSIX_SAVED_IDS
  36 feature.
  37 This allows a set-user-ID (other than root) program to drop all of its user
  38 privileges, do some un-privileged work, and then reengage the original
  39 effective user ID in a secure manner.
  40 .PP
  41 If the user is root or the program is set-user-ID-root, special care must be
  42 taken:
  43 .BR setuid ()
  44 checks the effective user ID of the caller and if it is
  45 the superuser, all process-related user ID's are set to
  46 .IR uid .
  47 After this has occurred, it is impossible for the program to regain root
  48 privileges.
  49 .PP
  50 Thus, a set-user-ID-root program wishing to temporarily drop root
  51 privileges, assume the identity of an unprivileged user, and then regain
  52 root privileges afterward cannot use
  53 .BR setuid ().
  54 You can accomplish this with
  55 .BR seteuid (2).
  56 .SH RETURN VALUE
  57 On success, zero is returned.
  58 On error, \-1 is returned, and
  59 .I errno
  60 is set to indicate the error.
  61 .PP
  62 .IR Note :
  63 there are cases where
  64 .BR setuid ()
  65 can fail even when the caller is UID 0;
  66 it is a grave security error to omit checking for a failure return from
  67 .BR setuid ().
  68 .SH ERRORS
  69 .TP
  70 .B EAGAIN
  71 The call would change the caller's real UID (i.e.,
  72 .I uid
  73 does not match the caller's real UID),
  74 but there was a temporary failure allocating the
  75 necessary kernel data structures.
  76 .TP
  77 .B EAGAIN
  78 .I uid
  79 does not match the real user ID of the caller and this call would
  80 bring the number of processes belonging to the real user ID
  81 .I uid
  82 over the caller's
  83 .B RLIMIT_NPROC
  84 resource limit.
  85 Since Linux 3.1, this error case no longer occurs
  86 (but robust applications should check for this error);
  87 see the description of
  88 .B EAGAIN
  89 in
  90 .BR execve (2).
  91 .TP
  92 .B EINVAL
  93 The user ID specified in
  94 .I uid
  95 is not valid in this user namespace.
  96 .TP
  97 .B EPERM
  98 The user is not privileged (Linux: does not have the
  99 .B CAP_SETUID
 100 capability in its user namespace) and
 101 .I uid
 102 does not match the real UID or saved set-user-ID of the calling process.
 103 .SH STANDARDS
 104 POSIX.1-2001, POSIX.1-2008, SVr4.
 105 Not quite compatible with the 4.4BSD call, which
 106 sets all of the real, saved, and effective user IDs.
 107 .\" SVr4 documents an additional EINVAL error condition.
 108 .SH NOTES
 109 Linux has the concept of the filesystem user ID, normally equal to the
 110 effective user ID.
 111 The
 112 .BR setuid ()
 113 call also sets the filesystem user ID of the calling process.
 114 See
 115 .BR setfsuid (2).
 116 .PP
 117 If
 118 .I uid
 119 is different from the old effective UID, the process will
 120 be forbidden from leaving core dumps.
 121 .PP
 122 The original Linux
 123 .BR setuid ()
 124 system call supported only 16-bit user IDs.
 125 Subsequently, Linux 2.4 added
 126 .BR setuid32 ()
 127 supporting 32-bit IDs.
 128 The glibc
 129 .BR setuid ()
 130 wrapper function transparently deals with the variation across kernel versions.
 131 .\"
 132 .SS C library/kernel differences
 133 At the kernel level, user IDs and group IDs are a per-thread attribute.
 134 However, POSIX requires that all threads in a process
 135 share the same credentials.
 136 The NPTL threading implementation handles the POSIX requirements by
 137 providing wrapper functions for
 138 the various system calls that change process UIDs and GIDs.
 139 These wrapper functions (including the one for
 140 .BR setuid ())
 141 employ a signal-based technique to ensure
 142 that when one thread changes credentials,
 143 all of the other threads in the process also change their credentials.
 144 For details, see
 145 .BR nptl (7).
 146 .SH SEE ALSO
 147 .BR getuid (2),
 148 .BR seteuid (2),
 149 .BR setfsuid (2),
 150 .BR setreuid (2),
 151 .BR capabilities (7),
 152 .BR credentials (7),
 153 .BR user_namespaces (7)