-
Notifications
You must be signed in to change notification settings - Fork 703
Add Layer Build and Validation for DoIP (Diagnostic over IP) Support #1655
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: dev
Are you sure you want to change the base?
Conversation
As per the contributing guidelines, please retarget the PR to the |
Observed several issues in the CI pipelines, likely due to missing definitions for |
Tests/Packet++Test/PacketExamples/DoIpAliveCheckRequestPacket.dat
Outdated
Show resolved
Hide resolved
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## dev #1655 +/- ##
==========================================
+ Coverage 83.10% 83.62% +0.52%
==========================================
Files 283 287 +4
Lines 48929 51047 +2118
Branches 10303 10963 +660
==========================================
+ Hits 40664 42690 +2026
- Misses 7113 7241 +128
+ Partials 1152 1116 -36
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
@raissi-oussema are you planning to continue working on this PR? |
Hi, I was engaged with other tasks, but I plan to get back to this PR soon. Thanks for your understanding! |
.improve maps searchs for doipEnumsToStrings .cover more uses cases based on codecov feedback
Design suggestions or code improvements are always welcome and greatly appreciated. |
@raissi-oussema to make it easier to review, do you think you can add some documentation on the DoIP protocol to the PR body? It'd mostly be helpful to get more details on the header structure and different possible message |
@seladb I need support for CI pipelines, I can't figure out why are they still failing. And a clear documentation was successfully added to PR body to make it easier for you to start the code review. |
Doxigen pipeline: XDP pipeline: VS pipeline: |
What could be the problem for dioxygen pipeline, doipLayer.h is well documented [line 42] ? |
Packet++/header/DoIpLayer.h
Outdated
// implement abstract methods | ||
|
||
/** | ||
* TODO, parse UDS layer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this for another PR? If so, should the remaining data be parsed as a generic payload layer for now?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
m_NextLayer is intended to be the UDS layer, which has not been implemented yet. In the future, as more knowledge is gained, either I or another contributor may add this functionality. For now, I suggest parsing it as a generic layer, as you mentioned.
PS: the nextLayer will be parsed only when the payloadType is 0x8001.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
your feedback is highly appertiated, what do you think about adding this snippet of code:
void parseNextLayer() override
{
if (getPayloadType() == DoIpPayloadTypes::DIAGNOSTIC_MESSAGE_TYPE)
{
size_t headerLen = sizeof(doiphdr);
if (m_DataLen <= headerLen + 2 /*source address size*/ + 2 /*target address size*/)
return;
uint8_t* payload = m_Data + (headerLen + 2 + 2);
size_t payloadLen = m_DataLen - (headerLen + 2 + 2);
m_NextLayer = new PayloadLayer(payload, payloadLen, this, m_Packet);
return;
}
}`
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
your feedback is highly appertiated, what do you think about adding this snippet of code:
void parseNextLayer() override { if (getPayloadType() == DoIpPayloadTypes::DIAGNOSTIC_MESSAGE_TYPE) { size_t headerLen = sizeof(doiphdr); if (m_DataLen <= headerLen + 2 /*source address size*/ + 2 /*target address size*/) return; uint8_t* payload = m_Data + (headerLen + 2 + 2); size_t payloadLen = m_DataLen - (headerLen + 2 + 2); m_NextLayer = new PayloadLayer(payload, payloadLen, this, m_Packet); return; } }`
Seems good. Can the source address
and target address
used in that type of message be accessed from this layer? Since we are excluding it from the generic payload.
A minor tip, having headerLen
be marked as constexpr
might allow some compiler optimizations (such as the arithmetic using it + a literal being computed during compilation and hardcoded if possible).
Also why the return statement that is at the end of the block anyway?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Dimi1010 , this approach appears both safer and cleaner. It allows us to construct a DiagnosticMessage directly from the current layer, providing direct access to the diagnostic data. Using this data, we can then build a generic PayloadLayer.
void parseNextLayer() override
{
DiagnosticMessageData diagnosticMessage;
if (diagnosticMessage.buildFromLayer(this))
{
m_NextLayer = new PayloadLayer(diagnosticMessage.diagnosticData.data(),
diagnosticMessage.diagnosticData.size(), this, m_Packet);
}
}
buildFromLayer
safely parses the current layer and verifies whether it represents a valid diagnostic message.
what do you think ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, but my question stands. DiagnosticMessageData
has two other members (sourceAddress
and targetAddress
) which at the moment I don't see how the user can access them easily. They have neither accessors in the current DoIPLayer
or are included as part of the UDSLayer
(currently PayloadLayer
).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sourceAddress
and targetAddress
are public members of DiagnosticMessageData class just like diagnosticData and they are not part of the UDS layer:
uint16_t sourceAddress; /**< Source address of the message. */
uint16_t targetAddress; /**< Target address for the diagnostic message. */
std::vector<uint8_t> diagnosticData; /**< Diagnostic message data with dynamic length. */
the user can access these fields by the method buildFromLayer
.
I've made this dummy function
just to show how to access to these fields :
void DoIpLayer::resolveDiagMessageFields()
{
DiagnosticMessageData diagnosticMessage;
if (diagnosticMessage.buildFromLayer(this))
{
uint16_t srcAddr = diagnosticMessage.sourceAddress;
uint16_t targetAddr = diagnosticMessage.targetAddress;
std::vector<uint8_t> diagData = diagnosticMessage.diagnosticData;
}
}
Do you think this implementation need more improvement ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, if i am understanding correctly the sequence is this?
- User somehow receives a
DoIPLayer
from aPacket
- User checks the payload type (via
DoIPLayer::getPayloadType()
) - Depending on the payload type user uses
T::buildFromLayer(DoIPLayer)
(T being the corresponding message struct) to populate the data from the layer into the struct.
Am I understanding the flow correctly?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes you are absolutely correct.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, that works fine. 👍
Co-authored-by: Dimitar Krastev <dimi1010100@gmail.com>
…Ack and diagnosticNac
@seladb, could you please have a look, I've made serval changes in this current version and layer now is more aligned with other layer implementation, you can start reviewing this PR, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@raissi-oussema I mostly reviewed the base class DoIpLayer
but since there are enough comments, I suggest you address those before I review the rest of the classes and files
@seladb , could you please have a look and suggest what we can improve more |
@seladb , could you have a look, I've made suggested changes. |
std::string DoIpVehicleIdentificationRequestVIN::getSummary() const | ||
{ | ||
std::ostringstream oss; | ||
oss << "VIN: " << std::string(reinterpret_cast<const char*>(getVIN().data()), DOIP_VIN_LEN) << "\n"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If VIN is always a string, should getVIN()
return a string and setVIN()
accept a string? 🤔
Same for the constructor - should it accept a string VIN?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we will keep it like this as disscussed in this comment .
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If VIN can include non-printable characters, we shouldn't convert it to string... We should either print the hex representation of it using pcpp::byteArrayToHexString()
or not print it at all
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@raissi-oussema I'm not sure you saw this comment ☝️
@seladb , Could you check if there are any areas left to improve or optimize further? |
std::string DoIpVehicleIdentificationRequestVIN::getSummary() const | ||
{ | ||
std::ostringstream oss; | ||
oss << "VIN: " << std::string(reinterpret_cast<const char*>(getVIN().data()), DOIP_VIN_LEN) << "\n"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If VIN can include non-printable characters, we shouldn't convert it to string... We should either print the hex representation of it using pcpp::byteArrayToHexString()
or not print it at all
Packet++/src/DoIpLayer.cpp
Outdated
if (currentDiagnosticDataLen > 0) | ||
{ | ||
shortenLayer(DIAGNOSTIC_DATA_OFFSET, currentDiagnosticDataLen); | ||
} | ||
extendLayer(DIAGNOSTIC_DATA_OFFSET, data.size()); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if currentDiagnosticDataLen > 0
we're shortening the layer and then extending it again. Insead we can calculate the length and do a single change:
auto layerExtensionLen = data.size() - currentDiagnosticDataLen;
if (layerExtensionLen > 0)
{
extendLayer(DIAGNOSTIC_DATA_OFFSET + currentDiagnosticDataLen, layerExtensionLen );
}
else if (layerExtensionLen < 0)
{
shortenLayer(DIAGNOSTIC_DATA_OFFSET, layerExtensionLen );
}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe the logic here might be incorrect. When subtracting two size_t values, a negative result causes unsigned underflow and produces a very large number. If layerExtensionLen is negative, we likely need to shrink the layer starting from DIAGNOSTIC_DATA_OFFSET + data.size(), using the absolute value of the difference (i.e., -1 * layerExtensionLen).
code will looks like this :
void DoIpDiagnosticMessage::setDiagnosticData(const std::vector<uint8_t>& data)
{
const size_t newPayloadLength = DOIP_SOURCE_ADDRESS_LEN + DOIP_TARGET_ADDRESS_LEN + data.size();
const size_t currentDiagnosticDataLen = m_DataLen - DIAGNOSTIC_DATA_OFFSET;
setPayloadLength(newPayloadLength);
ptrdiff_t layerExtensionLen =
static_cast<ptrdiff_t>(data.size()) - static_cast<ptrdiff_t>(currentDiagnosticDataLen);
if (layerExtensionLen > 0)
{
extendLayer(DIAGNOSTIC_DATA_OFFSET + currentDiagnosticDataLen, layerExtensionLen);
}
else if (layerExtensionLen < 0)
{
shortenLayer(DIAGNOSTIC_DATA_OFFSET + data.size(), (-1 * layerExtensionLen));
}
memcpy((m_Data + DIAGNOSTIC_DATA_OFFSET), data.data(), data.size());
}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right! Another option is to static_cast
both sizes to int
and then we can get a negative number. I think it's a bit safer than extracting pointers 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This works correctly since data.size()
is implicitly convertible to int
meaning it's guaranteed to be less than INT_MAX. In the automotive context, it's unlikely that diagnostic data will ever exceed 2,147,483,647 bytes on a 32-bit system.
That said, relying on this assumption can be risky in edge cases (e.g., malformed input or fuzzing). I used ptrdiff_t
to ensure we avoid potential overflows or undefined behavior.
If we’re confident this situation will never arise in production, I’m open to simplifying it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree, using ptrdiff_t
is a good option here 👍
Packet++/src/DoIpLayer.cpp
Outdated
if (hasPreviousMessage()) | ||
{ | ||
shortenLayer(PREVIOUS_MSG_OFFSET, currentPayloadLen); | ||
} | ||
extendLayer(PREVIOUS_MSG_OFFSET, msg.size()); | ||
uint8_t* ptr = getDataPtr(PREVIOUS_MSG_OFFSET); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ditto: instead of shortening and then extending we can calculate the size and decide which action is needed
std::string DoIpVehicleIdentificationRequestVIN::getSummary() const | ||
{ | ||
std::ostringstream oss; | ||
oss << "VIN: " << std::string(reinterpret_cast<const char*>(getVIN().data()), DOIP_VIN_LEN) << "\n"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@raissi-oussema I'm not sure you saw this comment ☝️
DoIpDiagnosticBase(uint8_t* data, size_t dataLen, Layer* prevLayer, Packet* packet); | ||
|
||
/// @brief default c'tor. | ||
DoIpDiagnosticBase(size_t length) : DoIpLayer(length) {}; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is an abstract layer, maybe we can make these constructors protected?
/// @param[in] dataLen Length of the data buffer. | ||
/// @param[in] prevLayer Pointer to the previous protocol layer. | ||
/// @param[in] packet Pointer to the parent packet. | ||
DoIpDiagnosticResponseMessageBase(uint8_t* data, size_t dataLen, Layer* prevLayer, Packet* packet); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ditto: this c'tor can also be protected
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file contains 16 packets, but there are 20 .dat
files... are there packets missing in the pcap file?
PTF_ASSERT_TRUE(RoutingActivationRequest.isPacketOfType(pcpp::IPv4)); | ||
PTF_ASSERT_TRUE(RoutingActivationRequest.isPacketOfType(pcpp::TCP)); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure these checks are needed, we only need to assert that the packet is of type DoIP.
Same for the other tests below
PTF_ASSERT_VECTORS_EQUAL(doipLayer->getReservedIso(), isoField); | ||
PTF_ASSERT_TRUE(doipLayer->hasReservedOem()); | ||
std::array<uint8_t, 4> oemField = { 0x0, 0x0, 0x0, 0x0 }; | ||
PTF_ASSERT_BUF_COMPARE(doipLayer->getReservedOem().data(), oemField.data(), 4); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's be consistent and use either PTF_ASSERT_VECTORS_EQUAL
or PTF_ASSERT_BUF_COMPARE
in both of these asserts?
pcpp::DoIpRoutingActivationRequest doipLayer(0x00, pcpp::DoIpActivationTypes::WWH_OBD); | ||
|
||
doipLayer.setSourceAddress(0x0e80); | ||
doipLayer.setActivationType(pcpp::DoIpActivationTypes::DEFAULT); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we need to set sourceAddress
and activateType
both in the c'tor and again here. We can set the expected values in the c'tor, and test the setters later in this test.
Same in the other tests below
PTF_ASSERT_EQUAL(doipLayer.getPayloadType(), pcpp::DoIpPayloadTypes::ROUTING_ACTIVATION_REQUEST, enumclass); | ||
PTF_ASSERT_EQUAL(doipLayer.getPayloadTypeAsStr(), "Routing activation request"); | ||
PTF_ASSERT_EQUAL(doipLayer.getPayloadLength(), 11); | ||
PTF_ASSERT_EQUAL(doipLayer.toString(), "DoIP Layer, Routing activation request (0x0005)"); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These getters are already tested in DoIpRoutingActivationRequestPacketParsing
, no?
try | ||
{ | ||
doipLayer->getReservedOem(); | ||
} | ||
catch (const std::runtime_error& e) | ||
{ | ||
PTF_ASSERT_EQUAL(std::string(e.what()), "Reserved OEM field not present!"); | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can use PTF_ASSERT_RAISES
here.
Same in the other tests that use try...catch
pcpp::Packet doIpPacket(100); | ||
pcpp::EthLayer ethLayer(pcpp::MacAddress("00:13:72:25:fa:cd"), pcpp::MacAddress("00:e0:b1:49:39:02")); | ||
pcpp::IPv4Layer ipLayer(pcpp::IPv4Address("172.22.178.234"), pcpp::IPv4Address("10.10.8.240")); | ||
pcpp::TcpLayer tcpLayer((uint16_t)13400, (uint16_t)13400); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The casting to uint16_t
is not needed. Same in the other tests
DoIP Protocol Overview
The Diagnostic over IP (DoIP) protocol is used in automotive diagnostic systems to facilitate communication between diagnostic tools and ECUs (Electronic Control Units) over IP-based networks. It enables remote diagnostics, configuration, and software updates over Ethernet, offering an efficient and scalable solution for modern vehicles.
Header Structure (8 bytes)
Pyload types / code / structure