DwmDns-0.1.0
DwmDnsRRDataNSEC.hh
Go to the documentation of this file.
1 //===========================================================================
2 // @(#) $DwmPath: dwm/DwmDns/tags/DwmDns-0.1.0/classes/include/DwmDnsRRDataNSEC.hh 10129 $
3 // @(#) $Id: DwmDnsRRDataNSEC.hh 10129 2018-01-27 04:20:26Z dwm $
4 //===========================================================================
5 // Copyright (c) Daniel W. McRobb 2018
6 // All rights reserved.
7 //
8 // Redistribution and use in source and binary forms, with or without
9 // modification, are permitted provided that the following conditions
10 // are met:
11 //
12 // 1. Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // 2. Redistributions in binary form must reproduce the above copyright
15 // notice, this list of conditions and the following disclaimer in the
16 // documentation and/or other materials provided with the distribution.
17 // 3. The names of the authors and copyright holders may not be used to
18 // endorse or promote products derived from this software without
19 // specific prior written permission.
20 //
21 // IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
22 // DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
23 // INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
24 // EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
25 // DAMAGE.
26 //
27 // THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
28 // DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
29 // UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
30 // REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
31 // IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
32 // WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
33 // OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
34 // TRADEMARK OR OTHER RIGHTS.
35 //===========================================================================
36 
37 //---------------------------------------------------------------------------
40 //---------------------------------------------------------------------------
41 
42 #ifndef _DWMDNSRRDATANSEC_HH_
43 #define _DWMDNSRRDATANSEC_HH_
44 
45 #include <cstdint>
46 #include <iostream>
47 #include <string>
48 #include <vector>
49 
50 #include "DwmDnsNSECBitmap.hh"
51 #include "DwmDnsRRData.hh"
52 
53 namespace Dwm {
54 
55  namespace Dns {
56 
57  //------------------------------------------------------------------------
60  //------------------------------------------------------------------------
61  class RRDataNSEC
62  : public RRData
63  {
64  public:
65  static const uint16_t k_rrtype = 47;
66 
67  //----------------------------------------------------------------------
69  //----------------------------------------------------------------------
70  RRDataNSEC();
71 
72  //----------------------------------------------------------------------
74  //----------------------------------------------------------------------
75  RRDataNSEC(const std::string & nextDomainName,
76  const std::vector<NSECBitmap> & bitmaps);
77 
78  //----------------------------------------------------------------------
80  //----------------------------------------------------------------------
81  bool operator == (const RRDataNSEC & nsec) const;
82 
83  //----------------------------------------------------------------------
85  //----------------------------------------------------------------------
86  const std::string & NextDomainName() const;
87 
88  //----------------------------------------------------------------------
90  //----------------------------------------------------------------------
91  const std::string & NextDomainName(const std::string & domainName);
92 
93  //----------------------------------------------------------------------
95  //----------------------------------------------------------------------
96  const std::vector<NSECBitmap> & Bitmaps() const;
97 
98  //----------------------------------------------------------------------
100  //----------------------------------------------------------------------
101  const std::vector<NSECBitmap> &
102  Bitmaps(const std::vector<NSECBitmap> & bitmaps);
103 
104  //----------------------------------------------------------------------
110  //----------------------------------------------------------------------
111  uint8_t *Encode(uint8_t *pkt, uint8_t *ptr, uint16_t pktlen,
112  LabelPositions & lps) const;
113 
114  //----------------------------------------------------------------------
120  //----------------------------------------------------------------------
121  const uint8_t *Decode(const uint8_t *pkt, const uint8_t *ptr,
122  uint16_t pktlen, uint16_t rdlen);
123 
124  //----------------------------------------------------------------------
127  //----------------------------------------------------------------------
128  friend std::ostream & operator << (std::ostream & os,
129  const RRDataNSEC & nsec);
130 
131  private:
132  std::string _nextDomainName;
133  std::vector<NSECBitmap> _bitmaps;
134  };
135 
136  } // namespace Dns
137 
138 } // namespace Dwm
139 
140 #endif // _DWMDNSRRDATANSEC_HH_
const std::string & NextDomainName() const
Returns the contained next domain name.
const uint8_t * Decode(const uint8_t *pkt, const uint8_t *ptr, uint16_t pktlen, uint16_t rdlen)
Decodes the NSEC resource record data from buffer pkt of length pktlen, starting at ptr...
Encapsulates NSEC resource record data.
Definition: DwmDnsRRDataNSEC.hh:61
const std::vector< NSECBitmap > & Bitmaps() const
Returns the contained bitmaps.
Dwm::Dns::NSECBitmap class definition.
RRDataNSEC()
Construct with empty next domain name and empty bitmaps.
bool operator==(const RRDataNSEC &nsec) const
Equal-to operator, mostly for unit testing.
uint8_t * Encode(uint8_t *pkt, uint8_t *ptr, uint16_t pktlen, LabelPositions &lps) const
Encodes the NSEC resource record data into buffer @ pkt of length pktlen, starting at ptr...
Definition: DwmDnsEtcHosts.hh:60
Dwm::Dns::RRData class definition.
A helper class used when performing label sequence compression.
Definition: DwmDnsLabelPositions.hh:57
friend std::ostream & operator<<(std::ostream &os, const RRDataNSEC &nsec)
Print the NSEC resource record data to an ostream in human readable form.
Abstract (pure virtual) base for resource record data classes.
Definition: DwmDnsRRData.hh:71