![David Creswick](/assets/img/avatar_default.png)
The function had several deficiencies: - When "" is passed as the filename, the function returns a null pointer (due to the quirky behavior of g_strsplit_set), which causes a segfault when it's dereferenced later. I'm not sure what the correct return should be, but it shouldn't be NULL. - It leaks memory. (The array of strings returned by g_strsplit_set are never freed.) - It only strips out backslashes. That is not the only character that is disallowed in filenames, even on windows. - The functionality is already provided by eo_massage_str and it does a more complete job of it. Change-Id: I4d9eab7506048c5d04de8f163b8af1e3f67c163d Reviewed-on: https://code.wireshark.org/review/7996 Petri-Dish: Alexis La Goutte <alexis.lagoutte@gmail.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Reviewed-by: Gerald Combs <gerald@wireshark.org>
508 lines
15 KiB
C
508 lines
15 KiB
C
/* export_object.c
|
|
* Common routines for tracking & saving objects found in streams of data
|
|
* Copyright 2007, Stephen Fisher (see AUTHORS file)
|
|
*
|
|
* Wireshark - Network traffic analyzer
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
* Copyright 1998 Gerald Combs
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
|
|
* USA.
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include <gtk/gtk.h>
|
|
|
|
#include <epan/packet_info.h>
|
|
#include <epan/prefs.h>
|
|
#include <epan/tap.h>
|
|
|
|
#include <wsutil/str_util.h>
|
|
|
|
#include <ui/export_object.h>
|
|
#include <ui/simple_dialog.h>
|
|
|
|
#include "dlg_utils.h"
|
|
#include "file_dlg.h"
|
|
#include "gui_utils.h"
|
|
#include "help_dlg.h"
|
|
#include "main.h"
|
|
#include "stock_icons.h"
|
|
#include "export_object_dlg.h"
|
|
|
|
/* When a protocol needs intermediate data structures to construct the
|
|
export objects, then it must specifiy a function that cleans up all
|
|
those data structures. This function is passed to export_object_window
|
|
and called when tap reset or windows closes occurs. If no function is needed
|
|
a NULL value should be passed instead */
|
|
typedef void (*eo_protocoldata_reset_cb)(void);
|
|
|
|
enum {
|
|
EO_PKT_NUM_COLUMN,
|
|
EO_HOSTNAME_COLUMN,
|
|
EO_CONTENT_TYPE_COLUMN,
|
|
EO_BYTES_COLUMN,
|
|
EO_FILENAME_COLUMN,
|
|
EO_NUM_COLUMNS /* must be last */
|
|
};
|
|
|
|
struct _export_object_list_t {
|
|
GSList *entries;
|
|
GtkWidget *tree, *dlg;
|
|
GtkTreeView *tree_view;
|
|
GtkTreeIter *iter;
|
|
GtkTreeStore *store;
|
|
gint row_selected;
|
|
};
|
|
|
|
static eo_protocoldata_reset_cb eo_protocoldata_reset = NULL;
|
|
|
|
static void
|
|
eo_remember_this_row(GtkTreeModel *model _U_, GtkTreePath *path,
|
|
GtkTreeIter *iter _U_, gpointer arg)
|
|
{
|
|
export_object_list_t *object_list = (export_object_list_t *)arg;
|
|
export_object_entry_t *entry;
|
|
|
|
gint *path_index;
|
|
|
|
if((path_index = gtk_tree_path_get_indices(path)) == NULL)
|
|
/* Row not found in tree - shouldn't happen */
|
|
return;
|
|
|
|
object_list->row_selected = path_index[0];
|
|
|
|
/* Select the corresponding packet in the packet list */
|
|
entry = (export_object_entry_t *)g_slist_nth_data(object_list->entries,
|
|
object_list->row_selected);
|
|
cf_goto_frame(&cfile, entry->pkt_num);
|
|
}
|
|
|
|
static void
|
|
eo_remember_row_num(GtkTreeSelection *sel, gpointer data)
|
|
{
|
|
gtk_tree_selection_selected_foreach(sel, eo_remember_this_row, data);
|
|
}
|
|
|
|
|
|
/* Called when the Export Object window is closed in any way */
|
|
static void
|
|
eo_win_destroy_cb(GtkWindow *win _U_, gpointer data)
|
|
{
|
|
export_object_list_t *object_list = (export_object_list_t *)data;
|
|
export_object_entry_t *entry;
|
|
GSList *slist = object_list->entries;
|
|
|
|
remove_tap_listener(object_list);
|
|
|
|
/* Free the GSList attributes */
|
|
while(slist) {
|
|
entry = (export_object_entry_t *)slist->data;
|
|
|
|
g_free(entry->hostname);
|
|
g_free(entry->content_type);
|
|
g_free(entry->filename);
|
|
g_free(entry->payload_data);
|
|
|
|
slist = slist->next;
|
|
g_free(entry);
|
|
}
|
|
|
|
/* Free the GSList elements */
|
|
g_slist_free(object_list->entries);
|
|
g_free(object_list);
|
|
|
|
/* Free the private export_object_xxx data */
|
|
if (eo_protocoldata_reset != NULL) eo_protocoldata_reset();
|
|
}
|
|
|
|
static char *
|
|
gtk_eo_save_object_as_file(export_object_list_t *object_list, char *auxfilename)
|
|
{
|
|
GtkWidget *save_as_w;
|
|
char *pathname;
|
|
|
|
save_as_w = file_selection_new("Wireshark: Save Object As ...",
|
|
GTK_WINDOW(object_list->dlg),
|
|
FILE_SELECTION_SAVE);
|
|
|
|
gtk_file_chooser_set_current_name(GTK_FILE_CHOOSER(save_as_w),
|
|
auxfilename);
|
|
pathname = file_selection_run(save_as_w);
|
|
if (pathname == NULL) {
|
|
/* User cancelled or closed the dialog. */
|
|
return NULL;
|
|
}
|
|
|
|
/* We've crosed the Rubicon; get rid of the dialog box. */
|
|
window_destroy(save_as_w);
|
|
|
|
return pathname;
|
|
}
|
|
|
|
static void
|
|
eo_save_clicked_cb(GtkWidget *widget _U_, gpointer arg)
|
|
{
|
|
export_object_list_t *object_list = (export_object_list_t *)arg;
|
|
export_object_entry_t *entry;
|
|
GString *safe_filename = NULL;
|
|
char *pathname;
|
|
|
|
entry =(export_object_entry_t *) g_slist_nth_data(object_list->entries,
|
|
object_list->row_selected);
|
|
|
|
if(!entry) {
|
|
simple_dialog(ESD_TYPE_WARN, ESD_BTN_OK, "No object was selected for saving. Please click on an object and click save again.");
|
|
return;
|
|
}
|
|
|
|
safe_filename = eo_massage_str(entry->filename, 256, 0);
|
|
|
|
/*
|
|
* Loop until the user either selects a file or gives up.
|
|
*/
|
|
for (;;) {
|
|
pathname = gtk_eo_save_object_as_file(object_list, safe_filename->str);
|
|
if (pathname == NULL) {
|
|
/* User gave up. */
|
|
break;
|
|
}
|
|
if (eo_save_entry(pathname, entry, TRUE)) {
|
|
/* We succeeded. */
|
|
g_free(pathname);
|
|
break;
|
|
}
|
|
/* Dump failed; let the user select another file
|
|
or give up. */
|
|
g_free(pathname);
|
|
}
|
|
|
|
g_string_free(safe_filename, TRUE);
|
|
}
|
|
|
|
#define MAXFILELEN 255
|
|
static void
|
|
eo_save_all_clicked_cb(GtkWidget *widget _U_, gpointer arg)
|
|
{
|
|
gchar *save_as_fullpath = NULL;
|
|
export_object_list_t *object_list = (export_object_list_t *)arg;
|
|
export_object_entry_t *entry;
|
|
GtkWidget *save_in_w;
|
|
GSList *slist = object_list->entries;
|
|
gboolean all_saved = TRUE;
|
|
gchar *save_in_path;
|
|
GString *safe_filename;
|
|
int count = 0;
|
|
|
|
save_in_w = file_selection_new("Wireshark: Save All Objects In ...",
|
|
GTK_WINDOW(object_list->dlg),
|
|
FILE_SELECTION_CREATE_FOLDER);
|
|
|
|
if (gtk_dialog_run(GTK_DIALOG(save_in_w)) == GTK_RESPONSE_ACCEPT) {
|
|
while (slist) {
|
|
entry = (export_object_entry_t *)slist->data;
|
|
|
|
save_in_path = gtk_file_chooser_get_filename(GTK_FILE_CHOOSER(save_in_w));
|
|
if ((strlen(save_in_path) < MAXFILELEN)) {
|
|
do {
|
|
g_free(save_as_fullpath);
|
|
if (entry->filename) {
|
|
safe_filename = eo_massage_str(entry->filename,
|
|
MAXFILELEN - strlen(save_in_path), count);
|
|
} else {
|
|
char generic_name[MAXFILELEN+1];
|
|
const char *ext;
|
|
ext = ct2ext(entry->content_type);
|
|
g_snprintf(generic_name, sizeof(generic_name),
|
|
"object%u%s%s", entry->pkt_num, ext ? "." : "",
|
|
ext ? ext : "");
|
|
safe_filename = eo_massage_str(generic_name,
|
|
MAXFILELEN - strlen(save_in_path), count);
|
|
}
|
|
save_as_fullpath = g_build_filename(
|
|
save_in_path, safe_filename->str, NULL);
|
|
g_string_free(safe_filename, TRUE);
|
|
} while (g_file_test(save_as_fullpath, G_FILE_TEST_EXISTS) && ++count < 1000);
|
|
count = 0;
|
|
if (!eo_save_entry(save_as_fullpath, entry, FALSE))
|
|
all_saved = FALSE;
|
|
g_free(save_as_fullpath);
|
|
save_as_fullpath = NULL;
|
|
}
|
|
else
|
|
all_saved = FALSE;
|
|
|
|
slist = slist->next;
|
|
}
|
|
}
|
|
|
|
if (!all_saved)
|
|
simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK,
|
|
"Some files could not be saved.");
|
|
|
|
window_destroy(save_in_w);
|
|
}
|
|
|
|
/* Runs at the beginning of tapping only */
|
|
static void
|
|
eo_reset(void *tapdata)
|
|
{
|
|
export_object_list_t *object_list = (export_object_list_t *)tapdata;
|
|
|
|
object_list->entries = NULL;
|
|
object_list->iter = NULL;
|
|
object_list->row_selected = -1;
|
|
|
|
if (eo_protocoldata_reset != NULL) eo_protocoldata_reset();
|
|
}
|
|
|
|
static void
|
|
eo_draw(void *tapdata)
|
|
{
|
|
export_object_list_t *object_list = (export_object_list_t *)tapdata;
|
|
export_object_entry_t *eo_entry;
|
|
gchar *size_str;
|
|
|
|
GSList *slist = object_list->entries;
|
|
GtkTreeIter new_iter;
|
|
|
|
/* Free the tree first, since we may get called more than once for the same capture
|
|
Not doing so caused duplicate entries and clicking them caused crashes.
|
|
*/
|
|
|
|
gtk_tree_store_clear(object_list->store);
|
|
|
|
while(slist) {
|
|
eo_entry = (export_object_entry_t *)slist->data;
|
|
|
|
gtk_tree_store_append(object_list->store, &new_iter,
|
|
object_list->iter);
|
|
|
|
size_str = format_size(eo_entry->payload_len, (format_size_flags_e)(format_size_unit_bytes|format_size_prefix_si));
|
|
gtk_tree_store_set(object_list->store, &new_iter,
|
|
EO_PKT_NUM_COLUMN, eo_entry->pkt_num,
|
|
EO_HOSTNAME_COLUMN, eo_entry->hostname,
|
|
EO_CONTENT_TYPE_COLUMN, eo_entry->content_type,
|
|
EO_BYTES_COLUMN, size_str,
|
|
EO_FILENAME_COLUMN, eo_entry->filename,
|
|
-1);
|
|
g_free(size_str);
|
|
|
|
slist = slist->next;
|
|
}
|
|
}
|
|
|
|
void object_list_add_entry(export_object_list_t *object_list, export_object_entry_t *entry)
|
|
{
|
|
object_list->entries = g_slist_append(object_list->entries, entry);
|
|
}
|
|
|
|
export_object_entry_t *object_list_get_entry(export_object_list_t *object_list, int row) {
|
|
return (export_object_entry_t *)g_slist_nth_data(object_list->entries, row);
|
|
}
|
|
|
|
static void
|
|
export_object_window(const gchar *tapname, const gchar *name, tap_packet_cb tap_packet, eo_protocoldata_reset_cb eo_protocoldata_resetfn)
|
|
{
|
|
GtkWidget *sw;
|
|
GtkCellRenderer *renderer;
|
|
GtkTreeViewColumn *column;
|
|
GtkTreeSelection *selection;
|
|
GtkWidget *vbox, *bbox, *help_bt, *cancel_bt, *save_bt, *save_all_bt;
|
|
GString *error_msg;
|
|
export_object_list_t *object_list;
|
|
gchar *window_title;
|
|
|
|
/* Initialize the pointer to the private data clearing function */
|
|
eo_protocoldata_reset = eo_protocoldata_resetfn;
|
|
|
|
/* Initialize our object list structure */
|
|
object_list = g_new0(export_object_list_t,1);
|
|
|
|
/* Data will be gathered via a tap callback */
|
|
error_msg = register_tap_listener(tapname, object_list, NULL, 0,
|
|
eo_reset,
|
|
tap_packet,
|
|
eo_draw);
|
|
|
|
if (error_msg) {
|
|
simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK,
|
|
"Can't register %s tap: %s\n", name, error_msg->str);
|
|
g_string_free(error_msg, TRUE);
|
|
g_free(object_list);
|
|
return;
|
|
}
|
|
|
|
/* Setup our GUI window */
|
|
window_title = g_strdup_printf("Wireshark: %s object list", name);
|
|
object_list->dlg = dlg_window_new(window_title);
|
|
g_free(window_title);
|
|
|
|
gtk_window_set_default_size(GTK_WINDOW(object_list->dlg),
|
|
DEF_WIDTH, DEF_HEIGHT);
|
|
|
|
vbox = ws_gtk_box_new(GTK_ORIENTATION_VERTICAL, 5, FALSE);
|
|
|
|
gtk_container_set_border_width(GTK_CONTAINER(vbox), 5);
|
|
gtk_container_add(GTK_CONTAINER(object_list->dlg), vbox);
|
|
|
|
sw = scrolled_window_new(NULL, NULL);
|
|
gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(sw),
|
|
GTK_SHADOW_IN);
|
|
|
|
gtk_box_pack_start(GTK_BOX (vbox), sw, TRUE, TRUE, 0);
|
|
|
|
object_list->store = gtk_tree_store_new(EO_NUM_COLUMNS,
|
|
G_TYPE_INT, G_TYPE_STRING,
|
|
/* we need a UINT64
|
|
(was G_TYPE_STRING, G_TYPE_INT,) */
|
|
G_TYPE_STRING, G_TYPE_STRING,
|
|
G_TYPE_STRING);
|
|
|
|
object_list->tree = tree_view_new(GTK_TREE_MODEL(object_list->store));
|
|
g_object_unref(G_OBJECT(object_list->store));
|
|
|
|
object_list->tree_view = GTK_TREE_VIEW(object_list->tree);
|
|
|
|
renderer = gtk_cell_renderer_text_new();
|
|
column = gtk_tree_view_column_new_with_attributes("Packet num",
|
|
renderer,
|
|
"text",
|
|
EO_PKT_NUM_COLUMN,
|
|
NULL);
|
|
gtk_tree_view_column_set_sizing(column, GTK_TREE_VIEW_COLUMN_AUTOSIZE);
|
|
gtk_tree_view_append_column(object_list->tree_view, column);
|
|
|
|
renderer = gtk_cell_renderer_text_new();
|
|
column = gtk_tree_view_column_new_with_attributes("Hostname",
|
|
renderer,
|
|
"text",
|
|
EO_HOSTNAME_COLUMN,
|
|
NULL);
|
|
gtk_tree_view_column_set_sizing(column, GTK_TREE_VIEW_COLUMN_AUTOSIZE);
|
|
gtk_tree_view_append_column(object_list->tree_view, column);
|
|
|
|
renderer = gtk_cell_renderer_text_new();
|
|
column = gtk_tree_view_column_new_with_attributes("Content Type",
|
|
renderer,
|
|
"text",
|
|
EO_CONTENT_TYPE_COLUMN,
|
|
NULL);
|
|
gtk_tree_view_column_set_sizing(column, GTK_TREE_VIEW_COLUMN_AUTOSIZE);
|
|
gtk_tree_view_append_column(object_list->tree_view, column);
|
|
|
|
renderer = gtk_cell_renderer_text_new();
|
|
column = gtk_tree_view_column_new_with_attributes("Size",
|
|
renderer,
|
|
"text",
|
|
EO_BYTES_COLUMN,
|
|
NULL);
|
|
gtk_tree_view_column_set_sizing(column, GTK_TREE_VIEW_COLUMN_AUTOSIZE);
|
|
gtk_tree_view_append_column(object_list->tree_view, column);
|
|
|
|
renderer = gtk_cell_renderer_text_new();
|
|
column = gtk_tree_view_column_new_with_attributes("Filename",
|
|
renderer,
|
|
"text",
|
|
EO_FILENAME_COLUMN,
|
|
NULL);
|
|
gtk_tree_view_column_set_sizing(column, GTK_TREE_VIEW_COLUMN_AUTOSIZE);
|
|
gtk_tree_view_append_column(object_list->tree_view, column);
|
|
|
|
gtk_container_add(GTK_CONTAINER(sw), object_list->tree);
|
|
|
|
selection = gtk_tree_view_get_selection(object_list->tree_view);
|
|
g_signal_connect(selection, "changed", G_CALLBACK(eo_remember_row_num), object_list);
|
|
|
|
bbox = dlg_button_row_new(GTK_STOCK_HELP, WIRESHARK_STOCK_SAVE_ALL, GTK_STOCK_SAVE_AS, GTK_STOCK_CANCEL, NULL);
|
|
|
|
/* Help button */
|
|
help_bt = (GtkWidget *)g_object_get_data(G_OBJECT(bbox), GTK_STOCK_HELP);
|
|
g_signal_connect(help_bt, "clicked", G_CALLBACK(topic_cb), (gpointer)HELP_EXPORT_OBJECT_LIST);
|
|
gtk_widget_set_tooltip_text(help_bt, "Show help for this dialog.");
|
|
|
|
/* Save All button */
|
|
save_all_bt = (GtkWidget *)g_object_get_data(G_OBJECT(bbox), WIRESHARK_STOCK_SAVE_ALL);
|
|
g_signal_connect(save_all_bt, "clicked", G_CALLBACK(eo_save_all_clicked_cb),
|
|
object_list);
|
|
gtk_widget_set_tooltip_text(save_all_bt, "Save all listed objects with their displayed filenames.");
|
|
|
|
/* Save As button */
|
|
save_bt = (GtkWidget *)g_object_get_data(G_OBJECT(bbox), GTK_STOCK_SAVE_AS);
|
|
g_signal_connect(save_bt, "clicked", G_CALLBACK(eo_save_clicked_cb), object_list);
|
|
gtk_widget_set_tooltip_text(save_bt, "Saves the currently selected content to a file.");
|
|
|
|
/* Cancel button */
|
|
cancel_bt = (GtkWidget *)g_object_get_data(G_OBJECT(bbox), GTK_STOCK_CANCEL);
|
|
gtk_widget_set_tooltip_text(cancel_bt, "Cancel this dialog.");
|
|
|
|
/* Pack the buttons into the "button box" */
|
|
gtk_box_pack_end(GTK_BOX(vbox), bbox, FALSE, FALSE, 0);
|
|
gtk_widget_show(bbox);
|
|
|
|
/* Setup cancel/delete/destroy signal handlers */
|
|
g_signal_connect(object_list->dlg, "delete_event", G_CALLBACK(window_delete_event_cb), NULL);
|
|
g_signal_connect(object_list->dlg, "destroy",
|
|
G_CALLBACK(eo_win_destroy_cb), object_list);
|
|
window_set_cancel_button(object_list->dlg, cancel_bt,
|
|
window_cancel_button_cb);
|
|
|
|
/* Show the window */
|
|
gtk_widget_show_all(object_list->dlg);
|
|
window_present(object_list->dlg);
|
|
|
|
cf_retap_packets(&cfile);
|
|
}
|
|
|
|
void
|
|
eo_dicom_cb(GtkWidget *widget _U_, gpointer data _U_)
|
|
{
|
|
export_object_window("dicom_eo", "DICOM", eo_dicom_packet, NULL);
|
|
}
|
|
|
|
void
|
|
eo_http_cb(GtkWidget *widget _U_, gpointer data _U_)
|
|
{
|
|
export_object_window("http_eo", "HTTP", eo_http_packet, NULL);
|
|
}
|
|
|
|
void
|
|
eo_smb_cb(GtkWidget *widget _U_, gpointer data _U_)
|
|
{
|
|
/* Call the export_object window */
|
|
export_object_window("smb_eo", "SMB", eo_smb_packet, eo_smb_cleanup);
|
|
}
|
|
|
|
void
|
|
eo_tftp_cb(GtkWidget *widget _U_, gpointer data _U_)
|
|
{
|
|
/* Call the export_object window */
|
|
export_object_window("tftp_eo", "TFTP", eo_tftp_packet, eo_tftp_cleanup);
|
|
}
|
|
|
|
/*
|
|
* Editor modelines - http://www.wireshark.org/tools/modelines.html
|
|
*
|
|
* Local variables:
|
|
* c-basic-offset: 8
|
|
* tab-width: 8
|
|
* indent-tabs-mode: t
|
|
* End:
|
|
*
|
|
* vi: set shiftwidth=8 tabstop=8 noexpandtab:
|
|
* :indentSize=8:tabSize=8:noTabs=false:
|
|
*/
|