man/man5/rlm_unix.5

   1 .TH rlm_unix 5 "5 February 2004" "" "FreeRADIUS Module"
   2 .SH NAME
   3 rlm_unix \- FreeRADIUS Module
   4 .SH DESCRIPTION
   5 The \fIrlm_unix\fP module allows authentication against the system
   6 password, shadow, and group files.  It also provides FreeRADIUS an
   7 interface into a radwtmp file (used by "radlast") when added to the
   8 accounting section.
   9 .PP
  10 The \fIrlm_unix\fP module provides the functionality for "Auth-Type =
  11 System", rather than "Auth-Type = Unix".  The "System" name is used
  12 for historical reasons.
  13 .PP
  14 The main configuration items to be aware of are:
  15 .IP cache
  16 This is a 'yes' or 'no' option.  If set to yes, FreeRADIUS will read
  17 the system files into memory, rather than perform a system call to
  18 lookup the information.  On *BSD systems, you should set this value to
  19 no.  On other systems, if you have a very large passwd and shadow
  20 files, you can try setting this to yes, which may increase the servers
  21 performance.  The default is no.
  22 .IP cache_reload
  23 This is the number of seconds to wait between refreshing the cached
  24 files from the system.  It has no effect unless you enable caching.
  25 .IP passwd
  26 The path to the system passwd file.  Usually /etc/passwd.  If
  27 commented out, or not set, the server will retrieve the information
  28 via systemcalls.
  29 .IP shadow
  30 The path to the system shadow file.  Usually /etc/shadow.  This is not
  31 set by default.
  32 .IP group
  33 The path to the system group file.  Usually /etc/group.  This is not
  34 set by default.
  35 .IP radwtmp
  36 The path to the system wtmp file to be used for keeping the database
  37 of online users as read by the 'radlast' program.
  38 .IP usegroup
  39 This is a 'yes' or 'no' option.  If set to 'yes' this allows the Group
  40 attribute to be used as a check item.  Default is 'no'.
  41 .SH CONFIGURATION
  42 .PP
  43 .DS
  44 modules {
  45   ...
  46 .br
  47   unix {
  48 .br
  49     cache = no
  50 .br
  51     cache_reload = 600
  52 .br
  53     #passwd = /etc/passwd
  54 .br
  55     #shadow = /etc/shadow
  56 .br
  57     #group = /etc/group
  58 .br
  59     usegroup = no
  60 .br
  61     radwtmp = ${logdir}/radwtmp
  62 .br
  63   }
  64 .br
  65   ...
  66 .br
  67 }
  68 .DE
  69 .PP
  70 .SH SECTIONS
  71 .BR authentication,
  72 .BR accounting
  73 .PP
  74 .SH FILES
  75 .I /etc/raddb/radiusd.conf,
  76 .PP
  77 .SH "SEE ALSO"
  78 .BR radiusd (8),
  79 .BR radiusd.conf (5),
  80 .BR radlast (1)
  81 .SH AUTHORS
  82 Chris Parker, cparker@segv.org