xref: /freebsd/lib/libc/compat-43/setruid.3 (revision afe61c15161c324a7af299a9b8457aba5afc92db)
1.\" Copyright (c) 1983, 1991, 1993
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.\"     @(#)setruid.3	8.1 (Berkeley) 6/2/93
33.\"
34.Dd June 2, 1993
35.Dt SETRUID 3
36.Os BSD 4.2
37.Sh NAME
38.Nm setruid ,
39.Nm setrgid
40.Nd set user and group ID
41.Sh SYNOPSIS
42.Fd #include <sys/types.h>
43.Ft int
44.Fn setruid "uid_t ruid"
45.Ft int
46.Fn setrgid "gid_t rgid"
47.Sh DESCRIPTION
48The
49.Fn setruid
50function
51.Pq Fn setrgid
52sets the real user ID (group ID) of the
53current process.
54.Sh RETURN VALUES
55Upon success, these functions return 0;
56otherwise \-1 is returned.
57.Pp
58If the user is not the super user, or the uid
59specified is not the real or effective ID, these
60functions return \-1.
61.Pp
62The use of these calls is not portable.
63Their use is discouraged; they will be removed in the future.
64.Sh SEE ALSO
65.Xr setuid 2 ,
66.Xr setgid 2 ,
67.Xr seteuid 2 ,
68.Xr setegid 2 ,
69.Xr getuid 2 ,
70.Xr getgid 2
71.Sh HISTORY
72The
73.Fn setruid
74and
75.Fn setrgid
76syscalls appeared in
77.Bx 4.2
78and were dropped in
79.Bx 4.4 .
80