DwmDns-0.1.0
DwmDnsRRDataCERT.hh
Go to the documentation of this file.
1 //===========================================================================
2 // @(#) $DwmPath: dwm/DwmDns/tags/DwmDns-0.1.0/classes/include/DwmDnsRRDataCERT.hh 10129 $
3 // @(#) $Id: DwmDnsRRDataCERT.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 _DWMDNSRRDATACERT_HH_
43 #define _DWMDNSRRDATACERT_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  // xxx - TODO: breakdown of cerrtificate data, which varies by type.
59  //------------------------------------------------------------------------
60  class RRDataCERT
61  : public RRData
62  {
63  public:
64  static const uint16_t k_rrtype = 37;
65 
66  static const uint16_t k_typePKIX = 1;
67  static const uint16_t k_typeSPKI = 2;
68  static const uint16_t k_typePGP = 3;
69  static const uint16_t k_typeIPKIX = 4;
70  static const uint16_t k_typeISPKI = 5;
71  static const uint16_t k_typeIPGP = 6;
72  static const uint16_t k_typeACPKIX = 7;
73  static const uint16_t k_typeIACPKIX = 8;
74  static const uint16_t k_typeURI = 253;
75  static const uint16_t k_typeOID = 254;
76 
77  static const uint8_t k_algorithmReserved = 0;
78  static const uint8_t k_algorithmRSAMD5 = 1;
79  static const uint8_t k_algorithmDH = 2;
80  static const uint8_t k_algorithmDSA = 3;
81  static const uint8_t k_algorithmECC = 4;
82 
83  //----------------------------------------------------------------------
85  //----------------------------------------------------------------------
86  RRDataCERT();
87 
88  //----------------------------------------------------------------------
91  //----------------------------------------------------------------------
92  RRDataCERT(uint16_t type, uint16_t keyTag, uint8_t algorithm,
93  const std::string & certificate);
94 
95  //----------------------------------------------------------------------
97  //----------------------------------------------------------------------
98  bool operator == (const RRDataCERT & cert) const;
99 
100  //----------------------------------------------------------------------
102  //----------------------------------------------------------------------
103  uint16_t Type() const;
104 
105  //----------------------------------------------------------------------
107  //----------------------------------------------------------------------
108  uint16_t Type(uint16_t type);
109 
110  //----------------------------------------------------------------------
112  //----------------------------------------------------------------------
113  uint16_t KeyTag() const;
114 
115  //----------------------------------------------------------------------
117  //----------------------------------------------------------------------
118  uint16_t KeyTag(uint16_t keyTag);
119 
120  //----------------------------------------------------------------------
122  //----------------------------------------------------------------------
123  uint8_t Algorithm() const;
124 
125  //----------------------------------------------------------------------
127  //----------------------------------------------------------------------
128  uint8_t Algorithm(uint8_t algorithm);
129 
130  //----------------------------------------------------------------------
132  //----------------------------------------------------------------------
133  const std::string & Certificate() const;
134 
135  //----------------------------------------------------------------------
137  //----------------------------------------------------------------------
138  const std::string & Certificate(const std::string & certificate);
139 
140  //----------------------------------------------------------------------
146  //----------------------------------------------------------------------
147  uint8_t *Encode(uint8_t *pkt, uint8_t *ptr, uint16_t pktlen,
148  LabelPositions & lps) const;
149 
150  //----------------------------------------------------------------------
156  //----------------------------------------------------------------------
157  const uint8_t *Decode(const uint8_t *pkt, const uint8_t *ptr,
158  uint16_t pktlen, uint16_t rdlen);
159 
160  //----------------------------------------------------------------------
163  //----------------------------------------------------------------------
164  friend std::ostream & operator << (std::ostream & os,
165  const RRDataCERT & cert);
166 
167  private:
168  uint16_t _type;
169  uint16_t _keyTag;
170  uint8_t _algorithm;
171  std::string _certificate;
172  };
173 
174  } // namespace Dns
175 
176 } // namespace Dwm
177 
178 #endif // _DWMDNSRRDATACERT_HH_
RRDataCERT()
Constructor.
Encapsulates CERT resource record data.
Definition: DwmDnsRRDataCERT.hh:60
uint16_t KeyTag() const
Returns the key tag in the CERT resource record data.
uint16_t Type() const
Returns the type in the CERT resource record data.
uint8_t * Encode(uint8_t *pkt, uint8_t *ptr, uint16_t pktlen, LabelPositions &lps) const
Encodes the CERT resource record data into buffer @ pkt of length pktlen, starting at ptr...
Definition: DwmDnsEtcHosts.hh:60
const uint8_t * Decode(const uint8_t *pkt, const uint8_t *ptr, uint16_t pktlen, uint16_t rdlen)
Decodes the CERT resource record data from buffer pkt of length pktlen, starting at ptr...
const std::string & Certificate() const
Returns the certificate in the CERT resource record data.
Dwm::Dns::RRData class definition.
uint8_t Algorithm() const
Returns the algorithm in the CERT resource record data.
bool operator==(const RRDataCERT &cert) const
Equal-to operator, mostly for unit testing.
A helper class used when performing label sequence compression.
Definition: DwmDnsLabelPositions.hh:57
friend std::ostream & operator<<(std::ostream &os, const RRDataCERT &cert)
Print the CERT resource record data to an ostream in human readable form.
Abstract (pure virtual) base for resource record data classes.
Definition: DwmDnsRRData.hh:71