lib/libpam/modules/pam_radius/pam_radius.8

   1 .\" $NetBSD: pam_radius.8,v 1.4 2005/02/26 15:59:08 thorpej Exp $
   2 .\" Copyright (c) 1999
   3 .\"     Andrzej Bialecki <abial@FreeBSD.org>.  All rights reserved.
   4 .\"
   5 .\" Copyright (c) 1992, 1993, 1994
   6 .\"     The Regents of the University of California.  All rights reserved.
   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. All advertising materials mentioning features or use of this software
  21 .\"    must display the following acknowledgement:
  22 .\"     This product includes software developed by the University of
  23 .\"     California, Berkeley and its contributors.
  24 .\" 4. Neither the name of the University nor the names of its contributors
  25 .\"    may be used to endorse or promote products derived from this software
  26 .\"    without specific prior written permission.
  27 .\"
  28 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  29 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  30 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  31 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  32 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  34 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  37 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  38 .\" SUCH DAMAGE.
  39 .\"
  40 .\" $FreeBSD: src/lib/libpam/modules/pam_radius/pam_radius.8,v 1.17 2005/02/13 22:25:14 ru Exp $
  41 .\"
  42 .Dd October 28, 2002
  43 .Dt PAM_RADIUS 8
  44 .Os
  45 .Sh NAME
  46 .Nm pam_radius
  47 .Nd RADIUS PAM module
  48 .Sh SYNOPSIS
  49 .Op Ar service-name
  50 .Ar module-type
  51 .Ar control-flag
  52 .Pa pam_radius
  53 .Op Ar options
  54 .Sh DESCRIPTION
  55 The RADIUS service module for PAM
  56 provides authentication services based
  57 upon the RADIUS (Remote Authentication Dial In User Service) protocol.
  58 .Pp
  59 The
  60 .Nm
  61 module accepts these optional parameters:
  62 .Bl -tag -width Fl
  63 .It Cm use_first_pass
  64 causes
  65 .Nm
  66 to use a previously entered password instead of prompting for a new one.
  67 If no password has been entered then authentication fails.
  68 .It Cm try_first_pass
  69 causes
  70 .Nm
  71 to use a previously entered password, if one is available.
  72 If no
  73 password has been entered,
  74 .Nm
  75 prompts for one as usual.
  76 .It Cm echo_pass
  77 causes echoing to be left on if
  78 .Nm
  79 prompts for a password.
  80 .It Cm conf Ns = Ns Ar pathname
  81 specifies 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
  85 specifies a NAS identifier to send instead of the hostname.
  86 .It Cm template_user Ns = Ns Ar username
  87 specifies a user whose
  88 .Xr passwd 5
  89 entry will be used as a template to create the session environment
  90 if the supplied username does not exist in the local password database.
  91 The user
  92 will be authenticated with the supplied username and password, but his
  93 credentials to the system will be presented as the ones for
  94 .Ar username ,
  95 i.e., his login class, home directory, resource limits, etc.\& will be set to ones
  96 defined for
  97 .Ar username .
  98 .Pp
  99 If this option is omitted, and there is no username
 100 in the system databases equal to the supplied one (as determined by call to
 101 .Xr getpwnam 3 ) ,
 102 the authentication will fail.
 103 .It Cm nas_ipaddr Ns Op No = Ns Ar address
 104 specifies a NAS IP address to be sent.
 105 If option is present, but there is no value provided then IP address
 106 corresponding 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
 111 The 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
 119 The
 120 .Nm
 121 module first appeared in
 122 .Fx 3.1 .
 123 The
 124 .Nm
 125 manual page first appeared in
 126 .Fx 3.3 .
 127 .Sh AUTHORS
 128 .An -nosplit
 129 The
 130 .Nm
 131 manual page was written by
 132 .An Andrzej Bialecki Aq abial@FreeBSD.org .
 133 .Pp
 134 The
 135 .Nm
 136 module was written by
 137 .An John D. Polstra Aq jdp@FreeBSD.org .