2013-07-28 23:41:18 +00:00
|
|
|
/* stanag4607.c
|
|
|
|
*
|
|
|
|
* STANAG 4607 file reading
|
|
|
|
*
|
2013-07-29 00:34:23 +00:00
|
|
|
* http://www.nato.int/structur/AC/224/standard/4607/4607e_JAS_ED3.pdf
|
2019-07-28 04:20:27 +00:00
|
|
|
* That is now missing from that site, but is available on the Wayback
|
|
|
|
* Machine:
|
|
|
|
*
|
|
|
|
* https://web.archive.org/web/20130223054955/http://www.nato.int/structur/AC/224/standard/4607/4607.htm
|
2017-02-16 08:29:57 +00:00
|
|
|
*
|
|
|
|
* https://nso.nato.int/nso/zPublic/ap/aedp-7(2).pdf
|
2013-07-29 00:34:23 +00:00
|
|
|
*
|
2018-02-07 11:26:45 +00:00
|
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
2013-07-28 23:41:18 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#include "config.h"
|
|
|
|
|
|
|
|
#include <errno.h>
|
|
|
|
|
|
|
|
#include "wtap-int.h"
|
|
|
|
#include "file_wrappers.h"
|
2014-07-15 23:40:46 +00:00
|
|
|
#include <wsutil/buffer.h>
|
2013-07-28 23:41:18 +00:00
|
|
|
#include "stanag4607.h"
|
|
|
|
|
2013-07-29 00:54:33 +00:00
|
|
|
typedef struct {
|
|
|
|
time_t base_secs;
|
|
|
|
} stanag4607_t;
|
|
|
|
|
2017-02-16 08:18:30 +00:00
|
|
|
#define PKT_HDR_SIZE 32 /* size of a packet header */
|
|
|
|
#define SEG_HDR_SIZE 5 /* size of a segment header */
|
|
|
|
|
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 stanag4607_file_type_subtype = -1;
|
|
|
|
|
|
|
|
void register_stanag4607(void);
|
|
|
|
|
2013-07-28 23:41:18 +00:00
|
|
|
static gboolean is_valid_id(guint16 version_id)
|
|
|
|
{
|
|
|
|
#define VERSION_21 0x3231
|
|
|
|
#define VERSION_30 0x3330
|
|
|
|
if ((version_id != VERSION_21) &&
|
|
|
|
(version_id != VERSION_30))
|
|
|
|
/* Not a stanag4607 file */
|
|
|
|
return FALSE;
|
|
|
|
return TRUE;
|
|
|
|
}
|
|
|
|
|
2018-02-09 00:19:12 +00:00
|
|
|
static gboolean stanag4607_read_file(wtap *wth, FILE_T fh, wtap_rec *rec,
|
2014-05-23 10:50:02 +00:00
|
|
|
Buffer *buf, int *err, gchar **err_info)
|
2013-07-28 23:41:18 +00:00
|
|
|
{
|
2014-05-09 05:18:49 +00:00
|
|
|
stanag4607_t *stanag4607 = (stanag4607_t *)wth->priv;
|
2013-07-28 23:41:18 +00:00
|
|
|
guint32 millisecs, secs, nsecs;
|
|
|
|
gint64 offset = 0;
|
2017-02-16 08:18:30 +00:00
|
|
|
guint8 stanag_pkt_hdr[PKT_HDR_SIZE+SEG_HDR_SIZE];
|
2013-07-28 23:41:18 +00:00
|
|
|
guint32 packet_size;
|
|
|
|
|
|
|
|
*err = 0;
|
|
|
|
|
|
|
|
/* Combined packet header and segment header */
|
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, stanag_pkt_hdr, sizeof stanag_pkt_hdr, err, err_info))
|
|
|
|
return FALSE;
|
|
|
|
offset += sizeof stanag_pkt_hdr;
|
2013-07-28 23:41:18 +00:00
|
|
|
|
2013-12-03 20:35:50 +00:00
|
|
|
if (!is_valid_id(pntoh16(&stanag_pkt_hdr[0]))) {
|
2013-07-28 23:41:18 +00:00
|
|
|
*err = WTAP_ERR_BAD_FILE;
|
|
|
|
*err_info = g_strdup("Bad version number");
|
2014-05-23 10:50:02 +00:00
|
|
|
return FALSE;
|
2013-07-28 23:41:18 +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);
|
2014-05-24 18:28:30 +00:00
|
|
|
|
2013-07-28 23:41:18 +00:00
|
|
|
/* The next 4 bytes are the packet length */
|
2013-12-03 20:35:50 +00:00
|
|
|
packet_size = pntoh32(&stanag_pkt_hdr[2]);
|
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
|
|
|
if (packet_size > WTAP_MAX_PACKET_SIZE_STANDARD) {
|
2015-08-27 16:01:27 +00:00
|
|
|
/*
|
|
|
|
* Probably a corrupt capture file; don't blow up trying
|
|
|
|
* to allocate space for an immensely-large packet.
|
|
|
|
*/
|
|
|
|
*err = WTAP_ERR_BAD_FILE;
|
2021-12-18 18:48:20 +00:00
|
|
|
*err_info = ws_strdup_printf("stanag4607: File has %" PRIu32 "d-byte packet, "
|
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
|
|
|
"bigger than maximum of %u", packet_size, WTAP_MAX_PACKET_SIZE_STANDARD);
|
2015-08-27 16:01:27 +00:00
|
|
|
return FALSE;
|
|
|
|
}
|
2017-02-16 08:18:30 +00:00
|
|
|
if (packet_size < PKT_HDR_SIZE+SEG_HDR_SIZE) {
|
|
|
|
/*
|
|
|
|
* Probably a corrupt capture file; don't, for example, loop
|
|
|
|
* infinitely if the size is zero.
|
|
|
|
*/
|
|
|
|
*err = WTAP_ERR_BAD_FILE;
|
2021-12-18 18:48:20 +00:00
|
|
|
*err_info = ws_strdup_printf("stanag4607: File has %" PRIu32 "d-byte packet, "
|
2017-02-16 08:18:30 +00:00
|
|
|
"smaller than minimum of %u", packet_size, PKT_HDR_SIZE+SEG_HDR_SIZE);
|
|
|
|
return FALSE;
|
|
|
|
}
|
2018-02-09 00:19:12 +00:00
|
|
|
rec->rec_header.packet_header.caplen = packet_size;
|
|
|
|
rec->rec_header.packet_header.len = packet_size;
|
2013-07-28 23:41:18 +00:00
|
|
|
|
|
|
|
/* Sadly, the header doesn't contain times; but some segments do */
|
2013-07-29 00:34:23 +00:00
|
|
|
/* So, get the segment header, which is just past the 32-byte header. */
|
2018-02-09 00:19:12 +00:00
|
|
|
rec->presence_flags = WTAP_HAS_TS;
|
2013-07-28 23:41:18 +00:00
|
|
|
|
2013-07-29 00:34:23 +00:00
|
|
|
/* If no time specified, it's the last baseline time */
|
2018-02-09 00:19:12 +00:00
|
|
|
rec->ts.secs = stanag4607->base_secs;
|
|
|
|
rec->ts.nsecs = 0;
|
2013-07-28 23:41:18 +00:00
|
|
|
millisecs = 0;
|
|
|
|
|
|
|
|
#define MISSION_SEGMENT 1
|
|
|
|
#define DWELL_SEGMENT 2
|
|
|
|
#define JOB_DEFINITION_SEGMENT 5
|
|
|
|
#define PLATFORM_LOCATION_SEGMENT 13
|
|
|
|
if (MISSION_SEGMENT == stanag_pkt_hdr[32]) {
|
|
|
|
guint8 mseg[39];
|
|
|
|
struct tm tm;
|
|
|
|
|
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(fh, &mseg, sizeof mseg, err, err_info))
|
|
|
|
return FALSE;
|
|
|
|
offset += sizeof mseg;
|
2013-07-28 23:41:18 +00:00
|
|
|
|
2013-12-03 20:35:50 +00:00
|
|
|
tm.tm_year = pntoh16(&mseg[35]) - 1900;
|
2013-07-28 23:41:18 +00:00
|
|
|
tm.tm_mon = mseg[37] - 1;
|
|
|
|
tm.tm_mday = mseg[38];
|
|
|
|
tm.tm_hour = 0;
|
|
|
|
tm.tm_min = 0;
|
|
|
|
tm.tm_sec = 0;
|
|
|
|
tm.tm_isdst = -1;
|
2013-07-29 00:54:33 +00:00
|
|
|
stanag4607->base_secs = mktime(&tm);
|
2018-02-09 00:19:12 +00:00
|
|
|
rec->ts.secs = stanag4607->base_secs;
|
2013-07-28 23:41:18 +00:00
|
|
|
}
|
|
|
|
else if (PLATFORM_LOCATION_SEGMENT == stanag_pkt_hdr[32]) {
|
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(fh, &millisecs, sizeof millisecs, err, err_info))
|
|
|
|
return FALSE;
|
|
|
|
offset += sizeof millisecs;
|
2013-07-28 23:58:30 +00:00
|
|
|
millisecs = g_ntohl(millisecs);
|
2013-07-28 23:41:18 +00:00
|
|
|
}
|
|
|
|
else if (DWELL_SEGMENT == stanag_pkt_hdr[32]) {
|
|
|
|
guint8 dseg[19];
|
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(fh, &dseg, sizeof dseg, err, err_info))
|
|
|
|
return FALSE;
|
|
|
|
offset += sizeof dseg;
|
2013-12-03 20:35:50 +00:00
|
|
|
millisecs = pntoh32(&dseg[15]);
|
2013-07-28 23:41:18 +00:00
|
|
|
}
|
|
|
|
if (0 != millisecs) {
|
|
|
|
secs = millisecs/1000;
|
|
|
|
nsecs = (millisecs - 1000 * secs) * 1000000;
|
2018-02-09 00:19:12 +00:00
|
|
|
rec->ts.secs = stanag4607->base_secs + secs;
|
|
|
|
rec->ts.nsecs = nsecs;
|
2013-07-28 23:41:18 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/* wind back to the start of the packet ... */
|
|
|
|
if (file_seek(fh, - offset, SEEK_CUR, err) == -1)
|
2014-05-23 18:10:05 +00:00
|
|
|
return FALSE;
|
2013-07-28 23:41:18 +00:00
|
|
|
|
2014-05-23 10:50:02 +00:00
|
|
|
return wtap_read_packet_bytes(fh, buf, packet_size, err, err_info);
|
2013-07-28 23:41:18 +00:00
|
|
|
}
|
|
|
|
|
2019-04-05 01:56:27 +00:00
|
|
|
static gboolean stanag4607_read(wtap *wth, wtap_rec *rec, Buffer *buf,
|
|
|
|
int *err, gchar **err_info, gint64 *data_offset)
|
2013-07-28 23:41:18 +00:00
|
|
|
{
|
2018-09-30 19:05:21 +00:00
|
|
|
*data_offset = file_tell(wth->fh);
|
2013-07-28 23:41:18 +00:00
|
|
|
|
2019-04-05 01:56:27 +00:00
|
|
|
return stanag4607_read_file(wth, wth->fh, rec, buf, err, err_info);
|
2013-07-28 23:41:18 +00:00
|
|
|
}
|
|
|
|
|
2014-05-23 10:50:02 +00:00
|
|
|
static gboolean stanag4607_seek_read(wtap *wth, gint64 seek_off,
|
2018-02-09 00:19:12 +00:00
|
|
|
wtap_rec *rec,
|
2014-05-23 10:50:02 +00:00
|
|
|
Buffer *buf, int *err, gchar **err_info)
|
2013-07-28 23:41:18 +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;
|
2013-07-28 23:41:18 +00:00
|
|
|
|
2018-02-09 00:19:12 +00:00
|
|
|
return stanag4607_read_file(wth, wth->random_fh, rec, buf, err, err_info);
|
2013-07-28 23:41:18 +00:00
|
|
|
}
|
|
|
|
|
2014-10-09 23:44:15 +00:00
|
|
|
wtap_open_return_val stanag4607_open(wtap *wth, int *err, gchar **err_info)
|
2013-07-28 23:41:18 +00:00
|
|
|
{
|
|
|
|
guint16 version_id;
|
2013-07-29 00:54:33 +00:00
|
|
|
stanag4607_t *stanag4607;
|
2013-07-28 23:41:18 +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, &version_id, sizeof version_id, err, err_info))
|
2014-10-09 23:44:15 +00:00
|
|
|
return (*err != WTAP_ERR_SHORT_READ) ? WTAP_OPEN_ERROR : WTAP_OPEN_NOT_MINE;
|
2013-07-28 23:41:18 +00:00
|
|
|
|
|
|
|
if (!is_valid_id(GUINT16_TO_BE(version_id)))
|
|
|
|
/* Not a stanag4607 file */
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_NOT_MINE;
|
2013-07-28 23:41:18 +00:00
|
|
|
|
|
|
|
/* seek back to the start of the file */
|
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;
|
2013-07-28 23:41:18 +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
|
|
|
wth->file_type_subtype = stanag4607_file_type_subtype;
|
2014-05-09 05:18:49 +00:00
|
|
|
wth->file_encap = WTAP_ENCAP_STANAG_4607;
|
|
|
|
wth->snapshot_length = 0; /* not known */
|
2013-07-28 23:41:18 +00:00
|
|
|
|
2020-12-21 02:30:28 +00:00
|
|
|
stanag4607 = g_new(stanag4607_t, 1);
|
2014-05-09 05:18:49 +00:00
|
|
|
wth->priv = (void *)stanag4607;
|
2013-07-29 00:54:33 +00:00
|
|
|
stanag4607->base_secs = 0; /* unknown as of yet */
|
|
|
|
|
2014-05-09 05:18:49 +00:00
|
|
|
wth->subtype_read = stanag4607_read;
|
|
|
|
wth->subtype_seek_read = stanag4607_seek_read;
|
2014-09-28 18:37:06 +00:00
|
|
|
wth->file_tsprec = WTAP_TSPREC_MSEC;
|
2013-07-28 23:41:18 +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;
|
2013-07-28 23:41:18 +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 stanag4607_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 stanag4607_info = {
|
|
|
|
"STANAG 4607 Format", "stanag4607", 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(stanag4607_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_stanag4607(void)
|
|
|
|
{
|
2021-02-24 03:10:35 +00:00
|
|
|
stanag4607_file_type_subtype = wtap_register_file_type_subtype(&stanag4607_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("STANAG_4607",
|
|
|
|
stanag4607_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:
|
|
|
|
*/
|