Add Layer Build and Validation for DoIP (Diagnostic over IP) Support #1655

raissi-oussema · 2024-12-07T23:04:40Z

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)

protocol version (1 byte)
invert protocol version (1 byte)
payload type (2 bytes)
payload length (4 bytes)

Pyload types / code / structure

"Generic DOIP header Nack" (0x0000) (header + nackCode (1 byte : required))
"Vehicle identification request" (0x0001) (header)
"Vehicle identification request with EID" (0x0002) (header + EID (6 bytes : required))
"Vehicle identification request with VIN" (0x0003) (header + VIN (17 bytes : required))
"Vehicle announcement message" (0x0004) (header + VIN (17 bytes : required) + logical address (2bytes : required) + EID (6 bytes : required) + GID (6 bytes : required) + further action (1 bytes : required)+ sync status (1 bytes : optional)).
"Routing activation request" (0x0005) (header + source address (2 bytes : required) + activation type (1 byte:required) + reservedISO (4 bytes : required) + reservedOEM (4 bytes : optional)).
"Routing activation response" (0x0006) (header + tester adress(2 bytes : required) + response code (1 byte:required) + reservedISO (4 bytes : required) + reservedOEM (4 bytes : optional)).
"Alive check request" (0x0007) (header)
"Alive check response" (0x0008) (header + source address (2 byte : required))
"DOIP entity status request" (0x4001) (header)
"DOIP entity status response" (0x4002) (header + node type (1 byte : required) + max concurrent socket (1 byte : required) + currently opened sockets (1 byte : required) + max data size(4 bytes : optional))
"Diagnostic power mode request information" (0x4003) (header)
"Diagnostic power mode response information" (0x4004) (header + power mode (1 byte : required))
"Diagnostic message" (0x8001) (header + source address (2 bytes : required) + target address (2 bytes : required) + UDS message (n bytes : required ; n > 0))
"Diagnostic message Ack" (0x8002) (header + source address (2 bytes : required) + target address (2 bytes : required) + ack code (1 byte : required)) + previous message (n bytes : optional ; n>0))
"Diagnostic message Nack" (0x8003) (header + source address (2 bytes : required) + target address (2 bytes : required) + Nack code (1 byte : required)) + previous message (n bytes : optional ; n>0))

Dimi1010 · 2024-12-08T06:18:55Z

As per the contributing guidelines, please retarget the PR to the dev branch instead of the master.

raissi-oussema · 2024-12-08T16:17:20Z

Observed several issues in the CI pipelines, likely due to missing definitions for htobe16 and other endianness conversion macros. All tests and pre-commit checks are passed in my linux machine.
Adding an import for "EndianPortable.h" in last PR is expected to resolve these problems.

…terpretation across systems.

seladb · 2024-12-10T09:43:15Z

Packet++/header/ProtocolType.h

+	/**
+	 * Diagnostic over IP protocol (DOIP)
+	 */
+	const ProtocolType DOIP = 38;


ID 38 is already taken by DHCPv6 protocol. The next available ID is 58, please add it after GTPv2

seladb · 2024-12-10T09:43:47Z

Packet++/header/HttpLayer.h

@@ -437,7 +437,6 @@ namespace pcpp

 		HttpResponseStatusCode() = default;

-		// cppcheck-suppress noExplicitConstructor


Why removing this cppcheck-suppress comment?

Cppcheck flags this as an incorrect suppression on my local machine. Let me know if you think I should revert it.

That is interesting. Which version of CPPcheck are you using?

2.7 as recommanded in CONTRIBUTING.md and still flags incorrect suppression, I'm keeping this changes so can I commit my recents updates,

seladb · 2024-12-10T09:44:01Z

3rdParty/json/include/json.hpp

Why update this file?

same thing as my previous comment, I only removed some suppress-checks detected as incorrect

seladb · 2024-12-10T09:51:53Z

Tests/Packet++Test/PacketExamples/DoIpAliveCheckRequestPacket.dat

Can you add one pcap file with all of these packets?

yes sure, I'll revert suppress-checks and add pcap file containig all tested packets in next PR, also try to cover some missing checks based on codecov feedback

codecov · 2024-12-10T09:57:48Z

Codecov Report

Attention: Patch coverage is 94.81690% with 92 lines in your changes missing coverage. Please review.

Project coverage is 83.55%. Comparing base (d60c699) to head (3c5dc4d).

Files with missing lines	Patch %	Lines
Packet++/src/DoIpLayerData.cpp	90.87%	38 Missing and 18 partials ⚠️
Packet++/src/DoIpLayer.cpp	88.13%	10 Missing and 11 partials ⚠️
Tests/Packet++Test/Tests/DoIpTests.cpp	98.63%	0 Missing and 12 partials ⚠️
Packet++/header/DoIpLayerData.h	76.92%	0 Missing and 3 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##              dev    #1655      +/-   ##
==========================================
+ Coverage   83.11%   83.55%   +0.43%     
==========================================
  Files         277      283       +6     
  Lines       48207    50042    +1835     
  Branches    10192    10704     +512     
==========================================
+ Hits        40069    41813    +1744     
- Misses       7243     7300      +57     
- Partials      895      929      +34

