2 .\" Copyright (c) 2004 Hiten Pandya <hmp@dragonflybsd.org>
3 .\" Copyright (c) 1996 Julian R Elischer
4 .\" All rights reserved.
6 .\" This code is derived from software contributed by Kenneth Stailey.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in the
15 .\" documentation and/or other materials provided with the distribution.
16 .\" 3. All advertising materials mentioning features or use of this software
17 .\" must display the following acknowledgement:
18 .\" This product includes software developed for the FreeBSD Project
19 .\" by Julian R Elischer
20 .\" 4. The name of the author may not be used to endorse or promote products
21 .\" derived from this software without specific prior written permission.
23 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .\" $FreeBSD: src/share/man/man9/suser.9,v 1.9.2.5 2001/12/17 11:30:19 ru Exp $
36 .\" $DragonFly: src/share/man/man9/suser.9,v 1.3 2004/05/10 13:00:37 hmp Exp $
45 .Nd check for credentials for superuser privilege
51 .Fn suser "struct thread *td"
53 .Fn suser_cred "struct ucred *cred" "int flags"
55 .Fn suser_proc "struct proc *p"
59 family of functions check if the credentials given include superuser privilege.
63 function is the most common, and should be used unless special
64 circumstances dictate otherwise.
65 The credential check is only necessary if the thread
67 is attached to a process.
71 function should be used when the credentials to be checked are
72 not the process' own, when there is no process or when superuser
73 privilege should be extended to imprisoned roots.
77 function is used when the credentials to be checked are of a
80 By default a process does not command superuser privilege if it has
81 been imprisoned by the
84 There are cases however where this is appropriate and can be done by
87 bit in the flags argument to the
90 It is important to review carefully in each case that
91 this does not weaken the prison.
92 Generally only where the action is protected by the
96 call should such privilege be granted.
103 functions note the fact that superuser powers have been used in the
104 process structure of the process specified.
105 Because part of their function is to notice
106 whether superuser privilege have been used,
107 the functions should only be called after other permission
108 possibilities have been exhausted.
117 if the user has superuser privilege and
122 of some other implementations of
124 in which a TRUE response indicates superuser powers.