man/man5/rlm_realm.5

   1 .TH rlm_realm 5 "19 May 2006" "" "FreeRADIUS Module"
   2 .SH NAME
   3 rlm_realm \- FreeRADIUS Module
   4 .SH DESCRIPTION
   5 The \fIrlm_realm\fP module parses the User-Name attribute into a
   6 User section and a Realm section.  This is used primarily in a
   7 proxy situation, however, Realms can also be used locally to provide
   8 different service profiles based on the Realm being used.
   9 .PP
  10 The main configuration items to be aware of are:
  11 .IP format
  12 This can be either 'prefix' or 'suffix'.  It specifies whether the
  13 Realm is before or after the User portion in the User-Name string.
  14 .IP delimiter
  15 A single character in quotes, which is used as the delimiting
  16 character that separates the Realm and User sections of the string.
  17 .IP ignore_default
  18 This is set to either 'yes' or 'no'.  If set to 'yes', this will
  19 prevent the module instance from matching a realm against the DEFAULT
  20 entry.  This may be useful if you have multiple realm module instances.
  21 The default is 'no'.
  22 .IP ignore_null
  23 This is set to either 'yes' or 'no'.  If set to 'yes', this will
  24 prevent the module instance from matching a realm against the NULL
  25 entry.  This may be useful if you have multiple realm module instances.
  26 The default is 'no'.
  27 .PP
  28 This module parses the realm from the User-Name attrbiute according
  29 to the instance configuration, and then performs a lookup to find a
  30 matching realm in the '/etc/raddb/proxy.conf' file.  Depending on the
  31 configuration of the Realm as matched in the file, the username may
  32 be rewritten in a 'stripped' format, or with the Realm portion
  33 removed.  In either case, a Realm attribute is created and added to
  34 the packet on a match, which can be used by other modules.
  35 .PP
  36 In order to force proxying for a request, set the
  37 .DS
  38 Proxy-To-Realm := "realm-name"
  39 .DE
  40 in the \fIusers\fP file, or in a database such as SQL.
  41 .SH CONFIGURATION
  42 .PP
  43 .DS
  44 modules {
  45   ... stuff here ...
  46 .br
  47 .br
  48   # useranme@realm syntax
  49 .br
  50   realm suffix {
  51 .br
  52     format = suffix
  53 .br
  54     delimiter = "@"
  55 .br
  56   }
  57 .br
  58 .br
  59    # realm/username syntax
  60 .br
  61    realm prefix {
  62 .br
  63     format = prefix
  64 .br
  65     delimiter = "/"
  66 .br
  67   }
  68 .br
  69 .br
  70   ... stuff here ...
  71 .br
  72 }
  73 .DE
  74 .PP
  75 .SH SECTIONS
  76 .BR authorization,
  77 .BR pre-accounting
  78 .PP
  79 .SH FILES
  80 .I /etc/raddb/radiusd.conf,
  81 .I /etc/raddb/proxy.conf
  82 .PP
  83 .SH "SEE ALSO"
  84 .BR radiusd (8),
  85 .BR radiusd.conf (5),
  86 .BR proxy.conf (5)
  87 .SH AUTHORS
  88 Chris Parker, cparker@segv.org