kea-dhcp: automatic route support for PD leases

[fichtner]

Important notices

Before you add a new report, we ask you kindly to acknowledge the following:

• I have read the contributing guide lines at https://github.com/opnsense/core/blob/master/CONTRIBUTING.md
• I am convinced that my issue is new after having checked both open and closed issues at https://github.com/opnsense/core/issues?q=is%3Aissue

Is your feature request related to a problem? Please describe.

ISC DHCPv6 has prefixes.php to deal with this. We need a similar mechanism for Kea.

Describe the solution you like

Minimal scripting using available Kea hooks.

Describe alternatives you considered

Kea supporting this in a canonical way already.. ;)

Additional context

N/A

[Monviech]

KEA leases file with IA_NA and IA_PD:

cat /var/db/kea/kea-leases6.csv

Primary HA node

address,duid,valid_lifetime,expire,subnet_id,pref_lifetime,lease_type,iaid,prefix_len,fqdn_fwd,fqdn_rev,hostname,hwaddr,state,user_context,hwtype,hwaddr_source,pool_id
2003:ffff:ffff:ff01::100,00:01:00:01:30:2f:4a:3c:00:15:5d:00:ad:23,4000,1761047783,1,2500,0,0,128,0,0,,00:15:5d:00:ad:23,0,,1,2,0
2003:ffff:ffff:ff11::,00:01:00:01:30:2f:4a:3c:00:15:5d:00:ad:23,4000,1761047783,1,2500,2,0,64,0,0,,00:15:5d:00:ad:23,0,,1,2,0

Secondary HA node

address,duid,valid_lifetime,expire,subnet_id,pref_lifetime,lease_type,iaid,prefix_len,fqdn_fwd,fqdn_rev,hostname,hwaddr,state,user_context,hwtype,hwaddr_source,pool_id
2003:ffff:ffff:ff01::101,00:01:00:01:30:2f:4a:3c:00:15:5d:00:ad:23,4000,1761047783,1,2500,0,0,128,0,0,,00:15:5d:00:ad:23,0,,1,0,0
2003:ffff:ffff:ff11::,00:01:00:01:30:2f:4a:3c:00:15:5d:00:ad:23,4000,1761047783,1,2500,2,0,64,0,0,,00:15:5d:00:ad:23,0,,1,0,0

Example configuration:

"subnet6": [
    {
        "id": 1,
        "subnet": "2003:ffff:ffff:ff00::\/56",
        "option-data": [],
        "pools": [
            {
                "pool": "2003:ffff:ffff:ff01::100 - 2003:ffff:ffff:ff01::200"
            }
        ],
        "pd-pools": [
            {
                "prefix": "2003:ffff:ffff:ff10::",
                "prefix-len": 60,
                "delegated-len": 64
            }
        ],
        "reservations": [],
        "interface": "vlan0.2"
    }
]

[Monviech]

leases6_commited environment when hook script is called via /usr/local/lib/kea/hooks/libdhcp_run_script.so

REQUEST (leases6_commited)

DELETED_LEASES6_SIZE=0
LEASES6_AT0_ADDRESS=2003:ffff:ffff:ff01::101
LEASES6_AT0_CLTT=1761032532
LEASES6_AT0_DUID=00:01:00:01:30:2f:4a:3c:00:15:5d:00:ad:23
LEASES6_AT0_HOSTNAME=
LEASES6_AT0_HWADDR=00:15:5d:00:ad:23
LEASES6_AT0_HWADDR_TYPE=1
LEASES6_AT0_IAID=0
LEASES6_AT0_PREFERRED_LIFETIME=2500
LEASES6_AT0_PREFIX_LEN=128
LEASES6_AT0_STATE=default
LEASES6_AT0_SUBNET_ID=1
LEASES6_AT0_TYPE=IA_NA
LEASES6_AT0_VALID_LIFETIME=4000
LEASES6_AT1_ADDRESS=2003:ffff:ffff:ff11::
LEASES6_AT1_CLTT=1761032532
LEASES6_AT1_DUID=00:01:00:01:30:2f:4a:3c:00:15:5d:00:ad:23
LEASES6_AT1_HOSTNAME=
LEASES6_AT1_HWADDR=00:15:5d:00:ad:23
LEASES6_AT1_HWADDR_TYPE=1
LEASES6_AT1_IAID=0
LEASES6_AT1_PREFERRED_LIFETIME=2500
LEASES6_AT1_PREFIX_LEN=64
LEASES6_AT1_STATE=default
LEASES6_AT1_SUBNET_ID=1
LEASES6_AT1_TYPE=IA_PD
LEASES6_AT1_VALID_LIFETIME=4000
LEASES6_SIZE=2
QUERY6_CLIENT_ID=00:01:00:01:30:2f:4a:3c:00:15:5d:00:ad:23
QUERY6_IFACE_INDEX=23
QUERY6_IFACE_NAME=vlan0.2
QUERY6_LOCAL_ADDR=ff02::1:2
QUERY6_LOCAL_PORT=0
QUERY6_PROTO=UDP
QUERY6_REMOTE_ADDR=fe80::215:5dff:fe00:ad24
QUERY6_REMOTE_HWADDR=
QUERY6_REMOTE_HWADDR_TYPE=
QUERY6_REMOTE_PORT=546
QUERY6_TXID=1059936
QUERY6_TYPE=REQUEST

