lease_query_impl6.h

Go to the documentation of this file.

// Copyright (C) 2020-2025 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
#ifndef LEASE_QUERY_IMPL6_H
#define LEASE_QUERY_IMPL6_H
 
#include <config.h>
 
#include <asiolink/io_address.h>
#include <dhcp/dhcp6.h>
#include <dhcp/option6_iaaddr.h>
#include <dhcp/option6_status_code.h>
#include <dhcp/option_custom.h>
#include <dhcp/pkt6.h>
#include <dhcpsrv/lease.h>
#include <dhcpsrv/cfgmgr.h>
#include <lease_query_impl.h>
 
namespace isc {
namespace lease_query {

typedef boost::shared_ptr<dhcp::Pkt6::RelayInfo> RelayInfoPtr;
 

typedef std::set<uint8_t> PrefixLengthList;

class LeaseQueryImpl6 : public LeaseQueryImpl {
public:
    LeaseQueryImpl6(const data::ConstElementPtr config);

    virtual ~LeaseQueryImpl6(){};

    virtual void processQuery(dhcp::PktPtr base_query) const;

    static dhcp::Option6StatusCodePtr
    queryByIpAddress(const asiolink::IOAddress& iaaddr,
                     dhcp::Lease6Collection& leases,
                     const PrefixLengthList& prefix_lengths = PrefixLengthList());

    static dhcp::Option6StatusCodePtr
    queryByClientId(const dhcp::DuidPtr& client_id,
                    const asiolink::IOAddress& link_addr,
                    dhcp::Lease6Collection& leases);

    static dhcp::Option6StatusCodePtr
    queryByRelayIdStart(const dhcp::DuidPtr& relay_id,
                        asiolink::IOAddress& start_addr,
                        const size_t page_size,
                        const asiolink::IOAddress& link_addr,
                        dhcp::SubnetIDSet& links,
                        dhcp::Lease6Collection& leases);

    static void queryByRelayIdNext(const dhcp::DuidPtr& relay_id,
                                   asiolink::IOAddress& start_addr,
                                   const size_t page_size,
                                   const dhcp::SubnetIDSet& links,
                                   dhcp::Lease6Collection& leases);

    static dhcp::Option6StatusCodePtr
    queryByRemoteIdStart(const dhcp::OptionBuffer& remote_id,
                         asiolink::IOAddress& start_addr,
                         const size_t page_size,
                         const asiolink::IOAddress& link_addr,
                         dhcp::SubnetIDSet& links,
                         dhcp::Lease6Collection& leases);

    static void queryByRemoteIdNext(const dhcp::OptionBuffer& remote_id,
                                    asiolink::IOAddress& start_addr,
                                    const size_t page_size,
                                    const dhcp::SubnetIDSet& links,
                                    dhcp::Lease6Collection& leases);

    static dhcp::Option6StatusCodePtr
    queryByLinkStart(asiolink::IOAddress& start_addr,
                     const size_t page_size,
                     const asiolink::IOAddress& link_addr,
                     dhcp::SubnetIDSet& links,
                     dhcp::Lease6Collection& leases);

    static void queryByLinkNext(asiolink::IOAddress& start_addr,
                                const size_t page_size,
                                dhcp::SubnetIDSet& links,
                                dhcp::Lease6Collection& leases);

    static dhcp::Pkt6Ptr buildReply(const dhcp::Option6StatusCodePtr& status,
                                    const dhcp::Pkt6Ptr& query,
                                    dhcp::Lease6Collection& leases);

    static dhcp::Pkt6Ptr initReply(const dhcp::Pkt6Ptr& query);

    static dhcp::Pkt6Ptr initData(const dhcp::Pkt6Ptr& query);

    static dhcp::Pkt6Ptr initDone(const dhcp::Pkt6Ptr& query);

    //  or
    static dhcp::OptionPtr makeClientOption(dhcp::Lease6Collection& leases);

    static dhcp::OptionPtr makeClientOption(dhcp::Lease6Ptr lease);

    static dhcp::OptionPtr makeRelayOption(const dhcp::Lease6& lease);

    static uint16_t getRelayOverhead(const dhcp::Pkt6::RelayInfo& relay, bool innermost);

    static void parseRelayInfoList(data::ConstElementPtr relays,
                                   std::vector<RelayInfoPtr>& relay_infos);

    static RelayInfoPtr parseRelayInfo(data::ConstElementPtr relay);

    static void testServerId(const dhcp::Pkt6Ptr& query);

    static dhcp::Option6StatusCodePtr makeStatusOption(const DHCPv6StatusCode&
                                                       status_code,
                                                       const std::string message = "");

    void sendResponse(const dhcp::Pkt6Ptr& response) const;

    virtual void send(const dhcp::Pkt6Ptr& response) const;

    static std::string leaseQueryLabel(const dhcp::Pkt6Ptr& packet);

    static int upgradeHandler(hooks::CalloutHandle& handle);

    static asiolink::IOAddress getPrefixFromAddress(const asiolink::IOAddress& address,
                                                    const uint8_t prefix_length);

    void addPrefixLength(uint8_t prefix_len) {
        if (prefix_len > 0 && prefix_len <= 128) {
            prefix_lens_.insert(prefix_len);
        }
    }

    void clearPrefixLengthList() {
        prefix_lens_.clear();
    }

    const PrefixLengthList& getPrefixLengthList() const {
        return (prefix_lens_);
    }

    void populatePrefixLengthList(dhcp::SrvConfigPtr cfg);

    static std::string dumpPrefixLengthList(const PrefixLengthList& prefix_lengths);

    mutable PrefixLengthList prefix_lens_;

    bool build_prefix_lens_;
};

typedef boost::shared_ptr<LeaseQueryImpl6> LeaseQueryImpl6Ptr;
 
} // end of namespace isc::lease_query
} // end of namespace isc
 
#endif // LEASE_QUERY_IMPL6_H