xref: /freebsd/lib/libpam/modules/pam_tacplus/pam_tacplus.8 (revision a9e8641da961bcf3d24afc85fd657f2083a872a2)
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. All advertising materials mentioning features or use of this software
20.\"    must display the following acknowledgement:
21.\"	This product includes software developed by the University of
22.\"	California, Berkeley and its contributors.
23.\" 4. Neither the name of the University nor the names of its contributors
24.\"    may be used to endorse or promote products derived from this software
25.\"    without specific prior written permission.
26.\"
27.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37.\" SUCH DAMAGE.
38.\"
39.\" $FreeBSD$
40.\"
41.Dd August 2, 1999
42.Dt PAM_TACPLUS 8
43.Os
44.Sh NAME
45.Nm pam_tacplus
46.Nd TACACS+ authentication PAM module
47.Sh SYNOPSIS
48.Op Ar service-name
49.Ar module-type
50.Ar control-flag
51.Pa pam_tacplus
52.Op Ar options
53.Sh DESCRIPTION
54The
55.Nm
56module provides authentication services based
57upon the TACACS+ protocol
58for the PAM (Pluggable Authentication Module) framework.
59.Pp
60The
61.Nm
62module accepts these optional parameters:
63.Bl -tag -width ".Cm use_first_pass"
64.It Cm use_first_pass
65causes
66.Nm
67to use a previously entered password instead of prompting for a new one.
68If no password has been entered then authentication fails.
69.It Cm try_first_pass
70causes
71.Nm
72to use a previously entered password, if one is available.
73If no
74password has been entered,
75.Nm
76prompts for one as usual.
77.It Cm echo_pass
78causes echoing to be left on if
79.Nm
80prompts for a password.
81.It Cm conf Ns = Ns Ar pathname
82specifies a non-standard location for the TACACS+ client configuration file
83(normally located in
84.Pa /etc/tacplus.conf ) .
85.It Cm template_user Ns = Ns Ar username
86specifies a user whose
87.Xr passwd 5
88entry will be used as a template to create the session environment
89if the supplied username does not exist in local password database.
90The user
91will be authenticated with the supplied username and password, but his
92credentials to the system will be presented as the ones for
93.Ar username ,
94i.e., his login class, home directory, resource limits, etc.\& will be set to ones
95defined for
96.Ar username .
97.Pp
98If this option is omitted, and there is no username
99in the system databases equal to the supplied one (as determined by call to
100.Xr getpwnam 3 ) ,
101the authentication will fail.
102.El
103.Sh FILES
104.Bl -tag -width /etc/tacplus.conf -compact
105.It Pa /etc/tacplus.conf
106The standard TACACS+ client configuration file for
107.Nm
108.El
109.Sh SEE ALSO
110.Xr passwd 5 ,
111.Xr tacplus.conf 5 ,
112.Xr pam 8
113.Sh HISTORY
114The
115.Nm
116module first appeared in
117.Fx 3.1 .
118.Sh AUTHORS
119.An -nosplit
120The
121.Nm
122manual page was written by
123.An Andrzej Bialecki Aq abial@FreeBSD.org
124and adapted to TACACS+ from RADIUS by
125.An Mark R V Murray Aq markm@FreeBSD.org .
126.Pp
127The
128.Nm
129module was written by
130.An John D. Polstra Aq jdp@FreeBSD.org .
131