[#539, !330] Updated admin guide and added ChangeLog

diff --git a/ChangeLog b/ChangeLog
index 38f2bac7b7466856077265436affbe4c9307ee00..1b60a7c03f248692d2cccae69b7a94e07c6b9b4c 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+1582.  [bug]           tmark
+       Input values for DHCPv4 and DHCPv6 options of type 'string'
+       will now be trimmed of any trailing null bytes (0x0).
+       (Gitlab #539, !330, git #TBD)
+
 1581.  [bug]           marcin
        Corrected a bug whereby the DHCPv6 server did not take into
        account a relay address specified at the shared network level

diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml
index e52fe9a6c1dc63c43395ef01dcf890f5d7cc72a5..506e22882b879b4b706a4b04dd414c988b8930a3 100644 (file)
--- a/doc/guide/dhcp4-srv.xml
+++ b/doc/guide/dhcp4-srv.xml
@@ -1726,7 +1726,7 @@ It is merely echoed by the server.
             <row><entry>ipv6-prefix</entry><entry>IPv6 prefix and prefix length specified using CIDR notation, e.g. 2001:db8:1::/64. This data type is used to represent an 8-bit field conveying a prefix length and the variable length prefix value.</entry></row>
             <row><entry>psid</entry><entry>PSID and PSID length separated by a slash, e.g. 3/4 specifies PSID=3 and PSID length=4. In the wire format it is represented by an 8-bit field carrying PSID length (in this case equal to 4) and the 16-bits-long PSID value field (in this case equal to "0011000000000000b" using binary notation). Allowed values for a PSID length are 0 to 16. See <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://tools.ietf.org/html/rfc7597">RFC 7597</link> for details about the PSID wire representation.</entry></row>
             <row><entry>record</entry><entry>Structured data that may be comprised of any types (except "record" and "empty"). The array flag applies to the last field only.</entry></row>
-            <row><entry>string</entry><entry>Any text.</entry></row>
+            <row><entry>string</entry><entry>Any text. Please note that Kea will silently discard any terminating/trailing nulls from the end of 'string' options when unpacking received packets. This is keeping with <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://tools.ietf.org/html/rfc2132#section-2">RFC 2132, Section 2</link></entry></row>
             <row><entry>tuple</entry><entry>A length encoded as an 8- (16- for DHCPv6) bit unsigned integer followed by a string of this length.</entry></row>
             <row><entry>uint8</entry><entry>8-bit unsigned integer with allowed values 0 to 255.</entry></row>
             <row><entry>uint16</entry><entry>16-bit unsigned integer with allowed values 0 to 65535.</entry></row>