lib/libpam/modules/pam_radius/pam_radius.8

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