wiretap/pppdump.c

   1 /* pppdump.c
   2  *
   3  * $Id$
   4  *
   5  * Copyright (c) 2000 by Gilbert Ramirez <gram@alumni.rice.edu>
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #include "config.h"
  23 #include "wtap-int.h"
  24 #include "buffer.h"
  25 #include "pppdump.h"
  26 #include "file_wrappers.h"
  27
  28 #include <glib.h>
  29 #include <stdio.h>
  30 #include <stdlib.h>
  31 #include <errno.h>
  32 #include <string.h>
  33
  34 /*
  35 pppdump records
  36 Daniel Thompson (STMicroelectronics) <daniel.thompson@st.com>
  37
  38 +------+
  39 | 0x07 |                              Reset time
  40 +------+------+------+------+
  41 |  t3  |  t2  |  t1  |  t0  |         t = time_t
  42 +------+------+------+------+
  43
  44 +------+
  45 | 0x06 |                              Time step (short)
  46 +------+
  47 |  ts  |                              ts = time step (tenths of seconds)
  48 +------+
  49
  50 +------+
  51 | 0x05 |                              Time step (long)
  52 +------+------+------+------+
  53 | ts3  | ts2  | ts1  | ts0  |         ts = time step (tenths of seconds)
  54 +------+------+------+------+
  55
  56 +------+
  57 | 0x04 |                              Receive deliminator (not seen in practice)
  58 +------+
  59
  60 +------+
  61 | 0x03 |                              Send deliminator (not seen in practice)
  62 +------+
  63
  64 +------+
  65 | 0x02 |                              Received data
  66 +------+------+
  67 |  n1  |  n0  |                       n = number of bytes following
  68 +------+------+
  69 |    data     |
  70 |             |
  71
  72 +------+
  73 | 0x01 |                              Sent data
  74 +------+------+
  75 |  n1  |  n0  |                       n = number of bytes following
  76 +------+------+
  77 |    data     |
  78 |             |
  79 */
  80
  81 #define PPPD_SENT_DATA          0x01
  82 #define PPPD_RECV_DATA          0x02
  83 #define PPPD_SEND_DELIM         0x03
  84 #define PPPD_RECV_DELIM         0x04
  85 #define PPPD_TIME_STEP_LONG     0x05
  86 #define PPPD_TIME_STEP_SHORT    0x06
  87 #define PPPD_RESET_TIME         0x07
  88
  89 /* this buffer must be at least (2*PPPD_MTU) + sizeof(ppp_header) +
  90  * sizeof(lcp_header) + sizeof(ipcp_header).  PPPD_MTU is *very* rarely
  91  * larger than 1500 so this value is fine.
  92  */
  93 #define PPPD_BUF_SIZE           8192
  94
  95 typedef enum {
  96         DIRECTION_SENT,
  97         DIRECTION_RECV
  98 } direction_enum;
  99
 100 static gboolean pppdump_read(wtap *wth, int *err, gchar **err_info,
 101         gint64 *data_offset);
 102 static gboolean pppdump_seek_read(wtap *wth, gint64 seek_off,
 103         struct wtap_pkthdr *phdr, guint8 *pd, int len,
 104         int *err, gchar **err_info);
 105
 106 /*
 107  * Information saved about a packet, during the initial sequential pass
 108  * through the file, to allow us to later re-read it when randomly
 109  * reading packets.
 110  *
 111  * "offset" is the offset in the file of the first data chunk containing data
 112  * from that packet; note that it may also contain data from previous
 113  * packets.
 114  *
 115  * "num_bytes_to_skip" is the number of bytes from previous packets in that
 116  * first data chunk.
 117  *
 118  * "dir" is the direction of the packet.
 119  */
 120 typedef struct {
 121         gint64          offset;
 122         gint64          num_bytes_to_skip;
 123         direction_enum  dir;
 124 } pkt_id;
 125
 126 /*
 127  * Information about a packet currently being processed.  There is one of
 128  * these for the sent packet being processed and one of these for the
 129  * received packet being processed, as we could be in the middle of
 130  * processing both a received packet and a sent packet.
 131  *
 132  * "dir" is the direction of the packet.
 133  *
 134  * "cnt" is the number of bytes of packet data we've accumulated.
 135  *
 136  * "esc" is TRUE if the next byte we see is escaped (and thus must be XORed
 137  * with 0x20 before saving it), FALSE otherwise.
 138  *
 139  * "buf" is a buffer containing the packet data we've accumulated.
 140  *
 141  * "id_offset" is the offset in the file of the first data chunk
 142  * containing data from the packet we're processing.
 143  *
 144  * "sd_offset" is the offset in the file of the first data byte from
 145  * the packet we're processing - which isn't necessarily right after
 146  * the header of the first data chunk, as we may already have assembled
 147  * packets from that chunk.
 148  *
 149  * "cd_offset" is the offset in the file of the current data chunk we're
 150  * processing.
 151  */
 152 typedef struct {
 153         direction_enum  dir;
 154         int             cnt;
 155         gboolean        esc;
 156         guint8          buf[PPPD_BUF_SIZE];
 157         gint64          id_offset;
 158         gint64          sd_offset;
 159         gint64          cd_offset;
 160 } pkt_t;
 161
 162 /*
 163  * This keeps state used while processing records.
 164  *
 165  * "timestamp" is the seconds portion of the current time stamp value,
 166  * as updated from PPPD_RESET_TIME, PPPD_TIME_STEP_LONG, and
 167  * PPPD_TIME_STEP_SHORT records.  "tenths" is the tenths-of-seconds
 168  * portion.
 169  *
 170  * "spkt" and "rpkt" are "pkt_t" structures for the sent and received
 171  * packets we're currently working on.
 172  *
 173  * "offset" is the current offset in the file.
 174  *
 175  * "num_bytes" and "pkt" are information saved when we finish accumulating
 176  * the data for a packet, if the data chunk we're working on still has more
 177  * data in it:
 178  *
 179  *      "num_bytes" is the number of bytes of additional data remaining
 180  *      in the chunk after we've finished accumulating the data for the
 181  *      packet.
 182  *
 183  *      "pkt" is the "pkt_t" for the type of packet the data chunk is for
 184  *      (sent or received packet).
 185  *
 186  * "seek_state" is another state structure used while processing records
 187  * when doing a seek-and-read.  (That structure doesn't itself have a
 188  * "seek_state" structure.)
 189  *
 190  * "pids" is a GPtrArray of pointers to "pkt_id" structures for all the
 191  * packets we've seen during the initial sequential pass, to allow us to
 192  * later retrieve them with random accesses.
 193  *
 194  * "pkt_cnt" is the number of packets we've seen up to this point in the
 195  * sequential pass.
 196  */
 197 typedef struct _pppdump_t {
 198         time_t                  timestamp;
 199         guint                   tenths;
 200         pkt_t                   spkt;
 201         pkt_t                   rpkt;
 202         gint64                  offset;
 203         int                     num_bytes;
 204         pkt_t                   *pkt;
 205         struct _pppdump_t       *seek_state;
 206         GPtrArray               *pids;
 207         guint                   pkt_cnt;
 208 } pppdump_t;
 209
 210 static int
 211 process_data(pppdump_t *state, FILE_T fh, pkt_t *pkt, int n, guint8 *pd,
 212     int *err, gchar **err_info, pkt_id *pid);
 213
 214 static gboolean
 215 collate(pppdump_t*, FILE_T fh, int *err, gchar **err_info, guint8 *pd,
 216                 int *num_bytes, direction_enum *direction, pkt_id *pid,
 217                 gint64 num_bytes_to_skip);
 218
 219 static void
 220 pppdump_close(wtap *wth);
 221
 222 static void
 223 init_state(pppdump_t *state)
 224 {
 225
 226         state->num_bytes = 0;
 227         state->pkt = NULL;
 228
 229         state->spkt.dir = DIRECTION_SENT;
 230         state->spkt.cnt = 0;
 231         state->spkt.esc = FALSE;
 232         state->spkt.id_offset = 0;
 233         state->spkt.sd_offset = 0;
 234         state->spkt.cd_offset = 0;
 235
 236         state->rpkt.dir = DIRECTION_RECV;
 237         state->rpkt.cnt = 0;
 238         state->rpkt.esc = FALSE;
 239         state->rpkt.id_offset = 0;
 240         state->rpkt.sd_offset = 0;
 241         state->rpkt.cd_offset = 0;
 242
 243         state->seek_state = NULL;
 244         state->offset = 0x100000; /* to detect errors during development */
 245 }
 246
 247
 248 int
 249 pppdump_open(wtap *wth, int *err, gchar **err_info)
 250 {
 251         guint8          buffer[6];      /* Looking for: 0x07 t3 t2 t1 t0 ID */
 252         int             bytes_read;
 253         pppdump_t       *state;
 254
 255         /* There is no file header, only packet records. Fortunately for us,
 256         * timestamp records are separated from packet records, so we should
 257         * find an "initial time stamp" (i.e., a "reset time" record, or
 258         * record type 0x07) at the beginning of the file. We'll check for
 259         * that, plus a valid record following the 0x07 and the four bytes
 260         * representing the timestamp.
 261         */
 262
 263         bytes_read = file_read(buffer, sizeof(buffer), wth->fh);
 264         if (bytes_read != (int) sizeof(buffer)) {
 265                 *err = file_error(wth->fh, err_info);
 266                 if (*err != 0 && *err != WTAP_ERR_SHORT_READ)
 267                         return -1;
 268                 return 0;
 269         }
 270
 271         if (buffer[0] == PPPD_RESET_TIME &&
 272                         (buffer[5] == PPPD_SENT_DATA ||
 273                          buffer[5] == PPPD_RECV_DATA ||
 274                          buffer[5] == PPPD_TIME_STEP_LONG ||
 275                          buffer[5] == PPPD_TIME_STEP_SHORT ||
 276                          buffer[5] == PPPD_RESET_TIME)) {
 277
 278                 goto my_file_type;
 279         }
 280         else {
 281                 return 0;
 282         }
 283
 284   my_file_type:
 285
 286         if (file_seek(wth->fh, 5, SEEK_SET, err) == -1)
 287                 return -1;
 288
 289         state = (pppdump_t *)g_malloc(sizeof(pppdump_t));
 290         wth->priv = (void *)state;
 291         state->timestamp = pntohl(&buffer[1]);
 292         state->tenths = 0;
 293
 294         init_state(state);
 295
 296         state->offset = 5;
 297         wth->file_encap = WTAP_ENCAP_PPP_WITH_PHDR;
 298         wth->file_type = WTAP_FILE_PPPDUMP;
 299
 300         wth->snapshot_length = PPPD_BUF_SIZE; /* just guessing */
 301         wth->subtype_read = pppdump_read;
 302         wth->subtype_seek_read = pppdump_seek_read;
 303         wth->subtype_close = pppdump_close;
 304         wth->tsprecision = WTAP_FILE_TSPREC_DSEC;
 305
 306         state->seek_state = g_new(pppdump_t,1);
 307
 308         /* If we have a random stream open, we're going to be reading
 309            the file randomly; set up a GPtrArray of pointers to
 310            information about how to retrieve the data for each packet. */
 311         if (wth->random_fh != NULL)
 312                 state->pids = g_ptr_array_new();
 313         else
 314                 state->pids = NULL;
 315         state->pkt_cnt = 0;
 316
 317         return 1;
 318 }
 319
 320 /* Find the next packet and parse it; called from wtap_read(). */
 321 static gboolean
 322 pppdump_read(wtap *wth, int *err, gchar **err_info, gint64 *data_offset)
 323 {
 324         int             num_bytes;
 325         direction_enum  direction;
 326         guint8          *buf;
 327         pppdump_t       *state;
 328         pkt_id          *pid;
 329
 330         buffer_assure_space(wth->frame_buffer, PPPD_BUF_SIZE);
 331         buf = buffer_start_ptr(wth->frame_buffer);
 332
 333         state = (pppdump_t *)wth->priv;
 334
 335         /* If we have a random stream open, allocate a structure to hold
 336            the information needed to read this packet's data again. */
 337         if (wth->random_fh != NULL) {
 338                 pid = g_new(pkt_id, 1);
 339                 if (!pid) {
 340                         *err = errno;   /* assume a malloc failed and set "errno" */
 341                         return FALSE;
 342                 }
 343                 pid->offset = 0;
 344         } else
 345                 pid = NULL;     /* sequential only */
 346
 347         if (!collate(state, wth->fh, err, err_info, buf, &num_bytes, &direction,
 348             pid, 0)) {
 349                 if (pid != NULL)
 350                         g_free(pid);
 351                 return FALSE;
 352         }
 353
 354         if (pid != NULL)
 355                 pid->dir = direction;
 356
 357         if (pid != NULL)
 358                 g_ptr_array_add(state->pids, pid);
 359         /* The user's data_offset is not really an offset, but a packet number. */
 360         *data_offset = state->pkt_cnt;
 361         state->pkt_cnt++;
 362
 363         wth->phdr.presence_flags = WTAP_HAS_TS;
 364         wth->phdr.len           = num_bytes;
 365         wth->phdr.caplen        = num_bytes;
 366         wth->phdr.ts.secs       = state->timestamp;
 367         wth->phdr.ts.nsecs      = state->tenths * 100000000;
 368         wth->phdr.pkt_encap     = WTAP_ENCAP_PPP_WITH_PHDR;
 369
 370         wth->phdr.pseudo_header.p2p.sent = (direction == DIRECTION_SENT ? TRUE : FALSE);
 371
 372         return TRUE;
 373 }
 374
 375 /* Returns number of bytes copied for record, -1 if failure.
 376  *
 377  * This is modeled after pppdump.c, the utility to parse pppd log files; it
 378  * comes with the ppp distribution.
 379  */
 380 static int
 381 process_data(pppdump_t *state, FILE_T fh, pkt_t *pkt, int n, guint8 *pd,
 382     int *err, gchar **err_info, pkt_id *pid)
 383 {
 384         int     c;
 385         int     num_bytes = n;
 386         int     num_written;
 387
 388         for (; num_bytes > 0; --num_bytes) {
 389                 c = file_getc(fh);
 390                 if (c == EOF) {
 391                         *err = file_error(fh, err_info);
 392                         if (*err == 0) {
 393                                 *err = WTAP_ERR_SHORT_READ;
 394                         }
 395                         return -1;
 396                 }
 397                 state->offset++;
 398                 switch (c) {
 399                         case 0x7e:
 400                                 /*
 401                                  * Flag Sequence for RFC 1662 HDLC-like
 402                                  * framing.
 403                                  *
 404                                  * As this is a raw trace of octets going
 405                                  * over the wire, and that might include
 406                                  * the login sequence, there is no
 407                                  * guarantee that *only* PPP traffic
 408                                  * appears in this file, so there is no
 409                                  * guarantee that the first 0x7e we see is
 410                                  * a start flag sequence, and therefore we
 411                                  * cannot safely ignore all characters up
 412                                  * to the first 0x7e, and therefore we
 413                                  * might end up with some bogus PPP
 414                                  * packets.
 415                                  */
 416                                 if (pkt->cnt > 0) {
 417                                         /*
 418                                          * We've seen stuff before this,
 419                                          * so this is the end of a frame.
 420                                          * Make a frame out of that stuff.
 421                                          */
 422                                         pkt->esc = FALSE;
 423
 424                                         num_written = pkt->cnt;
 425                                         pkt->cnt = 0;
 426                                         if (num_written <= 0) {
 427                                                 return 0;
 428                                         }
 429
 430                                         if (num_written > PPPD_BUF_SIZE) {
 431                                                 *err = WTAP_ERR_UNC_OVERFLOW;
 432                                                 return -1;
 433                                         }
 434
 435                                         memcpy(pd, pkt->buf, num_written);
 436
 437                                         /*
 438                                          * Remember the offset of the
 439                                          * first record containing data
 440                                          * for this packet, and how far
 441                                          * into that record to skip to
 442                                          * get to the beginning of the
 443                                          * data for this packet; the number
 444                                          * of bytes to skip into that record
 445                                          * is the file offset of the first
 446                                          * byte of this packet minus the
 447                                          * file offset of the first byte of
 448                                          * this record, minus 3 bytes for the
 449                                          * header of this record (which, if
 450                                          * we re-read this record, we will
 451                                          * process, not skip).
 452                                          */
 453                                         if (pid) {
 454                                                 pid->offset = pkt->id_offset;
 455                                                 pid->num_bytes_to_skip =
 456                                                     pkt->sd_offset - pkt->id_offset - 3;
 457                                                 g_assert(pid->num_bytes_to_skip >= 0);
 458                                         }
 459
 460                                         num_bytes--;
 461                                         if (num_bytes > 0) {
 462                                                 /*
 463                                                  * There's more data in this
 464                                                  * record.
 465                                                  * Set the initial data offset
 466                                                  * for the next packet.
 467                                                  */
 468                                                 pkt->id_offset = pkt->cd_offset;
 469                                                 pkt->sd_offset = state->offset;
 470                                         } else {
 471                                                 /*
 472                                                  * There is no more data in
 473                                                  * this record.
 474                                                  * Thus, we don't have the
 475                                                  * initial data offset for
 476                                                  * the next packet.
 477                                                  */
 478                                                 pkt->id_offset = 0;
 479                                                 pkt->sd_offset = 0;
 480                                         }
 481                                         state->num_bytes = num_bytes;
 482                                         state->pkt = pkt;
 483                                         return num_written;
 484                                 }
 485                                 break;
 486
 487                         case 0x7d:
 488                                 /*
 489                                  * Control Escape octet for octet-stuffed
 490                                  * RFC 1662 HDLC-like framing.
 491                                  */
 492                                 if (!pkt->esc) {
 493                                         /*
 494                                          * Control Escape not preceded by
 495                                          * Control Escape; discard it
 496                                          * but XOR the next octet with
 497                                          * 0x20.
 498                                          */
 499                                         pkt->esc = TRUE;
 500                                         break;
 501                                 }
 502                                 /*
 503                                  * Control Escape preceded by Control Escape;
 504                                  * treat it as an ordinary character,
 505                                  * by falling through.
 506                                  */
 507
 508                         default:
 509                                 if (pkt->esc) {
 510                                         /*
 511                                          * This character was preceded by
 512                                          * Control Escape, so XOR it with
 513                                          * 0x20, as per RFC 1662's octet-
 514                                          * stuffed framing, and clear
 515                                          * the flag saying that the
 516                                          * character should be escaped.
 517                                          */
 518                                         c ^= 0x20;
 519                                         pkt->esc = FALSE;
 520                                 }
 521
 522                                 if (pkt->cnt >= PPPD_BUF_SIZE) {
 523                                         *err = WTAP_ERR_UNC_OVERFLOW;
 524                                         return -1;
 525                                 }
 526                                 pkt->buf[pkt->cnt++] = c;
 527                                 break;
 528                 }
 529         }
 530
 531         /* we could have run out of bytes to read */
 532         return 0;
 533 }
 534
 535 /* Returns TRUE if packet data copied, FALSE if error occurred or EOF (no more records). */
 536 static gboolean
 537 collate(pppdump_t* state, FILE_T fh, int *err, gchar **err_info, guint8 *pd,
 538                 int *num_bytes, direction_enum *direction, pkt_id *pid,
 539                 gint64 num_bytes_to_skip)
 540 {
 541         int             id;
 542         pkt_t           *pkt = NULL;
 543         int             byte0, byte1;
 544         int             n, num_written = 0;
 545         gint64          start_offset;
 546         guint32         time_long;
 547         guint8          time_short;
 548
 549         /*
 550          * Process any data left over in the current record when doing
 551          * sequential processing.
 552          */
 553         if (state->num_bytes > 0) {
 554                 g_assert(num_bytes_to_skip == 0);
 555                 pkt = state->pkt;
 556                 num_written = process_data(state, fh, pkt, state->num_bytes,
 557                     pd, err, err_info, pid);
 558
 559                 if (num_written < 0) {
 560                         return FALSE;
 561                 }
 562                 else if (num_written > 0) {
 563                         *num_bytes = num_written;
 564                         *direction = pkt->dir;
 565                         return TRUE;
 566                 }
 567                 /* if 0 bytes written, keep processing */
 568         } else {
 569                 /*
 570                  * We didn't have any data left over, so the packet will
 571                  * start at the beginning of a record.
 572                  */
 573                 if (pid)
 574                         pid->num_bytes_to_skip = 0;
 575         }
 576
 577         /*
 578          * That didn't get all the data for this packet, so process
 579          * subsequent records.
 580          */
 581         start_offset = state->offset;
 582         while ((id = file_getc(fh)) != EOF) {
 583                 state->offset++;
 584                 switch (id) {
 585                         case PPPD_SENT_DATA:
 586                         case PPPD_RECV_DATA:
 587                                 pkt = id == PPPD_SENT_DATA ? &state->spkt : &state->rpkt;
 588
 589                                 /*
 590                                  * Save the offset of the beginning of
 591                                  * the current record.
 592                                  */
 593                                 pkt->cd_offset = state->offset - 1;
 594
 595                                 /*
 596                                  * Get the length of the record.
 597                                  */
 598                                 byte0 = file_getc(fh);
 599                                 if (byte0 == EOF)
 600                                         goto done;
 601                                 state->offset++;
 602                                 byte1 = file_getc(fh);
 603                                 if (byte1 == EOF)
 604                                         goto done;
 605                                 state->offset++;
 606                                 n = (byte0 << 8) | byte1;
 607
 608                                 if (pkt->id_offset == 0) {
 609                                         /*
 610                                          * We don't have the initial data
 611                                          * offset for this packet, which
 612                                          * means this is the first
 613                                          * data record for that packet.
 614                                          * Save the offset of the
 615                                          * beginning of that record and
 616                                          * the offset of the first data
 617                                          * byte in the packet, which is
 618                                          * the first data byte in the
 619                                          * record.
 620                                          */
 621                                         pkt->id_offset = pkt->cd_offset;
 622                                         pkt->sd_offset = state->offset;
 623                                 }
 624
 625                                 if (n == 0)
 626                                         continue;
 627
 628                                 g_assert(num_bytes_to_skip < n);
 629                                 while (num_bytes_to_skip) {
 630                                         if (file_getc(fh) == EOF)
 631                                                 goto done;
 632                                         state->offset++;
 633                                         num_bytes_to_skip--;
 634                                         n--;
 635                                 }
 636                                 num_written = process_data(state, fh, pkt, n,
 637                                     pd, err, err_info, pid);
 638
 639                                 if (num_written < 0) {
 640                                         return FALSE;
 641                                 }
 642                                 else if (num_written > 0) {
 643                                         *num_bytes = num_written;
 644                                         *direction = pkt->dir;
 645                                         return TRUE;
 646                                 }
 647                                 /* if 0 bytes written, keep looping */
 648                                 break;
 649
 650                         case PPPD_SEND_DELIM:
 651                         case PPPD_RECV_DELIM:
 652                                 /* What can we do? */
 653                                 break;
 654
 655                         case PPPD_RESET_TIME:
 656                                 wtap_file_read_unknown_bytes(&time_long, sizeof(guint32), fh, err, err_info);
 657                                 state->offset += sizeof(guint32);
 658                                 state->timestamp = pntohl(&time_long);
 659                                 state->tenths = 0;
 660                                 break;
 661
 662                         case PPPD_TIME_STEP_LONG:
 663                                 wtap_file_read_unknown_bytes(&time_long, sizeof(guint32), fh, err, err_info);
 664                                 state->offset += sizeof(guint32);
 665                                 state->tenths += pntohl(&time_long);
 666
 667                                 if (state->tenths >= 10) {
 668                                         state->timestamp += state->tenths / 10;
 669                                         state->tenths = state->tenths % 10;
 670                                 }
 671
 672                                 break;
 673
 674                         case PPPD_TIME_STEP_SHORT:
 675                                 wtap_file_read_unknown_bytes(&time_short, sizeof(guint8), fh, err, err_info);
 676                                 state->offset += sizeof(guint8);
 677                                 state->tenths += time_short;
 678
 679                                 if (state->tenths >= 10) {
 680                                         state->timestamp += state->tenths / 10;
 681                                         state->tenths = state->tenths % 10;
 682                                 }
 683
 684                                 break;
 685
 686                         default:
 687                                 /* XXX - bad file */
 688                                 *err = WTAP_ERR_BAD_FILE;
 689                                 *err_info = g_strdup_printf("pppdump: bad ID byte 0x%02x", id);
 690                                 return FALSE;
 691                 }
 692
 693         }
 694
 695 done:
 696         *err = file_error(fh, err_info);
 697         if (*err == 0) {
 698                 if (state->offset != start_offset) {
 699                         /*
 700                          * We read at least one byte, so we were working
 701                          * on a record; an EOF means that record was
 702                          * cut short.
 703                          */
 704                         *err = WTAP_ERR_SHORT_READ;
 705                 }
 706         }
 707         return FALSE;
 708 }
 709
 710
 711
 712 /* Used to read packets in random-access fashion */
 713 static gboolean
 714 pppdump_seek_read(wtap *wth,
 715                  gint64 seek_off,
 716                  struct wtap_pkthdr *phdr,
 717                  guint8 *pd,
 718                  int len,
 719                  int *err,
 720                  gchar **err_info)
 721 {
 722         union wtap_pseudo_header *pseudo_header = &phdr->pseudo_header;
 723         int             num_bytes;
 724         direction_enum  direction;
 725         pppdump_t       *state;
 726         pkt_id          *pid;
 727         gint64          num_bytes_to_skip;
 728
 729         state = (pppdump_t *)wth->priv;
 730
 731         pid = (pkt_id *)g_ptr_array_index(state->pids, seek_off);
 732         if (!pid) {
 733                 *err = WTAP_ERR_BAD_FILE;       /* XXX - better error? */
 734                 *err_info = g_strdup("pppdump: PID not found for record");
 735                 return FALSE;
 736         }
 737
 738         if (file_seek(wth->random_fh, pid->offset, SEEK_SET, err) == -1)
 739                 return FALSE;
 740
 741         init_state(state->seek_state);
 742         state->seek_state->offset = pid->offset;
 743
 744         /*
 745          * We'll start reading at the first record containing data from
 746          * this packet; however, that doesn't mean "collate()" will
 747          * stop only when we've read that packet, as there might be
 748          * data for packets going in the other direction as well, and
 749          * we might finish processing one of those packets before we
 750          * finish processing the packet we're reading.
 751          *
 752          * Therefore, we keep reading until we get a packet that's
 753          * going in the direction we want.
 754          */
 755         num_bytes_to_skip = pid->num_bytes_to_skip;
 756         do {
 757                 if (!collate(state->seek_state, wth->random_fh, err, err_info,
 758                     pd, &num_bytes, &direction, NULL, num_bytes_to_skip))
 759                         return FALSE;
 760                 num_bytes_to_skip = 0;
 761         } while (direction != pid->dir);
 762
 763         if (len != num_bytes) {
 764                 *err = WTAP_ERR_BAD_FILE;       /* XXX - better error? */
 765                 *err_info = g_strdup_printf("pppdump: requested length %d doesn't match record length %d",
 766                     len, num_bytes);
 767                 return FALSE;
 768         }
 769
 770         pseudo_header->p2p.sent = (pid->dir == DIRECTION_SENT ? TRUE : FALSE);
 771
 772         return TRUE;
 773 }
 774
 775 static void
 776 pppdump_close(wtap *wth)
 777 {
 778         pppdump_t       *state;
 779
 780         state = (pppdump_t *)wth->priv;
 781
 782         if (state->seek_state) { /* should always be TRUE */
 783                 g_free(state->seek_state);
 784         }
 785
 786         if (state->pids) {
 787                 unsigned int i;
 788                 for (i = 0; i < g_ptr_array_len(state->pids); i++) {
 789                         g_free(g_ptr_array_index(state->pids, i));
 790                 }
 791                 g_ptr_array_free(state->pids, TRUE);
 792         }
 793 }