/* plugins.c * plugin routines * * $Id: plugins.c,v 1.15 2001/01/03 07:53:46 guy Exp $ * * Ethereal - Network traffic analyzer * By Gerald Combs * Copyright 1999 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ #ifdef HAVE_CONFIG_H # include "config.h" #endif #include #include "plugins.h" #ifdef HAVE_PLUGINS #include #ifdef HAVE_DIRENT_H #include #endif #ifdef HAVE_DIRECT_H #include #endif #include #include #include #ifdef HAVE_SYS_STAT_H #include #endif #ifdef HAVE_SYS_TYPES_H #include #endif #ifdef HAVE_FCNTL_H #include #endif #ifdef HAVE_UNISTD_H #include #endif #include "filesystem.h" #ifdef PLUGINS_NEED_ADDRESS_TABLE #include "plugins/plugin_table.h" static plugin_address_table_t patable; #endif /* linked list of all plugins */ plugin *plugin_list; guint32 enabled_plugins_number; /* * New-style plugins, which don't have an enabled flag (you use the * standard mechanism for enabling and disabling protocols), and which * don't have a protocol or filter string (you use the register handoff * mechanism). */ typedef struct _new_plugin { GModule *handle; /* handle returned by dlopen */ gchar *name; /* plugin name */ gchar *version; /* plugin version */ void (*reg_handoff)(void); /* routine to call to register dissector handoff */ struct _new_plugin *next; /* forward link */ } new_plugin; /* linked list of all new-style plugins */ static new_plugin *new_plugin_list; #ifdef WIN32 static gchar std_plug_dir[] = "c:/program files/ethereal/plugins/0.8.14.1"; static gchar local_plug_dir[] = "c:/ethereal/plugins/0.8.14.1"; #else static gchar std_plug_dir[] = "/usr/lib/ethereal/plugins/0.8.14"; static gchar local_plug_dir[] = "/usr/local/lib/ethereal/plugins/0.8.14"; #endif static gchar *user_plug_dir = NULL; static gchar *plugin_status_file = NULL; #define PLUGINS_STATUS "plugins.status" #define PLUGINS_DIR_NAME "plugins" /* * add a new plugin to the list * returns : * - 0 : OK * - ENOMEM : memory allocation problem * - EEXIST : the same plugin (i.e. name/version) was already registered. */ int add_plugin(void *handle, gchar *name, gchar *version, gchar *protocol, gchar *filter_string, dfilter *filter, void (*dissector) (const u_char *, int, frame_data *, proto_tree *)) { plugin *new_plug, *pt_plug; pt_plug = plugin_list; if (!pt_plug) /* the list is empty */ { new_plug = (plugin *)g_malloc(sizeof(plugin)); if (new_plug == NULL) return ENOMEM; plugin_list = new_plug; } else { while (1) { /* check if the same name/version is already registered */ if (!strcmp(pt_plug->name, name) && !strcmp(pt_plug->version, version)) { return EEXIST; } /* we found the last plugin in the list */ if (pt_plug->next == NULL) break; pt_plug = pt_plug->next; } new_plug = (plugin *)g_malloc(sizeof(plugin)); if (new_plug == NULL) return ENOMEM; pt_plug->next = new_plug; } new_plug->handle = handle; new_plug->name = name; new_plug->version = version; new_plug->enabled = FALSE; new_plug->protocol = protocol; new_plug->filter_string = g_strdup(filter_string); new_plug->filter = filter; new_plug->dissector = dissector; new_plug->next = NULL; return 0; } /* * enable a plugin * returns a pointer to the enabled plugin, or NULL if the plugin wasn't found * in the list */ void * enable_plugin(const gchar *name, const gchar *version) { plugin *pt_plug; pt_plug = plugin_list; while (pt_plug) { if (!strcmp(pt_plug->name, name) && !strcmp(pt_plug->version, version)) { pt_plug->enabled = TRUE; enabled_plugins_number++; return pt_plug; } pt_plug = pt_plug->next; } return NULL; } /* * disable a plugin * returns a pointer to the disabled plugin, or NULL if the plugin wasn't found * in the list */ void * disable_plugin(const gchar *name, const gchar *version) { plugin *pt_plug; pt_plug = plugin_list; while (pt_plug) { if (!strcmp(pt_plug->name, name) && !strcmp(pt_plug->version, version)) { pt_plug->enabled = FALSE; enabled_plugins_number--; return pt_plug; } pt_plug = pt_plug->next; } return NULL; } /* * find a plugin using its name/version */ void * find_plugin(const gchar *name, const gchar *version) { plugin *pt_plug; pt_plug = plugin_list; while (pt_plug) { if (!strcmp(pt_plug->name, name) && !strcmp(pt_plug->version, version)) { return pt_plug; } pt_plug = pt_plug->next; } return NULL; } /* * check if a plugin is enabled */ gboolean is_enabled(const gchar *name, const gchar *version) { plugin *pt_plug; pt_plug = plugin_list; while (pt_plug) { if (!strcmp(pt_plug->name, name) && !strcmp(pt_plug->version, version)) return pt_plug->enabled; pt_plug = pt_plug->next; } return FALSE; } /* * replace the filter used by a plugin (filter string and dfilter) */ void plugin_replace_filter(const gchar *name, const gchar *version, const gchar *filter_string, dfilter *filter) { plugin *pt_plug; pt_plug = plugin_list; while (pt_plug) { if (!strcmp(pt_plug->name, name) && !strcmp(pt_plug->version, version)) { g_free(pt_plug->filter_string); pt_plug->filter_string = g_strdup(filter_string); dfilter_destroy(pt_plug->filter); pt_plug->filter = filter; return; } pt_plug = pt_plug->next; } } /* * save plugin status, returns 0 on success, -1 on failure: * file format : * for each plugin, two lines are saved : * plugin_name plugin_version [0|1] (0: disabled, 1: enabled) * filter_string * * Ex : * gryphon.so 0.8.0 1 * tcp.port == 7000 */ int save_plugin_status(void) { gchar *pf_path; FILE *statusfile; plugin *pt_plug; if (!plugin_status_file) { plugin_status_file = (gchar *)g_malloc(strlen(get_home_dir()) + strlen(PF_DIR) + strlen(PLUGINS_STATUS) + 3); sprintf(plugin_status_file, "%s/%s/%s", get_home_dir(), PF_DIR, PLUGINS_STATUS); } statusfile=fopen(plugin_status_file, "w"); if (!statusfile) { pf_path = g_malloc(strlen(get_home_dir()) + strlen(PF_DIR) + 2); sprintf(pf_path, "%s/%s", get_home_dir(), PF_DIR); #ifdef WIN32 mkdir(pf_path); #else mkdir(pf_path, 0755); #endif g_free(pf_path); statusfile=fopen(plugin_status_file, "w"); if (!statusfile) return -1; } pt_plug = plugin_list; while (pt_plug) { fprintf(statusfile,"%s %s %s\n%s\n", pt_plug->name, pt_plug->version, (pt_plug->enabled ? "1" : "0"), pt_plug->filter_string); pt_plug = pt_plug->next; } fclose(statusfile); return 0; } /* * Check if the status of this plugin has been saved. * If necessary, enable the plugin, and change the filter. */ static void check_plugin_status(gchar *name, gchar *version, GModule *handle, gchar *filter_string, FILE *statusfile) { gchar *ref_string; guint16 ref_string_len; gchar line[512]; dfilter *filter; if (!statusfile) return; ref_string = (gchar *)g_malloc(strlen(name) + strlen(version) + 2); ref_string_len = sprintf(ref_string, "%s %s", name, version); while (!feof(statusfile)) { if (fgets(line, 512, statusfile) == NULL) return; if (strncmp(line, ref_string, ref_string_len) != 0) { /* not the right plugin */ if (fgets(line, 512, statusfile) == NULL) return; } else { /* found the plugin */ if (line[ref_string_len+1] == '1') { if (init_plugin(name, version) != NULL) return; } if (fgets(line, 512, statusfile) == NULL) return; if (line[strlen(line)-1] == '\n') line[strlen(line)-1] = '\0'; /* only compile the new filter if it is different from the default */ if (strcmp(line, filter_string) && dfilter_compile(line, &filter) == 0) plugin_replace_filter(name, version, line, filter); return; } } g_free(ref_string); } /* * add a new new-style plugin to the list * returns : * - 0 : OK * - ENOMEM : memory allocation problem * - EEXIST : the same plugin (i.e. name/version) was already registered. */ static int new_add_plugin(void *handle, gchar *name, gchar *version, void (*reg_handoff)(void)) { new_plugin *new_plug, *pt_plug; pt_plug = new_plugin_list; if (!pt_plug) /* the list is empty */ { new_plug = (new_plugin *)g_malloc(sizeof(new_plugin)); if (new_plug == NULL) return ENOMEM; new_plugin_list = new_plug; } else { while (1) { /* check if the same name/version is already registered */ if (!strcmp(pt_plug->name, name) && !strcmp(pt_plug->version, version)) { return EEXIST; } /* we found the last plugin in the list */ if (pt_plug->next == NULL) break; pt_plug = pt_plug->next; } new_plug = (new_plugin *)g_malloc(sizeof(new_plugin)); if (new_plug == NULL) return ENOMEM; pt_plug->next = new_plug; } new_plug->handle = handle; new_plug->name = name; new_plug->version = version; new_plug->reg_handoff = reg_handoff; new_plug->next = NULL; return 0; } /* * Initialize a plugin. * Returns NULL on success, pointer to an error message on error. */ char * init_plugin(gchar *name, gchar *version) { plugin *pt_plug; gpointer symbol; void (*plugin_init)(void*); /* Try to find the plugin. */ if ((pt_plug = enable_plugin(name, version)) == NULL) return "Plugin not found"; /* Try to get the initialization routine for the plugin. */ if (!g_module_symbol(pt_plug->handle, "plugin_init", &symbol)) return "Failed to find plugin_init()"; plugin_init = symbol; /* We found it; now call it. */ #ifdef PLUGINS_NEED_ADDRESS_TABLE plugin_init(&patable); #else plugin_init(NULL); #endif return NULL; } static void plugins_scan_dir(const char *dirname) { #define FILENAME_LEN 1024 gchar *hack_path; /* pathname used to construct lt_lib_ext */ gchar *lt_lib_ext; /* extension for loadable modules */ DIR *dir; /* scanned directory */ struct dirent *file; /* current file */ gchar filename[FILENAME_LEN]; /* current file name */ GModule *handle; /* handle returned by dlopen */ gchar *name; gchar *version; void (*init)(void *); void (*reg_handoff)(void); gchar *protocol; gchar *filter_string; gchar *dot; dfilter *filter = NULL; void (*dissector) (const u_char *, int, frame_data *, proto_tree *); int cr; FILE *statusfile; /* * We find the extension used on this platform for loadable modules * by the sneaky hack of calling "g_module_build_path" to build * the pathname for a module with an empty directory name and * empty module name, and then search for the last "." and use * everything from the last "." on. * * GLib 2.0 will probably define G_MODULE_SUFFIX as the extension * to use, but that's not checked into the GLib CVS tree yet, * and we can't use it on systems that don't have GLib 2.0. */ hack_path = g_module_build_path("", ""); lt_lib_ext = strrchr(hack_path, '.'); if (lt_lib_ext == NULL) { /* * Does this mean there *is* no extension? Assume so. * * XXX - the code below assumes that all loadable modules have * an extension.... */ lt_lib_ext = ""; } if (!plugin_status_file) { plugin_status_file = (gchar *)g_malloc(strlen(get_home_dir()) + strlen(PF_DIR) + strlen(PLUGINS_STATUS) + 3); sprintf(plugin_status_file, "%s/%s/%s", get_home_dir(), PF_DIR, PLUGINS_STATUS); } statusfile = fopen(plugin_status_file, "r"); if ((dir = opendir(dirname)) != NULL) { while ((file = readdir(dir)) != NULL) { /* don't try to open "." and ".." */ if (!(strcmp(file->d_name, "..") && strcmp(file->d_name, "."))) continue; /* skip anything but files with lt_lib_ext */ dot = strrchr(file->d_name, '.'); if (dot == NULL || strcmp(dot, lt_lib_ext) != 0) continue; snprintf(filename, FILENAME_LEN, "%s" G_DIR_SEPARATOR_S "%s", dirname, file->d_name); if ((handle = g_module_open(filename, 0)) == NULL) continue; name = (gchar *)file->d_name; if (g_module_symbol(handle, "version", (gpointer*)&version) == FALSE) { g_warning("The plugin %s has no version symbol", name); g_module_close(handle); continue; } /* * If we have a "plugin_reg_handoff()" routine, we don't require * the plugin to have "protocol", "filter_string", or "dissector" * variables - we'll call the "plugin_reg_handoff()" routine and * assume it'll register the dissector with the appropriate * handoff tables. */ if (g_module_symbol(handle, "plugin_reg_handoff", (gpointer*)®_handoff)) { /* * We require it to have a "plugin_init()" routine. */ if (!g_module_symbol(handle, "plugin_init", (gpointer*)&init)) { g_warning("The plugin %s has a plugin_reg_handoff symbol but no plugin_init routine", name); g_module_close(handle); continue; } /* * We have a "plugin_reg_handoff()" routine, so we don't * need the protocol, filter string, or dissector pointer. */ if ((cr = new_add_plugin(handle, g_strdup(file->d_name), version, reg_handoff))) { if (cr == EEXIST) fprintf(stderr, "The plugin : %s, version %s\n" "was found in multiple directories\n", name, version); else fprintf(stderr, "Memory allocation problem\n" "when processing plugin %s, version %sn", name, version); g_module_close(handle); continue; } /* * Call its init routine. */ #ifdef PLUGINS_NEED_ADDRESS_TABLE init(&patable); #else init(NULL); #endif } else { if (g_module_symbol(handle, "protocol", (gpointer*)&protocol) == FALSE) { g_warning("The plugin %s has no protocol symbol and no plugin_reg_handoff symbol", name); g_module_close(handle); continue; } if (g_module_symbol(handle, "filter_string", (gpointer*)&filter_string) == FALSE) { g_warning("The plugin %s has no filter_string symbol and no plugin_reg_handoff symbol", name); g_module_close(handle); continue; } if (dfilter_compile(filter_string, &filter) != 0) { g_warning("The plugin %s has a non-compilable filter", name); g_module_close(handle); continue; } if (g_module_symbol(handle, "dissector", (gpointer*)&dissector) == FALSE) { if (filter != NULL) dfilter_destroy(filter); g_warning("The plugin %s has no dissector symbol and no plugin_reg_handoff symbol", name); g_module_close(handle); continue; } if ((cr = add_plugin(handle, g_strdup(file->d_name), version, protocol, filter_string, filter, dissector))) { if (cr == EEXIST) fprintf(stderr, "The plugin : %s, version %s\n" "was found in multiple directories\n", name, version); else fprintf(stderr, "Memory allocation problem\n" "when processing plugin %s, version %sn", name, version); if (filter != NULL) dfilter_destroy(filter); g_module_close(handle); continue; } if (statusfile) { check_plugin_status(file->d_name, version, handle, filter_string, statusfile); rewind(statusfile); } } } closedir(dir); } g_free(hack_path); if (statusfile) fclose(statusfile); } /* * init plugins */ void init_plugins(const char *plugin_dir) { struct stat std_dir_stat, local_dir_stat, plugin_dir_stat; new_plugin *pt_plug; if (plugin_list == NULL) /* ensure init_plugins is only run once */ { enabled_plugins_number = 0; #ifdef PLUGINS_NEED_ADDRESS_TABLE /* Intialize address table */ patable.p_check_col = check_col; patable.p_col_add_fstr = col_add_fstr; patable.p_col_append_fstr = col_append_fstr; patable.p_col_add_str = col_add_str; patable.p_col_append_str = col_append_str; patable.p_dfilter_init = dfilter_init; patable.p_dfilter_cleanup = dfilter_cleanup; patable.p_pi = π patable.p_proto_register_protocol = proto_register_protocol; patable.p_proto_register_field_array = proto_register_field_array; patable.p_proto_register_subtree_array = proto_register_subtree_array; patable.p_dissector_add = dissector_add; patable.p_old_dissector_add = old_dissector_add; patable.p_dissector_delete = dissector_delete; patable.p_heur_dissector_add = heur_dissector_add; patable.p_register_dissector = register_dissector; patable.p_find_dissector = find_dissector; patable.p_old_call_dissector = old_call_dissector; patable.p_call_dissector = call_dissector; patable.p_dissect_data = dissect_data; patable.p_old_dissect_data = old_dissect_data; patable.p_proto_is_protocol_enabled = proto_is_protocol_enabled; patable.p_proto_item_get_len = proto_item_get_len; patable.p_proto_item_set_len = proto_item_set_len; patable.p_proto_item_set_text = proto_item_set_text; patable.p_proto_item_add_subtree = proto_item_add_subtree; patable.p_proto_tree_add_item = proto_tree_add_item; patable.p_proto_tree_add_item_hidden = proto_tree_add_item_hidden; patable.p_proto_tree_add_protocol_format = proto_tree_add_protocol_format; patable.p_proto_tree_add_bytes = proto_tree_add_bytes; patable.p_proto_tree_add_bytes_hidden = proto_tree_add_bytes_hidden; patable.p_proto_tree_add_bytes_format = proto_tree_add_bytes_format; patable.p_proto_tree_add_time = proto_tree_add_time; patable.p_proto_tree_add_time_hidden = proto_tree_add_time_hidden; patable.p_proto_tree_add_time_format = proto_tree_add_time_format; patable.p_proto_tree_add_ipxnet = proto_tree_add_ipxnet; patable.p_proto_tree_add_ipxnet_hidden = proto_tree_add_ipxnet_hidden; patable.p_proto_tree_add_ipxnet_format = proto_tree_add_ipxnet_format; patable.p_proto_tree_add_ipv4 = proto_tree_add_ipv4; patable.p_proto_tree_add_ipv4_hidden = proto_tree_add_ipv4_hidden; patable.p_proto_tree_add_ipv4_format = proto_tree_add_ipv4_format; patable.p_proto_tree_add_ipv6 = proto_tree_add_ipv6; patable.p_proto_tree_add_ipv6_hidden = proto_tree_add_ipv6_hidden; patable.p_proto_tree_add_ipv6_format = proto_tree_add_ipv6_format; patable.p_proto_tree_add_ether = proto_tree_add_ether; patable.p_proto_tree_add_ether_hidden = proto_tree_add_ether_hidden; patable.p_proto_tree_add_ether_format = proto_tree_add_ether_format; patable.p_proto_tree_add_string = proto_tree_add_string; patable.p_proto_tree_add_string_hidden = proto_tree_add_string_hidden; patable.p_proto_tree_add_string_format = proto_tree_add_string_format; patable.p_proto_tree_add_boolean = proto_tree_add_boolean; patable.p_proto_tree_add_boolean_hidden = proto_tree_add_boolean_hidden; patable.p_proto_tree_add_boolean_format = proto_tree_add_boolean_format; patable.p_proto_tree_add_double = proto_tree_add_double; patable.p_proto_tree_add_double_hidden = proto_tree_add_double_hidden; patable.p_proto_tree_add_double_format = proto_tree_add_double_format; patable.p_proto_tree_add_uint = proto_tree_add_uint; patable.p_proto_tree_add_uint_hidden = proto_tree_add_uint_hidden; patable.p_proto_tree_add_uint_format = proto_tree_add_uint_format; patable.p_proto_tree_add_int = proto_tree_add_int; patable.p_proto_tree_add_int_hidden = proto_tree_add_int_hidden; patable.p_proto_tree_add_int_format = proto_tree_add_int_format; patable.p_proto_tree_add_text = proto_tree_add_text; patable.p_proto_tree_add_notext = proto_tree_add_notext; patable.p_tvb_new_subset = tvb_new_subset; patable.p_tvb_length = tvb_length; patable.p_tvb_length_remaining = tvb_length_remaining; patable.p_tvb_bytes_exist = tvb_bytes_exist; patable.p_tvb_offset_exists = tvb_offset_exists; patable.p_tvb_reported_length = tvb_reported_length; patable.p_tvb_get_guint8 = tvb_get_guint8; patable.p_tvb_get_ntohs = tvb_get_ntohs; patable.p_tvb_get_ntoh24 = tvb_get_ntoh24; patable.p_tvb_get_ntohl = tvb_get_ntohl; #ifdef G_HAVE_GINT64 patable.p_tvb_get_ntohll = tvb_get_ntohll; #endif patable.p_tvb_get_letohs = tvb_get_letohs; patable.p_tvb_get_letoh24 = tvb_get_letoh24; patable.p_tvb_get_letohl = tvb_get_letohl; #ifdef G_HAVE_GINT64 patable.p_tvb_get_letohll = tvb_get_letohll; #endif patable.p_tvb_memcpy = tvb_memcpy; patable.p_tvb_memdup = tvb_memdup; patable.p_tvb_get_ptr = tvb_get_ptr; patable.p_tvb_find_guint8 = tvb_find_guint8; patable.p_tvb_pbrk_guint8 = tvb_pbrk_guint8; patable.p_tvb_strnlen = tvb_strnlen; patable.p_tvb_format_text = tvb_format_text; patable.p_tvb_get_nstringz = tvb_get_nstringz; patable.p_tvb_get_nstringz0 = tvb_get_nstringz0; patable.p_tvb_find_line_end = tvb_find_line_end; patable.p_tvb_find_line_end_unquoted = tvb_find_line_end_unquoted; patable.p_tvb_strneql = tvb_strneql; patable.p_tvb_strncaseeql = tvb_strncaseeql; patable.p_tvb_bytes_to_str = tvb_bytes_to_str; patable.p_prefs_register_protocol = prefs_register_protocol; patable.p_prefs_register_uint_preference = prefs_register_uint_preference; patable.p_prefs_register_bool_preference = prefs_register_bool_preference; patable.p_prefs_register_enum_preference = prefs_register_enum_preference; #endif plugins_scan_dir(std_plug_dir); plugins_scan_dir(local_plug_dir); if ((strcmp(std_plug_dir, plugin_dir) != 0) && (strcmp(local_plug_dir, plugin_dir) != 0)) { if (stat(plugin_dir, &plugin_dir_stat) == 0) { /* check if plugin_dir is really different from std_dir and * local_dir if they exist ! */ if (stat(std_plug_dir, &std_dir_stat) == 0) { if (stat(local_plug_dir, &local_dir_stat) == 0) { if ((plugin_dir_stat.st_dev != std_dir_stat.st_dev || plugin_dir_stat.st_ino != std_dir_stat.st_ino) && (plugin_dir_stat.st_dev != local_dir_stat.st_dev || plugin_dir_stat.st_ino != local_dir_stat.st_ino)) plugins_scan_dir(plugin_dir); } else { if ((plugin_dir_stat.st_dev != std_dir_stat.st_dev || plugin_dir_stat.st_ino != std_dir_stat.st_ino)) plugins_scan_dir(plugin_dir); } } else if (stat(local_plug_dir, &local_dir_stat) == 0) { if ((plugin_dir_stat.st_dev != local_dir_stat.st_dev || plugin_dir_stat.st_ino != local_dir_stat.st_ino)) plugins_scan_dir(plugin_dir); } else plugins_scan_dir(plugin_dir); } } if (!user_plug_dir) { user_plug_dir = (gchar *)g_malloc(strlen(get_home_dir()) + strlen(PF_DIR) + strlen(PLUGINS_DIR_NAME) + 3); sprintf(user_plug_dir, "%s/%s/%s", get_home_dir(), PF_DIR, PLUGINS_DIR_NAME); } plugins_scan_dir(user_plug_dir); } /* * For all new-style plugins, call the register-handoff routine. * (We defer this until after registering all new-style plugins, * in case one plugin registers itself with another plugin; we * need to register all plugins, so their dissector tables are * initialized.) * * We treat those protocols as always being enabled; they should * use the standard mechanism for enabling/disabling protocols, not * the plugin-specific mechanism. */ for (pt_plug = new_plugin_list; pt_plug != NULL; pt_plug = pt_plug->next) (pt_plug->reg_handoff)(); } #endif