forked from osmocom/wireshark
![Guy Harris](/assets/img/avatar_default.png)
by the gunzipping code. Have it also supply a err_info string, and report it. Have file_error() supply an err_info string. Put "the file" - or, for WTAP_ERR_DECOMPRESS, "the compressed file", to suggest a decompression error - into the rawshark and tshark errors, along the lines of what other programs print. Fix a case in the Netscaler code where we weren't fetching the error code on a read failure. svn path=/trunk/; revision=36748
548 lines
14 KiB
C
548 lines
14 KiB
C
/* eyesdn.c
|
|
*
|
|
* $Id$
|
|
*
|
|
* Wiretap Library
|
|
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
|
|
*
|
|
* 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
*/
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
#include "config.h"
|
|
#endif
|
|
#include "wtap-int.h"
|
|
#include "buffer.h"
|
|
#include "eyesdn.h"
|
|
#include "file_wrappers.h"
|
|
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
#include <errno.h>
|
|
|
|
/* This module reads the output of the EyeSDN USB S0/E1 ISDN probes
|
|
* They store HDLC frames of D and B channels in a binary format
|
|
* The fileformat is
|
|
*
|
|
* 1-6 Byte: EyeSDN - Magic
|
|
* 7-n Byte: Frames
|
|
*
|
|
* Each Frame starts with the 0xff Flag byte
|
|
* - Bytes 0-2: timestamp (usec in network byte order)
|
|
* - Bytes 3-7: timestamp (40bits sec since 1970 in network byte order)
|
|
* - Byte 8: channel (0 for D channel, 1-30 for B1-B30)
|
|
* - Byte 9: Sender Bit 0(0 NT, 1 TE), Protocol in Bits 7:1, see enum
|
|
* - Byte 10-11: frame size in bytes
|
|
* - Byte 12-n: Frame Payload
|
|
*
|
|
* All multibyte values are represented in network byte order
|
|
* The frame is terminated with a flag character (0xff)
|
|
* bytes 0xff within a frame are escaped using the 0xfe escape character
|
|
* the byte following the escape character is decremented by two:
|
|
* so 0xfe 0xfd is actually a 0xff
|
|
* Characters that need to be escaped are 0xff and 0xfe
|
|
*/
|
|
|
|
|
|
static int esc_read(guint8 *buf, int len, FILE_T fh)
|
|
{
|
|
int i;
|
|
int value;
|
|
|
|
for(i=0; i<len; i++) {
|
|
value=file_getc(fh);
|
|
if(value==-1)
|
|
return -2; /* EOF or error */
|
|
if(value==0xff)
|
|
return -1; /* error !!, read into next frame */
|
|
if(value==0xfe) {
|
|
/* we need to escape */
|
|
value=file_getc(fh);
|
|
if(value==-1)
|
|
return -2;
|
|
value+=2;
|
|
}
|
|
buf[i]=value;
|
|
}
|
|
|
|
return i;
|
|
}
|
|
|
|
/* Magic text to check for eyesdn-ness of file */
|
|
static const unsigned char eyesdn_hdr_magic[] =
|
|
{ 'E', 'y', 'e', 'S', 'D', 'N'};
|
|
#define EYESDN_HDR_MAGIC_SIZE (sizeof(eyesdn_hdr_magic) / sizeof(eyesdn_hdr_magic[0]))
|
|
|
|
/* Size of a record header */
|
|
#define EYESDN_HDR_LENGTH 12
|
|
|
|
/*
|
|
* XXX - is this the biggest packet we can get?
|
|
*/
|
|
#define EYESDN_MAX_PACKET_LEN 16384
|
|
|
|
static gboolean eyesdn_read(wtap *wth, int *err, gchar **err_info,
|
|
gint64 *data_offset);
|
|
static gboolean eyesdn_seek_read(wtap *wth, gint64 seek_off,
|
|
union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
|
|
int *err, gchar **err_info);
|
|
static gboolean parse_eyesdn_packet_data(FILE_T fh, int pkt_len, guint8* buf,
|
|
int *err, gchar **err_info);
|
|
static int parse_eyesdn_rec_hdr(wtap *wth, FILE_T fh,
|
|
union wtap_pseudo_header *pseudo_header, int *err, gchar **err_info);
|
|
|
|
/* Seeks to the beginning of the next packet, and returns the
|
|
byte offset. Returns -1 on failure, and sets "*err" to the error
|
|
and "*err_info" to null or an additional error string. */
|
|
static gint64 eyesdn_seek_next_packet(wtap *wth, int *err, gchar **err_info)
|
|
{
|
|
int byte;
|
|
gint64 cur_off;
|
|
|
|
while ((byte = file_getc(wth->fh)) != EOF) {
|
|
if (byte == 0xff) {
|
|
cur_off = file_tell(wth->fh);
|
|
if (cur_off == -1) {
|
|
/* Error. */
|
|
*err = file_error(wth->fh, err_info);
|
|
return -1;
|
|
}
|
|
return cur_off;
|
|
}
|
|
}
|
|
if (file_eof(wth->fh)) {
|
|
/* We got an EOF. */
|
|
*err = 0;
|
|
} else {
|
|
/* We got an error. */
|
|
*err = file_error(wth->fh, err_info);
|
|
}
|
|
return -1;
|
|
}
|
|
|
|
int eyesdn_open(wtap *wth, int *err, gchar **err_info)
|
|
{
|
|
int bytes_read;
|
|
char magic[EYESDN_HDR_MAGIC_SIZE];
|
|
|
|
/* Look for eyesdn header */
|
|
errno = WTAP_ERR_CANT_READ;
|
|
bytes_read = file_read(&magic, sizeof magic, wth->fh);
|
|
if (bytes_read != sizeof magic) {
|
|
*err = file_error(wth->fh, err_info);
|
|
if (*err != 0)
|
|
return -1;
|
|
return 0;
|
|
}
|
|
if (memcmp(magic, eyesdn_hdr_magic, EYESDN_HDR_MAGIC_SIZE) != 0)
|
|
return 0;
|
|
|
|
wth->data_offset = 0;
|
|
wth->file_encap = WTAP_ENCAP_PER_PACKET;
|
|
wth->file_type = WTAP_FILE_EYESDN;
|
|
wth->snapshot_length = 0; /* not known */
|
|
wth->subtype_read = eyesdn_read;
|
|
wth->subtype_seek_read = eyesdn_seek_read;
|
|
wth->tsprecision = WTAP_FILE_TSPREC_USEC;
|
|
|
|
return 1;
|
|
}
|
|
|
|
/* Find the next packet and parse it; called from wtap_read(). */
|
|
static gboolean eyesdn_read(wtap *wth, int *err, gchar **err_info,
|
|
gint64 *data_offset)
|
|
{
|
|
gint64 offset;
|
|
guint8 *buf;
|
|
int pkt_len;
|
|
|
|
/* Find the next packet */
|
|
offset = eyesdn_seek_next_packet(wth, err, err_info);
|
|
if (offset < 1)
|
|
return FALSE;
|
|
|
|
/* Parse the header */
|
|
pkt_len = parse_eyesdn_rec_hdr(wth, wth->fh, &wth->pseudo_header, err,
|
|
err_info);
|
|
if (pkt_len == -1)
|
|
return FALSE;
|
|
|
|
/* Make sure we have enough room for the packet */
|
|
buffer_assure_space(wth->frame_buffer, EYESDN_MAX_PACKET_LEN);
|
|
buf = buffer_start_ptr(wth->frame_buffer);
|
|
|
|
/* Read the packet data */
|
|
if (!parse_eyesdn_packet_data(wth->fh, pkt_len, buf, err, err_info))
|
|
return FALSE;
|
|
|
|
wth->data_offset = offset;
|
|
*data_offset = offset;
|
|
return TRUE;
|
|
}
|
|
|
|
/* Used to read packets in random-access fashion */
|
|
static gboolean
|
|
eyesdn_seek_read (wtap *wth, gint64 seek_off,
|
|
union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
|
|
int *err, gchar **err_info)
|
|
{
|
|
int pkt_len;
|
|
|
|
if (file_seek(wth->random_fh, seek_off, SEEK_SET, err) == -1)
|
|
return FALSE;
|
|
|
|
pkt_len = parse_eyesdn_rec_hdr(NULL, wth->random_fh, pseudo_header,
|
|
err, err_info);
|
|
|
|
if (pkt_len != len) {
|
|
if (pkt_len != -1) {
|
|
*err = WTAP_ERR_BAD_RECORD;
|
|
*err_info = g_strdup_printf("eyesdn: requested length %d doesn't match length %d",
|
|
len, pkt_len);
|
|
}
|
|
return FALSE;
|
|
}
|
|
|
|
return parse_eyesdn_packet_data(wth->random_fh, pkt_len, pd, err,
|
|
err_info);
|
|
}
|
|
|
|
/* Parses a packet record header. */
|
|
static int
|
|
parse_eyesdn_rec_hdr(wtap *wth, FILE_T fh,
|
|
union wtap_pseudo_header *pseudo_header, int *err, gchar **err_info)
|
|
{
|
|
guint8 hdr[EYESDN_HDR_LENGTH];
|
|
time_t secs;
|
|
int usecs;
|
|
int pkt_len;
|
|
guint8 channel, direction;
|
|
|
|
/* Our file pointer should be at the summary information header
|
|
* for a packet. Read in that header and extract the useful
|
|
* information.
|
|
*/
|
|
if (esc_read(hdr, EYESDN_HDR_LENGTH, fh) != EYESDN_HDR_LENGTH) {
|
|
*err = file_error(fh, err_info);
|
|
if (*err == 0)
|
|
*err = WTAP_ERR_SHORT_READ;
|
|
return -1;
|
|
}
|
|
|
|
/* extract information from header */
|
|
usecs = pntoh24(&hdr[0]);
|
|
#ifdef TV64BITS
|
|
secs = hdr[3];
|
|
#else
|
|
secs = 0;
|
|
#endif
|
|
secs = (secs << 8) | hdr[4];
|
|
secs = (secs << 8) | hdr[5];
|
|
secs = (secs << 8) | hdr[6];
|
|
secs = (secs << 8) | hdr[7];
|
|
|
|
channel = hdr[8];
|
|
direction = hdr[9];
|
|
pkt_len = pntohs(&hdr[10]);
|
|
|
|
switch(direction >> 1) {
|
|
|
|
default:
|
|
case EYESDN_ENCAP_ISDN: /* ISDN */
|
|
pseudo_header->isdn.uton = direction & 1;
|
|
pseudo_header->isdn.channel = channel;
|
|
if(channel) { /* bearer channels */
|
|
if(wth) {
|
|
wth->phdr.pkt_encap = WTAP_ENCAP_ISDN; /* recognises PPP */
|
|
pseudo_header->isdn.uton=!pseudo_header->isdn.uton; /* bug */
|
|
}
|
|
} else { /* D channel */
|
|
if(wth) {
|
|
wth->phdr.pkt_encap = WTAP_ENCAP_ISDN;
|
|
}
|
|
}
|
|
break;
|
|
|
|
case EYESDN_ENCAP_MSG: /* Layer 1 message */
|
|
if(wth) {
|
|
wth->phdr.pkt_encap = WTAP_ENCAP_LAYER1_EVENT;
|
|
}
|
|
pseudo_header->l1event.uton = (direction & 1);
|
|
break;
|
|
|
|
case EYESDN_ENCAP_LAPB: /* X.25 via LAPB */
|
|
if(wth) {
|
|
wth->phdr.pkt_encap = WTAP_ENCAP_LAPB;
|
|
}
|
|
pseudo_header->x25.flags = (direction & 1) ? 0 : 0x80;
|
|
break;
|
|
|
|
case EYESDN_ENCAP_ATM: { /* ATM cells */
|
|
#define CELL_LEN 53
|
|
unsigned char cell[CELL_LEN];
|
|
gint64 cur_off;
|
|
|
|
if(pkt_len != CELL_LEN) {
|
|
*err = WTAP_ERR_BAD_RECORD;
|
|
*err_info = g_strdup_printf(
|
|
"eyesdn: ATM cell has a length != 53 (%u)",
|
|
pkt_len);
|
|
return -1;
|
|
}
|
|
|
|
cur_off = file_tell(fh);
|
|
if (esc_read(cell, CELL_LEN, fh) != CELL_LEN) {
|
|
*err = file_error(fh, err_info);
|
|
if (*err == 0)
|
|
*err = WTAP_ERR_SHORT_READ;
|
|
return -1;
|
|
}
|
|
if (file_seek(fh, cur_off, SEEK_SET, err) == -1)
|
|
return -1;
|
|
if(wth) {
|
|
wth->phdr.pkt_encap = WTAP_ENCAP_ATM_PDUS_UNTRUNCATED;
|
|
}
|
|
pseudo_header->atm.flags=ATM_RAW_CELL;
|
|
pseudo_header->atm.aal=AAL_UNKNOWN;
|
|
pseudo_header->atm.type=TRAF_UMTS_FP;
|
|
pseudo_header->atm.subtype=TRAF_ST_UNKNOWN;
|
|
pseudo_header->atm.vpi=((cell[0]&0xf)<<4) + (cell[0]&0xf);
|
|
pseudo_header->atm.vci=((cell[0]&0xf)<<4) + cell[0]; /* from cell */
|
|
pseudo_header->atm.channel=direction & 1;
|
|
}
|
|
break;
|
|
|
|
case EYESDN_ENCAP_MTP2: /* SS7 frames */
|
|
pseudo_header->mtp2.sent = direction & 1;
|
|
pseudo_header->mtp2.annex_a_used = MTP2_ANNEX_A_USED_UNKNOWN;
|
|
pseudo_header->mtp2.link_number = channel;
|
|
if(wth) {
|
|
wth->phdr.pkt_encap = WTAP_ENCAP_MTP2;
|
|
}
|
|
break;
|
|
|
|
case EYESDN_ENCAP_DPNSS: /* DPNSS */
|
|
pseudo_header->isdn.uton = direction & 1;
|
|
pseudo_header->isdn.channel = channel;
|
|
if(wth) {
|
|
wth->phdr.pkt_encap = WTAP_ENCAP_DPNSS;
|
|
}
|
|
break;
|
|
|
|
case EYESDN_ENCAP_DASS2: /* DASS2 frames */
|
|
pseudo_header->isdn.uton = direction & 1;
|
|
pseudo_header->isdn.channel = channel;
|
|
if(wth) {
|
|
wth->phdr.pkt_encap = WTAP_ENCAP_DPNSS;
|
|
}
|
|
break;
|
|
|
|
case EYESDN_ENCAP_BACNET: /* BACNET async over HDLC frames */
|
|
/* pseudo_header->isdn.uton = direction & 1; */
|
|
/* pseudo_header->isdn.channel = channel; */
|
|
if(wth) {
|
|
wth->phdr.pkt_encap = WTAP_ENCAP_BACNET_MS_TP;
|
|
}
|
|
break;
|
|
}
|
|
|
|
if(pkt_len > EYESDN_MAX_PACKET_LEN) {
|
|
*err = WTAP_ERR_BAD_RECORD;
|
|
*err_info = g_strdup_printf("eyesdn: File has %u-byte packet, bigger than maximum of %u",
|
|
pkt_len, EYESDN_MAX_PACKET_LEN);
|
|
return -1;
|
|
}
|
|
|
|
if (wth) {
|
|
wth->phdr.ts.secs = secs;
|
|
wth->phdr.ts.nsecs = usecs * 1000;
|
|
wth->phdr.caplen = pkt_len;
|
|
wth->phdr.len = pkt_len;
|
|
}
|
|
|
|
return pkt_len;
|
|
}
|
|
|
|
/* read a packet */
|
|
static gboolean
|
|
parse_eyesdn_packet_data(FILE_T fh, int pkt_len, guint8* buf, int *err,
|
|
gchar **err_info)
|
|
{
|
|
int bytes_read;
|
|
|
|
errno = WTAP_ERR_CANT_READ;
|
|
bytes_read = esc_read(buf, pkt_len, fh);
|
|
if (bytes_read != pkt_len) {
|
|
if (bytes_read == -2) {
|
|
*err = file_error(fh, err_info);
|
|
if (*err == 0)
|
|
*err = WTAP_ERR_SHORT_READ;
|
|
} else if (bytes_read == -1) {
|
|
*err = WTAP_ERR_BAD_RECORD;
|
|
*err_info = g_strdup("eyesdn: No flag character seen in frame");
|
|
} else
|
|
*err = WTAP_ERR_SHORT_READ;
|
|
return FALSE;
|
|
}
|
|
return TRUE;
|
|
}
|
|
|
|
|
|
static gboolean
|
|
esc_write(wtap_dumper *wdh, const guint8 *buf, int len, int *err)
|
|
{
|
|
int i;
|
|
guint8 byte;
|
|
static const guint8 esc = 0xfe;
|
|
|
|
for(i=0; i<len; i++) {
|
|
byte=buf[i];
|
|
if(byte == 0xff || byte == 0xfe) {
|
|
/*
|
|
* Escape the frame delimiter and escape byte.
|
|
*/
|
|
if (!wtap_dump_file_write(wdh, &esc, sizeof esc, err))
|
|
return FALSE;
|
|
byte-=2;
|
|
}
|
|
if (!wtap_dump_file_write(wdh, &byte, sizeof byte, err))
|
|
return FALSE;
|
|
}
|
|
return TRUE;
|
|
}
|
|
|
|
static gboolean eyesdn_dump(wtap_dumper *wdh,
|
|
const struct wtap_pkthdr *phdr,
|
|
const union wtap_pseudo_header *pseudo_header _U_,
|
|
const guchar *pd, int *err);
|
|
|
|
gboolean eyesdn_dump_open(wtap_dumper *wdh, int *err)
|
|
{
|
|
wdh->subtype_write=eyesdn_dump;
|
|
wdh->subtype_close=NULL;
|
|
|
|
if (!wtap_dump_file_write(wdh, eyesdn_hdr_magic,
|
|
EYESDN_HDR_MAGIC_SIZE, err))
|
|
return FALSE;
|
|
wdh->bytes_dumped += EYESDN_HDR_MAGIC_SIZE;
|
|
*err=0;
|
|
return TRUE;
|
|
}
|
|
|
|
int eyesdn_dump_can_write_encap(int encap)
|
|
{
|
|
switch (encap) {
|
|
case WTAP_ENCAP_ISDN:
|
|
case WTAP_ENCAP_LAYER1_EVENT:
|
|
case WTAP_ENCAP_DPNSS:
|
|
case WTAP_ENCAP_ATM_PDUS_UNTRUNCATED:
|
|
case WTAP_ENCAP_LAPB:
|
|
case WTAP_ENCAP_MTP2:
|
|
case WTAP_ENCAP_BACNET_MS_TP:
|
|
case WTAP_ENCAP_PER_PACKET:
|
|
return 0;
|
|
|
|
default:
|
|
return WTAP_ERR_UNSUPPORTED_ENCAP;
|
|
}
|
|
}
|
|
|
|
/* Write a record for a packet to a dump file.
|
|
* Returns TRUE on success, FALSE on failure. */
|
|
static gboolean eyesdn_dump(wtap_dumper *wdh,
|
|
const struct wtap_pkthdr *phdr,
|
|
const union wtap_pseudo_header *pseudo_header _U_,
|
|
const guchar *pd, int *err)
|
|
{
|
|
static const guint8 start_flag = 0xff;
|
|
guint8 buf[EYESDN_HDR_LENGTH];
|
|
int usecs;
|
|
time_t secs;
|
|
int channel;
|
|
int origin;
|
|
int protocol;
|
|
int size;
|
|
|
|
usecs=phdr->ts.nsecs/1000;
|
|
secs=phdr->ts.secs;
|
|
size=phdr->caplen;
|
|
origin = pseudo_header->isdn.uton;
|
|
channel = pseudo_header->isdn.channel;
|
|
|
|
switch(phdr->pkt_encap) {
|
|
|
|
case WTAP_ENCAP_ISDN:
|
|
protocol=EYESDN_ENCAP_ISDN; /* set depending on decoder format and mode */
|
|
break;
|
|
|
|
case WTAP_ENCAP_LAYER1_EVENT:
|
|
protocol=EYESDN_ENCAP_MSG;
|
|
break;
|
|
|
|
case WTAP_ENCAP_DPNSS:
|
|
protocol=EYESDN_ENCAP_DPNSS;
|
|
break;
|
|
|
|
#if 0
|
|
case WTAP_ENCAP_DASS2:
|
|
protocol=EYESDN_ENCAP_DASS2;
|
|
break;
|
|
#endif
|
|
|
|
case WTAP_ENCAP_ATM_PDUS_UNTRUNCATED:
|
|
protocol=EYESDN_ENCAP_ATM;
|
|
channel=0x80;
|
|
break;
|
|
|
|
case WTAP_ENCAP_LAPB:
|
|
protocol=EYESDN_ENCAP_LAPB;
|
|
break;
|
|
|
|
case WTAP_ENCAP_MTP2:
|
|
protocol=EYESDN_ENCAP_MTP2;
|
|
break;
|
|
|
|
case WTAP_ENCAP_BACNET_MS_TP:
|
|
protocol=EYESDN_ENCAP_BACNET;
|
|
break;
|
|
|
|
default:
|
|
*err=WTAP_ERR_UNSUPPORTED_ENCAP;
|
|
return FALSE;
|
|
}
|
|
|
|
phton24(&buf[0], usecs);
|
|
|
|
buf[3] = (guint8)0;
|
|
buf[4] = (guint8)(0xff & (secs >> 24));
|
|
buf[5] = (guint8)(0xff & (secs >> 16));
|
|
buf[6] = (guint8)(0xff & (secs >> 8));
|
|
buf[7] = (guint8)(0xff & (secs >> 0));
|
|
|
|
buf[8] = (guint8) channel;
|
|
buf[9] = (guint8) (origin?1:0) + (protocol << 1);
|
|
phtons(&buf[10], size);
|
|
|
|
/* start flag */
|
|
if (!wtap_dump_file_write(wdh, &start_flag, sizeof start_flag, err))
|
|
return FALSE;
|
|
if (!esc_write(wdh, buf, 12, err))
|
|
return FALSE;
|
|
if (!esc_write(wdh, pd, size, err))
|
|
return FALSE;
|
|
return TRUE;
|
|
}
|