lib/libc/sys/setreuid.2

   1 .\" Copyright (c) 1980, 1991, 1993, 1994
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)setreuid.2  8.2 (Berkeley) 4/16/94
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd February 8, 2001
  36 .Dt SETREUID 2
  37 .Os
  38 .Sh NAME
  39 .Nm setreuid
  40 .Nd set real and effective user ID's
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In unistd.h
  45 .Ft int
  46 .Fn setreuid "uid_t ruid" "uid_t euid"
  47 .Sh DESCRIPTION
  48 The real and effective user IDs of the
  49 current process are set according to the arguments.
  50 If
  51 .Fa ruid
  52 or
  53 .Fa euid
  54 is -1, the current uid is filled in by the system.
  55 Unprivileged users may change the real user
  56 ID to the effective user ID and vice-versa; only the super-user may
  57 make other changes.
  58 .Pp
  59 If the real user ID is changed (i.e.\&
  60 .Fa ruid
  61 is not -1) or the effective user ID is changed to something other than
  62 the real user ID, then the saved user ID will be set to the effective user ID.
  63 .Pp
  64 The
  65 .Fn setreuid
  66 system call has been used to swap the real and effective user IDs
  67 in set-user-ID programs to temporarily relinquish the set-user-ID value.
  68 This purpose is now better served by the use of the
  69 .Xr seteuid 2
  70 system call.
  71 .Pp
  72 When setting the real and effective user IDs to the same value,
  73 the standard
  74 .Fn setuid
  75 system call is preferred.
  76 .Sh RETURN VALUES
  77 .Rv -std setreuid
  78 .Sh ERRORS
  79 .Bl -tag -width Er
  80 .It Bq Er EPERM
  81 The current process is not the super-user and a change
  82 other than changing the effective user-id to the real user-id
  83 was specified.
  84 .El
  85 .Sh SEE ALSO
  86 .Xr getuid 2 ,
  87 .Xr issetugid 2 ,
  88 .Xr seteuid 2 ,
  89 .Xr setuid 2
  90 .Sh HISTORY
  91 The
  92 .Fn setreuid
  93 system call appeared in
  94 .Bx 4.2 .