2010-10-20 00:36:53 +00:00
|
|
|
/* ipfix.c
|
|
|
|
*
|
|
|
|
* Wiretap Library
|
|
|
|
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
|
|
|
|
*
|
|
|
|
* File format support for ipfix file format
|
|
|
|
* Copyright (c) 2010 by Hadriel Kaplan <hadrielk@yahoo.com>
|
|
|
|
* with generous copying from other wiretaps, such as pcapng
|
|
|
|
*
|
2018-02-07 11:26:45 +00:00
|
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
2010-10-20 00:36:53 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
/* File format reference:
|
|
|
|
* RFC 5655 and 5101
|
2019-07-28 04:20:27 +00:00
|
|
|
* https://tools.ietf.org/rfc/rfc5655
|
|
|
|
* https://tools.ietf.org/rfc/rfc5101
|
2010-10-20 00:36:53 +00:00
|
|
|
*
|
|
|
|
* This wiretap is for an ipfix file format reader, per RFC 5655/5101.
|
|
|
|
* All "records" in the file are IPFIX messages, beginning with an IPFIX
|
|
|
|
* message header of 16 bytes as follows from RFC 5101:
|
|
|
|
0 1 2 3
|
|
|
|
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
|
|
|
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
|
|
|
| Version Number | Length |
|
|
|
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
|
|
|
| Export Time |
|
|
|
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
|
|
|
| Sequence Number |
|
|
|
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
|
|
|
| Observation Domain ID |
|
|
|
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
|
|
|
|
|
|
|
Figure F: IPFIX Message Header Format
|
|
|
|
|
|
|
|
* which is then followed by one or more "Sets": Data Sets, Template Sets,
|
|
|
|
* and Options Template Sets. Each Set then has one or more Records in
|
|
|
|
* it.
|
|
|
|
*
|
|
|
|
* All IPFIX files are recorded in big-endian form (network byte order),
|
|
|
|
* per the RFCs. That means if we're on a little-endian system, all
|
|
|
|
* hell will break loose if we don't g_ntohX.
|
|
|
|
*
|
|
|
|
* Since wireshark already has an IPFIX dissector (implemented in
|
|
|
|
* packet-netflow.c), this reader will just set that dissector upon
|
|
|
|
* reading each message. Thus, an IPFIX Message is treated as a packet
|
|
|
|
* as far as the dissector is concerned.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include "config.h"
|
|
|
|
|
2021-06-08 01:46:52 +00:00
|
|
|
#define WS_LOG_DOMAIN LOG_DOMAIN_WIRETAP
|
2021-02-27 03:38:15 +00:00
|
|
|
|
2010-10-20 00:36:53 +00:00
|
|
|
#include <stdlib.h>
|
|
|
|
#include <string.h>
|
|
|
|
#include <errno.h>
|
|
|
|
#include "wtap-int.h"
|
|
|
|
#include "file_wrappers.h"
|
|
|
|
#include "ipfix.h"
|
|
|
|
|
2016-09-07 12:39:46 +00:00
|
|
|
#include <wsutil/strtoi.h>
|
2021-02-27 03:38:15 +00:00
|
|
|
#include <wsutil/wslog.h>
|
2010-10-20 00:36:53 +00:00
|
|
|
|
2010-10-20 17:20:56 +00:00
|
|
|
#define RECORDS_FOR_IPFIX_CHECK 20
|
|
|
|
|
2014-05-23 10:50:02 +00:00
|
|
|
static gboolean
|
2019-04-05 01:56:27 +00:00
|
|
|
ipfix_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
|
2014-05-09 05:18:49 +00:00
|
|
|
ipfix_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);
|
2010-10-20 00:36:53 +00:00
|
|
|
|
|
|
|
#define IPFIX_VERSION 10
|
|
|
|
|
|
|
|
/* ipfix: message header */
|
|
|
|
typedef struct ipfix_message_header_s {
|
|
|
|
guint16 version;
|
|
|
|
guint16 message_length;
|
|
|
|
guint32 export_time_secs;
|
|
|
|
guint32 sequence_number;
|
|
|
|
guint32 observation_id; /* might be 0 for none */
|
|
|
|
/* x bytes msg_body */
|
|
|
|
} ipfix_message_header_t;
|
|
|
|
#define IPFIX_MSG_HDR_SIZE 16
|
|
|
|
|
|
|
|
/* ipfix: common Set header for every Set type */
|
|
|
|
typedef struct ipfix_set_header_s {
|
|
|
|
guint16 set_type;
|
|
|
|
guint16 set_length;
|
|
|
|
/* x bytes set_body */
|
|
|
|
} ipfix_set_header_t;
|
|
|
|
#define IPFIX_SET_HDR_SIZE 4
|
|
|
|
|
|
|
|
|
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 ipfix_file_type_subtype = -1;
|
|
|
|
|
|
|
|
void register_ipfix(void);
|
|
|
|
|
2013-05-17 07:28:34 +00:00
|
|
|
/* Read IPFIX message header from file. Return true on success. Set *err to
|
|
|
|
* 0 on EOF, any other value for "real" errors (EOF is ok, since return
|
|
|
|
* value is still FALSE)
|
2010-10-20 00:36:53 +00:00
|
|
|
*/
|
2010-10-20 17:20:56 +00:00
|
|
|
static gboolean
|
2013-05-17 07:28:34 +00:00
|
|
|
ipfix_read_message_header(ipfix_message_header_t *pfx_hdr, FILE_T fh, int *err, gchar **err_info)
|
2010-10-20 00:36:53 +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, pfx_hdr, IPFIX_MSG_HDR_SIZE, err, err_info))
|
|
|
|
return FALSE;
|
2010-10-20 00:36:53 +00:00
|
|
|
|
2020-10-10 23:42:05 +00:00
|
|
|
/* fix endianness, because IPFIX files are always big-endian */
|
2013-05-17 07:28:34 +00:00
|
|
|
pfx_hdr->version = g_ntohs(pfx_hdr->version);
|
|
|
|
pfx_hdr->message_length = g_ntohs(pfx_hdr->message_length);
|
|
|
|
pfx_hdr->export_time_secs = g_ntohl(pfx_hdr->export_time_secs);
|
|
|
|
pfx_hdr->sequence_number = g_ntohl(pfx_hdr->sequence_number);
|
|
|
|
pfx_hdr->observation_id = g_ntohl(pfx_hdr->observation_id);
|
2010-10-20 00:36:53 +00:00
|
|
|
|
|
|
|
/* is the version number one we expect? */
|
2013-05-17 07:28:34 +00:00
|
|
|
if (pfx_hdr->version != IPFIX_VERSION) {
|
2010-10-20 00:36:53 +00:00
|
|
|
/* Not an ipfix file. */
|
2011-12-13 09:53:50 +00:00
|
|
|
*err = WTAP_ERR_BAD_FILE;
|
2021-12-18 18:48:20 +00:00
|
|
|
*err_info = ws_strdup_printf("ipfix: wrong version %d", pfx_hdr->version);
|
2010-10-20 00:36:53 +00:00
|
|
|
return FALSE;
|
|
|
|
}
|
|
|
|
|
2013-05-17 07:28:34 +00:00
|
|
|
if (pfx_hdr->message_length < 16) {
|
2011-12-13 09:53:50 +00:00
|
|
|
*err = WTAP_ERR_BAD_FILE;
|
2021-12-18 18:48:20 +00:00
|
|
|
*err_info = ws_strdup_printf("ipfix: message length %u is too short", pfx_hdr->message_length);
|
2010-10-20 00:36:53 +00:00
|
|
|
return FALSE;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* go back to before header */
|
|
|
|
if (file_seek(fh, 0 - IPFIX_MSG_HDR_SIZE, SEEK_CUR, err) == -1) {
|
2021-06-06 16:18:33 +00:00
|
|
|
ws_debug("couldn't go back in file before header");
|
2010-10-20 00:36:53 +00:00
|
|
|
return FALSE;
|
|
|
|
}
|
|
|
|
|
2013-05-17 07:28:34 +00:00
|
|
|
return TRUE;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2020-12-17 13:23:14 +00:00
|
|
|
/* Read IPFIX message header from file and fill in the struct wtap_rec
|
2013-06-17 21:18:47 +00:00
|
|
|
* for the packet, and, if that succeeds, read the packet data.
|
|
|
|
* Return true on success. Set *err to 0 on EOF, any other value for "real"
|
|
|
|
* errors (EOF is ok, since return value is still FALSE).
|
2013-05-17 07:28:34 +00:00
|
|
|
*/
|
|
|
|
static gboolean
|
2018-02-09 00:19:12 +00:00
|
|
|
ipfix_read_message(FILE_T fh, wtap_rec *rec, Buffer *buf, int *err, gchar **err_info)
|
2013-05-17 07:28:34 +00:00
|
|
|
{
|
|
|
|
ipfix_message_header_t msg_hdr;
|
|
|
|
|
|
|
|
if (!ipfix_read_message_header(&msg_hdr, fh, err, err_info))
|
|
|
|
return FALSE;
|
2016-04-30 02:04:17 +00:00
|
|
|
/*
|
|
|
|
* The maximum value of msg_hdr.message_length is 65535, which is
|
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
|
|
|
* less than WTAP_MAX_PACKET_SIZE_STANDARD will ever be, so we don't need
|
2016-04-30 02:04:17 +00:00
|
|
|
* to check it.
|
|
|
|
*/
|
2013-05-17 07:28:34 +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 = msg_hdr.message_length;
|
|
|
|
rec->rec_header.packet_header.caplen = msg_hdr.message_length;
|
|
|
|
rec->ts.secs = msg_hdr.export_time_secs;
|
|
|
|
rec->ts.nsecs = 0;
|
2013-05-17 06:41:20 +00:00
|
|
|
|
2013-06-17 21:18:47 +00:00
|
|
|
return wtap_read_packet_bytes(fh, buf, msg_hdr.message_length, err, err_info);
|
2010-10-20 00:36:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
2014-10-09 23:44:15 +00:00
|
|
|
/* classic wtap: open capture file. Return WTAP_OPEN_MINE on success,
|
|
|
|
* WTAP_OPEN_NOT_MINE on normal failure like malformed format,
|
|
|
|
* WTAP_OPEN_ERROR on bad error like file system
|
2010-10-20 00:36:53 +00:00
|
|
|
*/
|
2014-10-09 23:44:15 +00:00
|
|
|
wtap_open_return_val
|
2014-05-09 05:18:49 +00:00
|
|
|
ipfix_open(wtap *wth, int *err, gchar **err_info)
|
2010-10-20 00:36:53 +00:00
|
|
|
{
|
|
|
|
gint i, n, records_for_ipfix_check = RECORDS_FOR_IPFIX_CHECK;
|
|
|
|
gchar *s;
|
|
|
|
guint16 checked_len = 0;
|
|
|
|
ipfix_message_header_t msg_hdr;
|
|
|
|
ipfix_set_header_t set_hdr;
|
|
|
|
|
2021-06-06 16:18:33 +00:00
|
|
|
ws_debug("opening file");
|
2010-10-20 00:36:53 +00:00
|
|
|
|
2010-10-21 14:23:22 +00:00
|
|
|
/* number of records to scan before deciding if this really is IPFIX */
|
2010-10-20 00:36:53 +00:00
|
|
|
if ((s = getenv("IPFIX_RECORDS_TO_CHECK")) != NULL) {
|
2016-09-07 12:39:46 +00:00
|
|
|
if (ws_strtoi32(s, NULL, &n) && n > 0 && n < 101) {
|
2010-10-20 00:36:53 +00:00
|
|
|
records_for_ipfix_check = n;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* IPFIX is a little hard because there's no magic number; we look at
|
|
|
|
* the first few records and see if they look enough like IPFIX
|
|
|
|
* records.
|
|
|
|
*/
|
|
|
|
for (i = 0; i < records_for_ipfix_check; i++) {
|
|
|
|
/* read first message header to check version */
|
2014-05-09 05:18:49 +00:00
|
|
|
if (!ipfix_read_message_header(&msg_hdr, wth->fh, err, err_info)) {
|
2021-06-06 16:18:33 +00:00
|
|
|
ws_debug("couldn't read message header #%d with err code #%d (%s)",
|
2010-10-20 17:20:56 +00:00
|
|
|
i, *err, *err_info);
|
2011-12-13 09:53:50 +00:00
|
|
|
if (*err == WTAP_ERR_BAD_FILE) {
|
2010-10-20 17:20:56 +00:00
|
|
|
*err = 0; /* not actually an error in this case */
|
|
|
|
g_free(*err_info);
|
|
|
|
*err_info = NULL;
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_NOT_MINE;
|
2010-10-20 17:20:56 +00:00
|
|
|
}
|
Do not call wtap_file_read_unknown_bytes() or
wtap_file_read_expected_bytes() from an open routine - open routines are
supposed to return -1 on error, 0 if the file doesn't appear to be a
file of the specified type, or 1 if the file does appear to be a file of
the specified type, but those macros will cause the caller to return
FALSE on errors (so that, even if there's an I/O error, it reports "the
file isn't a file of the specified type" rather than "we got an error
trying to read the file").
When doing reads in an open routine before we've concluded that the file
is probably of the right type, return 0, rather than -1, if we get
WTAP_ERR_SHORT_READ - if we don't have enough data to check whether a
file is of a given type, we should keep trying other types, not give up.
For reads done *after* we've concluded the file is probably of the right
type, if a read doesn't return the number of bytes we asked for, but
returns an error of 0, return WTAP_ERR_SHORT_READ - the file is
apparently cut short.
For NetMon and NetXRay/Windows Sniffer files, use a #define for the
magic number size, and use that for both magic numbers.
svn path=/trunk/; revision=46803
2012-12-27 12:19:25 +00:00
|
|
|
if (*err != 0 && *err != WTAP_ERR_SHORT_READ)
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_ERROR; /* real failure */
|
2010-10-20 00:36:53 +00:00
|
|
|
/* else it's EOF */
|
|
|
|
if (i < 1) {
|
|
|
|
/* we haven't seen enough to prove this is a ipfix file */
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_NOT_MINE;
|
2010-10-20 00:36:53 +00:00
|
|
|
}
|
2013-05-17 07:28:34 +00:00
|
|
|
/*
|
|
|
|
* If we got here, it's EOF and we haven't yet seen anything
|
|
|
|
* that doesn't look like an IPFIX record - i.e. everything
|
|
|
|
* we've seen looks like an IPFIX record - so we assume this
|
|
|
|
* is an IPFIX file.
|
|
|
|
*/
|
2010-10-20 00:36:53 +00:00
|
|
|
break;
|
|
|
|
}
|
2014-05-09 05:18:49 +00:00
|
|
|
if (file_seek(wth->fh, IPFIX_MSG_HDR_SIZE, SEEK_CUR, err) == -1) {
|
2021-06-06 16:18:33 +00:00
|
|
|
ws_debug("failed seek to next message in file, %d bytes away",
|
2010-10-20 00:36:53 +00:00
|
|
|
msg_hdr.message_length);
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_NOT_MINE;
|
2010-10-20 00:36:53 +00:00
|
|
|
}
|
|
|
|
checked_len = IPFIX_MSG_HDR_SIZE;
|
|
|
|
|
|
|
|
/* check each Set in IPFIX Message for sanity */
|
|
|
|
while (checked_len < msg_hdr.message_length) {
|
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, &set_hdr, IPFIX_SET_HDR_SIZE,
|
2014-10-07 07:39:54 +00:00
|
|
|
err, err_info)) {
|
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 (*err == WTAP_ERR_SHORT_READ) {
|
2014-09-23 01:13:59 +00:00
|
|
|
/* Not a valid IPFIX Set, so not an IPFIX file. */
|
2021-06-06 16:18:33 +00:00
|
|
|
ws_debug("error %d reading set", *err);
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_NOT_MINE;
|
2014-09-23 01:13:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/* A real I/O error; fail. */
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_ERROR;
|
2014-09-23 01:13:59 +00:00
|
|
|
}
|
2010-10-20 00:36:53 +00:00
|
|
|
set_hdr.set_length = g_ntohs(set_hdr.set_length);
|
|
|
|
if ((set_hdr.set_length < IPFIX_SET_HDR_SIZE) ||
|
|
|
|
((set_hdr.set_length + checked_len) > msg_hdr.message_length)) {
|
2021-06-06 16:18:33 +00:00
|
|
|
ws_debug("found invalid set_length of %d",
|
2010-10-20 00:36:53 +00:00
|
|
|
set_hdr.set_length);
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_NOT_MINE;
|
2010-10-20 00:36:53 +00:00
|
|
|
}
|
|
|
|
|
2014-05-09 05:18:49 +00:00
|
|
|
if (file_seek(wth->fh, set_hdr.set_length - IPFIX_SET_HDR_SIZE,
|
2010-10-20 00:36:53 +00:00
|
|
|
SEEK_CUR, err) == -1)
|
|
|
|
{
|
2021-06-06 16:18:33 +00:00
|
|
|
ws_debug("failed seek to next set in file, %d bytes away",
|
2010-10-20 00:36:53 +00:00
|
|
|
set_hdr.set_length - IPFIX_SET_HDR_SIZE);
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_ERROR;
|
2010-10-20 00:36:53 +00:00
|
|
|
}
|
|
|
|
checked_len += set_hdr.set_length;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-10-09 23:44:15 +00:00
|
|
|
/* go back to beginning of file */
|
|
|
|
if (file_seek (wth->fh, 0, SEEK_SET, err) != 0)
|
|
|
|
{
|
|
|
|
return WTAP_OPEN_ERROR;
|
|
|
|
}
|
|
|
|
|
2010-10-20 00:36:53 +00:00
|
|
|
/* all's good, this is a IPFIX file */
|
2014-05-09 05:18:49 +00:00
|
|
|
wth->file_encap = WTAP_ENCAP_RAW_IPFIX;
|
|
|
|
wth->snapshot_length = 0;
|
2014-09-28 18:37:06 +00:00
|
|
|
wth->file_tsprec = WTAP_TSPREC_SEC;
|
2014-05-09 05:18:49 +00:00
|
|
|
wth->subtype_read = ipfix_read;
|
|
|
|
wth->subtype_seek_read = ipfix_seek_read;
|
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 = ipfix_file_type_subtype;
|
2010-10-20 00:36:53 +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;
|
2010-10-20 00:36:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/* classic wtap: read packet */
|
2014-05-23 10:50:02 +00:00
|
|
|
static gboolean
|
2019-04-05 01:56:27 +00:00
|
|
|
ipfix_read(wtap *wth, wtap_rec *rec, Buffer *buf, int *err,
|
|
|
|
gchar **err_info, gint64 *data_offset)
|
2010-10-20 00:36:53 +00:00
|
|
|
{
|
2014-05-09 05:18:49 +00:00
|
|
|
*data_offset = file_tell(wth->fh);
|
2021-12-17 20:05:19 +00:00
|
|
|
ws_debug("offset is initially %" PRId64, *data_offset);
|
2010-10-20 00:36:53 +00:00
|
|
|
|
2019-04-05 01:56:27 +00:00
|
|
|
if (!ipfix_read_message(wth->fh, rec, buf, err, err_info)) {
|
2021-06-06 16:18:33 +00:00
|
|
|
ws_debug("couldn't read message header with code: %d\n, and error '%s'",
|
2010-10-20 00:36:53 +00:00
|
|
|
*err, *err_info);
|
2014-05-23 10:50:02 +00:00
|
|
|
return FALSE;
|
2010-10-20 00:36:53 +00:00
|
|
|
}
|
|
|
|
|
2014-05-23 10:50:02 +00:00
|
|
|
return TRUE;
|
2010-10-20 00:36:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/* classic wtap: seek to file position and read packet */
|
2014-05-23 10:50:02 +00:00
|
|
|
static gboolean
|
2018-02-09 00:19:12 +00:00
|
|
|
ipfix_seek_read(wtap *wth, gint64 seek_off, wtap_rec *rec,
|
2014-01-02 20:47:21 +00:00
|
|
|
Buffer *buf, int *err, gchar **err_info)
|
2010-10-20 00:36:53 +00:00
|
|
|
{
|
|
|
|
/* seek to the right file position */
|
2014-05-09 05:18:49 +00:00
|
|
|
if (file_seek(wth->random_fh, seek_off, SEEK_SET, err) == -1) {
|
2021-06-06 16:18:33 +00:00
|
|
|
ws_debug("couldn't read message header with code: %d\n, and error '%s'",
|
2010-10-20 00:36:53 +00:00
|
|
|
*err, *err_info);
|
2014-05-23 10:50:02 +00:00
|
|
|
return FALSE; /* Seek error */
|
2010-10-20 00:36:53 +00:00
|
|
|
}
|
|
|
|
|
2021-12-17 20:05:19 +00:00
|
|
|
ws_debug("reading at offset %" PRIu64, seek_off);
|
2010-10-20 00:36:53 +00:00
|
|
|
|
2018-02-09 00:19:12 +00:00
|
|
|
if (!ipfix_read_message(wth->random_fh, rec, buf, err, err_info)) {
|
2021-06-06 16:18:33 +00:00
|
|
|
ws_debug("couldn't read message header");
|
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;
|
2010-10-20 00:36:53 +00:00
|
|
|
}
|
2014-05-23 10:50:02 +00:00
|
|
|
return TRUE;
|
2010-10-20 00:36:53 +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 ipfix_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 ipfix_info = {
|
|
|
|
"IPFIX File Format", "ipfix", "pfx", "ipfix",
|
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(ipfix_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_ipfix(void)
|
|
|
|
{
|
2021-02-24 03:10:35 +00:00
|
|
|
ipfix_file_type_subtype = wtap_register_file_type_subtype(&ipfix_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("IPFIX",
|
|
|
|
ipfix_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: 4
|
|
|
|
* tab-width: 8
|
|
|
|
* indent-tabs-mode: nil
|
|
|
|
* End:
|
|
|
|
*
|
|
|
|
* vi: set shiftwidth=4 tabstop=8 expandtab:
|
|
|
|
* :indentSize=4:tabSize=8:noTabs=true:
|
|
|
|
*/
|