From cb1b459e3b52bb0a7d6392335978e835850b7387 Mon Sep 17 00:00:00 2001 From: Francis Dupont Date: Mon, 18 Nov 2019 11:12:00 +0100 Subject: [PATCH] [898-add-a-new-hook-to-support-bootp] Updated docs --- doc/devel/Doxyfile | 2 ++ doc/sphinx/arm/dhcp4-srv.rst | 6 +++++- doc/sphinx/arm/hooks.rst | 28 ++++++++++++++++++++++++++++ doc/sphinx/mes-files.txt | 2 ++ 4 files changed, 37 insertions(+), 1 deletion(-) diff --git a/doc/devel/Doxyfile b/doc/devel/Doxyfile index 5032a88325..7733cd0bd6 100644 --- a/doc/devel/Doxyfile +++ b/doc/devel/Doxyfile @@ -779,6 +779,8 @@ INPUT = ../../src/bin/agent \ ../../src/bin/netconf \ ../../src/bin/perfdhcp \ ../../src/bin/sockcreator \ + ../../src/hooks/dhcp/bootp \ + ../../src/hooks/dhcp/flex_option \ ../../src/hooks/dhcp/high_availability \ ../../src/hooks/dhcp/lease_cmds \ ../../src/hooks/dhcp/stat_cmds \ diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst index 3f617f7358..0270887dc7 100644 --- a/doc/sphinx/arm/dhcp4-srv.rst +++ b/doc/sphinx/arm/dhcp4-srv.rst @@ -5679,7 +5679,11 @@ However, some of them are implications of the design choices made. Those are clearly marked as such. - BOOTP (`RFC 951 `__) is not - supported. This is a design choice; BOOTP support is not planned. + supported. This is a design choice; historic BOOTP support is not planned. + +- BOOTP with vendor information extensions + (`RFC 1497 `__) is supported + by the BOOTP hooks library; see :ref:`bootp-library` for details. - On Linux and BSD system families the DHCP messages are sent and received over the raw sockets (using LPF and BPF) and all packet diff --git a/doc/sphinx/arm/hooks.rst b/doc/sphinx/arm/hooks.rst index 449bbf330a..8f1d5da552 100644 --- a/doc/sphinx/arm/hooks.rst +++ b/doc/sphinx/arm/hooks.rst @@ -441,6 +441,10 @@ loaded by the correct process per the table below. | | |database. This library may only be used in conjuction with | | | |one of the supported configuration backend implementations. | +-----------------+---------------+------------------------------------------------------------+ + | BOOTP | Kea sources |The BOOTP hooks library recognizes received BOOTP requests: | + | | (since 1.7.2) |they are translated into DHCPREQUEST packets, put into the | + | | |BOOTP client class and get infinite lifetime leases. | + +-----------------+---------------+------------------------------------------------------------+ ISC hopes to see more hooks libraries become available as time progresses, developed both internally and externally. Since this list @@ -2775,6 +2779,30 @@ following: The ``network6-subnet-del`` command uses exactly the same syntax for both the command and the response. +.. _bootp-library: + +bootp BOOTP support +=================== + +This library adds support for BOOTP with vendor information extensions +(`RFC 1497 `__). Received BOOTP +requests are recognized, translated into DHCPREQUEST packets by adding +a dhcp-message-type option and put into the "BOOTP" client class. +Members of this class get infinite lifetime leases but the class can +be used too for instance to guard a pool of addresses. + +The library is available since Kea 1.7.2 and can be loaded in a +similar way as other hook libraries by the ``kea-dhp4`` process. +It takes no parameter. + +:: + + "Dhcp4": { + "hook_libraries": [ + { "library": "/usr/local/lib/libdhcp_bootp.so" }, + ... + ] + } .. include:: hooks-class-cmds.rst .. include:: hooks-cb-cmds.rst diff --git a/doc/sphinx/mes-files.txt b/doc/sphinx/mes-files.txt index 11b5feae5a..697508bede 100644 --- a/doc/sphinx/mes-files.txt +++ b/doc/sphinx/mes-files.txt @@ -1,3 +1,5 @@ +src/hooks/dhcp/flex_option/flex_option_messages.mes +src/hooks/dhcp/bootp/bootp_messages.mes src/hooks/dhcp/mysql_cb/mysql_cb_messages.mes src/hooks/dhcp/lease_cmds/lease_cmds_messages.mes src/hooks/dhcp/high_availability/ha_messages.mes -- 2.47.2