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