man2/setfsgid.2

   1 .\" Copyright (C) 1995, Thomas K. Dyas <tdyas@eden.rutgers.edu>
   2 .\" and Copyright (C) 2019, Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .\" Created   1995-08-06 Thomas K. Dyas <tdyas@eden.rutgers.edu>
  27 .\" Modified  2000-07-01 aeb
  28 .\" Modified  2002-07-23 aeb
  29 .\" Modified, 27 May 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  30 .\"     Added notes on capability requirements
  31 .\"
  32 .TH SETFSGID 2 2021-03-22 "Linux" "Linux Programmer's Manual"
  33 .SH NAME
  34 setfsgid \- set group identity used for filesystem checks
  35 .SH SYNOPSIS
  36 .nf
  37 .B #include <sys/fsuid.h>
  38 .PP
  39 .BI "int setfsgid(gid_t " fsgid );
  40 .fi
  41 .SH DESCRIPTION
  42 On Linux, a process has both a filesystem group ID and an effective group ID.
  43 The (Linux-specific) filesystem group ID is used
  44 for permissions checking when accessing filesystem objects,
  45 while the effective group ID is used for some other kinds
  46 of permissions checks (see
  47 .BR credentials (7)).
  48 .PP
  49 Normally, the value of the process's filesystem group ID
  50 is the same as the value of its effective group ID.
  51 This is so, because whenever a process's effective group ID is changed,
  52 the kernel also changes the filesystem group ID to be the same as
  53 the new value of the effective group ID.
  54 A process can cause the value of its filesystem group ID to diverge
  55 from its effective group ID by using
  56 .BR setfsgid ()
  57 to change its filesystem group ID to the value given in
  58 .IR fsgid .
  59 .PP
  60 .BR setfsgid ()
  61 will succeed only if the caller is the superuser or if
  62 .I fsgid
  63 matches either the caller's real group ID, effective group ID,
  64 saved set-group-ID, or current the filesystem user ID.
  65 .SH RETURN VALUE
  66 On both success and failure,
  67 this call returns the previous filesystem group ID of the caller.
  68 .SH VERSIONS
  69 This system call is present in Linux since version 1.2.
  70 .\" This system call is present since Linux 1.1.44
  71 .\" and in libc since libc 4.7.6.
  72 .SH CONFORMING TO
  73 .BR setfsgid ()
  74 is Linux-specific and should not be used in programs intended
  75 to be portable.
  76 .SH NOTES
  77 The filesystem group ID concept and the
  78 .BR setfsgid ()
  79 system call were invented for historical reasons that are
  80 no longer applicable on modern Linux kernels.
  81 See
  82 .BR setfsuid (2)
  83 for a discussion of why the use of both
  84 .BR setfsuid (2)
  85 and
  86 .BR setfsgid ()
  87 is nowadays unneeded.
  88 .PP
  89 The original Linux
  90 .BR setfsgid ()
  91 system call supported only 16-bit group IDs.
  92 Subsequently, Linux 2.4 added
  93 .BR setfsgid32 ()
  94 supporting 32-bit IDs.
  95 The glibc
  96 .BR setfsgid ()
  97 wrapper function transparently deals with the variation across kernel versions.
  98 .SS C library/kernel differences
  99 In glibc 2.15 and earlier,
 100 when the wrapper for this system call determines that the argument can't be
 101 passed to the kernel without integer truncation (because the kernel
 102 is old and does not support 32-bit group IDs),
 103 it will return \-1 and set \fIerrno\fP to
 104 .B EINVAL
 105 without attempting
 106 the system call.
 107 .SH BUGS
 108 No error indications of any kind are returned to the caller,
 109 and the fact that both successful and unsuccessful calls return
 110 the same value makes it impossible to directly determine
 111 whether the call succeeded or failed.
 112 Instead, the caller must resort to looking at the return value
 113 from a further call such as
 114 .IR setfsgid(\-1)
 115 (which will always fail), in order to determine if a preceding call to
 116 .BR setfsgid ()
 117 changed the filesystem group ID.
 118 At the very
 119 least,
 120 .B EPERM
 121 should be returned when the call fails (because the caller lacks the
 122 .B CAP_SETGID
 123 capability).
 124 .SH SEE ALSO
 125 .BR kill (2),
 126 .BR setfsuid (2),
 127 .BR capabilities (7),
 128 .BR credentials (7)