xref: /netbsd-src/share/man/man9/secmodel_suser.9 (revision 6cb10275d08f045e872662c371fe2f2724f2f6e6)
1.\" $NetBSD: secmodel_suser.9,v 1.7 2014/03/18 18:20:40 riastradh Exp $
2.\"
3.\" Copyright (c) 2009 Elad Efrat <elad@NetBSD.org>
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. The name of the author may not be used to endorse or promote products
15.\"    derived from this software without specific prior written permission.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27.\"
28.Dd December 4, 2011
29.Dt SECMODEL_SUSER 9
30.Os
31.Sh NAME
32.Nm secmodel_suser
33.Nd super-user security model
34.Sh DESCRIPTION
35.Nm
36implements the traditional
37.Em super-user
38(root) as the user with effective user-id 0.
39The
40.Em super-user
41is the host administrator, considered to have higher privileges than other
42users.
43.Sh FUNCTIONS
44.Nm
45exposes a
46.Xr secmodel_eval 9
47evaluation routine
48to test whether a set of credentials can be assimilated to
49.Em super-user
50credentials or not.
51.Pp
52The parameters to
53.Xr secmodel_eval 9
54are:
55.Bl -tag -compact -width xxxxx
56.It id
57the unique identifier of
58.Nm :
59.Qo Dv org.netbsd.secmodel.suser Qc
60.It what
61a string,
62.Qo Dv is-root Qc .
63.It arg
64the
65.Xr kauth 9
66credentials
67.Po Fa kauth_cred_t Pc
68of the caller.
69.It ret
70a boolean, set by
71.Nm
72to
73.Dv true
74when the credentials are equivalent to
75.Em super-user ,
76.Dv false
77otherwise.
78.El
79.Sh RETURN TYPES
80If successful, the evaluation returns 0 with the
81.Fa ret
82argument being either
83.Dv true
84or
85.Dv false .
86.Sh SEE ALSO
87.Xr kauth 9 ,
88.Xr secmodel 9 ,
89.Xr secmodel_bsd44 9 ,
90.Xr secmodel_eval 9
91.Sh AUTHORS
92.An Elad Efrat Aq Mt elad@NetBSD.org
93