DwmDnsRRDataRRSIG.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath: dwm/DwmDns/tags/DwmDns-0.1.0/classes/include/DwmDnsRRDataRRSIG.hh 10137 $
// @(#) $Id: DwmDnsRRDataRRSIG.hh 10137 2018-01-28 07:25:17Z dwm $
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2018
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions
//  are met:
//
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
//  3. The names of the authors and copyright holders may not be used to
//     endorse or promote products derived from this software without
//     specific prior written permission.
//
//  IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
//  DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
//  INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
//  EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
//  DAMAGE.
//
//  THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
//  DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
//  UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
//  REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
//  IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
//  OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
//  TRADEMARK OR OTHER RIGHTS.
//===========================================================================

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------

#ifndef _DWMDNSRRDATARRSIG_HH_
#define _DWMDNSRRDATARRSIG_HH_

#include <cstdint>
#include <iostream>
#include <string>

#include "DwmDnsRRData.hh"

namespace Dwm {

  namespace Dns {

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    class RRDataRRSIG
      : public RRData
    {
    public:
      static const uint16_t  k_rrtype = 46;

      static constexpr uint8_t  k_algoRSAMD5     = 1;
      static constexpr uint8_t  k_algoDH         = 2;
      static constexpr uint8_t  k_algoDSA        = 3;
      static constexpr uint8_t  k_algoECC        = 4;
      static constexpr uint8_t  k_algoRSASHA1    = 5;
      static constexpr uint8_t  k_algoINDIRECT   = 252;
      static constexpr uint8_t  k_algoPRIVATEDNS = 253;
      static constexpr uint8_t  k_algoPRIVATEOID = 254;
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      RRDataRRSIG();
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      RRDataRRSIG(uint16_t typeCovered, uint8_t algorithm, uint8_t labels,
                  uint32_t originalTTL, uint32_t signatureExpiration,
                  uint32_t signatureInception, uint16_t keyTag,
                  const std::string & signersName,
                  const std::string & signature);
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      bool operator == (const RRDataRRSIG & rrsig) const;
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      uint16_t TypeCovered() const;
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      uint16_t TypeCovered(uint16_t typeCovered);
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      uint8_t Algorithm() const;
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      uint8_t Algorithm(uint8_t algorithm);
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      uint8_t Labels() const;
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      uint8_t Labels(uint8_t labels);
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      uint32_t OriginalTTL() const;
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      uint32_t OriginalTTL(uint32_t originalTTL);
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      uint32_t SignatureExpiration() const;
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      uint32_t SignatureExpiration(uint32_t signatureExpiration);
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      uint32_t SignatureInception() const;
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      uint32_t SignatureInception(uint32_t signatureInception);
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      uint16_t KeyTag() const;
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      uint16_t KeyTag(uint16_t keyTag);
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      const std::string & SignersName() const;
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      const std::string & SignersName(const std::string & signersName);
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      const std::string & Signature() const;
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      const std::string & Signature(const std::string & signature);

      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      uint8_t *Encode(uint8_t *pkt, uint8_t *ptr, uint16_t pktlen,
                      LabelPositions & lps) const;
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      const uint8_t *Decode(const uint8_t *pkt, const uint8_t *ptr,
                            uint16_t pktlen, uint16_t rdlen);
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      friend std::ostream & operator << (std::ostream & os,
                                         const RRDataRRSIG & rrsig);

      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      static std::string AlgorithmName(uint8_t algo);
      
    private:
      typedef struct __attribute__((packed)) {
        uint16_t   typeCovered;
        uint8_t    algorithm;
        uint8_t    labels;
        uint32_t   originalTTL;
        uint32_t   signatureExpiration;
        uint32_t   signatureInception;
        uint16_t   keyTag;
      } fixed_data_t;

      fixed_data_t  _fixedData;
      std::string   _signersName;
      std::string   _signature;

      static fixed_data_t ToNetworkByteOrder(const fixed_data_t *data);
      static fixed_data_t ToHostByteOrder(const fixed_data_t *data);
    };
    
  }  // namespace Dns

}  // namespace Dwm

#endif  // _DWMDNSRRDATARRSIG_HH_