man/man5/rlm_files.5

   1 .TH rlm_files 5 "5 February 2004" "" "FreeRADIUS Module"
   2 .SH NAME
   3 rlm_files \- FreeRADIUS Module
   4 .SH DESCRIPTION
   5 The \fIrlm_files\fP module uses the 'users' file for accessing
   6 authorization information for users.  Additionally, it supports
   7 a 'users' file syntax to be applied to the accounting and pre-proxy
   8 sections.
   9 .PP
  10 The main configuration items to be aware of are:
  11 .IP usersfile
  12 The filename of the 'users' file, which is parsed during the
  13 authorization stage of this module.
  14 .IP acctusersfile
  15 The filename of the 'users' file, which is parsed during the
  16 accounting stage of this module.
  17 .IP preproxy_usersfile
  18 The filename of the 'users' file, which is parsed during the
  19 pre_proxy stage of this module.
  20 .IP compat
  21 This option allows FreeRADIUS to parse an old style Cistron syntax.
  22 The default is 'no'.  If you need to parse an old style Cistron
  23 file, set this option to 'cistron'.
  24 .IP key
  25 This option lets you set the attribute to use as a key to find
  26 entries.  The default is "%{Stripped-User-Name:-%{User-Name}}".  Note
  27 that the key MUST supply real data.  Dynamic attributes like "Group"
  28 will not work, because the "Group" attribute can only be used as a
  29 comparison, to see if a user is in a Unix group.  It will not return
  30 the name of the Unix group that a user is in.
  31 .PP
  32 If you want to use groups as a key, see the \fIrlm_passed\fP, which
  33 will create a real attribute that contains the group name.
  34 .PP
  35 This configuration entry enables you to have configurations that
  36 perform per-group checks, and return per-group attributes, where the
  37 group membership is dynamically defined by a previous module.  It also
  38 lets you do things like key off of attributes in the reply, and
  39 express policies like like "when I send replies containing attribute
  40 FOO with value BAR, do more checks, and maybe send additional
  41 attributes".
  42 .SH CONFIGURATION
  43 .PP
  44 .DS
  45 modules {
  46   ... stuff here ...
  47 .br
  48   files {
  49 .br
  50     usersfile = %{confdir}/users
  51 .br
  52     acctusersfile = %{confdir}/acct_users
  53 .br
  54     preproxy_usersfile = %{confdir}/preproxy_users
  55 .br
  56     compat = no
  57 .br
  58     key = %{Stripped-User-Name:-%{User-Name}}
  59 .br
  60   }
  61 .br
  62   ... stuff here ...
  63 .br
  64 }
  65 .DE
  66 .PP
  67 .SH SECTIONS
  68 .BR authorization,
  69 .BR accounting,
  70 .BR pre_proxy
  71 .PP
  72 .SH FILES
  73 .I /etc/raddb/radiusd.conf,
  74 .I /etc/raddb/users,
  75 .I /etc/raddb/acct_users,
  76 .I /etc/raddb/preproxy_users
  77 .PP
  78 .SH "SEE ALSO"
  79 .BR radiusd (8),
  80 .BR radiusd.conf (5),
  81 .BR users (5)
  82 .SH AUTHORS
  83 Chris Parker, cparker@segv.org