xref: /dflybsd-src/lib/libpam/modules/pam_self/pam_self.8 (revision c98db40744766ab0803912f29557df02814bcd9d)
1242be47eSzrj.\" Copyright (c) 2001 Mark R V Murray
2242be47eSzrj.\" All rights reserved.
3242be47eSzrj.\" Copyright (c) 2001 Networks Associates Technology, Inc.
4242be47eSzrj.\" All rights reserved.
5242be47eSzrj.\"
6242be47eSzrj.\" Portions of this software were developed for the FreeBSD Project by
7242be47eSzrj.\" ThinkSec AS and NAI Labs, the Security Research Division of Network
8242be47eSzrj.\" Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
9242be47eSzrj.\" ("CBOSS"), as part of the DARPA CHATS research program.
10242be47eSzrj.\"
11242be47eSzrj.\" Redistribution and use in source and binary forms, with or without
12242be47eSzrj.\" modification, are permitted provided that the following conditions
13242be47eSzrj.\" are met:
14242be47eSzrj.\" 1. Redistributions of source code must retain the above copyright
15242be47eSzrj.\"    notice, this list of conditions and the following disclaimer.
16242be47eSzrj.\" 2. Redistributions in binary form must reproduce the above copyright
17242be47eSzrj.\"    notice, this list of conditions and the following disclaimer in the
18242be47eSzrj.\"    documentation and/or other materials provided with the distribution.
19242be47eSzrj.\" 3. The name of the author may not be used to endorse or promote
20242be47eSzrj.\"    products derived from this software without specific prior written
21242be47eSzrj.\"    permission.
22242be47eSzrj.\"
23242be47eSzrj.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24242be47eSzrj.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25242be47eSzrj.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26242be47eSzrj.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27242be47eSzrj.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28242be47eSzrj.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29242be47eSzrj.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30242be47eSzrj.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31242be47eSzrj.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32242be47eSzrj.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33242be47eSzrj.\" SUCH DAMAGE.
34242be47eSzrj.\"
35*c98db407SSascha Wildner.\" $FreeBSD: head/lib/libpam/modules/pam_self/pam_self.8 131504 2004-07-02 23:52:20Z ru $
36242be47eSzrj.\"
37242be47eSzrj.Dd December 5, 2001
38242be47eSzrj.Dt PAM_SELF 8
39242be47eSzrj.Os
40242be47eSzrj.Sh NAME
41242be47eSzrj.Nm pam_self
42242be47eSzrj.Nd Self PAM module
43242be47eSzrj.Sh SYNOPSIS
44242be47eSzrj.Op Ar service-name
45242be47eSzrj.Ar module-type
46242be47eSzrj.Ar control-flag
47242be47eSzrj.Pa pam_self
48242be47eSzrj.Op Ar options
49242be47eSzrj.Sh DESCRIPTION
50242be47eSzrjThe Self authentication service module for PAM,
51242be47eSzrj.Nm
52242be47eSzrjprovides functionality for only one PAM category:
53242be47eSzrjauthentication.
54242be47eSzrjIn terms of the
55242be47eSzrj.Ar module-type
56242be47eSzrjparameter, this is the
57242be47eSzrj.Dq Li auth
58242be47eSzrjfeature.
59242be47eSzrj.Ss Self Authentication Module
60242be47eSzrjThe Self authentication component
61242be47eSzrj.Pq Fn pam_sm_authenticate ,
62242be47eSzrjreturns success if and only if the target user's user ID is identical
63242be47eSzrjwith the current real user ID.
64242be47eSzrjIf the current real user ID is zero, authentication will fail,
65242be47eSzrjunless the
66242be47eSzrj.Cm allow_root
67242be47eSzrjoption was specified.
68242be47eSzrj.Pp
69242be47eSzrjThe following options may be passed to the authentication module:
70242be47eSzrj.Bl -tag -width ".Cm allow_root"
71242be47eSzrj.It Cm debug
72242be47eSzrj.Xr syslog 3
73242be47eSzrjdebugging information at
74242be47eSzrj.Dv LOG_DEBUG
75242be47eSzrjlevel.
76242be47eSzrj.It Cm no_warn
77242be47eSzrjsuppress warning messages to the user.
78242be47eSzrjThese messages include reasons why the user's authentication attempt
79242be47eSzrjwas declined.
80242be47eSzrj.It Cm allow_root
81242be47eSzrjdo not automatically fail if the current real user ID is 0.
82242be47eSzrj.El
83242be47eSzrj.Sh SEE ALSO
84242be47eSzrj.Xr getuid 2 ,
85dfc0c85aSSascha Wildner.Xr pam 3 ,
86dfc0c85aSSascha Wildner.Xr pam.conf 5
87242be47eSzrj.Sh AUTHORS
88242be47eSzrjThe
89242be47eSzrj.Nm
90242be47eSzrjmodule and this manual page were developed for the
91242be47eSzrj.Fx
92242be47eSzrjProject by
93242be47eSzrjThinkSec AS and NAI Labs, the Security Research Division of Network
94242be47eSzrjAssociates, Inc.\& under DARPA/SPAWAR contract N66001-01-C-8035
95242be47eSzrj.Pq Dq CBOSS ,
96242be47eSzrjas part of the DARPA CHATS research program.
97