The Tcpdump Group git mirrors - libpcap/blob - pcap-libdlpi.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  * This code contributed by Sagun Shakya (sagun.shakya@sun.com)
  22  */
  23 /*
  24  * Packet capture routines for DLPI using libdlpi under SunOS 5.11.
  25  */
  26
  27 #ifdef HAVE_CONFIG_H
  28 #include <config.h>
  29 #endif
  30
  31 #include <sys/types.h>
  32 #include <sys/time.h>
  33 #include <sys/bufmod.h>
  34 #include <sys/stream.h>
  35 #include <libdlpi.h>
  36 #include <errno.h>
  37 #include <memory.h>
  38 #include <stropts.h>
  39 #include <stdio.h>
  40 #include <stdlib.h>
  41 #include <string.h>
  42
  43 #include "pcap-int.h"
  44 #include "dlpisubs.h"
  45
  46 /* Forwards. */
  47 static int dlpromiscon(pcap_t *, bpf_u_int32);
  48 static int pcap_read_libdlpi(pcap_t *, int, pcap_handler, u_char *);
  49 static int pcap_inject_libdlpi(pcap_t *, const void *, int);
  50 static void pcap_libdlpi_err(const char *, const char *, int, char *);
  51 static void pcap_cleanup_libdlpi(pcap_t *);
  52
  53 /*
  54  * list_interfaces() will list all the network links that are
  55  * available on a system.
  56  */
  57 static boolean_t list_interfaces(const char *, void *);
  58
  59 typedef struct linknamelist {
  60         char    linkname[DLPI_LINKNAME_MAX];
  61         struct linknamelist *lnl_next;
  62 } linknamelist_t;
  63
  64 typedef struct linkwalk {
  65         linknamelist_t  *lw_list;
  66         int             lw_err;
  67 } linkwalk_t;
  68
  69 /*
  70  * The caller of this function should free the memory allocated
  71  * for each linknamelist_t "entry" allocated.
  72  */
  73 static boolean_t
  74 list_interfaces(const char *linkname, void *arg)
  75 {
  76         linkwalk_t      *lwp = arg;
  77         linknamelist_t  *entry;
  78
  79         if ((entry = calloc(1, sizeof(linknamelist_t))) == NULL) {
  80                 lwp->lw_err = ENOMEM;
  81                 return (B_TRUE);
  82         }
  83         (void) pcap_strlcpy(entry->linkname, linkname, DLPI_LINKNAME_MAX);
  84
  85         if (lwp->lw_list == NULL) {
  86                 lwp->lw_list = entry;
  87         } else {
  88                 entry->lnl_next = lwp->lw_list;
  89                 lwp->lw_list = entry;
  90         }
  91
  92         return (B_FALSE);
  93 }
  94
  95 static int
  96 pcap_activate_libdlpi(pcap_t *p)
  97 {
  98         struct pcap_dlpi *pd = p->priv;
  99         int status = 0;
 100         int retv;
 101         dlpi_handle_t dh;
 102         dlpi_info_t dlinfo;
 103
 104         /*
 105          * Enable Solaris raw and passive DLPI extensions;
 106          * dlpi_open() will not fail if the underlying link does not support
 107          * passive mode. See dlpi(7P) for details.
 108          */
 109         retv = dlpi_open(p->opt.device, &dh, DLPI_RAW|DLPI_PASSIVE);
 110         if (retv != DLPI_SUCCESS) {
 111                 if (retv == DLPI_ELINKNAMEINVAL || retv == DLPI_ENOLINK) {
 112                         /*
 113                          * There's nothing more to say, so clear the
 114                          * error message.
 115                          */
 116                         status = PCAP_ERROR_NO_SUCH_DEVICE;
 117                         p->errbuf[0] = '\0';
 118                 } else if (retv == DL_SYSERR &&
 119                     (errno == EPERM || errno == EACCES)) {
 120                         status = PCAP_ERROR_PERM_DENIED;
 121                         snprintf(p->errbuf, PCAP_ERRBUF_SIZE,
 122                             "Attempt to open DLPI device failed with %s - root privilege may be required",
 123                             (errno == EPERM) ? "EPERM" : "EACCES");
 124                 } else {
 125                         status = PCAP_ERROR;
 126                         pcap_libdlpi_err(p->opt.device, "dlpi_open", retv,
 127                             p->errbuf);
 128                 }
 129                 return (status);
 130         }
 131         pd->dlpi_hd = dh;
 132
 133         if (p->opt.rfmon) {
 134                 /*
 135                  * This device exists, but we don't support monitor mode
 136                  * any platforms that support DLPI.
 137                  */
 138                 status = PCAP_ERROR_RFMON_NOTSUP;
 139                 goto bad;
 140         }
 141
 142         /* Bind with DLPI_ANY_SAP. */
 143         if ((retv = dlpi_bind(pd->dlpi_hd, DLPI_ANY_SAP, 0)) != DLPI_SUCCESS) {
 144                 status = PCAP_ERROR;
 145                 pcap_libdlpi_err(p->opt.device, "dlpi_bind", retv, p->errbuf);
 146                 goto bad;
 147         }
 148
 149         /*
 150          * Turn a negative snapshot value (invalid), a snapshot value of
 151          * 0 (unspecified), or a value bigger than the normal maximum
 152          * value, into the maximum allowed value.
 153          *
 154          * If some application really *needs* a bigger snapshot
 155          * length, we should just increase MAXIMUM_SNAPLEN.
 156          */
 157         if (p->snapshot <= 0 || p->snapshot > MAXIMUM_SNAPLEN)
 158                 p->snapshot = MAXIMUM_SNAPLEN;
 159
 160         /* Enable promiscuous mode. */
 161         if (p->opt.promisc) {
 162                 retv = dlpromiscon(p, DL_PROMISC_PHYS);
 163                 if (retv < 0) {
 164                         /*
 165                          * "You don't have permission to capture on
 166                          * this device" and "you don't have permission
 167                          * to capture in promiscuous mode on this
 168                          * device" are different; let the user know,
 169                          * so if they can't get permission to
 170                          * capture in promiscuous mode, they can at
 171                          * least try to capture in non-promiscuous
 172                          * mode.
 173                          *
 174                          * XXX - you might have to capture in
 175                          * promiscuous mode to see outgoing packets.
 176                          */
 177                         if (retv == PCAP_ERROR_PERM_DENIED)
 178                                 status = PCAP_ERROR_PROMISC_PERM_DENIED;
 179                         else
 180                                 status = retv;
 181                         goto bad;
 182                 }
 183         } else {
 184                 /* Try to enable multicast. */
 185                 retv = dlpromiscon(p, DL_PROMISC_MULTI);
 186                 if (retv < 0) {
 187                         status = retv;
 188                         goto bad;
 189                 }
 190         }
 191
 192         /* Try to enable SAP promiscuity. */
 193         retv = dlpromiscon(p, DL_PROMISC_SAP);
 194         if (retv < 0) {
 195                 /*
 196                  * Not fatal, since the DL_PROMISC_PHYS mode worked.
 197                  * Report it as a warning, however.
 198                  */
 199                 if (p->opt.promisc)
 200                         status = PCAP_WARNING;
 201                 else {
 202                         status = retv;
 203                         goto bad;
 204                 }
 205         }
 206
 207         /* Determine link type.  */
 208         if ((retv = dlpi_info(pd->dlpi_hd, &dlinfo, 0)) != DLPI_SUCCESS) {
 209                 status = PCAP_ERROR;
 210                 pcap_libdlpi_err(p->opt.device, "dlpi_info", retv, p->errbuf);
 211                 goto bad;
 212         }
 213
 214         if (pcap_process_mactype(p, dlinfo.di_mactype) != 0) {
 215                 status = PCAP_ERROR;
 216                 goto bad;
 217         }
 218
 219         p->fd = dlpi_fd(pd->dlpi_hd);
 220
 221         /* Push and configure bufmod. */
 222         if (pcap_conf_bufmod(p, p->snapshot) != 0) {
 223                 status = PCAP_ERROR;
 224                 goto bad;
 225         }
 226
 227         /*
 228          * Flush the read side.
 229          */
 230         if (ioctl(p->fd, I_FLUSH, FLUSHR) != 0) {
 231                 status = PCAP_ERROR;
 232                 pcap_fmt_errmsg_for_errno(p->errbuf, PCAP_ERRBUF_SIZE,
 233                     errno, "FLUSHR");
 234                 goto bad;
 235         }
 236
 237         /* Allocate data buffer. */
 238         if (pcap_alloc_databuf(p) != 0) {
 239                 status = PCAP_ERROR;
 240                 goto bad;
 241         }
 242
 243         /*
 244          * "p->fd" is a FD for a STREAMS device, so "select()" and
 245          * "poll()" should work on it.
 246          */
 247         p->selectable_fd = p->fd;
 248
 249         p->read_op = pcap_read_libdlpi;
 250         p->inject_op = pcap_inject_libdlpi;
 251         p->setfilter_op = install_bpf_program;  /* No kernel filtering */
 252         p->setdirection_op = NULL;      /* Not implemented */
 253         p->set_datalink_op = NULL;      /* Can't change data link type */
 254         p->getnonblock_op = pcap_getnonblock_fd;
 255         p->setnonblock_op = pcap_setnonblock_fd;
 256         p->stats_op = pcap_stats_dlpi;
 257         p->cleanup_op = pcap_cleanup_libdlpi;
 258
 259         return (status);
 260 bad:
 261         pcap_cleanup_libdlpi(p);
 262         return (status);
 263 }
 264
 265 #define STRINGIFY(n)    #n
 266
 267 static int
 268 dlpromiscon(pcap_t *p, bpf_u_int32 level)
 269 {
 270         struct pcap_dlpi *pd = p->priv;
 271         int retv;
 272         int err;
 273
 274         retv = dlpi_promiscon(pd->dlpi_hd, level);
 275         if (retv != DLPI_SUCCESS) {
 276                 if (retv == DL_SYSERR &&
 277                     (errno == EPERM || errno == EACCES)) {
 278                         if (level == DL_PROMISC_PHYS) {
 279                                 err = PCAP_ERROR_PROMISC_PERM_DENIED;
 280                                 snprintf(p->errbuf, PCAP_ERRBUF_SIZE,
 281                                     "Attempt to set promiscuous mode failed with %s - root privilege may be required",
 282                                     (errno == EPERM) ? "EPERM" : "EACCES");
 283                         } else {
 284                                 err = PCAP_ERROR_PERM_DENIED;
 285                                 snprintf(p->errbuf, PCAP_ERRBUF_SIZE,
 286                                     "Attempt to set %s mode failed with %s - root privilege may be required",
 287                                     (level == DL_PROMISC_MULTI) ? "multicast" : "SAP promiscuous",
 288                                     (errno == EPERM) ? "EPERM" : "EACCES");
 289                         }
 290                 } else {
 291                         err = PCAP_ERROR;
 292                         pcap_libdlpi_err(p->opt.device,
 293                             "dlpi_promiscon" STRINGIFY(level),
 294                             retv, p->errbuf);
 295                 }
 296                 return (err);
 297         }
 298         return (0);
 299 }
 300
 301 /*
 302  * Presumably everything returned by dlpi_walk() is a DLPI device,
 303  * so there's no work to be done here to check whether name refers
 304  * to a DLPI device.
 305  */
 306 static int
 307 is_dlpi_interface(const char *name _U_)
 308 {
 309         return (1);
 310 }
 311
 312 static int
 313 get_if_flags(const char *name _U_, bpf_u_int32 *flags _U_, char *errbuf _U_)
 314 {
 315         /*
 316          * Nothing we can do other than mark loopback devices as "the
 317          * connected/disconnected status doesn't apply".
 318          *
 319          * XXX - on Solaris, can we do what the dladm command does,
 320          * i.e. get a connected/disconnected indication from a kstat?
 321          * (Note that you can also get the link speed, and possibly
 322          * other information, from a kstat as well.)
 323          */
 324         if (*flags & PCAP_IF_LOOPBACK) {
 325                 /*
 326                  * Loopback devices aren't wireless, and "connected"/
 327                  * "disconnected" doesn't apply to them.
 328                  */
 329                 *flags |= PCAP_IF_CONNECTION_STATUS_NOT_APPLICABLE;
 330                 return (0);
 331         }
 332         return (0);
 333 }
 334
 335 /*
 336  * In Solaris, the "standard" mechanism" i.e SIOCGLIFCONF will only find
 337  * network links that are plumbed and are up. dlpi_walk(3DLPI) will find
 338  * additional network links present in the system.
 339  */
 340 int
 341 pcap_platform_finddevs(pcap_if_list_t *devlistp, char *errbuf)
 342 {
 343         int retv = 0;
 344
 345         linknamelist_t  *entry, *next;
 346         linkwalk_t      lw = {NULL, 0};
 347         int             save_errno;
 348
 349         /*
 350          * Get the list of regular interfaces first.
 351          */
 352         if (pcap_findalldevs_interfaces(devlistp, errbuf,
 353             is_dlpi_interface, get_if_flags) == -1)
 354                 return (-1);    /* failure */
 355
 356         /* dlpi_walk() for loopback will be added here. */
 357
 358         /*
 359          * Find all DLPI devices in the current zone.
 360          *
 361          * XXX - will pcap_findalldevs_interfaces() find any devices
 362          * outside the current zone?  If not, the only reason to call
 363          * it would be to get the interface addresses.
 364          */
 365         dlpi_walk(list_interfaces, &lw, 0);
 366
 367         if (lw.lw_err != 0) {
 368                 pcap_fmt_errmsg_for_errno(errbuf, PCAP_ERRBUF_SIZE,
 369                     lw.lw_err, "dlpi_walk");
 370                 retv = -1;
 371                 goto done;
 372         }
 373
 374         /* Add linkname if it does not exist on the list. */
 375         for (entry = lw.lw_list; entry != NULL; entry = entry->lnl_next) {
 376                 /*
 377                  * If it isn't already in the list of devices, try to
 378                  * add it.
 379                  */
 380                 if (find_or_add_dev(devlistp, entry->linkname, 0, get_if_flags,
 381                     NULL, errbuf) == NULL)
 382                         retv = -1;
 383         }
 384 done:
 385         save_errno = errno;
 386         for (entry = lw.lw_list; entry != NULL; entry = next) {
 387                 next = entry->lnl_next;
 388                 free(entry);
 389         }
 390         errno = save_errno;
 391
 392         return (retv);
 393 }
 394
 395 /*
 396  * Read data received on DLPI handle. Returns -2 if told to terminate, else
 397  * returns the number of packets read.
 398  */
 399 static int
 400 pcap_read_libdlpi(pcap_t *p, int count, pcap_handler callback, u_char *user)
 401 {
 402         struct pcap_dlpi *pd = p->priv;
 403         int len;
 404         u_char *bufp;
 405         size_t msglen;
 406         int retv;
 407
 408         len = p->cc;
 409         if (len != 0) {
 410                 bufp = p->bp;
 411                 goto process_pkts;
 412         }
 413         do {
 414                 /* Has "pcap_breakloop()" been called? */
 415                 if (p->break_loop) {
 416                         /*
 417                          * Yes - clear the flag that indicates that it has,
 418                          * and return -2 to indicate that we were told to
 419                          * break out of the loop.
 420                          */
 421                         p->break_loop = 0;
 422                         return (-2);
 423                 }
 424
 425                 msglen = p->bufsize;
 426                 bufp = (u_char *)p->buffer + p->offset;
 427
 428                 retv = dlpi_recv(pd->dlpi_hd, NULL, NULL, bufp,
 429                     &msglen, -1, NULL);
 430                 if (retv != DLPI_SUCCESS) {
 431                         /*
 432                          * This is most likely a call to terminate out of the
 433                          * loop. So, do not return an error message, instead
 434                          * check if "pcap_breakloop()" has been called above.
 435                          */
 436                         if (retv == DL_SYSERR && errno == EINTR) {
 437                                 len = 0;
 438                                 continue;
 439                         }
 440                         pcap_libdlpi_err(dlpi_linkname(pd->dlpi_hd),
 441                             "dlpi_recv", retv, p->errbuf);
 442                         return (-1);
 443                 }
 444                 len = msglen;
 445         } while (len == 0);
 446
 447 process_pkts:
 448         return (pcap_process_pkts(p, callback, user, count, bufp, len));
 449 }
 450
 451 static int
 452 pcap_inject_libdlpi(pcap_t *p, const void *buf, int size)
 453 {
 454         struct pcap_dlpi *pd = p->priv;
 455         int retv;
 456
 457         retv = dlpi_send(pd->dlpi_hd, NULL, 0, buf, size, NULL);
 458         if (retv != DLPI_SUCCESS) {
 459                 pcap_libdlpi_err(dlpi_linkname(pd->dlpi_hd), "dlpi_send", retv,
 460                     p->errbuf);
 461                 return (-1);
 462         }
 463         /*
 464          * dlpi_send(3DLPI) does not provide a way to return the number of
 465          * bytes sent on the wire. Based on the fact that DLPI_SUCCESS was
 466          * returned we are assuming 'size' bytes were sent.
 467          */
 468         return (size);
 469 }
 470
 471 /*
 472  * Close dlpi handle.
 473  */
 474 static void
 475 pcap_cleanup_libdlpi(pcap_t *p)
 476 {
 477         struct pcap_dlpi *pd = p->priv;
 478
 479         if (pd->dlpi_hd != NULL) {
 480                 dlpi_close(pd->dlpi_hd);
 481                 pd->dlpi_hd = NULL;
 482                 p->fd = -1;
 483         }
 484         pcap_cleanup_live_common(p);
 485 }
 486
 487 /*
 488  * Write error message to buffer.
 489  */
 490 static void
 491 pcap_libdlpi_err(const char *linkname, const char *func, int err, char *errbuf)
 492 {
 493         snprintf(errbuf, PCAP_ERRBUF_SIZE, "libpcap: %s failed on %s: %s",
 494             func, linkname, dlpi_strerror(err));
 495 }
 496
 497 pcap_t *
 498 pcap_create_interface(const char *device _U_, char *ebuf)
 499 {
 500         pcap_t *p;
 501
 502         p = PCAP_CREATE_COMMON(ebuf, struct pcap_dlpi);
 503         if (p == NULL)
 504                 return (NULL);
 505
 506         p->activate_op = pcap_activate_libdlpi;
 507         return (p);
 508 }
 509
 510 /*
 511  * Libpcap version string.
 512  */
 513 const char *
 514 pcap_lib_version(void)
 515 {
 516         return (PCAP_VERSION_STRING);
 517 }