1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) Tom Kistner <tom@duncanthrax.net> 2003 - 2015
7 * Copyright (c) The Exim Maintainers 2016
10 /* Code for calling virus (malware) scanners. Called from acl.c. */
13 #ifdef WITH_CONTENT_SCAN
15 typedef enum {M_FPROTD, M_DRWEB, M_AVES, M_FSEC, M_KAVD, M_CMDL,
16 M_SOPHIE, M_CLAMD, M_SOCK, M_MKSD, M_AVAST, M_FPROT6D} scanner_t;
17 typedef enum {MC_NONE, MC_TCP, MC_UNIX, MC_STRM} contype_t;
22 const uschar * options_default;
26 { M_FPROTD, US"f-protd", US"localhost 10200-10204", MC_TCP },
27 { M_DRWEB, US"drweb", US"/usr/local/drweb/run/drwebd.sock", MC_STRM },
28 { M_AVES, US"aveserver", US"/var/run/aveserver", MC_UNIX },
29 { M_FSEC, US"fsecure", US"/var/run/.fsav", MC_UNIX },
30 { M_KAVD, US"kavdaemon", US"/var/run/AvpCtl", MC_UNIX },
31 { M_CMDL, US"cmdline", NULL, MC_NONE },
32 { M_SOPHIE, US"sophie", US"/var/run/sophie", MC_UNIX },
33 { M_CLAMD, US"clamd", US"/tmp/clamd", MC_NONE },
34 { M_SOCK, US"sock", US"/tmp/malware.sock", MC_STRM },
35 { M_MKSD, US"mksd", NULL, MC_NONE },
36 { M_AVAST, US"avast", US"/var/run/avast/scan.sock", MC_STRM },
37 { M_FPROT6D, US"f-prot6d", US"localhost 10200", MC_TCP },
38 { -1, NULL, NULL, MC_NONE } /* end-marker */
41 /* The maximum number of clamd servers that are supported in the configuration */
42 #define MAX_CLAMD_SERVERS 32
43 #define MAX_CLAMD_SERVERS_S "32"
45 typedef struct clamd_address {
52 # define nelements(arr) (sizeof(arr) / sizeof(arr[0]))
56 #define MALWARE_TIMEOUT 120 /* default timeout, seconds */
59 #define DRWEBD_SCAN_CMD (1) /* scan file, buffer or diskfile */
60 #define DRWEBD_RETURN_VIRUSES (1<<0) /* ask daemon return to us viruses names from report */
61 #define DRWEBD_IS_MAIL (1<<19) /* say to daemon that format is "archive MAIL" */
63 #define DERR_READ_ERR (1<<0) /* read error */
64 #define DERR_NOMEMORY (1<<2) /* no memory */
65 #define DERR_TIMEOUT (1<<9) /* scan timeout has run out */
66 #define DERR_BAD_CALL (1<<15) /* wrong command */
69 static const uschar * malware_regex_default = US ".+";
70 static const pcre * malware_default_re = NULL;
72 static const uschar * drweb_re_str = US "infected\\swith\\s*(.+?)$";
73 static const pcre * drweb_re = NULL;
75 static const uschar * fsec_re_str = US "\\S{0,5}INFECTED\\t[^\\t]*\\t([^\\t]+)\\t\\S*$";
76 static const pcre * fsec_re = NULL;
78 static const uschar * kav_re_sus_str = US "suspicion:\\s*(.+?)\\s*$";
79 static const uschar * kav_re_inf_str = US "infected:\\s*(.+?)\\s*$";
80 static const pcre * kav_re_sus = NULL;
81 static const pcre * kav_re_inf = NULL;
83 static const uschar * ava_re_clean_str = US "(?!\\\\)\\t\\[\\+\\]";
84 static const uschar * ava_re_virus_str = US "(?!\\\\)\\t\\[L\\]\\d\\.\\d\\t\\d\\s(.*)";
85 static const pcre * ava_re_clean = NULL;
86 static const pcre * ava_re_virus = NULL;
88 static const uschar * fprot6d_re_error_str = US "^\\d+\\s<(.+?)>$";
89 static const uschar * fprot6d_re_virus_str = US "^\\d+\\s<infected:\\s+(.+?)>\\s+.+$";
90 static const pcre * fprot6d_re_error = NULL;
91 static const pcre * fprot6d_re_virus = NULL;
95 /******************************************************************************/
97 /* Routine to check whether a system is big- or little-endian.
98 Ripped from http://www.faqs.org/faqs/graphics/fileformats-faq/part4/section-7.html
99 Needed for proper kavdaemon implementation. Sigh. */
100 #define BIG_MY_ENDIAN 0
101 #define LITTLE_MY_ENDIAN 1
102 static int test_byte_order(void);
106 short int word = 0x0001;
107 char *byte = (char *) &word;
108 return(byte[0] ? LITTLE_MY_ENDIAN : BIG_MY_ENDIAN);
111 BOOL malware_ok = FALSE;
113 /* Gross hacks for the -bmalware option; perhaps we should just create
114 the scan directory normally for that case, but look into rigging up the
115 needed header variables if not already set on the command-line? */
116 extern int spool_mbox_ok;
117 extern uschar spooled_message_id[MESSAGE_ID_LENGTH+1];
122 malware_errlog_defer(const uschar * str)
124 log_write(0, LOG_MAIN|LOG_PANIC, "malware acl condition: %s", str);
129 m_errlog_defer(struct scan * scanent, const uschar * hostport,
132 return malware_errlog_defer(string_sprintf("%s %s : %s",
133 scanent->name, hostport ? hostport : CUS"", str));
136 m_errlog_defer_3(struct scan * scanent, const uschar * hostport,
137 const uschar * str, int fd_to_close)
139 (void) close(fd_to_close);
140 return m_errlog_defer(scanent, hostport, str);
143 /*************************************************/
145 /* Only used by the Clamav code, which is working from a list of servers and
146 uses the returned in_addr to get a second connection to the same system.
149 m_tcpsocket(const uschar * hostname, unsigned int port,
150 host_item * host, uschar ** errstr)
152 return ip_connectedsocket(SOCK_STREAM, hostname, port, port, 5, host, errstr);
156 m_sock_send(int sock, uschar * buf, int cnt, uschar ** errstr)
158 if (send(sock, buf, cnt, 0) < 0)
162 *errstr = string_sprintf("unable to send to socket (%s): %s",
170 m_pcre_compile(const uschar * re, uschar ** errstr)
172 const uschar * rerror;
176 cre = pcre_compile(CS re, PCRE_COPT, (const char **)&rerror, &roffset, NULL);
178 *errstr= string_sprintf("regular expression error in '%s': %s at offset %d",
179 re, rerror, roffset);
184 m_pcre_exec(const pcre * cre, uschar * text)
187 int i = pcre_exec(cre, NULL, CS text, Ustrlen(text), 0, 0,
188 ovector, nelements(ovector));
189 uschar * substr = NULL;
190 if (i >= 2) /* Got it */
191 pcre_get_substring(CS text, ovector, i, 1, (const char **) &substr);
196 m_pcre_nextinlist(const uschar ** list, int * sep,
197 char * listerr, uschar ** errstr)
199 const uschar * list_ele;
200 const pcre * cre = NULL;
202 if (!(list_ele = string_nextinlist(list, sep, NULL, 0)))
203 *errstr = US listerr;
205 cre = m_pcre_compile(CUS list_ele, errstr);
210 Simple though inefficient wrapper for reading a line. Drop CRs and the
211 trailing newline. Can return early on buffer full. Null-terminate.
212 Apply initial timeout if no data ready.
214 Return: number of chars - zero for an empty line
216 -2 on timeout or error
219 recv_line(int fd, uschar * buffer, int bsize, int tmo)
225 if (!fd_ready(fd, tmo-time(NULL)))
228 /*XXX tmo handling assumes we always get a whole line */
231 while ((rcv = read(fd, p, 1)) > 0)
234 if (p-buffer > bsize-2) break;
235 if (*p == '\n') break;
240 DEBUG(D_acl) debug_printf_indent("Malware scan: read %s (%s)\n",
241 rcv==0 ? "EOF" : "error", strerror(errno));
242 return rcv==0 ? -1 : -2;
246 DEBUG(D_acl) debug_printf_indent("Malware scan: read '%s'\n", buffer);
250 /* return TRUE iff size as requested */
252 recv_len(int sock, void * buf, int size, int tmo)
254 return fd_ready(sock, tmo-time(NULL))
255 ? recv(sock, buf, size, 0) == size
261 /* ============= private routines for the "mksd" scanner type ============== */
266 mksd_writev (int sock, struct iovec * iov, int iovcnt)
273 i = writev (sock, iov, iovcnt);
274 while (i < 0 && errno == EINTR);
277 (void) malware_errlog_defer(
278 US"unable to write to mksd UNIX socket (/var/run/mksd/socket)");
281 for (;;) /* check for short write */
282 if (i >= iov->iov_len)
292 iov->iov_base = CS iov->iov_base + i;
299 mksd_read_lines (int sock, uschar *av_buffer, int av_buffer_size, int tmo)
306 i = ip_recv(sock, av_buffer+offset, av_buffer_size-offset, tmo-time(NULL));
309 (void) malware_errlog_defer(US"unable to read from mksd UNIX socket (/var/run/mksd/socket)");
314 /* offset == av_buffer_size -> buffer full */
315 if (offset == av_buffer_size)
317 (void) malware_errlog_defer(US"malformed reply received from mksd");
320 } while (av_buffer[offset-1] != '\n');
322 av_buffer[offset] = '\0';
327 mksd_parse_line(struct scan * scanent, char * line)
338 if ((p = strchr (line, '\n')) != NULL)
340 return m_errlog_defer(scanent, NULL,
341 string_sprintf("scanner failed: %s", line));
344 if ((p = strchr (line, '\n')) != NULL)
349 && (p = strchr(line+4, ' ')) != NULL
354 malware_name = string_copy(US line+4);
358 return m_errlog_defer(scanent, NULL,
359 string_sprintf("malformed reply received: %s", line));
364 mksd_scan_packed(struct scan * scanent, int sock, const uschar * scan_filename,
368 const char *cmd = "MSQ\n";
369 uschar av_buffer[1024];
371 iov[0].iov_base = (void *) cmd;
373 iov[1].iov_base = (void *) scan_filename;
374 iov[1].iov_len = Ustrlen(scan_filename);
375 iov[2].iov_base = (void *) (cmd + 3);
378 if (mksd_writev (sock, iov, 3) < 0)
381 if (mksd_read_lines (sock, av_buffer, sizeof (av_buffer), tmo) < 0)
384 return mksd_parse_line (scanent, CS av_buffer);
389 clamd_option(clamd_address * cd, const uschar * optstr, int * subsep)
394 while ((s = string_nextinlist(&optstr, subsep, NULL, 0)))
395 if (Ustrncmp(s, "retry=", 6) == 0)
397 int sec = readconf_readtime((s += 6), '\0', FALSE);
407 /*************************************************
408 * Scan content for malware *
409 *************************************************/
411 /* This is an internal interface for scanning an email; the normal interface
412 is via malware(), or there's malware_in_file() used for testing/debugging.
415 malware_re match condition for "malware="
416 eml_filename the file holding the email to be scanned
417 timeout if nonzero, non-default timeoutl
418 faking whether or not we're faking this up for the -bmalware test
420 Returns: Exim message processing code (OK, FAIL, DEFER, ...)
421 where true means malware was found (condition applies)
424 malware_internal(const uschar * malware_re, const uschar * eml_filename,
425 int timeout, BOOL faking)
428 const uschar *av_scanner_work = av_scanner;
429 uschar *scanner_name;
430 unsigned long mbox_size;
434 struct scan * scanent;
435 const uschar * scanner_options;
439 /* make sure the eml mbox file is spooled up */
440 if (!(mbox_file = spool_mbox(&mbox_size, faking ? eml_filename : NULL)))
441 return malware_errlog_defer(US"error while creating mbox spool file");
443 /* none of our current scanners need the mbox
444 file as a stream, so we can close it right away */
445 (void)fclose(mbox_file);
448 return FAIL; /* empty means "don't match anything" */
450 /* parse 1st option */
451 if ( (strcmpic(malware_re, US"false") == 0) ||
452 (Ustrcmp(malware_re,"0") == 0) )
453 return FAIL; /* explicitly no matching */
455 /* special cases (match anything except empty) */
456 if ( strcmpic(malware_re,US"true") == 0
457 || Ustrcmp(malware_re,"*") == 0
458 || Ustrcmp(malware_re,"1") == 0
461 if ( !malware_default_re
462 && !(malware_default_re = m_pcre_compile(malware_regex_default, &errstr)))
463 return malware_errlog_defer(errstr);
464 malware_re = malware_regex_default;
465 re = malware_default_re;
468 /* compile the regex, see if it works */
469 else if (!(re = m_pcre_compile(malware_re, &errstr)))
470 return malware_errlog_defer(errstr);
472 /* Reset sep that is set by previous string_nextinlist() call */
475 /* if av_scanner starts with a dollar, expand it first */
476 if (*av_scanner == '$')
478 if (!(av_scanner_work = expand_string(av_scanner)))
479 return malware_errlog_defer(
480 string_sprintf("av_scanner starts with $, but expansion failed: %s",
481 expand_string_message));
484 debug_printf_indent("Expanded av_scanner global: %s\n", av_scanner_work);
485 /* disable result caching in this case */
490 /* Do not scan twice (unless av_scanner is dynamic). */
493 /* find the scanner type from the av_scanner option */
494 if (!(scanner_name = string_nextinlist(&av_scanner_work, &sep, NULL, 0)))
495 return malware_errlog_defer(US"av_scanner configuration variable is empty");
496 if (!timeout) timeout = MALWARE_TIMEOUT;
497 tmo = time(NULL) + timeout;
499 for (scanent = m_scans; ; scanent++)
502 return malware_errlog_defer(string_sprintf("unknown scanner type '%s'",
504 if (strcmpic(scanner_name, US scanent->name) != 0)
506 if (!(scanner_options = string_nextinlist(&av_scanner_work, &sep, NULL, 0)))
507 scanner_options = scanent->options_default;
508 if (scanent->conn == MC_NONE)
510 switch(scanent->conn)
512 case MC_TCP: sock = ip_tcpsocket(scanner_options, &errstr, 5); break;
513 case MC_UNIX: sock = ip_unixsocket(scanner_options, &errstr); break;
514 case MC_STRM: sock = ip_streamsocket(scanner_options, &errstr, 5); break;
515 default: /* compiler quietening */ break;
518 return m_errlog_defer(scanent, CUS callout_address, errstr);
521 DEBUG(D_acl) debug_printf_indent("Malware scan: %s tmo %s\n", scanner_name, readconf_printtime(timeout));
523 switch (scanent->scancode)
525 case M_FPROTD: /* "f-protd" scanner type -------------------------------- */
527 uschar *fp_scan_option;
528 unsigned int detected=0, par_count=0;
529 uschar * scanrequest;
530 uschar buf[32768], *strhelper, *strhelper2;
531 uschar * malware_name_internal = NULL;
534 scanrequest = string_sprintf("GET %s", eml_filename);
536 while ((fp_scan_option = string_nextinlist(&av_scanner_work, &sep,
539 scanrequest = string_sprintf("%s%s%s", scanrequest,
540 par_count ? "%20" : "?", fp_scan_option);
543 scanrequest = string_sprintf("%s HTTP/1.0\r\n\r\n", scanrequest);
544 DEBUG(D_acl) debug_printf_indent("Malware scan: issuing %s: %s\n",
545 scanner_name, scanrequest);
547 /* send scan request */
548 if (m_sock_send(sock, scanrequest, Ustrlen(scanrequest)+1, &errstr) < 0)
549 return m_errlog_defer(scanent, CUS callout_address, errstr);
551 while ((len = recv_line(sock, buf, sizeof(buf), tmo)) >= 0)
554 if (Ustrstr(buf, US"<detected type=\"") != NULL)
556 else if (detected && (strhelper = Ustrstr(buf, US"<name>")))
558 if ((strhelper2 = Ustrstr(buf, US"</name>")) != NULL)
561 malware_name_internal = string_copy(strhelper+6);
564 else if (Ustrstr(buf, US"<summary code=\""))
566 malware_name = Ustrstr(buf, US"<summary code=\"11\">")
567 ? malware_name_internal : NULL;
579 case M_DRWEB: /* "drweb" scanner type ----------------------------------- */
580 /* v0.1 - added support for tcp sockets */
581 /* v0.0 - initial release -- support for unix sockets */
585 unsigned int fsize_uint;
586 uschar * tmpbuf, *drweb_fbuf;
587 int drweb_rc, drweb_cmd, drweb_flags = 0x0000, drweb_fd,
588 drweb_vnum, drweb_slen, drweb_fin = 0x0000;
590 /* prepare variables */
591 drweb_cmd = htonl(DRWEBD_SCAN_CMD);
592 drweb_flags = htonl(DRWEBD_RETURN_VIRUSES | DRWEBD_IS_MAIL);
594 if (*scanner_options != '/')
597 if ((drweb_fd = open(CCS eml_filename, O_RDONLY)) == -1)
598 return m_errlog_defer_3(scanent, NULL,
599 string_sprintf("can't open spool file %s: %s",
600 eml_filename, strerror(errno)),
603 if ((fsize = lseek(drweb_fd, 0, SEEK_END)) == -1)
606 (void)close(drweb_fd);
607 return m_errlog_defer_3(scanent, NULL,
608 string_sprintf("can't seek spool file %s: %s",
609 eml_filename, strerror(err)),
612 fsize_uint = (unsigned int) fsize;
613 if ((off_t)fsize_uint != fsize)
615 (void)close(drweb_fd);
616 return m_errlog_defer_3(scanent, NULL,
617 string_sprintf("seeking spool file %s, size overflow",
621 drweb_slen = htonl(fsize);
622 lseek(drweb_fd, 0, SEEK_SET);
624 DEBUG(D_acl) debug_printf_indent("Malware scan: issuing %s remote scan [%s]\n",
625 scanner_name, scanner_options);
627 /* send scan request */
628 if ((send(sock, &drweb_cmd, sizeof(drweb_cmd), 0) < 0) ||
629 (send(sock, &drweb_flags, sizeof(drweb_flags), 0) < 0) ||
630 (send(sock, &drweb_fin, sizeof(drweb_fin), 0) < 0) ||
631 (send(sock, &drweb_slen, sizeof(drweb_slen), 0) < 0))
633 (void)close(drweb_fd);
634 return m_errlog_defer_3(scanent, CUS callout_address, string_sprintf(
635 "unable to send commands to socket (%s)", scanner_options),
639 if (!(drweb_fbuf = US malloc(fsize_uint)))
641 (void)close(drweb_fd);
642 return m_errlog_defer_3(scanent, NULL,
643 string_sprintf("unable to allocate memory %u for file (%s)",
644 fsize_uint, eml_filename),
648 if ((result = read (drweb_fd, drweb_fbuf, fsize)) == -1)
651 (void)close(drweb_fd);
653 return m_errlog_defer_3(scanent, NULL,
654 string_sprintf("can't read spool file %s: %s",
655 eml_filename, strerror(err)),
658 (void)close(drweb_fd);
660 /* send file body to socket */
661 if (send(sock, drweb_fbuf, fsize, 0) < 0)
664 return m_errlog_defer_3(scanent, CUS callout_address, string_sprintf(
665 "unable to send file body to socket (%s)", scanner_options),
671 drweb_slen = htonl(Ustrlen(eml_filename));
673 DEBUG(D_acl) debug_printf_indent("Malware scan: issuing %s local scan [%s]\n",
674 scanner_name, scanner_options);
676 /* send scan request */
677 if ((send(sock, &drweb_cmd, sizeof(drweb_cmd), 0) < 0) ||
678 (send(sock, &drweb_flags, sizeof(drweb_flags), 0) < 0) ||
679 (send(sock, &drweb_slen, sizeof(drweb_slen), 0) < 0) ||
680 (send(sock, eml_filename, Ustrlen(eml_filename), 0) < 0) ||
681 (send(sock, &drweb_fin, sizeof(drweb_fin), 0) < 0))
682 return m_errlog_defer_3(scanent, CUS callout_address, string_sprintf(
683 "unable to send commands to socket (%s)", scanner_options),
687 /* wait for result */
688 if (!recv_len(sock, &drweb_rc, sizeof(drweb_rc), tmo))
689 return m_errlog_defer_3(scanent, CUS callout_address,
690 US"unable to read return code", sock);
691 drweb_rc = ntohl(drweb_rc);
693 if (!recv_len(sock, &drweb_vnum, sizeof(drweb_vnum), tmo))
694 return m_errlog_defer_3(scanent, CUS callout_address,
695 US"unable to read the number of viruses", sock);
696 drweb_vnum = ntohl(drweb_vnum);
698 /* "virus(es) found" if virus number is > 0 */
703 /* setup default virus name */
704 malware_name = US"unknown";
706 /* set up match regex */
708 drweb_re = m_pcre_compile(drweb_re_str, &errstr);
710 /* read and concatenate virus names into one string */
711 for (i = 0; i < drweb_vnum; i++)
713 int size = 0, off = 0, ovector[10*3];
714 /* read the size of report */
715 if (!recv_len(sock, &drweb_slen, sizeof(drweb_slen), tmo))
716 return m_errlog_defer_3(scanent, CUS callout_address,
717 US"cannot read report size", sock);
718 drweb_slen = ntohl(drweb_slen);
719 tmpbuf = store_get(drweb_slen);
721 /* read report body */
722 if (!recv_len(sock, tmpbuf, drweb_slen, tmo))
723 return m_errlog_defer_3(scanent, CUS callout_address,
724 US"cannot read report string", sock);
725 tmpbuf[drweb_slen] = '\0';
727 /* try matcher on the line, grab substring */
728 result = pcre_exec(drweb_re, NULL, CS tmpbuf, Ustrlen(tmpbuf), 0, 0,
729 ovector, nelements(ovector));
732 const char * pre_malware_nb;
734 pcre_get_substring(CS tmpbuf, ovector, result, 1, &pre_malware_nb);
736 if (i==0) /* the first name we just copy to malware_name */
737 malware_name = string_append(NULL, &size, &off,
740 else /* concatenate each new virus name to previous */
741 malware_name = string_append(malware_name, &size, &off,
742 2, "/", pre_malware_nb);
744 pcre_free_substring(pre_malware_nb);
750 const char *drweb_s = NULL;
752 if (drweb_rc & DERR_READ_ERR) drweb_s = "read error";
753 if (drweb_rc & DERR_NOMEMORY) drweb_s = "no memory";
754 if (drweb_rc & DERR_TIMEOUT) drweb_s = "timeout";
755 if (drweb_rc & DERR_BAD_CALL) drweb_s = "wrong command";
756 /* retcodes DERR_SYMLINK, DERR_NO_REGFILE, DERR_SKIPPED.
757 * DERR_TOO_BIG, DERR_TOO_COMPRESSED, DERR_SPAM,
758 * DERR_CRC_ERROR, DERR_READSOCKET, DERR_WRITE_ERR
759 * and others are ignored */
761 return m_errlog_defer_3(scanent, CUS callout_address,
762 string_sprintf("drweb daemon retcode 0x%x (%s)", drweb_rc, drweb_s),
771 case M_AVES: /* "aveserver" scanner type -------------------------------- */
776 /* read aveserver's greeting and see if it is ready (2xx greeting) */
778 recv_line(sock, buf, sizeof(buf), tmo);
780 if (buf[0] != '2') /* aveserver is having problems */
781 return m_errlog_defer_3(scanent, CUS callout_address,
782 string_sprintf("unavailable (Responded: %s).",
783 ((buf[0] != 0) ? buf : (uschar *)"nothing") ),
786 /* prepare our command */
787 (void)string_format(buf, sizeof(buf), "SCAN bPQRSTUW %s\r\n",
791 DEBUG(D_acl) debug_printf_indent("Malware scan: issuing %s %s\n",
793 if (m_sock_send(sock, buf, Ustrlen(buf), &errstr) < 0)
794 return m_errlog_defer(scanent, CUS callout_address, errstr);
798 /* read response lines, find malware name and final response */
799 while (recv_line(sock, buf, sizeof(buf), tmo) > 0)
803 if (buf[0] == '5') /* aveserver is having problems */
805 result = m_errlog_defer(scanent, CUS callout_address,
806 string_sprintf("unable to scan file %s (Responded: %s).",
810 if (Ustrncmp(buf,"322",3) == 0)
812 uschar *p = Ustrchr(&buf[4], ' ');
814 malware_name = string_copy(&buf[4]);
818 if (m_sock_send(sock, US"quit\r\n", 6, &errstr) < 0)
819 return m_errlog_defer(scanent, CUS callout_address, errstr);
821 /* read aveserver's greeting and see if it is ready (2xx greeting) */
823 recv_line(sock, buf, sizeof(buf), tmo);
825 if (buf[0] != '2') /* aveserver is having problems */
826 return m_errlog_defer_3(scanent, CUS callout_address,
827 string_sprintf("unable to quit dialogue (Responded: %s).",
828 ((buf[0] != 0) ? buf : (uschar *)"nothing") ),
839 case M_FSEC: /* "fsecure" scanner type ---------------------------------- */
843 uschar av_buffer[1024];
844 static uschar *cmdopt[] = { US"CONFIGURE\tARCHIVE\t1\n",
845 US"CONFIGURE\tTIMEOUT\t0\n",
846 US"CONFIGURE\tMAXARCH\t5\n",
847 US"CONFIGURE\tMIME\t1\n" };
851 DEBUG(D_acl) debug_printf_indent("Malware scan: issuing %s scan [%s]\n",
852 scanner_name, scanner_options);
854 memset(av_buffer, 0, sizeof(av_buffer));
855 for (i = 0; i != nelements(cmdopt); i++)
858 if (m_sock_send(sock, cmdopt[i], Ustrlen(cmdopt[i]), &errstr) < 0)
859 return m_errlog_defer(scanent, CUS callout_address, errstr);
861 bread = ip_recv(sock, av_buffer, sizeof(av_buffer), tmo-time(NULL));
862 if (bread > 0) av_buffer[bread]='\0';
864 return m_errlog_defer_3(scanent, CUS callout_address,
865 string_sprintf("unable to read answer %d (%s)", i, strerror(errno)),
867 for (j = 0; j < bread; j++)
868 if (av_buffer[j] == '\r' || av_buffer[j] == '\n')
872 /* pass the mailfile to fsecure */
873 file_name = string_sprintf("SCAN\t%s\n", eml_filename);
875 if (m_sock_send(sock, file_name, Ustrlen(file_name), &errstr) < 0)
876 return m_errlog_defer(scanent, CUS callout_address, errstr);
879 /* todo also SUSPICION\t */
881 fsec_re = m_pcre_compile(fsec_re_str, &errstr);
883 /* read report, linewise. Apply a timeout as the Fsecure daemon
884 sometimes wants an answer to "PING" but they won't tell us what */
886 uschar * p = av_buffer;
892 i = av_buffer+sizeof(av_buffer)-p;
893 if ((bread= ip_recv(sock, p, i-1, tmo-time(NULL))) < 0)
894 return m_errlog_defer_3(scanent, CUS callout_address,
895 string_sprintf("unable to read result (%s)", strerror(errno)),
898 for (p[bread] = '\0'; (q = Ustrchr(p, '\n')); p = q+1)
902 /* Really search for virus again? */
904 /* try matcher on the line, grab substring */
905 malware_name = m_pcre_exec(fsec_re, p);
907 if (Ustrstr(p, "OK\tScan ok."))
911 /* copy down the trailing partial line then read another chunk */
912 i = av_buffer+sizeof(av_buffer)-p;
913 memmove(av_buffer, p, i);
922 case M_KAVD: /* "kavdaemon" scanner type -------------------------------- */
926 uschar * scanrequest;
928 unsigned long kav_reportlen;
933 /* get current date and time, build scan request */
935 /* pdp note: before the eml_filename parameter, this scanned the
936 directory; not finding documentation, so we'll strip off the directory.
937 The side-effect is that the test framework scanning may end up in
938 scanning more than was requested, but for the normal interface, this is
941 strftime(CS tmpbuf, sizeof(tmpbuf), "%d %b %H:%M:%S", localtime(&t));
942 scanrequest = string_sprintf("<0>%s:%s", CS tmpbuf, eml_filename);
943 p = Ustrrchr(scanrequest, '/');
947 DEBUG(D_acl) debug_printf_indent("Malware scan: issuing %s scan [%s]\n",
948 scanner_name, scanner_options);
950 /* send scan request */
951 if (m_sock_send(sock, scanrequest, Ustrlen(scanrequest)+1, &errstr) < 0)
952 return m_errlog_defer(scanent, CUS callout_address, errstr);
954 /* wait for result */
955 if (!recv_len(sock, tmpbuf, 2, tmo))
956 return m_errlog_defer_3(scanent, CUS callout_address,
957 US"unable to read 2 bytes from socket.", sock);
959 /* get errorcode from one nibble */
960 kav_rc = tmpbuf[ test_byte_order()==LITTLE_MY_ENDIAN ? 0 : 1 ] & 0x0F;
963 case 5: case 6: /* improper kavdaemon configuration */
964 return m_errlog_defer_3(scanent, CUS callout_address,
965 US"please reconfigure kavdaemon to NOT disinfect or remove infected files.",
968 return m_errlog_defer_3(scanent, CUS callout_address,
969 US"reported 'scanning not completed' (code 1).", sock);
971 return m_errlog_defer_3(scanent, CUS callout_address,
972 US"reported 'kavdaemon damaged' (code 7).", sock);
975 /* code 8 is not handled, since it is ambiguous. It appears mostly on
976 bounces where part of a file has been cut off */
978 /* "virus found" return codes (2-4) */
979 if (kav_rc > 1 && kav_rc < 5)
983 /* setup default virus name */
984 malware_name = US"unknown";
986 report_flag = tmpbuf[ test_byte_order() == LITTLE_MY_ENDIAN ? 1 : 0 ];
988 /* read the report, if available */
989 if (report_flag == 1)
991 /* read report size */
992 if (!recv_len(sock, &kav_reportlen, 4, tmo))
993 return m_errlog_defer_3(scanent, CUS callout_address,
994 US"cannot read report size", sock);
996 /* it's possible that avp returns av_buffer[1] == 1 but the
997 reportsize is 0 (!?) */
998 if (kav_reportlen > 0)
1000 /* set up match regex, depends on retcode */
1003 if (!kav_re_sus) kav_re_sus = m_pcre_compile(kav_re_sus_str, &errstr);
1004 kav_re = kav_re_sus;
1008 if (!kav_re_inf) kav_re_inf = m_pcre_compile(kav_re_inf_str, &errstr);
1009 kav_re = kav_re_inf;
1012 /* read report, linewise. Using size from stream to read amount of data
1013 from same stream is safe enough. */
1014 /* coverity[tainted_data] */
1015 while (kav_reportlen > 0)
1017 if ((bread = recv_line(sock, tmpbuf, sizeof(tmpbuf), tmo)) < 0)
1019 kav_reportlen -= bread+1;
1021 /* try matcher on the line, grab substring */
1022 if ((malware_name = m_pcre_exec(kav_re, tmpbuf)))
1028 else /* no virus found */
1029 malware_name = NULL;
1034 case M_CMDL: /* "cmdline" scanner type ---------------------------------- */
1036 const uschar *cmdline_scanner = scanner_options;
1037 const pcre *cmdline_trigger_re;
1038 const pcre *cmdline_regex_re;
1040 uschar * commandline;
1041 void (*eximsigchld)(int);
1042 void (*eximsigpipe)(int);
1043 FILE *scanner_out = NULL;
1045 FILE *scanner_record = NULL;
1046 uschar linebuffer[32767];
1051 if (!cmdline_scanner)
1052 return m_errlog_defer(scanent, NULL, errstr);
1054 /* find scanner output trigger */
1055 cmdline_trigger_re = m_pcre_nextinlist(&av_scanner_work, &sep,
1056 "missing trigger specification", &errstr);
1057 if (!cmdline_trigger_re)
1058 return m_errlog_defer(scanent, NULL, errstr);
1060 /* find scanner name regex */
1061 cmdline_regex_re = m_pcre_nextinlist(&av_scanner_work, &sep,
1062 "missing virus name regex specification", &errstr);
1063 if (!cmdline_regex_re)
1064 return m_errlog_defer(scanent, NULL, errstr);
1066 /* prepare scanner call; despite the naming, file_name holds a directory
1067 name which is documented as the value given to %s. */
1069 file_name = string_copy(eml_filename);
1070 p = Ustrrchr(file_name, '/');
1073 commandline = string_sprintf(CS cmdline_scanner, file_name);
1075 /* redirect STDERR too */
1076 commandline = string_sprintf("%s 2>&1", commandline);
1078 DEBUG(D_acl) debug_printf_indent("Malware scan: issuing %s scan [%s]\n",
1079 scanner_name, commandline);
1081 /* store exims signal handlers */
1082 eximsigchld = signal(SIGCHLD,SIG_DFL);
1083 eximsigpipe = signal(SIGPIPE,SIG_DFL);
1085 if (!(scanner_out = popen(CS commandline,"r")))
1088 signal(SIGCHLD,eximsigchld); signal(SIGPIPE,eximsigpipe);
1089 return m_errlog_defer(scanent, NULL,
1090 string_sprintf("call (%s) failed: %s.", commandline, strerror(err)));
1092 scanner_fd = fileno(scanner_out);
1094 file_name = string_sprintf("%s/scan/%s/%s_scanner_output",
1095 spool_directory, message_id, message_id);
1097 if (!(scanner_record = modefopen(file_name, "wb", SPOOL_MODE)))
1100 (void) pclose(scanner_out);
1101 signal(SIGCHLD,eximsigchld); signal(SIGPIPE,eximsigpipe);
1102 return m_errlog_defer(scanent, NULL, string_sprintf(
1103 "opening scanner output file (%s) failed: %s.",
1104 file_name, strerror(err)));
1107 /* look for trigger while recording output */
1108 while ((rcnt = recv_line(scanner_fd, linebuffer,
1109 sizeof(linebuffer), tmo)))
1116 (void) pclose(scanner_out);
1117 signal(SIGCHLD,eximsigchld); signal(SIGPIPE,eximsigpipe);
1118 return m_errlog_defer(scanent, NULL, string_sprintf(
1119 "unable to read from scanner (%s): %s",
1120 commandline, strerror(err)));
1123 if (Ustrlen(linebuffer) > fwrite(linebuffer, 1, Ustrlen(linebuffer), scanner_record))
1126 (void) pclose(scanner_out);
1127 signal(SIGCHLD,eximsigchld); signal(SIGPIPE,eximsigpipe);
1128 return m_errlog_defer(scanent, NULL, string_sprintf(
1129 "short write on scanner output file (%s).", file_name));
1131 putc('\n', scanner_record);
1132 /* try trigger match */
1134 && regex_match_and_setup(cmdline_trigger_re, linebuffer, 0, -1)
1139 (void)fclose(scanner_record);
1140 sep = pclose(scanner_out);
1141 signal(SIGCHLD,eximsigchld); signal(SIGPIPE,eximsigpipe);
1143 return m_errlog_defer(scanent, NULL,
1145 ? string_sprintf("running scanner failed: %s", strerror(sep))
1146 : string_sprintf("scanner returned error code: %d", sep));
1151 /* setup default virus name */
1152 malware_name = US"unknown";
1154 /* re-open the scanner output file, look for name match */
1155 scanner_record = fopen(CS file_name, "rb");
1156 while (fgets(CS linebuffer, sizeof(linebuffer), scanner_record))
1159 if ((s = m_pcre_exec(cmdline_regex_re, linebuffer)))
1162 (void)fclose(scanner_record);
1164 else /* no virus found */
1165 malware_name = NULL;
1169 case M_SOPHIE: /* "sophie" scanner type --------------------------------- */
1174 uschar av_buffer[1024];
1176 /* pass the scan directory to sophie */
1177 file_name = string_copy(eml_filename);
1178 if ((p = Ustrrchr(file_name, '/')))
1181 DEBUG(D_acl) debug_printf_indent("Malware scan: issuing %s scan [%s]\n",
1182 scanner_name, scanner_options);
1184 if ( write(sock, file_name, Ustrlen(file_name)) < 0
1185 || write(sock, "\n", 1) != 1
1187 return m_errlog_defer_3(scanent, CUS callout_address,
1188 string_sprintf("unable to write to UNIX socket (%s)", scanner_options),
1191 /* wait for result */
1192 memset(av_buffer, 0, sizeof(av_buffer));
1193 if ((bread = ip_recv(sock, av_buffer, sizeof(av_buffer), tmo-time(NULL))) <= 0)
1194 return m_errlog_defer_3(scanent, CUS callout_address,
1195 string_sprintf("unable to read from UNIX socket (%s)", scanner_options),
1199 if (av_buffer[0] == '1') {
1200 uschar * s = Ustrchr(av_buffer, '\n');
1203 malware_name = string_copy(&av_buffer[2]);
1205 else if (!strncmp(CS av_buffer, "-1", 2))
1206 return m_errlog_defer_3(scanent, CUS callout_address,
1207 US"scanner reported error", sock);
1208 else /* all ok, no virus */
1209 malware_name = NULL;
1214 case M_CLAMD: /* "clamd" scanner type ----------------------------------- */
1216 /* This code was originally contributed by David Saez */
1217 /* There are three scanning methods available to us:
1218 * (1) Use the SCAN command, pointing to a file in the filesystem
1219 * (2) Use the STREAM command, send the data on a separate port
1220 * (3) Use the zINSTREAM command, send the data inline
1221 * The zINSTREAM command was introduced with ClamAV 0.95, which marked
1222 * STREAM deprecated; see: http://wiki.clamav.net/bin/view/Main/UpgradeNotes095
1223 * In Exim, we use SCAN if using a Unix-domain socket or explicitly told that
1224 * the TCP-connected daemon is actually local; otherwise we use zINSTREAM unless
1225 * WITH_OLD_CLAMAV_STREAM is defined.
1226 * See Exim bug 926 for details. */
1228 uschar *p, *vname, *result_tag;
1231 uschar av_buffer[1024];
1232 uschar *hostname = US"";
1234 uschar *clamav_fbuf;
1235 int clam_fd, result;
1237 unsigned int fsize_uint;
1238 BOOL use_scan_command = FALSE;
1239 clamd_address * cv[MAX_CLAMD_SERVERS];
1240 int num_servers = 0;
1241 #ifdef WITH_OLD_CLAMAV_STREAM
1243 uschar av_buffer2[1024];
1246 uint32_t send_size, send_final_zeroblock;
1249 /*XXX if unixdomain socket, only one server supported. Needs fixing;
1250 there's no reason we should not mix local and remote servers */
1252 if (*scanner_options == '/')
1255 const uschar * sublist;
1258 /* Local file; so we def want to use_scan_command and don't want to try
1259 * passing IP/port combinations */
1260 use_scan_command = TRUE;
1261 cd = (clamd_address *) store_get(sizeof(clamd_address));
1263 /* extract socket-path part */
1264 sublist = scanner_options;
1265 cd->hostspec = string_nextinlist(&sublist, &subsep, NULL, 0);
1268 if (clamd_option(cd, sublist, &subsep) != OK)
1269 return m_errlog_defer(scanent, NULL,
1270 string_sprintf("bad option '%s'", scanner_options));
1275 /* Go through the rest of the list of host/port and construct an array
1276 * of servers to try. The first one is the bit we just passed from
1277 * scanner_options so process that first and then scan the remainder of
1278 * the address buffer */
1282 const uschar * sublist;
1286 /* The 'local' option means use the SCAN command over the network
1287 * socket (ie common file storage in use) */
1288 /*XXX we could accept this also as a local option? */
1289 if (strcmpic(scanner_options, US"local") == 0)
1291 use_scan_command = TRUE;
1295 cd = (clamd_address *) store_get(sizeof(clamd_address));
1297 /* extract host and port part */
1298 sublist = scanner_options;
1299 if (!(cd->hostspec = string_nextinlist(&sublist, &subsep, NULL, 0)))
1301 (void) m_errlog_defer(scanent, NULL,
1302 string_sprintf("missing address: '%s'", scanner_options));
1305 if (!(s = string_nextinlist(&sublist, &subsep, NULL, 0)))
1307 (void) m_errlog_defer(scanent, NULL,
1308 string_sprintf("missing port: '%s'", scanner_options));
1311 cd->tcp_port = atoi(CS s);
1314 /*XXX should these options be common over scanner types? */
1315 if (clamd_option(cd, sublist, &subsep) != OK)
1316 return m_errlog_defer(scanent, NULL,
1317 string_sprintf("bad option '%s'", scanner_options));
1319 cv[num_servers++] = cd;
1320 if (num_servers >= MAX_CLAMD_SERVERS)
1322 (void) m_errlog_defer(scanent, NULL,
1323 US"More than " MAX_CLAMD_SERVERS_S " clamd servers "
1324 "specified; only using the first " MAX_CLAMD_SERVERS_S );
1327 } while ((scanner_options = string_nextinlist(&av_scanner_work, &sep,
1330 /* check if we have at least one server */
1332 return m_errlog_defer(scanent, NULL,
1333 US"no useable server addresses in malware configuration option.");
1336 /* See the discussion of response formats below to see why we really
1337 don't like colons in filenames when passing filenames to ClamAV. */
1338 if (use_scan_command && Ustrchr(eml_filename, ':'))
1339 return m_errlog_defer(scanent, NULL,
1340 string_sprintf("local/SCAN mode incompatible with" \
1341 " : in path to email filename [%s]", eml_filename));
1343 /* We have some network servers specified */
1346 /* Confirmed in ClamAV source (0.95.3) that the TCPAddr option of clamd
1347 * only supports AF_INET, but we should probably be looking to the
1348 * future and rewriting this to be protocol-independent anyway. */
1350 while (num_servers > 0)
1352 int i = random_number( num_servers );
1353 clamd_address * cd = cv[i];
1355 DEBUG(D_acl) debug_printf_indent("trying server name %s, port %u\n",
1356 cd->hostspec, cd->tcp_port);
1358 /* Lookup the host. This is to ensure that we connect to the same IP
1359 * on both connections (as one host could resolve to multiple ips) */
1362 sock= m_tcpsocket(cd->hostspec, cd->tcp_port, &connhost, &errstr);
1365 /* Connection successfully established with a server */
1366 hostname = cd->hostspec;
1369 if (cd->retry <= 0) break;
1370 while (cd->retry > 0) cd->retry = sleep(cd->retry);
1375 (void) m_errlog_defer(scanent, CUS callout_address, errstr);
1377 /* Remove the server from the list. XXX We should free the memory */
1379 for (; i < num_servers; i++)
1383 if (num_servers == 0)
1384 return m_errlog_defer(scanent, NULL, US"all servers failed");
1389 if ((sock = ip_unixsocket(cv[0]->hostspec, &errstr)) >= 0)
1391 hostname = cv[0]->hostspec;
1394 if (cv[0]->retry <= 0)
1395 return m_errlog_defer(scanent, CUS callout_address, errstr);
1396 while (cv[0]->retry > 0) cv[0]->retry = sleep(cv[0]->retry);
1399 /* have socket in variable "sock"; command to use is semi-independent of
1400 * the socket protocol. We use SCAN if is local (either Unix/local
1401 * domain socket, or explicitly told local) else we stream the data.
1402 * How we stream the data depends upon how we were built. */
1404 if (!use_scan_command)
1406 #ifdef WITH_OLD_CLAMAV_STREAM
1407 /* "STREAM\n" command, get back a "PORT <N>\n" response, send data to
1408 * that port on a second connection; then in the scan-method-neutral
1409 * part, read the response back on the original connection. */
1411 DEBUG(D_acl) debug_printf_indent(
1412 "Malware scan: issuing %s old-style remote scan (PORT)\n",
1415 /* Pass the string to ClamAV (7 = "STREAM\n") */
1416 if (m_sock_send(sock, US"STREAM\n", 7, &errstr) < 0)
1417 return m_errlog_defer(scanent, CUS callout_address, errstr);
1419 memset(av_buffer2, 0, sizeof(av_buffer2));
1420 bread = ip_recv(sock, av_buffer2, sizeof(av_buffer2), tmo-time(NULL));
1423 return m_errlog_defer_3(scanent, CUS callout_address,
1424 string_sprintf("unable to read PORT from socket (%s)",
1428 if (bread == sizeof(av_buffer2))
1429 return m_errlog_defer_3(scanent, CUS callout_address,
1430 "buffer too small", sock);
1433 return m_errlog_defer_3(scanent, CUS callout_address,
1434 "ClamAV returned null", sock);
1436 av_buffer2[bread] = '\0';
1437 if( sscanf(CS av_buffer2, "PORT %u\n", &port) != 1 )
1438 return m_errlog_defer_3(scanent, CUS callout_address,
1439 string_sprintf("Expected port information from clamd, got '%s'",
1443 sockData = m_tcpsocket(connhost.address, port, NULL, &errstr);
1445 return m_errlog_defer_3(scanent, CUS callout_address, errstr, sock);
1447 # define CLOSE_SOCKDATA (void)close(sockData)
1448 #else /* WITH_OLD_CLAMAV_STREAM not defined */
1449 /* New protocol: "zINSTREAM\n" followed by a sequence of <length><data>
1450 chunks, <n> a 4-byte number (network order), terminated by a zero-length
1453 DEBUG(D_acl) debug_printf_indent(
1454 "Malware scan: issuing %s new-style remote scan (zINSTREAM)\n",
1457 /* Pass the string to ClamAV (10 = "zINSTREAM\0") */
1458 if (send(sock, "zINSTREAM", 10, 0) < 0)
1459 return m_errlog_defer_3(scanent, CUS hostname,
1460 string_sprintf("unable to send zINSTREAM to socket (%s)",
1464 # define CLOSE_SOCKDATA /**/
1467 /* calc file size */
1468 if ((clam_fd = open(CS eml_filename, O_RDONLY)) < 0)
1472 return m_errlog_defer_3(scanent, NULL,
1473 string_sprintf("can't open spool file %s: %s",
1474 eml_filename, strerror(err)),
1477 if ((fsize = lseek(clam_fd, 0, SEEK_END)) < 0)
1480 CLOSE_SOCKDATA; (void)close(clam_fd);
1481 return m_errlog_defer_3(scanent, NULL,
1482 string_sprintf("can't seek spool file %s: %s",
1483 eml_filename, strerror(err)),
1486 fsize_uint = (unsigned int) fsize;
1487 if ((off_t)fsize_uint != fsize)
1489 CLOSE_SOCKDATA; (void)close(clam_fd);
1490 return m_errlog_defer_3(scanent, NULL,
1491 string_sprintf("seeking spool file %s, size overflow",
1495 lseek(clam_fd, 0, SEEK_SET);
1497 if (!(clamav_fbuf = US malloc(fsize_uint)))
1499 CLOSE_SOCKDATA; (void)close(clam_fd);
1500 return m_errlog_defer_3(scanent, NULL,
1501 string_sprintf("unable to allocate memory %u for file (%s)",
1502 fsize_uint, eml_filename),
1506 if ((result = read(clam_fd, clamav_fbuf, fsize_uint)) < 0)
1509 free(clamav_fbuf); CLOSE_SOCKDATA; (void)close(clam_fd);
1510 return m_errlog_defer_3(scanent, NULL,
1511 string_sprintf("can't read spool file %s: %s",
1512 eml_filename, strerror(err)),
1515 (void)close(clam_fd);
1517 /* send file body to socket */
1518 #ifdef WITH_OLD_CLAMAV_STREAM
1519 if (send(sockData, clamav_fbuf, fsize_uint, 0) < 0)
1521 free(clamav_fbuf); CLOSE_SOCKDATA;
1522 return m_errlog_defer_3(scanent, NULL,
1523 string_sprintf("unable to send file body to socket (%s:%u)",
1528 send_size = htonl(fsize_uint);
1529 send_final_zeroblock = 0;
1530 if ((send(sock, &send_size, sizeof(send_size), 0) < 0) ||
1531 (send(sock, clamav_fbuf, fsize_uint, 0) < 0) ||
1532 (send(sock, &send_final_zeroblock, sizeof(send_final_zeroblock), 0) < 0))
1535 return m_errlog_defer_3(scanent, NULL,
1536 string_sprintf("unable to send file body to socket (%s)", hostname),
1544 #undef CLOSE_SOCKDATA
1547 { /* use scan command */
1548 /* Send a SCAN command pointing to a filename; then in the then in the
1549 * scan-method-neutral part, read the response back */
1551 /* ================================================================= */
1553 /* Prior to the reworking post-Exim-4.72, this scanned a directory,
1554 which dates to when ClamAV needed us to break apart the email into the
1555 MIME parts (eg, with the now deprecated demime condition coming first).
1556 Some time back, ClamAV gained the ability to deconstruct the emails, so
1557 doing this would actually have resulted in the mail attachments being
1558 scanned twice, in the broken out files and from the original .eml.
1559 Since ClamAV now handles emails (and has for quite some time) we can
1560 just use the email file itself. */
1561 /* Pass the string to ClamAV (7 = "SCAN \n" + \0) */
1562 file_name = string_sprintf("SCAN %s\n", eml_filename);
1564 DEBUG(D_acl) debug_printf_indent(
1565 "Malware scan: issuing %s local-path scan [%s]\n",
1566 scanner_name, scanner_options);
1568 if (send(sock, file_name, Ustrlen(file_name), 0) < 0)
1569 return m_errlog_defer_3(scanent, CUS callout_address,
1570 string_sprintf("unable to write to socket (%s)", strerror(errno)),
1573 /* Do not shut down the socket for writing; a user report noted that
1574 * clamd 0.70 does not react well to this. */
1576 /* Commands have been sent, no matter which scan method or connection
1577 * type we're using; now just read the result, independent of method. */
1579 /* Read the result */
1580 memset(av_buffer, 0, sizeof(av_buffer));
1581 bread = ip_recv(sock, av_buffer, sizeof(av_buffer), tmo-time(NULL));
1586 return m_errlog_defer(scanent, CUS callout_address,
1587 string_sprintf("unable to read from socket (%s)",
1588 errno == 0 ? "EOF" : strerror(errno)));
1590 if (bread == sizeof(av_buffer))
1591 return m_errlog_defer(scanent, CUS callout_address,
1592 US"buffer too small");
1593 /* We're now assured of a NULL at the end of av_buffer */
1595 /* Check the result. ClamAV returns one of two result formats.
1596 In the basic mode, the response is of the form:
1597 infected: -> "<filename>: <virusname> FOUND"
1598 not-infected: -> "<filename>: OK"
1599 error: -> "<filename>: <errcode> ERROR
1600 If the ExtendedDetectionInfo option has been turned on, then we get:
1601 "<filename>: <virusname>(<virushash>:<virussize>) FOUND"
1602 for the infected case. Compare:
1603 /tmp/eicar.com: Eicar-Test-Signature FOUND
1604 /tmp/eicar.com: Eicar-Test-Signature(44d88612fea8a8f36de82e1278abb02f:68) FOUND
1606 In the streaming case, clamd uses the filename "stream" which you should
1607 be able to verify with { ktrace clamdscan --stream /tmp/eicar.com }. (The
1608 client app will replace "stream" with the original filename before returning
1609 results to stdout, but the trace shows the data).
1611 We will assume that the pathname passed to clamd from Exim does not contain
1612 a colon. We will have whined loudly above if the eml_filename does (and we're
1613 passing a filename to clamd). */
1616 return m_errlog_defer(scanent, CUS callout_address,
1617 US"ClamAV returned null");
1619 /* strip newline at the end (won't be present for zINSTREAM)
1620 (also any trailing whitespace, which shouldn't exist, but we depend upon
1621 this below, so double-check) */
1622 p = av_buffer + Ustrlen(av_buffer) - 1;
1623 if (*p == '\n') *p = '\0';
1625 DEBUG(D_acl) debug_printf_indent("Malware response: %s\n", av_buffer);
1627 while (isspace(*--p) && (p > av_buffer))
1631 /* colon in returned output? */
1632 if(!(p = Ustrchr(av_buffer,':')))
1633 return m_errlog_defer(scanent, CUS callout_address, string_sprintf(
1634 "ClamAV returned malformed result (missing colon): %s",
1637 /* strip filename */
1638 while (*p && isspace(*++p)) /**/;
1641 /* It would be bad to encounter a virus with "FOUND" in part of the name,
1642 but we should at least be resistant to it. */
1643 p = Ustrrchr(vname, ' ');
1644 result_tag = p ? p+1 : vname;
1646 if (Ustrcmp(result_tag, "FOUND") == 0)
1648 /* p should still be the whitespace before the result_tag */
1649 while (isspace(*p)) --p;
1651 /* Strip off the extended information too, which will be in parens
1652 after the virus name, with no intervening whitespace. */
1655 /* "(hash:size)", so previous '(' will do; if not found, we have
1656 a curious virus name, but not an error. */
1657 p = Ustrrchr(vname, '(');
1661 malware_name = string_copy(vname);
1662 DEBUG(D_acl) debug_printf_indent("Malware found, name \"%s\"\n", malware_name);
1665 else if (Ustrcmp(result_tag, "ERROR") == 0)
1666 return m_errlog_defer(scanent, CUS callout_address,
1667 string_sprintf("ClamAV returned: %s", av_buffer));
1669 else if (Ustrcmp(result_tag, "OK") == 0)
1671 /* Everything should be OK */
1672 malware_name = NULL;
1673 DEBUG(D_acl) debug_printf_indent("Malware not found\n");
1677 return m_errlog_defer(scanent, CUS callout_address,
1678 string_sprintf("unparseable response from ClamAV: {%s}", av_buffer));
1683 case M_SOCK: /* "sock" scanner type ------------------------------------- */
1684 /* This code was derived by Martin Poole from the clamd code contributed
1685 by David Saez and the cmdline code
1689 uschar * commandline;
1690 uschar av_buffer[1024];
1691 uschar * linebuffer;
1692 uschar * sockline_scanner;
1693 uschar sockline_scanner_default[] = "%s\n";
1694 const pcre *sockline_trig_re;
1695 const pcre *sockline_name_re;
1697 /* find scanner command line */
1698 if ((sockline_scanner = string_nextinlist(&av_scanner_work, &sep,
1700 { /* check for no expansions apart from one %s */
1701 uschar * s = Ustrchr(sockline_scanner, '%');
1703 if ((*s != 's' && *s != '%') || Ustrchr(s+1, '%'))
1704 return m_errlog_defer_3(scanent, NULL,
1705 US"unsafe sock scanner call spec", sock);
1708 sockline_scanner = sockline_scanner_default;
1710 /* find scanner output trigger */
1711 sockline_trig_re = m_pcre_nextinlist(&av_scanner_work, &sep,
1712 "missing trigger specification", &errstr);
1713 if (!sockline_trig_re)
1714 return m_errlog_defer_3(scanent, NULL, errstr, sock);
1716 /* find virus name regex */
1717 sockline_name_re = m_pcre_nextinlist(&av_scanner_work, &sep,
1718 "missing virus name regex specification", &errstr);
1719 if (!sockline_name_re)
1720 return m_errlog_defer_3(scanent, NULL, errstr, sock);
1722 /* prepare scanner call - security depends on expansions check above */
1723 commandline = string_sprintf("%s/scan/%s/%s.eml", spool_directory, message_id, message_id);
1724 commandline = string_sprintf( CS sockline_scanner, CS commandline);
1727 /* Pass the command string to the socket */
1728 if (m_sock_send(sock, commandline, Ustrlen(commandline), &errstr) < 0)
1729 return m_errlog_defer(scanent, CUS callout_address, errstr);
1731 /* Read the result */
1732 bread = ip_recv(sock, av_buffer, sizeof(av_buffer), tmo-time(NULL));
1735 return m_errlog_defer_3(scanent, CUS callout_address,
1736 string_sprintf("unable to read from socket (%s)", strerror(errno)),
1739 if (bread == sizeof(av_buffer))
1740 return m_errlog_defer_3(scanent, CUS callout_address,
1741 US"buffer too small", sock);
1742 av_buffer[bread] = '\0';
1743 linebuffer = string_copy(av_buffer);
1745 /* try trigger match */
1746 if (regex_match_and_setup(sockline_trig_re, linebuffer, 0, -1))
1748 if (!(malware_name = m_pcre_exec(sockline_name_re, av_buffer)))
1749 malware_name = US "unknown";
1751 else /* no virus found */
1752 malware_name = NULL;
1756 case M_MKSD: /* "mksd" scanner type ------------------------------------- */
1758 char *mksd_options_end;
1759 int mksd_maxproc = 1; /* default, if no option supplied */
1762 if (scanner_options)
1764 mksd_maxproc = (int)strtol(CS scanner_options, &mksd_options_end, 10);
1765 if ( *scanner_options == '\0'
1766 || *mksd_options_end != '\0'
1768 || mksd_maxproc > 32
1770 return m_errlog_defer(scanent, CUS callout_address,
1771 string_sprintf("invalid option '%s'", scanner_options));
1774 if((sock = ip_unixsocket(US "/var/run/mksd/socket", &errstr)) < 0)
1775 return m_errlog_defer(scanent, CUS callout_address, errstr);
1777 malware_name = NULL;
1779 DEBUG(D_acl) debug_printf_indent("Malware scan: issuing %s scan\n", scanner_name);
1781 if ((retval = mksd_scan_packed(scanent, sock, eml_filename, tmo)) != OK)
1789 case M_AVAST: /* "avast" scanner type ----------------------------------- */
1793 uschar * scanrequest;
1794 enum {AVA_HELO, AVA_OPT, AVA_RSP, AVA_DONE} avast_stage;
1797 /* According to Martin Tuma @avast the protocol uses "escaped
1798 whitespace", that is, every embedded whitespace is backslash
1799 escaped, as well as backslash is protected by backslash.
1800 The returned lines contain the name of the scanned file, a tab
1804 [E] - some error occured
1805 Such marker follows the first non-escaped TAB. */
1806 if ( ( !ava_re_clean
1807 && !(ava_re_clean = m_pcre_compile(ava_re_clean_str, &errstr)))
1809 && !(ava_re_virus = m_pcre_compile(ava_re_virus_str, &errstr)))
1811 return malware_errlog_defer(errstr);
1813 /* wait for result */
1814 for (avast_stage = AVA_HELO;
1815 (nread = recv_line(sock, buf, sizeof(buf), tmo)) > 0;
1818 int slen = Ustrlen(buf);
1821 DEBUG(D_acl) debug_printf_indent("got from avast: %s\n", buf);
1822 switch (avast_stage)
1825 if (Ustrncmp(buf, "220", 3) != 0)
1826 goto endloop; /* require a 220 */
1830 if (Ustrncmp(buf, "210", 3) == 0)
1831 break; /* ignore 210 responses */
1832 if (Ustrncmp(buf, "200", 3) != 0)
1833 goto endloop; /* require a 200 */
1838 /* Check for another option to send. Newline-terminate it. */
1839 if ((scanrequest = string_nextinlist(&av_scanner_work, &sep,
1842 scanrequest = string_sprintf("%s\n", scanrequest);
1843 avast_stage = AVA_OPT; /* just sent option */
1847 scanrequest = string_sprintf("SCAN %s/scan/%s\n",
1848 spool_directory, message_id);
1849 avast_stage = AVA_RSP; /* just sent command */
1852 /* send config-cmd or scan-request to socket */
1853 len = Ustrlen(scanrequest);
1854 if (send(sock, scanrequest, len, 0) < 0)
1856 scanrequest[len-1] = '\0';
1857 return m_errlog_defer_3(scanent, CUS callout_address, string_sprintf(
1858 "unable to send request '%s' to socket (%s): %s",
1859 scanrequest, scanner_options, strerror(errno)), sock);
1865 if (Ustrncmp(buf, "210", 3) == 0)
1866 break; /* ignore the "210 SCAN DATA" message */
1868 if (pcre_exec(ava_re_clean, NULL, CS buf, slen,
1869 0, 0, ovector, nelements(ovector)) > 0)
1872 if ((malware_name = m_pcre_exec(ava_re_virus, buf)))
1873 { /* remove backslash in front of [whitespace|backslash] */
1875 for (p = malware_name; *p; ++p)
1876 if (*p == '\\' && (isspace(p[1]) || p[1] == '\\'))
1877 for (p0 = p; *p0; ++p0) *p0 = p0[1];
1879 avast_stage = AVA_DONE;
1883 if (Ustrncmp(buf, "200 SCAN OK", 11) == 0)
1884 { /* we're done finally */
1885 if (send(sock, "QUIT\n", 5, 0) < 0) /* courtesy */
1886 return m_errlog_defer_3(scanent, CUS callout_address,
1888 "unable to send quit request to socket (%s): %s",
1889 scanner_options, strerror(errno)),
1891 malware_name = NULL;
1892 avast_stage = AVA_DONE;
1896 /* here for any unexpected response from the scanner */
1899 case AVA_DONE: log_write(0, LOG_PANIC, "%s:%d:%s: should not happen",
1900 __FILE__, __LINE__, __FUNCTION__);
1910 case AVA_RSP: return m_errlog_defer_3(scanent, CUS callout_address,
1913 "invalid response from scanner: '%s'", buf)
1915 ? US"EOF from scanner"
1916 : US"timeout from scanner",
1923 case M_FPROT6D: /* "f-prot6d" scanner type ----------------------------------- */
1927 uschar * linebuffer;
1928 uschar * scanrequest;
1929 uschar av_buffer[1024];
1931 if ((!fprot6d_re_virus && !(fprot6d_re_virus = m_pcre_compile(fprot6d_re_virus_str, &errstr)))
1932 || (!fprot6d_re_error && !(fprot6d_re_error = m_pcre_compile(fprot6d_re_error_str, &errstr))))
1933 return malware_errlog_defer(errstr);
1935 scanrequest = string_sprintf("SCAN FILE %s\n", eml_filename);
1936 DEBUG(D_acl) debug_printf_indent("Malware scan: issuing %s: %s\n",
1937 scanner_name, scanrequest);
1939 if (m_sock_send(sock, scanrequest, Ustrlen(scanrequest), &errstr) < 0)
1940 return m_errlog_defer(scanent, CUS callout_address, errstr);
1942 bread = ip_recv(sock, av_buffer, sizeof(av_buffer), tmo-time(NULL));
1945 return m_errlog_defer_3(scanent, CUS callout_address,
1946 string_sprintf("unable to read from socket (%s)", strerror(errno)),
1949 if (bread == sizeof(av_buffer))
1950 return m_errlog_defer_3(scanent, CUS callout_address,
1951 US"buffer too small", sock);
1953 av_buffer[bread] = '\0';
1954 linebuffer = string_copy(av_buffer);
1956 m_sock_send(sock, US"QUIT\n", 5, 0);
1958 if ((e = m_pcre_exec(fprot6d_re_error, linebuffer)))
1959 return m_errlog_defer_3(scanent, CUS callout_address,
1960 string_sprintf("scanner reported error (%s)", e), sock);
1962 if (!(malware_name = m_pcre_exec(fprot6d_re_virus, linebuffer)))
1963 malware_name = NULL;
1967 } /* scanner type switch */
1970 (void) close (sock);
1971 malware_ok = TRUE; /* set "been here, done that" marker */
1974 /* match virus name against pattern (caseless ------->----------v) */
1975 if (malware_name && regex_match_and_setup(re, malware_name, 0, -1))
1977 DEBUG(D_acl) debug_printf_indent(
1978 "Matched regex to malware [%s] [%s]\n", malware_re, malware_name);
1986 /*************************************************
1987 * Scan an email for malware *
1988 *************************************************/
1990 /* This is the normal interface for scanning an email, which doesn't need a
1991 filename; it's a wrapper around the malware_file function.
1994 malware_re match condition for "malware="
1995 timeout if nonzero, timeout in seconds
1997 Returns: Exim message processing code (OK, FAIL, DEFER, ...)
1998 where true means malware was found (condition applies)
2001 malware(const uschar * malware_re, int timeout)
2003 uschar * scan_filename;
2006 scan_filename = string_sprintf("%s/scan/%s/%s.eml",
2007 spool_directory, message_id, message_id);
2008 ret = malware_internal(malware_re, scan_filename, timeout, FALSE);
2009 if (ret == DEFER) av_failed = TRUE;
2015 /*************************************************
2016 * Scan a file for malware *
2017 *************************************************/
2019 /* This is a test wrapper for scanning an email, which is not used in
2020 normal processing. Scan any file, using the Exim scanning interface.
2021 This function tampers with various global variables so is unsafe to use
2022 in any other context.
2025 eml_filename a file holding the message to be scanned
2027 Returns: Exim message processing code (OK, FAIL, DEFER, ...)
2028 where true means malware was found (condition applies)
2031 malware_in_file(uschar *eml_filename)
2033 uschar message_id_buf[64];
2036 /* spool_mbox() assumes various parameters exist, when creating
2037 the relevant directory and the email within */
2039 (void) string_format(message_id_buf, sizeof(message_id_buf),
2040 "dummy-%d", vaguely_random_number(INT_MAX));
2041 message_id = message_id_buf;
2042 sender_address = US"malware-sender@example.net";
2044 recipients_list = NULL;
2045 receive_add_recipient(US"malware-victim@example.net", -1);
2046 enable_dollar_recipients = TRUE;
2048 ret = malware_internal(US"*", eml_filename, 0, TRUE);
2050 Ustrncpy(spooled_message_id, message_id, sizeof(spooled_message_id));
2053 /* don't set no_mbox_unspool; at present, there's no way for it to become
2054 set, but if that changes, then it should apply to these tests too */
2058 /* silence static analysis tools */
2068 if (!malware_default_re)
2069 malware_default_re = regex_must_compile(malware_regex_default, FALSE, TRUE);
2071 drweb_re = regex_must_compile(drweb_re_str, FALSE, TRUE);
2073 fsec_re = regex_must_compile(fsec_re_str, FALSE, TRUE);
2075 kav_re_sus = regex_must_compile(kav_re_sus_str, FALSE, TRUE);
2077 kav_re_inf = regex_must_compile(kav_re_inf_str, FALSE, TRUE);
2079 ava_re_clean = regex_must_compile(ava_re_clean_str, FALSE, TRUE);
2081 ava_re_virus = regex_must_compile(ava_re_virus_str, FALSE, TRUE);
2082 if (!fprot6d_re_error)
2083 fprot6d_re_error = regex_must_compile(fprot6d_re_error_str, FALSE, TRUE);
2084 if (!fprot6d_re_virus)
2085 fprot6d_re_virus = regex_must_compile(fprot6d_re_virus_str, FALSE, TRUE);
2088 #endif /*WITH_CONTENT_SCAN*/