man/man5/vmpsd.conf.5

   1 .TH vmpsd.conf 5 "28 May 2007" "" "FreeRADIUS VMPSd configuration file"
   2 .SH NAME
   3 vmpsd.conf \- configuration file for the VMPSd server
   4 .SH DESCRIPTION
   5 The \fBvmpsd.conf\fP file resides in the \fB/etc/raddb\fP directory.
   6 It defines the global configuration for the VMPSd server.
   7 .SH INTRODUCTION
   8 The file is very similar in form to that of the \fBradiusd.conf\fP, as
   9 the vmps server is really a RADIUS server that also handles VMPS.
  10
  11 This documentation page explains the VMPS-specific portions of the
  12 configuration file, and how those portions differ from a
  13 \fBradiusd.conf\fP file.
  14 .SH VMPS CONFIGURATION
  15 When a VMPS request is received by the server, it is processed through
  16 a "vmps" section.  In RADIUS, requests are processed through
  17 "authorize", "authenticate", etc.
  18
  19 .DS
  20         vmps {
  21 .br
  22                 module1
  23 .br
  24                 module2
  25 .br
  26                 ...
  27 .br
  28         }
  29 .DE
  30
  31 Proxying of requests is supported, as are the "pre-proxy" and
  32 "post-proxy" sections.  However, any VMPS requests will be proxied as
  33 RADIUS packets, and not VMPS packets.  This is because the server is
  34 still, at heart, a RADIUS server.
  35 .SH "CONTENTS"
  36 There are a large number of configuration parameters for the server.
  37 Most are documented in the file itself as comments.  This page
  38 documents only the format of the file.  Please read the
  39 \fBvmpsd.conf\fP file itself for more information.
  40
  41 The configuration file parser is independent of the server
  42 configuration.  This means that you can put almost anything into the
  43 configuration file.  So long as it is properly formatted, the server
  44 will start.
  45
  46 When the server parses the configuration file, it looks only for those
  47 configurations it understands.  Extra configuration items are ignored.
  48 This "feature" can be (ab)used in certain interesting ways.
  49 .SH "FILE FORMAT"
  50 The file format is line-based, like many other Unix configuration
  51 files.  Each entry in the file must be placed on a line by itself,
  52 although continuations are supported.
  53
  54 The file consists of configuration items (variable = value pairs),
  55 sections, and comments.
  56 .IP Variables
  57 Variables can be set via:
  58
  59 .DS
  60 .br
  61         name = value
  62 .DE
  63
  64 Single and double-quoted strings are permitted:
  65
  66 .DS
  67 .br
  68         string1 = "hello world"
  69 .br
  70         string2 = 'hello mom'
  71 .DE
  72 .IP Sections
  73 A section begins with a section name, followed on the same line by an
  74 open bracket '\fB{\fP'.  Section may contain other sections, comments, or
  75 variables.  Sections may be nested to any depth, limited
  76 only by available memory.  A section ends with a close bracket
  77 '\fB}\fP', on a line by itself.
  78
  79 .DS
  80 .br
  81         section {
  82 .br
  83                 ...
  84 .br
  85         }
  86 .DE
  87
  88 Sections can sometimes have a second name following the first one.
  89 The situations where this is legal depend on the context.  See the
  90 examples and comments in the \fBvmpsd.conf\fP file for more
  91 information.
  92
  93 .DS
  94 .br
  95         section foo {
  96 .br
  97                 ...
  98 .br
  99         }
 100 .DE
 101 .IP Comments
 102 Any line beginning with a (\fB#\fP) is deemed to be a comment, and is
 103 ignored.  Comments can appear after a variable or section definitions.
 104
 105 .DS
 106 .br
 107         # comment
 108 .br
 109         foo = bar # set variable 'foo' to value 'bar'
 110 .br
 111         section {       # start of section
 112 .br
 113         ...
 114 .br
 115         }               # end of section
 116 .DE
 117 .IP Continuations
 118 Long lines can be broken up via continuations, using '\\' as the last
 119 character of the line.  For example, the following entry:
 120
 121 .DS
 122 .br
 123         foo = "blah \\
 124 .br
 125         blah \\
 126 .br
 127         blah"
 128 .DE
 129
 130 will set the value of the variable "foo" to "blah blah blah".  Any CR
 131 or LF is not turned into a space, but all other whitespace is
 132 preserved in the final value.
 133 .SH "REFERENCES"
 134 The value of a variable can reference another variable.  These
 135 references are evaluated when the configuration file is loaded, which
 136 means that there is no run-time cost associated with them.  This
 137 feature is most useful for turning long, repeated pieces of text into
 138 short ones.
 139
 140 Variables are referenced by ${variable_name}, as in the following examples.
 141
 142 .DS
 143         foo = bar       # set variable 'foo' to value 'bar'
 144 .br
 145         who = ${foo}    # sets variable 'who' to value of variable 'foo'
 146 .br
 147         my = "${foo} a" # sets variable 'my' to "bar a"
 148 .DE
 149
 150 If the variable exists in a section or subsection, it can be
 151 referenced as ${section.subsection.variable}.  Forward references are
 152 not allowed.  Relative references are allowed, by pre-pending the name
 153 with one or more period.
 154
 155 .DS
 156         blogs = ${.foo}
 157
 158 .DE
 159 Will set variable \fBblogs\fP to the value of variable \fBfoo\fP,
 160 from the current section.
 161
 162 .DS
 163         blogs = ${..foo}
 164
 165 .DE
 166 Will set variable \fBblogs\fP to the value of variable \fBfoo\fP, from the
 167 section which contains the current section.
 168
 169 .DS
 170         blogs = ${modules.detail.detailfile}
 171
 172 .DE
 173 Will set variable \fBblogs\fP to the value of variable \fBdetailfile\fP,
 174 of the \fBdetail\fP module, which is in the \fBmodules\fP section of
 175 the configuration file.
 176 .SH FILES
 177 /etc/raddb/vmpsd.conf
 178 .SH "SEE ALSO"
 179 .BR vmpsd (8),
 180 .BR radiusd.conf (5)
 181 .SH AUTHOR
 182 Alan DeKok <aland@deployingradius.com>