Remove tracing of encrypted message data (prepared buffers). (#27276)

* Remove tracing of encrypted message data (prepared buffers).

We had data logging for prepared messages that were
still in encrypted format.

This data does not seem useful: shows hex content of encrypted
data and generally we would have unencrypted send/receive tracing
instead.

Remove it for now to simplify code.

* Restyled by clang-format

---------

Co-authored-by: Andrei Litvin <[email protected]>
Co-authored-by: Restyled.io <[email protected]>

Author: 3 people

examples/common/tracing/TraceHandlers.cpp

@@ -226,22 +226,6 @@ std::string PayloadHeaderToJson(const PayloadHeader * payloadHeader)
     return jsonBody;
 }
 
-std::string PreparedSecureMessageDataToJson(const TracePreparedSecureMessageData * data, const std::string & peerAddressKey)
-{
-    const System::PacketBuffer * packetBuffer = data->packetBuffer->operator->();
-    std::string jsonBody                      = "{";
-    jsonBody += AsFirstJsonKey(peerAddressKey, AsJsonString(data->peerAddress));
-    jsonBody += ", ";
-    jsonBody += AsFirstJsonKey("payload_size", std::to_string(packetBuffer->DataLength()));
-    jsonBody += ", ";
-    jsonBody += AsFirstJsonKey("payload_hex", AsJsonHexString(packetBuffer->Start(), packetBuffer->DataLength()));
-    jsonBody += ", ";
-    jsonBody += AsFirstJsonKey("buffer_ptr", std::to_string(reinterpret_cast<std::uintptr_t>(packetBuffer)));
-    jsonBody += "}";
-
-    return jsonBody;
-}
-
 void SecureMessageSentHandler(const TraceSecureMessageSentData * eventData)
 {
     if (!gTraceOutputs.HasStreamAvailable())
@@ -290,41 +274,9 @@ void SecureMessageReceivedHandler(const TraceSecureMessageReceivedData * eventDa
     // Note that `eventData->session` is currently ignored.
 }
 
-void PreparedMessageSentHandler(const TracePreparedSecureMessageData * eventData)
-{
-    if (!gTraceOutputs.HasStreamAvailable())
-    {
-        return;
-    }
-
-    gTraceOutputs.StartEvent(std::string{ kTraceMessageEvent } + "." + kTracePreparedMessageSentDataFormat);
-    gTraceOutputs.AddField("json", PreparedSecureMessageDataToJson(eventData, "destination"));
-    gTraceOutputs.FinishEvent();
-}
-
-void PreparedMessageReceivedHandler(const TracePreparedSecureMessageData * eventData)
-{
-    if (!gTraceOutputs.HasStreamAvailable())
-    {
-        return;
-    }
-
-    gTraceOutputs.StartEvent(std::string{ kTraceMessageEvent } + "." + kTracePreparedMessageReceivedDataFormat);
-    gTraceOutputs.AddField("json", PreparedSecureMessageDataToJson(eventData, "source"));
-    gTraceOutputs.FinishEvent();
-}
-
 void TraceHandler(const char * type, const void * data, size_t size)
 {
-    if ((std::string{ type } == kTracePreparedMessageReceivedDataFormat) && (size == sizeof(TracePreparedSecureMessageData)))
-    {
-        PreparedMessageReceivedHandler(reinterpret_cast<const TracePreparedSecureMessageData *>(data));
-    }
-    else if ((std::string{ type } == kTracePreparedMessageSentDataFormat) && (size == sizeof(TracePreparedSecureMessageData)))
-    {
-        PreparedMessageSentHandler(reinterpret_cast<const TracePreparedSecureMessageData *>(data));
-    }
-    else if ((std::string{ type } == kTraceMessageSentDataFormat) && (size == sizeof(TraceSecureMessageSentData)))
+    if ((std::string{ type } == kTraceMessageSentDataFormat) && (size == sizeof(TraceSecureMessageSentData)))
     {
         SecureMessageSentHandler(reinterpret_cast<const TraceSecureMessageSentData *>(data));
     }

src/transport/SessionManager.cpp

@@ -389,7 +389,6 @@ CHIP_ERROR SessionManager::SendPreparedMessage(const SessionHandle & sessionHand
                     destination = &(multicastAddress.SetInterface(interfaceId));
                     if (mTransportMgr != nullptr)
                     {
-                        CHIP_TRACE_PREPARED_MESSAGE_SENT(destination, &tempBuf);
                         if (CHIP_NO_ERROR != mTransportMgr->SendMessage(*destination, std::move(tempBuf)))
                         {
                             ChipLogError(Inet, "Failed to send Multicast message on interface %s", name);
@@ -418,7 +417,6 @@ CHIP_ERROR SessionManager::SendPreparedMessage(const SessionHandle & sessionHand
 
     if (mTransportMgr != nullptr)
     {
-        CHIP_TRACE_PREPARED_MESSAGE_SENT(destination, &msgBuf);
         return mTransportMgr->SendMessage(*destination, std::move(msgBuf));
     }
 
@@ -543,7 +541,6 @@ CHIP_ERROR SessionManager::InjectCaseSessionWithTestKey(SessionHolder & sessionH
 
 void SessionManager::OnMessageReceived(const PeerAddress & peerAddress, System::PacketBufferHandle && msg)
 {
-    CHIP_TRACE_PREPARED_MESSAGE_RECEIVED(&peerAddress, &msg);
     PacketHeader partialPacketHeader;
 
     CHIP_ERROR err = partialPacketHeader.DecodeFixed(msg);

src/transport/TraceMessage.h

@@ -57,22 +57,6 @@
                                      sizeof(_trace_data));                                                                         \
     } while (0)
 
-#define CHIP_TRACE_PREPARED_MESSAGE_SENT(destination, packetBuffer)                                                                \
-    do                                                                                                                             \
-    {                                                                                                                              \
-        const ::chip::trace::TracePreparedSecureMessageData _trace_data{ destination, packetBuffer };                              \
-        _CHIP_TRACE_MESSAGE_INTERNAL(::chip::trace::kTracePreparedMessageSentDataFormat,                                           \
-                                     reinterpret_cast<const char *>(&_trace_data), sizeof(_trace_data));                           \
-    } while (0)
-
-#define CHIP_TRACE_PREPARED_MESSAGE_RECEIVED(source, packetBuffer)                                                                 \
-    do                                                                                                                             \
-    {                                                                                                                              \
-        const ::chip::trace::TracePreparedSecureMessageData _trace_data{ source, packetBuffer };                                   \
-        _CHIP_TRACE_MESSAGE_INTERNAL(::chip::trace::kTracePreparedMessageReceivedDataFormat,                                       \
-                                     reinterpret_cast<const char *>(&_trace_data), sizeof(_trace_data));                           \
-    } while (0)
-
 #else // CHIP_CONFIG_TRANSPORT_TRACE_ENABLED || CHIP_CONFIG_TRANSPORT_PW_TRACE_ENABLED
 #define CHIP_TRACE_MESSAGE_SENT(payloadHeader, packetHeader, data, dataLen)                                                        \
     do                                                                                                                             \
@@ -84,25 +68,14 @@
     {                                                                                                                              \
     } while (0)
 
-#define CHIP_TRACE_PREPARED_MESSAGE_SENT(destination, packetBuffer)                                                                \
-    do                                                                                                                             \
-    {                                                                                                                              \
-    } while (0)
-
-#define CHIP_TRACE_PREPARED_MESSAGE_RECEIVED(source, packetBuffer)                                                                 \
-    do                                                                                                                             \
-    {                                                                                                                              \
-    } while (0)
 #endif // CHIP_CONFIG_TRANSPORT_TRACE_ENABLED || CHIP_CONFIG_TRANSPORT_PW_TRACE_ENABLED
 
 namespace chip {
 namespace trace {
 
-constexpr const char * kTraceMessageEvent                      = "SecureMsg";
-constexpr const char * kTraceMessageSentDataFormat             = "SecMsgSent";
-constexpr const char * kTraceMessageReceivedDataFormat         = "SecMsgReceived";
-constexpr const char * kTracePreparedMessageSentDataFormat     = "PreparedMsgSent";
-constexpr const char * kTracePreparedMessageReceivedDataFormat = "PreparedMsgReceived";
+constexpr const char * kTraceMessageEvent              = "SecureMsg";
+constexpr const char * kTraceMessageSentDataFormat     = "SecMsgSent";
+constexpr const char * kTraceMessageReceivedDataFormat = "SecMsgReceived";
 
 struct TraceSecureMessageSentData
 {
@@ -122,12 +95,6 @@ struct TraceSecureMessageReceivedData
     size_t packetSize;
 };
 
-struct TracePreparedSecureMessageData
-{
-    const Transport::PeerAddress * peerAddress;
-    const System::PacketBufferHandle * packetBuffer;
-};
-
 #if CHIP_CONFIG_TRANSPORT_TRACE_ENABLED
 
 typedef void (*TransportTraceHandler)(const char * type, const void * data, size_t size);