xref: /freebsd/lib/libpam/modules/pam_radius/pam_radius.8 (revision d37ea99837e6ad50837fd9fe1771ddf1c3ba6002)
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 October 28, 2002
42.Dt PAM_RADIUS 8
43.Os
44.Sh NAME
45.Nm pam_radius
46.Nd RADIUS authentication PAM module
47.Sh SYNOPSIS
48.Op Ar service-name
49.Ar module-type
50.Ar control-flag
51.Pa pam_radius
52.Op Ar options
53.Sh DESCRIPTION
54The
55.Nm
56module provides authentication services based
57upon the RADIUS (Remote Authentication Dial In User Service) protocol
58for the PAM (Pluggable Authentication Module) framework.
59.Pp
60The
61.Nm
62module accepts these optional parameters:
63.Bl -tag -width Fl
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.  If no
73password has been entered,
74.Nm
75prompts for one as usual.
76.It Cm echo_pass
77causes echoing to be left on if
78.Nm
79prompts for a password.
80.It Cm conf Ns = Ns Ar pathname
81specifies a non-standard location for the RADIUS client configuration file
82(normally located in
83.Pa /etc/radius.conf ) .
84.It Cm nas_id Ns = Ns Ar identifier
85specifies a NAS identifier to send instead of the hostname.
86.It Cm template_user Ns = Ns Ar username
87specifies a user whose
88.Xr passwd 5
89entry will be used as a template to create the session environment
90if the supplied username doesn't exist in local password database.
91The user
92will be authenticated with the supplied username and password, but his
93credentials to the system will be presented as the ones for
94.Ar username ,
95i.e., his login class, home directory, resource limits, etc. will be set to ones
96defined for
97.Ar username .
98.Pp
99If this option is omitted, and there is no username
100in the system databases equal to the supplied one (as determined by call to
101.Xr getpwnam 3 ) ,
102the authentication will fail.
103.It Cm nas_ipaddr Ns Op No = Ns Ar address
104specifies a NAS IP address to be sent.
105If option is present, but there is no value provided then IP address
106corresponding to the current hostname will be used.
107.El
108.Sh FILES
109.Bl -tag -width /etc/radius.conf -compact
110.It Pa /etc/radius.conf
111The standard RADIUS client configuration file for
112.Nm
113.El
114.Sh SEE ALSO
115.Xr passwd 5 ,
116.Xr radius.conf 5 ,
117.Xr pam 8
118.Sh HISTORY
119The
120.Nm
121module first appeared in
122.Fx 3.1 .
123The
124.Nm
125manual page first appeared in
126.Fx 3.3 .
127.Sh AUTHORS
128.An -nosplit
129The
130.Nm
131manual page was written by
132.An Andrzej Bialecki Aq abial@FreeBSD.org .
133.Pp
134The
135.Nm
136module was written by
137.An John D. Polstra Aq jdp@FreeBSD.org .
138