edns.h

Go to the documentation of this file.

// Copyright (C) 2010-2024 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 EDNS_H
#define EDNS_H
 
#include <util/buffer.h>
 
#include <stdint.h>
 
#include <boost/shared_ptr.hpp>
 
#include <ostream>
 
#include <dns/rdata.h>
 
namespace isc {
namespace dns {
 
class EDNS;
class Name;
class AbstractMessageRenderer;
class RRClass;
class RRTTL;
class RRType;
class Rcode;

typedef boost::shared_ptr<EDNS> EDNSPtr;

typedef boost::shared_ptr<const EDNS> ConstEDNSPtr;

class EDNS {
public:


    explicit EDNS(const uint8_t version = SUPPORTED_VERSION);

    EDNS(const Name& name, const RRClass& rrclass, const RRType& rrtype,
         const RRTTL& ttl, const rdata::Rdata& rdata);



    uint8_t getVersion() const { return (version_); }

    uint16_t getUDPSize() const { return (udp_size_); }

    void setUDPSize(const uint16_t udp_size) { udp_size_ = udp_size; }

    bool getDNSSECAwareness() const { return (dnssec_aware_); }

    void setDNSSECAwareness(const bool is_aware) { dnssec_aware_ = is_aware; }



    uint32_t toWire(AbstractMessageRenderer& renderer,
                    const uint8_t extended_rcode) const;

    uint32_t toWire(isc::util::OutputBuffer& buffer,
                    const uint8_t extended_rcode) const;

    std::string toText() const;
 
    // TBD: This method is currently not implemented.  We'll eventually need
    // something like this.
    //void addOption();
 
public:
    static const uint8_t SUPPORTED_VERSION = 0;
private:
    // We may eventually want to migrate to pimpl, especially when we support
    // EDNS options.  In this initial implementation, we keep it simple.
    const uint8_t version_;
    uint16_t udp_size_;
    bool dnssec_aware_;
};

EDNS* createEDNSFromRR(const Name& name, const RRClass& rrclass,
                       const RRType& rrtype, const RRTTL& ttl,
                       const rdata::Rdata& rdata, uint8_t& extended_rcode);

std::ostream& operator<<(std::ostream& os, const EDNS& edns);
}
}
#endif  // EDNS_H