forked from osmocom/wireshark
![Peter Wu](/assets/img/avatar_default.png)
The memory ownership of wtap_rec::opt_comment was not clear. Users of wtap were leaking memory (editcap.c). wtap readers were not sure about freeing old comments (erf) or simply ignored memleaks (pcapng). To fix this, ensure opt_comment is owned by wtap_rec and free it with wtap_rec_cleanup. The erf issue was already addressed since cf_get_packet_comment properly duplicates wth.opt_comment memory. - wtap file formats (readers): - Should allocate memory for new comments. - Should free a comment from an earlier read before writing a new one. - Users of wth: - Can only assume that opt_comment remains valid until the next read. - Can assume that wtap_dump does not modify the comment. - For random access (wtap_seek_read): should call wtap_rec_cleanup to free the comment. The test_tshark_z_expert_comment and test_text2pcap_sip_pcapng tests now pass when built with ASAN. This change was created by carefully looking at all users opt "opt_comment" and cf_get_packet_comment. Thanks to Vasil Velichkov for an initial patch which helped validating this version. Bug: 7515 Change-Id: If3152d1391e7e0d9860f04f3bc2ec41a1f6cc54b Reviewed-on: https://code.wireshark.org/review/31713 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot Reviewed-by: Vasil Velichkov <vvvelichkov@gmail.com> Reviewed-by: Anders Broman <a.broman58@gmail.com>
218 lines
7.3 KiB
C
218 lines
7.3 KiB
C
/* tap_export_pdu.c
|
|
* Routines for exporting PDUs to file
|
|
*
|
|
* Wireshark - Network traffic analyzer
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
* Copyright 1998 Gerald Combs
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include "wiretap/pcap-encap.h"
|
|
#include "wsutil/os_version_info.h"
|
|
#include "version_info.h"
|
|
|
|
#include <epan/tap.h>
|
|
#include <epan/exported_pdu.h>
|
|
#include <epan/epan_dissect.h>
|
|
#include <wiretap/wtap.h>
|
|
#include <wiretap/wtap_opttypes.h>
|
|
#include <wiretap/pcapng.h>
|
|
|
|
#include "tap_export_pdu.h"
|
|
|
|
/* Main entry point to the tap */
|
|
static tap_packet_status
|
|
export_pdu_packet(void *tapdata, packet_info *pinfo, epan_dissect_t *edt, const void *data)
|
|
{
|
|
const exp_pdu_data_t *exp_pdu_data = (const exp_pdu_data_t *)data;
|
|
exp_pdu_t *exp_pdu_tap_data = (exp_pdu_t *)tapdata;
|
|
wtap_rec rec;
|
|
int err;
|
|
gchar *err_info;
|
|
int buffer_len;
|
|
guint8 *packet_buf;
|
|
|
|
memset(&rec, 0, sizeof rec);
|
|
buffer_len = exp_pdu_data->tvb_captured_length + exp_pdu_data->tlv_buffer_len;
|
|
packet_buf = (guint8 *)g_malloc(buffer_len);
|
|
|
|
if(exp_pdu_data->tlv_buffer_len > 0){
|
|
memcpy(packet_buf, exp_pdu_data->tlv_buffer, exp_pdu_data->tlv_buffer_len);
|
|
}
|
|
if(exp_pdu_data->tvb_captured_length > 0){
|
|
tvb_memcpy(exp_pdu_data->pdu_tvb, packet_buf+exp_pdu_data->tlv_buffer_len, 0, exp_pdu_data->tvb_captured_length);
|
|
}
|
|
rec.rec_type = REC_TYPE_PACKET;
|
|
rec.presence_flags = WTAP_HAS_CAP_LEN|WTAP_HAS_INTERFACE_ID|WTAP_HAS_TS|WTAP_HAS_PACK_FLAGS;
|
|
rec.ts.secs = pinfo->abs_ts.secs;
|
|
rec.ts.nsecs = pinfo->abs_ts.nsecs;
|
|
rec.rec_header.packet_header.caplen = buffer_len;
|
|
rec.rec_header.packet_header.len = exp_pdu_data->tvb_reported_length + exp_pdu_data->tlv_buffer_len;
|
|
|
|
rec.rec_header.packet_header.pkt_encap = exp_pdu_tap_data->pkt_encap;
|
|
|
|
/* rec.opt_comment is not modified by wtap_dump, but if for some reason the
|
|
* epan_get_user_comment() or pinfo->rec->opt_comment are invalidated,
|
|
* copying it here does not hurt. (Can invalidation really happen?) */
|
|
if (pinfo->fd->has_user_comment) {
|
|
rec.opt_comment = g_strdup(epan_get_user_comment(edt->session, pinfo->fd));
|
|
rec.has_comment_changed = TRUE;
|
|
} else if (pinfo->fd->has_phdr_comment) {
|
|
rec.opt_comment = g_strdup(pinfo->rec->opt_comment);
|
|
}
|
|
|
|
/* XXX: should the rec.rec_header.packet_header.pseudo_header be set to the pinfo's pseudo-header? */
|
|
/* XXX: report errors and return TAP_PACKET_FAILED! */
|
|
if (!wtap_dump(exp_pdu_tap_data->wdh, &rec, packet_buf, &err, &err_info)) {
|
|
switch (err) {
|
|
|
|
case WTAP_ERR_UNWRITABLE_REC_DATA:
|
|
g_free(err_info);
|
|
break;
|
|
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
|
|
g_free(packet_buf);
|
|
g_free(rec.opt_comment);
|
|
|
|
return TAP_PACKET_DONT_REDRAW; /* Do not redraw */
|
|
}
|
|
|
|
int
|
|
exp_pdu_open(exp_pdu_t *exp_pdu_tap_data, int fd, const char *comment)
|
|
{
|
|
|
|
int err;
|
|
|
|
/* pcapng defs */
|
|
wtap_block_t shb_hdr;
|
|
wtap_block_t int_data;
|
|
wtapng_if_descr_mandatory_t *int_data_mand;
|
|
GString *os_info_str;
|
|
gsize opt_len;
|
|
gchar *opt_str;
|
|
|
|
/* Create data for SHB */
|
|
os_info_str = g_string_new("");
|
|
get_os_version_info(os_info_str);
|
|
|
|
shb_hdr = wtap_block_create(WTAP_BLOCK_NG_SECTION);
|
|
|
|
/* options */
|
|
wtap_block_add_string_option(shb_hdr, OPT_COMMENT, comment, strlen(comment));
|
|
|
|
/*
|
|
* UTF-8 string containing the name of the operating system used to create
|
|
* this section.
|
|
*/
|
|
opt_len = os_info_str->len;
|
|
opt_str = g_string_free(os_info_str, FALSE);
|
|
if (opt_str) {
|
|
wtap_block_add_string_option(shb_hdr, OPT_SHB_OS, opt_str, opt_len);
|
|
g_free(opt_str);
|
|
}
|
|
/*
|
|
* UTF-8 string containing the name of the application used to create
|
|
* this section.
|
|
*/
|
|
wtap_block_add_string_option_format(shb_hdr, OPT_SHB_USERAPPL, "%s", get_appname_and_version());
|
|
|
|
/* Create fake IDB info */
|
|
exp_pdu_tap_data->idb_inf = g_new(wtapng_iface_descriptions_t,1);
|
|
exp_pdu_tap_data->idb_inf->interface_data = g_array_new(FALSE, FALSE, sizeof(wtap_block_t));
|
|
|
|
/* create the fake interface data */
|
|
int_data = wtap_block_create(WTAP_BLOCK_IF_DESCR);
|
|
int_data_mand = (wtapng_if_descr_mandatory_t*)wtap_block_get_mandatory_data(int_data);
|
|
int_data_mand->wtap_encap = WTAP_ENCAP_WIRESHARK_UPPER_PDU;
|
|
int_data_mand->time_units_per_second = 1000000000; /* default nanosecond resolution */
|
|
int_data_mand->snap_len = WTAP_MAX_PACKET_SIZE_STANDARD;
|
|
|
|
wtap_block_add_string_option(int_data, OPT_IDB_NAME, "Fake IF, PDU->Export", strlen("Fake IF, PDU->Export"));
|
|
wtap_block_add_uint8_option(int_data, OPT_IDB_TSRESOL, 9);
|
|
|
|
g_array_append_val(exp_pdu_tap_data->idb_inf->interface_data, int_data);
|
|
|
|
exp_pdu_tap_data->shb_hdrs = g_array_new(FALSE, FALSE, sizeof(wtap_block_t));
|
|
g_array_append_val(exp_pdu_tap_data->shb_hdrs, shb_hdr);
|
|
|
|
const wtap_dump_params params = {
|
|
.encap = WTAP_ENCAP_WIRESHARK_UPPER_PDU,
|
|
.snaplen = WTAP_MAX_PACKET_SIZE_STANDARD,
|
|
.shb_hdrs = exp_pdu_tap_data->shb_hdrs,
|
|
.idb_inf = exp_pdu_tap_data->idb_inf,
|
|
};
|
|
if (fd == 1) {
|
|
exp_pdu_tap_data->wdh = wtap_dump_open_stdout(WTAP_FILE_TYPE_SUBTYPE_PCAPNG,
|
|
WTAP_UNCOMPRESSED, ¶ms, &err);
|
|
} else {
|
|
exp_pdu_tap_data->wdh = wtap_dump_fdopen(fd, WTAP_FILE_TYPE_SUBTYPE_PCAPNG,
|
|
WTAP_UNCOMPRESSED, ¶ms, &err);
|
|
}
|
|
if (exp_pdu_tap_data->wdh == NULL) {
|
|
g_assert(err != 0);
|
|
return err;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
int
|
|
exp_pdu_close(exp_pdu_t *exp_pdu_tap_data)
|
|
{
|
|
int err = 0;
|
|
if (!wtap_dump_close(exp_pdu_tap_data->wdh, &err))
|
|
g_assert(err != 0);
|
|
|
|
wtap_block_array_free(exp_pdu_tap_data->shb_hdrs);
|
|
wtap_free_idb_info(exp_pdu_tap_data->idb_inf);
|
|
|
|
remove_tap_listener(exp_pdu_tap_data);
|
|
return err;
|
|
}
|
|
|
|
|
|
char *
|
|
exp_pdu_pre_open(const char *tap_name, const char *filter, exp_pdu_t *exp_pdu_tap_data)
|
|
{
|
|
GString *error_string;
|
|
|
|
/* XXX: can we always assume WTAP_ENCAP_WIRESHARK_UPPER_PDU? */
|
|
exp_pdu_tap_data->pkt_encap = wtap_wtap_encap_to_pcap_encap(WTAP_ENCAP_WIRESHARK_UPPER_PDU);
|
|
|
|
/* Register this tap listener now */
|
|
error_string = register_tap_listener(tap_name, /* The name of the tap we want to listen to */
|
|
exp_pdu_tap_data, /* instance identifier/pointer to a struct holding
|
|
* all state variables */
|
|
filter, /* pointer to a filter string */
|
|
TL_REQUIRES_PROTO_TREE, /* flags for the tap listener */
|
|
NULL,
|
|
export_pdu_packet,
|
|
NULL,
|
|
NULL);
|
|
if (error_string != NULL)
|
|
return g_string_free(error_string, FALSE);
|
|
|
|
return NULL;
|
|
}
|
|
|
|
|
|
/*
|
|
* Editor modelines
|
|
*
|
|
* Local Variables:
|
|
* c-basic-offset: 4
|
|
* tab-width: 8
|
|
* indent-tabs-mode: nil
|
|
* End:
|
|
*
|
|
* ex: set shiftwidth=4 tabstop=8 expandtab:
|
|
* :indentSize=4:tabSize=8:noTabs=true:
|
|
*/
|