forked from osmocom/wireshark
9d41c658fe
wtap_seek_read(). svn path=/trunk/; revision=54570
295 lines
8.8 KiB
C
295 lines
8.8 KiB
C
/* daintree_sna.c
|
|
* 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>
|
|
*
|
|
* $Id$
|
|
*
|
|
* Wireshark - Network traffic analyzer
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
* Copyright 1998 Gerald Combs
|
|
*
|
|
* Started with packetlogger.c as a template, but little packetlogger code
|
|
* remains. Borrowed many snippets from dbs-etherwatch.c, the
|
|
* daintree_sna_process_hex_data function having the largest chunk.
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
/* This module reads capture files saved by Daintree's Sensor Network Analyzer.
|
|
* 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:
|
|
|
|
#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 <glib.h>
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include <errno.h>
|
|
#include <string.h>
|
|
#include <ctype.h>
|
|
|
|
#include "wtap.h"
|
|
#include "wtap-int.h"
|
|
#include "buffer.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
|
|
#define READDATA_BUF_SIZE (DAINTREE_MAX_LINE_SIZE/2)
|
|
#define READDATA_MAX_FIELD_SIZE "255" /* DAINTREE_MAX_LINE_SIZE/2 -1 */
|
|
|
|
#define COMMENT_LINE daintree_magic_text[0]
|
|
|
|
static gboolean daintree_sna_read(wtap *wth, int *err, gchar **err_info,
|
|
gint64 *data_offset);
|
|
|
|
static gboolean daintree_sna_seek_read(wtap *wth, gint64 seek_off,
|
|
struct wtap_pkthdr *phdr, Buffer *buf, int *err, gchar **err_info);
|
|
|
|
static gboolean daintree_sna_scan_header(struct wtap_pkthdr *phdr,
|
|
char *readLine, char *readData, int *err, gchar **err_info);
|
|
|
|
static gboolean daintree_sna_process_hex_data(struct wtap_pkthdr *phdr,
|
|
Buffer *buf, char *readData, int *err, gchar **err_info);
|
|
|
|
/* Open a file and determine if it's a Daintree file */
|
|
int daintree_sna_open(wtap *wth, int *err, gchar **err_info)
|
|
{
|
|
char readLine[DAINTREE_MAX_LINE_SIZE];
|
|
guint i;
|
|
|
|
/* get first line of file header */
|
|
if (file_gets(readLine, DAINTREE_MAX_LINE_SIZE, wth->fh)==NULL) {
|
|
*err = file_error(wth->fh, err_info);
|
|
if (*err != 0 && *err != WTAP_ERR_SHORT_READ)
|
|
return -1;
|
|
return 0;
|
|
}
|
|
|
|
/* check magic text */
|
|
i = 0;
|
|
while (i < DAINTREE_MAGIC_TEXT_SIZE) {
|
|
if (readLine[i] != daintree_magic_text[i]) return 0; /* not daintree format */
|
|
i++;
|
|
}
|
|
|
|
/* read second header line */
|
|
if (file_gets(readLine, DAINTREE_MAX_LINE_SIZE, wth->fh)==NULL) {
|
|
*err = file_error(wth->fh, err_info);
|
|
if (*err != 0 && *err != WTAP_ERR_SHORT_READ)
|
|
return -1;
|
|
return 0;
|
|
}
|
|
if (readLine[0] != COMMENT_LINE) return 0; /* daintree files have a two line header */
|
|
|
|
/* set up the pointers to the handlers for this file type */
|
|
wth->subtype_read = daintree_sna_read;
|
|
wth->subtype_seek_read = daintree_sna_seek_read;
|
|
|
|
/* set up for file type */
|
|
wth->file_type_subtype = WTAP_FILE_TYPE_SUBTYPE_DAINTREE_SNA;
|
|
wth->file_encap = WTAP_ENCAP_IEEE802_15_4_NOFCS;
|
|
wth->tsprecision = WTAP_FILE_TSPREC_USEC;
|
|
wth->snapshot_length = 0; /* not available in header */
|
|
|
|
return 1; /* it's a Daintree file */
|
|
}
|
|
|
|
/* Read the capture file sequentially
|
|
* Wireshark scans the file with sequential reads during preview and initial display. */
|
|
static gboolean
|
|
daintree_sna_read(wtap *wth, int *err, gchar **err_info, gint64 *data_offset)
|
|
{
|
|
char readLine[DAINTREE_MAX_LINE_SIZE];
|
|
char readData[READDATA_BUF_SIZE];
|
|
|
|
*data_offset = file_tell(wth->fh);
|
|
|
|
/* 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, wth->fh) == NULL) {
|
|
*err = file_error(wth->fh, err_info);
|
|
return FALSE; /* all done */
|
|
}
|
|
} while (readLine[0] == COMMENT_LINE);
|
|
|
|
/* parse one line of capture data */
|
|
if (!daintree_sna_scan_header(&wth->phdr, readLine, readData,
|
|
err, err_info))
|
|
return FALSE;
|
|
|
|
/* process packet data */
|
|
return daintree_sna_process_hex_data(&wth->phdr, wth->frame_buffer,
|
|
readData, err, err_info);
|
|
}
|
|
|
|
/* Read the capture file randomly
|
|
* Wireshark opens the capture file for random access when displaying user-selected packets */
|
|
static gboolean
|
|
daintree_sna_seek_read(wtap *wth, gint64 seek_off, struct wtap_pkthdr *phdr,
|
|
Buffer *buf, int *err, gchar **err_info)
|
|
{
|
|
char readLine[DAINTREE_MAX_LINE_SIZE];
|
|
char readData[READDATA_BUF_SIZE];
|
|
|
|
if(file_seek(wth->random_fh, seek_off, SEEK_SET, err) == -1)
|
|
return FALSE;
|
|
|
|
/* It appears only file header lines start with '#', but
|
|
* if we find any others, we toss them */
|
|
do {
|
|
if (file_gets(readLine, DAINTREE_MAX_LINE_SIZE, wth->random_fh) == NULL) {
|
|
*err = file_error(wth->random_fh, err_info);
|
|
return FALSE; /* all done */
|
|
}
|
|
} while (readLine[0] == COMMENT_LINE);
|
|
|
|
/* parse one line of capture data */
|
|
if (!daintree_sna_scan_header(phdr, readLine, readData, err, err_info))
|
|
return FALSE;
|
|
|
|
/* process packet data */
|
|
return daintree_sna_process_hex_data(phdr, buf, readData, err,
|
|
err_info);
|
|
}
|
|
|
|
/* Scan a header line and fill in a struct wtap_pkthdr */
|
|
static gboolean
|
|
daintree_sna_scan_header(struct wtap_pkthdr *phdr, char *readLine,
|
|
char *readData, int *err, gchar **err_info)
|
|
{
|
|
guint64 seconds;
|
|
int useconds;
|
|
|
|
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) {
|
|
*err = WTAP_ERR_BAD_FILE;
|
|
*err_info = g_strdup("daintree_sna: invalid read record");
|
|
return FALSE;
|
|
}
|
|
|
|
/* Daintree doesn't store the FCS, but pads end of packet with 0xffff, which we toss */
|
|
if (phdr->len <= FCS_LENGTH) {
|
|
*err = WTAP_ERR_BAD_FILE;
|
|
*err_info = g_strdup_printf("daintree_sna: packet length <= %u bytes, no frame data present",
|
|
FCS_LENGTH);
|
|
return FALSE;
|
|
}
|
|
phdr->len -= FCS_LENGTH;
|
|
|
|
phdr->ts.secs = (time_t) seconds;
|
|
phdr->ts.nsecs = useconds * 1000; /* convert mS to nS */
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
/* 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 */
|
|
static gboolean
|
|
daintree_sna_process_hex_data(struct wtap_pkthdr *phdr, Buffer *buf,
|
|
char *readData, int *err, gchar **err_info)
|
|
{
|
|
guchar *str = (guchar *)readData;
|
|
guint bytes;
|
|
guint8 *p;
|
|
|
|
p = str; /* overlay source buffer */
|
|
bytes = 0;
|
|
/* convert hex string to guint8 */
|
|
while(*str) {
|
|
/* most significant nibble */
|
|
if (!isxdigit((guchar)*str)) {
|
|
*err = WTAP_ERR_BAD_FILE;
|
|
*err_info = g_strdup("daintree_sna: non-hex digit in hex data");
|
|
return FALSE;
|
|
}
|
|
if(isdigit((guchar)*str)) {
|
|
*p = (*str - '0') << 4;
|
|
} else {
|
|
*p = ((tolower(*str) - 'a') + 10) << 4;
|
|
}
|
|
str++;
|
|
|
|
/* least significant nibble */
|
|
if (!isxdigit((guchar)*str)) {
|
|
*err = WTAP_ERR_BAD_FILE;
|
|
*err_info = g_strdup("daintree_sna: non-hex digit in hex data");
|
|
return FALSE;
|
|
}
|
|
if(isdigit((guchar)*str)) {
|
|
*p += *str - '0';
|
|
} else {
|
|
*p += (tolower(*str) - 'a') + 10;
|
|
}
|
|
str++;
|
|
|
|
/* next byte in buffer */
|
|
p++;
|
|
bytes++;
|
|
}
|
|
|
|
/* 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);
|
|
return FALSE;
|
|
}
|
|
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);
|
|
return FALSE;
|
|
}
|
|
|
|
phdr->caplen = bytes;
|
|
|
|
buffer_assure_space(buf, bytes);
|
|
memcpy(buffer_start_ptr(buf), readData, bytes);
|
|
return TRUE;
|
|
}
|