original/man2/setuid.2

   1 .\" Copyright (C), 1994, Graeme W. Wilford (Wilf).
   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 .\" Fri Jul 29th 12:56:44 BST 1994  Wilf. <G.Wilford@ee.surrey.ac.uk>
  26 .\" Changes inspired by patch from Richard Kettlewell
  27 .\"   <richard@greenend.org.uk>, aeb 970616.
  28 .\" Modified, 27 May 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  29 .\"     Added notes on capability requirements
  30 .TH SETUID 2 2010-11-22 "Linux" "Linux Programmer's Manual"
  31 .SH NAME
  32 setuid \- set user identity
  33 .SH SYNOPSIS
  34 .B #include <sys/types.h>
  35 .br
  36 .B #include <unistd.h>
  37 .sp
  38 .BI "int setuid(uid_t " uid );
  39 .SH DESCRIPTION
  40 .BR setuid ()
  41 sets the effective user ID of the calling process.
  42 If the effective UID of the caller is root,
  43 the real UID and saved set-user-ID are also set.
  44 .PP
  45 Under Linux,
  46 .BR setuid ()
  47 is implemented like the POSIX version with the
  48 .B _POSIX_SAVED_IDS
  49 feature.
  50 This allows a set-user-ID (other than root) program to drop all of its user
  51 privileges, do some un-privileged work, and then reengage the original
  52 effective user ID in a secure manner.
  53 .PP
  54 If the user is root or the program is set-user-ID-root, special care must be
  55 taken.
  56 The
  57 .BR setuid ()
  58 function checks the effective user ID of the caller and if it is
  59 the superuser, all process-related user ID's are set to
  60 .IR uid .
  61 After this has occurred, it is impossible for the program to regain root
  62 privileges.
  63 .PP
  64 Thus, a set-user-ID-root program wishing to temporarily drop root
  65 privileges, assume the identity of an unprivileged user, and then regain
  66 root privileges afterward cannot use
  67 .BR setuid ().
  68 You can accomplish this with
  69 .BR seteuid (2).
  70 .SH RETURN VALUE
  71 On success, zero is returned.
  72 On error, \-1 is returned, and
  73 .I errno
  74 is set appropriately.
  75 .SH ERRORS
  76 .TP
  77 .B EAGAIN
  78 The
  79 .I uid
  80 does not match the current uid and
  81 .I uid
  82 brings process over its
  83 .B RLIMIT_NPROC
  84 resource limit.
  85 .TP
  86 .B EPERM
  87 The user is not privileged (Linux: does not have the
  88 .B CAP_SETUID
  89 capability) and
  90 .I uid
  91 does not match the real UID or saved set-user-ID of the calling process.
  92 .SH CONFORMING TO
  93 SVr4, POSIX.1-2001.
  94 Not quite compatible with the 4.4BSD call, which
  95 sets all of the real, saved, and effective user IDs.
  96 .\" SVr4 documents an additional EINVAL error condition.
  97 .SH NOTES
  98 Linux has the concept of the filesystem user ID, normally equal to the
  99 effective user ID.
 100 The
 101 .BR setuid ()
 102 call also sets the filesystem user ID of the calling process.
 103 See
 104 .BR setfsuid (2).
 105 .PP
 106 If
 107 .I uid
 108 is different from the old effective UID, the process will
 109 be forbidden from leaving core dumps.
 110
 111 The original Linux
 112 .BR setuid ()
 113 system call supported only 16-bit user IDs.
 114 Subsequently, Linux 2.4 added
 115 .BR setuid32 ()
 116 supporting 32-bit IDs.
 117 The glibc
 118 .BR setuid ()
 119 wrapper function transparently deals with the variation across kernel versions.
 120 .SH SEE ALSO
 121 .BR getuid (2),
 122 .BR seteuid (2),
 123 .BR setfsuid (2),
 124 .BR setreuid (2),
 125 .BR capabilities (7),
 126 .BR credentials (7)
 127 .SH COLOPHON
 128 This page is part of release 3.67 of the Linux
 129 .I man-pages
 130 project.
 131 A description of the project,
 132 information about reporting bugs,
 133 and the latest version of this page,
 134 can be found at
 135 \%http://www.kernel.org/doc/man\-pages/.