2 * Copyright (c) 2002 - 2005 NetGroup, Politecnico di Torino (Italy)
3 * Copyright (c) 2005 - 2008 CACE Technologies, Davis (California)
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the Politecnico di Torino, CACE Technologies
16 * nor the names of its contributors may be used to endorse or promote
17 * products derived from this software without specific prior written
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 #include <string.h> /* for strlen(), ... */
41 #include <stdlib.h> /* for malloc(), free(), ... */
42 #include <stdarg.h> /* for functions with variable number of arguments */
43 #include <errno.h> /* for the errno variable */
44 #include "sockutils.h"
46 #include "rpcap-protocol.h"
47 #include "pcap-rpcap.h"
54 * This file contains the pcap module for capturing from a remote machine's
55 * interfaces using the RPCAP protocol.
57 * WARNING: All the RPCAP functions that are allowed to return a buffer
58 * containing the error description can return max PCAP_ERRBUF_SIZE characters.
59 * However there is no guarantees that the string will be zero-terminated.
60 * Best practice is to define the errbuf variable as a char of size
61 * 'PCAP_ERRBUF_SIZE+1' and to insert manually a NULL character at the end
62 * of the buffer. This will guarantee that no buffer overflows occur even
63 * if we use the printf() to show the error on the screen.
65 * XXX - actually, null-terminating the error string is part of the
66 * contract for the pcap API; if there's any place in the pcap code
67 * that doesn't guarantee null-termination, even at the expense of
68 * cutting the message short, that's a bug and needs to be fixed.
71 #define PCAP_STATS_STANDARD 0 /* Used by pcap_stats_rpcap to see if we want standard or extended statistics */
73 #define PCAP_STATS_EX 1 /* Used by pcap_stats_rpcap to see if we want standard or extended statistics */
77 * \brief Keeps a list of all the opened connections in the active mode.
79 * This structure defines a linked list of items that are needed to keep the info required to
80 * manage the active mode.
81 * In other words, when a new connection in active mode starts, this structure is updated so that
82 * it reflects the list of active mode connections currently opened.
83 * This structure is required by findalldevs() and open_remote() to see if they have to open a new
84 * control connection toward the host, or they already have a control connection in place.
88 struct sockaddr_storage host
;
91 uint8 protocol_version
;
92 struct activehosts
*next
;
95 /* Keeps a list of all the opened connections in the active mode. */
96 static struct activehosts
*activeHosts
;
99 * Keeps the main socket identifier when we want to accept a new remote
100 * connection (active mode only).
101 * See the documentation of pcap_remoteact_accept() and
102 * pcap_remoteact_cleanup() for more details.
104 static SOCKET sockmain
;
105 static SSL
*ssl_main
;
108 * Private data for capturing remotely using the rpcap protocol.
112 * This is '1' if we're the network client; it is needed by several
113 * functions (such as pcap_setfilter()) to know whether they have
114 * to use the socket or have to open the local adapter.
118 SOCKET rmt_sockctrl
; /* socket ID of the socket used for the control connection */
119 SOCKET rmt_sockdata
; /* socket ID of the socket used for the data connection */
120 SSL
*ctrl_ssl
, *data_ssl
; /* optional transport of rmt_sockctrl and rmt_sockdata via TLS */
121 int rmt_flags
; /* we have to save flags, since they are passed by the pcap_open_live(), but they are used by the pcap_startcapture() */
122 int rmt_capstarted
; /* 'true' if the capture is already started (needed to knoe if we have to call the pcap_startcapture() */
123 char *currentfilter
; /* Pointer to a buffer (allocated at run-time) that stores the current filter. Needed when flag PCAP_OPENFLAG_NOCAPTURE_RPCAP is turned on. */
125 uint8 protocol_version
; /* negotiated protocol version */
126 uint8 uses_ssl
; /* User asked for rpcaps scheme */
128 unsigned int TotNetDrops
; /* keeps the number of packets that have been dropped by the network */
131 * This keeps the number of packets that have been received by the
134 * Packets dropped by the kernel buffer are not counted in this
135 * variable. It is always equal to (TotAccepted - TotDrops),
136 * except for the case of remote capture, in which we have also
137 * packets in flight, i.e. that have been transmitted by the remote
138 * host, but that have not been received (yet) from the client.
139 * In this case, (TotAccepted - TotDrops - TotNetDrops) gives a
140 * wrong result, since this number does not corresponds always to
141 * the number of packet received by the application. For this reason,
142 * in the remote capture we need another variable that takes into
143 * account of the number of packets actually received by the
146 unsigned int TotCapt
;
148 struct pcap_stat stat
;
150 struct pcap
*next
; /* list of open pcaps that need stuff cleared on close */
153 /****************************************************
155 * Locally defined functions *
157 ****************************************************/
158 static struct pcap_stat
*rpcap_stats_rpcap(pcap_t
*p
, struct pcap_stat
*ps
, int mode
);
159 static int pcap_pack_bpffilter(pcap_t
*fp
, char *sendbuf
, int *sendbufidx
, struct bpf_program
*prog
);
160 static int pcap_createfilter_norpcappkt(pcap_t
*fp
, struct bpf_program
*prog
);
161 static int pcap_updatefilter_remote(pcap_t
*fp
, struct bpf_program
*prog
);
162 static void pcap_save_current_filter_rpcap(pcap_t
*fp
, const char *filter
);
163 static int pcap_setfilter_rpcap(pcap_t
*fp
, struct bpf_program
*prog
);
164 static int pcap_setsampling_remote(pcap_t
*fp
);
165 static int pcap_startcapture_remote(pcap_t
*fp
);
166 static int rpcap_recv_msg_header(SOCKET sock
, SSL
*, struct rpcap_header
*header
, char *errbuf
);
167 static int rpcap_check_msg_ver(SOCKET sock
, SSL
*, uint8 expected_ver
, struct rpcap_header
*header
, char *errbuf
);
168 static int rpcap_check_msg_type(SOCKET sock
, SSL
*, uint8 request_type
, struct rpcap_header
*header
, uint16
*errcode
, char *errbuf
);
169 static int rpcap_process_msg_header(SOCKET sock
, SSL
*, uint8 ver
, uint8 request_type
, struct rpcap_header
*header
, char *errbuf
);
170 static int rpcap_recv(SOCKET sock
, SSL
*, void *buffer
, size_t toread
, uint32
*plen
, char *errbuf
);
171 static void rpcap_msg_err(SOCKET sockctrl
, SSL
*, uint32 plen
, char *remote_errbuf
);
172 static int rpcap_discard(SOCKET sock
, SSL
*, uint32 len
, char *errbuf
);
173 static int rpcap_read_packet_msg(struct pcap_rpcap
const *, pcap_t
*p
, size_t size
);
175 /****************************************************
179 ****************************************************/
182 * This function translates (i.e. de-serializes) a 'rpcap_sockaddr'
183 * structure from the network byte order to a 'sockaddr_in" or
184 * 'sockaddr_in6' structure in the host byte order.
186 * It accepts an 'rpcap_sockaddr' structure as it is received from the
187 * network, and checks the address family field against various values
188 * to see whether it looks like an IPv4 address, an IPv6 address, or
189 * neither of those. It checks for multiple values in order to try
190 * to handle older rpcap daemons that sent the native OS's 'sockaddr_in'
191 * or 'sockaddr_in6' structures over the wire with some members
192 * byte-swapped, and to handle the fact that AF_INET6 has different
193 * values on different OSes.
195 * For IPv4 addresses, it converts the address family to host byte
196 * order from network byte order and puts it into the structure,
197 * sets the length if a sockaddr structure has a length, converts the
198 * port number to host byte order from network byte order and puts
199 * it into the structure, copies over the IPv4 address, and zeroes
200 * out the zero padding.
202 * For IPv6 addresses, it converts the address family to host byte
203 * order from network byte order and puts it into the structure,
204 * sets the length if a sockaddr structure has a length, converts the
205 * port number and flow information to host byte order from network
206 * byte order and puts them into the structure, copies over the IPv6
207 * address, and converts the scope ID to host byte order from network
208 * byte order and puts it into the structure.
210 * The function will allocate the 'sockaddrout' variable according to the
211 * address family in use. In case the address does not belong to the
212 * AF_INET nor AF_INET6 families, 'sockaddrout' is not allocated and a
213 * NULL pointer is returned. This usually happens because that address
214 * does not exist on the other host, or is of an address family other
215 * than AF_INET or AF_INET6, so the RPCAP daemon sent a 'sockaddr_storage'
216 * structure containing all 'zero' values.
218 * Older RPCAPDs sent the addresses over the wire in the OS's native
219 * structure format. For most OSes, this looks like the over-the-wire
220 * format, but might have a different value for AF_INET6 than the value
221 * on the machine receiving the reply. For OSes with the newer BSD-style
222 * sockaddr structures, this has, instead of a 2-byte address family,
223 * a 1-byte structure length followed by a 1-byte address family. The
224 * RPCAPD code would put the address family in network byte order before
225 * sending it; that would set it to 0 on a little-endian machine, as
226 * htons() of any value between 1 and 255 would result in a value > 255,
227 * with its lower 8 bits zero, so putting that back into a 1-byte field
230 * Therefore, for older RPCAPDs running on an OS with newer BSD-style
231 * sockaddr structures, the family field, if treated as a big-endian
232 * (network byte order) 16-bit field, would be:
234 * (length << 8) | family if sent by a big-endian machine
235 * (length << 8) if sent by a little-endian machine
237 * For current RPCAPDs, and for older RPCAPDs running on an OS with
238 * older BSD-style sockaddr structures, the family field, if treated
239 * as a big-endian 16-bit field, would just contain the family.
241 * \param sockaddrin: a 'rpcap_sockaddr' pointer to the variable that has
242 * to be de-serialized.
244 * \param sockaddrout: a 'sockaddr_storage' pointer to the variable that will contain
245 * the de-serialized data. The structure returned can be either a 'sockaddr_in' or 'sockaddr_in6'.
246 * This variable will be allocated automatically inside this function.
248 * \param errbuf: a pointer to a user-allocated buffer (of size PCAP_ERRBUF_SIZE)
249 * that will contain the error message (in case there is one).
251 * \return '0' if everything is fine, '-1' if some errors occurred. Basically, the error
252 * can be only the fact that the malloc() failed to allocate memory.
253 * The error message is returned in the 'errbuf' variable, while the deserialized address
254 * is returned into the 'sockaddrout' variable.
256 * \warning This function supports only AF_INET and AF_INET6 address families.
258 * \warning The sockaddrout (if not NULL) must be deallocated by the user.
262 * Possible IPv4 family values other than the designated over-the-wire value,
263 * which is 2 (because everybody uses 2 for AF_INET4).
265 #define SOCKADDR_IN_LEN 16 /* length of struct sockaddr_in */
266 #define SOCKADDR_IN6_LEN 28 /* length of struct sockaddr_in6 */
267 #define NEW_BSD_AF_INET_BE ((SOCKADDR_IN_LEN << 8) | 2)
268 #define NEW_BSD_AF_INET_LE (SOCKADDR_IN_LEN << 8)
271 * Possible IPv6 family values other than the designated over-the-wire value,
272 * which is 23 (because that's what Windows uses, and most RPCAP servers
273 * out there are probably running Windows, as WinPcap includes the server
274 * but few if any UN*Xes build and ship it).
276 * The new BSD sockaddr structure format was in place before 4.4-Lite, so
277 * all the free-software BSDs use it.
279 #define NEW_BSD_AF_INET6_BSD_BE ((SOCKADDR_IN6_LEN << 8) | 24) /* NetBSD, OpenBSD, BSD/OS */
280 #define NEW_BSD_AF_INET6_FREEBSD_BE ((SOCKADDR_IN6_LEN << 8) | 28) /* FreeBSD, DragonFly BSD */
281 #define NEW_BSD_AF_INET6_DARWIN_BE ((SOCKADDR_IN6_LEN << 8) | 30) /* macOS, iOS, anything else Darwin-based */
282 #define NEW_BSD_AF_INET6_LE (SOCKADDR_IN6_LEN << 8)
283 #define LINUX_AF_INET6 10
284 #define HPUX_AF_INET6 22
285 #define AIX_AF_INET6 24
286 #define SOLARIS_AF_INET6 26
289 rpcap_deseraddr(struct rpcap_sockaddr
*sockaddrin
, struct sockaddr_storage
**sockaddrout
, char *errbuf
)
291 /* Warning: we support only AF_INET and AF_INET6 */
292 switch (ntohs(sockaddrin
->family
))
295 case NEW_BSD_AF_INET_BE
:
296 case NEW_BSD_AF_INET_LE
:
298 struct rpcap_sockaddr_in
*sockaddrin_ipv4
;
299 struct sockaddr_in
*sockaddrout_ipv4
;
301 (*sockaddrout
) = (struct sockaddr_storage
*) malloc(sizeof(struct sockaddr_in
));
302 if ((*sockaddrout
) == NULL
)
304 pcap_fmt_errmsg_for_errno(errbuf
, PCAP_ERRBUF_SIZE
,
305 errno
, "malloc() failed");
308 sockaddrin_ipv4
= (struct rpcap_sockaddr_in
*) sockaddrin
;
309 sockaddrout_ipv4
= (struct sockaddr_in
*) (*sockaddrout
);
310 sockaddrout_ipv4
->sin_family
= AF_INET
;
311 sockaddrout_ipv4
->sin_port
= ntohs(sockaddrin_ipv4
->port
);
312 memcpy(&sockaddrout_ipv4
->sin_addr
, &sockaddrin_ipv4
->addr
, sizeof(sockaddrout_ipv4
->sin_addr
));
313 memset(sockaddrout_ipv4
->sin_zero
, 0, sizeof(sockaddrout_ipv4
->sin_zero
));
319 case NEW_BSD_AF_INET6_BSD_BE
:
320 case NEW_BSD_AF_INET6_FREEBSD_BE
:
321 case NEW_BSD_AF_INET6_DARWIN_BE
:
322 case NEW_BSD_AF_INET6_LE
:
326 case SOLARIS_AF_INET6
:
328 struct rpcap_sockaddr_in6
*sockaddrin_ipv6
;
329 struct sockaddr_in6
*sockaddrout_ipv6
;
331 (*sockaddrout
) = (struct sockaddr_storage
*) malloc(sizeof(struct sockaddr_in6
));
332 if ((*sockaddrout
) == NULL
)
334 pcap_fmt_errmsg_for_errno(errbuf
, PCAP_ERRBUF_SIZE
,
335 errno
, "malloc() failed");
338 sockaddrin_ipv6
= (struct rpcap_sockaddr_in6
*) sockaddrin
;
339 sockaddrout_ipv6
= (struct sockaddr_in6
*) (*sockaddrout
);
340 sockaddrout_ipv6
->sin6_family
= AF_INET6
;
341 sockaddrout_ipv6
->sin6_port
= ntohs(sockaddrin_ipv6
->port
);
342 sockaddrout_ipv6
->sin6_flowinfo
= ntohl(sockaddrin_ipv6
->flowinfo
);
343 memcpy(&sockaddrout_ipv6
->sin6_addr
, &sockaddrin_ipv6
->addr
, sizeof(sockaddrout_ipv6
->sin6_addr
));
344 sockaddrout_ipv6
->sin6_scope_id
= ntohl(sockaddrin_ipv6
->scope_id
);
351 * It is neither AF_INET nor AF_INET6 (or, if the OS doesn't
352 * support AF_INET6, it's not AF_INET).
361 * This function reads a packet from the network socket. It does not
362 * deliver the packet to a pcap_dispatch()/pcap_loop() callback (hence
363 * the "nocb" string into its name).
365 * This function is called by pcap_read_rpcap().
367 * WARNING: By choice, this function does not make use of semaphores. A smarter
368 * implementation should put a semaphore into the data thread, and a signal will
369 * be raised as soon as there is data into the socket buffer.
370 * However this is complicated and it does not bring any advantages when reading
371 * from the network, in which network delays can be much more important than
372 * these optimizations. Therefore, we chose the following approach:
373 * - the 'timeout' chosen by the user is split in two (half on the server side,
374 * with the usual meaning, and half on the client side)
375 * - this function checks for packets; if there are no packets, it waits for
376 * timeout/2 and then it checks again. If packets are still missing, it returns,
377 * otherwise it reads packets.
379 static int pcap_read_nocb_remote(pcap_t
*p
, struct pcap_pkthdr
*pkt_header
, u_char
**pkt_data
)
381 struct pcap_rpcap
*pr
= p
->priv
; /* structure used when doing a remote live capture */
382 struct rpcap_header
*header
; /* general header according to the RPCAP format */
383 struct rpcap_pkthdr
*net_pkt_header
; /* header of the packet, from the message */
384 u_char
*net_pkt_data
; /* packet data from the message */
386 int retval
= 0; /* generic return value */
389 /* Structures needed for the select() call */
390 struct timeval tv
; /* maximum time the select() can block waiting for data */
391 fd_set rfds
; /* set of socket descriptors we have to check */
394 * Define the packet buffer timeout, to be used in the select()
395 * 'timeout', in pcap_t, is in milliseconds; we have to convert it into sec and microsec
397 tv
.tv_sec
= p
->opt
.timeout
/ 1000;
398 tv
.tv_usec
= (suseconds_t
)((p
->opt
.timeout
- tv
.tv_sec
* 1000) * 1000);
401 /* Check if we still have bytes available in the last decoded TLS record.
402 * If that's the case, we know SSL_read will not block. */
403 retval
= pr
->data_ssl
&& SSL_pending(pr
->data_ssl
) > 0;
407 /* Watch out sockdata to see if it has input */
411 * 'fp->rmt_sockdata' has always to be set before calling the select(),
412 * since it is cleared by the select()
414 FD_SET(pr
->rmt_sockdata
, &rfds
);
416 retval
= select((int) pr
->rmt_sockdata
+ 1, &rfds
, NULL
, NULL
, &tv
);
427 sock_geterror("select()", p
->errbuf
, PCAP_ERRBUF_SIZE
);
432 /* There is no data waiting, so return '0' */
437 * We have to define 'header' as a pointer to a larger buffer,
438 * because in case of UDP we have to read all the message within a single call
440 header
= (struct rpcap_header
*) p
->buffer
;
441 net_pkt_header
= (struct rpcap_pkthdr
*) ((char *)p
->buffer
+ sizeof(struct rpcap_header
));
442 net_pkt_data
= (u_char
*)p
->buffer
+ sizeof(struct rpcap_header
) + sizeof(struct rpcap_pkthdr
);
444 if (pr
->rmt_flags
& PCAP_OPENFLAG_DATATX_UDP
)
446 /* Read the entire message from the network */
447 msglen
= sock_recv_dgram(pr
->rmt_sockdata
, pr
->data_ssl
, p
->buffer
,
448 p
->bufsize
, p
->errbuf
, PCAP_ERRBUF_SIZE
);
456 /* Interrupted receive. */
459 if ((size_t)msglen
< sizeof(struct rpcap_header
))
462 * Message is shorter than an rpcap header.
464 snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
465 "UDP packet message is shorter than an rpcap header");
468 plen
= ntohl(header
->plen
);
469 if ((size_t)msglen
< sizeof(struct rpcap_header
) + plen
)
472 * Message is shorter than the header claims it
475 snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
476 "UDP packet message is shorter than its rpcap header claims");
484 if ((size_t)p
->cc
< sizeof(struct rpcap_header
))
487 * We haven't read any of the packet header yet.
488 * The size we should get is the size of the
491 status
= rpcap_read_packet_msg(pr
, p
, sizeof(struct rpcap_header
));
499 /* Interrupted receive. */
505 * We have the header, so we know how long the
506 * message payload is. The size we should get
507 * is the size of the packet header plus the
508 * size of the payload.
510 plen
= ntohl(header
->plen
);
511 if (plen
> p
->bufsize
- sizeof(struct rpcap_header
))
514 * This is bigger than the largest
515 * record we'd expect. (We do it by
516 * subtracting in order to avoid an
519 snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
520 "Server sent us a message larger than the largest expected packet message");
523 status
= rpcap_read_packet_msg(pr
, p
, sizeof(struct rpcap_header
) + plen
);
531 /* Interrupted receive. */
536 * We have the entire message; reset the buffer pointer
537 * and count, as the next read should start a new
545 * We have the entire message.
550 * Did the server specify the version we negotiated?
552 if (rpcap_check_msg_ver(pr
->rmt_sockdata
, pr
->data_ssl
, pr
->protocol_version
,
553 header
, p
->errbuf
) == -1)
555 return 0; /* Return 'no packets received' */
559 * Is this a RPCAP_MSG_PACKET message?
561 if (header
->type
!= RPCAP_MSG_PACKET
)
563 return 0; /* Return 'no packets received' */
566 if (ntohl(net_pkt_header
->caplen
) > plen
)
568 snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
569 "Packet's captured data goes past the end of the received packet message.");
573 /* Fill in packet header */
574 pkt_header
->caplen
= ntohl(net_pkt_header
->caplen
);
575 pkt_header
->len
= ntohl(net_pkt_header
->len
);
576 pkt_header
->ts
.tv_sec
= ntohl(net_pkt_header
->timestamp_sec
);
577 pkt_header
->ts
.tv_usec
= ntohl(net_pkt_header
->timestamp_usec
);
579 /* Supply a pointer to the beginning of the packet data */
580 *pkt_data
= net_pkt_data
;
583 * I don't update the counter of the packets dropped by the network since we're using TCP,
584 * therefore no packets are dropped. Just update the number of packets received correctly
588 if (pr
->rmt_flags
& PCAP_OPENFLAG_DATATX_UDP
)
592 /* We're using UDP, so we need to update the counter of the packets dropped by the network */
593 npkt
= ntohl(net_pkt_header
->npkt
);
595 if (pr
->TotCapt
!= npkt
)
597 pr
->TotNetDrops
+= (npkt
- pr
->TotCapt
);
602 /* Packet read successfully */
607 * This function reads a packet from the network socket.
609 * This function relies on the pcap_read_nocb_remote to deliver packets. The
610 * difference, here, is that as soon as a packet is read, it is delivered
611 * to the application by means of a callback function.
613 static int pcap_read_rpcap(pcap_t
*p
, int cnt
, pcap_handler callback
, u_char
*user
)
615 struct pcap_rpcap
*pr
= p
->priv
; /* structure used when doing a remote live capture */
616 struct pcap_pkthdr pkt_header
;
622 * If this is client-side, and we haven't already started
623 * the capture, start it now.
625 if (pr
->rmt_clientside
)
627 /* We are on an remote capture */
628 if (!pr
->rmt_capstarted
)
631 * The capture isn't started yet, so try to
634 if (pcap_startcapture_remote(p
))
639 while (n
< cnt
|| PACKET_COUNT_IS_UNLIMITED(cnt
))
642 * Has "pcap_breakloop()" been called?
646 * Yes - clear the flag that indicates that it
647 * has, and return PCAP_ERROR_BREAK to indicate
648 * that we were told to break out of the loop.
651 return (PCAP_ERROR_BREAK
);
657 ret
= pcap_read_nocb_remote(p
, &pkt_header
, &pkt_data
);
661 * We got a packet. Hand it to the callback
662 * and count it so we can return the count.
664 (*callback
)(user
, &pkt_header
, pkt_data
);
675 * No packet; this could mean that we timed
676 * out, or that we got interrupted, or that
677 * we got a bad packet.
679 * Were we told to break out of the loop?
686 return (PCAP_ERROR_BREAK
);
688 /* No - return the number of packets we've processed. */
696 * This function sends a CLOSE command to the capture server if we're in
697 * passive mode and an ENDCAP command to the capture server if we're in
700 * It is called when the user calls pcap_close(). It sends a command
701 * to our peer that says 'ok, let's stop capturing'.
703 * WARNING: Since we're closing the connection, we do not check for errors.
705 static void pcap_cleanup_rpcap(pcap_t
*fp
)
707 struct pcap_rpcap
*pr
= fp
->priv
; /* structure used when doing a remote live capture */
708 struct rpcap_header header
; /* header of the RPCAP packet */
709 struct activehosts
*temp
; /* temp var needed to scan the host list chain, to detect if we're in active mode */
710 int active
= 0; /* active mode or not? */
712 /* detect if we're in active mode */
716 if (temp
->sockctrl
== pr
->rmt_sockctrl
)
726 rpcap_createhdr(&header
, pr
->protocol_version
,
727 RPCAP_MSG_CLOSE
, 0, 0);
730 * Send the close request; don't report any errors, as
731 * we're closing this pcap_t, and have no place to report
732 * the error. No reply is sent to this message.
734 (void)sock_send(pr
->rmt_sockctrl
, pr
->ctrl_ssl
, (char *)&header
,
735 sizeof(struct rpcap_header
), NULL
, 0);
739 rpcap_createhdr(&header
, pr
->protocol_version
,
740 RPCAP_MSG_ENDCAP_REQ
, 0, 0);
743 * Send the end capture request; don't report any errors,
744 * as we're closing this pcap_t, and have no place to
747 if (sock_send(pr
->rmt_sockctrl
, pr
->ctrl_ssl
, (char *)&header
,
748 sizeof(struct rpcap_header
), NULL
, 0) == 0)
751 * Wait for the answer; don't report any errors,
752 * as we're closing this pcap_t, and have no
753 * place to report the error.
755 if (rpcap_process_msg_header(pr
->rmt_sockctrl
, pr
->ctrl_ssl
,
756 pr
->protocol_version
, RPCAP_MSG_ENDCAP_REQ
,
759 (void)rpcap_discard(pr
->rmt_sockctrl
, pr
->ctrl_ssl
,
765 if (pr
->rmt_sockdata
)
770 // Finish using the SSL handle for the data socket.
771 // This must be done *before* the socket is closed.
772 ssl_finish(pr
->data_ssl
);
776 sock_close(pr
->rmt_sockdata
, NULL
, 0);
777 pr
->rmt_sockdata
= 0;
780 if ((!active
) && (pr
->rmt_sockctrl
))
785 // Finish using the SSL handle for the control socket.
786 // This must be done *before* the socket is closed.
787 ssl_finish(pr
->ctrl_ssl
);
791 sock_close(pr
->rmt_sockctrl
, NULL
, 0);
794 pr
->rmt_sockctrl
= 0;
797 if (pr
->currentfilter
)
799 free(pr
->currentfilter
);
800 pr
->currentfilter
= NULL
;
803 pcap_cleanup_live_common(fp
);
805 /* To avoid inconsistencies in the number of sock_init() */
810 * This function retrieves network statistics from our peer;
811 * it provides only the standard statistics.
813 static int pcap_stats_rpcap(pcap_t
*p
, struct pcap_stat
*ps
)
815 struct pcap_stat
*retval
;
817 retval
= rpcap_stats_rpcap(p
, ps
, PCAP_STATS_STANDARD
);
827 * This function retrieves network statistics from our peer;
828 * it provides the additional statistics supported by pcap_stats_ex().
830 static struct pcap_stat
*pcap_stats_ex_rpcap(pcap_t
*p
, int *pcap_stat_size
)
832 *pcap_stat_size
= sizeof (p
->stat
);
834 /* PCAP_STATS_EX (third param) means 'extended pcap_stats()' */
835 return (rpcap_stats_rpcap(p
, &(p
->stat
), PCAP_STATS_EX
));
840 * This function retrieves network statistics from our peer. It
841 * is used by the two previous functions.
843 * It can be called in two modes:
844 * - PCAP_STATS_STANDARD: if we want just standard statistics (i.e.,
846 * - PCAP_STATS_EX: if we want extended statistics (i.e., for
849 * This 'mode' parameter is needed because in pcap_stats() the variable that
850 * keeps the statistics is allocated by the user. On Windows, this structure
851 * has been extended in order to keep new stats. However, if the user has a
852 * smaller structure and it passes it to pcap_stats(), this function will
853 * try to fill in more data than the size of the structure, so that memory
854 * after the structure will be overwritten.
856 * So, we need to know it we have to copy just the standard fields, or the
857 * extended fields as well.
859 * In case we want to copy the extended fields as well, the problem of
860 * memory overflow no longer exists because the structure that's filled
861 * in is part of the pcap_t, so that it can be guaranteed to be large
862 * enough for the additional statistics.
864 * \param p: the pcap_t structure related to the current instance.
866 * \param ps: a pointer to a 'pcap_stat' structure, needed for compatibility
867 * with pcap_stat(), where the structure is allocated by the user. In case
868 * of pcap_stats_ex(), this structure and the function return value point
869 * to the same variable.
871 * \param mode: one of PCAP_STATS_STANDARD or PCAP_STATS_EX.
873 * \return The structure that keeps the statistics, or NULL in case of error.
874 * The error string is placed in the pcap_t structure.
876 static struct pcap_stat
*rpcap_stats_rpcap(pcap_t
*p
, struct pcap_stat
*ps
, int mode
)
878 struct pcap_rpcap
*pr
= p
->priv
; /* structure used when doing a remote live capture */
879 struct rpcap_header header
; /* header of the RPCAP packet */
880 struct rpcap_stats netstats
; /* statistics sent on the network */
881 uint32 plen
; /* data remaining in the message */
884 if (mode
!= PCAP_STATS_STANDARD
&& mode
!= PCAP_STATS_EX
)
886 if (mode
!= PCAP_STATS_STANDARD
)
889 snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
890 "Invalid stats mode %d", mode
);
895 * If the capture has not yet started, we cannot request statistics
896 * for the capture from our peer, so we return 0 for all statistics,
897 * as nothing's been seen yet.
899 if (!pr
->rmt_capstarted
)
905 if (mode
== PCAP_STATS_EX
)
916 rpcap_createhdr(&header
, pr
->protocol_version
,
917 RPCAP_MSG_STATS_REQ
, 0, 0);
919 /* Send the PCAP_STATS command */
920 if (sock_send(pr
->rmt_sockctrl
, pr
->ctrl_ssl
, (char *)&header
,
921 sizeof(struct rpcap_header
), p
->errbuf
, PCAP_ERRBUF_SIZE
) < 0)
922 return NULL
; /* Unrecoverable network error */
924 /* Receive and process the reply message header. */
925 if (rpcap_process_msg_header(pr
->rmt_sockctrl
, pr
->ctrl_ssl
, pr
->protocol_version
,
926 RPCAP_MSG_STATS_REQ
, &header
, p
->errbuf
) == -1)
927 return NULL
; /* Error */
931 /* Read the reply body */
932 if (rpcap_recv(pr
->rmt_sockctrl
, pr
->ctrl_ssl
, (char *)&netstats
,
933 sizeof(struct rpcap_stats
), &plen
, p
->errbuf
) == -1)
936 ps
->ps_drop
= ntohl(netstats
.krnldrop
);
937 ps
->ps_ifdrop
= ntohl(netstats
.ifdrop
);
938 ps
->ps_recv
= ntohl(netstats
.ifrecv
);
940 if (mode
== PCAP_STATS_EX
)
942 ps
->ps_capt
= pr
->TotCapt
;
943 ps
->ps_netdrop
= pr
->TotNetDrops
;
944 ps
->ps_sent
= ntohl(netstats
.svrcapt
);
948 /* Discard the rest of the message. */
949 if (rpcap_discard(pr
->rmt_sockctrl
, pr
->ctrl_ssl
, plen
, p
->errbuf
) == -1)
950 goto error_nodiscard
;
956 * Discard the rest of the message.
957 * We already reported an error; if this gets an error, just
960 (void)rpcap_discard(pr
->rmt_sockctrl
, pr
->ctrl_ssl
, plen
, NULL
);
967 * This function returns the entry in the list of active hosts for this
968 * active connection (active mode only), or NULL if there is no
969 * active connection or an error occurred. It is just for internal
972 * \param host: a string that keeps the host name of the host for which we
973 * want to get the socket ID for that active connection.
975 * \param error: a pointer to an int that is set to 1 if an error occurred
978 * \param errbuf: a pointer to a user-allocated buffer (of size
979 * PCAP_ERRBUF_SIZE) that will contain the error message (in case
982 * \return the entry for this host in the list of active connections
983 * if found, NULL if it's not found or there's an error.
985 static struct activehosts
*
986 rpcap_remoteact_getsock(const char *host
, int *error
, char *errbuf
)
988 struct activehosts
*temp
; /* temp var needed to scan the host list chain */
989 struct addrinfo hints
, *addrinfo
, *ai_next
; /* temp var needed to translate between hostname to its address */
992 /* retrieve the network address corresponding to 'host' */
994 memset(&hints
, 0, sizeof(struct addrinfo
));
995 hints
.ai_family
= PF_UNSPEC
;
996 hints
.ai_socktype
= SOCK_STREAM
;
998 retval
= getaddrinfo(host
, "0", &hints
, &addrinfo
);
1001 snprintf(errbuf
, PCAP_ERRBUF_SIZE
, "getaddrinfo() %s",
1002 gai_strerror(retval
));
1014 if (sock_cmpaddr(&temp
->host
, (struct sockaddr_storage
*) ai_next
->ai_addr
) == 0)
1017 freeaddrinfo(addrinfo
);
1021 ai_next
= ai_next
->ai_next
;
1027 freeaddrinfo(addrinfo
);
1030 * The host for which you want to get the socket ID does not have an
1031 * active connection.
1038 * This function starts a remote capture.
1040 * This function is required since the RPCAP protocol decouples the 'open'
1041 * from the 'start capture' functions.
1042 * This function takes all the parameters needed (which have been stored
1043 * into the pcap_t structure) and sends them to the server.
1045 * \param fp: the pcap_t descriptor of the device currently open.
1047 * \return '0' if everything is fine, '-1' otherwise. The error message
1048 * (if one) is returned into the 'errbuf' field of the pcap_t structure.
1050 static int pcap_startcapture_remote(pcap_t
*fp
)
1052 struct pcap_rpcap
*pr
= fp
->priv
; /* structure used when doing a remote live capture */
1053 char sendbuf
[RPCAP_NETBUF_SIZE
]; /* temporary buffer in which data to be sent is buffered */
1054 int sendbufidx
= 0; /* index which keeps the number of bytes currently buffered */
1055 char portdata
[PCAP_BUF_SIZE
]; /* temp variable needed to keep the network port for the data connection */
1057 int active
= 0; /* '1' if we're in active mode */
1058 struct activehosts
*temp
; /* temp var needed to scan the host list chain, to detect if we're in active mode */
1059 char host
[INET6_ADDRSTRLEN
+ 1]; /* numeric name of the other host */
1061 /* socket-related variables*/
1062 struct addrinfo hints
; /* temp, needed to open a socket connection */
1063 struct addrinfo
*addrinfo
; /* temp, needed to open a socket connection */
1064 SOCKET sockdata
= 0; /* socket descriptor of the data connection */
1065 struct sockaddr_storage saddr
; /* temp, needed to retrieve the network data port chosen on the local machine */
1066 socklen_t saddrlen
; /* temp, needed to retrieve the network data port chosen on the local machine */
1067 int ai_family
; /* temp, keeps the address family used by the control connection */
1069 /* RPCAP-related variables*/
1070 struct rpcap_header header
; /* header of the RPCAP packet */
1071 struct rpcap_startcapreq
*startcapreq
; /* start capture request message */
1072 struct rpcap_startcapreply startcapreply
; /* start capture reply message */
1074 /* Variables related to the buffer setting */
1077 int sockbufsize
= 0;
1078 uint32 server_sockbufsize
;
1080 // Take the opportunity to clear pr->data_ssl before any goto error,
1081 // as it seems pr->priv is not zeroed after its malloced.
1082 pr
->data_ssl
= NULL
;
1085 * Let's check if sampling has been required.
1086 * If so, let's set it first
1088 if (pcap_setsampling_remote(fp
) != 0)
1091 /* detect if we're in active mode */
1095 if (temp
->sockctrl
== pr
->rmt_sockctrl
)
1106 * Gets the complete sockaddr structure used in the ctrl connection
1107 * This is needed to get the address family of the control socket
1108 * Tip: I cannot save the ai_family of the ctrl sock in the pcap_t struct,
1109 * since the ctrl socket can already be open in case of active mode;
1110 * so I would have to call getpeername() anyway
1112 saddrlen
= sizeof(struct sockaddr_storage
);
1113 if (getpeername(pr
->rmt_sockctrl
, (struct sockaddr
*) &saddr
, &saddrlen
) == -1)
1115 sock_geterror("getsockname()", fp
->errbuf
, PCAP_ERRBUF_SIZE
);
1116 goto error_nodiscard
;
1118 ai_family
= ((struct sockaddr_storage
*) &saddr
)->ss_family
;
1120 /* Get the numeric address of the remote host we are connected to */
1121 if (getnameinfo((struct sockaddr
*) &saddr
, saddrlen
, host
,
1122 sizeof(host
), NULL
, 0, NI_NUMERICHOST
))
1124 sock_geterror("getnameinfo()", fp
->errbuf
, PCAP_ERRBUF_SIZE
);
1125 goto error_nodiscard
;
1129 * Data connection is opened by the server toward the client if:
1130 * - we're using TCP, and the user wants us to be in active mode
1133 if ((active
) || (pr
->rmt_flags
& PCAP_OPENFLAG_DATATX_UDP
))
1136 * We have to create a new socket to receive packets
1137 * We have to do that immediately, since we have to tell the other
1138 * end which network port we picked up
1140 memset(&hints
, 0, sizeof(struct addrinfo
));
1141 /* TEMP addrinfo is NULL in case of active */
1142 hints
.ai_family
= ai_family
; /* Use the same address family of the control socket */
1143 hints
.ai_socktype
= (pr
->rmt_flags
& PCAP_OPENFLAG_DATATX_UDP
) ? SOCK_DGRAM
: SOCK_STREAM
;
1144 hints
.ai_flags
= AI_PASSIVE
; /* Data connection is opened by the server toward the client */
1146 /* Let's the server pick up a free network port for us */
1147 if (sock_initaddress(NULL
, "0", &hints
, &addrinfo
, fp
->errbuf
, PCAP_ERRBUF_SIZE
) == -1)
1148 goto error_nodiscard
;
1150 if ((sockdata
= sock_open(addrinfo
, SOCKOPEN_SERVER
,
1151 1 /* max 1 connection in queue */, fp
->errbuf
, PCAP_ERRBUF_SIZE
)) == INVALID_SOCKET
)
1152 goto error_nodiscard
;
1154 /* addrinfo is no longer used */
1155 freeaddrinfo(addrinfo
);
1158 /* get the complete sockaddr structure used in the data connection */
1159 saddrlen
= sizeof(struct sockaddr_storage
);
1160 if (getsockname(sockdata
, (struct sockaddr
*) &saddr
, &saddrlen
) == -1)
1162 sock_geterror("getsockname()", fp
->errbuf
, PCAP_ERRBUF_SIZE
);
1163 goto error_nodiscard
;
1166 /* Get the local port the system picked up */
1167 if (getnameinfo((struct sockaddr
*) &saddr
, saddrlen
, NULL
,
1168 0, portdata
, sizeof(portdata
), NI_NUMERICSERV
))
1170 sock_geterror("getnameinfo()", fp
->errbuf
, PCAP_ERRBUF_SIZE
);
1171 goto error_nodiscard
;
1176 * Now it's time to start playing with the RPCAP protocol
1177 * RPCAP start capture command: create the request message
1179 if (sock_bufferize(NULL
, sizeof(struct rpcap_header
), NULL
,
1180 &sendbufidx
, RPCAP_NETBUF_SIZE
, SOCKBUF_CHECKONLY
, fp
->errbuf
, PCAP_ERRBUF_SIZE
))
1181 goto error_nodiscard
;
1183 rpcap_createhdr((struct rpcap_header
*) sendbuf
,
1184 pr
->protocol_version
, RPCAP_MSG_STARTCAP_REQ
, 0,
1185 sizeof(struct rpcap_startcapreq
) + sizeof(struct rpcap_filter
) + fp
->fcode
.bf_len
* sizeof(struct rpcap_filterbpf_insn
));
1187 /* Fill the structure needed to open an adapter remotely */
1188 startcapreq
= (struct rpcap_startcapreq
*) &sendbuf
[sendbufidx
];
1190 if (sock_bufferize(NULL
, sizeof(struct rpcap_startcapreq
), NULL
,
1191 &sendbufidx
, RPCAP_NETBUF_SIZE
, SOCKBUF_CHECKONLY
, fp
->errbuf
, PCAP_ERRBUF_SIZE
))
1192 goto error_nodiscard
;
1194 memset(startcapreq
, 0, sizeof(struct rpcap_startcapreq
));
1196 /* By default, apply half the timeout on one side, half of the other */
1197 fp
->opt
.timeout
= fp
->opt
.timeout
/ 2;
1198 startcapreq
->read_timeout
= htonl(fp
->opt
.timeout
);
1200 /* portdata on the openreq is meaningful only if we're in active mode */
1201 if ((active
) || (pr
->rmt_flags
& PCAP_OPENFLAG_DATATX_UDP
))
1203 sscanf(portdata
, "%d", (int *)&(startcapreq
->portdata
)); /* cast to avoid a compiler warning */
1204 startcapreq
->portdata
= htons(startcapreq
->portdata
);
1207 startcapreq
->snaplen
= htonl(fp
->snapshot
);
1208 startcapreq
->flags
= 0;
1210 if (pr
->rmt_flags
& PCAP_OPENFLAG_PROMISCUOUS
)
1211 startcapreq
->flags
|= RPCAP_STARTCAPREQ_FLAG_PROMISC
;
1212 if (pr
->rmt_flags
& PCAP_OPENFLAG_DATATX_UDP
)
1213 startcapreq
->flags
|= RPCAP_STARTCAPREQ_FLAG_DGRAM
;
1215 startcapreq
->flags
|= RPCAP_STARTCAPREQ_FLAG_SERVEROPEN
;
1217 startcapreq
->flags
= htons(startcapreq
->flags
);
1219 /* Pack the capture filter */
1220 if (pcap_pack_bpffilter(fp
, &sendbuf
[sendbufidx
], &sendbufidx
, &fp
->fcode
))
1221 goto error_nodiscard
;
1223 if (sock_send(pr
->rmt_sockctrl
, pr
->ctrl_ssl
, sendbuf
, sendbufidx
, fp
->errbuf
,
1224 PCAP_ERRBUF_SIZE
) < 0)
1225 goto error_nodiscard
;
1227 /* Receive and process the reply message header. */
1228 if (rpcap_process_msg_header(pr
->rmt_sockctrl
, pr
->ctrl_ssl
, pr
->protocol_version
,
1229 RPCAP_MSG_STARTCAP_REQ
, &header
, fp
->errbuf
) == -1)
1230 goto error_nodiscard
;
1234 if (rpcap_recv(pr
->rmt_sockctrl
, pr
->ctrl_ssl
, (char *)&startcapreply
,
1235 sizeof(struct rpcap_startcapreply
), &plen
, fp
->errbuf
) == -1)
1239 * In case of UDP data stream, the connection is always opened by the daemon
1240 * So, this case is already covered by the code above.
1241 * Now, we have still to handle TCP connections, because:
1242 * - if we're in active mode, we have to wait for a remote connection
1243 * - if we're in passive more, we have to start a connection
1245 * We have to do he job in two steps because in case we're opening a TCP connection, we have
1246 * to tell the port we're using to the remote side; in case we're accepting a TCP
1247 * connection, we have to wait this info from the remote side.
1249 if (!(pr
->rmt_flags
& PCAP_OPENFLAG_DATATX_UDP
))
1253 memset(&hints
, 0, sizeof(struct addrinfo
));
1254 hints
.ai_family
= ai_family
; /* Use the same address family of the control socket */
1255 hints
.ai_socktype
= (pr
->rmt_flags
& PCAP_OPENFLAG_DATATX_UDP
) ? SOCK_DGRAM
: SOCK_STREAM
;
1256 snprintf(portdata
, PCAP_BUF_SIZE
, "%d", ntohs(startcapreply
.portdata
));
1258 /* Let's the server pick up a free network port for us */
1259 if (sock_initaddress(host
, portdata
, &hints
, &addrinfo
, fp
->errbuf
, PCAP_ERRBUF_SIZE
) == -1)
1262 if ((sockdata
= sock_open(addrinfo
, SOCKOPEN_CLIENT
, 0, fp
->errbuf
, PCAP_ERRBUF_SIZE
)) == INVALID_SOCKET
)
1265 /* addrinfo is no longer used */
1266 freeaddrinfo(addrinfo
);
1271 SOCKET socktemp
; /* We need another socket, since we're going to accept() a connection */
1273 /* Connection creation */
1274 saddrlen
= sizeof(struct sockaddr_storage
);
1276 socktemp
= accept(sockdata
, (struct sockaddr
*) &saddr
, &saddrlen
);
1278 if (socktemp
== INVALID_SOCKET
)
1280 sock_geterror("accept()", fp
->errbuf
, PCAP_ERRBUF_SIZE
);
1284 /* Now that I accepted the connection, the server socket is no longer needed */
1285 sock_close(sockdata
, fp
->errbuf
, PCAP_ERRBUF_SIZE
);
1286 sockdata
= socktemp
;
1290 /* Let's save the socket of the data connection */
1291 pr
->rmt_sockdata
= sockdata
;
1296 pr
->data_ssl
= ssl_promotion(0, sockdata
, fp
->errbuf
, PCAP_ERRBUF_SIZE
);
1297 if (! pr
->data_ssl
) goto error
;
1302 * Set the size of the socket buffer for the data socket.
1303 * It has the same size as the local capture buffer used
1304 * on the other side of the connection.
1306 server_sockbufsize
= ntohl(startcapreply
.bufsize
);
1308 /* Let's get the actual size of the socket buffer */
1309 itemp
= sizeof(sockbufsize
);
1311 res
= getsockopt(sockdata
, SOL_SOCKET
, SO_RCVBUF
, (char *)&sockbufsize
, &itemp
);
1314 sock_geterror("pcap_startcapture_remote(): getsockopt() failed", fp
->errbuf
, PCAP_ERRBUF_SIZE
);
1319 * Warning: on some kernels (e.g. Linux), the size of the user
1320 * buffer does not take into account the pcap_header and such,
1321 * and it is set equal to the snaplen.
1323 * In my view, this is wrong (the meaning of the bufsize became
1324 * a bit strange). So, here bufsize is the whole size of the
1325 * user buffer. In case the bufsize returned is too small,
1326 * let's adjust it accordingly.
1328 if (server_sockbufsize
<= (u_int
) fp
->snapshot
)
1329 server_sockbufsize
+= sizeof(struct pcap_pkthdr
);
1331 /* if the current socket buffer is smaller than the desired one */
1332 if ((u_int
) sockbufsize
< server_sockbufsize
)
1335 * Loop until the buffer size is OK or the original
1336 * socket buffer size is larger than this one.
1340 res
= setsockopt(sockdata
, SOL_SOCKET
, SO_RCVBUF
,
1341 (char *)&(server_sockbufsize
),
1342 sizeof(server_sockbufsize
));
1348 * If something goes wrong, halve the buffer size
1349 * (checking that it does not become smaller than
1352 server_sockbufsize
/= 2;
1354 if ((u_int
) sockbufsize
>= server_sockbufsize
)
1356 server_sockbufsize
= sockbufsize
;
1363 * Let's allocate the packet; this is required in order to put
1364 * the packet somewhere when extracting data from the socket.
1365 * Since buffering has already been done in the socket buffer,
1366 * here we need just a buffer whose size is equal to the
1367 * largest possible packet message for the snapshot size,
1368 * namely the length of the message header plus the length
1369 * of the packet header plus the snapshot length.
1371 fp
->bufsize
= sizeof(struct rpcap_header
) + sizeof(struct rpcap_pkthdr
) + fp
->snapshot
;
1373 fp
->buffer
= (u_char
*)malloc(fp
->bufsize
);
1374 if (fp
->buffer
== NULL
)
1376 pcap_fmt_errmsg_for_errno(fp
->errbuf
, PCAP_ERRBUF_SIZE
,
1382 * The buffer is currently empty.
1384 fp
->bp
= fp
->buffer
;
1387 /* Discard the rest of the message. */
1388 if (rpcap_discard(pr
->rmt_sockctrl
, pr
->ctrl_ssl
, plen
, fp
->errbuf
) == -1)
1389 goto error_nodiscard
;
1392 * In case the user does not want to capture RPCAP packets, let's update the filter
1393 * We have to update it here (instead of sending it into the 'StartCapture' message
1394 * because when we generate the 'start capture' we do not know (yet) all the ports
1395 * we're currently using.
1397 if (pr
->rmt_flags
& PCAP_OPENFLAG_NOCAPTURE_RPCAP
)
1399 struct bpf_program fcode
;
1401 if (pcap_createfilter_norpcappkt(fp
, &fcode
) == -1)
1404 /* We cannot use 'pcap_setfilter_rpcap' because formally the capture has not been started yet */
1405 /* (the 'pr->rmt_capstarted' variable will be updated some lines below) */
1406 if (pcap_updatefilter_remote(fp
, &fcode
) == -1)
1409 pcap_freecode(&fcode
);
1412 pr
->rmt_capstarted
= 1;
1417 * When the connection has been established, we have to close it. So, at the
1418 * beginning of this function, if an error occur we return immediately with
1419 * a return NULL; when the connection is established, we have to come here
1420 * ('goto error;') in order to close everything properly.
1424 * Discard the rest of the message.
1425 * We already reported an error; if this gets an error, just
1428 (void)rpcap_discard(pr
->rmt_sockctrl
, pr
->ctrl_ssl
, plen
, NULL
);
1434 // Finish using the SSL handle for the data socket.
1435 // This must be done *before* the socket is closed.
1436 ssl_finish(pr
->data_ssl
);
1437 pr
->data_ssl
= NULL
;
1441 if ((sockdata
) && (sockdata
!= -1)) /* we can be here because sockdata said 'error' */
1442 sock_close(sockdata
, NULL
, 0);
1449 // Finish using the SSL handle for the control socket.
1450 // This must be done *before* the socket is closed.
1451 ssl_finish(pr
->ctrl_ssl
);
1452 pr
->ctrl_ssl
= NULL
;
1455 sock_close(pr
->rmt_sockctrl
, NULL
, 0);
1458 if (addrinfo
!= NULL
)
1459 freeaddrinfo(addrinfo
);
1462 * We do not have to call pcap_close() here, because this function is always called
1463 * by the user in case something bad happens
1477 * This function takes a bpf program and sends it to the other host.
1479 * This function can be called in two cases:
1480 * - pcap_startcapture_remote() is called (we have to send the filter
1481 * along with the 'start capture' command)
1482 * - we want to udpate the filter during a capture (i.e. pcap_setfilter()
1483 * after the capture has been started)
1485 * This function serializes the filter into the sending buffer ('sendbuf',
1486 * passed as a parameter) and return back. It does not send anything on
1489 * \param fp: the pcap_t descriptor of the device currently opened.
1491 * \param sendbuf: the buffer on which the serialized data has to copied.
1493 * \param sendbufidx: it is used to return the abounf of bytes copied into the buffer.
1495 * \param prog: the bpf program we have to copy.
1497 * \return '0' if everything is fine, '-1' otherwise. The error message (if one)
1498 * is returned into the 'errbuf' field of the pcap_t structure.
1500 static int pcap_pack_bpffilter(pcap_t
*fp
, char *sendbuf
, int *sendbufidx
, struct bpf_program
*prog
)
1502 struct rpcap_filter
*filter
;
1503 struct rpcap_filterbpf_insn
*insn
;
1504 struct bpf_insn
*bf_insn
;
1505 struct bpf_program fake_prog
; /* To be used just in case the user forgot to set a filter */
1508 if (prog
->bf_len
== 0) /* No filters have been specified; so, let's apply a "fake" filter */
1510 if (pcap_compile(fp
, &fake_prog
, NULL
/* buffer */, 1, 0) == -1)
1516 filter
= (struct rpcap_filter
*) sendbuf
;
1518 if (sock_bufferize(NULL
, sizeof(struct rpcap_filter
), NULL
, sendbufidx
,
1519 RPCAP_NETBUF_SIZE
, SOCKBUF_CHECKONLY
, fp
->errbuf
, PCAP_ERRBUF_SIZE
))
1522 filter
->filtertype
= htons(RPCAP_UPDATEFILTER_BPF
);
1523 filter
->nitems
= htonl((int32
)prog
->bf_len
);
1525 if (sock_bufferize(NULL
, prog
->bf_len
* sizeof(struct rpcap_filterbpf_insn
),
1526 NULL
, sendbufidx
, RPCAP_NETBUF_SIZE
, SOCKBUF_CHECKONLY
, fp
->errbuf
, PCAP_ERRBUF_SIZE
))
1529 insn
= (struct rpcap_filterbpf_insn
*) (filter
+ 1);
1530 bf_insn
= prog
->bf_insns
;
1532 for (i
= 0; i
< prog
->bf_len
; i
++)
1534 insn
->code
= htons(bf_insn
->code
);
1535 insn
->jf
= bf_insn
->jf
;
1536 insn
->jt
= bf_insn
->jt
;
1537 insn
->k
= htonl(bf_insn
->k
);
1547 * This function updates a filter on a remote host.
1549 * It is called when the user wants to update a filter.
1550 * In case we're capturing from the network, it sends the filter to our
1552 * This function is *not* called automatically when the user calls
1554 * There will be two cases:
1555 * - the capture has been started: in this case, pcap_setfilter_rpcap()
1556 * calls pcap_updatefilter_remote()
1557 * - the capture has not started yet: in this case, pcap_setfilter_rpcap()
1558 * stores the filter into the pcap_t structure, and then the filter is
1559 * sent with pcap_startcap().
1561 * WARNING This function *does not* clear the packet currently into the
1562 * buffers. Therefore, the user has to expect to receive some packets
1563 * that are related to the previous filter. If you want to discard all
1564 * the packets before applying a new filter, you have to close the
1565 * current capture session and start a new one.
1567 * XXX - we really should have pcap_setfilter() always discard packets
1568 * received with the old filter, and have a separate pcap_setfilter_noflush()
1569 * function that doesn't discard any packets.
1571 static int pcap_updatefilter_remote(pcap_t
*fp
, struct bpf_program
*prog
)
1573 struct pcap_rpcap
*pr
= fp
->priv
; /* structure used when doing a remote live capture */
1574 char sendbuf
[RPCAP_NETBUF_SIZE
]; /* temporary buffer in which data to be sent is buffered */
1575 int sendbufidx
= 0; /* index which keeps the number of bytes currently buffered */
1576 struct rpcap_header header
; /* To keep the reply message */
1578 if (sock_bufferize(NULL
, sizeof(struct rpcap_header
), NULL
, &sendbufidx
,
1579 RPCAP_NETBUF_SIZE
, SOCKBUF_CHECKONLY
, fp
->errbuf
, PCAP_ERRBUF_SIZE
))
1582 rpcap_createhdr((struct rpcap_header
*) sendbuf
,
1583 pr
->protocol_version
, RPCAP_MSG_UPDATEFILTER_REQ
, 0,
1584 sizeof(struct rpcap_filter
) + prog
->bf_len
* sizeof(struct rpcap_filterbpf_insn
));
1586 if (pcap_pack_bpffilter(fp
, &sendbuf
[sendbufidx
], &sendbufidx
, prog
))
1589 if (sock_send(pr
->rmt_sockctrl
, pr
->ctrl_ssl
, sendbuf
, sendbufidx
, fp
->errbuf
,
1590 PCAP_ERRBUF_SIZE
) < 0)
1593 /* Receive and process the reply message header. */
1594 if (rpcap_process_msg_header(pr
->rmt_sockctrl
, pr
->ctrl_ssl
, pr
->protocol_version
,
1595 RPCAP_MSG_UPDATEFILTER_REQ
, &header
, fp
->errbuf
) == -1)
1599 * It shouldn't have any contents; discard it if it does.
1601 if (rpcap_discard(pr
->rmt_sockctrl
, pr
->ctrl_ssl
, header
.plen
, fp
->errbuf
) == -1)
1608 pcap_save_current_filter_rpcap(pcap_t
*fp
, const char *filter
)
1610 struct pcap_rpcap
*pr
= fp
->priv
; /* structure used when doing a remote live capture */
1614 * - We are on an remote capture
1615 * - we do not want to capture RPCAP traffic
1617 * If so, we have to save the current filter, because we have to
1618 * add some piece of stuff later
1620 if (pr
->rmt_clientside
&&
1621 (pr
->rmt_flags
& PCAP_OPENFLAG_NOCAPTURE_RPCAP
))
1623 if (pr
->currentfilter
)
1624 free(pr
->currentfilter
);
1629 pr
->currentfilter
= strdup(filter
);
1634 * This function sends a filter to a remote host.
1636 * This function is called when the user wants to set a filter.
1637 * It sends the filter to our peer.
1638 * This function is called automatically when the user calls pcap_setfilter().
1640 * Parameters and return values are exactly the same of pcap_setfilter().
1642 static int pcap_setfilter_rpcap(pcap_t
*fp
, struct bpf_program
*prog
)
1644 struct pcap_rpcap
*pr
= fp
->priv
; /* structure used when doing a remote live capture */
1646 if (!pr
->rmt_capstarted
)
1648 /* copy filter into the pcap_t structure */
1649 if (install_bpf_program(fp
, prog
) == -1)
1654 /* we have to update a filter during run-time */
1655 if (pcap_updatefilter_remote(fp
, prog
))
1662 * This function updates the current filter in order not to capture rpcap
1665 * This function is called *only* when the user wants exclude RPCAP packets
1666 * related to the current session from the captured packets.
1668 * \return '0' if everything is fine, '-1' otherwise. The error message (if one)
1669 * is returned into the 'errbuf' field of the pcap_t structure.
1671 static int pcap_createfilter_norpcappkt(pcap_t
*fp
, struct bpf_program
*prog
)
1673 struct pcap_rpcap
*pr
= fp
->priv
; /* structure used when doing a remote live capture */
1676 /* We do not want to capture our RPCAP traffic. So, let's update the filter */
1677 if (pr
->rmt_flags
& PCAP_OPENFLAG_NOCAPTURE_RPCAP
)
1679 struct sockaddr_storage saddr
; /* temp, needed to retrieve the network data port chosen on the local machine */
1680 socklen_t saddrlen
; /* temp, needed to retrieve the network data port chosen on the local machine */
1681 char myaddress
[128];
1682 char myctrlport
[128];
1683 char mydataport
[128];
1684 char peeraddress
[128];
1685 char peerctrlport
[128];
1688 /* Get the name/port of our peer */
1689 saddrlen
= sizeof(struct sockaddr_storage
);
1690 if (getpeername(pr
->rmt_sockctrl
, (struct sockaddr
*) &saddr
, &saddrlen
) == -1)
1692 sock_geterror("getpeername()", fp
->errbuf
, PCAP_ERRBUF_SIZE
);
1696 if (getnameinfo((struct sockaddr
*) &saddr
, saddrlen
, peeraddress
,
1697 sizeof(peeraddress
), peerctrlport
, sizeof(peerctrlport
), NI_NUMERICHOST
| NI_NUMERICSERV
))
1699 sock_geterror("getnameinfo()", fp
->errbuf
, PCAP_ERRBUF_SIZE
);
1703 /* We cannot check the data port, because this is available only in case of TCP sockets */
1704 /* Get the name/port of the current host */
1705 if (getsockname(pr
->rmt_sockctrl
, (struct sockaddr
*) &saddr
, &saddrlen
) == -1)
1707 sock_geterror("getsockname()", fp
->errbuf
, PCAP_ERRBUF_SIZE
);
1711 /* Get the local port the system picked up */
1712 if (getnameinfo((struct sockaddr
*) &saddr
, saddrlen
, myaddress
,
1713 sizeof(myaddress
), myctrlport
, sizeof(myctrlport
), NI_NUMERICHOST
| NI_NUMERICSERV
))
1715 sock_geterror("getnameinfo()", fp
->errbuf
, PCAP_ERRBUF_SIZE
);
1719 /* Let's now check the data port */
1720 if (getsockname(pr
->rmt_sockdata
, (struct sockaddr
*) &saddr
, &saddrlen
) == -1)
1722 sock_geterror("getsockname()", fp
->errbuf
, PCAP_ERRBUF_SIZE
);
1726 /* Get the local port the system picked up */
1727 if (getnameinfo((struct sockaddr
*) &saddr
, saddrlen
, NULL
, 0, mydataport
, sizeof(mydataport
), NI_NUMERICSERV
))
1729 sock_geterror("getnameinfo()", fp
->errbuf
, PCAP_ERRBUF_SIZE
);
1733 if (pr
->currentfilter
&& pr
->currentfilter
[0] != '\0')
1736 * We have a current filter; add items to it to
1737 * filter out this rpcap session.
1739 if (pcap_asprintf(&newfilter
,
1740 "(%s) and not (host %s and host %s and port %s and port %s) and not (host %s and host %s and port %s)",
1741 pr
->currentfilter
, myaddress
, peeraddress
,
1742 myctrlport
, peerctrlport
, myaddress
, peeraddress
,
1746 snprintf(fp
->errbuf
, PCAP_ERRBUF_SIZE
,
1747 "Can't allocate memory for new filter");
1754 * We have no current filter; construct a filter to
1755 * filter out this rpcap session.
1757 if (pcap_asprintf(&newfilter
,
1758 "not (host %s and host %s and port %s and port %s) and not (host %s and host %s and port %s)",
1759 myaddress
, peeraddress
, myctrlport
, peerctrlport
,
1760 myaddress
, peeraddress
, mydataport
) == -1)
1763 snprintf(fp
->errbuf
, PCAP_ERRBUF_SIZE
,
1764 "Can't allocate memory for new filter");
1770 * This is only an hack to prevent the save_current_filter
1771 * routine, which will be called when we call pcap_compile(),
1772 * from saving the modified filter.
1774 pr
->rmt_clientside
= 0;
1776 if (pcap_compile(fp
, prog
, newfilter
, 1, 0) == -1)
1779 /* Undo the hack. */
1780 pr
->rmt_clientside
= 1;
1789 * This function sets sampling parameters in the remote host.
1791 * It is called when the user wants to set activate sampling on the
1794 * Sampling parameters are defined into the 'pcap_t' structure.
1796 * \param p: the pcap_t descriptor of the device currently opened.
1798 * \return '0' if everything is OK, '-1' is something goes wrong. The
1799 * error message is returned in the 'errbuf' member of the pcap_t structure.
1801 static int pcap_setsampling_remote(pcap_t
*fp
)
1803 struct pcap_rpcap
*pr
= fp
->priv
; /* structure used when doing a remote live capture */
1804 char sendbuf
[RPCAP_NETBUF_SIZE
];/* temporary buffer in which data to be sent is buffered */
1805 int sendbufidx
= 0; /* index which keeps the number of bytes currently buffered */
1806 struct rpcap_header header
; /* To keep the reply message */
1807 struct rpcap_sampling
*sampling_pars
; /* Structure that is needed to send sampling parameters to the remote host */
1809 /* If no samping is requested, return 'ok' */
1810 if (fp
->rmt_samp
.method
== PCAP_SAMP_NOSAMP
)
1814 * Check for sampling parameters that don't fit in a message.
1815 * We'll let the server complain about invalid parameters
1816 * that do fit into the message.
1818 if (fp
->rmt_samp
.method
< 0 || fp
->rmt_samp
.method
> 255) {
1819 snprintf(fp
->errbuf
, PCAP_ERRBUF_SIZE
,
1820 "Invalid sampling method %d", fp
->rmt_samp
.method
);
1823 if (fp
->rmt_samp
.value
< 0 || fp
->rmt_samp
.value
> 65535) {
1824 snprintf(fp
->errbuf
, PCAP_ERRBUF_SIZE
,
1825 "Invalid sampling value %d", fp
->rmt_samp
.value
);
1829 if (sock_bufferize(NULL
, sizeof(struct rpcap_header
), NULL
,
1830 &sendbufidx
, RPCAP_NETBUF_SIZE
, SOCKBUF_CHECKONLY
, fp
->errbuf
, PCAP_ERRBUF_SIZE
))
1833 rpcap_createhdr((struct rpcap_header
*) sendbuf
,
1834 pr
->protocol_version
, RPCAP_MSG_SETSAMPLING_REQ
, 0,
1835 sizeof(struct rpcap_sampling
));
1837 /* Fill the structure needed to open an adapter remotely */
1838 sampling_pars
= (struct rpcap_sampling
*) &sendbuf
[sendbufidx
];
1840 if (sock_bufferize(NULL
, sizeof(struct rpcap_sampling
), NULL
,
1841 &sendbufidx
, RPCAP_NETBUF_SIZE
, SOCKBUF_CHECKONLY
, fp
->errbuf
, PCAP_ERRBUF_SIZE
))
1844 memset(sampling_pars
, 0, sizeof(struct rpcap_sampling
));
1846 sampling_pars
->method
= (uint8
)fp
->rmt_samp
.method
;
1847 sampling_pars
->value
= (uint16
)htonl(fp
->rmt_samp
.value
);
1849 if (sock_send(pr
->rmt_sockctrl
, pr
->ctrl_ssl
, sendbuf
, sendbufidx
, fp
->errbuf
,
1850 PCAP_ERRBUF_SIZE
) < 0)
1853 /* Receive and process the reply message header. */
1854 if (rpcap_process_msg_header(pr
->rmt_sockctrl
, pr
->ctrl_ssl
, pr
->protocol_version
,
1855 RPCAP_MSG_SETSAMPLING_REQ
, &header
, fp
->errbuf
) == -1)
1859 * It shouldn't have any contents; discard it if it does.
1861 if (rpcap_discard(pr
->rmt_sockctrl
, pr
->ctrl_ssl
, header
.plen
, fp
->errbuf
) == -1)
1867 /*********************************************************
1869 * Miscellaneous functions *
1871 *********************************************************/
1874 * This function performs authentication and protocol version
1875 * negotiation. It is required in order to open the connection
1876 * with the other end party.
1878 * It sends authentication parameters on the control socket and
1879 * reads the reply. If the reply is a success indication, it
1880 * checks whether the reply includes minimum and maximum supported
1881 * versions from the server; if not, it assumes both are 0, as
1882 * that means it's an older server that doesn't return supported
1883 * version numbers in authentication replies, so it only supports
1884 * version 0. It then tries to determine the maximum version
1885 * supported both by us and by the server. If it can find such a
1886 * version, it sets us up to use that version; otherwise, it fails,
1887 * indicating that there is no version supported by us and by the
1890 * \param sock: the socket we are currently using.
1892 * \param ver: pointer to variable to which to set the protocol version
1893 * number we selected.
1895 * \param auth: authentication parameters that have to be sent.
1897 * \param errbuf: a pointer to a user-allocated buffer (of size
1898 * PCAP_ERRBUF_SIZE) that will contain the error message (in case there
1899 * is one). It could be a network problem or the fact that the authorization
1902 * \return '0' if everything is fine, '-1' for an error. For errors,
1903 * an error message string is returned in the 'errbuf' variable.
1905 static int rpcap_doauth(SOCKET sockctrl
, SSL
*ssl
, uint8
*ver
, struct pcap_rmtauth
*auth
, char *errbuf
)
1907 char sendbuf
[RPCAP_NETBUF_SIZE
]; /* temporary buffer in which data that has to be sent is buffered */
1908 int sendbufidx
= 0; /* index which keeps the number of bytes currently buffered */
1909 uint16 length
; /* length of the payload of this message */
1910 struct rpcap_auth
*rpauth
;
1912 struct rpcap_header header
;
1915 struct rpcap_authreply authreply
; /* authentication reply message */
1922 case RPCAP_RMTAUTH_NULL
:
1923 length
= sizeof(struct rpcap_auth
);
1926 case RPCAP_RMTAUTH_PWD
:
1927 length
= sizeof(struct rpcap_auth
);
1930 str_length
= strlen(auth
->username
);
1931 if (str_length
> 65535)
1933 snprintf(errbuf
, PCAP_ERRBUF_SIZE
, "User name is too long (> 65535 bytes)");
1936 length
+= (uint16
)str_length
;
1940 str_length
= strlen(auth
->password
);
1941 if (str_length
> 65535)
1943 snprintf(errbuf
, PCAP_ERRBUF_SIZE
, "Password is too long (> 65535 bytes)");
1946 length
+= (uint16
)str_length
;
1951 snprintf(errbuf
, PCAP_ERRBUF_SIZE
, "Authentication type not recognized.");
1955 auth_type
= (uint16
)auth
->type
;
1959 auth_type
= RPCAP_RMTAUTH_NULL
;
1960 length
= sizeof(struct rpcap_auth
);
1963 if (sock_bufferize(NULL
, sizeof(struct rpcap_header
), NULL
,
1964 &sendbufidx
, RPCAP_NETBUF_SIZE
, SOCKBUF_CHECKONLY
, errbuf
, PCAP_ERRBUF_SIZE
))
1967 rpcap_createhdr((struct rpcap_header
*) sendbuf
, 0,
1968 RPCAP_MSG_AUTH_REQ
, 0, length
);
1970 rpauth
= (struct rpcap_auth
*) &sendbuf
[sendbufidx
];
1972 if (sock_bufferize(NULL
, sizeof(struct rpcap_auth
), NULL
,
1973 &sendbufidx
, RPCAP_NETBUF_SIZE
, SOCKBUF_CHECKONLY
, errbuf
, PCAP_ERRBUF_SIZE
))
1976 memset(rpauth
, 0, sizeof(struct rpcap_auth
));
1978 rpauth
->type
= htons(auth_type
);
1980 if (auth_type
== RPCAP_RMTAUTH_PWD
)
1983 rpauth
->slen1
= (uint16
)strlen(auth
->username
);
1987 if (sock_bufferize(auth
->username
, rpauth
->slen1
, sendbuf
,
1988 &sendbufidx
, RPCAP_NETBUF_SIZE
, SOCKBUF_BUFFERIZE
, errbuf
, PCAP_ERRBUF_SIZE
))
1992 rpauth
->slen2
= (uint16
)strlen(auth
->password
);
1996 if (sock_bufferize(auth
->password
, rpauth
->slen2
, sendbuf
,
1997 &sendbufidx
, RPCAP_NETBUF_SIZE
, SOCKBUF_BUFFERIZE
, errbuf
, PCAP_ERRBUF_SIZE
))
2000 rpauth
->slen1
= htons(rpauth
->slen1
);
2001 rpauth
->slen2
= htons(rpauth
->slen2
);
2004 if (sock_send(sockctrl
, ssl
, sendbuf
, sendbufidx
, errbuf
,
2005 PCAP_ERRBUF_SIZE
) < 0)
2008 /* Receive and process the reply message header */
2009 if (rpcap_process_msg_header(sockctrl
, ssl
, 0, RPCAP_MSG_AUTH_REQ
,
2010 &header
, errbuf
) == -1)
2014 * OK, it's an authentication reply, so we're logged in.
2016 * Did it send any additional information?
2021 /* Yes - is it big enough to be version information? */
2022 if (plen
< sizeof(struct rpcap_authreply
))
2024 /* No - discard it and fail. */
2025 (void)rpcap_discard(sockctrl
, ssl
, plen
, NULL
);
2029 /* Read the reply body */
2030 if (rpcap_recv(sockctrl
, ssl
, (char *)&authreply
,
2031 sizeof(struct rpcap_authreply
), &plen
, errbuf
) == -1)
2033 (void)rpcap_discard(sockctrl
, ssl
, plen
, NULL
);
2037 /* Discard the rest of the message, if there is any. */
2038 if (rpcap_discard(sockctrl
, ssl
, plen
, errbuf
) == -1)
2042 * Check the minimum and maximum versions for sanity;
2043 * the minimum must be <= the maximum.
2045 if (authreply
.minvers
> authreply
.maxvers
)
2048 * Bogus - give up on this server.
2050 snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
2051 "The server's minimum supported protocol version is greater than its maximum supported protocol version");
2057 /* No - it supports only version 0. */
2058 authreply
.minvers
= 0;
2059 authreply
.maxvers
= 0;
2063 * OK, let's start with the maximum version the server supports.
2065 ourvers
= authreply
.maxvers
;
2067 #if RPCAP_MIN_VERSION != 0
2069 * If that's less than the minimum version we support, we
2070 * can't communicate.
2072 if (ourvers
< RPCAP_MIN_VERSION
)
2077 * If that's greater than the maximum version we support,
2078 * choose the maximum version we support.
2080 if (ourvers
> RPCAP_MAX_VERSION
)
2082 ourvers
= RPCAP_MAX_VERSION
;
2085 * If that's less than the minimum version they
2086 * support, we can't communicate.
2088 if (ourvers
< authreply
.minvers
)
2097 * There is no version we both support; that is a fatal error.
2099 snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
2100 "The server doesn't support any protocol version that we support");
2104 /* We don't currently support non-blocking mode. */
2106 pcap_getnonblock_rpcap(pcap_t
*p
)
2108 snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
2109 "Non-blocking mode isn't supported for capturing remotely with rpcap");
2114 pcap_setnonblock_rpcap(pcap_t
*p
, int nonblock _U_
)
2116 snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
2117 "Non-blocking mode isn't supported for capturing remotely with rpcap");
2122 rpcap_setup_session(const char *source
, struct pcap_rmtauth
*auth
,
2123 int *activep
, SOCKET
*sockctrlp
, uint8
*uses_sslp
, SSL
**sslp
,
2124 int rmt_flags
, uint8
*protocol_versionp
, char *host
, char *port
,
2125 char *iface
, char *errbuf
)
2128 struct activehosts
*activeconn
; /* active connection, if there is one */
2129 int error
; /* 1 if rpcap_remoteact_getsock got an error */
2132 * Determine the type of the source (NULL, file, local, remote).
2133 * You must have a valid source string even if we're in active mode,
2134 * because otherwise the call to the following function will fail.
2136 if (pcap_parsesrcstr_ex(source
, &type
, host
, port
, iface
, uses_sslp
,
2141 * It must be remote.
2143 if (type
!= PCAP_SRC_IFREMOTE
)
2145 snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
2146 "Non-remote interface passed to remote capture routine");
2151 * We don't yet support DTLS, so if the user asks for a TLS
2152 * connection and asks for data packets to be sent over UDP,
2153 * we have to give up.
2155 if (*uses_sslp
&& (rmt_flags
& PCAP_OPENFLAG_DATATX_UDP
))
2157 snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
2158 "TLS not supported with UDP forward of remote packets");
2162 /* Warning: this call can be the first one called by the user. */
2163 /* For this reason, we have to initialize the WinSock support. */
2164 if (sock_init(errbuf
, PCAP_ERRBUF_SIZE
) == -1)
2167 /* Check for active mode */
2168 activeconn
= rpcap_remoteact_getsock(host
, &error
, errbuf
);
2169 if (activeconn
!= NULL
)
2172 *sockctrlp
= activeconn
->sockctrl
;
2173 *sslp
= activeconn
->ssl
;
2174 *protocol_versionp
= activeconn
->protocol_version
;
2179 struct addrinfo hints
; /* temp variable needed to resolve hostnames into to socket representation */
2180 struct addrinfo
*addrinfo
; /* temp variable needed to resolve hostnames into to socket representation */
2191 * We're not in active mode; let's try to open a new
2192 * control connection.
2194 memset(&hints
, 0, sizeof(struct addrinfo
));
2195 hints
.ai_family
= PF_UNSPEC
;
2196 hints
.ai_socktype
= SOCK_STREAM
;
2200 /* the user chose not to specify the port */
2201 if (sock_initaddress(host
, RPCAP_DEFAULT_NETPORT
,
2202 &hints
, &addrinfo
, errbuf
, PCAP_ERRBUF_SIZE
) == -1)
2207 if (sock_initaddress(host
, port
, &hints
, &addrinfo
,
2208 errbuf
, PCAP_ERRBUF_SIZE
) == -1)
2212 if ((*sockctrlp
= sock_open(addrinfo
, SOCKOPEN_CLIENT
, 0,
2213 errbuf
, PCAP_ERRBUF_SIZE
)) == INVALID_SOCKET
)
2215 freeaddrinfo(addrinfo
);
2219 /* addrinfo is no longer used */
2220 freeaddrinfo(addrinfo
);
2226 *sslp
= ssl_promotion(0, *sockctrlp
, errbuf
,
2230 sock_close(*sockctrlp
, NULL
, 0);
2234 snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
2236 sock_close(*sockctrlp
, NULL
, 0);
2241 if (rpcap_doauth(*sockctrlp
, *sslp
, protocol_versionp
, auth
,
2247 // Finish using the SSL handle for the socket.
2248 // This must be done *before* the socket is
2253 sock_close(*sockctrlp
, NULL
, 0);
2261 * This function opens a remote adapter by opening an RPCAP connection and
2264 * It does the job of pcap_open_live() for a remote interface; it's called
2265 * by pcap_open() for remote interfaces.
2267 * We do not start the capture until pcap_startcapture_remote() is called.
2269 * This is because, when doing a remote capture, we cannot start capturing
2270 * data as soon as the 'open adapter' command is sent. Suppose the remote
2271 * adapter is already overloaded; if we start a capture (which, by default,
2272 * has a NULL filter) the new traffic can saturate the network.
2274 * Instead, we want to "open" the adapter, then send a "start capture"
2275 * command only when we're ready to start the capture.
2276 * This function does this job: it sends an "open adapter" command
2277 * (according to the RPCAP protocol), but it does not start the capture.
2279 * Since the other libpcap functions do not share this way of life, we
2280 * have to do some dirty things in order to make everything work.
2282 * \param source: see pcap_open().
2283 * \param snaplen: see pcap_open().
2284 * \param flags: see pcap_open().
2285 * \param read_timeout: see pcap_open().
2286 * \param auth: see pcap_open().
2287 * \param errbuf: see pcap_open().
2289 * \return a pcap_t pointer in case of success, NULL otherwise. In case of
2290 * success, the pcap_t pointer can be used as a parameter to the following
2291 * calls (pcap_compile() and so on). In case of problems, errbuf contains
2292 * a text explanation of error.
2294 * WARNING: In case we call pcap_compile() and the capture has not yet
2295 * been started, the filter will be saved into the pcap_t structure,
2296 * and it will be sent to the other host later (when
2297 * pcap_startcapture_remote() is called).
2299 pcap_t
*pcap_open_rpcap(const char *source
, int snaplen
, int flags
, int read_timeout
, struct pcap_rmtauth
*auth
, char *errbuf
)
2303 struct pcap_rpcap
*pr
; /* structure used when doing a remote live capture */
2304 char host
[PCAP_BUF_SIZE
], ctrlport
[PCAP_BUF_SIZE
], iface
[PCAP_BUF_SIZE
];
2307 uint8 protocol_version
; /* negotiated protocol version */
2310 char sendbuf
[RPCAP_NETBUF_SIZE
]; /* temporary buffer in which data to be sent is buffered */
2311 int sendbufidx
= 0; /* index which keeps the number of bytes currently buffered */
2313 /* RPCAP-related variables */
2314 struct rpcap_header header
; /* header of the RPCAP packet */
2315 struct rpcap_openreply openreply
; /* open reply message */
2317 fp
= pcap_create_common(errbuf
, sizeof (struct pcap_rpcap
));
2322 source_str
= strdup(source
);
2323 if (source_str
== NULL
) {
2324 pcap_fmt_errmsg_for_errno(errbuf
, PCAP_ERRBUF_SIZE
,
2330 * Turn a negative snapshot value (invalid), a snapshot value of
2331 * 0 (unspecified), or a value bigger than the normal maximum
2332 * value, into the maximum allowed value.
2334 * If some application really *needs* a bigger snapshot
2335 * length, we should just increase MAXIMUM_SNAPLEN.
2337 * XXX - should we leave this up to the remote server to
2340 if (snaplen
<= 0 || snaplen
> MAXIMUM_SNAPLEN
)
2341 snaplen
= MAXIMUM_SNAPLEN
;
2343 fp
->opt
.device
= source_str
;
2344 fp
->snapshot
= snaplen
;
2345 fp
->opt
.timeout
= read_timeout
;
2347 pr
->rmt_flags
= flags
;
2350 * Attempt to set up the session with the server.
2352 if (rpcap_setup_session(fp
->opt
.device
, auth
, &active
, &sockctrl
,
2353 &pr
->uses_ssl
, &ssl
, flags
, &protocol_version
, host
, ctrlport
,
2354 iface
, errbuf
) == -1)
2356 /* Session setup failed. */
2361 /* All good so far, save the ssl handler */
2365 * Now it's time to start playing with the RPCAP protocol
2366 * RPCAP open command: create the request message
2368 if (sock_bufferize(NULL
, sizeof(struct rpcap_header
), NULL
,
2369 &sendbufidx
, RPCAP_NETBUF_SIZE
, SOCKBUF_CHECKONLY
, errbuf
, PCAP_ERRBUF_SIZE
))
2370 goto error_nodiscard
;
2372 rpcap_createhdr((struct rpcap_header
*) sendbuf
, protocol_version
,
2373 RPCAP_MSG_OPEN_REQ
, 0, (uint32
) strlen(iface
));
2375 if (sock_bufferize(iface
, (int) strlen(iface
), sendbuf
, &sendbufidx
,
2376 RPCAP_NETBUF_SIZE
, SOCKBUF_BUFFERIZE
, errbuf
, PCAP_ERRBUF_SIZE
))
2377 goto error_nodiscard
;
2379 if (sock_send(sockctrl
, ssl
, sendbuf
, sendbufidx
, errbuf
,
2380 PCAP_ERRBUF_SIZE
) < 0)
2381 goto error_nodiscard
;
2383 /* Receive and process the reply message header. */
2384 if (rpcap_process_msg_header(sockctrl
, ssl
, protocol_version
,
2385 RPCAP_MSG_OPEN_REQ
, &header
, errbuf
) == -1)
2386 goto error_nodiscard
;
2389 /* Read the reply body */
2390 if (rpcap_recv(sockctrl
, ssl
, (char *)&openreply
,
2391 sizeof(struct rpcap_openreply
), &plen
, errbuf
) == -1)
2394 /* Discard the rest of the message, if there is any. */
2395 if (rpcap_discard(sockctrl
, ssl
, plen
, errbuf
) == -1)
2396 goto error_nodiscard
;
2398 /* Set proper fields into the pcap_t struct */
2399 fp
->linktype
= ntohl(openreply
.linktype
);
2400 pr
->rmt_sockctrl
= sockctrl
;
2402 pr
->protocol_version
= protocol_version
;
2403 pr
->rmt_clientside
= 1;
2405 /* This code is duplicated from the end of this function */
2406 fp
->read_op
= pcap_read_rpcap
;
2407 fp
->save_current_filter_op
= pcap_save_current_filter_rpcap
;
2408 fp
->setfilter_op
= pcap_setfilter_rpcap
;
2409 fp
->getnonblock_op
= pcap_getnonblock_rpcap
;
2410 fp
->setnonblock_op
= pcap_setnonblock_rpcap
;
2411 fp
->stats_op
= pcap_stats_rpcap
;
2413 fp
->stats_ex_op
= pcap_stats_ex_rpcap
;
2415 fp
->cleanup_op
= pcap_cleanup_rpcap
;
2422 * When the connection has been established, we have to close it. So, at the
2423 * beginning of this function, if an error occur we return immediately with
2424 * a return NULL; when the connection is established, we have to come here
2425 * ('goto error;') in order to close everything properly.
2429 * Discard the rest of the message.
2430 * We already reported an error; if this gets an error, just
2433 (void)rpcap_discard(sockctrl
, pr
->ctrl_ssl
, plen
, NULL
);
2441 // Finish using the SSL handle for the socket.
2442 // This must be done *before* the socket is closed.
2446 sock_close(sockctrl
, NULL
, 0);
2453 /* String identifier to be used in the pcap_findalldevs_ex() */
2454 #define PCAP_TEXT_SOURCE_ADAPTER "Network adapter"
2455 #define PCAP_TEXT_SOURCE_ADAPTER_LEN (sizeof PCAP_TEXT_SOURCE_ADAPTER - 1)
2456 /* String identifier to be used in the pcap_findalldevs_ex() */
2457 #define PCAP_TEXT_SOURCE_ON_REMOTE_HOST "on remote node"
2458 #define PCAP_TEXT_SOURCE_ON_REMOTE_HOST_LEN (sizeof PCAP_TEXT_SOURCE_ON_REMOTE_HOST - 1)
2461 freeaddr(struct pcap_addr
*addr
)
2464 free(addr
->netmask
);
2465 free(addr
->broadaddr
);
2466 free(addr
->dstaddr
);
2471 pcap_findalldevs_ex_remote(const char *source
, struct pcap_rmtauth
*auth
, pcap_if_t
**alldevs
, char *errbuf
)
2473 uint8 protocol_version
; /* protocol version */
2474 SOCKET sockctrl
; /* socket descriptor of the control connection */
2475 SSL
*ssl
= NULL
; /* optional SSL handler for sockctrl */
2477 struct rpcap_header header
; /* structure that keeps the general header of the rpcap protocol */
2478 int i
, j
; /* temp variables */
2479 int nif
; /* Number of interfaces listed */
2480 int active
; /* 'true' if we the other end-party is in active mode */
2482 char host
[PCAP_BUF_SIZE
], port
[PCAP_BUF_SIZE
];
2483 char tmpstring
[PCAP_BUF_SIZE
+ 1]; /* Needed to convert names and descriptions from 'old' syntax to the 'new' one */
2484 pcap_if_t
*lastdev
; /* Last device in the pcap_if_t list */
2485 pcap_if_t
*dev
; /* Device we're adding to the pcap_if_t list */
2487 /* List starts out empty. */
2492 * Attempt to set up the session with the server.
2494 if (rpcap_setup_session(source
, auth
, &active
, &sockctrl
, &uses_ssl
,
2495 &ssl
, 0, &protocol_version
, host
, port
, NULL
, errbuf
) == -1)
2497 /* Session setup failed. */
2501 /* RPCAP findalldevs command */
2502 rpcap_createhdr(&header
, protocol_version
, RPCAP_MSG_FINDALLIF_REQ
,
2505 if (sock_send(sockctrl
, ssl
, (char *)&header
, sizeof(struct rpcap_header
),
2506 errbuf
, PCAP_ERRBUF_SIZE
) < 0)
2507 goto error_nodiscard
;
2509 /* Receive and process the reply message header. */
2510 if (rpcap_process_msg_header(sockctrl
, ssl
, protocol_version
,
2511 RPCAP_MSG_FINDALLIF_REQ
, &header
, errbuf
) == -1)
2512 goto error_nodiscard
;
2516 /* read the number of interfaces */
2517 nif
= ntohs(header
.value
);
2519 /* loop until all interfaces have been received */
2520 for (i
= 0; i
< nif
; i
++)
2522 struct rpcap_findalldevs_if findalldevs_if
;
2523 char tmpstring2
[PCAP_BUF_SIZE
+ 1]; /* Needed to convert names and descriptions from 'old' syntax to the 'new' one */
2524 struct pcap_addr
*addr
, *prevaddr
;
2526 tmpstring2
[PCAP_BUF_SIZE
] = 0;
2528 /* receive the findalldevs structure from remote host */
2529 if (rpcap_recv(sockctrl
, ssl
, (char *)&findalldevs_if
,
2530 sizeof(struct rpcap_findalldevs_if
), &plen
, errbuf
) == -1)
2533 findalldevs_if
.namelen
= ntohs(findalldevs_if
.namelen
);
2534 findalldevs_if
.desclen
= ntohs(findalldevs_if
.desclen
);
2535 findalldevs_if
.naddr
= ntohs(findalldevs_if
.naddr
);
2537 /* allocate the main structure */
2538 dev
= (pcap_if_t
*)malloc(sizeof(pcap_if_t
));
2541 pcap_fmt_errmsg_for_errno(errbuf
, PCAP_ERRBUF_SIZE
,
2542 errno
, "malloc() failed");
2546 /* Initialize the structure to 'zero' */
2547 memset(dev
, 0, sizeof(pcap_if_t
));
2549 /* Append it to the list. */
2550 if (lastdev
== NULL
)
2553 * List is empty, so it's also the first device.
2560 * Append after the last device.
2562 lastdev
->next
= dev
;
2564 /* It's now the last device. */
2567 /* allocate mem for name and description */
2568 if (findalldevs_if
.namelen
)
2571 if (findalldevs_if
.namelen
>= sizeof(tmpstring
))
2573 snprintf(errbuf
, PCAP_ERRBUF_SIZE
, "Interface name too long");
2577 /* Retrieve adapter name */
2578 if (rpcap_recv(sockctrl
, ssl
, tmpstring
,
2579 findalldevs_if
.namelen
, &plen
, errbuf
) == -1)
2582 tmpstring
[findalldevs_if
.namelen
] = 0;
2584 /* Create the new device identifier */
2585 if (pcap_createsrcstr_ex(tmpstring2
, PCAP_SRC_IFREMOTE
,
2586 host
, port
, tmpstring
, uses_ssl
, errbuf
) == -1)
2589 dev
->name
= strdup(tmpstring2
);
2590 if (dev
->name
== NULL
)
2592 pcap_fmt_errmsg_for_errno(errbuf
,
2593 PCAP_ERRBUF_SIZE
, errno
, "malloc() failed");
2598 if (findalldevs_if
.desclen
)
2600 if (findalldevs_if
.desclen
>= sizeof(tmpstring
))
2602 snprintf(errbuf
, PCAP_ERRBUF_SIZE
, "Interface description too long");
2606 /* Retrieve adapter description */
2607 if (rpcap_recv(sockctrl
, ssl
, tmpstring
,
2608 findalldevs_if
.desclen
, &plen
, errbuf
) == -1)
2611 tmpstring
[findalldevs_if
.desclen
] = 0;
2613 if (pcap_asprintf(&dev
->description
,
2614 "%s '%s' %s %s", PCAP_TEXT_SOURCE_ADAPTER
,
2615 tmpstring
, PCAP_TEXT_SOURCE_ON_REMOTE_HOST
, host
) == -1)
2617 pcap_fmt_errmsg_for_errno(errbuf
,
2618 PCAP_ERRBUF_SIZE
, errno
, "malloc() failed");
2623 dev
->flags
= ntohl(findalldevs_if
.flags
);
2626 /* loop until all addresses have been received */
2627 for (j
= 0; j
< findalldevs_if
.naddr
; j
++)
2629 struct rpcap_findalldevs_ifaddr ifaddr
;
2631 /* Retrieve the interface addresses */
2632 if (rpcap_recv(sockctrl
, ssl
, (char *)&ifaddr
,
2633 sizeof(struct rpcap_findalldevs_ifaddr
),
2634 &plen
, errbuf
) == -1)
2638 * Deserialize all the address components.
2640 addr
= (struct pcap_addr
*) malloc(sizeof(struct pcap_addr
));
2643 pcap_fmt_errmsg_for_errno(errbuf
,
2644 PCAP_ERRBUF_SIZE
, errno
, "malloc() failed");
2649 addr
->netmask
= NULL
;
2650 addr
->broadaddr
= NULL
;
2651 addr
->dstaddr
= NULL
;
2653 if (rpcap_deseraddr(&ifaddr
.addr
,
2654 (struct sockaddr_storage
**) &addr
->addr
, errbuf
) == -1)
2659 if (rpcap_deseraddr(&ifaddr
.netmask
,
2660 (struct sockaddr_storage
**) &addr
->netmask
, errbuf
) == -1)
2665 if (rpcap_deseraddr(&ifaddr
.broadaddr
,
2666 (struct sockaddr_storage
**) &addr
->broadaddr
, errbuf
) == -1)
2671 if (rpcap_deseraddr(&ifaddr
.dstaddr
,
2672 (struct sockaddr_storage
**) &addr
->dstaddr
, errbuf
) == -1)
2678 if ((addr
->addr
== NULL
) && (addr
->netmask
== NULL
) &&
2679 (addr
->broadaddr
== NULL
) && (addr
->dstaddr
== NULL
))
2682 * None of the addresses are IPv4 or IPv6
2683 * addresses, so throw this entry away.
2690 * Add this entry to the list.
2692 if (prevaddr
== NULL
)
2694 dev
->addresses
= addr
;
2698 prevaddr
->next
= addr
;
2705 /* Discard the rest of the message. */
2706 if (rpcap_discard(sockctrl
, ssl
, plen
, errbuf
) == 1)
2707 goto error_nodiscard
;
2709 /* Control connection has to be closed only in case the remote machine is in passive mode */
2712 /* DO not send RPCAP_CLOSE, since we did not open a pcap_t; no need to free resources */
2716 // Finish using the SSL handle for the socket.
2717 // This must be done *before* the socket is closed.
2721 if (sock_close(sockctrl
, errbuf
, PCAP_ERRBUF_SIZE
))
2725 /* To avoid inconsistencies in the number of sock_init() */
2732 * In case there has been an error, I don't want to overwrite it with a new one
2733 * if the following call fails. I want to return always the original error.
2735 * Take care: this connection can already be closed when we try to close it.
2736 * This happens because a previous error in the rpcapd, which requested to
2737 * closed the connection. In that case, we already recognized that into the
2738 * rpspck_isheaderok() and we already acknowledged the closing.
2739 * In that sense, this call is useless here (however it is needed in case
2740 * the client generates the error).
2742 * Checks if all the data has been read; if not, discard the data in excess
2744 (void) rpcap_discard(sockctrl
, ssl
, plen
, NULL
);
2747 /* Control connection has to be closed only in case the remote machine is in passive mode */
2753 // Finish using the SSL handle for the socket.
2754 // This must be done *before* the socket is closed.
2758 sock_close(sockctrl
, NULL
, 0);
2761 /* To avoid inconsistencies in the number of sock_init() */
2764 /* Free whatever interfaces we've allocated. */
2765 pcap_freealldevs(*alldevs
);
2771 * Active mode routines.
2773 * The old libpcap API is somewhat ugly, and makes active mode difficult
2774 * to implement; we provide some APIs for it that work only with rpcap.
2777 SOCKET
pcap_remoteact_accept_ex(const char *address
, const char *port
, const char *hostlist
, char *connectinghost
, struct pcap_rmtauth
*auth
, int uses_ssl
, char *errbuf
)
2779 /* socket-related variables */
2780 struct addrinfo hints
; /* temporary struct to keep settings needed to open the new socket */
2781 struct addrinfo
*addrinfo
; /* keeps the addrinfo chain; required to open a new socket */
2782 struct sockaddr_storage from
; /* generic sockaddr_storage variable */
2783 socklen_t fromlen
; /* keeps the length of the sockaddr_storage variable */
2784 SOCKET sockctrl
; /* keeps the main socket identifier */
2785 SSL
*ssl
= NULL
; /* Optional SSL handler for sockctrl */
2786 uint8 protocol_version
; /* negotiated protocol version */
2787 struct activehosts
*temp
, *prev
; /* temp var needed to scan he host list chain */
2789 *connectinghost
= 0; /* just in case */
2791 /* Prepare to open a new server socket */
2792 memset(&hints
, 0, sizeof(struct addrinfo
));
2793 /* WARNING Currently it supports only ONE socket family among ipv4 and IPv6 */
2794 hints
.ai_family
= AF_INET
; /* PF_UNSPEC to have both IPv4 and IPv6 server */
2795 hints
.ai_flags
= AI_PASSIVE
; /* Ready to a bind() socket */
2796 hints
.ai_socktype
= SOCK_STREAM
;
2798 /* Warning: this call can be the first one called by the user. */
2799 /* For this reason, we have to initialize the WinSock support. */
2800 if (sock_init(errbuf
, PCAP_ERRBUF_SIZE
) == -1)
2804 if ((port
== NULL
) || (port
[0] == 0))
2806 if (sock_initaddress(address
, RPCAP_DEFAULT_NETPORT_ACTIVE
, &hints
, &addrinfo
, errbuf
, PCAP_ERRBUF_SIZE
) == -1)
2813 if (sock_initaddress(address
, port
, &hints
, &addrinfo
, errbuf
, PCAP_ERRBUF_SIZE
) == -1)
2820 if ((sockmain
= sock_open(addrinfo
, SOCKOPEN_SERVER
, 1, errbuf
, PCAP_ERRBUF_SIZE
)) == INVALID_SOCKET
)
2822 freeaddrinfo(addrinfo
);
2825 freeaddrinfo(addrinfo
);
2827 /* Connection creation */
2828 fromlen
= sizeof(struct sockaddr_storage
);
2830 sockctrl
= accept(sockmain
, (struct sockaddr
*) &from
, &fromlen
);
2832 /* We're not using sock_close, since we do not want to send a shutdown */
2833 /* (which is not allowed on a non-connected socket) */
2834 closesocket(sockmain
);
2837 if (sockctrl
== INVALID_SOCKET
)
2839 sock_geterror("accept()", errbuf
, PCAP_ERRBUF_SIZE
);
2843 /* Promote to SSL early before any error message may be sent */
2847 ssl
= ssl_promotion(0, sockctrl
, errbuf
, PCAP_ERRBUF_SIZE
);
2850 sock_close(sockctrl
, NULL
, 0);
2854 snprintf(errbuf
, PCAP_ERRBUF_SIZE
, "No TLS support");
2855 sock_close(sockctrl
, NULL
, 0);
2860 /* Get the numeric for of the name of the connecting host */
2861 if (getnameinfo((struct sockaddr
*) &from
, fromlen
, connectinghost
, RPCAP_HOSTLIST_SIZE
, NULL
, 0, NI_NUMERICHOST
))
2863 sock_geterror("getnameinfo()", errbuf
, PCAP_ERRBUF_SIZE
);
2864 rpcap_senderror(sockctrl
, ssl
, 0, PCAP_ERR_REMOTEACCEPT
, errbuf
, NULL
);
2868 // Finish using the SSL handle for the socket.
2869 // This must be done *before* the socket is closed.
2873 sock_close(sockctrl
, NULL
, 0);
2877 /* checks if the connecting host is among the ones allowed */
2878 if (sock_check_hostlist((char *)hostlist
, RPCAP_HOSTLIST_SEP
, &from
, errbuf
, PCAP_ERRBUF_SIZE
) < 0)
2880 rpcap_senderror(sockctrl
, ssl
, 0, PCAP_ERR_REMOTEACCEPT
, errbuf
, NULL
);
2884 // Finish using the SSL handle for the socket.
2885 // This must be done *before* the socket is closed.
2889 sock_close(sockctrl
, NULL
, 0);
2894 * Send authentication to the remote machine.
2896 if (rpcap_doauth(sockctrl
, ssl
, &protocol_version
, auth
, errbuf
) == -1)
2898 /* Unrecoverable error. */
2899 rpcap_senderror(sockctrl
, ssl
, 0, PCAP_ERR_REMOTEACCEPT
, errbuf
, NULL
);
2903 // Finish using the SSL handle for the socket.
2904 // This must be done *before* the socket is closed.
2908 sock_close(sockctrl
, NULL
, 0);
2912 /* Checks that this host does not already have a cntrl connection in place */
2914 /* Initialize pointers */
2920 /* This host already has an active connection in place, so I don't have to update the host list */
2921 if (sock_cmpaddr(&temp
->host
, &from
) == 0)
2928 /* The host does not exist in the list; so I have to update the list */
2931 prev
->next
= (struct activehosts
*) malloc(sizeof(struct activehosts
));
2936 activeHosts
= (struct activehosts
*) malloc(sizeof(struct activehosts
));
2942 pcap_fmt_errmsg_for_errno(errbuf
, PCAP_ERRBUF_SIZE
,
2943 errno
, "malloc() failed");
2944 rpcap_senderror(sockctrl
, ssl
, protocol_version
, PCAP_ERR_REMOTEACCEPT
, errbuf
, NULL
);
2948 // Finish using the SSL handle for the socket.
2949 // This must be done *before* the socket is closed.
2953 sock_close(sockctrl
, NULL
, 0);
2957 memcpy(&temp
->host
, &from
, fromlen
);
2958 temp
->sockctrl
= sockctrl
;
2960 temp
->protocol_version
= protocol_version
;
2966 SOCKET
pcap_remoteact_accept(const char *address
, const char *port
, const char *hostlist
, char *connectinghost
, struct pcap_rmtauth
*auth
, char *errbuf
)
2968 return pcap_remoteact_accept_ex(address
, port
, hostlist
, connectinghost
, auth
, 0, errbuf
);
2971 int pcap_remoteact_close(const char *host
, char *errbuf
)
2973 struct activehosts
*temp
, *prev
; /* temp var needed to scan the host list chain */
2974 struct addrinfo hints
, *addrinfo
, *ai_next
; /* temp var needed to translate between hostname to its address */
2980 /* retrieve the network address corresponding to 'host' */
2982 memset(&hints
, 0, sizeof(struct addrinfo
));
2983 hints
.ai_family
= PF_UNSPEC
;
2984 hints
.ai_socktype
= SOCK_STREAM
;
2986 retval
= getaddrinfo(host
, "0", &hints
, &addrinfo
);
2989 snprintf(errbuf
, PCAP_ERRBUF_SIZE
, "getaddrinfo() %s", gai_strerror(retval
));
2998 if (sock_cmpaddr(&temp
->host
, (struct sockaddr_storage
*) ai_next
->ai_addr
) == 0)
3000 struct rpcap_header header
;
3003 /* Close this connection */
3004 rpcap_createhdr(&header
, temp
->protocol_version
,
3005 RPCAP_MSG_CLOSE
, 0, 0);
3008 * Don't check for errors, since we're
3011 if (sock_send(temp
->sockctrl
, temp
->ssl
,
3013 sizeof(struct rpcap_header
), errbuf
,
3014 PCAP_ERRBUF_SIZE
) < 0)
3017 * Let that error be the one we
3023 // Finish using the SSL handle
3025 // This must be done *before*
3026 // the socket is closed.
3027 ssl_finish(temp
->ssl
);
3030 (void)sock_close(temp
->sockctrl
, NULL
,
3039 // Finish using the SSL handle
3041 // This must be done *before*
3042 // the socket is closed.
3043 ssl_finish(temp
->ssl
);
3046 if (sock_close(temp
->sockctrl
, errbuf
,
3047 PCAP_ERRBUF_SIZE
) == -1)
3052 * Remove the host from the list of active
3056 prev
->next
= temp
->next
;
3058 activeHosts
= temp
->next
;
3060 freeaddrinfo(addrinfo
);
3064 /* To avoid inconsistencies in the number of sock_init() */
3070 ai_next
= ai_next
->ai_next
;
3077 freeaddrinfo(addrinfo
);
3079 /* To avoid inconsistencies in the number of sock_init() */
3082 snprintf(errbuf
, PCAP_ERRBUF_SIZE
, "The host you want to close the active connection is not known");
3086 void pcap_remoteact_cleanup(void)
3088 # ifdef HAVE_OPENSSL
3091 // Finish using the SSL handle for the main active socket.
3092 // This must be done *before* the socket is closed.
3093 ssl_finish(ssl_main
);
3098 /* Very dirty, but it works */
3101 closesocket(sockmain
);
3103 /* To avoid inconsistencies in the number of sock_init() */
3108 int pcap_remoteact_list(char *hostlist
, char sep
, int size
, char *errbuf
)
3110 struct activehosts
*temp
; /* temp var needed to scan the host list chain */
3112 char hoststr
[RPCAP_HOSTLIST_SIZE
+ 1];
3121 /*int sock_getascii_addrport(const struct sockaddr_storage *sockaddr, char *address, int addrlen, char *port, int portlen, int flags, char *errbuf, int errbuflen) */
3123 /* Get the numeric form of the name of the connecting host */
3124 if (sock_getascii_addrport((struct sockaddr_storage
*) &temp
->host
, hoststr
,
3125 RPCAP_HOSTLIST_SIZE
, NULL
, 0, NI_NUMERICHOST
, errbuf
, PCAP_ERRBUF_SIZE
) != -1)
3126 /* if (getnameinfo( (struct sockaddr *) &temp->host, sizeof (struct sockaddr_storage), hoststr, */
3127 /* RPCAP_HOSTLIST_SIZE, NULL, 0, NI_NUMERICHOST) ) */
3129 /* sock_geterror("getnameinfo()", errbuf, PCAP_ERRBUF_SIZE); */
3133 len
= len
+ strlen(hoststr
) + 1 /* the separator */;
3135 if ((size
< 0) || (len
>= (size_t)size
))
3137 snprintf(errbuf
, PCAP_ERRBUF_SIZE
, "The string you provided is not able to keep "
3138 "the hostnames for all the active connections");
3142 pcap_strlcat(hostlist
, hoststr
, PCAP_ERRBUF_SIZE
);
3143 hostlist
[len
- 1] = sep
;
3153 * Receive the header of a message.
3155 static int rpcap_recv_msg_header(SOCKET sock
, SSL
*ssl
, struct rpcap_header
*header
, char *errbuf
)
3159 nrecv
= sock_recv(sock
, ssl
, (char *) header
, sizeof(struct rpcap_header
),
3160 SOCK_RECEIVEALL_YES
|SOCK_EOF_IS_ERROR
, errbuf
,
3164 /* Network error. */
3167 header
->plen
= ntohl(header
->plen
);
3172 * Make sure the protocol version of a received message is what we were
3175 static int rpcap_check_msg_ver(SOCKET sock
, SSL
*ssl
, uint8 expected_ver
, struct rpcap_header
*header
, char *errbuf
)
3178 * Did the server specify the version we negotiated?
3180 if (header
->ver
!= expected_ver
)
3183 * Discard the rest of the message.
3185 if (rpcap_discard(sock
, ssl
, header
->plen
, errbuf
) == -1)
3189 * Tell our caller that it's not the negotiated version.
3193 snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
3194 "Server sent us a message with version %u when we were expecting %u",
3195 header
->ver
, expected_ver
);
3203 * Check the message type of a received message, which should either be
3204 * the expected message type or RPCAP_MSG_ERROR.
3206 static int rpcap_check_msg_type(SOCKET sock
, SSL
*ssl
, uint8 request_type
, struct rpcap_header
*header
, uint16
*errcode
, char *errbuf
)
3208 const char *request_type_string
;
3209 const char *msg_type_string
;
3212 * What type of message is it?
3214 if (header
->type
== RPCAP_MSG_ERROR
)
3217 * The server reported an error.
3218 * Hand that error back to our caller.
3220 *errcode
= ntohs(header
->value
);
3221 rpcap_msg_err(sock
, ssl
, header
->plen
, errbuf
);
3228 * For a given request type value, the expected reply type value
3229 * is the request type value with ORed with RPCAP_MSG_IS_REPLY.
3231 if (header
->type
!= (request_type
| RPCAP_MSG_IS_REPLY
))
3234 * This isn't a reply to the request we sent.
3238 * Discard the rest of the message.
3240 if (rpcap_discard(sock
, ssl
, header
->plen
, errbuf
) == -1)
3244 * Tell our caller about it.
3246 request_type_string
= rpcap_msg_type_string(request_type
);
3247 msg_type_string
= rpcap_msg_type_string(header
->type
);
3250 if (request_type_string
== NULL
)
3252 /* This should not happen. */
3253 snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
3254 "rpcap_check_msg_type called for request message with type %u",
3258 if (msg_type_string
!= NULL
)
3259 snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
3260 "%s message received in response to a %s message",
3261 msg_type_string
, request_type_string
);
3263 snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
3264 "Message of unknown type %u message received in response to a %s request",
3265 header
->type
, request_type_string
);
3274 * Receive and process the header of a message.
3276 static int rpcap_process_msg_header(SOCKET sock
, SSL
*ssl
, uint8 expected_ver
, uint8 request_type
, struct rpcap_header
*header
, char *errbuf
)
3280 if (rpcap_recv_msg_header(sock
, ssl
, header
, errbuf
) == -1)
3282 /* Network error. */
3287 * Did the server specify the version we negotiated?
3289 if (rpcap_check_msg_ver(sock
, ssl
, expected_ver
, header
, errbuf
) == -1)
3293 * Check the message type.
3295 return rpcap_check_msg_type(sock
, ssl
, request_type
, header
,
3300 * Read data from a message.
3301 * If we're trying to read more data that remains, puts an error
3302 * message into errmsgbuf and returns -2. Otherwise, tries to read
3303 * the data and, if that succeeds, subtracts the amount read from
3304 * the number of bytes of data that remains.
3305 * Returns 0 on success, logs a message and returns -1 on a network
3308 static int rpcap_recv(SOCKET sock
, SSL
*ssl
, void *buffer
, size_t toread
, uint32
*plen
, char *errbuf
)
3314 /* The server sent us a bad message */
3315 snprintf(errbuf
, PCAP_ERRBUF_SIZE
, "Message payload is too short");
3318 nread
= sock_recv(sock
, ssl
, buffer
, toread
,
3319 SOCK_RECEIVEALL_YES
|SOCK_EOF_IS_ERROR
, errbuf
, PCAP_ERRBUF_SIZE
);
3329 * This handles the RPCAP_MSG_ERROR message.
3331 static void rpcap_msg_err(SOCKET sockctrl
, SSL
*ssl
, uint32 plen
, char *remote_errbuf
)
3333 char errbuf
[PCAP_ERRBUF_SIZE
];
3335 if (plen
>= PCAP_ERRBUF_SIZE
)
3338 * Message is too long; just read as much of it as we
3339 * can into the buffer provided, and discard the rest.
3341 if (sock_recv(sockctrl
, ssl
, remote_errbuf
, PCAP_ERRBUF_SIZE
- 1,
3342 SOCK_RECEIVEALL_YES
|SOCK_EOF_IS_ERROR
, errbuf
,
3343 PCAP_ERRBUF_SIZE
) == -1)
3346 snprintf(remote_errbuf
, PCAP_ERRBUF_SIZE
, "Read of error message from client failed: %s", errbuf
);
3351 * Null-terminate it.
3353 remote_errbuf
[PCAP_ERRBUF_SIZE
- 1] = '\0';
3356 * Throw away the rest.
3358 (void)rpcap_discard(sockctrl
, ssl
, plen
- (PCAP_ERRBUF_SIZE
- 1), remote_errbuf
);
3362 /* Empty error string. */
3363 remote_errbuf
[0] = '\0';
3367 if (sock_recv(sockctrl
, ssl
, remote_errbuf
, plen
,
3368 SOCK_RECEIVEALL_YES
|SOCK_EOF_IS_ERROR
, errbuf
,
3369 PCAP_ERRBUF_SIZE
) == -1)
3372 snprintf(remote_errbuf
, PCAP_ERRBUF_SIZE
, "Read of error message from client failed: %s", errbuf
);
3377 * Null-terminate it.
3379 remote_errbuf
[plen
] = '\0';
3384 * Discard data from a connection.
3385 * Mostly used to discard wrong-sized messages.
3386 * Returns 0 on success, logs a message and returns -1 on a network
3389 static int rpcap_discard(SOCKET sock
, SSL
*ssl
, uint32 len
, char *errbuf
)
3393 if (sock_discard(sock
, ssl
, len
, errbuf
, PCAP_ERRBUF_SIZE
) == -1)
3403 * Read bytes into the pcap_t's buffer until we have the specified
3404 * number of bytes read or we get an error or interrupt indication.
3406 static int rpcap_read_packet_msg(struct pcap_rpcap
const *rp
, pcap_t
*p
, size_t size
)
3416 * Loop until we have the amount of data requested or we get
3417 * an error or interrupt.
3419 while ((size_t)cc
< size
)
3422 * We haven't read all of the packet header yet.
3423 * Read what remains, which could be all of it.
3425 bytes_read
= sock_recv(rp
->rmt_sockdata
, rp
->data_ssl
, bp
, size
- cc
,
3426 SOCK_RECEIVEALL_NO
|SOCK_EOF_IS_ERROR
, p
->errbuf
,
3429 if (bytes_read
== -1)
3432 * Network error. Update the read pointer and
3433 * byte count, and return an error indication.
3439 if (bytes_read
== -3)
3442 * Interrupted receive. Update the read
3443 * pointer and byte count, and return
3444 * an interrupted indication.
3450 if (bytes_read
== 0)
3453 * EOF - server terminated the connection.
3454 * Update the read pointer and byte count, and
3455 * return an error indication.
3457 snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
3458 "The server terminated the connection.");