112 lines
3.5 KiB
Groff
112 lines
3.5 KiB
Groff
.\"
|
|
.\" Copyright (c) 1996 Julian R Elischer
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" This code is derived from software contributed by Kenneth Stailey.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed for the FreeBSD Project
|
|
.\" by Julian R Elischer
|
|
.\" 4. The name of the author may not be used to endorse or promote products
|
|
.\" derived from this software without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
|
.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd October 15, 1996
|
|
.Dt SUSER 9
|
|
.Os
|
|
.Sh NAME
|
|
.Nm suser ,
|
|
.Nm suser_cred
|
|
.Nd check if process has superuser privilege
|
|
.Sh SYNOPSIS
|
|
.In sys/param.h
|
|
.In sys/systm.h
|
|
.Ft int
|
|
.Fn suser "struct thread *td"
|
|
.Ft int
|
|
.Fn suser_cred "struct ucred *cred" "int flag"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
and
|
|
.Nm suser_cred
|
|
functions check if the credentials given include superuser powers.
|
|
.Pp
|
|
The
|
|
.Nm
|
|
function is the most common, and should be used unless special
|
|
circumstances dictate otherwise.
|
|
.Pp
|
|
The
|
|
.Nm suser_cred
|
|
function should be used when the credentials to be checked are
|
|
not the thread's own, when there is no thread, or when superuser
|
|
powers should be extended to imprisoned roots.
|
|
.Pp
|
|
By default a process does not command superuser powers if it has
|
|
been imprisoned by the
|
|
.Xr jail 2
|
|
system call.
|
|
There are cases however where this is appropriate, and this can
|
|
be done by setting the
|
|
.Dv PRISON_ROOT
|
|
bit in the flags argument to the
|
|
.Nm suser_cred
|
|
function.
|
|
It is important to review carefully in each case that
|
|
this does not weaken the prison.
|
|
Generally only where the action is protected by the
|
|
.Xr chroot 2
|
|
implicit in
|
|
.Xr jail 2
|
|
call should such powers be granted.
|
|
.Pp
|
|
The
|
|
.Nm
|
|
and
|
|
.Nm suser_cred
|
|
functions note the fact that superuser powers have been used in the
|
|
process structure of the process specified.
|
|
Because part of their function is to notice
|
|
whether superuser powers have been used,
|
|
the functions should only be called after other permission
|
|
possibilities have been exhausted.
|
|
.Sh RETURN VALUES
|
|
The
|
|
.Nm
|
|
and
|
|
.Nm suser_cred
|
|
functions return 0 if the user has superuser powers and
|
|
.Er EPERM
|
|
otherwise.
|
|
This is the
|
|
.Em reverse logic
|
|
of some other implementations of
|
|
.Nm
|
|
in which a TRUE response indicates superuser powers.
|
|
.Sh SEE ALSO
|
|
.Xr chroot 2 ,
|
|
.Xr jail 2
|