xref: /freebsd/lib/libpam/modules/pam_tacplus/pam_tacplus.8 (revision 7ef62cebc2f965b0f640263e179276928885e33d)
1.\" Copyright (c) 1999
2.\"	Andrzej Bialecki <abial@FreeBSD.org>.  All rights reserved.
3.\"
4.\" Copyright (c) 1992, 1993, 1994
5.\"	The Regents of the University of California.  All rights reserved.
6.\" All rights reserved.
7.\"
8.\" This code is derived from software donated to Berkeley by
9.\" Jan-Simon Pendry.
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. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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 May 17, 2023
38.Dt PAM_TACPLUS 8
39.Os
40.Sh NAME
41.Nm pam_tacplus
42.Nd TACACS+ authentication PAM module
43.Sh SYNOPSIS
44.Op Ar service-name
45.Ar module-type
46.Ar control-flag
47.Pa pam_tacplus
48.Op Ar options
49.Sh DESCRIPTION
50The
51.Nm
52module provides authentication services based
53upon the TACACS+ protocol
54for the PAM (Pluggable Authentication Module) framework.
55.Pp
56The
57.Nm
58module accepts these optional parameters:
59.Bl -tag -width ".Cm use_first_pass"
60.It Cm use_first_pass
61causes
62.Nm
63to use a previously entered password instead of prompting for a new one.
64If no password has been entered then authentication fails.
65.It Cm try_first_pass
66causes
67.Nm
68to use a previously entered password, if one is available.
69If no
70password has been entered,
71.Nm
72prompts for one as usual.
73.It Cm echo_pass
74causes echoing to be left on if
75.Nm
76prompts for a password.
77.It Cm conf Ns = Ns Ar pathname
78specifies a non-standard location for the TACACS+ client configuration file
79(normally located in
80.Pa /etc/tacplus.conf ) .
81.It Cm template_user Ns = Ns Ar username
82specifies a user whose
83.Xr passwd 5
84entry will be used as a template to create the session environment
85if the supplied username does not exist in local password database.
86The user
87will be authenticated with the supplied username and password, but his
88credentials to the system will be presented as the ones for
89.Ar username ,
90i.e., his login class, home directory, resource limits, etc.\& will be set to ones
91defined for
92.Ar username .
93.Pp
94If this option is omitted, and there is no username
95in the system databases equal to the supplied one (as determined by call to
96.Xr getpwnam 3 ) ,
97the authentication will fail.
98.El
99.Sh FILES
100.Bl -tag -width /etc/tacplus.conf -compact
101.It Pa /etc/tacplus.conf
102The standard TACACS+ client configuration file for
103.Nm
104.El
105.Sh SEE ALSO
106.Xr pam 3 ,
107.Xr passwd 5 ,
108.Xr tacplus.conf 5 ,
109.Xr nss_tacplus 8
110.Sh HISTORY
111The
112.Nm
113module first appeared in
114.Fx 3.1 .
115.Sh AUTHORS
116.An -nosplit
117The
118.Nm
119manual page was written by
120.An Andrzej Bialecki Aq Mt abial@FreeBSD.org
121and adapted to TACACS+ from RADIUS by
122.An Mark R V Murray Aq Mt markm@FreeBSD.org .
123.Pp
124The
125.Nm
126module was written by
127.An John D. Polstra Aq Mt jdp@FreeBSD.org .
128