doc/variables.txt

   1 The variables defined by the server are:
   2
   3      %{Attribute-Name}               Corresponding value for Attribute-Name
   4                                      in request
   5      %{request:Attribute-Name}       Corresponding value for Attribute-Name
   6                                      in request
   7      %{reply:Attribute-Name}         Corresponding value for Attribute-Name
   8                                      in reply
   9      %{proxy-reply:Attribute-Name}   Corresponding value for Attribute-Name
  10                                      in the proxy reply (if it exists)
  11
  12      %{config:section.subsection.item} Corresponding value in 'radiusd.conf'
  13                                        for the string value of that item.
  14
  15   The %{config:...} variables should be used VERY carefully, as they
  16 may leak secret information from your RADIUS server, if you use them
  17 in reply attributes to the NAS!
  18
  19   e.g.
  20
  21   %{User-Name}                   The string value of the User-Name attribute.
  22   %{proxy-reply:Framed-Protocol} The string value of the Framed-Protocol
  23                                  attribute, from the proxy reply.
  24   %{config:modules.unix.passwd}  The string value of the 'passwd' configuration
  25                                  item in the 'unix' module, in the 'modules'
  26                                  section of radiusd.conf.
  27
  28 Variables are used in dynamically translated strings.  Most of the
  29 configuration entries in radiusd.conf (and related files) will do
  30 dynamic string translation.  To do the same dynamic translation in
  31 RADIUS attributes, you must put the string into an back-quoted string:
  32
  33        Session-Timeout = `%{expr: 2 + 3}`
  34
  35
  36 Additionally, you can use conditional syntax similar to ${foo:-bar} as
  37 defined in 'sh'.  For example:
  38
  39   1.  %{Foo:-bar}
  40     When attribute Foo is set:  returns value of Foo
  41     When attribute Foo unset:   returns literal string 'bar'
  42
  43   2.  %{Foo:-%{Bar}}
  44     When attribute Foo is set:  returns value of attribute Foo
  45     When attribute Foo unset:   returns value of attribute Bar (if any)
  46
  47   3.  %{Foo:-%{bar:-baz}}
  48     When attribute Foo is set:  returns value of attribute Foo
  49     When attribute Foo unset:   returns value of attribute Bar (if any)
  50     When attribute Bar unset:   returns literal string 'baz'
  51
  52
  53 When calling an external program (e.g. from Exec-Program-Wait), these
  54 variables can be passed on the command line to the program.  In
  55 addition, the server places all of the attributes in the RADIUS
  56 request into environment variables for the external program.  The
  57 variables are renamed under the following rules:
  58
  59   1.  All letters are made upper-case.
  60
  61   2.  All hyphens '-' are turned into underscores '_'
  62
  63 so the attribute User-Name can be passed on the command line to the
  64 program as %{User-Name}, or used inside the program as the environment
  65 variable USER_NAME (or $USER_NAME for shell scripts).
  66
  67 If you want to see the list of all of the variables, try adding a line
  68 'printenv > /tmp/exec-program-wait' to the script.  Then look in the
  69 file for a complete list of variables.
  70
  71 The following one-character variables are also defined.  However, they
  72 are duplicates of the previous general cases, and are only provided
  73 for backwards compatibility.  They WILL BE removed in a future
  74 release.  They also do NOT permit the use of conditional syntax
  75 (':-'), as described above.
  76
  77
  78     Variable  Description                 Proper Equivalent
  79     --------  -----------                 ----------------
  80      %a       Protocol (SLIP/PPP)         %{Framed-Protocol}
  81      %c       Callback-Number             %{Callback-Number}
  82      %d       request day (DD)
  83      %f       Framed IP address           %{Framed-IP-Address}
  84      %i       Calling Station ID          %{Calling-Station-Id}
  85      %l       request timestamp
  86      %m       request month (MM)
  87      %n       NAS IP address              %{NAS-IP-Address}
  88      %p       Port number                 %{NAS-Port-Id}
  89      %s       Speed (PW_CONNECT_INFO)     %{Connect-Info}
  90      %t       request in ctime format
  91      %u       User name                   %{User-Name}
  92      %A       radacct_dir                 %{config:radacctdir}
  93      %C       clientname
  94      %D       request date (YYYYMMDD)
  95      %H       request hour
  96      %L       radlog_dir                  %{config:logdir}
  97      %M       MTU                         %{Framed-MTU}
  98      %R       radius_dir                  %{config:raddbdir}
  99      %S       request timestamp
 100                 in SQL format
 101      %T       request timestamp
 102                 in database format
 103      %U       Stripped User name          %{Stripped-User-Name}
 104      %V       Request-Authenticator
 105                 (Verified/None)
 106      %Y       request year (YYYY)
 107      %Z       All request attributes
 108                except password
 109                (must have a big buffer)