DwmDns-0.1.0
DwmDnsRRDataDS.hh
Go to the documentation of this file.
1 //===========================================================================
2 // @(#) $DwmPath: dwm/DwmDns/tags/DwmDns-0.1.0/classes/include/DwmDnsRRDataDS.hh 10129 $
3 // @(#) $Id: DwmDnsRRDataDS.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 _DWMDNSRRDATADS_HH_
43 #define _DWMDNSRRDATADS_HH_
44 
45 #include <cstdint>
46 #include <iostream>
47 #include <string>
48 
49 #include "DwmDnsRRData.hh"
50 
51 namespace Dwm {
52 
53  namespace Dns {
54 
55  //------------------------------------------------------------------------
58  //------------------------------------------------------------------------
59  class RRDataDS
60  : public RRData
61  {
62  public:
63  static const uint16_t k_rrtype = 43;
64 
65  static const uint8_t k_digestTypeReserved = 0;
66  static const uint8_t k_digestTypeSHA1 = 1;
67 
68  static const uint8_t k_algorithmReserved = 0;
69  static const uint8_t k_algorithmRSAMD5 = 1; // not recommended
70  static const uint8_t k_algorithmDH = 2;
71  static const uint8_t k_algorithmDSA = 3; // optional
72  static const uint8_t k_algorithmECC = 4;
73  static const uint8_t k_algorithmRSASHA1 = 5; // mandatory
74  static const uint8_t k_algorithmINDIRECT = 252;
75  static const uint8_t k_algorithmPRIVATEDNS = 253; // optional
76  static const uint8_t k_algorithmPRIVATEOID = 254; // optional
77 
78  //----------------------------------------------------------------------
80  //----------------------------------------------------------------------
81  RRDataDS();
82 
83  //----------------------------------------------------------------------
86  //----------------------------------------------------------------------
87  RRDataDS(uint16_t keyTag, uint8_t algorithm, uint8_t digestType,
88  const std::string & digest);
89 
90  //----------------------------------------------------------------------
92  //----------------------------------------------------------------------
93  bool operator == (const RRDataDS & ds) const;
94 
95  //----------------------------------------------------------------------
97  //----------------------------------------------------------------------
98  uint16_t KeyTag() const;
99 
100  //----------------------------------------------------------------------
102  //----------------------------------------------------------------------
103  uint16_t KeyTag(uint16_t keyTag);
104 
105  //----------------------------------------------------------------------
107  //----------------------------------------------------------------------
108  uint8_t Algorithm() const;
109 
110  //----------------------------------------------------------------------
112  //----------------------------------------------------------------------
113  uint8_t Algorithm(uint8_t algorithm);
114 
115  //----------------------------------------------------------------------
117  //----------------------------------------------------------------------
118  uint8_t DigestType() const;
119 
120  //----------------------------------------------------------------------
122  //----------------------------------------------------------------------
123  uint8_t DigestType(uint16_t digestType);
124 
125  //----------------------------------------------------------------------
127  //----------------------------------------------------------------------
128  const std::string & Digest() const;
129 
130  //----------------------------------------------------------------------
132  //----------------------------------------------------------------------
133  const std::string & Digest(const std::string & digest);
134 
135  //----------------------------------------------------------------------
141  //----------------------------------------------------------------------
142  uint8_t *Encode(uint8_t *pkt, uint8_t *ptr, uint16_t pktlen,
143  LabelPositions & lps) const;
144 
145  //----------------------------------------------------------------------
151  //----------------------------------------------------------------------
152  const uint8_t *Decode(const uint8_t *pkt, const uint8_t *ptr,
153  uint16_t pktlen, uint16_t rdlen);
154 
155  //----------------------------------------------------------------------
158  //----------------------------------------------------------------------
159  friend std::ostream & operator << (std::ostream & os,
160  const RRDataDS & ds);
161 
162  private:
163  uint16_t _keyTag;
164  uint8_t _algorithm;
165  uint8_t _digestType;
166  std::string _digest;
167  };
168 
169  } // namespace Dns
170 
171 } // namespace Dwm
172 
173 #endif // _DWMDNSRRDATADS_HH_
uint16_t KeyTag() const
Returns the key tag in the DS resource record data.
friend std::ostream & operator<<(std::ostream &os, const RRDataDS &ds)
Print the DS resource record data to an ostream in human readable form.
uint8_t * Encode(uint8_t *pkt, uint8_t *ptr, uint16_t pktlen, LabelPositions &lps) const
Encodes the DS resource record data into buffer @ pkt of length pktlen, starting at ptr...
uint8_t DigestType() const
Returns the digest type in the DS resource record data.
Definition: DwmDnsEtcHosts.hh:60
RRDataDS()
Constructs an empty DS resource record data object.
bool operator==(const RRDataDS &ds) const
Equal-to operator, mostly for unit testing.
Dwm::Dns::RRData class definition.
const uint8_t * Decode(const uint8_t *pkt, const uint8_t *ptr, uint16_t pktlen, uint16_t rdlen)
Decodes the DS resource record data from buffer pkt of length pktlen, starting at ptr...
const std::string & Digest() const
Returns the digest in the DS resource record data.
A helper class used when performing label sequence compression.
Definition: DwmDnsLabelPositions.hh:57
uint8_t Algorithm() const
Returns the algorithm in the DS resource record data.
Abstract (pure virtual) base for resource record data classes.
Definition: DwmDnsRRData.hh:71
Encapsulates DS resource record data.
Definition: DwmDnsRRDataDS.hh:59