xref: /freebsd/lib/libpam/modules/pam_self/pam_self.8 (revision eacee0ff7ec955b32e09515246bd97b6edcd2b0f)
1.\" Copyright (c) 2001 Mark R V Murray
2.\" All rights reserved.
3.\" Copyright (c) 2001 Networks Associates Technologies, 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.\" $FreeBSD$
36.\"
37.Dd December 5, 2001
38.Dt PAM_SELF 8
39.Os
40.Sh NAME
41.Nm pam_self
42.Nd Self PAM module
43.Sh SYNOPSIS
44.Op Ar service-name
45.Ar module-type
46.Ar control-flag
47.Pa pam_self
48.Op Ar options
49.Sh DESCRIPTION
50The Self authentication service module for PAM,
51.Nm
52provides functionality for only one PAM category:
53authentication.
54In terms of the
55.Ar module-type
56parameter, this is the
57.Dq Li auth
58feature.
59It also provides a null function for session management.
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 non-zero, authentication will fail,
66unless the
67.Cm even_root
68option was specified.
69.Pp
70The following options may be passed to the authentication module:
71.Bl -tag -width ".Cm even_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 even_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 FreeBSD Project by
92ThinkSec AS and NAI Labs, the Security Research Division of Network
93Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
94.Pq Dq CBOSS ,
95as part of the DARPA CHATS research program.
96