From bde15e660005e50ff77c5832c9993275ac1d96c0 Mon Sep 17 00:00:00 2001
From: Linus Nordberg <linus@nordu.net>
Date: Tue, 27 Sep 2011 19:48:12 +0200
Subject: [PATCH] Add F-Ticks documentation to radsecproxy.conf.5.
---
radsecproxy.conf.5.xml | 37 +++++++++++++++++++++++++++++++------
1 file changed, 31 insertions(+), 6 deletions(-)
diff --git a/radsecproxy.conf.5.xml b/radsecproxy.conf.5.xml
index 16b0413..bfc701e 100644
--- a/radsecproxy.conf.5.xml
+++ b/radsecproxy.conf.5.xml
@@ -173,8 +173,15 @@ blocktype name {
<term><literal>FTicksReporting</literal></term>
<listitem>
<para>
- TODO! (See <literal>radsecproxy.conf-example</literal>
- for now.)
+ 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>.
+
+ 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.
</para>
</listitem>
</varlistentry>
@@ -183,8 +190,20 @@ blocktype name {
<term><literal>FTicksMAC</literal></term>
<listitem>
<para>
- TODO! (See <literal>radsecproxy.conf-example</literal>
- for now.)
+ 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>,
+ <literal>VendorHashed</literal>,
+ <literal>VendorKeyHashed</literal>,
+ <literal>FullyHashed</literal> or
+ <literal>FullyKeyHashed</literal>.
+
+ Its default value is <static>Static</static>.
+
+ 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.
</para>
</listitem>
</varlistentry>
@@ -193,8 +212,14 @@ blocktype name {
<term><literal>FTicksKey</literal></term>
<listitem>
<para>
- TODO! (See <literal>radsecproxy.conf-example</literal>
- for now.)
+ The FTicksKey option is used to specify the key to use
+ 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
+ option to have any effect.
</para>
</listitem>
</varlistentry>