contrib/libpcap/savefile.c

   1 /*
   2  * Copyright (c) 1993, 1994, 1995, 1996, 1997
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that: (1) source code distributions
   7  * retain the above copyright notice and this paragraph in its entirety, (2)
   8  * distributions including binary code include the above copyright notice and
   9  * this paragraph in its entirety in the documentation or other materials
  10  * provided with the distribution, and (3) all advertising materials mentioning
  11  * features or use of this software display the following acknowledgement:
  12  * ``This product includes software developed by the University of California,
  13  * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
  14  * the University nor the names of its contributors may be used to endorse
  15  * or promote products derived from this software without specific prior
  16  * written permission.
  17  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  18  * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  20  *
  21  * savefile.c - supports offline use of tcpdump
  22  *      Extraction/creation by Jeffrey Mogul, DECWRL
  23  *      Modified by Steve McCanne, LBL.
  24  *
  25  * Used to save the received packet headers, after filtering, to
  26  * a file, and then read them later.
  27  * The first record in the file contains saved values for the machine
  28  * dependent values so we can print the dump file on any architecture.
  29  */
  30
  31 #ifdef HAVE_CONFIG_H
  32 #include <config.h>
  33 #endif
  34
  35 #include <pcap-types.h>
  36 #ifdef _WIN32
  37 #include <io.h>
  38 #include <fcntl.h>
  39 #endif /* _WIN32 */
  40
  41 #include <errno.h>
  42 #include <memory.h>
  43 #include <stdio.h>
  44 #include <stdlib.h>
  45 #include <string.h>
  46 #include <limits.h> /* for INT_MAX */
  47
  48 #include "pcap-int.h"
  49
  50 #ifdef HAVE_OS_PROTO_H
  51 #include "os-proto.h"
  52 #endif
  53
  54 #include "sf-pcap.h"
  55 #include "sf-pcapng.h"
  56 #include "pcap-common.h"
  57
  58 #ifdef _WIN32
  59 /*
  60  * These aren't exported on Windows, because they would only work if both
  61  * WinPcap/Npcap and the code using it were to use the Universal CRT; otherwise,
  62  * a FILE structure in WinPcap/Npcap and a FILE structure in the code using it
  63  * could be different if they're using different versions of the C runtime.
  64  *
  65  * Instead, pcap/pcap.h defines them as macros that wrap the hopen versions,
  66  * with the wrappers calling _fileno() and _get_osfhandle() themselves,
  67  * so that they convert the appropriate CRT version's FILE structure to
  68  * a HANDLE (which is OS-defined, not CRT-defined, and is part of the Win32
  69  * and Win64 ABIs).
  70  */
  71 static pcap_t *pcap_fopen_offline_with_tstamp_precision(FILE *, u_int, char *);
  72 static pcap_t *pcap_fopen_offline(FILE *, char *);
  73 #endif
  74
  75 /*
  76  * Setting O_BINARY on DOS/Windows is a bit tricky
  77  */
  78 #if defined(_WIN32)
  79   #define SET_BINMODE(f)  _setmode(_fileno(f), _O_BINARY)
  80 #elif defined(MSDOS)
  81   #if defined(__HIGHC__)
  82   #define SET_BINMODE(f)  setmode(f, O_BINARY)
  83   #else
  84   #define SET_BINMODE(f)  setmode(fileno(f), O_BINARY)
  85   #endif
  86 #endif
  87
  88 static int
  89 sf_getnonblock(pcap_t *p _U_)
  90 {
  91         /*
  92          * This is a savefile, not a live capture file, so never say
  93          * it's in non-blocking mode.
  94          */
  95         return (0);
  96 }
  97
  98 static int
  99 sf_setnonblock(pcap_t *p, int nonblock _U_)
 100 {
 101         /*
 102          * This is a savefile, not a live capture file, so reject
 103          * requests to put it in non-blocking mode.  (If it's a
 104          * pipe, it could be put in non-blocking mode, but that
 105          * would significantly complicate the code to read packets,
 106          * as it would have to handle reading partial packets and
 107          * keeping the state of the read.)
 108          */
 109         pcap_snprintf(p->errbuf, PCAP_ERRBUF_SIZE,
 110             "Savefiles cannot be put into non-blocking mode");
 111         return (-1);
 112 }
 113
 114 static int
 115 sf_stats(pcap_t *p, struct pcap_stat *ps _U_)
 116 {
 117         pcap_snprintf(p->errbuf, PCAP_ERRBUF_SIZE,
 118             "Statistics aren't available from savefiles");
 119         return (-1);
 120 }
 121
 122 #ifdef _WIN32
 123 static struct pcap_stat *
 124 sf_stats_ex(pcap_t *p, int *size)
 125 {
 126         pcap_snprintf(p->errbuf, PCAP_ERRBUF_SIZE,
 127             "Statistics aren't available from savefiles");
 128         return (NULL);
 129 }
 130
 131 static int
 132 sf_setbuff(pcap_t *p, int dim)
 133 {
 134         pcap_snprintf(p->errbuf, PCAP_ERRBUF_SIZE,
 135             "The kernel buffer size cannot be set while reading from a file");
 136         return (-1);
 137 }
 138
 139 static int
 140 sf_setmode(pcap_t *p, int mode)
 141 {
 142         pcap_snprintf(p->errbuf, PCAP_ERRBUF_SIZE,
 143             "impossible to set mode while reading from a file");
 144         return (-1);
 145 }
 146
 147 static int
 148 sf_setmintocopy(pcap_t *p, int size)
 149 {
 150         pcap_snprintf(p->errbuf, PCAP_ERRBUF_SIZE,
 151             "The mintocopy parameter cannot be set while reading from a file");
 152         return (-1);
 153 }
 154
 155 static HANDLE
 156 sf_getevent(pcap_t *pcap)
 157 {
 158         (void)pcap_snprintf(pcap->errbuf, sizeof(pcap->errbuf),
 159             "The read event cannot be retrieved while reading from a file");
 160         return (INVALID_HANDLE_VALUE);
 161 }
 162
 163 static int
 164 sf_oid_get_request(pcap_t *p, bpf_u_int32 oid _U_, void *data _U_,
 165     size_t *lenp _U_)
 166 {
 167         pcap_snprintf(p->errbuf, PCAP_ERRBUF_SIZE,
 168             "An OID get request cannot be performed on a file");
 169         return (PCAP_ERROR);
 170 }
 171
 172 static int
 173 sf_oid_set_request(pcap_t *p, bpf_u_int32 oid _U_, const void *data _U_,
 174     size_t *lenp _U_)
 175 {
 176         pcap_snprintf(p->errbuf, PCAP_ERRBUF_SIZE,
 177             "An OID set request cannot be performed on a file");
 178         return (PCAP_ERROR);
 179 }
 180
 181 static u_int
 182 sf_sendqueue_transmit(pcap_t *p, pcap_send_queue *queue, int sync)
 183 {
 184         pcap_strlcpy(p->errbuf, "Sending packets isn't supported on savefiles",
 185             PCAP_ERRBUF_SIZE);
 186         return (0);
 187 }
 188
 189 static int
 190 sf_setuserbuffer(pcap_t *p, int size)
 191 {
 192         pcap_snprintf(p->errbuf, PCAP_ERRBUF_SIZE,
 193             "The user buffer cannot be set when reading from a file");
 194         return (-1);
 195 }
 196
 197 static int
 198 sf_live_dump(pcap_t *p, char *filename, int maxsize, int maxpacks)
 199 {
 200         pcap_snprintf(p->errbuf, PCAP_ERRBUF_SIZE,
 201             "Live packet dumping cannot be performed when reading from a file");
 202         return (-1);
 203 }
 204
 205 static int
 206 sf_live_dump_ended(pcap_t *p, int sync)
 207 {
 208         pcap_snprintf(p->errbuf, PCAP_ERRBUF_SIZE,
 209             "Live packet dumping cannot be performed on a pcap_open_dead pcap_t");
 210         return (-1);
 211 }
 212
 213 static PAirpcapHandle
 214 sf_get_airpcap_handle(pcap_t *pcap)
 215 {
 216         return (NULL);
 217 }
 218 #endif
 219
 220 static int
 221 sf_inject(pcap_t *p, const void *buf _U_, size_t size _U_)
 222 {
 223         pcap_strlcpy(p->errbuf, "Sending packets isn't supported on savefiles",
 224             PCAP_ERRBUF_SIZE);
 225         return (-1);
 226 }
 227
 228 /*
 229  * Set direction flag: Which packets do we accept on a forwarding
 230  * single device? IN, OUT or both?
 231  */
 232 static int
 233 sf_setdirection(pcap_t *p, pcap_direction_t d _U_)
 234 {
 235         pcap_snprintf(p->errbuf, sizeof(p->errbuf),
 236             "Setting direction is not supported on savefiles");
 237         return (-1);
 238 }
 239
 240 void
 241 sf_cleanup(pcap_t *p)
 242 {
 243         if (p->rfile != stdin)
 244                 (void)fclose(p->rfile);
 245         if (p->buffer != NULL)
 246                 free(p->buffer);
 247         pcap_freecode(&p->fcode);
 248 }
 249
 250 pcap_t *
 251 pcap_open_offline_with_tstamp_precision(const char *fname, u_int precision,
 252                                         char *errbuf)
 253 {
 254         FILE *fp;
 255         pcap_t *p;
 256
 257         if (fname == NULL) {
 258                 pcap_snprintf(errbuf, PCAP_ERRBUF_SIZE,
 259                     "A null pointer was supplied as the file name");
 260                 return (NULL);
 261         }
 262         if (fname[0] == '-' && fname[1] == '\0')
 263         {
 264                 fp = stdin;
 265 #if defined(_WIN32) || defined(MSDOS)
 266                 /*
 267                  * We're reading from the standard input, so put it in binary
 268                  * mode, as savefiles are binary files.
 269                  */
 270                 SET_BINMODE(fp);
 271 #endif
 272         }
 273         else {
 274                 /*
 275                  * "b" is supported as of C90, so *all* UN*Xes should
 276                  * support it, even though it does nothing.  It's
 277                  * required on Windows, as the file is a binary file
 278                  * and must be read in binary mode.
 279                  */
 280                 fp = fopen(fname, "rb");
 281                 if (fp == NULL) {
 282                         pcap_fmt_errmsg_for_errno(errbuf, PCAP_ERRBUF_SIZE,
 283                             errno, "%s", fname);
 284                         return (NULL);
 285                 }
 286         }
 287         p = pcap_fopen_offline_with_tstamp_precision(fp, precision, errbuf);
 288         if (p == NULL) {
 289                 if (fp != stdin)
 290                         fclose(fp);
 291         }
 292         return (p);
 293 }
 294
 295 pcap_t *
 296 pcap_open_offline(const char *fname, char *errbuf)
 297 {
 298         return (pcap_open_offline_with_tstamp_precision(fname,
 299             PCAP_TSTAMP_PRECISION_MICRO, errbuf));
 300 }
 301
 302 #ifdef _WIN32
 303 pcap_t* pcap_hopen_offline_with_tstamp_precision(intptr_t osfd, u_int precision,
 304     char *errbuf)
 305 {
 306         int fd;
 307         FILE *file;
 308
 309         fd = _open_osfhandle(osfd, _O_RDONLY);
 310         if ( fd < 0 )
 311         {
 312                 pcap_fmt_errmsg_for_errno(errbuf, PCAP_ERRBUF_SIZE,
 313                     errno, "_open_osfhandle");
 314                 return NULL;
 315         }
 316
 317         file = _fdopen(fd, "rb");
 318         if ( file == NULL )
 319         {
 320                 pcap_fmt_errmsg_for_errno(errbuf, PCAP_ERRBUF_SIZE,
 321                     errno, "_fdopen");
 322                 _close(fd);
 323                 return NULL;
 324         }
 325
 326         return pcap_fopen_offline_with_tstamp_precision(file, precision,
 327             errbuf);
 328 }
 329
 330 pcap_t* pcap_hopen_offline(intptr_t osfd, char *errbuf)
 331 {
 332         return pcap_hopen_offline_with_tstamp_precision(osfd,
 333             PCAP_TSTAMP_PRECISION_MICRO, errbuf);
 334 }
 335 #endif
 336
 337 /*
 338  * Given a link-layer header type and snapshot length, return a
 339  * snapshot length to use when reading the file; it's guaranteed
 340  * to be > 0 and <= INT_MAX.
 341  *
 342  * XXX - the only reason why we limit it to <= INT_MAX is so that
 343  * it fits in p->snapshot, and the only reason that p->snapshot is
 344  * signed is that pcap_snapshot() returns an int, not an unsigned int.
 345  */
 346 bpf_u_int32
 347 pcap_adjust_snapshot(bpf_u_int32 linktype, bpf_u_int32 snaplen)
 348 {
 349         if (snaplen == 0 || snaplen > INT_MAX) {
 350                 /*
 351                  * Bogus snapshot length; use the maximum for this
 352                  * link-layer type as a fallback.
 353                  *
 354                  * XXX - we don't clamp snapshot lengths that are
 355                  * <= INT_MAX but > max_snaplen_for_dlt(linktype),
 356                  * so a capture file could cause us to allocate
 357                  * a Really Big Buffer.
 358                  */
 359                 snaplen = max_snaplen_for_dlt(linktype);
 360         }
 361         return snaplen;
 362 }
 363
 364 static pcap_t *(*check_headers[])(const uint8_t *, FILE *, u_int, char *, int *) = {
 365         pcap_check_header,
 366         pcap_ng_check_header
 367 };
 368
 369 #define N_FILE_TYPES    (sizeof check_headers / sizeof check_headers[0])
 370
 371 #ifdef _WIN32
 372 static
 373 #endif
 374 pcap_t *
 375 pcap_fopen_offline_with_tstamp_precision(FILE *fp, u_int precision,
 376     char *errbuf)
 377 {
 378         register pcap_t *p;
 379         uint8_t magic[4];
 380         size_t amt_read;
 381         u_int i;
 382         int err;
 383
 384         /*
 385          * Read the first 4 bytes of the file; the network analyzer dump
 386          * file formats we support (pcap and pcapng), and several other
 387          * formats we might support in the future (such as snoop, DOS and
 388          * Windows Sniffer, and Microsoft Network Monitor) all have magic
 389          * numbers that are unique in their first 4 bytes.
 390          */
 391         amt_read = fread(&magic, 1, sizeof(magic), fp);
 392         if (amt_read != sizeof(magic)) {
 393                 if (ferror(fp)) {
 394                         pcap_fmt_errmsg_for_errno(errbuf, PCAP_ERRBUF_SIZE,
 395                             errno, "error reading dump file");
 396                 } else {
 397                         pcap_snprintf(errbuf, PCAP_ERRBUF_SIZE,
 398                             "truncated dump file; tried to read %" PRIsize " file header bytes, only got %" PRIsize,
 399                             sizeof(magic), amt_read);
 400                 }
 401                 return (NULL);
 402         }
 403
 404         /*
 405          * Try all file types.
 406          */
 407         for (i = 0; i < N_FILE_TYPES; i++) {
 408                 p = (*check_headers[i])(magic, fp, precision, errbuf, &err);
 409                 if (p != NULL) {
 410                         /* Yup, that's it. */
 411                         goto found;
 412                 }
 413                 if (err) {
 414                         /*
 415                          * Error trying to read the header.
 416                          */
 417                         return (NULL);
 418                 }
 419         }
 420
 421         /*
 422          * Well, who knows what this mess is....
 423          */
 424         pcap_snprintf(errbuf, PCAP_ERRBUF_SIZE, "unknown file format");
 425         return (NULL);
 426
 427 found:
 428         p->rfile = fp;
 429
 430         /* Padding only needed for live capture fcode */
 431         p->fddipad = 0;
 432
 433 #if !defined(_WIN32) && !defined(MSDOS)
 434         /*
 435          * You can do "select()" and "poll()" on plain files on most
 436          * platforms, and should be able to do so on pipes.
 437          *
 438          * You can't do "select()" on anything other than sockets in
 439          * Windows, so, on Win32 systems, we don't have "selectable_fd".
 440          */
 441         p->selectable_fd = fileno(fp);
 442 #endif
 443
 444         p->read_op = pcap_offline_read;
 445         p->inject_op = sf_inject;
 446         p->setfilter_op = install_bpf_program;
 447         p->setdirection_op = sf_setdirection;
 448         p->set_datalink_op = NULL;      /* we don't support munging link-layer headers */
 449         p->getnonblock_op = sf_getnonblock;
 450         p->setnonblock_op = sf_setnonblock;
 451         p->stats_op = sf_stats;
 452 #ifdef _WIN32
 453         p->stats_ex_op = sf_stats_ex;
 454         p->setbuff_op = sf_setbuff;
 455         p->setmode_op = sf_setmode;
 456         p->setmintocopy_op = sf_setmintocopy;
 457         p->getevent_op = sf_getevent;
 458         p->oid_get_request_op = sf_oid_get_request;
 459         p->oid_set_request_op = sf_oid_set_request;
 460         p->sendqueue_transmit_op = sf_sendqueue_transmit;
 461         p->setuserbuffer_op = sf_setuserbuffer;
 462         p->live_dump_op = sf_live_dump;
 463         p->live_dump_ended_op = sf_live_dump_ended;
 464         p->get_airpcap_handle_op = sf_get_airpcap_handle;
 465 #endif
 466
 467         /*
 468          * For offline captures, the standard one-shot callback can
 469          * be used for pcap_next()/pcap_next_ex().
 470          */
 471         p->oneshot_callback = pcap_oneshot;
 472
 473         /*
 474          * Savefiles never require special BPF code generation.
 475          */
 476         p->bpf_codegen_flags = 0;
 477
 478         p->activated = 1;
 479
 480         return (p);
 481 }
 482
 483 #ifdef _WIN32
 484 static
 485 #endif
 486 pcap_t *
 487 pcap_fopen_offline(FILE *fp, char *errbuf)
 488 {
 489         return (pcap_fopen_offline_with_tstamp_precision(fp,
 490             PCAP_TSTAMP_PRECISION_MICRO, errbuf));
 491 }
 492
 493 /*
 494  * Read packets from a capture file, and call the callback for each
 495  * packet.
 496  * If cnt > 0, return after 'cnt' packets, otherwise continue until eof.
 497  */
 498 int
 499 pcap_offline_read(pcap_t *p, int cnt, pcap_handler callback, u_char *user)
 500 {
 501         struct bpf_insn *fcode;
 502         int status = 0;
 503         int n = 0;
 504         u_char *data;
 505
 506         while (status == 0) {
 507                 struct pcap_pkthdr h;
 508
 509                 /*
 510                  * Has "pcap_breakloop()" been called?
 511                  * If so, return immediately - if we haven't read any
 512                  * packets, clear the flag and return -2 to indicate
 513                  * that we were told to break out of the loop, otherwise
 514                  * leave the flag set, so that the *next* call will break
 515                  * out of the loop without having read any packets, and
 516                  * return the number of packets we've processed so far.
 517                  */
 518                 if (p->break_loop) {
 519                         if (n == 0) {
 520                                 p->break_loop = 0;
 521                                 return (-2);
 522                         } else
 523                                 return (n);
 524                 }
 525
 526                 status = p->next_packet_op(p, &h, &data);
 527                 if (status) {
 528                         if (status == 1)
 529                                 return (0);
 530                         return (status);
 531                 }
 532
 533                 if ((fcode = p->fcode.bf_insns) == NULL ||
 534                     bpf_filter(fcode, data, h.len, h.caplen)) {
 535                         (*callback)(user, &h, data);
 536                         if (++n >= cnt && cnt > 0)
 537                                 break;
 538                 }
 539         }
 540         /*XXX this breaks semantics tcpslice expects */
 541         return (n);
 542 }