Flag	Coverage Δ
alpine320	`75.36% <83.20%> (+0.25%)`	⬆️
fedora40	`75.43% <84.02%> (+0.27%)`	⬆️
macos-13	`80.95% <89.84%> (+0.33%)`	⬆️
macos-14	`80.95% <89.84%> (+0.33%)`	⬆️
macos-15	`80.89% <89.29%> (+0.30%)`	⬆️
mingw32	`70.74% <68.61%> (-0.12%)`	⬇️
mingw64	`70.73% <68.67%> (-0.10%)`	⬇️
npcap	`85.30% <87.22%> (+0.04%)`	⬆️
rhel94	`75.26% <84.02%> (+0.28%)`	⬆️
ubuntu2004	`58.40% <53.95%> (-0.19%)`	⬇️
ubuntu2004-zstd	`58.48% <53.95%> (-0.20%)`	⬇️
ubuntu2204	`75.19% <84.00%> (+0.29%)`	⬆️
ubuntu2204-icpx	`61.42% <60.47%> (-0.03%)`	⬇️
ubuntu2404	`75.44% <83.20%> (+0.28%)`	⬆️
unittest	`83.55% <94.81%> (+0.43%)`	⬆️
windows-2019	`85.33% <87.12%> (+0.04%)`	⬆️
windows-2022	`85.36% <87.22%> (+0.04%)`	⬆️
winpcap	`85.32% <87.22%> (+0.06%)`	⬆️
xdp	`51.56% <84.00%> (+1.03%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

seladb · 2025-01-03T06:44:18Z

@raissi-oussema are you planning to continue working on this PR?

raissi-oussema · 2025-01-05T19:07:39Z

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

raissi-oussema · 2025-01-07T21:22:28Z

Design suggestions or code improvements are always welcome and greatly appreciated.

seladb · 2025-01-08T08:08:42Z

@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

raissi-oussema · 2025-01-12T13:33:35Z

@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.

Dimi1010 · 2025-01-12T14:03:06Z

@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:
/__w/PcapPlusPlus/PcapPlusPlus/Packet++/header/DoIpLayer.h:42: error: Compound pcpp::DoIpLayer is not documented. (warning treated as error, aborting now)

XDP pipeline:
That is an issue with the CI image. Merge latest changes from dev branch and it should be fine.

VS pipeline:
Tbh, no idea om that one. It seems the opencoverage download link stopped working for a bit or something.

raissi-oussema requested a review from seladb as a code owner December 7, 2024 23:04

raissi-oussema and others added 2 commits December 8, 2024 01:57

Add Layer Build and Validation for DoIP (Diagnostic over IP) Support

a50cf68

Merge branch 'master' into develop

703b650

tigercosmos changed the base branch from master to dev December 8, 2024 09:37

Merge branch 'dev' into develop

7aee737

egecetin closed this Dec 8, 2024

egecetin reopened this Dec 8, 2024

egecetin linked an issue Dec 8, 2024 that may be closed by this pull request

support of doip (diagnostic over IP protocol) #1644

Open

raissi-oussema added 3 commits December 8, 2024 19:09

Correct endianness handling for imported data to ensure consistent in…

7966b06

…terpretation across systems.

Fix serval issues related to multi-cross platform

d4658d7

other fix for DoIpLayerData

dd26c31

seladb reviewed Dec 10, 2024

View reviewed changes

raissi-oussema and others added 2 commits January 6, 2025 01:52

.add doipPackets.pcapng containg all doip packets.

2ed8c0a

.improve maps searchs for doipEnumsToStrings .cover more uses cases based on codecov feedback

Merge branch 'dev' into develop

0d52dbf

raissi-oussema and others added 3 commits January 8, 2025 16:30

Merge branch 'dev' into develop

b317bf6

fix dioxygene and gersemi errors

3ba3c71

Merge branch 'dev' into develop

7822458

Merge branch 'dev' into develop

3c5dc4d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Layer Build and Validation for DoIP (Diagnostic over IP) Support #1655

Add Layer Build and Validation for DoIP (Diagnostic over IP) Support #1655

raissi-oussema commented Dec 7, 2024 •

edited

Loading

Dimi1010 commented Dec 8, 2024 •

edited

Loading

raissi-oussema commented Dec 8, 2024

seladb Dec 10, 2024

seladb Dec 10, 2024

raissi-oussema Dec 10, 2024

seladb Dec 16, 2024

raissi-oussema Jan 5, 2025

seladb Dec 10, 2024

raissi-oussema Dec 10, 2024

seladb Dec 10, 2024

raissi-oussema Dec 10, 2024 •

edited

Loading

codecov bot commented Dec 10, 2024 •

edited

Loading

seladb commented Jan 3, 2025

raissi-oussema commented Jan 5, 2025

raissi-oussema commented Jan 7, 2025

seladb commented Jan 8, 2025

raissi-oussema commented Jan 12, 2025

Dimi1010 commented Jan 12, 2025 •

edited

Loading

		@@ -437,7 +437,6 @@ namespace pcpp

		HttpResponseStatusCode() = default;

		// cppcheck-suppress noExplicitConstructor

Add Layer Build and Validation for DoIP (Diagnostic over IP) Support #1655

Are you sure you want to change the base?

Add Layer Build and Validation for DoIP (Diagnostic over IP) Support #1655

Conversation

raissi-oussema commented Dec 7, 2024 • edited Loading

Dimi1010 commented Dec 8, 2024 • edited Loading

raissi-oussema commented Dec 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raissi-oussema Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Dec 10, 2024 • edited Loading

Codecov Report

seladb commented Jan 3, 2025

raissi-oussema commented Jan 5, 2025

raissi-oussema commented Jan 7, 2025

seladb commented Jan 8, 2025

raissi-oussema commented Jan 12, 2025

Dimi1010 commented Jan 12, 2025 • edited Loading

raissi-oussema commented Dec 7, 2024 •

edited

Loading

Dimi1010 commented Dec 8, 2024 •

edited

Loading

raissi-oussema Dec 10, 2024 •

edited

Loading

codecov bot commented Dec 10, 2024 •

edited

Loading

Dimi1010 commented Jan 12, 2025 •

edited

Loading