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