xref: /386bsd/usr/src/lib/libc/gen/setuid.3 (revision a2142627)
1.\" Copyright (c) 1983, 1991 Regents of the University of California.
2.\" 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.\"     @(#)setuid.3	6.4 (Berkeley) 4/19/91
33.\"
34.Dd April 19, 1991
35.Dt SETUID 3
36.Os BSD 4.2
37.Sh NAME
38.Nm setuid ,
39.Nm seteuid ,
40.Nm setruid ,
41.Nm setgid ,
42.Nm setegid ,
43.Nm setrgid
44.Nd set user and group ID
45.Sh SYNOPSIS
46.Fd #include <sys/types.h>
47.Ft int
48.Fn setuid "uid_t uid"
49.Ft int
50.Fn seteuid "uid_t euid"
51.Ft int
52.Fn setruid "uid_t ruid"
53.Ft int
54.Fn setgid "gid_t gid"
55.Ft int
56.Fn setegid "gid_t egid"
57.Ft int
58.Fn setrgid "gid_t rgid"
59.Sh DESCRIPTION
60The
61.Fn setuid
62function
63.Pq Fn setgid
64sets both the real and effective
65user ID (group ID) of the current process
66as specified.
67.Pp
68The
69.Fn seteuid
70function
71.Pq Fn setegid
72sets the effective user ID (group ID) of the
73current process.
74.Pp
75The
76.Fn setruid
77function
78.Pq Fn setrgid
79sets the real user ID (group ID) of the
80current process.
81.Sh RETURN VALUES
82Upon success, these functions return 0;
83otherwise \-1 is returned.
84.Pp
85If the user is not the super user, or the uid
86specified is not the real or effective ID, these
87functions return \-1.
88.Sh SEE ALSO
89.Xr setreuid 2 ,
90.Xr setregid 2 ,
91.Xr getuid 2 ,
92.Xr getgid 2
93.Sh HISTORY
94A
95.Fn setuid
96and
97.Fn setgid
98syscall appeared in
99.At v6 .
100