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