xref: /freebsd/lib/libpam/modules/pam_securetty/pam_securetty.8 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1.\" Copyright (c) 2001 Mark R V Murray
2.\" All rights reserved.
3.\" Copyright (c) 2002 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 July 8, 2001
36.Dt PAM_SECURETTY 8
37.Os
38.Sh NAME
39.Nm pam_securetty
40.Nd SecureTTY PAM module
41.Sh SYNOPSIS
42.Op Ar service-name
43.Ar module-type
44.Ar control-flag
45.Pa pam_securetty
46.Op Ar options
47.Sh DESCRIPTION
48The SecureTTY service module for PAM,
49.Nm
50provides functionality for only one PAM category:
51account management.
52In terms of the
53.Ar module-type
54parameter, this is the
55.Dq Li account
56feature.
57It also provides null functions for authentication and session
58management.
59.Ss SecureTTY Account Management Module
60The SecureTTY account management component
61.Pq Fn pam_sm_acct_mgmt ,
62returns failure if the user is attempting to authenticate as superuser,
63and the process is attached to an insecure TTY.
64In all other cases, the module returns success.
65.Pp
66A TTY is considered secure if it is listed in
67.Pa /etc/ttys
68and has the
69.Dv TTY_SECURE
70flag set.
71.Pp
72The following options may be passed to the authentication module:
73.Bl -tag -width ".Cm no_warn"
74.It Cm debug
75.Xr syslog 3
76debugging information at
77.Dv LOG_DEBUG
78level.
79.It Cm no_warn
80suppress warning messages to the user.
81These messages include
82reasons why the user's
83authentication attempt was declined.
84.El
85.Sh SEE ALSO
86.Xr getttynam 3 ,
87.Xr syslog 3 ,
88.Xr pam.conf 5 ,
89.Xr ttys 5 ,
90.Xr pam 3
91