8dd9e14a3a9ae839d9eeb603baab18b7fe5f2911
[dragonfly.git] / lib / libpam / modules / pam_self / pam_self.8
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 .\" $FreeBSD: src/lib/libpam/modules/pam_self/pam_self.8,v 1.11 2004/07/02 23:52:18 ru Exp $
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
50 The Self authentication service module for PAM,
51 .Nm
52 provides functionality for only one PAM category:
53 authentication.
54 In terms of the
55 .Ar module-type
56 parameter, this is the
57 .Dq Li auth
58 feature.
59 .Ss Self Authentication Module
60 The Self authentication component
61 .Pq Fn pam_sm_authenticate ,
62 returns success if and only if the target user's user ID is identical
63 with the current real user ID.
64 If the current real user ID is zero, authentication will fail,
65 unless the
66 .Cm allow_root
67 option was specified.
68 .Pp
69 The following options may be passed to the authentication module:
70 .Bl -tag -width ".Cm allow_root"
71 .It Cm debug
72 .Xr syslog 3
73 debugging information at
74 .Dv LOG_DEBUG
75 level.
76 .It Cm no_warn
77 suppress warning messages to the user.
78 These messages include reasons why the user's authentication attempt
79 was declined.
80 .It Cm allow_root
81 do not automatically fail if the current real user ID is 0.
82 .El
83 .Sh SEE ALSO
84 .Xr getuid 2 ,
85 .Xr pam.conf 5 ,
86 .Xr pam 8
87 .Sh AUTHORS
88 The
89 .Nm
90 module and this manual page were developed for the
91 .Fx
92 Project by
93 ThinkSec AS and NAI Labs, the Security Research Division of Network
94 Associates, Inc.\& under DARPA/SPAWAR contract N66001-01-C-8035
95 .Pq Dq CBOSS ,
96 as part of the DARPA CHATS research program.