2014-05-09 05:18:49 +00:00
|
|
|
/* daintree_sna.c
|
2009-05-24 22:49:36 +00:00
|
|
|
* Routines for opening .dcf capture files created by Daintree's
|
|
|
|
* Sensor Network Analyzer for 802.15.4 radios
|
|
|
|
* Copyright 2009, Exegin Technologies Limited <fff@exegin.com>
|
|
|
|
*
|
|
|
|
* Wireshark - Network traffic analyzer
|
|
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
|
|
* Copyright 1998 Gerald Combs
|
|
|
|
*
|
2013-11-08 17:17:57 +00:00
|
|
|
* Started with packetlogger.c as a template, but little packetlogger code
|
|
|
|
* remains. Borrowed many snippets from dbs-etherwatch.c, the
|
2013-05-17 00:00:13 +00:00
|
|
|
* daintree_sna_process_hex_data function having the largest chunk.
|
2013-11-08 17:17:57 +00:00
|
|
|
*
|
2009-05-24 22:49:36 +00:00
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
|
|
|
* of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
|
|
|
|
* USA.
|
|
|
|
*/
|
|
|
|
|
2013-11-08 17:17:57 +00:00
|
|
|
/* This module reads capture files saved by Daintree's Sensor Network Analyzer.
|
2009-05-24 22:49:36 +00:00
|
|
|
* Daintree captures are plain text files with a two line header,
|
|
|
|
* followed by packet records, one per line, with whitespace separated fields
|
|
|
|
* consisting of: packet number, time, bytes of capture data, capture data,
|
|
|
|
* unknown, unknown, signal strength?, unknown, etc, and terminated with CRLF.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* Example capture file:
|
2013-11-08 17:17:57 +00:00
|
|
|
|
2009-05-24 22:49:36 +00:00
|
|
|
#Format=4
|
|
|
|
# SNA v2.2.0.4 SUS:20090709 ACT:819705
|
|
|
|
1 1233783799.326400 10 030809ffffffff07ffff 42 1 -69 25 2 0 1 32767
|
|
|
|
2 1233783799.477440 5 02000bffff 110 1 -44 25 6 0 1 32767
|
|
|
|
3 1233783799.809920 5 020013ffff 107 1 -45 25 43 0 1 3276
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include "config.h"
|
|
|
|
|
|
|
|
#include <stdlib.h>
|
|
|
|
#include <errno.h>
|
|
|
|
#include <string.h>
|
|
|
|
|
|
|
|
#include "wtap-int.h"
|
|
|
|
#include "file_wrappers.h"
|
|
|
|
#include "daintree-sna.h"
|
|
|
|
|
|
|
|
typedef struct daintree_sna_header {
|
|
|
|
guint32 len;
|
|
|
|
guint64 ts;
|
|
|
|
} daintree_sna_header_t;
|
|
|
|
|
|
|
|
#define DAINTREE_SNA_HEADER_SIZE 2
|
|
|
|
#define FCS_LENGTH 2
|
|
|
|
|
|
|
|
static const char daintree_magic_text[] =
|
|
|
|
{ '#', 'F', 'o', 'r', 'm', 'a', 't', '=' };
|
|
|
|
|
|
|
|
#define DAINTREE_MAGIC_TEXT_SIZE (sizeof daintree_magic_text)
|
|
|
|
#define DAINTREE_MAX_LINE_SIZE 512
|
2009-12-04 16:56:34 +00:00
|
|
|
#define READDATA_BUF_SIZE (DAINTREE_MAX_LINE_SIZE/2)
|
|
|
|
#define READDATA_MAX_FIELD_SIZE "255" /* DAINTREE_MAX_LINE_SIZE/2 -1 */
|
2009-12-04 16:42:14 +00:00
|
|
|
|
2009-05-24 22:49:36 +00:00
|
|
|
#define COMMENT_LINE daintree_magic_text[0]
|
|
|
|
|
2014-05-23 10:50:02 +00:00
|
|
|
static gboolean daintree_sna_read(wtap *wth, int *err, gchar **err_info,
|
2009-05-24 22:49:36 +00:00
|
|
|
gint64 *data_offset);
|
|
|
|
|
2014-05-23 10:50:02 +00:00
|
|
|
static gboolean daintree_sna_seek_read(wtap *wth, gint64 seek_off,
|
2014-05-09 05:18:49 +00:00
|
|
|
struct wtap_pkthdr *phdr, Buffer *buf, int *err, gchar **err_info);
|
2009-05-24 22:49:36 +00:00
|
|
|
|
2016-04-30 09:05:09 +00:00
|
|
|
static gboolean daintree_sna_read_packet(FILE_T fh, struct wtap_pkthdr *phdr,
|
|
|
|
Buffer *buf, int *err, gchar **err_info);
|
2009-05-24 22:49:36 +00:00
|
|
|
|
|
|
|
/* Open a file and determine if it's a Daintree file */
|
2014-10-09 23:44:15 +00:00
|
|
|
wtap_open_return_val daintree_sna_open(wtap *wth, int *err, gchar **err_info)
|
2009-05-24 22:49:36 +00:00
|
|
|
{
|
2012-04-22 02:03:29 +00:00
|
|
|
char readLine[DAINTREE_MAX_LINE_SIZE];
|
2009-05-24 22:49:36 +00:00
|
|
|
|
|
|
|
/* get first line of file header */
|
2014-05-09 05:18:49 +00:00
|
|
|
if (file_gets(readLine, DAINTREE_MAX_LINE_SIZE, wth->fh)==NULL) {
|
|
|
|
*err = file_error(wth->fh, err_info);
|
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;
|
|
|
|
return WTAP_OPEN_NOT_MINE;
|
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
|
|
|
}
|
2009-05-24 22:49:36 +00:00
|
|
|
|
|
|
|
/* check magic text */
|
2014-10-09 23:44:15 +00:00
|
|
|
if (memcmp(readLine, daintree_magic_text, DAINTREE_MAGIC_TEXT_SIZE) != 0)
|
|
|
|
return WTAP_OPEN_NOT_MINE; /* not daintree format */
|
2009-05-24 22:49:36 +00:00
|
|
|
|
|
|
|
/* read second header line */
|
2014-05-09 05:18:49 +00:00
|
|
|
if (file_gets(readLine, DAINTREE_MAX_LINE_SIZE, wth->fh)==NULL) {
|
|
|
|
*err = file_error(wth->fh, err_info);
|
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;
|
|
|
|
return WTAP_OPEN_NOT_MINE;
|
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
|
|
|
}
|
2014-10-09 23:44:15 +00:00
|
|
|
if (readLine[0] != COMMENT_LINE)
|
|
|
|
return WTAP_OPEN_NOT_MINE; /* daintree files have a two line header */
|
2009-05-24 22:49:36 +00:00
|
|
|
|
|
|
|
/* set up the pointers to the handlers for this file type */
|
2014-05-09 05:18:49 +00:00
|
|
|
wth->subtype_read = daintree_sna_read;
|
|
|
|
wth->subtype_seek_read = daintree_sna_seek_read;
|
2009-05-24 22:49:36 +00:00
|
|
|
|
|
|
|
/* set up for file type */
|
2014-05-09 05:18:49 +00:00
|
|
|
wth->file_type_subtype = WTAP_FILE_TYPE_SUBTYPE_DAINTREE_SNA;
|
|
|
|
wth->file_encap = WTAP_ENCAP_IEEE802_15_4_NOFCS;
|
2014-09-28 18:37:06 +00:00
|
|
|
wth->file_tsprec = WTAP_TSPREC_USEC;
|
2014-05-09 05:18:49 +00:00
|
|
|
wth->snapshot_length = 0; /* not available in header */
|
2009-05-24 22:49:36 +00:00
|
|
|
|
2014-10-09 23:44:15 +00:00
|
|
|
return WTAP_OPEN_MINE; /* it's a Daintree file */
|
2009-05-24 22:49:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/* Read the capture file sequentially
|
|
|
|
* Wireshark scans the file with sequential reads during preview and initial display. */
|
2014-05-23 10:50:02 +00:00
|
|
|
static gboolean
|
2014-05-09 05:18:49 +00:00
|
|
|
daintree_sna_read(wtap *wth, int *err, gchar **err_info, gint64 *data_offset)
|
2009-05-24 22:49:36 +00:00
|
|
|
{
|
2014-05-09 05:18:49 +00:00
|
|
|
*data_offset = file_tell(wth->fh);
|
2009-05-24 22:49:36 +00:00
|
|
|
|
2016-04-30 09:05:09 +00:00
|
|
|
/* parse that line and the following packet data */
|
|
|
|
return daintree_sna_read_packet(wth->fh, &wth->phdr,
|
|
|
|
wth->frame_buffer, err, err_info);
|
2009-05-24 22:49:36 +00:00
|
|
|
}
|
|
|
|
|
2013-11-08 17:17:57 +00:00
|
|
|
/* Read the capture file randomly
|
2009-05-24 22:49:36 +00:00
|
|
|
* Wireshark opens the capture file for random access when displaying user-selected packets */
|
2014-05-23 10:50:02 +00:00
|
|
|
static gboolean
|
2014-05-09 05:18:49 +00:00
|
|
|
daintree_sna_seek_read(wtap *wth, gint64 seek_off, struct wtap_pkthdr *phdr,
|
2014-01-02 20:47:21 +00:00
|
|
|
Buffer *buf, int *err, gchar **err_info)
|
2009-05-24 22:49:36 +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;
|
2009-05-24 22:49:36 +00:00
|
|
|
|
2016-04-30 09:05:09 +00:00
|
|
|
/* parse that line and the following packet data */
|
|
|
|
return daintree_sna_read_packet(wth->random_fh, phdr, buf, err,
|
2013-06-17 21:18:47 +00:00
|
|
|
err_info);
|
2013-05-17 00:00:13 +00:00
|
|
|
}
|
2009-05-24 22:49:36 +00:00
|
|
|
|
2016-04-30 09:05:09 +00:00
|
|
|
/* Read a header line, scan it, and fill in a struct wtap_pkthdr.
|
|
|
|
* Then convert packet data from ASCII hex string to binary in place,
|
|
|
|
* sanity-check its length against what we assume is the packet length field,
|
|
|
|
* and copy it into a Buffer. */
|
2013-05-17 00:00:13 +00:00
|
|
|
static gboolean
|
2016-04-30 09:05:09 +00:00
|
|
|
daintree_sna_read_packet(FILE_T fh, struct wtap_pkthdr *phdr, Buffer *buf,
|
|
|
|
int *err, gchar **err_info)
|
2013-05-17 00:00:13 +00:00
|
|
|
{
|
|
|
|
guint64 seconds;
|
|
|
|
int useconds;
|
2016-04-30 09:05:09 +00:00
|
|
|
char readLine[DAINTREE_MAX_LINE_SIZE];
|
|
|
|
char readData[READDATA_BUF_SIZE];
|
|
|
|
guchar *str = (guchar *)readData;
|
|
|
|
guint bytes;
|
|
|
|
guint8 *p;
|
|
|
|
|
|
|
|
/* we've only seen file header lines starting with '#', but
|
|
|
|
* if others appear in the file, they are tossed */
|
|
|
|
do {
|
|
|
|
if (file_gets(readLine, DAINTREE_MAX_LINE_SIZE, fh) == NULL) {
|
|
|
|
*err = file_error(fh, err_info);
|
|
|
|
return FALSE; /* all done */
|
|
|
|
}
|
|
|
|
} while (readLine[0] == COMMENT_LINE);
|
2013-05-17 00:00:13 +00:00
|
|
|
|
2014-05-24 18:28:30 +00:00
|
|
|
phdr->rec_type = REC_TYPE_PACKET;
|
2013-05-17 00:00:13 +00:00
|
|
|
phdr->presence_flags = WTAP_HAS_TS|WTAP_HAS_CAP_LEN;
|
|
|
|
|
|
|
|
if (sscanf(readLine, "%*s %18" G_GINT64_MODIFIER "u.%9d %9u %" READDATA_MAX_FIELD_SIZE "s",
|
|
|
|
&seconds, &useconds, &phdr->len, readData) != 4) {
|
2011-12-13 09:53:50 +00:00
|
|
|
*err = WTAP_ERR_BAD_FILE;
|
2013-05-17 00:00:13 +00:00
|
|
|
*err_info = g_strdup("daintree_sna: invalid read record");
|
2009-05-24 22:49:36 +00:00
|
|
|
return FALSE;
|
|
|
|
}
|
|
|
|
|
2013-05-17 00:00:13 +00:00
|
|
|
/* Daintree doesn't store the FCS, but pads end of packet with 0xffff, which we toss */
|
|
|
|
if (phdr->len <= FCS_LENGTH) {
|
2011-12-13 09:53:50 +00:00
|
|
|
*err = WTAP_ERR_BAD_FILE;
|
2013-05-17 00:00:13 +00:00
|
|
|
*err_info = g_strdup_printf("daintree_sna: packet length <= %u bytes, no frame data present",
|
|
|
|
FCS_LENGTH);
|
2009-05-24 22:49:36 +00:00
|
|
|
return FALSE;
|
2013-05-17 00:00:13 +00:00
|
|
|
}
|
|
|
|
phdr->len -= FCS_LENGTH;
|
|
|
|
|
|
|
|
phdr->ts.secs = (time_t) seconds;
|
|
|
|
phdr->ts.nsecs = useconds * 1000; /* convert mS to nS */
|
2009-05-24 22:49:36 +00:00
|
|
|
|
2016-04-30 09:05:09 +00:00
|
|
|
/*
|
|
|
|
* READDATA_BUF_SIZE is < WTAP_MAX_PACKET_SIZE, and is the maximum
|
|
|
|
* number of bytes of packet data we can generate, so we don't
|
|
|
|
* need to check the packet length.
|
|
|
|
*/
|
2009-05-24 22:49:36 +00:00
|
|
|
p = str; /* overlay source buffer */
|
|
|
|
bytes = 0;
|
2011-09-01 09:43:10 +00:00
|
|
|
/* convert hex string to guint8 */
|
2009-05-24 22:49:36 +00:00
|
|
|
while(*str) {
|
|
|
|
/* most significant nibble */
|
2014-10-17 20:37:11 +00:00
|
|
|
if (!g_ascii_isxdigit(*str)) {
|
2013-05-17 00:00:13 +00:00
|
|
|
*err = WTAP_ERR_BAD_FILE;
|
|
|
|
*err_info = g_strdup("daintree_sna: non-hex digit in hex data");
|
2014-05-23 10:50:02 +00:00
|
|
|
return FALSE;
|
2013-05-17 00:00:13 +00:00
|
|
|
}
|
2014-10-17 20:37:11 +00:00
|
|
|
if(g_ascii_isdigit(*str)) {
|
2009-05-24 22:49:36 +00:00
|
|
|
*p = (*str - '0') << 4;
|
|
|
|
} else {
|
2014-10-17 20:37:11 +00:00
|
|
|
*p = ((g_ascii_tolower(*str) - 'a') + 10) << 4;
|
2009-05-24 22:49:36 +00:00
|
|
|
}
|
|
|
|
str++;
|
|
|
|
|
|
|
|
/* least significant nibble */
|
2014-10-17 20:37:11 +00:00
|
|
|
if (!g_ascii_isxdigit(*str)) {
|
2013-05-17 00:00:13 +00:00
|
|
|
*err = WTAP_ERR_BAD_FILE;
|
|
|
|
*err_info = g_strdup("daintree_sna: non-hex digit in hex data");
|
2014-05-23 10:50:02 +00:00
|
|
|
return FALSE;
|
2013-05-17 00:00:13 +00:00
|
|
|
}
|
2014-10-17 20:37:11 +00:00
|
|
|
if(g_ascii_isdigit(*str)) {
|
2009-05-24 22:49:36 +00:00
|
|
|
*p += *str - '0';
|
|
|
|
} else {
|
2014-10-17 20:37:11 +00:00
|
|
|
*p += (g_ascii_tolower(*str) - 'a') + 10;
|
2009-05-24 22:49:36 +00:00
|
|
|
}
|
|
|
|
str++;
|
|
|
|
|
|
|
|
/* next byte in buffer */
|
|
|
|
p++;
|
|
|
|
bytes++;
|
|
|
|
}
|
|
|
|
|
2013-05-17 00:00:13 +00:00
|
|
|
/* Daintree doesn't store the FCS, but pads end of packet with 0xffff, which we toss */
|
|
|
|
if (bytes <= FCS_LENGTH) {
|
|
|
|
*err = WTAP_ERR_BAD_FILE;
|
|
|
|
*err_info = g_strdup_printf("daintree_sna: Only %u bytes of packet data",
|
|
|
|
bytes);
|
2014-05-23 10:50:02 +00:00
|
|
|
return FALSE;
|
2013-05-17 00:00:13 +00:00
|
|
|
}
|
|
|
|
bytes -= FCS_LENGTH;
|
|
|
|
if (bytes > phdr->len) {
|
|
|
|
*err = WTAP_ERR_BAD_FILE;
|
|
|
|
*err_info = g_strdup_printf("daintree_sna: capture length (%u) > packet length (%u)",
|
|
|
|
bytes, phdr->len);
|
2014-05-23 10:50:02 +00:00
|
|
|
return FALSE;
|
2013-05-17 00:00:13 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
phdr->caplen = bytes;
|
2013-06-16 00:20:00 +00:00
|
|
|
|
2014-08-02 11:00:48 +00:00
|
|
|
ws_buffer_assure_space(buf, bytes);
|
|
|
|
memcpy(ws_buffer_start_ptr(buf), readData, bytes);
|
2014-05-23 10:50:02 +00:00
|
|
|
return TRUE;
|
2009-05-24 22:49:36 +00:00
|
|
|
}
|
2015-01-02 00:45:22 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Editor modelines - http://www.wireshark.org/tools/modelines.html
|
|
|
|
*
|
|
|
|
* Local variables:
|
|
|
|
* c-basic-offset: 8
|
|
|
|
* tab-width: 8
|
|
|
|
* indent-tabs-mode: t
|
|
|
|
* End:
|
|
|
|
*
|
|
|
|
* vi: set shiftwidth=8 tabstop=8 noexpandtab:
|
|
|
|
* :indentSize=8:tabSize=8:noTabs=false:
|
|
|
|
*/
|