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