DwmDns-0.1.0
DwmDnsRRDataSSHFP.hh
Go to the documentation of this file.
1 //===========================================================================
2 // @(#) $DwmPath: dwm/DwmDns/tags/DwmDns-0.1.0/classes/include/DwmDnsRRDataSSHFP.hh 10129 $
3 // @(#) $Id: DwmDnsRRDataSSHFP.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 _DWMDNSRRDATASSHFP_HH_
43 #define _DWMDNSRRDATASSHFP_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  //------------------------------------------------------------------------
60  : public RRData
61  {
62  public:
63  static const uint16_t k_rrtype = 44;
64 
65  // algorithms (RFC4255 section 3.1.1)
66  static const uint8_t k_algorithmReserved = 0;
67  static const uint8_t k_algorithmRSA = 1;
68  static const uint8_t k_algorithmDSS = 2;
69 
70  // fingerprint types (RFC4255 section 3.1.2)
71  static const uint8_t k_fpTypeReserved = 0;
72  static const uint8_t k_fpTypeSHA1 = 1;
73 
74  //----------------------------------------------------------------------
76  //----------------------------------------------------------------------
77  RRDataSSHFP();
78 
79  //----------------------------------------------------------------------
82  //----------------------------------------------------------------------
83  RRDataSSHFP(uint8_t algorithm, uint8_t fpType,
84  const std::string & fingerprint);
85 
86  //----------------------------------------------------------------------
88  //----------------------------------------------------------------------
89  bool operator == (const RRDataSSHFP & sshfp) const;
90 
91  //----------------------------------------------------------------------
93  //----------------------------------------------------------------------
94  uint8_t Algorithm() const;
95 
96  //----------------------------------------------------------------------
98  //----------------------------------------------------------------------
99  uint8_t Algorithm(uint8_t algorithm);
100 
101  //----------------------------------------------------------------------
103  //----------------------------------------------------------------------
104  uint8_t FPType() const;
105 
106  //----------------------------------------------------------------------
108  //----------------------------------------------------------------------
109  uint8_t FPType(uint8_t fpType);
110 
111  //----------------------------------------------------------------------
113  //----------------------------------------------------------------------
114  const std::string & Fingerprint() const;
115 
116  //----------------------------------------------------------------------
118  //----------------------------------------------------------------------
119  const std::string & Fingerprint(const std::string & fingerprint);
120 
121  //----------------------------------------------------------------------
127  //----------------------------------------------------------------------
128  uint8_t *Encode(uint8_t *pkt, uint8_t *ptr, uint16_t pktlen,
129  LabelPositions & lps) const;
130 
131  //----------------------------------------------------------------------
137  //----------------------------------------------------------------------
138  const uint8_t *Decode(const uint8_t *pkt, const uint8_t *ptr,
139  uint16_t pktlen, uint16_t rdlen);
140 
141  //----------------------------------------------------------------------
144  //----------------------------------------------------------------------
145  friend std::ostream & operator << (std::ostream & os,
146  const RRDataSSHFP & sshfp);
147 
148  private:
149  uint8_t _algorithm;
150  uint8_t _fpType;
151  std::string _fingerprint;
152  };
153 
154  } // namespace Dns
155 
156 } // namespace Dwm
157 
158 #endif // _DWMDNSRRDATASSHFP_HH_
uint8_t FPType() const
Returns the contained fingerprint type.
const std::string & Fingerprint() const
Returns the contained fingerprint.
friend std::ostream & operator<<(std::ostream &os, const RRDataSSHFP &sshfp)
Print the SSHFP 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 SSHFP resource record data into buffer @ pkt of length pktlen, starting at ptr...
bool operator==(const RRDataSSHFP &sshfp) const
Equal-to operator, mostly for unit testing.
const uint8_t * Decode(const uint8_t *pkt, const uint8_t *ptr, uint16_t pktlen, uint16_t rdlen)
Decodes the SSHFP resource record data from buffer pkt of length pktlen, starting at ptr...
Definition: DwmDnsEtcHosts.hh:60
uint8_t Algorithm() const
Returns the contained algorithm.
Encapsulates SSHFP recource record data.
Definition: DwmDnsRRDataSSHFP.hh:59
Dwm::Dns::RRData class definition.
A helper class used when performing label sequence compression.
Definition: DwmDnsLabelPositions.hh:57
RRDataSSHFP()
Construct with an empty fingerprint.
Abstract (pure virtual) base for resource record data classes.
Definition: DwmDnsRRData.hh:71