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