From: Razvan Becheriu <razvan@isc.org>
Date: Mon, 7 Jun 2021 13:18:18 +0000 (+0300)
Subject: [#1720] fixed documentation
X-Git-Tag: Kea-1.9.9~123
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1212d5bbc5aa6414ec58ca18c8d39eab52324f19;p=thirdparty%2Fkea.git

[#1720] fixed documentation
---

diff --git a/src/bin/keactrl/kea-dhcp4.conf.pre b/src/bin/keactrl/kea-dhcp4.conf.pre
index bff4210361..efb57f6748 100644
--- a/src/bin/keactrl/kea-dhcp4.conf.pre
+++ b/src/bin/keactrl/kea-dhcp4.conf.pre
@@ -252,7 +252,7 @@
     //      // of all devices serviced by Kea, including their identifiers
     //      // (like MAC address), their location in the network, times
     //      // when they were active etc.
-    //      "library": "@libdir@/kea/hooks/libdhcp_legal_log.so"
+    //      "library": "@libdir@/kea/hooks/libdhcp_legal_log.so",
     //      "parameters": {
     //          "path": "/var/lib/kea",
     //          "base-name": "kea-forensic4"
@@ -271,7 +271,7 @@
     //      // are addressed by the Flexible Identifiers hook application.
     //      "library": "@libdir@/kea/hooks/libdhcp_flex_id.so",
     //      "parameters": {
-    //          "identifier-expression": "substring(relay6[0].option[18],0,8)"
+    //          "identifier-expression": "substring(relay4[2].hex)"
     //      }
     //  }
     //],
diff --git a/src/bin/keactrl/kea-dhcp6.conf.pre b/src/bin/keactrl/kea-dhcp6.conf.pre
index 5fb8c80f54..83dd708821 100644
--- a/src/bin/keactrl/kea-dhcp6.conf.pre
+++ b/src/bin/keactrl/kea-dhcp6.conf.pre
@@ -184,6 +184,42 @@
         }
     ],
 
+    // Another thing possible here are hooks. Kea supports a powerful mechanism
+    // that allows loading external libraries that can extract information and
+    // even influence how the server processes packets. Those libraries include
+    // additional forensic logging capabilities, ability to reserve hosts in
+    // more flexible ways, and even add extra commands. For a list of available
+    // hook libraries, see https://gitlab.isc.org/isc-projects/kea/wikis/Hooks-available.
+    //"hooks-libraries": [
+    //  {
+    //      // Forensic Logging library generates forensic type of audit trail
+    //      // of all devices serviced by Kea, including their identifiers
+    //      // (like MAC address), their location in the network, times
+    //      // when they were active etc.
+    //      "library": "@libdir@/kea/hooks/libdhcp_legal_log.so",
+    //      "parameters": {
+    //          "path": "/var/lib/kea",
+    //          "base-name": "kea-forensic6"
+    //      }
+    //  },
+    //  {
+    //      // Flexible identifier (flex-id). Kea software provides a way to
+    //      // handle host reservations that include addresses, prefixes,
+    //      // options, client classes and other features. The reservation can
+    //      // be based on hardware address, DUID, circuit-id or client-id in
+    //      // DHCPv4 and using hardware address or DUID in DHCPv6. However,
+    //      // there are sometimes scenario where the reservation is more
+    //      // complex, e.g. uses other options that mentioned above, uses part
+    //      // of specific options or perhaps even a combination of several
+    //      // options and fields to uniquely identify a client. Those scenarios
+    //      // are addressed by the Flexible Identifiers hook application.
+    //      "library": "@libdir@/kea/hooks/libdhcp_flex_id.so",
+    //      "parameters": {
+    //          "identifier-expression": "relay6[0].option[37].hex)"
+    //      }
+    //  }
+    //],
+
     // Below an example of a simple IPv6 subnet declaration. Uncomment to enable
     // it. This is a list, denoted with [ ], of structures, each denoted with
     // { }. Each structure describes a single subnet and may have several