xref: /freebsd/lib/libpam/modules/pam_radius/pam_radius.8 (revision 0aa4a9fc859fd43343e2d7b5094a50d1ca0948eb)
1.\"-
2.\" Copyright (c) 1992, 1993, 1994
3.\"	The Regents of the University of California.  All rights reserved.
4.\" Copyright (c) 1999 Andrzej Bialecki <abial@FreeBSD.org>
5.\" All rights reserved.
6.\" Copyright (c) 2018 The University of Oslo
7.\" All rights reserved.
8.\"
9.\" This code is derived from software donated to Berkeley by
10.\" Jan-Simon Pendry.
11.\"
12.\" Redistribution and use in source and binary forms, with or without
13.\" modification, are permitted provided that the following conditions
14.\" are met:
15.\" 1. Redistributions of source code must retain the above copyright
16.\"    notice, this list of conditions and the following disclaimer.
17.\" 2. Redistributions in binary form must reproduce the above copyright
18.\"    notice, this list of conditions and the following disclaimer in the
19.\"    documentation and/or other materials provided with the distribution.
20.\" 3. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.Dd May 16, 2018
37.Dt PAM_RADIUS 8
38.Os
39.Sh NAME
40.Nm pam_radius
41.Nd RADIUS authentication PAM module
42.Sh SYNOPSIS
43.Op Ar service-name
44.Ar module-type
45.Ar control-flag
46.Pa pam_radius
47.Op Ar options
48.Sh DESCRIPTION
49The
50.Nm
51module provides authentication services based
52upon the RADIUS (Remote Authentication Dial In User Service) protocol
53for the PAM (Pluggable Authentication Module) framework.
54.Pp
55The
56.Nm
57module accepts these optional parameters:
58.Bl -tag -width Fl
59.It Cm use_first_pass
60causes
61.Nm
62to use a previously entered password instead of prompting for a new one.
63If no password has been entered then authentication fails.
64.It Cm try_first_pass
65causes
66.Nm
67to use a previously entered password, if one is available.
68If no
69password has been entered,
70.Nm
71prompts for one as usual.
72.It Cm echo_pass
73causes echoing to be left on if
74.Nm
75prompts for a password.
76.It Cm conf Ns = Ns Ar pathname
77specifies a non-standard location for the RADIUS client configuration file
78(normally located in
79.Pa /etc/radius.conf ) .
80.It Cm nas_id Ns = Ns Ar identifier
81specifies a NAS identifier to send instead of the hostname.
82.It Cm nas_ipaddr Ns Op No = Ns Ar address
83specifies a NAS IP address to be sent.
84If option is present, but there is no value provided then IP address
85corresponding to the current hostname will be used.
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 does not 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 no_reply_message
104suppress printing of the contents of any
105.Cm Reply-Message
106attributes found in
107.Cm Access-Accept
108and
109.Cm Access-Reject
110responses.
111These are normally conveyed to the user as either informational or
112error messages, depending on whether the access request was accepted
113or rejected.
114.It Cm no_warn
115suppress warning messages to the user.
116These messages include reasons why the user's authentication attempt
117was declined.
118.El
119.Sh FILES
120.Bl -tag -width /etc/radius.conf -compact
121.It Pa /etc/radius.conf
122The standard RADIUS client configuration file for
123.Nm
124.El
125.Sh SEE ALSO
126.Xr pam 3 ,
127.Xr passwd 5 ,
128.Xr radius.conf 5
129.Sh HISTORY
130The
131.Nm
132module first appeared in
133.Fx 3.1 .
134The
135.Nm
136manual page first appeared in
137.Fx 3.3 .
138.Sh AUTHORS
139.An -nosplit
140The
141.Nm
142manual page was written by
143.An Andrzej Bialecki Aq Mt abial@FreeBSD.org .
144.Pp
145The
146.Nm
147module was written by
148.An John D. Polstra Aq Mt jdp@FreeBSD.org .
149