3 Copyright (C) 2014 Proxmox Server Solutions GmbH
5 This software is written by Proxmox Server Solutions GmbH <support@proxmox.com>
7 This program is free software: you can redistribute it and/or modify
8 it under the terms of the GNU Affero General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU Affero General Public License for more details.
17 You should have received a copy of the GNU Affero General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 Author: Dietmar Maurer <dietmar@proxmox.com>
32 #include <sys/types.h>
36 #include <arpa/inet.h>
37 #include <sys/socket.h>
39 #include <linux/netlink.h>
40 #include <libnfnetlink/libnfnetlink.h>
41 #include <libnetfilter_log/libnetfilter_log.h>
42 #include <netinet/ip.h>
43 #include <netinet/ip_icmp.h>
44 #include <netinet/udp.h>
45 #include <netinet/tcp.h>
46 #include <netinet/if_ether.h>
50 #include <glib-unix.h>
52 static struct nflog_handle *logh = NULL;
53 static struct nlif_handle *nlifh = NULL;
60 Special care was taken to allow fast parsing (and filer messages for a singl VM).
62 <VMID> <LOGLEVEL> <CHAIN> <TIME> <TIMEZONE> <MSG>
66 117 6 tap117i0-IN 14/Mar/2014:12:47:07 +0100 policy REJECT: IN=vmbr1 ...
70 #define LOGFILE "/var/log/pve-firewall.log"
72 #define LOCKFILE "/var/lock/pvefw-logger.lck"
73 #define PIDFILE "/var/run/pvefw-logger.pid"
76 #define LE_MAX (512 - 4) // try to fit into 512 bytes
78 #define MAX_CHAIN_LEN 28
81 guint32 len; // max LE_MAX chars
85 #define STATIC_ASSERT(cond) \
86 extern void pve_static_assert(int test[(cond) ? 1 : -1])
88 STATIC_ASSERT(sizeof(struct log_entry) == 512);
92 gboolean terminate_threads = FALSE;
94 static gboolean write_pidfile(pid_t pid)
98 char *strpid = g_strdup_printf("%d\n", pid);
99 res = g_file_set_contents(PIDFILE, strpid, strlen(strpid), NULL);
105 static GAsyncQueue *queue;
108 safe_write(int fd, char *buf, size_t count)
113 n = write(fd, buf, count);
114 } while (n < 0 && errno == EINTR);
120 log_writer_thread(gpointer data)
123 struct log_entry *le = (struct log_entry *)g_async_queue_timeout_pop(queue, 250000);
125 if (terminate_threads) {
131 int res = safe_write(outfd, le->buf, le->len);
136 syslog(3, "writing log failed, stopping daemon - %s", strerror (errno));
137 g_main_loop_quit(main_loop);
145 static int skipped_logs = 0;
147 static void log_status_message(guint loglevel, const char *fmt, ...);
150 queue_log_entry(struct log_entry *le)
152 gint len = g_async_queue_length(queue);
154 if (skipped_logs > 0) {
155 if (len >= (LQ_LEN - 1)) {
158 int skip_tmp = skipped_logs;
159 skipped_logs = 0; // clear before calling log_status_message()
160 log_status_message(3, "skipped %d log entries (queue full)", skip_tmp);
161 g_async_queue_push(queue, le);
167 g_async_queue_push(queue, le);
173 #define LEPRINTF(format, ...) { if (le->len < LE_MAX) le->len += snprintf(le->buf + le->len, LE_MAX - le->len, format, ##__VA_ARGS__); }
174 #define LEPRINTTIME(sec) { time_t tmp_sec = sec; if (le->len < (LE_MAX - 30)) le->len += strftime(le->buf + le->len, LE_MAX - le->len, "%d/%b/%Y:%H:%M:%S %z ", localtime(&tmp_sec)); }
177 log_status_message(guint loglevel, const char *fmt, ...)
182 if (loglevel > 7 ) loglevel = 7; // syslog defines level 0-7
184 struct log_entry *le = g_new0(struct log_entry, 1);
186 LEPRINTF("0 %d - ", loglevel);
188 LEPRINTTIME(time(NULL));
190 le->len += vsnprintf(le->buf + le->len, LE_MAX - le->len, fmt, ap);
196 // also log to syslog
198 vsyslog(loglevel, fmt, ap);
202 print_tcp(struct log_entry *le, struct tcphdr *h, int payload_len)
204 LEPRINTF("PROTO=TCP ");
206 if (payload_len < sizeof(struct tcphdr)) {
207 LEPRINTF("LEN=%d ", payload_len);
208 LEPRINTF("INVALID=LEN ");
212 LEPRINTF("SPT=%u DPT=%u ", ntohs(h->source), ntohs(h->dest));
213 LEPRINTF("SEQ=%u ACK=%u ", ntohl(h->seq), ntohl(h->ack_seq));
214 LEPRINTF("WINDOW=%u ", ntohs(h->window));
216 if (h->urg) LEPRINTF("URG ");
217 if (h->ack) LEPRINTF("ACK ");
218 if (h->psh) LEPRINTF("PSH ");
219 if (h->rst) LEPRINTF("RST ");
220 if (h->syn) LEPRINTF("SYN ");
221 if (h->fin) LEPRINTF("FIN ");
223 if (h->urg) LEPRINTF("URGP=%u ",ntohs(h->urg_ptr));
229 print_udp(struct log_entry *le, struct udphdr *h, int payload_len)
231 LEPRINTF("PROTO=UDP ");
233 if (payload_len < sizeof(struct udphdr)) {
234 LEPRINTF("LEN=%d ", payload_len);
235 LEPRINTF("INVALID=LEN ");
239 LEPRINTF("SPT=%u DPT=%u LEN=%u", ntohs(h->source), ntohs(h->dest), ntohs(h->len));
245 print_icmp(struct log_entry *le, struct icmphdr *h, int payload_len)
247 char tmp[INET_ADDRSTRLEN];
250 LEPRINTF("PROTO=ICMP ");
252 if (payload_len < sizeof(struct icmphdr)) {
253 LEPRINTF("LEN=%d ", payload_len);
254 LEPRINTF("INVALID=LEN ");
258 LEPRINTF("TYPE=%u CODE=%u ", h->type, h->code);
263 LEPRINTF("ID=%u SEQ=%u ", ntohs(h->un.echo.id), ntohs(h->un.echo.sequence));
265 case ICMP_PARAMETERPROB:
266 LEPRINTF("PARAMETER=%u ", ntohl(h->un.gateway) >> 24);
269 gateway = ntohl(h->un.gateway);
270 inet_ntop(AF_INET, &gateway, tmp, sizeof(tmp));
271 LEPRINTF("GATEWAY=%s ", tmp);
273 case ICMP_DEST_UNREACH:
274 if (h->code == ICMP_FRAG_NEEDED) {
275 LEPRINTF("MTU=%u ", ntohs(h->un.frag.mtu));
283 /* Section 3.1. SCTP Common Header Format */
284 typedef struct sctphdr {
289 } __attribute__((packed)) sctp_sctphdr_t;
292 print_sctp(struct log_entry *le, struct sctphdr *h, int payload_len)
294 LEPRINTF("PROTO=SCTP ");
296 if (payload_len < sizeof(struct sctphdr)) {
297 LEPRINTF("LEN=%d ", payload_len);
298 LEPRINTF("INVALID=LEN ");
302 LEPRINTF("SPT=%u DPT=%u ", ntohs(h->source), ntohs(h->dest));
308 print_iphdr(struct log_entry *le, char * payload, int payload_len)
310 if (payload_len < sizeof(struct iphdr)) {
311 LEPRINTF("LEN=%d ", payload_len);
312 LEPRINTF("INVALID=LEN ");
316 struct iphdr *h = (struct iphdr *)payload;
318 if (payload_len <= (u_int32_t)(h->ihl * 4)) {
319 LEPRINTF("INVALID=IHL ");
323 char tmp[INET_ADDRSTRLEN];
325 inet_ntop(AF_INET, &h->saddr, tmp, sizeof(tmp));
326 LEPRINTF("SRC=%s ", tmp);
327 inet_ntop(AF_INET, &h->daddr, tmp, sizeof(tmp));
328 LEPRINTF("DST=%s ", tmp);
330 LEPRINTF("LEN=%u TOS=0x%02X PREC=0x%02X TTL=%u ID=%u ",
331 ntohs(h->tot_len), h->tos & IPTOS_TOS_MASK,
332 h->tos & IPTOS_PREC_MASK, h->ttl, ntohs(h->id));
334 short ip_off = ntohs(h->frag_off);
335 if (ip_off & IP_OFFMASK)
336 LEPRINTF("FRAG=%u ", ip_off & IP_OFFMASK);
338 if (ip_off & IP_DF) LEPRINTF("DF ");
339 if (ip_off & IP_MF) LEPRINTF("MF ");
341 void *nexthdr = (u_int32_t *)h + h->ihl;
342 payload_len -= h->ihl * 4;
344 switch (h->protocol) {
346 print_tcp(le, (struct tcphdr *)nexthdr, payload_len);
349 print_udp(le, (struct udphdr *)nexthdr, payload_len);
352 print_icmp(le, (struct icmphdr *)nexthdr, payload_len);
355 print_sctp(le, (struct sctphdr *)nexthdr, payload_len);
358 LEPRINTF("PROTO=AH ");
361 LEPRINTF("PROTO=ESP ");
364 LEPRINTF("PROTO=IGMP ");
367 LEPRINTF("PROTO=%u ", h->protocol);
374 print_ip6hdr(struct log_entry *le, char * payload, int payload_len)
376 LEPRINTF("IPV6 logging not implemented ");
381 // ebtables -I FORWARD --nflog --nflog-group 0
383 print_arp(struct log_entry *le, struct ether_arp *h, int payload_len)
385 if (payload_len < sizeof(struct ether_arp)) {
386 LEPRINTF("LEN=%d ", payload_len);
387 LEPRINTF("INVALID=LEN ");
391 LEPRINTF("SRC=%u.%u.%u.%u ", h->arp_spa[0], h->arp_spa[1],
392 h->arp_spa[2], h->arp_spa[3]);
394 LEPRINTF("DST=%u.%u.%u.%u ", h->arp_tpa[0], h->arp_tpa[1],
395 h->arp_tpa[2], h->arp_tpa[3]);
397 LEPRINTF("PROTO=ARP ");
399 unsigned short code = ntohs(h->arp_op);
402 LEPRINTF("REQUEST ");
405 LEPRINTF("REPLY MAC=%02x:%02x:%02x:%02x:%02x:%02x ",
406 h->arp_sha[0], h->arp_sha[1], h->arp_sha[2],
407 h->arp_sha[3], h->arp_sha[4], h->arp_sha[5]);
413 LEPRINTF("CODE=%u ", code);
417 // LEPRINTF("HTYPE=%u ", ntohs(h->arp_hrd));
419 // LEPRINTF("PTYPE=%u ", ntohs(h->arp_pro));
425 static int print_pkt(struct log_entry *le, struct nflog_data *ldata, u_int8_t family)
427 u_int32_t mark = nflog_get_nfmark(ldata);
428 u_int32_t indev = nflog_get_indev(ldata);
429 u_int32_t outdev = nflog_get_outdev(ldata);
430 u_int32_t physindev = nflog_get_physindev(ldata);
431 u_int32_t physoutdev = nflog_get_physoutdev(ldata);
433 char *prefix = nflog_get_prefix(ldata);
439 guint8 log_level = 6; // info
441 char *chain_name = "-";
443 if (prefix != NULL) {
444 // Note: parse ":$vmid:$loglevel:$chain: $msg"
445 if (prefix[0] == ':') {
446 char *p = prefix + 1;
448 while(*p >= '0' && *p <= '9') { tmpid *= 10; tmpid += *p - '0'; p++; }
451 (p[1] >= '0' && p[1] <= '7') &&
454 guint8 tmp_level = p[1] - '0'; // store for later use
455 char *chain_start = p + 3; // store for later use
457 while (*p && *p != ':' && *p != ' ') p++;
458 int len = p - chain_start;
460 if (*p == ':' && p[1] == ' ' && len && (len <= MAX_CHAIN_LEN)) {
461 // parsing successful
463 *p = 0; // terminate string
466 log_level = tmp_level;
467 chain_name = chain_start;
468 prefix = p + 2; // the rest
474 LEPRINTF("%d ", vmid);
476 LEPRINTF("%d ", log_level);
478 LEPRINTF("%s ", chain_name);
481 nflog_get_timestamp(ldata, &ts);
483 LEPRINTTIME(ts.tv_sec);
485 if (prefix != NULL) {
486 LEPRINTF("%s", prefix);
490 if (nlif_index2name(nlifh, indev, devname) != -1) {
491 LEPRINTF("IN=%s ", devname);
493 LEPRINTF("IN=%u ", indev);
498 if (nlif_index2name(nlifh, outdev, devname) != -1) {
499 LEPRINTF("OUT=%s ", devname);
501 LEPRINTF("OUT=%u ", outdev);
506 if (nlif_index2name(nlifh, physindev, devname) != -1) {
507 LEPRINTF("PHYSIN=%s ", devname);
509 LEPRINTF("PHYSIN=%u ", physindev);
513 if (physoutdev > 0) {
514 if (nlif_index2name(nlifh, physoutdev, devname) != -1) {
515 LEPRINTF("PHYSOUT=%s ", devname);
517 LEPRINTF("PHYSOUT=%u ", physoutdev);
521 int payload_len = nflog_get_payload(ldata, &payload);
523 int hwhdrlen = nflog_get_msg_packet_hwhdrlen(ldata);
525 unsigned char *hwhdr = (unsigned char *)nflog_get_msg_packet_hwhdr(ldata);
529 for (i = 0; i < hwhdrlen; i++) {
530 LEPRINTF("%02x", hwhdr[i]);
531 if (i < (hwhdrlen -1 )) LEPRINTF(":");
537 u_int16_t hw_protocol = 0;
538 struct nfulnl_msg_packet_hdr *ph = NULL;
542 print_iphdr(le, payload, payload_len);
545 print_ip6hdr(le, payload, payload_len);
548 ph = nflog_get_msg_packet_hdr(ldata);
549 if (ph) hw_protocol = ntohs(ph->hw_protocol);
551 switch (hw_protocol) {
553 print_iphdr(le, payload, payload_len);
556 print_ip6hdr(le, payload, payload_len);
559 print_arp(le, (struct ether_arp *)payload, payload_len);
565 if (mark) LEPRINTF("mark=%u ", mark);
573 nflog_cb(struct nflog_g_handle *gh, struct nfgenmsg *nfmsg,
574 struct nflog_data *nfa, void *data)
576 struct log_entry *le = g_new0(struct log_entry, 1);
578 print_pkt(le, nfa, nfmsg->nfgen_family);
580 LEPRINTF("\n"); // add newline
588 nflog_read_cb(GIOChannel *source,
589 GIOCondition condition,
595 int fd = g_io_channel_unix_get_fd(source);
597 if ((rv = recv(fd, buf, sizeof(buf), 0)) && rv >= 0) {
598 nflog_handle_packet(logh, buf, rv);
605 nlif_read_cb(GIOChannel *source,
606 GIOCondition condition,
609 static int last_res = 0;
612 if ((res = nlif_catch(nlifh)) < 0) {
613 if (last_res == 0) { // only report once
614 log_status_message(3, "nlif_catch failed (res = %d)", res);
625 terminate_request(gpointer data)
627 terminate_threads = TRUE;
629 log_status_message(5, "received terminate request (signal)");
631 g_main_loop_quit(main_loop);
638 main(int argc, char *argv[])
641 gboolean foreground = FALSE;
642 gboolean wrote_pidfile = FALSE;
646 openlog("pvepw-logger", LOG_CONS|LOG_PID, LOG_DAEMON);
648 if ((lockfd = open(LOCKFILE, O_RDWR|O_CREAT|O_APPEND, 0644)) == -1) {
649 fprintf(stderr, "unable to create lock '%s': %s", LOCKFILE, strerror (errno) );
653 for (int i = 10; i >= 0; i--) {
654 if (flock(lockfd, LOCK_EX|LOCK_NB) != 0) {
656 fprintf(stderr, "unable to aquire lock '%s': %s", LOCKFILE, strerror (errno));
660 fprintf(stderr, "unable to aquire lock '%s' - trying again.\n", LOCKFILE);
666 if ((outfd = open(LOGFILE, O_WRONLY|O_CREAT|O_APPEND, 0644)) == -1) {
667 fprintf(stderr, "unable to open file '%s': %s", LOGFILE, strerror (errno));
671 if ((logh = nflog_open()) == NULL) {
672 fprintf(stderr, "unable to open nflog\n");
676 if (!nflog_bind_pf(logh, AF_INET) <= 0) {
677 fprintf(stderr, "nflog_bind_pf AF_INET failed\n");
682 if (!nflog_bind_pf(logh, AF_INET6) <= 0) {
683 fprintf(stderr, "nflog_bind_pf AF_INET6 failed\n");
688 if (!nflog_bind_pf(logh, AF_BRIDGE) <= 0) {
689 fprintf(stderr, "nflog_bind_pf AF_BRIDGE failed\n");
693 struct nflog_g_handle *qh = nflog_bind_group(logh, 0);
695 fprintf(stderr, "no handle for group 1\n");
699 if (nflog_set_mode(qh, NFULNL_COPY_PACKET, 0xffff) < 0) {
700 fprintf(stderr, "can't set packet copy mode\n");
704 if ((nlifh = nlif_open()) == NULL) {
705 fprintf(stderr, "unable to open netlink interface handle\n");
713 fprintf(stderr, "failed to daemonize program - %s\n", strerror (errno));
721 if (chroot("/") != 0) fprintf(stderr, "chroot '/' failed - %s\n", strerror (errno));
723 if ((nullfd = open("/dev/null", O_RDWR, 0)) != -1) {
734 write_pidfile(getpid());
737 wrote_pidfile = TRUE;
739 nflog_callback_register(qh, &nflog_cb, logh);
741 queue = g_async_queue_new_full(g_free);
743 log_status_message(5, "starting pvefw logger");
747 GIOChannel *nlif_ch = g_io_channel_unix_new(nlif_fd(nlifh));
749 g_io_add_watch(nlif_ch, G_IO_IN, nlif_read_cb, NULL);
751 int logfd = nflog_fd(logh);
752 GIOChannel *nflog_ch = g_io_channel_unix_new(logfd);
754 g_io_add_watch(nflog_ch, G_IO_IN, nflog_read_cb, NULL);
756 GThread *wthread = g_thread_new("log_writer_thread", log_writer_thread, NULL);
758 main_loop = g_main_loop_new(NULL, TRUE);
760 g_unix_signal_add(SIGINT, terminate_request, NULL);
761 g_unix_signal_add(SIGTERM, terminate_request, NULL);
763 g_main_loop_run(main_loop);
765 log_status_message(5, "stopping pvefw logger");
767 g_thread_join(wthread);