RENEW: (lease6_renew)

DELETED_LEASES6_SIZE=0
LEASES6_AT0_ADDRESS=2003:ffff:ffff:ff01::101
LEASES6_AT0_CLTT=1761033782
LEASES6_AT0_DUID=00:01:00:01:30:2f:4a:3c:00:15:5d:00:ad:23
LEASES6_AT0_HOSTNAME=
LEASES6_AT0_HWADDR=00:15:5d:00:ad:23
LEASES6_AT0_HWADDR_TYPE=1
LEASES6_AT0_IAID=0
LEASES6_AT0_PREFERRED_LIFETIME=2500
LEASES6_AT0_PREFIX_LEN=128
LEASES6_AT0_STATE=default
LEASES6_AT0_SUBNET_ID=1
LEASES6_AT0_TYPE=IA_NA
LEASES6_AT0_VALID_LIFETIME=4000
LEASES6_SIZE=1
QUERY6_CLIENT_ID=00:01:00:01:30:2f:4a:3c:00:15:5d:00:ad:23
QUERY6_IFACE_INDEX=23
QUERY6_IFACE_NAME=vlan0.2
QUERY6_LOCAL_ADDR=ff02::1:2
QUERY6_LOCAL_PORT=0
QUERY6_PROTO=UDP
QUERY6_REMOTE_ADDR=fe80::215:5dff:fe00:ad24
QUERY6_REMOTE_HWADDR=
QUERY6_REMOTE_HWADDR_TYPE=
QUERY6_REMOTE_PORT=546
QUERY6_TXID=9398482
QUERY6_TYPE=RENEW

----

LEASE6_ADDRESS=2003:ffff:ffff:ff11::
LEASE6_CLTT=1761033782
LEASE6_DUID=00:01:00:01:30:2f:4a:3c:00:15:5d:00:ad:23
LEASE6_HOSTNAME=
LEASE6_HWADDR=00:15:5d:00:ad:23
LEASE6_HWADDR_TYPE=1
LEASE6_IAID=0
LEASE6_PREFERRED_LIFETIME=2500
LEASE6_PREFIX_LEN=64
LEASE6_STATE=default
LEASE6_SUBNET_ID=1
LEASE6_TYPE=IA_PD
LEASE6_VALID_LIFETIME=4000
PKT6_IA_IAID=0
PKT6_IA_IA_T1=0
PKT6_IA_IA_T2=0
PKT6_IA_IA_TYPE=25
QUERY6_CLIENT_ID=00:01:00:01:30:2f:4a:3c:00:15:5d:00:ad:23
QUERY6_IFACE_INDEX=23
QUERY6_IFACE_NAME=vlan0.2
QUERY6_LOCAL_ADDR=ff02::1:2
QUERY6_LOCAL_PORT=0
QUERY6_PROTO=UDP
QUERY6_REMOTE_ADDR=fe80::215:5dff:fe00:ad24
QUERY6_REMOTE_HWADDR=
QUERY6_REMOTE_HWADDR_TYPE=
QUERY6_REMOTE_PORT=546
QUERY6_TXID=13175939
QUERY6_TYPE=RENEW

[Monviech]

Here is another configuration + lease file using ULA addresses:

        "subnet6": [
            {
                "id": 1,
                "subnet": "fd80::\/64",
                "option-data": [],
                "pools": [
                    {
                        "pool": "fd80::100-fd80::199"
                    }
                ],
                "pd-pools": [
                    {
                        "prefix": "fd80:0:0:100::",
                        "prefix-len": 56,
                        "delegated-len": 60
                    }
                ],
                "reservations": [],
                "interface": "hn0"
            }
        ],

Lease file:

