xref: /freebsd/lib/libpam/modules/pam_rootok/pam_rootok.8 (revision ebacd8013fe5f7fdf9f6a5b286f6680dd2891036)
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.\" $FreeBSD$
26.\"
27.Dd July 8, 2001
28.Dt PAM_ROOTOK 8
29.Os
30.Sh NAME
31.Nm pam_rootok
32.Nd RootOK PAM module
33.Sh SYNOPSIS
34.Op Ar service-name
35.Ar module-type
36.Ar control-flag
37.Pa pam_rootok
38.Op Ar options
39.Sh DESCRIPTION
40The RootOK authentication service module for PAM,
41.Nm
42provides functionality for only one PAM category:
43authentication.
44In terms of the
45.Ar module-type
46parameter, this is the
47.Dq Li auth
48feature.
49It also provides a null function for session management.
50.Ss RootOK Authentication Module
51The RootOK authentication component
52.Pq Fn pam_sm_authenticate ,
53always returns success for the superuser;
54i.e.,
55if
56.Xr getuid 2
57returns 0.
58.Pp
59The following options may be passed to the authentication module:
60.Bl -tag -width ".Cm no_warn"
61.It Cm debug
62.Xr syslog 3
63debugging information at
64.Dv LOG_DEBUG
65level.
66.It Cm no_warn
67suppress warning messages to the user.
68These messages include
69reasons why the user's
70authentication attempt was declined.
71.El
72.Sh SEE ALSO
73.Xr getuid 2 ,
74.Xr pam.conf 5 ,
75.Xr pam 3
76