TCPPacket.hh

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


#ifndef HH_SENF_Packets_DefaultBundle_TCPPacket_
#define HH_SENF_Packets_DefaultBundle_TCPPacket_ 1

// Custom includes
#include <senf/Packets/Packets.hh>
#include "Registries.hh"

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

namespace senf {

    struct TCPPacketParser : public PacketParserBase
    {
#       include SENF_PARSER()

        SENF_PARSER_FIELD( source,               UInt16Parser );
        SENF_PARSER_FIELD( destination,          UInt16Parser );
        SENF_PARSER_FIELD( sequencenumber,       UInt32Parser );
        SENF_PARSER_FIELD( acknowledgmentnumber, UInt32Parser );

        SENF_PARSER_BITFIELD        ( dataoffset, 4, unsigned );
        SENF_PARSER_PRIVATE_BITFIELD( reserved,   6, unsigned );
        SENF_PARSER_BITFIELD        ( urgf,       1, bool     );
        SENF_PARSER_BITFIELD        ( ackf,       1, bool     );
        SENF_PARSER_BITFIELD        ( pshf,       1, bool     );
        SENF_PARSER_BITFIELD        ( rstf,       1, bool     );
        SENF_PARSER_BITFIELD        ( synf,       1, bool     );
        SENF_PARSER_BITFIELD        ( finf,       1, bool     );

        SENF_PARSER_FIELD( window,        UInt16Parser );
        SENF_PARSER_FIELD( checksum,      UInt16Parser );
        SENF_PARSER_FIELD( urgentpointer, UInt16Parser );

        // skip option part in TCP-Header, dataoffset()*4 = TCP header length in byte
        // for options see http://www.iana.org/assignments/tcp-parameters/
        // if dataoffset() < 5 packet is invalid
        SENF_PARSER_SKIP( (dataoffset() < 5 ? 0 : dataoffset()*4-20), 0);

        SENF_PARSER_FINALIZE( TCPPacketParser );

        SENF_PARSER_INIT() {
            // Reserved: 6 bits, reserved for future use. Must be zero.
            // see http://tools.ietf.org/html/rfc793
            reserved_() = 0;
            // dataoffset per default 5, 5*4 = 20 Byte Header Length
            dataoffset() = 5;
        }

        boost::uint16_t calcChecksum() const; 

        bool validateChecksum() const {
            return checksum() == 0u || checksum() == calcChecksum();
        }                               

    };

    struct TCPPacketType
        : public PacketTypeBase,
          public PacketTypeMixin<TCPPacketType>
    {
        typedef PacketTypeMixin<TCPPacketType> mixin;
        typedef ConcretePacket<TCPPacketType> packet; 
        typedef TCPPacketParser parser;               

        using mixin::nextPacketRange;
        using mixin::initSize;
        using mixin::init;

        static void dump(packet p, std::ostream & os);

        static void finalize(packet p); 

        static const IPTypes::key_t ipType = 6;
    };

    typedef ConcretePacket<TCPPacketType> TCPPacket;
    SENF_PACKET_PREVENT_TEMPLATE_INSTANTIATION( TCPPacket );
}


//-/////////////////////////////////////////////////////////////////////////////////////////////////
//#include "TCPPacket.cci"
//#include "TCPPacket.ct"
//#include "TCPPacket.cti"
#endif


// Local Variables:
// mode: c++
// fill-column: 100
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// comment-column: 40
// End: