DwmDns-0.1.0
DwmDnsRRDataNSEC3PARAM.hh
Go to the documentation of this file.
1 //===========================================================================
2 // @(#) $DwmPath: dwm/DwmDns/tags/DwmDns-0.1.0/classes/include/DwmDnsRRDataNSEC3PARAM.hh 10132 $
3 // @(#) $Id: DwmDnsRRDataNSEC3PARAM.hh 10132 2018-01-27 17:25:04Z 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 _DWMDNSRRDATANSEC3PARAM_HH_
43 #define _DWMDNSRRDATANSEC3PARAM_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  //------------------------------------------------------------------------
59  //------------------------------------------------------------------------
61  : public RRData
62  {
63  public:
64  static const uint16_t k_rrtype = 51;
65 
66  //----------------------------------------------------------------------
68  //----------------------------------------------------------------------
70 
71  //----------------------------------------------------------------------
74  //----------------------------------------------------------------------
75  RRDataNSEC3PARAM(uint8_t algorithm, uint8_t flags, uint16_t iterations,
76  const std::string & salt);
77 
78  //----------------------------------------------------------------------
80  //----------------------------------------------------------------------
81  bool operator == (const RRDataNSEC3PARAM & nsec3param) const;
82 
83  //----------------------------------------------------------------------
85  //----------------------------------------------------------------------
86  uint8_t Algorithm() const;
87 
88  //----------------------------------------------------------------------
91  //----------------------------------------------------------------------
92  uint8_t Algorithm(uint8_t algorithm);
93 
94  //----------------------------------------------------------------------
96  //----------------------------------------------------------------------
97  uint8_t Flags() const;
98 
99  //----------------------------------------------------------------------
101  //----------------------------------------------------------------------
102  uint8_t Flags(uint8_t flags);
103 
104  //----------------------------------------------------------------------
106  //----------------------------------------------------------------------
107  uint16_t Iterations() const;
108 
109  //----------------------------------------------------------------------
111  //----------------------------------------------------------------------
112  uint16_t Iterations(uint16_t iterations);
113 
114  //----------------------------------------------------------------------
116  //----------------------------------------------------------------------
117  const std::string & Salt() const;
118 
119  //----------------------------------------------------------------------
121  //----------------------------------------------------------------------
122  const std::string & Salt(const std::string & salt);
123 
124  //----------------------------------------------------------------------
130  //----------------------------------------------------------------------
131  uint8_t *Encode(uint8_t *pkt, uint8_t *ptr, uint16_t pktlen,
132  LabelPositions & lps) const;
133 
134  //----------------------------------------------------------------------
140  //----------------------------------------------------------------------
141  const uint8_t *Decode(const uint8_t *pkt, const uint8_t *ptr,
142  uint16_t pktlen, uint16_t rdlen);
143 
144  //----------------------------------------------------------------------
147  //----------------------------------------------------------------------
148  friend std::ostream & operator << (std::ostream & os,
149  const RRDataNSEC3PARAM & param);
150 
151  private:
152  uint8_t _algorithm;
153  uint8_t _flags;
154  uint16_t _iterations;
155  std::string _salt;
156  };
157 
158  } // namespace Dns
159 
160 } // namespace Dwm
161 
162 #endif // _DWMDNSRRDATANSEC3PARAM_HH_
friend std::ostream & operator<<(std::ostream &os, const RRDataNSEC3PARAM &param)
Print the NSEC3PARAM resource record data to an ostream in human readable form.
uint16_t Iterations() const
Returns the iterations in the resource record data.
Encapsulates NSEC3PARAM resource record data.
Definition: DwmDnsRRDataNSEC3PARAM.hh:60
bool operator==(const RRDataNSEC3PARAM &nsec3param) const
Equal-to operator, mostly for unit testing.
uint8_t Algorithm() const
Returns the algorithm in the NSEC3PARAM resource record data.
const uint8_t * Decode(const uint8_t *pkt, const uint8_t *ptr, uint16_t pktlen, uint16_t rdlen)
Decodes the NSEC3PARAM resource record data from buffer pkt of length pktlen, starting at ptr...
Definition: DwmDnsEtcHosts.hh:60
uint8_t * Encode(uint8_t *pkt, uint8_t *ptr, uint16_t pktlen, LabelPositions &lps) const
Encodes the NSEC3PARAM resource record data into buffer @ pkt of length pktlen, starting at ptr...
Dwm::Dns::RRData class definition.
A helper class used when performing label sequence compression.
Definition: DwmDnsLabelPositions.hh:57
uint8_t Flags() const
Returns the flags in the resource record data.
const std::string & Salt() const
Returns the salt in the resource record data.
RRDataNSEC3PARAM()
Construct with an empty salt.
Abstract (pure virtual) base for resource record data classes.
Definition: DwmDnsRRData.hh:71