xref: /freebsd/lib/libpam/modules/pam_rootok/pam_rootok.8 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1.\" Copyright (c) 2001 Mark R V Murray
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.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd July 8, 2001
26.Dt PAM_ROOTOK 8
27.Os
28.Sh NAME
29.Nm pam_rootok
30.Nd RootOK PAM module
31.Sh SYNOPSIS
32.Op Ar service-name
33.Ar module-type
34.Ar control-flag
35.Pa pam_rootok
36.Op Ar options
37.Sh DESCRIPTION
38The RootOK authentication service module for PAM,
39.Nm
40provides functionality for only one PAM category:
41authentication.
42In terms of the
43.Ar module-type
44parameter, this is the
45.Dq Li auth
46feature.
47It also provides a null function for session management.
48.Ss RootOK Authentication Module
49The RootOK authentication component
50.Pq Fn pam_sm_authenticate ,
51always returns success for the superuser;
52i.e.,
53if
54.Xr getuid 2
55returns 0.
56.Pp
57The following options may be passed to the authentication module:
58.Bl -tag -width ".Cm no_warn"
59.It Cm debug
60.Xr syslog 3
61debugging information at
62.Dv LOG_DEBUG
63level.
64.It Cm no_warn
65suppress warning messages to the user.
66These messages include
67reasons why the user's
68authentication attempt was declined.
69.El
70.Sh SEE ALSO
71.Xr getuid 2 ,
72.Xr pam.conf 5 ,
73.Xr pam 3
74