2000-08-08 22:16:42 +00:00
|
|
|
/* csids.c
|
|
|
|
*
|
|
|
|
* Copyright (c) 2000 by Mike Hall <mlh@io.com>
|
|
|
|
* Copyright (c) 2000 by Cisco Systems
|
2002-08-28 20:30:45 +00:00
|
|
|
*
|
2018-02-07 11:26:45 +00:00
|
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
2000-08-08 22:16:42 +00:00
|
|
|
*/
|
2002-03-04 00:25:35 +00:00
|
|
|
|
2000-08-08 22:16:42 +00:00
|
|
|
#include "config.h"
|
|
|
|
#include "wtap-int.h"
|
|
|
|
#include "csids.h"
|
|
|
|
#include "file_wrappers.h"
|
|
|
|
|
|
|
|
#include <stdlib.h>
|
|
|
|
#include <string.h>
|
|
|
|
|
2002-08-28 20:30:45 +00:00
|
|
|
/*
|
2012-04-19 23:58:53 +00:00
|
|
|
* This module reads the output from the Cisco Secure Intrusion Detection
|
2002-08-28 20:30:45 +00:00
|
|
|
* System iplogging facility. The term iplogging is misleading since this
|
|
|
|
* logger will only output TCP. There is no link layer information.
|
2000-08-08 22:16:42 +00:00
|
|
|
* Packet format is 4 byte timestamp (seconds since epoch), and a 4 byte size
|
|
|
|
* of data following for that packet.
|
|
|
|
*
|
|
|
|
* For a time there was an error in iplogging and the ip length, flags, and id
|
2002-03-04 00:25:35 +00:00
|
|
|
* were byteswapped. We will check for this and handle it before handing to
|
2006-05-28 15:56:15 +00:00
|
|
|
* wireshark.
|
2000-08-08 22:16:42 +00:00
|
|
|
*/
|
|
|
|
|
2013-05-16 23:42:10 +00:00
|
|
|
typedef struct {
|
2015-01-02 00:45:22 +00:00
|
|
|
gboolean byteswapped;
|
2013-05-16 23:42:10 +00:00
|
|
|
} csids_t;
|
|
|
|
|
2019-04-05 01:56:27 +00:00
|
|
|
static gboolean csids_read(wtap *wth, wtap_rec *rec, Buffer *buf,
|
|
|
|
int *err, gchar **err_info, gint64 *data_offset);
|
2014-05-23 10:50:02 +00:00
|
|
|
static gboolean csids_seek_read(wtap *wth, gint64 seek_off,
|
2018-02-09 00:19:12 +00:00
|
|
|
wtap_rec *rec, Buffer *buf, int *err, gchar **err_info);
|
2013-06-17 21:18:47 +00:00
|
|
|
static gboolean csids_read_packet(FILE_T fh, csids_t *csids,
|
2018-02-09 00:19:12 +00:00
|
|
|
wtap_rec *rec, Buffer *buf, int *err, gchar **err_info);
|
2000-08-08 22:16:42 +00:00
|
|
|
|
|
|
|
struct csids_header {
|
|
|
|
guint32 seconds; /* seconds since epoch */
|
2000-08-15 18:19:06 +00:00
|
|
|
guint16 zeropad; /* 2 byte zero'ed pads */
|
|
|
|
guint16 caplen; /* the capture length */
|
2000-08-08 22:16:42 +00:00
|
|
|
};
|
|
|
|
|
wiretap: register most built-in file types from its module.
Remove most of the built-in file types from the table in
wiretap/file_access.c and, instead, have the file types register
themselves, using wtap_register_file_type_subtypes().
This reduces the source code changes needed to add a new file type from
three (add the handler, add the file type to the table in file_access.c,
add a #define for the file type in wiretap/wtap.h) to one (add the
handler). (It also requires adding the handler's source file to
wiretap/CMakeLists.txt, but that's required in both cases.)
A few remain because the WTAP_FILE_TYPE_SUBTYPE_ #define is used
elsewhere; that needs to be fixed.
Fix the wiretap/CMakefile.txt file to scan k12text.l, as that now
contains a registration routine. In the process, avoid scanning files
that don't implement a file type and won't ever have a registration
routine.
Add a Lua routine to fetch the total number of file types; we use that
in some code to construct the wtap_filetypes table, which we need to do
in order to continue to have all the values that used to come from the
WTAP_FILE_TYPE_SUBTYPE_ types.
While we're at it, add modelines to a file that lacked them.
2021-02-14 08:34:10 +00:00
|
|
|
static int csids_file_type_subtype = -1;
|
|
|
|
|
|
|
|
void register_csids(void);
|
|
|
|
|
2014-10-09 23:44:15 +00:00
|
|
|
wtap_open_return_val csids_open(wtap *wth, int *err, gchar **err_info)
|
2000-08-08 22:16:42 +00:00
|
|
|
{
|
2002-08-28 20:30:45 +00:00
|
|
|
/* There is no file header. There is only a header for each packet
|
|
|
|
* so we read a packet header and compare the caplen with iplen. They
|
2013-02-26 04:42:26 +00:00
|
|
|
* should always be equal except with the weird byteswap version.
|
2002-08-28 20:30:45 +00:00
|
|
|
*
|
|
|
|
* THIS IS BROKEN-- anytime the caplen is 0x0101 or 0x0202 up to 0x0505
|
|
|
|
* this will byteswap it. I need to fix this. XXX --mlh
|
2000-08-08 22:16:42 +00:00
|
|
|
*/
|
|
|
|
|
Add some higher-level file-read APIs and use them.
Add wtap_read_bytes(), which takes a FILE_T, a pointer, a byte count, an
error number pointer, and an error string pointer as arguments, and that
treats a short read of any sort, including a read that returns 0 bytes,
as a WTAP_ERR_SHORT_READ error, and that returns the error number and
string through its last two arguments.
Add wtap_read_bytes_or_eof(), which is similar, but that treats a read
that returns 0 bytes as an EOF, supplying an error number of 0 as an EOF
indication.
Use those in file readers; that simplifies the code and makes it less
likely that somebody will fail to supply the error number and error
string on a file read error.
Change-Id: Ia5dba2a6f81151e87b614461349d611cffc16210
Reviewed-on: https://code.wireshark.org/review/4512
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-10-07 01:00:57 +00:00
|
|
|
int tmp,iplen;
|
2002-08-28 20:30:45 +00:00
|
|
|
|
2000-08-08 22:16:42 +00:00
|
|
|
gboolean byteswap = FALSE;
|
|
|
|
struct csids_header hdr;
|
2010-02-26 07:59:54 +00:00
|
|
|
csids_t *csids;
|
2000-08-08 22:16:42 +00:00
|
|
|
|
2002-08-28 20:30:45 +00:00
|
|
|
/* check the file to make sure it is a csids file. */
|
Add some higher-level file-read APIs and use them.
Add wtap_read_bytes(), which takes a FILE_T, a pointer, a byte count, an
error number pointer, and an error string pointer as arguments, and that
treats a short read of any sort, including a read that returns 0 bytes,
as a WTAP_ERR_SHORT_READ error, and that returns the error number and
string through its last two arguments.
Add wtap_read_bytes_or_eof(), which is similar, but that treats a read
that returns 0 bytes as an EOF, supplying an error number of 0 as an EOF
indication.
Use those in file readers; that simplifies the code and makes it less
likely that somebody will fail to supply the error number and error
string on a file read error.
Change-Id: Ia5dba2a6f81151e87b614461349d611cffc16210
Reviewed-on: https://code.wireshark.org/review/4512
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-10-07 01:00:57 +00:00
|
|
|
if( !wtap_read_bytes( wth->fh, &hdr, sizeof( struct csids_header), err, err_info ) ) {
|
|
|
|
if( *err != WTAP_ERR_SHORT_READ ) {
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_ERROR;
|
2000-08-08 22:16:42 +00:00
|
|
|
}
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_NOT_MINE;
|
2000-08-08 22:16:42 +00:00
|
|
|
}
|
2008-07-08 22:24:32 +00:00
|
|
|
if( hdr.zeropad != 0 || hdr.caplen == 0 ) {
|
2015-01-02 00:45:22 +00:00
|
|
|
return WTAP_OPEN_NOT_MINE;
|
2000-08-15 18:19:06 +00:00
|
|
|
}
|
2013-12-03 20:35:50 +00:00
|
|
|
hdr.seconds = pntoh32( &hdr.seconds );
|
|
|
|
hdr.caplen = pntoh16( &hdr.caplen );
|
Add some higher-level file-read APIs and use them.
Add wtap_read_bytes(), which takes a FILE_T, a pointer, a byte count, an
error number pointer, and an error string pointer as arguments, and that
treats a short read of any sort, including a read that returns 0 bytes,
as a WTAP_ERR_SHORT_READ error, and that returns the error number and
string through its last two arguments.
Add wtap_read_bytes_or_eof(), which is similar, but that treats a read
that returns 0 bytes as an EOF, supplying an error number of 0 as an EOF
indication.
Use those in file readers; that simplifies the code and makes it less
likely that somebody will fail to supply the error number and error
string on a file read error.
Change-Id: Ia5dba2a6f81151e87b614461349d611cffc16210
Reviewed-on: https://code.wireshark.org/review/4512
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-10-07 01:00:57 +00:00
|
|
|
if( !wtap_read_bytes( wth->fh, &tmp, 2, err, err_info ) ) {
|
|
|
|
if( *err != WTAP_ERR_SHORT_READ ) {
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_ERROR;
|
2000-08-08 22:16:42 +00:00
|
|
|
}
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_NOT_MINE;
|
2000-08-08 22:16:42 +00:00
|
|
|
}
|
Add some higher-level file-read APIs and use them.
Add wtap_read_bytes(), which takes a FILE_T, a pointer, a byte count, an
error number pointer, and an error string pointer as arguments, and that
treats a short read of any sort, including a read that returns 0 bytes,
as a WTAP_ERR_SHORT_READ error, and that returns the error number and
string through its last two arguments.
Add wtap_read_bytes_or_eof(), which is similar, but that treats a read
that returns 0 bytes as an EOF, supplying an error number of 0 as an EOF
indication.
Use those in file readers; that simplifies the code and makes it less
likely that somebody will fail to supply the error number and error
string on a file read error.
Change-Id: Ia5dba2a6f81151e87b614461349d611cffc16210
Reviewed-on: https://code.wireshark.org/review/4512
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-10-07 01:00:57 +00:00
|
|
|
if( !wtap_read_bytes(wth->fh, &iplen, 2, err, err_info ) ) {
|
|
|
|
if( *err != WTAP_ERR_SHORT_READ ) {
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_ERROR;
|
2000-08-08 22:16:42 +00:00
|
|
|
}
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_NOT_MINE;
|
2000-08-08 22:16:42 +00:00
|
|
|
}
|
2013-12-03 20:35:50 +00:00
|
|
|
iplen = pntoh16(&iplen);
|
2008-07-08 22:24:32 +00:00
|
|
|
|
|
|
|
if ( iplen == 0 )
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_NOT_MINE;
|
2008-07-08 22:24:32 +00:00
|
|
|
|
2000-08-15 18:19:06 +00:00
|
|
|
/* if iplen and hdr.caplen are equal, default to no byteswap. */
|
|
|
|
if( iplen > hdr.caplen ) {
|
2000-08-08 22:16:42 +00:00
|
|
|
/* maybe this is just a byteswapped version. the iplen ipflags */
|
|
|
|
/* and ipid are swapped. We cannot use the normal swaps because */
|
|
|
|
/* we don't know the host */
|
2013-11-29 19:21:20 +00:00
|
|
|
iplen = GUINT16_SWAP_LE_BE(iplen);
|
2000-08-15 18:19:06 +00:00
|
|
|
if( iplen <= hdr.caplen ) {
|
2000-08-08 22:16:42 +00:00
|
|
|
/* we know this format */
|
|
|
|
byteswap = TRUE;
|
|
|
|
} else {
|
|
|
|
/* don't know this one */
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_NOT_MINE;
|
2000-08-08 22:16:42 +00:00
|
|
|
}
|
|
|
|
} else {
|
|
|
|
byteswap = FALSE;
|
2002-08-28 20:30:45 +00:00
|
|
|
}
|
2000-08-08 22:16:42 +00:00
|
|
|
|
2002-03-04 00:25:35 +00:00
|
|
|
/* no file header. So reset the fh to 0 so we can read the first packet */
|
2014-05-09 05:18:49 +00:00
|
|
|
if (file_seek(wth->fh, 0, SEEK_SET, err) == -1)
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_ERROR;
|
2002-03-04 00:25:35 +00:00
|
|
|
|
2020-12-21 02:30:28 +00:00
|
|
|
csids = g_new(csids_t, 1);
|
2014-05-09 05:18:49 +00:00
|
|
|
wth->priv = (void *)csids;
|
2010-02-26 07:59:54 +00:00
|
|
|
csids->byteswapped = byteswap;
|
2014-05-09 05:18:49 +00:00
|
|
|
wth->file_encap = WTAP_ENCAP_RAW_IP;
|
wiretap: register most built-in file types from its module.
Remove most of the built-in file types from the table in
wiretap/file_access.c and, instead, have the file types register
themselves, using wtap_register_file_type_subtypes().
This reduces the source code changes needed to add a new file type from
three (add the handler, add the file type to the table in file_access.c,
add a #define for the file type in wiretap/wtap.h) to one (add the
handler). (It also requires adding the handler's source file to
wiretap/CMakeLists.txt, but that's required in both cases.)
A few remain because the WTAP_FILE_TYPE_SUBTYPE_ #define is used
elsewhere; that needs to be fixed.
Fix the wiretap/CMakefile.txt file to scan k12text.l, as that now
contains a registration routine. In the process, avoid scanning files
that don't implement a file type and won't ever have a registration
routine.
Add a Lua routine to fetch the total number of file types; we use that
in some code to construct the wtap_filetypes table, which we need to do
in order to continue to have all the values that used to come from the
WTAP_FILE_TYPE_SUBTYPE_ types.
While we're at it, add modelines to a file that lacked them.
2021-02-14 08:34:10 +00:00
|
|
|
wth->file_type_subtype = csids_file_type_subtype;
|
2014-05-09 05:18:49 +00:00
|
|
|
wth->snapshot_length = 0; /* not known */
|
|
|
|
wth->subtype_read = csids_read;
|
|
|
|
wth->subtype_seek_read = csids_seek_read;
|
2014-09-28 18:37:06 +00:00
|
|
|
wth->file_tsprec = WTAP_TSPREC_SEC;
|
2000-08-08 22:16:42 +00:00
|
|
|
|
2020-07-29 08:30:54 +00:00
|
|
|
/*
|
|
|
|
* Add an IDB; we don't know how many interfaces were
|
|
|
|
* involved, so we just say one interface, about which
|
|
|
|
* we only know the link-layer type, snapshot length,
|
|
|
|
* and time stamp resolution.
|
|
|
|
*/
|
|
|
|
wtap_add_generated_idb(wth);
|
|
|
|
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_MINE;
|
2000-08-08 22:16:42 +00:00
|
|
|
}
|
|
|
|
|
2005-04-03 11:00:49 +00:00
|
|
|
/* Find the next packet and parse it; called from wtap_read(). */
|
2019-04-05 01:56:27 +00:00
|
|
|
static gboolean csids_read(wtap *wth, wtap_rec *rec, Buffer *buf,
|
|
|
|
int *err, gchar **err_info, gint64 *data_offset)
|
2000-08-08 22:16:42 +00:00
|
|
|
{
|
2014-05-09 05:18:49 +00:00
|
|
|
csids_t *csids = (csids_t *)wth->priv;
|
2000-09-07 05:34:23 +00:00
|
|
|
|
2014-05-09 05:18:49 +00:00
|
|
|
*data_offset = file_tell(wth->fh);
|
2000-08-08 22:16:42 +00:00
|
|
|
|
2019-04-05 01:56:27 +00:00
|
|
|
return csids_read_packet( wth->fh, csids, rec, buf, err, err_info );
|
2000-08-08 22:16:42 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/* Used to read packets in random-access fashion */
|
2014-05-23 10:50:02 +00:00
|
|
|
static gboolean
|
2014-05-09 05:18:49 +00:00
|
|
|
csids_seek_read(wtap *wth,
|
2015-01-02 00:45:22 +00:00
|
|
|
gint64 seek_off,
|
2018-02-09 00:19:12 +00:00
|
|
|
wtap_rec *rec,
|
2015-01-02 00:45:22 +00:00
|
|
|
Buffer *buf,
|
|
|
|
int *err,
|
|
|
|
gchar **err_info)
|
2000-08-08 22:16:42 +00:00
|
|
|
{
|
2014-05-09 05:18:49 +00:00
|
|
|
csids_t *csids = (csids_t *)wth->priv;
|
2000-08-08 22:16:42 +00:00
|
|
|
|
2014-05-09 05:18:49 +00:00
|
|
|
if( file_seek( wth->random_fh, seek_off, SEEK_SET, err ) == -1 )
|
2014-05-23 10:50:02 +00:00
|
|
|
return FALSE;
|
2000-08-08 22:16:42 +00:00
|
|
|
|
2018-02-09 00:19:12 +00:00
|
|
|
if( !csids_read_packet( wth->random_fh, csids, rec, buf, err, err_info ) ) {
|
2013-06-17 21:18:47 +00:00
|
|
|
if( *err == 0 )
|
|
|
|
*err = WTAP_ERR_SHORT_READ;
|
2014-05-23 10:50:02 +00:00
|
|
|
return FALSE;
|
2013-05-16 23:42:10 +00:00
|
|
|
}
|
2014-05-23 10:50:02 +00:00
|
|
|
return TRUE;
|
2013-05-16 23:42:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static gboolean
|
2018-02-09 00:19:12 +00:00
|
|
|
csids_read_packet(FILE_T fh, csids_t *csids, wtap_rec *rec,
|
2013-06-17 21:18:47 +00:00
|
|
|
Buffer *buf, int *err, gchar **err_info)
|
2013-05-16 23:42:10 +00:00
|
|
|
{
|
|
|
|
struct csids_header hdr;
|
2013-06-17 21:18:47 +00:00
|
|
|
guint8 *pd;
|
2013-05-16 23:42:10 +00:00
|
|
|
|
Add some higher-level file-read APIs and use them.
Add wtap_read_bytes(), which takes a FILE_T, a pointer, a byte count, an
error number pointer, and an error string pointer as arguments, and that
treats a short read of any sort, including a read that returns 0 bytes,
as a WTAP_ERR_SHORT_READ error, and that returns the error number and
string through its last two arguments.
Add wtap_read_bytes_or_eof(), which is similar, but that treats a read
that returns 0 bytes as an EOF, supplying an error number of 0 as an EOF
indication.
Use those in file readers; that simplifies the code and makes it less
likely that somebody will fail to supply the error number and error
string on a file read error.
Change-Id: Ia5dba2a6f81151e87b614461349d611cffc16210
Reviewed-on: https://code.wireshark.org/review/4512
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-10-07 01:00:57 +00:00
|
|
|
if( !wtap_read_bytes_or_eof( fh, &hdr, sizeof( struct csids_header), err, err_info ) )
|
2002-03-05 08:40:27 +00:00
|
|
|
return FALSE;
|
2013-12-03 20:35:50 +00:00
|
|
|
hdr.seconds = pntoh32(&hdr.seconds);
|
|
|
|
hdr.caplen = pntoh16(&hdr.caplen);
|
2016-04-30 02:04:17 +00:00
|
|
|
/*
|
|
|
|
* The maximum value of hdr.caplen is 65535, which is less than
|
Allow bigger snapshot lengths for D-Bus captures.
Use WTAP_MAX_PACKET_SIZE_STANDARD, set to 256KB, for everything except
for D-Bus captures. Use WTAP_MAX_PACKET_SIZE_DBUS, set to 128MB, for
them, because that's the largest possible D-Bus message size. See
https://bugs.freedesktop.org/show_bug.cgi?id=100220
for an example of the problems caused by limiting the snapshot length to
256KB for D-Bus.
Have a snapshot length of 0 in a capture_file structure mean "there is
no snapshot length for the file"; we don't need the has_snap field in
that case, a value of 0 mean "no, we don't have a snapshot length".
In dumpcap, start out with a pipe buffer size of 2KB, and grow it as
necessary. When checking for a too-big packet from a pipe, check
against the appropriate maximum - 128MB for DLT_DBUS, 256KB for
everything else.
Change-Id: Ib2ce7a0cf37b971fbc0318024fd011e18add8b20
Reviewed-on: https://code.wireshark.org/review/21952
Petri-Dish: Guy Harris <guy@alum.mit.edu>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2017-06-05 01:58:40 +00:00
|
|
|
* WTAP_MAX_PACKET_SIZE_STANDARD will ever be, so we don't need to check
|
2016-04-30 02:04:17 +00:00
|
|
|
* it.
|
|
|
|
*/
|
2002-08-28 20:30:45 +00:00
|
|
|
|
2018-02-09 00:19:12 +00:00
|
|
|
rec->rec_type = REC_TYPE_PACKET;
|
2021-08-30 02:12:13 +00:00
|
|
|
rec->block = wtap_block_create(WTAP_BLOCK_PACKET);
|
2018-02-09 00:19:12 +00:00
|
|
|
rec->presence_flags = WTAP_HAS_TS;
|
|
|
|
rec->rec_header.packet_header.len = hdr.caplen;
|
|
|
|
rec->rec_header.packet_header.caplen = hdr.caplen;
|
|
|
|
rec->ts.secs = hdr.seconds;
|
|
|
|
rec->ts.nsecs = 0;
|
2013-05-16 23:42:10 +00:00
|
|
|
|
2018-02-09 00:19:12 +00:00
|
|
|
if( !wtap_read_packet_bytes( fh, buf, rec->rec_header.packet_header.caplen, err, err_info ) )
|
2002-03-05 08:40:27 +00:00
|
|
|
return FALSE;
|
2000-08-08 22:16:42 +00:00
|
|
|
|
2014-08-02 11:00:48 +00:00
|
|
|
pd = ws_buffer_start_ptr( buf );
|
2010-02-26 07:59:54 +00:00
|
|
|
if( csids->byteswapped ) {
|
2018-02-09 00:19:12 +00:00
|
|
|
if( rec->rec_header.packet_header.caplen >= 2 ) {
|
2012-04-19 23:19:10 +00:00
|
|
|
PBSWAP16(pd); /* the ip len */
|
2018-02-09 00:19:12 +00:00
|
|
|
if( rec->rec_header.packet_header.caplen >= 4 ) {
|
2012-04-19 23:19:10 +00:00
|
|
|
PBSWAP16(pd+2); /* ip id */
|
2018-02-09 00:19:12 +00:00
|
|
|
if( rec->rec_header.packet_header.caplen >= 6 )
|
2012-04-19 23:19:10 +00:00
|
|
|
PBSWAP16(pd+4); /* ip flags and fragoff */
|
|
|
|
}
|
|
|
|
}
|
2000-08-08 22:16:42 +00:00
|
|
|
}
|
2002-08-28 20:30:45 +00:00
|
|
|
|
2002-03-05 08:40:27 +00:00
|
|
|
return TRUE;
|
2000-08-08 22:16:42 +00:00
|
|
|
}
|
2015-01-02 00:45:22 +00:00
|
|
|
|
wiretap: have file handlers advertise blocks and options supported.
Instead of a "supports name resolution" Boolean and bitflags for types of
comments supported, provide a list of block types that the file
type/subtype supports, with each block type having a list of options
supported. Indicate whether "supported" means "one instance" or
"multiple instances".
"Supports" doesn't just mean "can be written", it also means "could be
read".
Rename WTAP_BLOCK_IF_DESCRIPTION to WTAP_BLOCK_IF_ID_AND_INFO, to
indicate that it provides, in addition to information about the
interface, an ID (implicitly, in pcapng files, by its ordinal number)
that is associated with every packet in the file. Emphasize that in
comments - just because your capture file format can list the interfaces
on which a capture was done, that doesn't mean it supports this; it
doesn't do so if the file doesn't indicate, for every packet, on which
of those interfaces it was captured (I'm looking at *you*, Microsoft
Network Monitor...).
Use APIs to query that information to do what the "does this file
type/subtype support name resolution information", "does this file
type/subtype support all of these comment types", and "does this file
type/subtype support - and require - interface IDs" APIs did.
Provide backwards compatibility for Lua.
This allows us to eliminate the WTAP_FILE_TYPE_SUBTYPE_ values for IBM's
iptrace; do so.
2021-02-21 22:18:04 +00:00
|
|
|
static const struct supported_block_type csids_blocks_supported[] = {
|
|
|
|
/*
|
|
|
|
* We support packet blocks, with no comments or other options.
|
|
|
|
*/
|
|
|
|
{ WTAP_BLOCK_PACKET, MULTIPLE_BLOCKS_SUPPORTED, NO_OPTIONS_SUPPORTED }
|
|
|
|
};
|
|
|
|
|
wiretap: register most built-in file types from its module.
Remove most of the built-in file types from the table in
wiretap/file_access.c and, instead, have the file types register
themselves, using wtap_register_file_type_subtypes().
This reduces the source code changes needed to add a new file type from
three (add the handler, add the file type to the table in file_access.c,
add a #define for the file type in wiretap/wtap.h) to one (add the
handler). (It also requires adding the handler's source file to
wiretap/CMakeLists.txt, but that's required in both cases.)
A few remain because the WTAP_FILE_TYPE_SUBTYPE_ #define is used
elsewhere; that needs to be fixed.
Fix the wiretap/CMakefile.txt file to scan k12text.l, as that now
contains a registration routine. In the process, avoid scanning files
that don't implement a file type and won't ever have a registration
routine.
Add a Lua routine to fetch the total number of file types; we use that
in some code to construct the wtap_filetypes table, which we need to do
in order to continue to have all the values that used to come from the
WTAP_FILE_TYPE_SUBTYPE_ types.
While we're at it, add modelines to a file that lacked them.
2021-02-14 08:34:10 +00:00
|
|
|
static const struct file_type_subtype_info csids_info = {
|
|
|
|
"CSIDS IPLog", "csids", NULL, NULL,
|
wiretap: have file handlers advertise blocks and options supported.
Instead of a "supports name resolution" Boolean and bitflags for types of
comments supported, provide a list of block types that the file
type/subtype supports, with each block type having a list of options
supported. Indicate whether "supported" means "one instance" or
"multiple instances".
"Supports" doesn't just mean "can be written", it also means "could be
read".
Rename WTAP_BLOCK_IF_DESCRIPTION to WTAP_BLOCK_IF_ID_AND_INFO, to
indicate that it provides, in addition to information about the
interface, an ID (implicitly, in pcapng files, by its ordinal number)
that is associated with every packet in the file. Emphasize that in
comments - just because your capture file format can list the interfaces
on which a capture was done, that doesn't mean it supports this; it
doesn't do so if the file doesn't indicate, for every packet, on which
of those interfaces it was captured (I'm looking at *you*, Microsoft
Network Monitor...).
Use APIs to query that information to do what the "does this file
type/subtype support name resolution information", "does this file
type/subtype support all of these comment types", and "does this file
type/subtype support - and require - interface IDs" APIs did.
Provide backwards compatibility for Lua.
This allows us to eliminate the WTAP_FILE_TYPE_SUBTYPE_ values for IBM's
iptrace; do so.
2021-02-21 22:18:04 +00:00
|
|
|
FALSE, BLOCKS_SUPPORTED(csids_blocks_supported),
|
wiretap: register most built-in file types from its module.
Remove most of the built-in file types from the table in
wiretap/file_access.c and, instead, have the file types register
themselves, using wtap_register_file_type_subtypes().
This reduces the source code changes needed to add a new file type from
three (add the handler, add the file type to the table in file_access.c,
add a #define for the file type in wiretap/wtap.h) to one (add the
handler). (It also requires adding the handler's source file to
wiretap/CMakeLists.txt, but that's required in both cases.)
A few remain because the WTAP_FILE_TYPE_SUBTYPE_ #define is used
elsewhere; that needs to be fixed.
Fix the wiretap/CMakefile.txt file to scan k12text.l, as that now
contains a registration routine. In the process, avoid scanning files
that don't implement a file type and won't ever have a registration
routine.
Add a Lua routine to fetch the total number of file types; we use that
in some code to construct the wtap_filetypes table, which we need to do
in order to continue to have all the values that used to come from the
WTAP_FILE_TYPE_SUBTYPE_ types.
While we're at it, add modelines to a file that lacked them.
2021-02-14 08:34:10 +00:00
|
|
|
NULL, NULL, NULL
|
|
|
|
};
|
|
|
|
|
|
|
|
void register_csids(void)
|
|
|
|
{
|
2021-02-24 03:10:35 +00:00
|
|
|
csids_file_type_subtype = wtap_register_file_type_subtype(&csids_info);
|
wiretap: more work on file type/subtypes.
Provide a wiretap routine to get an array of all savable file
type/subtypes, sorted with pcap and pcapng at the top, followed by the
other types, sorted either by the name or the description.
Use that routine to list options for the -F flag for various commands
Rename wtap_get_savable_file_types_subtypes() to
wtap_get_savable_file_types_subtypes_for_file(), to indicate that it
provides an array of all file type/subtypes in which a given file can be
saved. Have it sort all types, other than the default type/subtype and,
if there is one, the "other" type (both of which are put at the top), by
the name or the description.
Don't allow wtap_register_file_type_subtypes() to override any existing
registrations; have them always register a new type. In that routine,
if there are any emply slots in the table, due to an entry being
unregistered, use it rather than allocating a new slot.
Don't allow unregistration of built-in types.
Rename the "dump open table" to the "file type/subtype table", as it has
entries for all types/subtypes, even if we can't write them.
Initialize that table in a routine that pre-allocates the GArray before
filling it with built-in types/subtypes, so it doesn't keep getting
reallocated.
Get rid of wtap_num_file_types_subtypes - it's just a copy of the size
of the GArray.
Don't have wtap_file_type_subtype_description() crash if handed an
file type/subtype that isn't a valid array index - just return NULL, as
we do with wtap_file_type_subtype_name().
In wtap_name_to_file_type_subtype(), don't use WTAP_FILE_TYPE_SUBTYPE_
names for the backwards-compatibility names - map those names to the
current names, and then look them up. This reduces the number of
uses of hardwired WTAP_FILE_TYPE_SUBTYPE_ values.
Clean up the type of wtap_module_count - it has no need to be a gulong.
Have built-in wiretap file handlers register names to be used for their
file type/subtypes, rather than building the table in init.lua.
Add a new Lua C function get_wtap_filetypes() to construct the
wtap_filetypes table, based on the registered names, and use it in
init.lua.
Add a #define WSLUA_INTERNAL_FUNCTION to register functions intended
only for internal use in init.lua, so they can be made available from
Lua without being documented.
Get rid of WTAP_NUM_FILE_TYPES_SUBTYPES - most code has no need to use
it, as it can just request arrays of types, and the space of
type/subtype codes can be sparse due to registration in any case, so
code has to be careful using it.
wtap_get_num_file_types_subtypes() is no longer used, so remove it. It
returns the number of elements in the file type/subtype array, which is
not necessarily the name of known file type/subtypes, as there may have
been some deregistered types, and those types do *not* get removed from
the array, they just get cleared so that they're available for future
allocation (we don't want the indices of any registered types to changes
if another type is deregistered, as those indicates are the type/subtype
values, so we can't shrink the array).
Clean up white space and remove some comments that shouldn't have been
added.
2021-02-17 06:24:47 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Register name for backwards compatibility with the
|
|
|
|
* wtap_filetypes table in Lua.
|
|
|
|
*/
|
|
|
|
wtap_register_backwards_compatibility_lua_name("CSIDS",
|
|
|
|
csids_file_type_subtype);
|
wiretap: register most built-in file types from its module.
Remove most of the built-in file types from the table in
wiretap/file_access.c and, instead, have the file types register
themselves, using wtap_register_file_type_subtypes().
This reduces the source code changes needed to add a new file type from
three (add the handler, add the file type to the table in file_access.c,
add a #define for the file type in wiretap/wtap.h) to one (add the
handler). (It also requires adding the handler's source file to
wiretap/CMakeLists.txt, but that's required in both cases.)
A few remain because the WTAP_FILE_TYPE_SUBTYPE_ #define is used
elsewhere; that needs to be fixed.
Fix the wiretap/CMakefile.txt file to scan k12text.l, as that now
contains a registration routine. In the process, avoid scanning files
that don't implement a file type and won't ever have a registration
routine.
Add a Lua routine to fetch the total number of file types; we use that
in some code to construct the wtap_filetypes table, which we need to do
in order to continue to have all the values that used to come from the
WTAP_FILE_TYPE_SUBTYPE_ types.
While we're at it, add modelines to a file that lacked them.
2021-02-14 08:34:10 +00:00
|
|
|
}
|
|
|
|
|
2015-01-02 00:45:22 +00:00
|
|
|
/*
|
2019-07-26 18:43:17 +00:00
|
|
|
* Editor modelines - https://www.wireshark.org/tools/modelines.html
|
2015-01-02 00:45:22 +00:00
|
|
|
*
|
|
|
|
* Local Variables:
|
|
|
|
* c-basic-offset: 2
|
|
|
|
* tab-width: 8
|
|
|
|
* indent-tabs-mode: nil
|
|
|
|
* End:
|
|
|
|
*
|
|
|
|
* vi: set shiftwidth=2 tabstop=8 expandtab:
|
|
|
|
* :indentSize=2:tabSize=8:noTabs=true:
|
|
|
|
*/
|