xref: /freebsd/lib/libpam/modules/pam_self/pam_self.8 (revision 4f8f43b06ed07e96a250855488cc531799d5b78f)
1.\" Copyright (c) 2001 Mark R V Murray
2.\" All rights reserved.
3.\" Copyright (c) 2001 Networks Associates Technology, Inc.
4.\" All rights reserved.
5.\"
6.\" Portions of this software were developed for the FreeBSD Project by
7.\" ThinkSec AS and NAI Labs, the Security Research Division of Network
8.\" Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
9.\" ("CBOSS"), as part of the DARPA CHATS research program.
10.\"
11.\" Redistribution and use in source and binary forms, with or without
12.\" modification, are permitted provided that the following conditions
13.\" are met:
14.\" 1. Redistributions of source code must retain the above copyright
15.\"    notice, this list of conditions and the following disclaimer.
16.\" 2. Redistributions in binary form must reproduce the above copyright
17.\"    notice, this list of conditions and the following disclaimer in the
18.\"    documentation and/or other materials provided with the distribution.
19.\" 3. The name of the author may not be used to endorse or promote
20.\"    products derived from this software without specific prior written
21.\"    permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, 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
33.\" SUCH DAMAGE.
34.\"
35.Dd December 5, 2001
36.Dt PAM_SELF 8
37.Os
38.Sh NAME
39.Nm pam_self
40.Nd Self PAM module
41.Sh SYNOPSIS
42.Op Ar service-name
43.Ar module-type
44.Ar control-flag
45.Pa pam_self
46.Op Ar options
47.Sh DESCRIPTION
48The Self authentication service module for PAM,
49.Nm
50provides functionality for only one PAM category:
51authentication.
52In terms of the
53.Ar module-type
54parameter, this is the
55.Dq Li auth
56feature.
57.Ss Self Authentication Module
58The Self authentication component
59.Pq Fn pam_sm_authenticate ,
60returns success if and only if the target user's user ID is identical
61with the current real user ID.
62If the current real user ID is zero, authentication will fail,
63unless the
64.Cm allow_root
65option was specified.
66.Pp
67The following options may be passed to the authentication module:
68.Bl -tag -width ".Cm allow_root"
69.It Cm debug
70.Xr syslog 3
71debugging information at
72.Dv LOG_DEBUG
73level.
74.It Cm no_warn
75suppress warning messages to the user.
76These messages include reasons why the user's authentication attempt
77was declined.
78.It Cm allow_root
79do not automatically fail if the current real user ID is 0.
80.El
81.Sh SEE ALSO
82.Xr getuid 2 ,
83.Xr pam.conf 5 ,
84.Xr pam 3
85.Sh AUTHORS
86The
87.Nm
88module and this manual page were developed for the
89.Fx
90Project by
91ThinkSec AS and NAI Labs, the Security Research Division of Network
92Associates, Inc.\& under DARPA/SPAWAR contract N66001-01-C-8035
93.Pq Dq CBOSS ,
94as part of the DARPA CHATS research program.
95