xref: /freebsd/lib/libpam/modules/pam_rhosts/pam_rhosts.8 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
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_RHOSTS 8
37.Os
38.Sh NAME
39.Nm pam_rhosts
40.Nd Rhosts PAM module
41.Sh SYNOPSIS
42.Op Ar service-name
43.Ar module-type
44.Ar control-flag
45.Pa pam_rhosts
46.Op Ar options
47.Sh DESCRIPTION
48The rhosts 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 Rhosts Authentication Module
58The Rhosts authentication component
59.Pq Fn pam_sm_authenticate ,
60returns success if and only if the target user's UID is not 0 and the
61remote host and user are listed in
62.Pa /etc/hosts.equiv
63or in the target user's
64.Pa ~/.rhosts .
65.Pp
66The following options may be passed to the authentication module:
67.Bl -tag -width ".Cm allow_root"
68.It Cm debug
69.Xr syslog 3
70debugging information at
71.Dv LOG_DEBUG
72level.
73.It Cm no_warn
74suppress warning messages to the user.
75These messages include reasons why the user's authentication attempt
76was declined.
77.It Cm allow_root
78do not automatically fail if the target user's UID is 0.
79.El
80.Sh SEE ALSO
81.Xr hosts.equiv 5 ,
82.Xr pam.conf 5 ,
83.Xr pam 3
84.Sh AUTHORS
85The
86.Nm
87module and this manual page were developed for the
88.Fx
89Project by
90ThinkSec AS and NAI Labs, the Security Research Division of Network
91Associates, Inc.\& under DARPA/SPAWAR contract N66001-01-C-8035
92.Pq Dq CBOSS ,
93as part of the DARPA CHATS research program.
94