xref: /freebsd/lib/libpam/modules/pam_securetty/pam_securetty.8 (revision 08ecaa10b26796016ee009d7bb5cb9ece21f4107)
1.\" Copyright (c) 2001 Mark R V Murray
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd July 8, 2001
28.Dt PAM_SECURETTY 8
29.Os
30.Sh NAME
31.Nm pam_securetty
32.Nd SecureTTY PAM module
33.Sh SYNOPSIS
34.Op Ar service-name
35.Ar module-type
36.Ar control-flag
37.Pa pam_securetty
38.Op Ar options
39.Sh DESCRIPTION
40The SecureTTY authentication service module for PAM,
41.Nm
42provides functionality for only one PAM category:
43authentication.
44In terms of the
45.Ar module-type
46parameter, this is the
47.Dq Li auth
48feature.
49It also provides a null function for session management.
50.Ss SecureTTY Authentication Module
51The SecureTTY authentication component
52.Pq Fn pam_sm_authenticate ,
53returns success if the user is attempting to authenticate as superuser,
54and the process is attached to a secure TTY.
55Alternatively,
56if the user is not authenticating as superuser,
57the module always returns success.
58.Pp
59A TTY is defined as secure if its entry is fetchable from
60.Pa /etc/ttys
61by
62.Xr getttynam 3
63(see
64.Xr ttys 5 ) ,
65and the entry (a
66.Vt "struct ttyent" )
67has the
68.Dv TTY_SECURE
69flag set.
70.Pp
71The following options may be passed to the authentication module:
72.Bl -tag -xwidth ".Cm debug"
73.It Cm debug
74.Xr syslog 3
75debugging information at
76.Dv LOG_DEBUG
77level.
78.El
79.Sh SEE ALSO
80.Xr getttynam 3 ,
81.Xr syslog 3 ,
82.Xr pam.conf 5 ,
83.Xr ttys 5 ,
84.Xr pam 8
85