ostinato/common/icmp.cpp
Srivats P 9f70f29499 Refactor ICMP/IGMP checksums
Added a new CksumTypeIcmpIgmp and implemented it in AbstractProtocol.
2021-09-05 13:04:57 +05:30

386 lines
9.9 KiB
C++

/*
Copyright (C) 2010 Srivats P.
This file is part of "Ostinato"
This is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>
*/
#include "icmp.h"
#include "icmphelper.h"
IcmpProtocol::IcmpProtocol(StreamBase *stream, AbstractProtocol *parent)
: AbstractProtocol(stream, parent)
{
}
IcmpProtocol::~IcmpProtocol()
{
// field count may change based on msgType - so don't cache field offsets
_cacheFlags &= ~FieldFrameBitOffsetCache;
}
AbstractProtocol* IcmpProtocol::createInstance(StreamBase *stream,
AbstractProtocol *parent)
{
return new IcmpProtocol(stream, parent);
}
quint32 IcmpProtocol::protocolNumber() const
{
return OstProto::Protocol::kIcmpFieldNumber;
}
void IcmpProtocol::protoDataCopyInto(OstProto::Protocol &protocol) const
{
protocol.MutableExtension(OstProto::icmp)->CopyFrom(data);
protocol.mutable_protocol_id()->set_id(protocolNumber());
}
void IcmpProtocol::protoDataCopyFrom(const OstProto::Protocol &protocol)
{
if (protocol.protocol_id().id() == protocolNumber() &&
protocol.HasExtension(OstProto::icmp))
data.MergeFrom(protocol.GetExtension(OstProto::icmp));
}
QString IcmpProtocol::name() const
{
return QString("Internet Control Message Protocol");
}
QString IcmpProtocol::shortName() const
{
return QString("ICMP");
}
quint32 IcmpProtocol::protocolId(ProtocolIdType type) const
{
switch(type)
{
case ProtocolIdIp:
switch(icmpVersion())
{
case OstProto::Icmp::kIcmp4: return 0x1;
case OstProto::Icmp::kIcmp6: return 0x3A;
default:break;
}
default:break;
}
return AbstractProtocol::protocolId(type);
}
int IcmpProtocol::fieldCount() const
{
return icmp_fieldCount;
}
int IcmpProtocol::frameFieldCount() const
{
int count;
if (isIdSeqType(icmpVersion(), icmpType()))
count = icmp_idSeqFrameFieldCount;
else
count = icmp_commonFrameFieldCount;
return count;
}
AbstractProtocol::FieldFlags IcmpProtocol::fieldFlags(int index) const
{
AbstractProtocol::FieldFlags flags;
flags = AbstractProtocol::fieldFlags(index);
switch (index)
{
case icmp_type:
case icmp_code:
break;
case icmp_checksum:
flags |= CksumField;
break;
case icmp_identifier:
case icmp_sequence:
if (!isIdSeqType(icmpVersion(), icmpType()))
flags &= ~FrameField;
break;
case icmp_version:
case icmp_is_override_checksum:
flags &= ~FrameField;
flags |= MetaField;
break;
default:
qFatal("%s: unimplemented case %d in switch", __PRETTY_FUNCTION__,
index);
break;
}
return flags;
}
QVariant IcmpProtocol::fieldData(int index, FieldAttrib attrib,
int streamIndex) const
{
switch (index)
{
case icmp_type:
{
unsigned char type = data.type() & 0xFF;
switch(attrib)
{
case FieldName:
return QString("Type");
case FieldValue:
return type;
case FieldTextValue:
return QString("%1").arg((uint) type);
case FieldFrameValue:
return QByteArray(1, type);
default:
break;
}
break;
}
case icmp_code:
{
unsigned char code = data.code() & 0xFF;
switch(attrib)
{
case FieldName:
return QString("Code");
case FieldValue:
return code;
case FieldTextValue:
return QString("%1").arg((uint)code);
case FieldFrameValue:
return QByteArray(1, code);
default:
break;
}
break;
}
case icmp_checksum:
{
quint16 cksum;
switch(attrib)
{
case FieldValue:
case FieldFrameValue:
case FieldTextValue:
if (data.is_override_checksum())
{
cksum = data.checksum();
}
else
{
cksum = (icmpVersion() == OstProto::Icmp::kIcmp4) ?
AbstractProtocol::protocolFrameCksum(
streamIndex, CksumIcmpIgmp) :
AbstractProtocol::protocolFrameCksum(
streamIndex, CksumTcpUdp);
}
break;
default:
cksum = 0; // avoid the 'maybe used unitialized' warning
break;
}
switch(attrib)
{
case FieldName:
return QString("Checksum");
case FieldValue:
return cksum;
case FieldFrameValue:
{
QByteArray fv;
fv.resize(2);
qToBigEndian(cksum, (uchar*) fv.data());
return fv;
}
case FieldTextValue:
return QString("0x%1").arg(
cksum, 4, BASE_HEX, QChar('0'));;
case FieldBitSize:
return 16;
default:
break;
}
break;
}
case icmp_identifier:
{
switch(attrib)
{
case FieldName:
return QString("Identifier");
case FieldValue:
return data.identifier();
case FieldTextValue:
return QString("%1").arg(data.identifier());
case FieldFrameValue:
{
QByteArray fv;
fv.resize(2);
qToBigEndian((quint16) data.identifier(),
(uchar*) fv.data());
return fv;
}
default:
break;
}
break;
}
case icmp_sequence:
{
switch(attrib)
{
case FieldName:
return QString("Sequence");
case FieldValue:
return data.sequence();
case FieldTextValue:
return QString("%1").arg(data.sequence());
case FieldFrameValue:
{
QByteArray fv;
fv.resize(2);
qToBigEndian((quint16) data.sequence(), (uchar*) fv.data());
return fv;
}
default:
break;
}
break;
}
// Meta fields
case icmp_version:
{
switch(attrib)
{
case FieldValue:
return data.icmp_version();
default:
break;
}
break;
}
case icmp_is_override_checksum:
{
switch(attrib)
{
case FieldValue:
return data.is_override_checksum();
default:
break;
}
break;
}
default:
qFatal("%s: unimplemented case %d in switch", __PRETTY_FUNCTION__,
index);
break;
}
return AbstractProtocol::fieldData(index, attrib, streamIndex);
}
bool IcmpProtocol::setFieldData(int index, const QVariant &value,
FieldAttrib attrib)
{
bool isOk = false;
if (attrib != FieldValue)
goto _exit;
switch (index)
{
case icmp_type:
{
uint type = value.toUInt(&isOk);
if (isOk)
data.set_type(type & 0xFF);
break;
}
case icmp_code:
{
uint code = value.toUInt(&isOk);
if (isOk)
data.set_code(code & 0xFF);
break;
}
case icmp_checksum:
{
uint csum = value.toUInt(&isOk);
if (isOk)
data.set_checksum(csum);
break;
}
case icmp_identifier:
{
uint id = value.toUInt(&isOk);
if (isOk)
data.set_identifier(id);
break;
}
case icmp_sequence:
{
uint seq = value.toUInt(&isOk);
if (isOk)
data.set_sequence(seq);
break;
}
case icmp_version:
{
int ver = value.toUInt(&isOk);
if (isOk)
data.set_icmp_version(OstProto::Icmp::Version(ver));
break;
}
case icmp_is_override_checksum:
{
bool ovr = value.toBool();
data.set_is_override_checksum(ovr);
isOk = true;
break;
}
default:
qFatal("%s: unimplemented case %d in switch", __PRETTY_FUNCTION__,
index);
break;
}
_exit:
return isOk;
}