4 * User Accessible Tables
5 * Maintain an array of user accessible data structures
7 * (c) 2007, Luis E. Garcia Ontanon <luis@ontanon.org>
9 * Wireshark - Network traffic analyzer
10 * By Gerald Combs <gerald@wireshark.org>
11 * Copyright 2001 Gerald Combs
13 * SPDX-License-Identifier: GPL-2.0-or-later
25 #include <wsutil/file_util.h>
26 #include <wsutil/str_util.h>
27 #include <wsutil/report_message.h>
29 #include <wsutil/filesystem.h>
30 #include <epan/packet.h>
31 #include <epan/range.h>
36 * XXX Files are encoded as ASCII. We might want to encode them as UTF8
40 static GPtrArray* all_uats = NULL;
42 uat_t* uat_new(const char* name,
45 gboolean from_profile,
50 uat_copy_cb_t copy_cb,
51 uat_update_cb_t update_cb,
52 uat_free_cb_t free_cb,
53 uat_post_update_cb_t post_update_cb,
54 uat_reset_cb_t reset_cb,
55 uat_field_t* flds_array) {
57 uat_t* uat = (uat_t *)g_malloc(sizeof(uat_t));
60 /* Add to global array of uats */
62 all_uats = g_ptr_array_new();
64 g_ptr_array_add(all_uats,uat);
67 g_assert(name && size && filename && data_ptr && numitems_ptr);
69 /* Set uat values from inputs */
70 uat->name = g_strdup(name);
71 uat->record_size = size;
72 uat->filename = g_strdup(filename);
73 uat->from_profile = from_profile;
74 /* Callers of uat_new() pass in (void*) for data_ptr, because
75 * that is the "universal" pointer type that can be cast to
76 * anything. However, for our purposes, we want a (void**).
77 * So, we cast (void*) data_ptr to (void**) here. That keeps
78 * gcc -fstrict-aliasing from complaining. */
79 uat->user_ptr = (void**) data_ptr;
80 uat->nrows_p = numitems_ptr;
81 uat->copy_cb = copy_cb;
82 uat->update_cb = update_cb;
83 uat->free_cb = free_cb;
84 uat->post_update_cb = post_update_cb;
85 uat->reset_cb = reset_cb;
86 uat->fields = flds_array;
87 uat->user_data = g_array_new(FALSE,FALSE,(guint)uat->record_size);
88 uat->raw_data = g_array_new(FALSE,FALSE,(guint)uat->record_size);
89 uat->valid_data = g_array_new(FALSE,FALSE,sizeof(gboolean));
92 uat->from_global = FALSE;
95 uat->help = g_strdup(help);
98 for (i=0;flds_array[i].title;i++) {
99 fld_data_t* f = (fld_data_t *)g_malloc(sizeof(fld_data_t));
105 flds_array[i].priv = f;
110 *((void**)data_ptr) = NULL;
116 void* uat_add_record(uat_t* uat, const void* data, gboolean valid_rec) {
120 uat_insert_record_idx(uat, uat->raw_data->len, data);
123 /* Add a "known good" record to the list to be used by the dissector */
124 g_array_append_vals (uat->user_data, data, 1);
126 rec = UAT_USER_INDEX_PTR(uat, uat->user_data->len - 1);
129 uat->copy_cb(rec, data, (unsigned int) uat->record_size);
134 valid = &g_array_index(uat->valid_data, gboolean, uat->valid_data->len-1);
143 /* Updates the validity of a record. */
144 void uat_update_record(uat_t *uat, const void *record, gboolean valid_rec) {
148 /* Locate internal UAT data pointer. */
149 for (pos = 0; pos < uat->raw_data->len; pos++) {
150 if (UAT_INDEX_PTR(uat, pos) == record) {
154 if (pos == uat->raw_data->len) {
155 /* Data is not within list?! */
156 g_assert_not_reached();
159 valid = &g_array_index(uat->valid_data, gboolean, pos);
163 void uat_swap(uat_t* uat, guint a, guint b) {
164 size_t s = uat->record_size;
168 g_assert( a < uat->raw_data->len && b < uat->raw_data->len );
173 memcpy(tmp, UAT_INDEX_PTR(uat,a), s);
174 memcpy(UAT_INDEX_PTR(uat,a), UAT_INDEX_PTR(uat,b), s);
175 memcpy(UAT_INDEX_PTR(uat,b), tmp, s);
178 tmp_bool = *(gboolean*)(uat->valid_data->data + (sizeof(gboolean) * (a)));
179 *(gboolean*)(uat->valid_data->data + (sizeof(gboolean) * (a))) = *(gboolean*)(uat->valid_data->data + (sizeof(gboolean) * (b)));
180 *(gboolean*)(uat->valid_data->data + (sizeof(gboolean) * (b))) = tmp_bool;
185 void uat_insert_record_idx(uat_t* uat, guint idx, const void *src_record) {
186 /* Allow insert before an existing item or append after the last item. */
187 g_assert( idx <= uat->raw_data->len );
189 /* Store a copy of the record and invoke copy_cb to clone pointers too. */
190 g_array_insert_vals(uat->raw_data, idx, src_record, 1);
191 void *rec = UAT_INDEX_PTR(uat, idx);
193 uat->copy_cb(rec, src_record, (unsigned int) uat->record_size);
195 memcpy(rec, src_record, (unsigned int) uat->record_size);
198 /* Initially assume that the record is invalid, it is not copied to the
199 * user-visible records list. */
200 gboolean valid_rec = FALSE;
201 g_array_insert_val(uat->valid_data, idx, valid_rec);
204 void uat_remove_record_idx(uat_t* uat, guint idx) {
206 g_assert( idx < uat->raw_data->len );
209 uat->free_cb(UAT_INDEX_PTR(uat,idx));
212 g_array_remove_index(uat->raw_data, idx);
213 g_array_remove_index(uat->valid_data, idx);
216 void uat_move_index(uat_t * uat, guint old_idx, guint new_idx)
219 guint start = old_idx;
220 if ( old_idx > new_idx )
223 while ( start != new_idx )
225 uat_swap(uat, start, start + dir);
230 /* The returned filename was g_malloc()'d so the caller must free it */
231 gchar* uat_get_actual_filename(uat_t* uat, gboolean for_writing) {
232 gchar *pers_fname = NULL;
234 if (! uat->from_global) {
235 pers_fname = get_persconffile_path(uat->filename, uat->from_profile);
238 if ((! for_writing ) && (! file_exists(pers_fname) )) {
239 gchar* data_fname = get_datafile_path(uat->filename);
241 if (file_exists(data_fname)) {
254 uat_t* uat_get_table_by_name(const char* name) {
257 for (i=0; i < all_uats->len; i++) {
258 uat_t* u = (uat_t *)g_ptr_array_index(all_uats,i);
259 if ( g_str_equal(u->name,name) ) {
267 char *uat_fld_tostr(void *rec, uat_field_t *f) {
272 f->cb.tostr(rec, &ptr, &len, f->cbdata.tostr, f->fld_data);
276 case PT_TXTMOD_STRING:
279 case PT_TXTMOD_FILENAME:
280 case PT_TXTMOD_DIRECTORYNAME:
281 case PT_TXTMOD_DISPLAY_FILTER:
282 case PT_TXTMOD_COLOR:
283 case PT_TXTMOD_PROTO_FIELD:
284 out = g_strndup(ptr, len);
286 case PT_TXTMOD_HEXBYTES: {
287 GString *s = g_string_sized_new( len*2 + 1 );
290 for (i=0; i<len;i++) g_string_append_printf(s, "%.2X", ((const guint8*)ptr)[i]);
292 out = g_strdup(s->str);
294 g_string_free(s, TRUE);
298 g_assert_not_reached();
307 static void putfld(FILE* fp, void* rec, uat_field_t* f) {
311 f->cb.tostr(rec,&fld_ptr,&fld_len,f->cbdata.tostr,f->fld_data);
316 case PT_TXTMOD_FILENAME:
317 case PT_TXTMOD_DIRECTORYNAME:
318 case PT_TXTMOD_DISPLAY_FILTER:
319 case PT_TXTMOD_PROTO_FIELD:
320 case PT_TXTMOD_COLOR:
321 case PT_TXTMOD_STRING: {
326 for(i=0;i<fld_len;i++) {
329 if (c == '"' || c == '\\' || ! g_ascii_isprint((guchar)c) ) {
330 fprintf(fp,"\\x%02x", (guchar) c);
339 case PT_TXTMOD_HEXBYTES: {
342 for(i=0;i<fld_len;i++) {
343 fprintf(fp,"%02x", (guchar)fld_ptr[i]);
348 case PT_TXTMOD_BOOL: {
349 fprintf(fp,"\"%s\"", fld_ptr);
353 g_assert_not_reached();
359 gboolean uat_save(uat_t* uat, char** error) {
361 gchar* fname = uat_get_actual_filename(uat,TRUE);
364 if (! fname ) return FALSE;
366 fp = ws_fopen(fname,"w");
368 if (!fp && errno == ENOENT) {
369 /* Parent directory does not exist, try creating first */
370 gchar *pf_dir_path = NULL;
371 if (create_persconffile_dir(&pf_dir_path) != 0) {
372 *error = g_strdup_printf("uat_save: error creating '%s'", pf_dir_path);
373 g_free (pf_dir_path);
376 fp = ws_fopen(fname,"w");
380 *error = g_strdup_printf("uat_save: error opening '%s': %s",fname,g_strerror(errno));
387 /* Ensure raw_data is synced with user_data and all "good" entries have been accounted for */
389 /* Start by clearing current user_data */
390 for ( i = 0 ; i < uat->user_data->len ; i++ ) {
392 uat->free_cb(UAT_USER_INDEX_PTR(uat,i));
395 g_array_set_size(uat->user_data,0);
397 *((uat)->user_ptr) = NULL;
398 *((uat)->nrows_p) = 0;
400 /* Now copy "good" raw_data entries to user_data */
401 for ( i = 0 ; i < uat->raw_data->len ; i++ ) {
402 void *rec = UAT_INDEX_PTR(uat, i);
403 gboolean valid = g_array_index(uat->valid_data, gboolean, i);
405 g_array_append_vals(uat->user_data, rec, 1);
407 uat->copy_cb(UAT_USER_INDEX_PTR(uat, uat->user_data->len - 1),
408 rec, (unsigned int) uat->record_size);
416 fprintf(fp,"# This file is automatically generated, DO NOT MODIFY.\n");
418 for ( i = 0 ; i < uat->user_data->len ; i++ ) {
419 void* rec = uat->user_data->data + (uat->record_size * i);
426 for( j=0 ; j < uat->ncols ; j++ ) {
427 putfld(fp, rec, &(f[j]));
428 fputs((j == uat->ncols - 1) ? "\n" : "," ,fp);
435 uat->changed = FALSE;
440 uat_t *uat_find(gchar *name) {
443 for (i=0; i < all_uats->len; i++) {
444 uat_t* u = (uat_t *)g_ptr_array_index(all_uats,i);
446 if (strcmp(u->name, name) == 0 || strcmp(u->filename, name) == 0) {
453 void uat_clear(uat_t* uat) {
456 for ( i = 0 ; i < uat->user_data->len ; i++ ) {
458 uat->free_cb(UAT_USER_INDEX_PTR(uat,i));
462 for ( i = 0 ; i < uat->raw_data->len ; i++ ) {
464 uat->free_cb(UAT_INDEX_PTR(uat,i));
468 g_array_set_size(uat->raw_data,0);
469 g_array_set_size(uat->user_data,0);
470 g_array_set_size(uat->valid_data,0);
472 *((uat)->user_ptr) = NULL;
473 *((uat)->nrows_p) = 0;
480 void uat_unload_all(void) {
483 for (i=0; i < all_uats->len; i++) {
484 uat_t* u = (uat_t *)g_ptr_array_index(all_uats,i);
485 /* Do not unload if not in profile */
486 if (u->from_profile) {
493 void uat_cleanup(void) {
498 for (i = 0; i < all_uats->len; i++) {
499 uat = (uat_t *)g_ptr_array_index(all_uats, i);
503 g_free(uat->filename);
504 g_array_free(uat->user_data, TRUE);
505 g_array_free(uat->raw_data, TRUE);
506 g_array_free(uat->valid_data, TRUE);
507 for (j = 0; uat->fields[j].title; j++)
508 g_free(uat->fields[j].priv);
512 g_ptr_array_free(all_uats,TRUE);
515 void uat_foreach_table(uat_cb_t cb,void* user_data) {
518 for (i=0; i < all_uats->len; i++)
519 cb(g_ptr_array_index(all_uats,i), user_data);
523 void uat_load_all(void) {
527 for (i=0; i < all_uats->len; i++) {
528 uat_t* u = (uat_t *)g_ptr_array_index(all_uats,i);
532 if (!uat_load(u, &err)) {
533 report_failure("Error loading table '%s': %s",u->name,err);
541 gboolean uat_fld_chk_str(void* u1 _U_, const char* strptr, guint len _U_, const void* u2 _U_, const void* u3 _U_, char** err) {
542 if (strptr == NULL) {
543 *err = g_strdup("NULL pointer");
551 gboolean uat_fld_chk_oid(void* u1 _U_, const char* strptr, guint len, const void* u2 _U_, const void* u3 _U_, char** err) {
555 if (strptr == NULL) {
556 *err = g_strdup("NULL pointer");
561 *err = g_strdup("Empty OID");
565 for(i = 0; i < len; i++)
566 if(!(g_ascii_isdigit(strptr[i]) || strptr[i] == '.')) {
567 *err = g_strdup("Only digits [0-9] and \".\" allowed in an OID");
571 if(strptr[len-1] == '.') {
572 *err = g_strdup("OIDs must not be terminated with a \".\"");
576 if(!((*strptr == '0' || *strptr == '1' || *strptr =='2') && (len > 1 && strptr[1] == '.'))) {
577 *err = g_strdup("OIDs must start with \"0.\" (ITU-T assigned), \"1.\" (ISO assigned) or \"2.\" (joint ISO/ITU-T assigned)");
581 /* should also check that the second arc is in the range 0-39 */
586 gboolean uat_fld_chk_proto(void* u1 _U_, const char* strptr, guint len, const void* u2 _U_, const void* u3 _U_, char** err) {
588 char* name = g_strndup(strptr,len);
589 ascii_strdown_inplace(name);
592 if (find_dissector(name)) {
597 *err = g_strdup("dissector not found");
607 static gboolean uat_fld_chk_num(int base, const char* strptr, guint len, char** err) {
609 char* str = g_strndup(strptr,len);
614 i = strtol(str,&strn,base);
616 if (((i == G_MAXLONG || i == G_MINLONG) && errno == ERANGE)
617 || (errno != 0 && i == 0)) {
618 *err = g_strdup(g_strerror(errno));
622 if ((*strn != '\0') && (*strn != ' ')) {
623 *err = g_strdup("Invalid value");
627 /* Allow only 32bit values */
628 if ((sizeof(long) > 4) && ((i < G_MININT) || (i > G_MAXINT))) {
629 *err = g_strdup("Value too large");
641 gboolean uat_fld_chk_num_dec(void* u1 _U_, const char* strptr, guint len, const void* u2 _U_, const void* u3 _U_, char** err) {
642 return uat_fld_chk_num(10, strptr, len, err);
645 gboolean uat_fld_chk_num_hex(void* u1 _U_, const char* strptr, guint len, const void* u2 _U_, const void* u3 _U_, char** err) {
646 return uat_fld_chk_num(16, strptr, len, err);
649 gboolean uat_fld_chk_bool(void* u1 _U_, const char* strptr, guint len, const void* u2 _U_, const void* u3 _U_, char** err)
651 char* str = g_strndup(strptr,len);
653 if ((g_strcmp0(str, "TRUE") == 0) ||
654 (g_strcmp0(str, "FALSE") == 0)) {
660 *err = g_strdup_printf("invalid value: %s (must be TRUE or FALSE)", str);
666 gboolean uat_fld_chk_enum(void* u1 _U_, const char* strptr, guint len, const void* v, const void* u3 _U_, char** err) {
667 char* str = g_strndup(strptr,len);
669 const value_string* vs = (const value_string *)v;
671 for(i=0;vs[i].strptr;i++) {
672 if (g_strcmp0(vs[i].strptr,str) == 0) {
679 *err = g_strdup_printf("invalid value: %s",str);
684 gboolean uat_fld_chk_range(void* u1 _U_, const char* strptr, guint len, const void* v _U_, const void* u3, char** err) {
685 char* str = g_strndup(strptr,len);
687 convert_ret_t ret = range_convert_str(NULL, &r, str,GPOINTER_TO_UINT(u3));
688 gboolean ret_value = FALSE;
695 case CVT_SYNTAX_ERROR:
696 *err = g_strdup_printf("syntax error in range: %s",str);
699 case CVT_NUMBER_TOO_BIG:
700 *err = g_strdup_printf("value too large in range: '%s' (max = %u)",str,GPOINTER_TO_UINT(u3));
704 *err = g_strdup("Unable to convert range. Please report this to wireshark-dev@wireshark.org");
714 gboolean uat_fld_chk_color(void* u1 _U_, const char* strptr, guint len, const void* v _U_, const void* u3 _U_, char** err) {
716 if ((len != 7) || (*strptr != '#')) {
717 *err = g_strdup("Color must be of the format #RRGGBB");
721 /* Color is just # followed by hex string, so use hex verification */
722 return uat_fld_chk_num(16, strptr + 1, len - 1, err);
725 char* uat_unbinstring(const char* si, guint in_len, guint* len_p) {
727 guint len = in_len/2;
735 buf= (guint8 *)g_malloc0(len+1);
736 if (len_p) *len_p = len;
739 d1 = ws_xton(*(si++));
740 d0 = ws_xton(*(si++));
742 buf[i++] = (d1 * 16) + d0;
750 char* uat_unesc(const char* si, guint in_len, guint* len_p) {
751 char* buf = (char *)g_malloc0(in_len+1);
755 const char* in_end = si+in_len;
757 for (s = (const char *)si; s < in_end; s++) {
761 case 'a': *(p++) = '\a'; len++; break;
762 case 'b': *(p++) = '\b'; len++; break;
763 case 'e': *(p++) = '\033' /* '\e' is non ANSI-C */; len++; break;
764 case 'f': *(p++) = '\f'; len++; break;
765 case 'n': *(p++) = '\n'; len++; break;
766 case 'r': *(p++) = '\r'; len++; break;
767 case 't': *(p++) = '\t'; len++; break;
768 case 'v': *(p++) = '\v'; len++; break;
786 if ( s[1] >= '0' && s[1] <= '7' ) {
790 if ( s[1] >= '0' && s[1] <= '7' ) {
796 c = (64 * c2) + (8 * c1) + c0;
797 *(p++) = (char) (c > 255 ? 255 : c);
807 if (g_ascii_isxdigit(c1) && g_ascii_isxdigit(c0)) {
808 *(p++) = (ws_xton(c1) * 0x10) + ws_xton(c0);
828 if (len_p) *len_p = len;
832 char* uat_undquote(const char* si, guint in_len, guint* len_p) {
833 return uat_unesc(si+1,in_len-2,len_p);
837 char* uat_esc(const char* buf, guint len) {
838 const guint8* end = ((const guint8*)buf)+len;
839 char* out = (char *)g_malloc0((4*len)+1);
843 for (b = (const guint8 *)buf; b < end; b++) {
844 if (*b == '"' || *b == '\\' || ! g_ascii_isprint(*b) ) {
845 g_snprintf(s,5,"\\x%02x",((guint)*b));
856 gboolean uat_fld_chk_str_isprint(void* u1 _U_, const char* strptr, guint len, const void* u2 _U_, const void* u3 _U_, char** err) {
859 for (i = 0; i < len; i++) {
861 if (! g_ascii_isprint(c)) {
862 *err = g_strdup_printf("invalid char pos=%d value=%02x", i, (guchar) c);
870 gboolean uat_fld_chk_str_isalpha(void* u1 _U_, const char* strptr, guint len, const void* u2 _U_, const void* u3 _U_, char** err) {
873 for (i = 0; i < len; i++) {
875 if (! g_ascii_isalpha(c)) {
876 *err = g_strdup_printf("invalid char pos=%d value=%02x", i, (guchar) c);
884 gboolean uat_fld_chk_str_isalnum(void* u1 _U_, const char* strptr, guint len, const void* u2 _U_, const void* u3 _U_, char** err) {
887 for (i = 0; i < len; i++) {
889 if (! g_ascii_isalnum(c)) {
890 *err = g_strdup_printf("invalid char pos=%d value=%02x", i, (guchar) c);
898 gboolean uat_fld_chk_str_isdigit(void* u1 _U_, const char* strptr, guint len, const void* u2 _U_, const void* u3 _U_, char** err) {
901 for (i = 0; i < len; i++) {
903 if (! g_ascii_isdigit(c)) {
904 *err = g_strdup_printf("invalid char pos=%d value=%02x", i, (guchar) c);
912 gboolean uat_fld_chk_str_isxdigit(void* u1 _U_, const char* strptr, guint len, const void* u2 _U_, const void* u3 _U_, char** err) {
915 for (i = 0; i < len; i++) {
917 if (! g_ascii_isxdigit(c)) {
918 *err = g_strdup_printf("invalid char pos=%d value=%02x", i, (guchar) c);
933 * indent-tabs-mode: nil
936 * ex: set shiftwidth=4 tabstop=8 expandtab:
937 * :indentSize=4:tabSize=8:noTabs=true: