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