1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
4 /* Experimental DMARC support.
5 Copyright (c) Todd Lyons <tlyons@exim.org> 2012 - 2014
8 /* Portions Copyright (c) 2012, 2013, The Trusted Domain Project;
9 All rights reserved, licensed for use per LICENSE.opendmarc. */
11 /* Code for calling dmarc checks via libopendmarc. Called from acl.c. */
14 #ifdef EXPERIMENTAL_DMARC
15 # if !defined SUPPORT_SPF
16 # error SPF must also be enabled for DMARC
17 # elif defined DISABLE_DKIM
18 # error DKIM must also be enabled for DMARC
21 # include "functions.h"
23 # include "pdkim/pdkim.h"
25 OPENDMARC_LIB_T dmarc_ctx
;
26 DMARC_POLICY_T
*dmarc_pctx
= NULL
;
27 OPENDMARC_STATUS_T libdm_status
, action
, dmarc_policy
;
28 OPENDMARC_STATUS_T da
, sa
, action
;
29 BOOL dmarc_abort
= FALSE
;
30 uschar
*dmarc_pass_fail
= US
"skipped";
31 header_line
*from_header
= NULL
;
32 extern SPF_response_t
*spf_response
;
33 int dmarc_spf_ares_result
= 0;
34 uschar
*spf_sender_domain
= NULL
;
35 uschar
*spf_human_readable
= NULL
;
36 u_char
*header_from_sender
= NULL
;
37 int history_file_status
= DMARC_HIST_OK
;
38 uschar
*dkim_history_buffer
= NULL
;
40 typedef struct dmarc_exim_p
{
45 static dmarc_exim_p dmarc_policy_description
[] = {
47 { US
"", DMARC_RECORD_P_UNSPECIFIED
},
48 { US
"none", DMARC_RECORD_P_NONE
},
49 { US
"quarantine", DMARC_RECORD_P_QUARANTINE
},
50 { US
"reject", DMARC_RECORD_P_REJECT
},
53 /* Accept an error_block struct, initialize if empty, parse to the
54 * end, and append the two strings passed to it. Used for adding
55 * variable amounts of value:pair data to the forensic emails. */
58 add_to_eblock(error_block
*eblock
, uschar
*t1
, uschar
*t2
)
60 error_block
*eb
= store_malloc(sizeof(error_block
));
65 /* Find the end of the eblock struct and point it at eb */
66 error_block
*tmp
= eblock
;
67 while(tmp
->next
!= NULL
)
77 /* dmarc_init sets up a context that can be re-used for several
78 messages on the same SMTP connection (that come from the
79 same host with the same HELO string) */
84 int *netmask
= NULL
; /* Ignored */
87 /* Set some sane defaults. Also clears previous results when
88 * multiple messages in one connection. */
90 dmarc_status
= US
"none";
92 dmarc_pass_fail
= US
"skipped";
93 dmarc_used_domain
= US
"";
94 dmarc_has_been_checked
= FALSE
;
95 header_from_sender
= NULL
;
96 spf_sender_domain
= NULL
;
97 spf_human_readable
= NULL
;
99 /* ACLs have "control=dmarc_disable_verify" */
100 if (dmarc_disable_verify
== TRUE
)
103 (void) memset(&dmarc_ctx
, '\0', sizeof dmarc_ctx
);
104 dmarc_ctx
.nscount
= 0;
105 libdm_status
= opendmarc_policy_library_init(&dmarc_ctx
);
106 if (libdm_status
!= DMARC_PARSE_OKAY
)
108 log_write(0, LOG_MAIN
|LOG_PANIC
, "DMARC failure to init library: %s",
109 opendmarc_policy_status_to_str(libdm_status
));
114 DEBUG(D_receive
) debug_printf("DMARC: no dmarc_tld_file\n");
117 else if (opendmarc_tld_read_file(dmarc_tld_file
, NULL
, NULL
, NULL
))
119 log_write(0, LOG_MAIN
|LOG_PANIC
, "DMARC failure to load tld list %s: %d",
120 dmarc_tld_file
, errno
);
123 if (!sender_host_address
)
125 DEBUG(D_receive
) debug_printf("DMARC: no sender_host_address\n");
128 /* This catches locally originated email and startup errors above. */
131 is_ipv6
= string_is_ip_address(sender_host_address
, netmask
) == 6;
132 if (!(dmarc_pctx
= opendmarc_policy_connect_init(sender_host_address
, is_ipv6
)))
134 log_write(0, LOG_MAIN
|LOG_PANIC
,
135 "DMARC failure creating policy context: ip=%s", sender_host_address
);
144 /* dmarc_store_data stores the header data so that subsequent
145 dmarc_process can access the data */
148 dmarc_store_data(header_line
*hdr
)
150 /* No debug output because would change every test debug output */
151 if (!dmarc_disable_verify
)
158 dmarc_send_forensic_report(u_char
**ruf
)
161 uschar
*recipient
, *save_sender
;
162 BOOL send_status
= FALSE
;
163 error_block
*eblock
= NULL
;
164 FILE *message_file
= NULL
;
166 /* Earlier ACL does not have *required* control=dmarc_enable_forensic */
167 if (!dmarc_enable_forensic
)
170 if ( dmarc_policy
== DMARC_POLICY_REJECT
&& action
== DMARC_RESULT_REJECT
171 || dmarc_policy
== DMARC_POLICY_QUARANTINE
&& action
== DMARC_RESULT_QUARANTINE
172 || dmarc_policy
== DMARC_POLICY_NONE
&& action
== DMARC_RESULT_REJECT
173 || dmarc_policy
== DMARC_POLICY_NONE
&& action
== DMARC_RESULT_QUARANTINE
177 eblock
= add_to_eblock(eblock
, US
"Sender Domain", dmarc_used_domain
);
178 eblock
= add_to_eblock(eblock
, US
"Sender IP Address", sender_host_address
);
179 eblock
= add_to_eblock(eblock
, US
"Received Date", tod_stamp(tod_full
));
180 eblock
= add_to_eblock(eblock
, US
"SPF Alignment",
181 (sa
==DMARC_POLICY_SPF_ALIGNMENT_PASS
) ?US
"yes":US
"no");
182 eblock
= add_to_eblock(eblock
, US
"DKIM Alignment",
183 (da
==DMARC_POLICY_DKIM_ALIGNMENT_PASS
)?US
"yes":US
"no");
184 eblock
= add_to_eblock(eblock
, US
"DMARC Results", dmarc_status_text
);
185 /* Set a sane default envelope sender */
186 dsn_from
= dmarc_forensic_sender
? dmarc_forensic_sender
:
187 dsn_from
? dsn_from
:
188 string_sprintf("do-not-reply@%s",primary_hostname
);
189 for (c
= 0; ruf
[c
]; c
++)
191 recipient
= string_copylc(ruf
[c
]);
192 if (Ustrncmp(recipient
, "mailto:",7))
194 /* Move to first character past the colon */
197 debug_printf("DMARC forensic report to %s%s\n", recipient
,
198 (host_checking
|| running_in_test_harness
) ? " (not really)" : "");
199 if (host_checking
|| running_in_test_harness
)
202 save_sender
= sender_address
;
203 sender_address
= recipient
;
204 send_status
= moan_to_sender(ERRMESS_DMARC_FORENSIC
, eblock
,
205 header_list
, message_file
, FALSE
);
206 sender_address
= save_sender
;
208 log_write(0, LOG_MAIN
|LOG_PANIC
,
209 "failure to send DMARC forensic report to %s", recipient
);
214 /* dmarc_process adds the envelope sender address to the existing
215 context (if any), retrieves the result, sets up expansion
216 strings and evaluates the condition outcome. */
221 int sr
, origin
; /* used in SPF section */
222 int dmarc_spf_result
= 0; /* stores spf into dmarc conn ctx */
224 pdkim_signature
* sig
= dkim_signatures
;
225 BOOL has_dmarc_record
= TRUE
;
226 u_char
**ruf
; /* forensic report addressees, if called for */
228 /* ACLs have "control=dmarc_disable_verify" */
229 if (dmarc_disable_verify
)
232 /* Store the header From: sender domain for this part of DMARC.
233 * If there is no from_header struct, then it's likely this message
234 * is locally generated and relying on fixups to add it. Just skip
235 * the entire DMARC system if we can't find a From: header....or if
236 * there was a previous error.
240 DEBUG(D_receive
) debug_printf("DMARC: no From: header\n");
243 else if (!dmarc_abort
)
250 parse_allow_group
= TRUE
;
251 p
= parse_find_address_end(from_header
->text
, FALSE
);
252 saveend
= *p
; *p
= '\0';
253 if ((header_from_sender
= parse_extract_address(from_header
->text
, &errormsg
,
254 &dummy
, &dummy
, &domain
, FALSE
)))
255 header_from_sender
+= domain
;
258 /* The opendmarc library extracts the domain from the email address, but
259 * only try to store it if it's not empty. Otherwise, skip out of DMARC. */
260 if (!header_from_sender
|| (strcmp( CCS header_from_sender
, "") == 0))
262 libdm_status
= dmarc_abort
264 : opendmarc_policy_store_from_domain(dmarc_pctx
, header_from_sender
);
265 if (libdm_status
!= DMARC_PARSE_OKAY
)
267 log_write(0, LOG_MAIN
|LOG_PANIC
,
268 "failure to store header From: in DMARC: %s, header was '%s'",
269 opendmarc_policy_status_to_str(libdm_status
), from_header
->text
);
274 /* Skip DMARC if connection is SMTP Auth. Temporarily, admin should
275 * instead do this in the ACLs. */
276 if (!dmarc_abort
&& !sender_host_authenticated
)
278 uschar
* dmarc_domain
;
280 /* Use the envelope sender domain for this part of DMARC */
281 spf_sender_domain
= expand_string(US
"$sender_address_domain");
284 /* No spf data means null envelope sender so generate a domain name
285 * from the sender_helo_name */
286 if (!spf_sender_domain
)
288 spf_sender_domain
= sender_helo_name
;
289 log_write(0, LOG_MAIN
, "DMARC using synthesized SPF sender domain = %s\n",
292 debug_printf("DMARC using synthesized SPF sender domain = %s\n",
295 dmarc_spf_result
= DMARC_POLICY_SPF_OUTCOME_NONE
;
296 dmarc_spf_ares_result
= ARES_RESULT_UNKNOWN
;
297 origin
= DMARC_POLICY_SPF_ORIGIN_HELO
;
298 spf_human_readable
= US
"";
302 sr
= spf_response
->result
;
303 dmarc_spf_result
= sr
== SPF_RESULT_NEUTRAL
? DMARC_POLICY_SPF_OUTCOME_NONE
:
304 sr
== SPF_RESULT_PASS
? DMARC_POLICY_SPF_OUTCOME_PASS
:
305 sr
== SPF_RESULT_FAIL
? DMARC_POLICY_SPF_OUTCOME_FAIL
:
306 sr
== SPF_RESULT_SOFTFAIL
? DMARC_POLICY_SPF_OUTCOME_TMPFAIL
:
307 DMARC_POLICY_SPF_OUTCOME_NONE
;
308 dmarc_spf_ares_result
= sr
== SPF_RESULT_NEUTRAL
? ARES_RESULT_NEUTRAL
:
309 sr
== SPF_RESULT_PASS
? ARES_RESULT_PASS
:
310 sr
== SPF_RESULT_FAIL
? ARES_RESULT_FAIL
:
311 sr
== SPF_RESULT_SOFTFAIL
? ARES_RESULT_SOFTFAIL
:
312 sr
== SPF_RESULT_NONE
? ARES_RESULT_NONE
:
313 sr
== SPF_RESULT_TEMPERROR
? ARES_RESULT_TEMPERROR
:
314 sr
== SPF_RESULT_PERMERROR
? ARES_RESULT_PERMERROR
:
316 origin
= DMARC_POLICY_SPF_ORIGIN_MAILFROM
;
317 spf_human_readable
= US spf_response
->header_comment
;
319 debug_printf("DMARC using SPF sender domain = %s\n", spf_sender_domain
);
321 if (strcmp( CCS spf_sender_domain
, "") == 0)
325 libdm_status
= opendmarc_policy_store_spf(dmarc_pctx
, spf_sender_domain
,
326 dmarc_spf_result
, origin
, spf_human_readable
);
327 if (libdm_status
!= DMARC_PARSE_OKAY
)
328 log_write(0, LOG_MAIN
|LOG_PANIC
, "failure to store spf for DMARC: %s",
329 opendmarc_policy_status_to_str(libdm_status
));
332 /* Now we cycle through the dkim signature results and put into
333 * the opendmarc context, further building the DMARC reply. */
334 dkim_history_buffer
= US
"";
337 int dkim_result
, dkim_ares_result
, vs
, ves
;
339 vs
= sig
->verify_status
& ~PDKIM_VERIFY_POLICY
;
340 ves
= sig
->verify_ext_status
;
341 dkim_result
= vs
== PDKIM_VERIFY_PASS
? DMARC_POLICY_DKIM_OUTCOME_PASS
:
342 vs
== PDKIM_VERIFY_FAIL
? DMARC_POLICY_DKIM_OUTCOME_FAIL
:
343 vs
== PDKIM_VERIFY_INVALID
? DMARC_POLICY_DKIM_OUTCOME_TMPFAIL
:
344 DMARC_POLICY_DKIM_OUTCOME_NONE
;
345 libdm_status
= opendmarc_policy_store_dkim(dmarc_pctx
, US sig
->domain
,
348 debug_printf("DMARC adding DKIM sender domain = %s\n", sig
->domain
);
349 if (libdm_status
!= DMARC_PARSE_OKAY
)
350 log_write(0, LOG_MAIN
|LOG_PANIC
,
351 "failure to store dkim (%s) for DMARC: %s",
352 sig
->domain
, opendmarc_policy_status_to_str(libdm_status
));
355 vs
== PDKIM_VERIFY_PASS
? ARES_RESULT_PASS
:
356 vs
== PDKIM_VERIFY_FAIL
? ARES_RESULT_FAIL
:
357 vs
== PDKIM_VERIFY_NONE
? ARES_RESULT_NONE
:
358 vs
== PDKIM_VERIFY_INVALID
?
359 ves
== PDKIM_VERIFY_INVALID_PUBKEY_UNAVAILABLE
? ARES_RESULT_PERMERROR
:
360 ves
== PDKIM_VERIFY_INVALID_BUFFER_SIZE
? ARES_RESULT_PERMERROR
:
361 ves
== PDKIM_VERIFY_INVALID_PUBKEY_DNSRECORD
? ARES_RESULT_PERMERROR
:
362 ves
== PDKIM_VERIFY_INVALID_PUBKEY_IMPORT
? ARES_RESULT_PERMERROR
:
363 ARES_RESULT_UNKNOWN
:
365 dkim_history_buffer
= string_sprintf("%sdkim %s %d\n", dkim_history_buffer
,
366 sig
->domain
, dkim_ares_result
);
369 libdm_status
= opendmarc_policy_query_dmarc(dmarc_pctx
, US
"");
370 switch (libdm_status
)
372 case DMARC_DNS_ERROR_NXDOMAIN
:
373 case DMARC_DNS_ERROR_NO_RECORD
:
375 debug_printf("DMARC no record found for %s\n", header_from_sender
);
376 has_dmarc_record
= FALSE
;
378 case DMARC_PARSE_OKAY
:
380 debug_printf("DMARC record found for %s\n", header_from_sender
);
382 case DMARC_PARSE_ERROR_BAD_VALUE
:
384 debug_printf("DMARC record parse error for %s\n", header_from_sender
);
385 has_dmarc_record
= FALSE
;
388 /* everything else, skip dmarc */
390 debug_printf("DMARC skipping (%d), unsure what to do with %s",
391 libdm_status
, from_header
->text
);
392 has_dmarc_record
= FALSE
;
396 /* Store the policy string in an expandable variable. */
398 libdm_status
= opendmarc_policy_fetch_p(dmarc_pctx
, &tmp_ans
);
399 for (c
= 0; dmarc_policy_description
[c
].name
; c
++)
400 if (tmp_ans
== dmarc_policy_description
[c
].value
)
402 dmarc_domain_policy
= string_sprintf("%s",dmarc_policy_description
[c
].name
);
406 /* Can't use exim's string manipulation functions so allocate memory
407 for libopendmarc using its max hostname length definition. */
409 dmarc_domain
= US
calloc(DMARC_MAXHOSTNAMELEN
, sizeof(uschar
));
410 libdm_status
= opendmarc_policy_fetch_utilized_domain(dmarc_pctx
,
411 dmarc_domain
, DMARC_MAXHOSTNAMELEN
-1);
412 dmarc_used_domain
= string_copy(dmarc_domain
);
415 if (libdm_status
!= DMARC_PARSE_OKAY
)
416 log_write(0, LOG_MAIN
|LOG_PANIC
,
417 "failure to read domainname used for DMARC lookup: %s",
418 opendmarc_policy_status_to_str(libdm_status
));
420 dmarc_policy
= libdm_status
= opendmarc_get_policy_to_enforce(dmarc_pctx
);
423 case DMARC_POLICY_ABSENT
: /* No DMARC record found */
424 dmarc_status
= US
"norecord";
425 dmarc_pass_fail
= US
"none";
426 dmarc_status_text
= US
"No DMARC record";
427 action
= DMARC_RESULT_ACCEPT
;
429 case DMARC_FROM_DOMAIN_ABSENT
: /* No From: domain */
430 dmarc_status
= US
"nofrom";
431 dmarc_pass_fail
= US
"temperror";
432 dmarc_status_text
= US
"No From: domain found";
433 action
= DMARC_RESULT_ACCEPT
;
435 case DMARC_POLICY_NONE
: /* Accept and report */
436 dmarc_status
= US
"none";
437 dmarc_pass_fail
= US
"none";
438 dmarc_status_text
= US
"None, Accept";
439 action
= DMARC_RESULT_ACCEPT
;
441 case DMARC_POLICY_PASS
: /* Explicit accept */
442 dmarc_status
= US
"accept";
443 dmarc_pass_fail
= US
"pass";
444 dmarc_status_text
= US
"Accept";
445 action
= DMARC_RESULT_ACCEPT
;
447 case DMARC_POLICY_REJECT
: /* Explicit reject */
448 dmarc_status
= US
"reject";
449 dmarc_pass_fail
= US
"fail";
450 dmarc_status_text
= US
"Reject";
451 action
= DMARC_RESULT_REJECT
;
453 case DMARC_POLICY_QUARANTINE
: /* Explicit quarantine */
454 dmarc_status
= US
"quarantine";
455 dmarc_pass_fail
= US
"fail";
456 dmarc_status_text
= US
"Quarantine";
457 action
= DMARC_RESULT_QUARANTINE
;
460 dmarc_status
= US
"temperror";
461 dmarc_pass_fail
= US
"temperror";
462 dmarc_status_text
= US
"Internal Policy Error";
463 action
= DMARC_RESULT_TEMPFAIL
;
467 libdm_status
= opendmarc_policy_fetch_alignment(dmarc_pctx
, &da
, &sa
);
468 if (libdm_status
!= DMARC_PARSE_OKAY
)
469 log_write(0, LOG_MAIN
|LOG_PANIC
, "failure to read DMARC alignment: %s",
470 opendmarc_policy_status_to_str(libdm_status
));
472 if (has_dmarc_record
)
474 log_write(0, LOG_MAIN
, "DMARC results: spf_domain=%s dmarc_domain=%s "
475 "spf_align=%s dkim_align=%s enforcement='%s'",
476 spf_sender_domain
, dmarc_used_domain
,
477 sa
==DMARC_POLICY_SPF_ALIGNMENT_PASS
?"yes":"no",
478 da
==DMARC_POLICY_DKIM_ALIGNMENT_PASS
?"yes":"no",
480 history_file_status
= dmarc_write_history_file();
481 /* Now get the forensic reporting addresses, if any */
482 ruf
= opendmarc_policy_fetch_ruf(dmarc_pctx
, NULL
, 0, 1);
483 dmarc_send_forensic_report(ruf
);
487 /* shut down libopendmarc */
489 (void) opendmarc_policy_connect_shutdown(dmarc_pctx
);
490 if (!dmarc_disable_verify
)
491 (void) opendmarc_policy_library_shutdown(&dmarc_ctx
);
497 dmarc_write_history_file()
502 u_char
**rua
; /* aggregate report addressees */
503 uschar
*history_buffer
= NULL
;
505 if (!dmarc_history_file
)
507 DEBUG(D_receive
) debug_printf("DMARC history file not set\n");
508 return DMARC_HIST_DISABLED
;
510 history_file_fd
= log_create(dmarc_history_file
);
512 if (history_file_fd
< 0)
514 log_write(0, LOG_MAIN
|LOG_PANIC
, "failure to create DMARC history file: %s",
516 return DMARC_HIST_FILE_ERR
;
519 /* Generate the contents of the history file */
520 history_buffer
= string_sprintf(
521 "job %s\nreporter %s\nreceived %ld\nipaddr %s\nfrom %s\nmfrom %s\n",
522 message_id
, primary_hostname
, time(NULL
), sender_host_address
,
523 header_from_sender
, expand_string(US
"$sender_address_domain"));
526 history_buffer
= string_sprintf("%sspf %d\n", history_buffer
, dmarc_spf_ares_result
);
527 /* history_buffer = string_sprintf("%sspf -1\n", history_buffer); */
529 history_buffer
= string_sprintf(
530 "%s%spdomain %s\npolicy %d\n",
531 history_buffer
, dkim_history_buffer
, dmarc_used_domain
, dmarc_policy
);
533 if ((rua
= opendmarc_policy_fetch_rua(dmarc_pctx
, NULL
, 0, 1)))
534 for (tmp_ans
= 0; rua
[tmp_ans
]; tmp_ans
++)
535 history_buffer
= string_sprintf("%srua %s\n", history_buffer
, rua
[tmp_ans
]);
537 history_buffer
= string_sprintf("%srua -\n", history_buffer
);
539 opendmarc_policy_fetch_pct(dmarc_pctx
, &tmp_ans
);
540 history_buffer
= string_sprintf("%spct %d\n", history_buffer
, tmp_ans
);
542 opendmarc_policy_fetch_adkim(dmarc_pctx
, &tmp_ans
);
543 history_buffer
= string_sprintf("%sadkim %d\n", history_buffer
, tmp_ans
);
545 opendmarc_policy_fetch_aspf(dmarc_pctx
, &tmp_ans
);
546 history_buffer
= string_sprintf("%saspf %d\n", history_buffer
, tmp_ans
);
548 opendmarc_policy_fetch_p(dmarc_pctx
, &tmp_ans
);
549 history_buffer
= string_sprintf("%sp %d\n", history_buffer
, tmp_ans
);
551 opendmarc_policy_fetch_sp(dmarc_pctx
, &tmp_ans
);
552 history_buffer
= string_sprintf("%ssp %d\n", history_buffer
, tmp_ans
);
554 history_buffer
= string_sprintf(
555 "%salign_dkim %d\nalign_spf %d\naction %d\n",
556 history_buffer
, da
, sa
, action
);
558 /* Write the contents to the history file */
560 debug_printf("DMARC logging history data for opendmarc reporting%s\n",
561 (host_checking
|| running_in_test_harness
) ? " (not really)" : "");
562 if (host_checking
|| running_in_test_harness
)
565 debug_printf("DMARC history data for debugging:\n%s", history_buffer
);
569 written_len
= write_to_fd_buf(history_file_fd
,
571 Ustrlen(history_buffer
));
572 if (written_len
== 0)
574 log_write(0, LOG_MAIN
|LOG_PANIC
, "failure to write to DMARC history file: %s",
576 return DMARC_HIST_WRITE_ERR
;
578 (void)close(history_file_fd
);
580 return DMARC_HIST_OK
;
585 dmarc_exim_expand_query(int what
)
587 if (dmarc_disable_verify
|| !dmarc_pctx
)
588 return dmarc_exim_expand_defaults(what
);
590 if (what
== DMARC_VERIFY_STATUS
)
596 dmarc_exim_expand_defaults(int what
)
598 if (what
== DMARC_VERIFY_STATUS
)
599 return dmarc_disable_verify
? US
"off" : US
"none";
605 authres_dmarc(gstring
* g
)
607 if (dmarc_has_been_checked
)
609 g
= string_append(g
, 2, US
";\n\tdmarc=", dmarc_pass_fail
);
610 if (header_from_sender
)
611 g
= string_append(g
, 2, US
" header.from=", header_from_sender
);
616 # endif /* SUPPORT_SPF */
617 #endif /* EXPERIMENTAL_DMARC */