original/man2/seteuid.2

   1 .\" Copyright (C) 2001 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 .\" [should really be seteuid.3]
  26 .\" Modified, 27 May 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  27 .\"     Added notes on capability requirements
  28 .\"
  29 .TH SETEUID 2 2012-07-02 "Linux" "Linux Programmer's Manual"
  30 .SH NAME
  31 seteuid, setegid \- set effective user or group ID
  32 .SH SYNOPSIS
  33 .B #include <sys/types.h>
  34 .br
  35 .B #include <unistd.h>
  36 .sp
  37 .BI "int seteuid(uid_t " euid );
  38 .br
  39 .BI "int setegid(gid_t " egid );
  40 .sp
  41 .in -4n
  42 Feature Test Macro Requirements for glibc (see
  43 .BR feature_test_macros (7)):
  44 .in
  45 .sp
  46 .ad l
  47 .BR seteuid (),
  48 .BR setegid ():
  49 .RS 4
  50 _BSD_SOURCE || _POSIX_C_SOURCE\ >=\ 200112L || _XOPEN_SOURCE\ >=\ 600
  51 .RE
  52 .ad
  53 .SH DESCRIPTION
  54 .BR seteuid ()
  55 sets the effective user ID of the calling process.
  56 Unprivileged user processes may only set the effective user ID to the
  57 real user ID, the effective user ID or the saved set-user-ID.
  58
  59 Precisely the same holds for
  60 .BR setegid ()
  61 with "group" instead of "user".
  62 .\" When
  63 .\" .I euid
  64 .\" equals \-1, nothing is changed.
  65 .\" (This is an artifact of the implementation in glibc of seteuid()
  66 .\" using setresuid(2).)
  67 .SH RETURN VALUE
  68 On success, zero is returned.
  69 On error, \-1 is returned, and
  70 .I errno
  71 is set appropriately.
  72 .SH ERRORS
  73 .\" .TP
  74 .\" .B EINVAL
  75 .TP
  76 .B EPERM
  77 The calling process is not privileged (Linux: does not have the
  78 .B CAP_SETUID
  79 capability in the case of
  80 .BR seteuid (),
  81 or the
  82 .B CAP_SETGID
  83 capability in the case of
  84 .BR setegid ())
  85 and
  86 .I euid
  87 (respectively,
  88 .IR egid )
  89 is not the real user (group) ID, the effective user (group) ID,
  90 or the saved set-user-ID (saved set-group-ID).
  91 .SH CONFORMING TO
  92 4.3BSD, POSIX.1-2001.
  93 .SH NOTES
  94 Setting the effective user (group) ID to the
  95 saved set-user-ID (saved set-group-ID) is
  96 possible since Linux 1.1.37 (1.1.38).
  97 On an arbitrary system one should check
  98 .BR _POSIX_SAVED_IDS .
  99 .LP
 100 Under libc4, libc5 and glibc 2.0
 101 .BI seteuid( euid )
 102 is equivalent to
 103 .BI setreuid(\-1, " euid" )
 104 and hence may change the saved set-user-ID.
 105 Under glibc 2.1 and later it is equivalent to
 106 .BI setresuid(\-1, " euid" ", \-1)"
 107 and hence does not change the saved set-user-ID.
 108 Analogous remarks hold for
 109 .BR setegid (),
 110 with the difference that the change in implementation from
 111 .BI setregid(\-1, " egid" )
 112 to
 113 .BI setresgid(\-1, " egid" ", \-1)"
 114 occurred in glibc 2.2 or 2.3 (depending on the hardware architecture).
 115
 116 According to POSIX.1,
 117 .BR seteuid ()
 118 .RB ( setegid ())
 119 need not permit
 120 .I euid
 121 .RI ( egid )
 122 to be the same value as the current effective user (group) ID,
 123 and some implementations do not permit this.
 124 .SH SEE ALSO
 125 .BR geteuid (2),
 126 .BR setresuid (2),
 127 .BR setreuid (2),
 128 .BR setuid (2),
 129 .BR capabilities (7),
 130 .BR credentials (7)
 131 .SH COLOPHON
 132 This page is part of release 3.64 of the Linux
 133 .I man-pages
 134 project.
 135 A description of the project,
 136 and information about reporting bugs,
 137 can be found at
 138 \%http://www.kernel.org/doc/man\-pages/.