forked from osmocom/wireshark
441 lines
15 KiB
C
441 lines
15 KiB
C
/* etl.c
|
|
*
|
|
* Copyright 2020, Odysseus Yang
|
|
*
|
|
* Wireshark - Network traffic analyzer
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
* Copyright 1998 Gerald Combs
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
|
*/
|
|
|
|
/*
|
|
* Reads an ETL file and writes out a pcap file with LINKTYPE_ETW.
|
|
*
|
|
* https://docs.microsoft.com/en-us/windows/win32/etw/event-tracing-portal
|
|
*/
|
|
|
|
#include "config.h"
|
|
#include "etl.h"
|
|
|
|
#include "etw_message.h"
|
|
|
|
#define MAX_PACKET_SIZE 0xFFFF
|
|
#define G_NSEC_PER_SEC 1000000000
|
|
#define ADD_OFFSET_TO_POINTER(buffer, offset) (((PBYTE)buffer) + offset)
|
|
#define ROUND_UP_COUNT(Count,Pow2) \
|
|
( ((Count)+(Pow2)-1) & (~(((int)(Pow2))-1)) )
|
|
|
|
extern int g_include_undecidable_event;
|
|
|
|
const GUID mbb_provider = { 0xA42FE227, 0xA7BF, 0x4483, {0xA5, 0x02, 0x6B, 0xCD, 0xA4, 0x28, 0xCD, 0x96} };
|
|
|
|
EXTERN_C const GUID DECLSPEC_SELECTANY EventTraceGuid = { 0x68fdd900, 0x4a3e, 0x11d1, {0x84, 0xf4, 0x00, 0x00, 0xf8, 0x04, 0x64, 0xe3} };
|
|
EXTERN_C const GUID DECLSPEC_SELECTANY ImageIdGuid = { 0xb3e675d7, 0x2554, 0x4f18, { 0x83, 0xb, 0x27, 0x62, 0x73, 0x25, 0x60, 0xde } };
|
|
EXTERN_C const GUID DECLSPEC_SELECTANY SystemConfigExGuid = { 0x9b79ee91, 0xb5fd, 0x41c0, { 0xa2, 0x43, 0x42, 0x48, 0xe2, 0x66, 0xe9, 0xd0 } };
|
|
EXTERN_C const GUID DECLSPEC_SELECTANY EventMetadataGuid = { 0xbbccf6c1, 0x6cd1, 0x48c4, {0x80, 0xff, 0x83, 0x94, 0x82, 0xe3, 0x76, 0x71 } };
|
|
|
|
typedef struct _WTAP_ETL_RECORD {
|
|
EVENT_HEADER EventHeader; // Event header
|
|
ETW_BUFFER_CONTEXT BufferContext; // Buffer context
|
|
ULONG UserDataLength;
|
|
ULONG MessageLength;
|
|
ULONG ProviderLength;
|
|
} WTAP_ETL_RECORD;
|
|
|
|
static gchar g_err_info[FILENAME_MAX] = { 0 };
|
|
static int g_err = ERROR_SUCCESS;
|
|
static wtap_dumper* g_pdh = NULL;
|
|
extern ULONGLONG g_num_events;
|
|
|
|
static void WINAPI event_callback(PEVENT_RECORD ev);
|
|
void etw_dump_write_opn_event(PEVENT_RECORD ev, ULARGE_INTEGER timestamp);
|
|
void etw_dump_write_general_event(PEVENT_RECORD ev, ULARGE_INTEGER timestamp);
|
|
void etw_dump_write_event_head_only(PEVENT_RECORD ev, ULARGE_INTEGER timestamp);
|
|
void wtap_etl_rec_dump(ULARGE_INTEGER timestamp, WTAP_ETL_RECORD* etl_record, ULONG total_packet_length, BOOLEAN is_inbound);
|
|
wtap_dumper* etw_dump_open(const char* pcapng_filename, int* err, gchar** err_info);
|
|
|
|
wtap_open_return_val etw_dump(const char* etl_filename, const char* pcapng_filename, int* err, gchar** err_info)
|
|
{
|
|
EVENT_TRACE_LOGFILE log_file;
|
|
TRACEHANDLE trace_handle = INVALID_PROCESSTRACE_HANDLE;
|
|
WCHAR w_etl_filename[FILENAME_MAX] = { 0 };
|
|
WCHAR w_pcapng_filename[FILENAME_MAX] = { 0 };
|
|
ULONG trace_error;
|
|
wtap_open_return_val returnVal = WTAP_OPEN_MINE;
|
|
|
|
SecureZeroMemory(g_err_info, FILENAME_MAX);
|
|
g_err = ERROR_SUCCESS;
|
|
g_num_events = 0;
|
|
|
|
/* do/while(FALSE) is used to jump out of loop so no complex nested if/else is needed */
|
|
do
|
|
{
|
|
mbstowcs(w_etl_filename, etl_filename, FILENAME_MAX);
|
|
mbstowcs(w_pcapng_filename, pcapng_filename, FILENAME_MAX);
|
|
|
|
SecureZeroMemory(&log_file, sizeof(log_file));
|
|
log_file.LogFileName = w_etl_filename;
|
|
log_file.ProcessTraceMode = PROCESS_TRACE_MODE_EVENT_RECORD;
|
|
log_file.EventRecordCallback = event_callback;
|
|
log_file.Context = NULL;
|
|
|
|
trace_handle = OpenTrace(&log_file);
|
|
if (trace_handle == INVALID_PROCESSTRACE_HANDLE) {
|
|
*err_info = g_strdup_printf("OpenTrace failed with %u", err);
|
|
returnVal = WTAP_OPEN_NOT_MINE;
|
|
break;
|
|
}
|
|
|
|
g_pdh = etw_dump_open(pcapng_filename, err, err_info);
|
|
if (g_pdh == NULL)
|
|
{
|
|
returnVal = WTAP_OPEN_ERROR;
|
|
break;
|
|
}
|
|
|
|
trace_error = ProcessTrace(&trace_handle, 1, 0, 0);
|
|
if (trace_error != ERROR_SUCCESS) {
|
|
returnVal = WTAP_OPEN_ERROR;
|
|
break;
|
|
}
|
|
|
|
if (g_err != ERROR_SUCCESS)
|
|
{
|
|
*err = g_err;
|
|
*err_info = g_strdup(g_err_info);
|
|
returnVal = WTAP_OPEN_ERROR;
|
|
break;
|
|
}
|
|
|
|
if (!g_num_events) {
|
|
*err_info = g_strdup_printf("Didn't find any etw event");
|
|
returnVal = WTAP_OPEN_NOT_MINE;
|
|
break;
|
|
}
|
|
} while (FALSE);
|
|
|
|
if (trace_handle != INVALID_PROCESSTRACE_HANDLE)
|
|
{
|
|
CloseTrace(trace_handle);
|
|
}
|
|
if (g_pdh != NULL)
|
|
{
|
|
if (!wtap_dump_close(g_pdh, err, err_info))
|
|
{
|
|
returnVal = WTAP_OPEN_ERROR;
|
|
}
|
|
}
|
|
return returnVal;
|
|
}
|
|
|
|
static void WINAPI event_callback(PEVENT_RECORD ev)
|
|
{
|
|
ULARGE_INTEGER timestamp;
|
|
g_num_events++;
|
|
/*
|
|
* 100ns since 1/1/1601 -> usec since 1/1/1970.
|
|
* The offset of 11644473600 seconds can be calculated with a couple of calls to SystemTimeToFileTime.
|
|
*/
|
|
timestamp.QuadPart = (ev->EventHeader.TimeStamp.QuadPart / 10) - 11644473600000000ll;
|
|
|
|
/* Write OPN events that needs mbim sub dissector */
|
|
if (IsEqualGUID(&ev->EventHeader.ProviderId, &mbb_provider))
|
|
{
|
|
etw_dump_write_opn_event(ev, timestamp);
|
|
}
|
|
/* TODO:: You can write events from other providers that needs specific sub dissector */
|
|
#if 0
|
|
else if (IsEqualGUID(&ev->EventHeader.ProviderId, &ndis_packcapture_provider))
|
|
{
|
|
etw_dump_write_packet_event(ev, timestamp);
|
|
}
|
|
#endif
|
|
/* Write any event form other providers other than above */
|
|
else
|
|
{
|
|
etw_dump_write_general_event(ev, timestamp);
|
|
}
|
|
}
|
|
|
|
wtap_dumper* etw_dump_open(const char* pcapng_filename, int* err, gchar** err_info)
|
|
{
|
|
wtap_dump_params params = { 0 };
|
|
GArray* shb_hdrs = NULL;
|
|
wtap_block_t shb_hdr;
|
|
wtapng_iface_descriptions_t* idb_info;
|
|
GArray* idb_datas;
|
|
wtap_block_t idb_data;
|
|
wtapng_if_descr_mandatory_t* descr_mand;
|
|
|
|
wtap_dumper* pdh = NULL;
|
|
|
|
shb_hdrs = g_array_new(FALSE, FALSE, sizeof(wtap_block_t));
|
|
shb_hdr = wtap_block_create(WTAP_BLOCK_SECTION);
|
|
g_array_append_val(shb_hdrs, shb_hdr);
|
|
|
|
/* In the future, may create multiple WTAP_BLOCK_IF_ID_AND_INFO separately for IP packet */
|
|
idb_info = g_new(wtapng_iface_descriptions_t, 1);
|
|
idb_datas = g_array_new(FALSE, FALSE, sizeof(wtap_block_t));
|
|
idb_data = wtap_block_create(WTAP_BLOCK_IF_ID_AND_INFO);
|
|
descr_mand = (wtapng_if_descr_mandatory_t*)wtap_block_get_mandatory_data(idb_data);
|
|
descr_mand->tsprecision = WTAP_TSPREC_USEC;
|
|
descr_mand->wtap_encap = WTAP_ENCAP_ETW;
|
|
/* Timestamp for each pcapng packet is usec units, so time_units_per_second need be set to 10^6 */
|
|
descr_mand->time_units_per_second = G_USEC_PER_SEC;
|
|
g_array_append_val(idb_datas, idb_data);
|
|
idb_info->interface_data = idb_datas;
|
|
|
|
params.encap = WTAP_ENCAP_ETW;
|
|
params.snaplen = 0;
|
|
params.tsprec = WTAP_TSPREC_USEC;
|
|
params.shb_hdrs = shb_hdrs;
|
|
params.idb_inf = idb_info;
|
|
|
|
pdh = wtap_dump_open(pcapng_filename, wtap_pcapng_file_type_subtype(), WTAP_UNCOMPRESSED, ¶ms, err, err_info);
|
|
|
|
if (shb_hdrs)
|
|
{
|
|
wtap_block_array_free(shb_hdrs);
|
|
}
|
|
if (params.idb_inf)
|
|
{
|
|
if (params.idb_inf->interface_data)
|
|
{
|
|
wtap_block_array_free(params.idb_inf->interface_data);
|
|
}
|
|
g_free(params.idb_inf);
|
|
params.idb_inf = NULL;
|
|
}
|
|
|
|
return pdh;
|
|
}
|
|
|
|
ULONG wtap_etl_record_buffer_init(WTAP_ETL_RECORD** out_etl_record, PEVENT_RECORD ev, BOOLEAN include_user_data, WCHAR* message, WCHAR* provider_name)
|
|
{
|
|
ULONG total_packet_length = sizeof(WTAP_ETL_RECORD);
|
|
WTAP_ETL_RECORD* etl_record = NULL;
|
|
ULONG user_data_length = 0;
|
|
ULONG user_data_offset = 0;
|
|
ULONG message_offset = 0;
|
|
ULONG provider_name_offset = 0;
|
|
ULONG message_length = 0;
|
|
ULONG provider_name_length = 0;
|
|
|
|
if (include_user_data)
|
|
{
|
|
if (ev->UserDataLength < MAX_PACKET_SIZE)
|
|
{
|
|
user_data_length = ev->UserDataLength;
|
|
}
|
|
else
|
|
{
|
|
user_data_length = MAX_PACKET_SIZE;
|
|
}
|
|
user_data_offset = sizeof(WTAP_ETL_RECORD);
|
|
total_packet_length += ROUND_UP_COUNT(user_data_length, sizeof(LONG));
|
|
}
|
|
if (message && message[0] != L'\0')
|
|
{
|
|
message_offset = total_packet_length;
|
|
message_length = (ULONG)((wcslen(message) + 1) * sizeof(WCHAR));
|
|
total_packet_length += ROUND_UP_COUNT(message_length, sizeof(LONG));
|
|
}
|
|
if (provider_name && provider_name[0] != L'\0')
|
|
{
|
|
provider_name_offset = total_packet_length;
|
|
provider_name_length = (ULONG)((wcslen(provider_name) + 1) * sizeof(WCHAR));
|
|
total_packet_length += ROUND_UP_COUNT(provider_name_length, sizeof(LONG));
|
|
}
|
|
|
|
etl_record = g_malloc(total_packet_length);
|
|
SecureZeroMemory(etl_record, total_packet_length);
|
|
etl_record->EventHeader = ev->EventHeader;
|
|
etl_record->BufferContext = ev->BufferContext;
|
|
etl_record->UserDataLength = user_data_length;
|
|
etl_record->MessageLength = message_length;
|
|
etl_record->ProviderLength = provider_name_length;
|
|
|
|
if (user_data_offset)
|
|
{
|
|
memcpy(ADD_OFFSET_TO_POINTER(etl_record, user_data_offset), ev->UserData, user_data_length);
|
|
}
|
|
if (message_offset)
|
|
{
|
|
memcpy(ADD_OFFSET_TO_POINTER(etl_record, message_offset), message, message_length);
|
|
}
|
|
if (provider_name_offset)
|
|
{
|
|
memcpy(ADD_OFFSET_TO_POINTER(etl_record, provider_name_offset), provider_name, provider_name_length);
|
|
}
|
|
|
|
*out_etl_record = etl_record;
|
|
return total_packet_length;
|
|
}
|
|
|
|
void wtap_etl_rec_dump(ULARGE_INTEGER timestamp, WTAP_ETL_RECORD* etl_record, ULONG total_packet_length, BOOLEAN is_inbound)
|
|
{
|
|
gchar* err_info;
|
|
int err;
|
|
wtap_rec rec = { 0 };
|
|
|
|
wtap_rec_init(&rec);
|
|
rec.rec_header.packet_header.caplen = total_packet_length;
|
|
rec.rec_header.packet_header.len = total_packet_length;
|
|
rec.rec_header.packet_header.pkt_encap = WTAP_ENCAP_ETW;
|
|
rec.presence_flags = rec.presence_flags | WTAP_HAS_PACK_FLAGS;
|
|
rec.rec_header.packet_header.pack_flags = is_inbound ? 1 : 2;
|
|
/* Convert usec of the timestamp into nstime_t */
|
|
rec.ts.secs = (time_t)(timestamp.QuadPart / G_USEC_PER_SEC);
|
|
rec.ts.nsecs = (int)(((timestamp.QuadPart % G_USEC_PER_SEC) * G_NSEC_PER_SEC) / G_USEC_PER_SEC);
|
|
|
|
/* and save the packet */
|
|
if (!wtap_dump(g_pdh, &rec, (guint8*)etl_record, &err, &err_info)) {
|
|
g_err = err;
|
|
sprintf_s(g_err_info, sizeof(g_err_info), "wtap_dump failed, %s", err_info);
|
|
g_free(err_info);
|
|
}
|
|
wtap_rec_cleanup(&rec);
|
|
}
|
|
|
|
void etw_dump_write_opn_event(PEVENT_RECORD ev, ULARGE_INTEGER timestamp)
|
|
{
|
|
WTAP_ETL_RECORD* etl_record = NULL;
|
|
ULONG total_packet_length = 0;
|
|
BOOLEAN is_inbound = FALSE;
|
|
/* 0x80000000 mask the function to host message */
|
|
is_inbound = ((*(INT32*)(ev->UserData)) & 0x80000000) ? TRUE : FALSE;
|
|
total_packet_length = wtap_etl_record_buffer_init(&etl_record, ev, TRUE, NULL, NULL);
|
|
wtap_etl_rec_dump(timestamp, etl_record, total_packet_length, is_inbound);
|
|
g_free(etl_record);
|
|
}
|
|
|
|
void etw_dump_write_event_head_only(PEVENT_RECORD ev, ULARGE_INTEGER timestamp)
|
|
{
|
|
WTAP_ETL_RECORD* etl_record = NULL;
|
|
ULONG total_packet_length = 0;
|
|
total_packet_length = wtap_etl_record_buffer_init(&etl_record, ev, FALSE, NULL, NULL);
|
|
wtap_etl_rec_dump(timestamp, etl_record, total_packet_length, FALSE);
|
|
g_free(etl_record);
|
|
}
|
|
|
|
void etw_dump_write_general_event(PEVENT_RECORD ev, ULARGE_INTEGER timestamp)
|
|
{
|
|
PTRACE_EVENT_INFO pInfo = NULL;
|
|
PBYTE pUserData = NULL;
|
|
PBYTE pEndOfUserData = NULL;
|
|
DWORD PointerSize = 0;
|
|
PROPERTY_KEY_VALUE* prop_arr = NULL;
|
|
DWORD dwTopLevelPropertyCount = 0;
|
|
DWORD dwSizeofArray = 0;
|
|
WCHAR wszMessageBuffer[MAX_LOG_LINE_LENGTH] = { 0 };
|
|
WCHAR formatMessage[MAX_LOG_LINE_LENGTH] = { 0 };
|
|
|
|
WTAP_ETL_RECORD* etl_record = NULL;
|
|
ULONG total_packet_length = 0;
|
|
BOOLEAN is_message_dumped = FALSE;
|
|
|
|
do
|
|
{
|
|
/* Skip EventTrace events */
|
|
if (ev->EventHeader.Flags & EVENT_HEADER_FLAG_CLASSIC_HEADER &&
|
|
IsEqualGUID(&ev->EventHeader.ProviderId, &EventTraceGuid))
|
|
{
|
|
/*
|
|
* The first event in every ETL file contains the data from the file header.
|
|
* This is the same data as was returned in the EVENT_TRACE_LOGFILEW by
|
|
* OpenTrace. Since we've already seen this information, we'll skip this
|
|
* event.
|
|
*/
|
|
break;
|
|
}
|
|
|
|
/* Skip events injected by the XPerf tracemerger - they will never be decodable */
|
|
if (IsEqualGUID(&ev->EventHeader.ProviderId, &ImageIdGuid) ||
|
|
IsEqualGUID(&ev->EventHeader.ProviderId, &SystemConfigExGuid) ||
|
|
IsEqualGUID(&ev->EventHeader.ProviderId, &EventMetadataGuid))
|
|
{
|
|
break;
|
|
}
|
|
|
|
if (!get_event_information(ev, &pInfo))
|
|
{
|
|
break;
|
|
}
|
|
|
|
/* Skip those events without format message since most of them need special logic to decode like NDIS-PackCapture */
|
|
if (pInfo->EventMessageOffset <= 0)
|
|
{
|
|
break;
|
|
}
|
|
|
|
if (EVENT_HEADER_FLAG_32_BIT_HEADER == (ev->EventHeader.Flags & EVENT_HEADER_FLAG_32_BIT_HEADER))
|
|
{
|
|
PointerSize = 4;
|
|
}
|
|
else
|
|
{
|
|
PointerSize = 8;
|
|
}
|
|
|
|
pUserData = (PBYTE)ev->UserData;
|
|
pEndOfUserData = (PBYTE)ev->UserData + ev->UserDataLength;
|
|
|
|
dwTopLevelPropertyCount = pInfo->TopLevelPropertyCount;
|
|
if (dwTopLevelPropertyCount > 0)
|
|
{
|
|
prop_arr = g_malloc(sizeof(PROPERTY_KEY_VALUE) * dwTopLevelPropertyCount);
|
|
dwSizeofArray = dwTopLevelPropertyCount * sizeof(PROPERTY_KEY_VALUE);
|
|
SecureZeroMemory(prop_arr, dwSizeofArray);
|
|
}
|
|
|
|
StringCbCopy(formatMessage, MAX_LOG_LINE_LENGTH, (LPWSTR)ADD_OFFSET_TO_POINTER(pInfo, pInfo->EventMessageOffset));
|
|
|
|
for (USHORT i = 0; i < dwTopLevelPropertyCount; i++)
|
|
{
|
|
pUserData = extract_properties(ev, pInfo, PointerSize, i, pUserData, pEndOfUserData, &prop_arr[i]);
|
|
if (NULL == pUserData)
|
|
{
|
|
break;
|
|
}
|
|
}
|
|
|
|
format_message(formatMessage, prop_arr, dwTopLevelPropertyCount, wszMessageBuffer, sizeof(wszMessageBuffer));
|
|
|
|
total_packet_length = wtap_etl_record_buffer_init(&etl_record, ev, FALSE, wszMessageBuffer, (WCHAR*)ADD_OFFSET_TO_POINTER(pInfo, pInfo->ProviderNameOffset));
|
|
wtap_etl_rec_dump(timestamp, etl_record, total_packet_length, FALSE);
|
|
g_free(etl_record);
|
|
|
|
is_message_dumped = TRUE;
|
|
} while (FALSE);
|
|
|
|
if (NULL != prop_arr)
|
|
{
|
|
g_free(prop_arr);
|
|
prop_arr = NULL;
|
|
}
|
|
if (NULL != pInfo)
|
|
{
|
|
g_free(pInfo);
|
|
pInfo = NULL;
|
|
}
|
|
|
|
if (!is_message_dumped && g_include_undecidable_event)
|
|
{
|
|
etw_dump_write_event_head_only(ev, timestamp);
|
|
}
|
|
}
|
|
|
|
/*
|
|
* Editor modelines - https://www.wireshark.org/tools/modelines.html
|
|
*
|
|
* Local variables:
|
|
* c-basic-offset: 4
|
|
* tab-width: 8
|
|
* indent-tabs-mode: nil
|
|
* End:
|
|
*
|
|
* vi: set shiftwidth=4 tabstop=8 expandtab:
|
|
* :indentSize=4:tabSize=8:noTabs=true:
|
|
*/
|