radius_backend.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 RADIUS_BACKEND_H
#define RADIUS_BACKEND_H
 
#include <dhcpsrv/base_host_data_source.h>
 
namespace isc {
namespace radius {
 
class RadiusBackendImpl;

class RadiusBackend : public isc::dhcp::BaseHostDataSource {
public:

    RadiusBackend();

    virtual ~RadiusBackend();


    virtual isc::dhcp::ConstHostCollection
    getAll(const isc::dhcp::Host::IdentifierType& identifier_type,
           const uint8_t* identifier_begin,
           const size_t identifier_len) const override;

    virtual isc::dhcp::ConstHostCollection
    getAll4(const isc::dhcp::SubnetID& subnet_id) const override;

    virtual isc::dhcp::ConstHostCollection
    getAll6(const isc::dhcp::SubnetID& subnet_id) const override;

    virtual isc::dhcp::ConstHostCollection
    getAllbyHostname(const std::string& hostname) const override;

    virtual isc::dhcp::ConstHostCollection
    getAllbyHostname4(const std::string& hostname,
                      const isc::dhcp::SubnetID& subnet_id) const override;

    virtual isc::dhcp::ConstHostCollection
    getAllbyHostname6(const std::string& hostname,
                      const isc::dhcp::SubnetID& subnet_id) const override;

    virtual isc::dhcp::ConstHostCollection
    getPage4(const isc::dhcp::SubnetID& subnet_id,
             size_t& source_index,
             uint64_t lower_host_id,
             const dhcp::HostPageSize& page_size) const override;

    virtual isc::dhcp::ConstHostCollection
    getPage6(const isc::dhcp::SubnetID& subnet_id,
             size_t& source_index,
             uint64_t lower_host_id,
             const dhcp::HostPageSize& page_size) const override;

    virtual isc::dhcp::ConstHostCollection
    getPage4(size_t& source_index,
             uint64_t lower_host_id,
             const dhcp::HostPageSize& page_size) const override;

    virtual isc::dhcp::ConstHostCollection
    getPage6(size_t& source_index,
             uint64_t lower_host_id,
             const dhcp::HostPageSize& page_size) const override;

    virtual isc::dhcp::ConstHostCollection
    getAll4(const isc::asiolink::IOAddress& address) const override;

    virtual isc::dhcp::ConstHostPtr
    get4(const isc::dhcp::SubnetID& subnet_id,
         const isc::dhcp::Host::IdentifierType& identifier_type,
         const uint8_t* identifier_begin,
         const size_t identifier_len) const override;

    virtual isc::dhcp::ConstHostPtr
    get4(const isc::dhcp::SubnetID& subnet_id,
         const isc::asiolink::IOAddress& address) const override;

    virtual isc::dhcp::ConstHostCollection
    getAll4(const isc::dhcp::SubnetID& subnet_id,
            const isc::asiolink::IOAddress& address) const override;

    virtual isc::dhcp::ConstHostPtr
    get6(const isc::dhcp::SubnetID& subnet_id,
         const isc::dhcp::Host::IdentifierType& identifier_type,
         const uint8_t* identifier_begin,
         const size_t identifier_len) const override;

    virtual isc::dhcp::ConstHostPtr
    get6(const isc::asiolink::IOAddress& prefix,
         const uint8_t prefix_len) const override;

    virtual isc::dhcp::ConstHostPtr
    get6(const isc::dhcp::SubnetID& subnet_id,
         const isc::asiolink::IOAddress& address) const override;

    virtual isc::dhcp::ConstHostCollection
    getAll6(const isc::dhcp::SubnetID& subnet_id,
            const isc::asiolink::IOAddress& address) const override;

    virtual dhcp::ConstHostCollection
    getAll6(const isc::asiolink::IOAddress& address) const override;

    virtual void add(const isc::dhcp::HostPtr& host) override;

    virtual bool del(const isc::dhcp::SubnetID& subnet_id,
                     const isc::asiolink::IOAddress& addr) override;

    virtual bool del4(const isc::dhcp::SubnetID& subnet_id,
                      const isc::dhcp::Host::IdentifierType& identifier_type,
                      const uint8_t* identifier_begin,
                      const size_t identifier_len) override;

    virtual bool del6(const isc::dhcp::SubnetID& subnet_id,
                      const isc::dhcp::Host::IdentifierType& identifier_type,
                      const uint8_t* identifier_begin,
                      const size_t identifier_len) override;

    virtual std::string getType() const override {
        return ("radius");
    }

    virtual bool setIPReservationsUnique(const bool unique) override;

    size_t getUnexpected4() const;

    size_t getUnexpected6() const;
 
protected:
    boost::shared_ptr<RadiusBackendImpl> impl_;
};

typedef boost::shared_ptr<RadiusBackend> RadiusBackendPtr;

class RadiusBackendImpl {
public:

    RadiusBackendImpl();

    virtual ~RadiusBackendImpl();


    isc::dhcp::ConstHostPtr
    get4(const isc::dhcp::SubnetID& subnet_id,
         const isc::dhcp::Host::IdentifierType& identifier_type,
         const uint8_t* identifier_begin,
         const size_t identifier_len);

    isc::dhcp::ConstHostPtr
    get6(const isc::dhcp::SubnetID& subnet_id,
         const isc::dhcp::Host::IdentifierType& identifier_type,
         const uint8_t* identifier_begin,
         const size_t identifier_len);

    size_t xcount4_;

    size_t xcount6_;
};
 
} // end of namespace radius
} // end of namespace isc
 
#endif // RADIUS_BACKEND_H