1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 Copyright (c) The Exim Maintainers 2019 - 2022
6 Copyright (c) Todd Lyons <tlyons@exim.org> 2012 - 2014
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
10 /* Portions Copyright (c) 2012, 2013, The Trusted Domain Project;
11 All rights reserved, licensed for use per LICENSE.opendmarc. */
13 /* Code for calling dmarc checks via libopendmarc. Called from acl.c. */
17 # if !defined SUPPORT_SPF
18 # error SPF must also be enabled for DMARC
19 # elif defined DISABLE_DKIM
20 # error DKIM must also be enabled for DMARC
23 # include "functions.h"
25 # include "pdkim/pdkim.h"
27 OPENDMARC_LIB_T dmarc_ctx;
28 DMARC_POLICY_T *dmarc_pctx = NULL;
29 OPENDMARC_STATUS_T libdm_status, action, dmarc_policy;
30 OPENDMARC_STATUS_T da, sa, action;
31 BOOL dmarc_abort = FALSE;
32 uschar *dmarc_pass_fail = US"skipped";
33 header_line *from_header = NULL;
34 extern SPF_response_t *spf_response;
35 int dmarc_spf_ares_result = 0;
36 uschar *spf_sender_domain = NULL;
37 uschar *spf_human_readable = NULL;
38 u_char *header_from_sender = NULL;
39 int history_file_status = DMARC_HIST_OK;
40 uschar *dkim_history_buffer= NULL;
42 typedef struct dmarc_exim_p {
47 static dmarc_exim_p dmarc_policy_description[] = {
49 { US"", DMARC_RECORD_P_UNSPECIFIED },
50 { US"none", DMARC_RECORD_P_NONE },
51 { US"quarantine", DMARC_RECORD_P_QUARANTINE },
52 { US"reject", DMARC_RECORD_P_REJECT },
58 dmarc_version_report(gstring * g)
60 return string_fmt_append(g, "Library version: dmarc: Compile: %d.%d.%d.%d\n",
61 (OPENDMARC_LIB_VERSION & 0xff000000) >> 24, (OPENDMARC_LIB_VERSION & 0x00ff0000) >> 16,
62 (OPENDMARC_LIB_VERSION & 0x0000ff00) >> 8, OPENDMARC_LIB_VERSION & 0x000000ff);
66 /* Accept an error_block struct, initialize if empty, parse to the
67 end, and append the two strings passed to it. Used for adding
68 variable amounts of value:pair data to the forensic emails. */
71 add_to_eblock(error_block *eblock, uschar *t1, uschar *t2)
73 error_block *eb = store_malloc(sizeof(error_block));
78 /* Find the end of the eblock struct and point it at eb */
79 error_block *tmp = eblock;
90 /* dmarc_init sets up a context that can be re-used for several
91 messages on the same SMTP connection (that come from the
92 same host with the same HELO string) */
97 int *netmask = NULL; /* Ignored */
100 /* Set some sane defaults. Also clears previous results when
101 * multiple messages in one connection. */
103 dmarc_status = US"none";
105 dmarc_pass_fail = US"skipped";
106 dmarc_used_domain = US"";
107 f.dmarc_has_been_checked = FALSE;
108 header_from_sender = NULL;
109 spf_sender_domain = NULL;
110 spf_human_readable = NULL;
112 /* ACLs have "control=dmarc_disable_verify" */
113 if (f.dmarc_disable_verify == TRUE)
116 (void) memset(&dmarc_ctx, '\0', sizeof dmarc_ctx);
117 dmarc_ctx.nscount = 0;
118 libdm_status = opendmarc_policy_library_init(&dmarc_ctx);
119 if (libdm_status != DMARC_PARSE_OKAY)
121 log_write(0, LOG_MAIN|LOG_PANIC, "DMARC failure to init library: %s",
122 opendmarc_policy_status_to_str(libdm_status));
125 if (!dmarc_tld_file || !*dmarc_tld_file)
127 DEBUG(D_receive) debug_printf("DMARC: no dmarc_tld_file\n");
130 else if (opendmarc_tld_read_file(CS dmarc_tld_file, NULL, NULL, NULL))
132 log_write(0, LOG_MAIN|LOG_PANIC, "DMARC failure to load tld list '%s': %s",
133 dmarc_tld_file, strerror(errno));
136 if (!sender_host_address)
138 DEBUG(D_receive) debug_printf("DMARC: no sender_host_address\n");
141 /* This catches locally originated email and startup errors above. */
144 is_ipv6 = string_is_ip_address(sender_host_address, netmask) == 6;
145 if (!(dmarc_pctx = opendmarc_policy_connect_init(sender_host_address, is_ipv6)))
147 log_write(0, LOG_MAIN|LOG_PANIC,
148 "DMARC failure creating policy context: ip=%s", sender_host_address);
157 /* dmarc_store_data stores the header data so that subsequent
158 dmarc_process can access the data */
161 dmarc_store_data(header_line *hdr)
163 /* No debug output because would change every test debug output */
164 if (!f.dmarc_disable_verify)
171 dmarc_send_forensic_report(u_char **ruf)
173 uschar *recipient, *save_sender;
174 BOOL send_status = FALSE;
175 error_block *eblock = NULL;
176 FILE *message_file = NULL;
178 /* Earlier ACL does not have *required* control=dmarc_enable_forensic */
179 if (!f.dmarc_enable_forensic)
182 if ( dmarc_policy == DMARC_POLICY_REJECT && action == DMARC_RESULT_REJECT
183 || dmarc_policy == DMARC_POLICY_QUARANTINE && action == DMARC_RESULT_QUARANTINE
184 || dmarc_policy == DMARC_POLICY_NONE && action == DMARC_RESULT_REJECT
185 || dmarc_policy == DMARC_POLICY_NONE && action == DMARC_RESULT_QUARANTINE
189 eblock = add_to_eblock(eblock, US"Sender Domain", dmarc_used_domain);
190 eblock = add_to_eblock(eblock, US"Sender IP Address", sender_host_address);
191 eblock = add_to_eblock(eblock, US"Received Date", tod_stamp(tod_full));
192 eblock = add_to_eblock(eblock, US"SPF Alignment",
193 sa == DMARC_POLICY_SPF_ALIGNMENT_PASS ? US"yes" : US"no");
194 eblock = add_to_eblock(eblock, US"DKIM Alignment",
195 da == DMARC_POLICY_DKIM_ALIGNMENT_PASS ? US"yes" : US"no");
196 eblock = add_to_eblock(eblock, US"DMARC Results", dmarc_status_text);
198 for (int c = 0; ruf[c]; c++)
200 recipient = string_copylc(ruf[c]);
201 if (Ustrncmp(recipient, "mailto:",7))
203 /* Move to first character past the colon */
206 debug_printf("DMARC forensic report to %s%s\n", recipient,
207 (host_checking || f.running_in_test_harness) ? " (not really)" : "");
208 if (host_checking || f.running_in_test_harness)
211 if (!moan_send_message(recipient, ERRMESS_DMARC_FORENSIC, eblock,
212 header_list, message_file, NULL))
213 log_write(0, LOG_MAIN|LOG_PANIC,
214 "failure to send DMARC forensic report to %s", recipient);
220 /* Look up a DNS dmarc record for the given domain. Return it or NULL */
223 dmarc_dns_lookup(uschar * dom)
225 dns_answer * dnsa = store_get_dns_answer();
227 int rc = dns_lookup(dnsa, string_sprintf("_dmarc.%s", dom), T_TXT, NULL);
229 if (rc == DNS_SUCCEED)
230 for (dns_record * rr = dns_next_rr(dnsa, &dnss, RESET_ANSWERS); rr;
231 rr = dns_next_rr(dnsa, &dnss, RESET_NEXT))
232 if (rr->type == T_TXT && rr->size > 3)
234 uschar *record = string_copyn_taint(US rr->data, rr->size, GET_TAINTED);
235 store_free_dns_answer(dnsa);
238 store_free_dns_answer(dnsa);
244 dmarc_write_history_file()
249 u_char ** rua; /* aggregate report addressees */
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 g = string_fmt_append(NULL,
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 g = string_fmt_append(g, "spf %d\n", dmarc_spf_ares_result);
275 g = string_fmt_append(g, "%spdomain %s\npolicy %d\n",
276 dkim_history_buffer, dmarc_used_domain, dmarc_policy);
278 if ((rua = opendmarc_policy_fetch_rua(dmarc_pctx, NULL, 0, 1)))
279 for (tmp_ans = 0; rua[tmp_ans]; tmp_ans++)
280 g = string_fmt_append(g, "rua %s\n", rua[tmp_ans]);
282 g = string_fmt_append(g, "rua -\n");
284 opendmarc_policy_fetch_pct(dmarc_pctx, &tmp_ans);
285 g = string_fmt_append(g, "pct %d\n", tmp_ans);
287 opendmarc_policy_fetch_adkim(dmarc_pctx, &tmp_ans);
288 g = string_fmt_append(g, "adkim %d\n", tmp_ans);
290 opendmarc_policy_fetch_aspf(dmarc_pctx, &tmp_ans);
291 g = string_fmt_append(g, "aspf %d\n", tmp_ans);
293 opendmarc_policy_fetch_p(dmarc_pctx, &tmp_ans);
294 g = string_fmt_append(g, "p %d\n", tmp_ans);
296 opendmarc_policy_fetch_sp(dmarc_pctx, &tmp_ans);
297 g = string_fmt_append(g, "sp %d\n", tmp_ans);
299 g = string_fmt_append(g, "align_dkim %d\nalign_spf %d\naction %d\n",
302 /* Write the contents to the history file */
304 debug_printf("DMARC logging history data for opendmarc reporting%s\n",
305 (host_checking || f.running_in_test_harness) ? " (not really)" : "");
306 if (host_checking || f.running_in_test_harness)
309 debug_printf("DMARC history data for debugging:\n%Y", g);
313 written_len = write_to_fd_buf(history_file_fd,
316 if (written_len == 0)
318 log_write(0, LOG_MAIN|LOG_PANIC, "failure to write to DMARC history file: %s",
320 return DMARC_HIST_WRITE_ERR;
322 (void)close(history_file_fd);
324 return DMARC_HIST_OK;
328 /* dmarc_process adds the envelope sender address to the existing
329 context (if any), retrieves the result, sets up expansion
330 strings and evaluates the condition outcome. */
335 int sr, origin; /* used in SPF section */
336 int dmarc_spf_result = 0; /* stores spf into dmarc conn ctx */
338 pdkim_signature * sig = dkim_signatures;
340 BOOL has_dmarc_record = TRUE;
341 u_char ** ruf; /* forensic report addressees, if called for */
343 /* ACLs have "control=dmarc_disable_verify" */
344 if (f.dmarc_disable_verify)
347 /* Store the header From: sender domain for this part of DMARC.
348 If there is no from_header struct, then it's likely this message
349 is locally generated and relying on fixups to add it. Just skip
350 the entire DMARC system if we can't find a From: header....or if
351 there was a previous error. */
355 DEBUG(D_receive) debug_printf("DMARC: no From: header\n");
358 else if (!dmarc_abort)
365 f.parse_allow_group = TRUE;
366 p = parse_find_address_end(from_header->text, FALSE);
367 saveend = *p; *p = '\0';
368 if ((header_from_sender = parse_extract_address(from_header->text, &errormsg,
369 &dummy, &dummy, &domain, FALSE)))
370 header_from_sender += domain;
373 /* The opendmarc library extracts the domain from the email address, but
374 only try to store it if it's not empty. Otherwise, skip out of DMARC. */
376 if (!header_from_sender || (strcmp( CCS header_from_sender, "") == 0))
378 libdm_status = dmarc_abort
380 : opendmarc_policy_store_from_domain(dmarc_pctx, header_from_sender);
381 if (libdm_status != DMARC_PARSE_OKAY)
383 log_write(0, LOG_MAIN|LOG_PANIC,
384 "failure to store header From: in DMARC: %s, header was '%s'",
385 opendmarc_policy_status_to_str(libdm_status), from_header->text);
390 /* Skip DMARC if connection is SMTP Auth. Temporarily, admin should
391 instead do this in the ACLs. */
393 if (!dmarc_abort && !sender_host_authenticated)
395 uschar * dmarc_domain;
398 /* Use the envelope sender domain for this part of DMARC */
400 spf_sender_domain = expand_string(US"$sender_address_domain");
403 /* No spf data means null envelope sender so generate a domain name
404 from the sender_helo_name */
406 if (!spf_sender_domain)
408 spf_sender_domain = sender_helo_name;
409 log_write(0, LOG_MAIN, "DMARC using synthesized SPF sender domain = %s\n",
412 debug_printf("DMARC using synthesized SPF sender domain = %s\n",
415 dmarc_spf_result = DMARC_POLICY_SPF_OUTCOME_NONE;
416 dmarc_spf_ares_result = ARES_RESULT_UNKNOWN;
417 origin = DMARC_POLICY_SPF_ORIGIN_HELO;
418 spf_human_readable = US"";
422 sr = spf_response->result;
423 dmarc_spf_result = sr == SPF_RESULT_NEUTRAL ? DMARC_POLICY_SPF_OUTCOME_NONE :
424 sr == SPF_RESULT_PASS ? DMARC_POLICY_SPF_OUTCOME_PASS :
425 sr == SPF_RESULT_FAIL ? DMARC_POLICY_SPF_OUTCOME_FAIL :
426 sr == SPF_RESULT_SOFTFAIL ? DMARC_POLICY_SPF_OUTCOME_TMPFAIL :
427 DMARC_POLICY_SPF_OUTCOME_NONE;
428 dmarc_spf_ares_result = sr == SPF_RESULT_NEUTRAL ? ARES_RESULT_NEUTRAL :
429 sr == SPF_RESULT_PASS ? ARES_RESULT_PASS :
430 sr == SPF_RESULT_FAIL ? ARES_RESULT_FAIL :
431 sr == SPF_RESULT_SOFTFAIL ? ARES_RESULT_SOFTFAIL :
432 sr == SPF_RESULT_NONE ? ARES_RESULT_NONE :
433 sr == SPF_RESULT_TEMPERROR ? ARES_RESULT_TEMPERROR :
434 sr == SPF_RESULT_PERMERROR ? ARES_RESULT_PERMERROR :
436 origin = DMARC_POLICY_SPF_ORIGIN_MAILFROM;
437 spf_human_readable = US spf_response->header_comment;
439 debug_printf("DMARC using SPF sender domain = %s\n", spf_sender_domain);
441 if (strcmp( CCS spf_sender_domain, "") == 0)
445 libdm_status = opendmarc_policy_store_spf(dmarc_pctx, spf_sender_domain,
446 dmarc_spf_result, origin, spf_human_readable);
447 if (libdm_status != DMARC_PARSE_OKAY)
448 log_write(0, LOG_MAIN|LOG_PANIC, "failure to store spf for DMARC: %s",
449 opendmarc_policy_status_to_str(libdm_status));
452 /* Now we cycle through the dkim signature results and put into
453 the opendmarc context, further building the DMARC reply. */
455 for(pdkim_signature * sig = dkim_signatures; sig; sig = sig->next)
457 int dkim_result, dkim_ares_result, vs, ves;
459 vs = sig->verify_status & ~PDKIM_VERIFY_POLICY;
460 ves = sig->verify_ext_status;
461 dkim_result = vs == PDKIM_VERIFY_PASS ? DMARC_POLICY_DKIM_OUTCOME_PASS :
462 vs == PDKIM_VERIFY_FAIL ? DMARC_POLICY_DKIM_OUTCOME_FAIL :
463 vs == PDKIM_VERIFY_INVALID ? DMARC_POLICY_DKIM_OUTCOME_TMPFAIL :
464 DMARC_POLICY_DKIM_OUTCOME_NONE;
465 libdm_status = opendmarc_policy_store_dkim(dmarc_pctx, US sig->domain,
467 /* The opendmarc project broke its API in a way we can't detect * easily.
468 The EDITME provides a DMARC_API variable */
469 #if DMARC_API >= 100400
474 debug_printf("DMARC adding DKIM sender domain = %s\n", sig->domain);
475 if (libdm_status != DMARC_PARSE_OKAY)
476 log_write(0, LOG_MAIN|LOG_PANIC,
477 "failure to store dkim (%s) for DMARC: %s",
478 sig->domain, opendmarc_policy_status_to_str(libdm_status));
481 vs == PDKIM_VERIFY_PASS ? ARES_RESULT_PASS :
482 vs == PDKIM_VERIFY_FAIL ? ARES_RESULT_FAIL :
483 vs == PDKIM_VERIFY_NONE ? ARES_RESULT_NONE :
484 vs == PDKIM_VERIFY_INVALID ?
485 ves == PDKIM_VERIFY_INVALID_PUBKEY_UNAVAILABLE ? ARES_RESULT_PERMERROR :
486 ves == PDKIM_VERIFY_INVALID_BUFFER_SIZE ? ARES_RESULT_PERMERROR :
487 ves == PDKIM_VERIFY_INVALID_PUBKEY_DNSRECORD ? ARES_RESULT_PERMERROR :
488 ves == PDKIM_VERIFY_INVALID_PUBKEY_IMPORT ? ARES_RESULT_PERMERROR :
489 ARES_RESULT_UNKNOWN :
491 g = string_fmt_append(g, "dkim %s %d\n", sig->domain, dkim_ares_result);
493 dkim_history_buffer = string_from_gstring(g);
495 /* Look up DMARC policy record in DNS. We do this explicitly, rather than
496 letting the dmarc library do it with opendmarc_policy_query_dmarc(), so that
497 our dns access path is used for debug tracing and for the testsuite
500 libdm_status = (rr = dmarc_dns_lookup(header_from_sender))
501 ? opendmarc_policy_store_dmarc(dmarc_pctx, rr, header_from_sender, NULL)
502 : DMARC_DNS_ERROR_NO_RECORD;
503 switch (libdm_status)
505 case DMARC_DNS_ERROR_NXDOMAIN:
506 case DMARC_DNS_ERROR_NO_RECORD:
508 debug_printf("DMARC no record found for %s\n", header_from_sender);
509 has_dmarc_record = FALSE;
511 case DMARC_PARSE_OKAY:
513 debug_printf("DMARC record found for %s\n", header_from_sender);
515 case DMARC_PARSE_ERROR_BAD_VALUE:
517 debug_printf("DMARC record parse error for %s\n", header_from_sender);
518 has_dmarc_record = FALSE;
521 /* everything else, skip dmarc */
523 debug_printf("DMARC skipping (%d), unsure what to do with %s",
524 libdm_status, from_header->text);
525 has_dmarc_record = FALSE;
529 /* Store the policy string in an expandable variable. */
531 libdm_status = opendmarc_policy_fetch_p(dmarc_pctx, &tmp_ans);
532 for (c = 0; dmarc_policy_description[c].name; c++)
533 if (tmp_ans == dmarc_policy_description[c].value)
535 dmarc_domain_policy = string_sprintf("%s",dmarc_policy_description[c].name);
539 /* Can't use exim's string manipulation functions so allocate memory
540 for libopendmarc using its max hostname length definition. */
542 dmarc_domain = store_get(DMARC_MAXHOSTNAMELEN, GET_TAINTED);
543 libdm_status = opendmarc_policy_fetch_utilized_domain(dmarc_pctx,
544 dmarc_domain, DMARC_MAXHOSTNAMELEN-1);
545 store_release_above(dmarc_domain + Ustrlen(dmarc_domain)+1);
546 dmarc_used_domain = dmarc_domain;
548 if (libdm_status != DMARC_PARSE_OKAY)
549 log_write(0, LOG_MAIN|LOG_PANIC,
550 "failure to read domainname used for DMARC lookup: %s",
551 opendmarc_policy_status_to_str(libdm_status));
553 dmarc_policy = libdm_status = opendmarc_get_policy_to_enforce(dmarc_pctx);
556 case DMARC_POLICY_ABSENT: /* No DMARC record found */
557 dmarc_status = US"norecord";
558 dmarc_pass_fail = US"none";
559 dmarc_status_text = US"No DMARC record";
560 action = DMARC_RESULT_ACCEPT;
562 case DMARC_FROM_DOMAIN_ABSENT: /* No From: domain */
563 dmarc_status = US"nofrom";
564 dmarc_pass_fail = US"temperror";
565 dmarc_status_text = US"No From: domain found";
566 action = DMARC_RESULT_ACCEPT;
568 case DMARC_POLICY_NONE: /* Accept and report */
569 dmarc_status = US"none";
570 dmarc_pass_fail = US"none";
571 dmarc_status_text = US"None, Accept";
572 action = DMARC_RESULT_ACCEPT;
574 case DMARC_POLICY_PASS: /* Explicit accept */
575 dmarc_status = US"accept";
576 dmarc_pass_fail = US"pass";
577 dmarc_status_text = US"Accept";
578 action = DMARC_RESULT_ACCEPT;
580 case DMARC_POLICY_REJECT: /* Explicit reject */
581 dmarc_status = US"reject";
582 dmarc_pass_fail = US"fail";
583 dmarc_status_text = US"Reject";
584 action = DMARC_RESULT_REJECT;
586 case DMARC_POLICY_QUARANTINE: /* Explicit quarantine */
587 dmarc_status = US"quarantine";
588 dmarc_pass_fail = US"fail";
589 dmarc_status_text = US"Quarantine";
590 action = DMARC_RESULT_QUARANTINE;
593 dmarc_status = US"temperror";
594 dmarc_pass_fail = US"temperror";
595 dmarc_status_text = US"Internal Policy Error";
596 action = DMARC_RESULT_TEMPFAIL;
600 libdm_status = opendmarc_policy_fetch_alignment(dmarc_pctx, &da, &sa);
601 if (libdm_status != DMARC_PARSE_OKAY)
602 log_write(0, LOG_MAIN|LOG_PANIC, "failure to read DMARC alignment: %s",
603 opendmarc_policy_status_to_str(libdm_status));
605 if (has_dmarc_record)
607 log_write(0, LOG_MAIN, "DMARC results: spf_domain=%s dmarc_domain=%s "
608 "spf_align=%s dkim_align=%s enforcement='%s'",
609 spf_sender_domain, dmarc_used_domain,
610 sa==DMARC_POLICY_SPF_ALIGNMENT_PASS ?"yes":"no",
611 da==DMARC_POLICY_DKIM_ALIGNMENT_PASS ?"yes":"no",
613 history_file_status = dmarc_write_history_file();
614 /* Now get the forensic reporting addresses, if any */
615 ruf = opendmarc_policy_fetch_ruf(dmarc_pctx, NULL, 0, 1);
616 dmarc_send_forensic_report(ruf);
620 /* shut down libopendmarc */
622 (void) opendmarc_policy_connect_shutdown(dmarc_pctx);
623 if (!f.dmarc_disable_verify)
624 (void) opendmarc_policy_library_shutdown(&dmarc_ctx);
630 dmarc_exim_expand_query(int what)
632 if (f.dmarc_disable_verify || !dmarc_pctx)
633 return dmarc_exim_expand_defaults(what);
635 if (what == DMARC_VERIFY_STATUS)
641 dmarc_exim_expand_defaults(int what)
643 if (what == DMARC_VERIFY_STATUS)
644 return f.dmarc_disable_verify ? US"off" : US"none";
650 authres_dmarc(gstring * g)
652 if (f.dmarc_has_been_checked)
654 g = string_append(g, 2, US";\n\tdmarc=", dmarc_pass_fail);
655 if (header_from_sender)
656 g = string_append(g, 2, US" header.from=", header_from_sender);
661 # endif /* SUPPORT_SPF */
662 #endif /* SUPPORT_DMARC */