xref: /freebsd/lib/libpam/modules/pam_radius/pam_radius.8 (revision 23f282aa31e9b6fceacd449020e936e98d6f2298)
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_radius 8
43.Os FreeBSD 3.3
44.Sh NAME
45.Nm pam_radius
46.Nd RADIUS authentication PAM module
47.Sh SYNOPSIS
48.Nm pam_radius.so
49.Op Cm use_first_pass
50.Op Cm try_first_pass
51.Op Cm echo_pass
52.Op Cm conf Ns No = Ns Ar pathname
53.Op Cm template_user Ns No = Ns Ar username
54.Sh DESCRIPTION
55The
56.Nm
57module provides authentication services based
58upon the RADIUS (Remote Authentication Dial In User Service) protocol
59for the PAM (Pluggable Authentication Module) framework.
60.Pp
61The
62.Nm
63module accepts these optional parameters:
64.Bl -tag -width Fl
65.It Cm use_first_pass
66causes
67.Nm
68to use a previously entered password instead of prompting for a new one.
69If no password has been entered then authentication fails.
70.It Cm try_first_pass
71causes
72.Nm
73to use a previously entered password, if one is available.  If 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 No = Ns Ar pathname
82specifies a non-standard location for the RADIUS client configuration file
83(normally located in /etc/radius.conf).
84.It Cm template_user Ns No = Ns Ar username
85specifies a user whose
86.Xr passwd 5
87entry will be used as a template to create the session environment
88if the supplied username doesn't exist in local password database.
89The user
90will be authenticated with the supplied username and password, but his
91credentials to the system will be presented as the ones for
92.Ar username ,
93i.e., his login class, home directory, resource limits, etc. will be set to ones
94defined for
95.Ar username .
96.Pp
97If this option is omitted, and there is no username
98in the system databases equal to the supplied one (as determined by call to
99.Xr getpwnam 3 Ns ),
100the authentication will fail.
101.Sh FILES
102.Bl -tag -width /etc/radius.conf -compact
103.It Pa /etc/radius.conf
104The standard RADIUS client configuration file for
105.Nm
106.El
107.Sh SEE ALSO
108.Xr pam 8 ,
109.Xr passwd 5 ,
110.Xr radius.conf 5
111.Sh HISTORY
112The
113.Nm
114module first appeared in
115.Fx 3.1 .
116The
117.Nm
118manual page first appeared in
119.Fx 3.3 .
120.Sh AUTHORS
121The
122.Nm
123manual page was written by
124.An Andrzej Bialecki Aq abial@FreeBSD.org .
125.Pp
126The
127.Nm
128module was written by
129.An John D. Polstra Aq jdp@FreeBSD.org .
130