root@opn-dev-02:~ # cat /var/db/kea/kea-leases6.csv
address,duid,valid_lifetime,expire,subnet_id,pref_lifetime,lease_type,iaid,prefix_len,fqdn_fwd,fqdn_rev,hostname,hwaddr,state,user_context,hwtype,hwaddr_source,pool_id
fd80::100,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,4000,1761751106,1,2500,0,3,128,0,0,,00:15:5d:00:ad:29,0,,1,2,0
fd80:0:0:100::,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,4000,1761751106,1,2500,2,3,60,0,0,,00:15:5d:00:ad:29,0,,1,2,0
fd80::100,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,4000,1761752189,1,2500,0,3,128,0,0,,00:15:5d:00:ad:29,0,,1,0,0
fd80::101,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761748584,1,0,0,1,128,0,0,,00:15:5d:00:ad:29,2,,1,0,0
fd80:0:0:100::,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,4000,1761752189,1,2500,2,3,60,0,0,,00:15:5d:00:ad:29,0,,1,0,0
fd80:0:0:110::,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761748584,1,0,2,1,60,0,0,,00:15:5d:00:ad:29,2,,1,0,0
fd80::101,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761748584,1,0,0,1,128,0,0,,00:15:5d:00:ad:29,2,,1,0,0
fd80:0:0:110::,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761748584,1,0,2,1,60,0,0,,00:15:5d:00:ad:29,2,,1,0,0
fd80:0:0:100::,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761748189,1,0,2,3,60,0,0,,00:15:5d:00:ad:29,3,,1,0,0
fd80::100,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761748189,1,0,0,3,128,0,0,,00:15:5d:00:ad:29,3,,1,0,0
fd80:0:0:100::,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761748189,1,0,2,3,60,0,0,,00:15:5d:00:ad:29,2,,1,0,0
fd80::100,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761748189,1,0,0,3,128,0,0,,00:15:5d:00:ad:29,2,,1,0,0
fd80::100,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,4000,1761753298,1,2500,0,3,128,0,0,,00:15:5d:00:ad:29,0,,1,0,0
fd80:0:0:100::,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,4000,1761753298,1,2500,2,3,60,0,0,,00:15:5d:00:ad:29,0,,1,0,0
fd80::100,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761749298,1,0,0,3,128,0,0,,00:15:5d:00:ad:29,3,,1,0,0
fd80:0:0:100::,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761749298,1,0,2,3,60,0,0,,00:15:5d:00:ad:29,3,,1,0,0
fd80::100,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761749298,1,0,0,3,128,0,0,,00:15:5d:00:ad:29,2,,1,0,0
fd80:0:0:100::,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761749298,1,0,2,3,60,0,0,,00:15:5d:00:ad:29,2,,1,0,0
fd80::100,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,4000,1761753403,1,2500,0,3,128,0,0,,00:15:5d:00:ad:29,0,,1,0,0
fd80:0:0:100::,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,4000,1761753403,1,2500,2,3,60,0,0,,00:15:5d:00:ad:29,0,,1,0,0
fd80::100,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761749403,1,0,0,3,128,0,0,,00:15:5d:00:ad:29,3,,1,0,0
fd80:0:0:100::,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761749403,1,0,2,3,60,0,0,,00:15:5d:00:ad:29,3,,1,0,0
fd80::100,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761749403,1,0,0,3,128,0,0,,00:15:5d:00:ad:29,2,,1,0,0
fd80:0:0:100::,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761749403,1,0,2,3,60,0,0,,00:15:5d:00:ad:29,2,,1,0,0
fd80::100,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,4000,1761753447,1,2500,0,3,128,0,0,,00:15:5d:00:ad:29,0,,1,0,0
fd80:0:0:100::,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,4000,1761753447,1,2500,2,3,60,0,0,,00:15:5d:00:ad:29,0,,1,0,0
fd80::100,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761749447,1,0,0,3,128,0,0,,00:15:5d:00:ad:29,3,,1,0,0
fd80:0:0:100::,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761749447,1,0,2,3,60,0,0,,00:15:5d:00:ad:29,3,,1,0,0
fd80::100,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761749447,1,0,0,3,128,0,0,,00:15:5d:00:ad:29,2,,1,0,0
fd80:0:0:100::,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,0,1761749447,1,0,2,3,60,0,0,,00:15:5d:00:ad:29,2,,1,0,0
fd80::101,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,4000,1761753635,1,2500,0,1,128,0,0,,00:15:5d:00:ad:29,0,,1,0,0
fd80:0:0:110::,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,4000,1761753635,1,2500,2,1,60,0,0,,00:15:5d:00:ad:29,0,,1,0,0
fd80::101,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,4000,1761754885,1,2500,0,1,128,0,0,,00:15:5d:00:ad:29,0,,1,0,0
fd80:0:0:110::,00:01:00:01:30:94:dd:1f:00:15:5d:00:ad:29,4000,1761754885,1,2500,2,1,60,0,0,,00:15:5d:00:ad:29,0,,1,0,0