Stop resolver scripts from signalling "not found".
[libradsec.git] / radsecproxy.conf.5.xml
index efcd4ed..35182f0 100644 (file)
@@ -2,14 +2,14 @@
 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 <refentry>
   <refentryinfo>
-    <date>2011-09-30</date>
+    <date>2012-12-12</date>
   </refentryinfo>
   <refmeta>
     <refentrytitle>
       <application>radsecproxy.conf</application>
     </refentrytitle>
     <manvolnum>5</manvolnum>
-    <refmiscinfo>radsecproxy 1.5-dev</refmiscinfo>
+    <refmiscinfo>radsecproxy 1.6-dev</refmiscinfo>
   </refmeta>
   <refnamediv>
     <refname>
@@ -176,12 +176,17 @@ blocktype name {
            The FTicksReporting option is used to enable F-Ticks
            logging and can be set to <literal>None</literal>,
            <literal>Basic</literal> or <literal>Full</literal>.  Its
-           default value is <literal>None</literal>.
-
+           default value is <literal>None</literal>.  If
+           FTicksReporting is set to anything other than
+           <literal>None</literal>, note that the default value for
+           FTicksMAC is <literal>VendorKeyHashed</literal> which
+           needs FTicksKey to be set.
+         </para>
+         <para>
            See <literal>radsecproxy.conf-example</literal> for
            details.  Note that radsecproxy has to be configured with
-           support for F-Ticks (<literal>--enable-fticks</literal>)
-           for this option to have any effect.
+           F-Ticks support (<literal>--enable-fticks</literal>) for
+           this option to have any effect.
          </para>
        </listitem>
       </varlistentry>
@@ -191,19 +196,31 @@ blocktype name {
         <listitem>
          <para>
            The FTicksMAC option can be used to control if and how
-           Calling-Station-Id is being logged.  It can be set to one
-           of <literal>Static</literal>, <literal>Original</literal>,
+           Calling-Station-Id (the users Ethernet MAC address) is
+           being logged.  It can be set to one of
+           <literal>Static</literal>, <literal>Original</literal>,
            <literal>VendorHashed</literal>,
            <literal>VendorKeyHashed</literal>,
            <literal>FullyHashed</literal> or
            <literal>FullyKeyHashed</literal>.
-
-           Its default value is <static>Static</static>.
-
+         </para>
+         <para>
+           The default value for FTicksMAC is
+           <literal>VendorKeyHashed</literal>.  This means that
+           FTicksKey has to be set.
+         <para>
+           Before chosing any of <literal>Original</literal>,
+           <literal>FullyHashed</literal> or
+           <literal>VendorHashed</literal>, consider the implications
+           for user privacy when MAC addresses are collected.  How
+           will the logs be stored, transferred and accessed?
+         </para>
+         </para>
+         <para>
            See <literal>radsecproxy.conf-example</literal> for
            details.  Note that radsecproxy has to be configured with
-           support for F-Ticks (<literal>--enable-fticks</literal>)
-           for this option to have any effect.
+           F-Ticks support (<literal>--enable-fticks</literal>) for
+           this option to have any effect.
          </para>
        </listitem>
       </varlistentry>
@@ -216,15 +233,35 @@ blocktype name {
            when producing HMAC's as an effect of specifying
            VendorKeyHashed or FullyKeyHashed for the FTicksMAC
            option.
-
-           Note that radsecproxy has to be configured with support
-           for F-Ticks (<literal>--enable-fticks</literal>) for this
+         </para>
+         <para>
+           Note that radsecproxy has to be configured with F-Ticks
+           support (<literal>--enable-fticks</literal>) for this
            option to have any effect.
          </para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
+        <term><literal>FTicksSyslogFacility</literal></term>
+        <listitem>
+         <para>
+           The FTicksSyslogFacility option is used to specify a
+           dedicated syslog facility for F-Ticks messages.  This
+           allows for easier filtering of F-Ticks messages.  If no
+           FTicksSyslogFacility option is given, F-Ticks messages are
+           written to what the LogDestination option specifies.
+         </para>
+         <para>
+           F-Ticks messages are always logged using the log level
+           LOG_DEBUG.  Note that specifying a file in
+           FTicksSyslogFacility (using the file:/// prefix) is
+           not supported.
+         </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
         <term><literal>ListenUDP</literal></term>
         <listitem>
          <para>
@@ -443,9 +480,9 @@ blocktype name {
       <literal>certificateNameCheck</literal>,
       <literal>matchCertificateAttribute</literal>,
       <literal>duplicateInterval</literal>, <literal>AddTTL</literal>,
-      <literal>fticksVISCOUNTRY</literal>, <literal>rewrite</literal>,
-      <literal>rewriteIn</literal>, <literal>rewriteOut</literal>, and
-      <literal>rewriteAttribute</literal>.
+      <literal>fticksVISCOUNTRY</literal>, <literal>fticksVISINST</literal>,
+      <literal>rewrite</literal>, <literal>rewriteIn</literal>, 
+      <literal>rewriteOut</literal>, and <literal>rewriteAttribute</literal>.
 
       We already discussed the <literal>host</literal> option. The
       value of <literal>type</literal> must be one of
@@ -453,7 +490,9 @@ blocktype name {
       <literal>tls</literal> or <literal>dtls</literal>. The value of
       <literal>secret</literal> is the shared RADIUS key used with
       this client. If the secret contains whitespace, the value must
-      be quoted. This option is optional for TLS/DTLS.
+      be quoted. This option is optional for TLS/DTLS and if omitted
+      will default to "mysecret".  Note that the default value of
+      <literal>secret</literal> will change in an upcoming release.
     </para>
     <para>
       For a TLS/DTLS client you may also specify the
@@ -505,6 +544,11 @@ blocktype name {
       <literal>FTicksReporting</literal> basic option.
     </para>
     <para>
+      The <literal>fticksVISINST</literal> option overwrites
+      the default <literal>VISINST</literal> value taken from the client
+      block name.
+    </para>
+    <para>
       The <literal>rewrite</literal> option is deprecated. Use
       <literal>rewriteIn</literal> instead.
     </para>
@@ -589,8 +633,7 @@ blocktype name {
       <literal>AddTTL</literal>, <literal>rewrite</literal>,
       <literal>rewriteIn</literal>, <literal>rewriteOut</literal>,
       <literal>statusServer</literal>, <literal>retryCount</literal>,
-      <literal>retryInterval</literal>,
-      <literal>dynamicLookupCommand</literal> and
+      <literal>retryInterval</literal> and
       <literal>LoopPrevention</literal>.
     </para>
     <para>
@@ -625,12 +668,6 @@ blocktype name {
       an interval of 5s.
     </para>
     <para>
-      The option <literal>dynamicLookupCommand</literal> can be used
-      to specify a command that should be executed to dynamically
-      configure and use a server.  The use of this feature will be
-      documented separately/later.
-    </para>
-    <para>
       Using the <literal>LoopPrevention</literal> option here
       overrides any basic setting of this option.  See section
       <literal>BASIC OPTIONS</literal> for details on this option.