man-pages/man2/setfsuid.2.html
2021-03-31 01:06:50 +01:00

209 lines
6.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of SETFSUID</TITLE>
</HEAD><BODY>
<H1>SETFSUID</H1>
Section: Linux Programmer's Manual (2)<BR>Updated: 2019-05-09<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
setfsuid - set user identity used for filesystem checks
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>#include &lt;<A HREF="file:///usr/include/sys/fsuid.h">sys/fsuid.h</A>&gt;</B>
<P>
<B>int setfsuid(uid_t </B><I>fsuid</I><B>);</B>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
On Linux, a process has both a filesystem user ID and an effective user ID.
The (Linux-specific) filesystem user ID is used
for permissions checking when accessing filesystem objects,
while the effective user ID is used for various other kinds
of permissions checks (see
<B><A HREF="/cgi-bin/man/man2html?7+credentials">credentials</A></B>(7)).
<P>
Normally, the value of the process's filesystem user ID
is the same as the value of its effective user ID.
This is so, because whenever a process's effective user ID is changed,
the kernel also changes the filesystem user ID to be the same as
the new value of the effective user ID.
A process can cause the value of its filesystem user ID to diverge
from its effective user ID by using
<B>setfsuid</B>()
to change its filesystem user ID to the value given in
<I>fsuid</I>.
<P>
Explicit calls to
<B>setfsuid</B>()
and
<B><A HREF="/cgi-bin/man/man2html?2+setfsgid">setfsgid</A></B>(2)
are (were) usually used only by programs such as the Linux NFS server that
need to change what user and group ID is used for file access without a
corresponding change in the real and effective user and group IDs.
A change in the normal user IDs for a program such as the NFS server
is (was) a security hole that can expose it to unwanted signals.
(However, this issue is historical; see below.)
<P>
<B>setfsuid</B>()
will succeed only if the caller is the superuser or if
<I>fsuid</I>
matches either the caller's real user ID, effective user ID,
saved set-user-ID, or current filesystem user ID.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
On both success and failure,
this call returns the previous filesystem user ID of the caller.
<A NAME="lbAF">&nbsp;</A>
<H2>VERSIONS</H2>
This system call is present in Linux since version 1.2.
<A NAME="lbAG">&nbsp;</A>
<H2>CONFORMING TO</H2>
<B>setfsuid</B>()
is Linux-specific and should not be used in programs intended
to be portable.
<A NAME="lbAH">&nbsp;</A>
<H2>NOTES</H2>
At the time when this system call was introduced, one process
could send a signal to another process with the same effective user ID.
This meant that if a privileged process changed its effective user ID
for the purpose of file permission checking,
then it could become vulnerable to receiving signals
sent by another (unprivileged) process with the same user ID.
The filesystem user ID attribute was thus added to allow a process to
change its user ID for the purposes of file permission checking without
at the same time becoming vulnerable to receiving unwanted signals.
Since Linux 2.0, signal permission handling is different (see
<B><A HREF="/cgi-bin/man/man2html?2+kill">kill</A></B>(2)),
with the result that a process can change its effective user ID
without being vulnerable to receiving signals from unwanted processes.
Thus,
<B>setfsuid</B>()
is nowadays unneeded and should be avoided in new applications
(likewise for
<B><A HREF="/cgi-bin/man/man2html?2+setfsgid">setfsgid</A></B>(2)).
<P>
The original Linux
<B>setfsuid</B>()
system call supported only 16-bit user IDs.
Subsequently, Linux 2.4 added
<B>setfsuid32</B>()
supporting 32-bit IDs.
The glibc
<B>setfsuid</B>()
wrapper function transparently deals with the variation across kernel versions.
<A NAME="lbAI">&nbsp;</A>
<H3>C library/kernel differences</H3>
In glibc 2.15 and earlier,
when the wrapper for this system call determines that the argument can't be
passed to the kernel without integer truncation (because the kernel
is old and does not support 32-bit user IDs),
it will return -1 and set <I>errno</I> to
<B>EINVAL</B>
without attempting
the system call.
<A NAME="lbAJ">&nbsp;</A>
<H2>BUGS</H2>
No error indications of any kind are returned to the caller,
and the fact that both successful and unsuccessful calls return
the same value makes it impossible to directly determine
whether the call succeeded or failed.
Instead, the caller must resort to looking at the return value
from a further call such as
<I>setfsuid(-1)</I>
(which will always fail), in order to determine if a preceding call to
<B>setfsuid</B>()
changed the filesystem user ID.
At the very
least,
<B>EPERM</B>
should be returned when the call fails (because the caller lacks the
<B>CAP_SETUID</B>
capability).
<A NAME="lbAK">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?2+kill">kill</A></B>(2),
<B><A HREF="/cgi-bin/man/man2html?2+setfsgid">setfsgid</A></B>(2),
<B><A HREF="/cgi-bin/man/man2html?7+capabilities">capabilities</A></B>(7),
<B><A HREF="/cgi-bin/man/man2html?7+credentials">credentials</A></B>(7)
<A NAME="lbAL">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="4"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="5"><A HREF="#lbAF">VERSIONS</A><DD>
<DT id="6"><A HREF="#lbAG">CONFORMING TO</A><DD>
<DT id="7"><A HREF="#lbAH">NOTES</A><DD>
<DL>
<DT id="8"><A HREF="#lbAI">C library/kernel differences</A><DD>
</DL>
<DT id="9"><A HREF="#lbAJ">BUGS</A><DD>
<DT id="10"><A HREF="#lbAK">SEE ALSO</A><DD>
<DT id="11"><A HREF="#lbAL">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:34 GMT, March 31, 2021
</BODY>
</HTML>