original/man2/setfsuid.2

   1 .\" Copyright (C) 1995, Thomas K. Dyas <tdyas@eden.rutgers.edu>
   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 .\" Created   1995-08-06 Thomas K. Dyas <tdyas@eden.rutgers.edu>
  26 .\" Modified  2000-07-01 aeb
  27 .\" Modified  2002-07-23 aeb
  28 .\" Modified, 27 May 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  29 .\"     Added notes on capability requirements
  30 .\"
  31 .TH SETFSUID 2 2013-08-08 "Linux" "Linux Programmer's Manual"
  32 .SH NAME
  33 setfsuid \- set user identity used for filesystem checks
  34 .SH SYNOPSIS
  35 .B #include <sys/fsuid.h>
  36 .sp
  37 .BI "int setfsuid(uid_t " fsuid );
  38 .SH DESCRIPTION
  39 The system call
  40 .BR setfsuid ()
  41 changes the value of the caller's filesystem user ID\(emthe
  42 user ID that the Linux kernel uses to check for all accesses
  43 to the filesystem.
  44 Normally, the value of
  45 the filesystem user ID
  46 will shadow the value of the effective user ID.
  47 In fact, whenever the
  48 effective user ID is changed,
  49 the filesystem user ID
  50 will also be changed to the new value of the effective user ID.
  51
  52 Explicit calls to
  53 .BR setfsuid ()
  54 and
  55 .BR setfsgid (2)
  56 are usually used only by programs such as the Linux NFS server that
  57 need to change what user and group ID is used for file access without a
  58 corresponding change in the real and effective user and group IDs.
  59 A change in the normal user IDs for a program such as the NFS server
  60 is a security hole that can expose it to unwanted signals.
  61 (But see below.)
  62
  63 .BR setfsuid ()
  64 will succeed only if the caller is the superuser or if
  65 .I fsuid
  66 matches either the caller's real user ID, effective user ID,
  67 saved set-user-ID, or current filesystem user ID.
  68 .SH RETURN VALUE
  69 On both success and failure,
  70 this call returns the previous filesystem user ID of the caller.
  71 .SH VERSIONS
  72 This system call is present in Linux since version 1.2.
  73 .\" This system call is present since Linux 1.1.44
  74 .\" and in libc since libc 4.7.6.
  75 .SH CONFORMING TO
  76 .BR setfsuid ()
  77 is Linux-specific and should not be used in programs intended
  78 to be portable.
  79 .SH NOTES
  80 When glibc determines that the argument is not a valid user ID,
  81 it will return \-1 and set \fIerrno\fP to
  82 .B EINVAL
  83 without attempting
  84 the system call.
  85 .LP
  86 At the time when this system call was introduced, one process
  87 could send a signal to another process with the same effective user ID.
  88 This meant that if a privileged process changed its effective user ID
  89 for the purpose of file permission checking,
  90 then it could become vulnerable to receiving signals
  91 sent by another (unprivileged) process with the same user ID.
  92 The filesystem user ID attribute was thus added to allow a process to
  93 change its user ID for the purposes of file permission checking without
  94 at the same time becoming vulnerable to receiving unwanted signals.
  95 Since Linux 2.0, signal permission handling is different (see
  96 .BR kill (2)),
  97 with the result that a process change can change its effective user ID
  98 without being vulnerable to receiving signals from unwanted processes.
  99 Thus,
 100 .BR setfsuid ()
 101 is nowadays unneeded and should be avoided in new applications
 102 (likewise for
 103 .BR setfsgid (2)).
 104
 105 The original Linux
 106 .BR setfsuid ()
 107 system call supported only 16-bit user IDs.
 108 Subsequently, Linux 2.4 added
 109 .BR setfsuid32 ()
 110 supporting 32-bit IDs.
 111 The glibc
 112 .BR setfsuid ()
 113 wrapper function transparently deals with the variation across kernel versions.
 114 .SH BUGS
 115 No error indications of any kind are returned to the caller,
 116 and the fact that both successful and unsuccessful calls return
 117 the same value makes it impossible to directly determine
 118 whether the call succeeded or failed.
 119 Instead, the caller must resort to looking at the return value
 120 from a further call such as
 121 .IR setfsuid(\-1)
 122 (which will always fail), in order to determine if a preceding call to
 123 .BR setfsuid ()
 124 changed the filesystem user ID.
 125 At the very
 126 least,
 127 .B EPERM
 128 should be returned when the call fails (because the caller lacks the
 129 .B CAP_SETUID
 130 capability).
 131 .SH SEE ALSO
 132 .BR kill (2),
 133 .BR setfsgid (2),
 134 .BR capabilities (7),
 135 .BR credentials (7)
 136 .SH COLOPHON
 137 This page is part of release 3.79 of the Linux
 138 .I man-pages
 139 project.
 140 A description of the project,
 141 information about reporting bugs,
 142 and the latest version of this page,
 143 can be found at
 144 \%http://www.kernel.org/doc/man\-pages/.