1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 Copyright (c) Todd Lyons <tlyons@exim.org> 2012 - 2014
6 Copyright (c) The Exim Maintainers 2019
9 /* Portions Copyright (c) 2012, 2013, The Trusted Domain Project;
10 All rights reserved, licensed for use per LICENSE.opendmarc. */
12 /* Code for calling dmarc checks via libopendmarc. Called from acl.c. */
16 # if !defined SUPPORT_SPF
17 # error SPF must also be enabled for DMARC
18 # elif defined DISABLE_DKIM
19 # error DKIM must also be enabled for DMARC
22 # include "functions.h"
24 # include "pdkim/pdkim.h"
26 OPENDMARC_LIB_T dmarc_ctx;
27 DMARC_POLICY_T *dmarc_pctx = NULL;
28 OPENDMARC_STATUS_T libdm_status, action, dmarc_policy;
29 OPENDMARC_STATUS_T da, sa, action;
30 BOOL dmarc_abort = FALSE;
31 uschar *dmarc_pass_fail = US"skipped";
32 header_line *from_header = NULL;
33 extern SPF_response_t *spf_response;
34 int dmarc_spf_ares_result = 0;
35 uschar *spf_sender_domain = NULL;
36 uschar *spf_human_readable = NULL;
37 u_char *header_from_sender = NULL;
38 int history_file_status = DMARC_HIST_OK;
39 uschar *dkim_history_buffer= NULL;
41 typedef struct dmarc_exim_p {
46 static dmarc_exim_p dmarc_policy_description[] = {
48 { US"", DMARC_RECORD_P_UNSPECIFIED },
49 { US"none", DMARC_RECORD_P_NONE },
50 { US"quarantine", DMARC_RECORD_P_QUARANTINE },
51 { US"reject", DMARC_RECORD_P_REJECT },
57 dmarc_version_report(FILE *f)
59 const char *implementation, *version;
61 fprintf(f, "Library version: dmarc: Compile: %d.%d.%d.%d\n",
62 (OPENDMARC_LIB_VERSION & 0xff000000) >> 24, (OPENDMARC_LIB_VERSION & 0x00ff0000) >> 16,
63 (OPENDMARC_LIB_VERSION & 0x0000ff00) >> 8, OPENDMARC_LIB_VERSION & 0x000000ff);
67 /* Accept an error_block struct, initialize if empty, parse to the
68 end, and append the two strings passed to it. Used for adding
69 variable amounts of value:pair data to the forensic emails. */
72 add_to_eblock(error_block *eblock, uschar *t1, uschar *t2)
74 error_block *eb = store_malloc(sizeof(error_block));
79 /* Find the end of the eblock struct and point it at eb */
80 error_block *tmp = eblock;
91 /* dmarc_init sets up a context that can be re-used for several
92 messages on the same SMTP connection (that come from the
93 same host with the same HELO string) */
98 int *netmask = NULL; /* Ignored */
101 /* Set some sane defaults. Also clears previous results when
102 * multiple messages in one connection. */
104 dmarc_status = US"none";
106 dmarc_pass_fail = US"skipped";
107 dmarc_used_domain = US"";
108 f.dmarc_has_been_checked = FALSE;
109 header_from_sender = NULL;
110 spf_sender_domain = NULL;
111 spf_human_readable = NULL;
113 /* ACLs have "control=dmarc_disable_verify" */
114 if (f.dmarc_disable_verify == TRUE)
117 (void) memset(&dmarc_ctx, '\0', sizeof dmarc_ctx);
118 dmarc_ctx.nscount = 0;
119 libdm_status = opendmarc_policy_library_init(&dmarc_ctx);
120 if (libdm_status != DMARC_PARSE_OKAY)
122 log_write(0, LOG_MAIN|LOG_PANIC, "DMARC failure to init library: %s",
123 opendmarc_policy_status_to_str(libdm_status));
126 if (!dmarc_tld_file || !*dmarc_tld_file)
128 DEBUG(D_receive) debug_printf("DMARC: no dmarc_tld_file\n");
131 else if (opendmarc_tld_read_file(CS dmarc_tld_file, NULL, NULL, NULL))
133 log_write(0, LOG_MAIN|LOG_PANIC, "DMARC failure to load tld list '%s': %s",
134 dmarc_tld_file, strerror(errno));
137 if (!sender_host_address)
139 DEBUG(D_receive) debug_printf("DMARC: no sender_host_address\n");
142 /* This catches locally originated email and startup errors above. */
145 is_ipv6 = string_is_ip_address(sender_host_address, netmask) == 6;
146 if (!(dmarc_pctx = opendmarc_policy_connect_init(sender_host_address, is_ipv6)))
148 log_write(0, LOG_MAIN|LOG_PANIC,
149 "DMARC failure creating policy context: ip=%s", sender_host_address);
158 /* dmarc_store_data stores the header data so that subsequent
159 dmarc_process can access the data */
162 dmarc_store_data(header_line *hdr)
164 /* No debug output because would change every test debug output */
165 if (!f.dmarc_disable_verify)
172 dmarc_send_forensic_report(u_char **ruf)
174 uschar *recipient, *save_sender;
175 BOOL send_status = FALSE;
176 error_block *eblock = NULL;
177 FILE *message_file = NULL;
179 /* Earlier ACL does not have *required* control=dmarc_enable_forensic */
180 if (!f.dmarc_enable_forensic)
183 if ( dmarc_policy == DMARC_POLICY_REJECT && action == DMARC_RESULT_REJECT
184 || dmarc_policy == DMARC_POLICY_QUARANTINE && action == DMARC_RESULT_QUARANTINE
185 || dmarc_policy == DMARC_POLICY_NONE && action == DMARC_RESULT_REJECT
186 || dmarc_policy == DMARC_POLICY_NONE && action == DMARC_RESULT_QUARANTINE
190 eblock = add_to_eblock(eblock, US"Sender Domain", dmarc_used_domain);
191 eblock = add_to_eblock(eblock, US"Sender IP Address", sender_host_address);
192 eblock = add_to_eblock(eblock, US"Received Date", tod_stamp(tod_full));
193 eblock = add_to_eblock(eblock, US"SPF Alignment",
194 sa == DMARC_POLICY_SPF_ALIGNMENT_PASS ? US"yes" : US"no");
195 eblock = add_to_eblock(eblock, US"DKIM Alignment",
196 da == DMARC_POLICY_DKIM_ALIGNMENT_PASS ? US"yes" : US"no");
197 eblock = add_to_eblock(eblock, US"DMARC Results", dmarc_status_text);
199 for (int c = 0; ruf[c]; c++)
201 recipient = string_copylc(ruf[c]);
202 if (Ustrncmp(recipient, "mailto:",7))
204 /* Move to first character past the colon */
207 debug_printf("DMARC forensic report to %s%s\n", recipient,
208 (host_checking || f.running_in_test_harness) ? " (not really)" : "");
209 if (host_checking || f.running_in_test_harness)
212 if (!moan_send_message(recipient, ERRMESS_DMARC_FORENSIC, eblock,
213 header_list, message_file, NULL))
214 log_write(0, LOG_MAIN|LOG_PANIC,
215 "failure to send DMARC forensic report to %s", recipient);
221 /* Look up a DNS dmarc record for the given domain. Return it or NULL */
224 dmarc_dns_lookup(uschar * dom)
226 dns_answer * dnsa = store_get_dns_answer();
228 int rc = dns_lookup(dnsa, string_sprintf("_dmarc.%s", dom), T_TXT, NULL);
230 if (rc == DNS_SUCCEED)
231 for (dns_record * rr = dns_next_rr(dnsa, &dnss, RESET_ANSWERS); rr;
232 rr = dns_next_rr(dnsa, &dnss, RESET_NEXT))
233 if (rr->type == T_TXT && rr->size > 3)
235 store_free_dns_answer(dnsa);
236 return string_copyn_taint(US rr->data, rr->size, TRUE);
238 store_free_dns_answer(dnsa);
244 dmarc_write_history_file()
249 u_char **rua; /* aggregate report addressees */
250 uschar *history_buffer = NULL;
252 if (!dmarc_history_file)
254 DEBUG(D_receive) debug_printf("DMARC history file not set\n");
255 return DMARC_HIST_DISABLED;
257 history_file_fd = log_open_as_exim(dmarc_history_file);
259 if (history_file_fd < 0)
261 log_write(0, LOG_MAIN|LOG_PANIC, "failure to create DMARC history file: %s",
263 return DMARC_HIST_FILE_ERR;
266 /* Generate the contents of the history file */
267 history_buffer = string_sprintf(
268 "job %s\nreporter %s\nreceived %ld\nipaddr %s\nfrom %s\nmfrom %s\n",
269 message_id, primary_hostname, time(NULL), sender_host_address,
270 header_from_sender, expand_string(US"$sender_address_domain"));
273 history_buffer = string_sprintf("%sspf %d\n", history_buffer, dmarc_spf_ares_result);
274 /* history_buffer = string_sprintf("%sspf -1\n", history_buffer); */
276 history_buffer = string_sprintf(
277 "%s%spdomain %s\npolicy %d\n",
278 history_buffer, dkim_history_buffer, dmarc_used_domain, dmarc_policy);
280 if ((rua = opendmarc_policy_fetch_rua(dmarc_pctx, NULL, 0, 1)))
281 for (tmp_ans = 0; rua[tmp_ans]; tmp_ans++)
282 history_buffer = string_sprintf("%srua %s\n", history_buffer, rua[tmp_ans]);
284 history_buffer = string_sprintf("%srua -\n", history_buffer);
286 opendmarc_policy_fetch_pct(dmarc_pctx, &tmp_ans);
287 history_buffer = string_sprintf("%spct %d\n", history_buffer, tmp_ans);
289 opendmarc_policy_fetch_adkim(dmarc_pctx, &tmp_ans);
290 history_buffer = string_sprintf("%sadkim %d\n", history_buffer, tmp_ans);
292 opendmarc_policy_fetch_aspf(dmarc_pctx, &tmp_ans);
293 history_buffer = string_sprintf("%saspf %d\n", history_buffer, tmp_ans);
295 opendmarc_policy_fetch_p(dmarc_pctx, &tmp_ans);
296 history_buffer = string_sprintf("%sp %d\n", history_buffer, tmp_ans);
298 opendmarc_policy_fetch_sp(dmarc_pctx, &tmp_ans);
299 history_buffer = string_sprintf("%ssp %d\n", history_buffer, tmp_ans);
301 history_buffer = string_sprintf(
302 "%salign_dkim %d\nalign_spf %d\naction %d\n",
303 history_buffer, da, sa, action);
305 /* Write the contents to the history file */
307 debug_printf("DMARC logging history data for opendmarc reporting%s\n",
308 (host_checking || f.running_in_test_harness) ? " (not really)" : "");
309 if (host_checking || f.running_in_test_harness)
312 debug_printf("DMARC history data for debugging:\n%s", history_buffer);
316 written_len = write_to_fd_buf(history_file_fd,
318 Ustrlen(history_buffer));
319 if (written_len == 0)
321 log_write(0, LOG_MAIN|LOG_PANIC, "failure to write to DMARC history file: %s",
323 return DMARC_HIST_WRITE_ERR;
325 (void)close(history_file_fd);
327 return DMARC_HIST_OK;
331 /* dmarc_process adds the envelope sender address to the existing
332 context (if any), retrieves the result, sets up expansion
333 strings and evaluates the condition outcome. */
338 int sr, origin; /* used in SPF section */
339 int dmarc_spf_result = 0; /* stores spf into dmarc conn ctx */
341 pdkim_signature * sig = dkim_signatures;
343 BOOL has_dmarc_record = TRUE;
344 u_char **ruf; /* forensic report addressees, if called for */
346 /* ACLs have "control=dmarc_disable_verify" */
347 if (f.dmarc_disable_verify)
350 /* Store the header From: sender domain for this part of DMARC.
351 * If there is no from_header struct, then it's likely this message
352 * is locally generated and relying on fixups to add it. Just skip
353 * the entire DMARC system if we can't find a From: header....or if
354 * there was a previous error.
358 DEBUG(D_receive) debug_printf("DMARC: no From: header\n");
361 else if (!dmarc_abort)
368 f.parse_allow_group = TRUE;
369 p = parse_find_address_end(from_header->text, FALSE);
370 saveend = *p; *p = '\0';
371 if ((header_from_sender = parse_extract_address(from_header->text, &errormsg,
372 &dummy, &dummy, &domain, FALSE)))
373 header_from_sender += domain;
376 /* The opendmarc library extracts the domain from the email address, but
377 * only try to store it if it's not empty. Otherwise, skip out of DMARC. */
378 if (!header_from_sender || (strcmp( CCS header_from_sender, "") == 0))
380 libdm_status = dmarc_abort
382 : opendmarc_policy_store_from_domain(dmarc_pctx, header_from_sender);
383 if (libdm_status != DMARC_PARSE_OKAY)
385 log_write(0, LOG_MAIN|LOG_PANIC,
386 "failure to store header From: in DMARC: %s, header was '%s'",
387 opendmarc_policy_status_to_str(libdm_status), from_header->text);
392 /* Skip DMARC if connection is SMTP Auth. Temporarily, admin should
393 * instead do this in the ACLs. */
394 if (!dmarc_abort && !sender_host_authenticated)
396 uschar * dmarc_domain;
398 /* Use the envelope sender domain for this part of DMARC */
399 spf_sender_domain = expand_string(US"$sender_address_domain");
402 /* No spf data means null envelope sender so generate a domain name
403 * from the sender_helo_name */
404 if (!spf_sender_domain)
406 spf_sender_domain = sender_helo_name;
407 log_write(0, LOG_MAIN, "DMARC using synthesized SPF sender domain = %s\n",
410 debug_printf("DMARC using synthesized SPF sender domain = %s\n",
413 dmarc_spf_result = DMARC_POLICY_SPF_OUTCOME_NONE;
414 dmarc_spf_ares_result = ARES_RESULT_UNKNOWN;
415 origin = DMARC_POLICY_SPF_ORIGIN_HELO;
416 spf_human_readable = US"";
420 sr = spf_response->result;
421 dmarc_spf_result = sr == SPF_RESULT_NEUTRAL ? DMARC_POLICY_SPF_OUTCOME_NONE :
422 sr == SPF_RESULT_PASS ? DMARC_POLICY_SPF_OUTCOME_PASS :
423 sr == SPF_RESULT_FAIL ? DMARC_POLICY_SPF_OUTCOME_FAIL :
424 sr == SPF_RESULT_SOFTFAIL ? DMARC_POLICY_SPF_OUTCOME_TMPFAIL :
425 DMARC_POLICY_SPF_OUTCOME_NONE;
426 dmarc_spf_ares_result = sr == SPF_RESULT_NEUTRAL ? ARES_RESULT_NEUTRAL :
427 sr == SPF_RESULT_PASS ? ARES_RESULT_PASS :
428 sr == SPF_RESULT_FAIL ? ARES_RESULT_FAIL :
429 sr == SPF_RESULT_SOFTFAIL ? ARES_RESULT_SOFTFAIL :
430 sr == SPF_RESULT_NONE ? ARES_RESULT_NONE :
431 sr == SPF_RESULT_TEMPERROR ? ARES_RESULT_TEMPERROR :
432 sr == SPF_RESULT_PERMERROR ? ARES_RESULT_PERMERROR :
434 origin = DMARC_POLICY_SPF_ORIGIN_MAILFROM;
435 spf_human_readable = US spf_response->header_comment;
437 debug_printf("DMARC using SPF sender domain = %s\n", spf_sender_domain);
439 if (strcmp( CCS spf_sender_domain, "") == 0)
443 libdm_status = opendmarc_policy_store_spf(dmarc_pctx, spf_sender_domain,
444 dmarc_spf_result, origin, spf_human_readable);
445 if (libdm_status != DMARC_PARSE_OKAY)
446 log_write(0, LOG_MAIN|LOG_PANIC, "failure to store spf for DMARC: %s",
447 opendmarc_policy_status_to_str(libdm_status));
450 /* Now we cycle through the dkim signature results and put into
451 * the opendmarc context, further building the DMARC reply. */
452 dkim_history_buffer = US"";
455 int dkim_result, dkim_ares_result, vs, ves;
457 vs = sig->verify_status & ~PDKIM_VERIFY_POLICY;
458 ves = sig->verify_ext_status;
459 dkim_result = vs == PDKIM_VERIFY_PASS ? DMARC_POLICY_DKIM_OUTCOME_PASS :
460 vs == PDKIM_VERIFY_FAIL ? DMARC_POLICY_DKIM_OUTCOME_FAIL :
461 vs == PDKIM_VERIFY_INVALID ? DMARC_POLICY_DKIM_OUTCOME_TMPFAIL :
462 DMARC_POLICY_DKIM_OUTCOME_NONE;
463 libdm_status = opendmarc_policy_store_dkim(dmarc_pctx, US sig->domain,
466 debug_printf("DMARC adding DKIM sender domain = %s\n", sig->domain);
467 if (libdm_status != DMARC_PARSE_OKAY)
468 log_write(0, LOG_MAIN|LOG_PANIC,
469 "failure to store dkim (%s) for DMARC: %s",
470 sig->domain, opendmarc_policy_status_to_str(libdm_status));
473 vs == PDKIM_VERIFY_PASS ? ARES_RESULT_PASS :
474 vs == PDKIM_VERIFY_FAIL ? ARES_RESULT_FAIL :
475 vs == PDKIM_VERIFY_NONE ? ARES_RESULT_NONE :
476 vs == PDKIM_VERIFY_INVALID ?
477 ves == PDKIM_VERIFY_INVALID_PUBKEY_UNAVAILABLE ? ARES_RESULT_PERMERROR :
478 ves == PDKIM_VERIFY_INVALID_BUFFER_SIZE ? ARES_RESULT_PERMERROR :
479 ves == PDKIM_VERIFY_INVALID_PUBKEY_DNSRECORD ? ARES_RESULT_PERMERROR :
480 ves == PDKIM_VERIFY_INVALID_PUBKEY_IMPORT ? ARES_RESULT_PERMERROR :
481 ARES_RESULT_UNKNOWN :
483 dkim_history_buffer = string_sprintf("%sdkim %s %d\n", dkim_history_buffer,
484 sig->domain, dkim_ares_result);
488 /* Look up DMARC policy record in DNS. We do this explicitly, rather than
489 letting the dmarc library do it with opendmarc_policy_query_dmarc(), so that
490 our dns access path is used for debug tracing and for the testsuite
493 libdm_status = (rr = dmarc_dns_lookup(header_from_sender))
494 ? opendmarc_policy_store_dmarc(dmarc_pctx, rr, header_from_sender, NULL)
495 : DMARC_DNS_ERROR_NO_RECORD;
496 switch (libdm_status)
498 case DMARC_DNS_ERROR_NXDOMAIN:
499 case DMARC_DNS_ERROR_NO_RECORD:
501 debug_printf("DMARC no record found for %s\n", header_from_sender);
502 has_dmarc_record = FALSE;
504 case DMARC_PARSE_OKAY:
506 debug_printf("DMARC record found for %s\n", header_from_sender);
508 case DMARC_PARSE_ERROR_BAD_VALUE:
510 debug_printf("DMARC record parse error for %s\n", header_from_sender);
511 has_dmarc_record = FALSE;
514 /* everything else, skip dmarc */
516 debug_printf("DMARC skipping (%d), unsure what to do with %s",
517 libdm_status, from_header->text);
518 has_dmarc_record = FALSE;
522 /* Store the policy string in an expandable variable. */
524 libdm_status = opendmarc_policy_fetch_p(dmarc_pctx, &tmp_ans);
525 for (c = 0; dmarc_policy_description[c].name; c++)
526 if (tmp_ans == dmarc_policy_description[c].value)
528 dmarc_domain_policy = string_sprintf("%s",dmarc_policy_description[c].name);
532 /* Can't use exim's string manipulation functions so allocate memory
533 for libopendmarc using its max hostname length definition. */
535 dmarc_domain = store_get(DMARC_MAXHOSTNAMELEN, TRUE);
536 libdm_status = opendmarc_policy_fetch_utilized_domain(dmarc_pctx,
537 dmarc_domain, DMARC_MAXHOSTNAMELEN-1);
538 store_release_above(dmarc_domain + Ustrlen(dmarc_domain)+1);
539 dmarc_used_domain = dmarc_domain;
541 if (libdm_status != DMARC_PARSE_OKAY)
542 log_write(0, LOG_MAIN|LOG_PANIC,
543 "failure to read domainname used for DMARC lookup: %s",
544 opendmarc_policy_status_to_str(libdm_status));
546 dmarc_policy = libdm_status = opendmarc_get_policy_to_enforce(dmarc_pctx);
549 case DMARC_POLICY_ABSENT: /* No DMARC record found */
550 dmarc_status = US"norecord";
551 dmarc_pass_fail = US"none";
552 dmarc_status_text = US"No DMARC record";
553 action = DMARC_RESULT_ACCEPT;
555 case DMARC_FROM_DOMAIN_ABSENT: /* No From: domain */
556 dmarc_status = US"nofrom";
557 dmarc_pass_fail = US"temperror";
558 dmarc_status_text = US"No From: domain found";
559 action = DMARC_RESULT_ACCEPT;
561 case DMARC_POLICY_NONE: /* Accept and report */
562 dmarc_status = US"none";
563 dmarc_pass_fail = US"none";
564 dmarc_status_text = US"None, Accept";
565 action = DMARC_RESULT_ACCEPT;
567 case DMARC_POLICY_PASS: /* Explicit accept */
568 dmarc_status = US"accept";
569 dmarc_pass_fail = US"pass";
570 dmarc_status_text = US"Accept";
571 action = DMARC_RESULT_ACCEPT;
573 case DMARC_POLICY_REJECT: /* Explicit reject */
574 dmarc_status = US"reject";
575 dmarc_pass_fail = US"fail";
576 dmarc_status_text = US"Reject";
577 action = DMARC_RESULT_REJECT;
579 case DMARC_POLICY_QUARANTINE: /* Explicit quarantine */
580 dmarc_status = US"quarantine";
581 dmarc_pass_fail = US"fail";
582 dmarc_status_text = US"Quarantine";
583 action = DMARC_RESULT_QUARANTINE;
586 dmarc_status = US"temperror";
587 dmarc_pass_fail = US"temperror";
588 dmarc_status_text = US"Internal Policy Error";
589 action = DMARC_RESULT_TEMPFAIL;
593 libdm_status = opendmarc_policy_fetch_alignment(dmarc_pctx, &da, &sa);
594 if (libdm_status != DMARC_PARSE_OKAY)
595 log_write(0, LOG_MAIN|LOG_PANIC, "failure to read DMARC alignment: %s",
596 opendmarc_policy_status_to_str(libdm_status));
598 if (has_dmarc_record)
600 log_write(0, LOG_MAIN, "DMARC results: spf_domain=%s dmarc_domain=%s "
601 "spf_align=%s dkim_align=%s enforcement='%s'",
602 spf_sender_domain, dmarc_used_domain,
603 sa==DMARC_POLICY_SPF_ALIGNMENT_PASS ?"yes":"no",
604 da==DMARC_POLICY_DKIM_ALIGNMENT_PASS ?"yes":"no",
606 history_file_status = dmarc_write_history_file();
607 /* Now get the forensic reporting addresses, if any */
608 ruf = opendmarc_policy_fetch_ruf(dmarc_pctx, NULL, 0, 1);
609 dmarc_send_forensic_report(ruf);
613 /* shut down libopendmarc */
615 (void) opendmarc_policy_connect_shutdown(dmarc_pctx);
616 if (!f.dmarc_disable_verify)
617 (void) opendmarc_policy_library_shutdown(&dmarc_ctx);
623 dmarc_exim_expand_query(int what)
625 if (f.dmarc_disable_verify || !dmarc_pctx)
626 return dmarc_exim_expand_defaults(what);
628 if (what == DMARC_VERIFY_STATUS)
634 dmarc_exim_expand_defaults(int what)
636 if (what == DMARC_VERIFY_STATUS)
637 return f.dmarc_disable_verify ? US"off" : US"none";
643 authres_dmarc(gstring * g)
645 if (f.dmarc_has_been_checked)
647 g = string_append(g, 2, US";\n\tdmarc=", dmarc_pass_fail);
648 if (header_from_sender)
649 g = string_append(g, 2, US" header.from=", header_from_sender);
654 # endif /* SUPPORT_SPF */
655 #endif /* SUPPORT_DMARC */