man/man5/rlm_files.5

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