d2_update_message.h

Go to the documentation of this file.

// Copyright (C) 2013-2026 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 D2_UPDATE_MESSAGE_H
#define D2_UPDATE_MESSAGE_H
 
#include <d2srv/d2_zone.h>
#include <dns/message.h>
#include <dns/name.h>
#include <dns/rcode.h>
#include <dns/rrclass.h>
#include <dns/rrset.h>
#include <dns/tsig.h>
 
#include <cstdint>
#include <map>
 
namespace isc {
namespace d2 {

class InvalidZoneSection : public Exception {
public:
    InvalidZoneSection(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) {}
};

class InvalidQRFlag : public Exception {
public:
    InvalidQRFlag(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) {}
};

class NotUpdateMessage : public Exception {
public:
    NotUpdateMessage(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) {}
};

class TSIGVerifyError : public Exception {
public:
    TSIGVerifyError(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) {}
};
 
 
class D2UpdateMessage;

typedef boost::shared_ptr<D2UpdateMessage> D2UpdateMessagePtr;

class D2UpdateMessage {
public:

    enum Direction : uint16_t {
        INBOUND,
        OUTBOUND
    };

    enum QRFlag : uint16_t {
        REQUEST,
        RESPONSE
    };

    enum UpdateMsgSection : uint16_t {
        SECTION_ZONE,
        SECTION_PREREQUISITE,
        SECTION_UPDATE,
        SECTION_ADDITIONAL
    };
 
public:
    D2UpdateMessage(const Direction direction = OUTBOUND);


private:
    D2UpdateMessage(const D2UpdateMessage& source);
    D2UpdateMessage& operator=(const D2UpdateMessage& source);
 
public:

    QRFlag getQRFlag() const;

    uint16_t getId() const;

    void setId(const uint16_t id);

    const dns::Rcode& getRcode() const;

    void setRcode(const dns::Rcode& rcode);

    unsigned int getRRCount(const UpdateMsgSection section) const;



    const dns::RRsetIterator beginSection(const UpdateMsgSection section) const;

    const dns::RRsetIterator endSection(const UpdateMsgSection section) const;

    void setZone(const dns::Name& zone, const dns::RRClass& rrclass);

    D2ZonePtr getZone() const;

    void addRRset(const UpdateMsgSection section, const dns::RRsetPtr& rrset);



    void toWire(dns::AbstractMessageRenderer& renderer,
                dns::TSIGContext* const tsig_ctx = NULL);

    void fromWire(const void* received_data, size_t bytes_received,
                  dns::TSIGContext* const tsig_context = NULL);
 
private:
    static
    dns::Message::Section ddnsToDnsSection(const UpdateMsgSection section);

    void validateResponse() const;

    dns::Message message_;

    D2ZonePtr zone_;
 
};
 
} // namespace d2
} // namespace isc
 
#endif // D2_UPDATE_MESSAGE_H