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 extern pdkim_signature
*dkim_signatures
;
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
},
54 /* Accept an error_block struct, initialize if empty, parse to the
55 * end, and append the two strings passed to it. Used for adding
56 * variable amounts of value:pair data to the forensic emails. */
59 add_to_eblock(error_block
*eblock
, uschar
*t1
, uschar
*t2
)
61 error_block
*eb
= store_malloc(sizeof(error_block
));
66 /* Find the end of the eblock struct and point it at eb */
67 error_block
*tmp
= eblock
;
68 while(tmp
->next
!= NULL
)
78 /* dmarc_init sets up a context that can be re-used for several
79 messages on the same SMTP connection (that come from the
80 same host with the same HELO string) */
85 int *netmask
= NULL
; /* Ignored */
87 char *tld_file
= dmarc_tld_file
? CS dmarc_tld_file
: DMARC_TLD_FILE
;
89 /* Set some sane defaults. Also clears previous results when
90 * multiple messages in one connection. */
92 dmarc_status
= US
"none";
94 dmarc_pass_fail
= US
"skipped";
95 dmarc_used_domain
= US
"";
96 dmarc_has_been_checked
= FALSE
;
97 header_from_sender
= NULL
;
98 spf_sender_domain
= NULL
;
99 spf_human_readable
= NULL
;
101 /* ACLs have "control=dmarc_disable_verify" */
102 if (dmarc_disable_verify
== TRUE
)
105 (void) memset(&dmarc_ctx
, '\0', sizeof dmarc_ctx
);
106 dmarc_ctx
.nscount
= 0;
107 libdm_status
= opendmarc_policy_library_init(&dmarc_ctx
);
108 if (libdm_status
!= DMARC_PARSE_OKAY
)
110 log_write(0, LOG_MAIN
|LOG_PANIC
, "DMARC failure to init library: %s",
111 opendmarc_policy_status_to_str(libdm_status
));
114 if (dmarc_tld_file
== NULL
)
116 else if (opendmarc_tld_read_file(tld_file
, NULL
, NULL
, NULL
))
118 log_write(0, LOG_MAIN
|LOG_PANIC
, "DMARC failure to load tld list %s: %d",
122 if (sender_host_address
== NULL
)
124 /* This catches locally originated email and startup errors above. */
127 is_ipv6
= string_is_ip_address(sender_host_address
, netmask
) == 6;
128 dmarc_pctx
= opendmarc_policy_connect_init(sender_host_address
, is_ipv6
);
129 if (dmarc_pctx
== NULL
)
131 log_write(0, LOG_MAIN
|LOG_PANIC
,
132 "DMARC failure creating policy context: ip=%s", sender_host_address
);
141 /* dmarc_store_data stores the header data so that subsequent
142 dmarc_process can access the data */
145 dmarc_store_data(header_line
*hdr
)
147 /* No debug output because would change every test debug output */
148 if (!dmarc_disable_verify
)
155 dmarc_send_forensic_report(u_char
**ruf
)
158 uschar
*recipient
, *save_sender
;
159 BOOL send_status
= FALSE
;
160 error_block
*eblock
= NULL
;
161 FILE *message_file
= NULL
;
163 /* Earlier ACL does not have *required* control=dmarc_enable_forensic */
164 if (!dmarc_enable_forensic
)
167 if ( dmarc_policy
== DMARC_POLICY_REJECT
&& action
== DMARC_RESULT_REJECT
168 || dmarc_policy
== DMARC_POLICY_QUARANTINE
&& action
== DMARC_RESULT_QUARANTINE
169 || dmarc_policy
== DMARC_POLICY_NONE
&& action
== DMARC_RESULT_REJECT
170 || dmarc_policy
== DMARC_POLICY_NONE
&& action
== DMARC_RESULT_QUARANTINE
174 eblock
= add_to_eblock(eblock
, US
"Sender Domain", dmarc_used_domain
);
175 eblock
= add_to_eblock(eblock
, US
"Sender IP Address", sender_host_address
);
176 eblock
= add_to_eblock(eblock
, US
"Received Date", tod_stamp(tod_full
));
177 eblock
= add_to_eblock(eblock
, US
"SPF Alignment",
178 (sa
==DMARC_POLICY_SPF_ALIGNMENT_PASS
) ?US
"yes":US
"no");
179 eblock
= add_to_eblock(eblock
, US
"DKIM Alignment",
180 (da
==DMARC_POLICY_DKIM_ALIGNMENT_PASS
)?US
"yes":US
"no");
181 eblock
= add_to_eblock(eblock
, US
"DMARC Results", dmarc_status_text
);
182 /* Set a sane default envelope sender */
183 dsn_from
= dmarc_forensic_sender
? dmarc_forensic_sender
:
184 dsn_from
? dsn_from
:
185 string_sprintf("do-not-reply@%s",primary_hostname
);
186 for (c
= 0; ruf
[c
]; c
++)
188 recipient
= string_copylc(ruf
[c
]);
189 if (Ustrncmp(recipient
, "mailto:",7))
191 /* Move to first character past the colon */
194 debug_printf("DMARC forensic report to %s%s\n", recipient
,
195 (host_checking
|| running_in_test_harness
) ? " (not really)" : "");
196 if (host_checking
|| running_in_test_harness
)
199 save_sender
= sender_address
;
200 sender_address
= recipient
;
201 send_status
= moan_to_sender(ERRMESS_DMARC_FORENSIC
, eblock
,
202 header_list
, message_file
, FALSE
);
203 sender_address
= save_sender
;
205 log_write(0, LOG_MAIN
|LOG_PANIC
,
206 "failure to send DMARC forensic report to %s", recipient
);
211 /* dmarc_process adds the envelope sender address to the existing
212 context (if any), retrieves the result, sets up expansion
213 strings and evaluates the condition outcome. */
218 int sr
, origin
; /* used in SPF section */
219 int dmarc_spf_result
= 0; /* stores spf into dmarc conn ctx */
221 pdkim_signature
*sig
= NULL
;
222 BOOL has_dmarc_record
= TRUE
;
223 u_char
**ruf
; /* forensic report addressees, if called for */
225 /* ACLs have "control=dmarc_disable_verify" */
226 if (dmarc_disable_verify
)
229 /* Store the header From: sender domain for this part of DMARC.
230 * If there is no from_header struct, then it's likely this message
231 * is locally generated and relying on fixups to add it. Just skip
232 * the entire DMARC system if we can't find a From: header....or if
233 * there was a previous error.
235 if (!from_header
|| dmarc_abort
)
244 parse_allow_group
= TRUE
;
245 p
= parse_find_address_end(from_header
->text
, FALSE
);
246 saveend
= *p
; *p
= '\0';
247 if ((header_from_sender
= parse_extract_address(from_header
->text
, &errormsg
,
248 &dummy
, &dummy
, &domain
, FALSE
)))
249 header_from_sender
+= domain
;
252 /* The opendmarc library extracts the domain from the email address, but
253 * only try to store it if it's not empty. Otherwise, skip out of DMARC. */
254 if (!header_from_sender
|| (strcmp( CCS header_from_sender
, "") == 0))
256 libdm_status
= dmarc_abort
?
258 opendmarc_policy_store_from_domain(dmarc_pctx
, header_from_sender
);
259 if (libdm_status
!= DMARC_PARSE_OKAY
)
261 log_write(0, LOG_MAIN
|LOG_PANIC
,
262 "failure to store header From: in DMARC: %s, header was '%s'",
263 opendmarc_policy_status_to_str(libdm_status
), from_header
->text
);
268 /* Skip DMARC if connection is SMTP Auth. Temporarily, admin should
269 * instead do this in the ACLs. */
270 if (!dmarc_abort
&& !sender_host_authenticated
)
272 /* Use the envelope sender domain for this part of DMARC */
273 spf_sender_domain
= expand_string(US
"$sender_address_domain");
276 /* No spf data means null envelope sender so generate a domain name
277 * from the sender_helo_name */
278 if (!spf_sender_domain
)
280 spf_sender_domain
= sender_helo_name
;
281 log_write(0, LOG_MAIN
, "DMARC using synthesized SPF sender domain = %s\n",
284 debug_printf("DMARC using synthesized SPF sender domain = %s\n",
287 dmarc_spf_result
= DMARC_POLICY_SPF_OUTCOME_NONE
;
288 dmarc_spf_ares_result
= ARES_RESULT_UNKNOWN
;
289 origin
= DMARC_POLICY_SPF_ORIGIN_HELO
;
290 spf_human_readable
= US
"";
294 sr
= spf_response
->result
;
295 dmarc_spf_result
= sr
== SPF_RESULT_NEUTRAL
? DMARC_POLICY_SPF_OUTCOME_NONE
:
296 sr
== SPF_RESULT_PASS
? DMARC_POLICY_SPF_OUTCOME_PASS
:
297 sr
== SPF_RESULT_FAIL
? DMARC_POLICY_SPF_OUTCOME_FAIL
:
298 sr
== SPF_RESULT_SOFTFAIL
? DMARC_POLICY_SPF_OUTCOME_TMPFAIL
:
299 DMARC_POLICY_SPF_OUTCOME_NONE
;
300 dmarc_spf_ares_result
= sr
== SPF_RESULT_NEUTRAL
? ARES_RESULT_NEUTRAL
:
301 sr
== SPF_RESULT_PASS
? ARES_RESULT_PASS
:
302 sr
== SPF_RESULT_FAIL
? ARES_RESULT_FAIL
:
303 sr
== SPF_RESULT_SOFTFAIL
? ARES_RESULT_SOFTFAIL
:
304 sr
== SPF_RESULT_NONE
? ARES_RESULT_NONE
:
305 sr
== SPF_RESULT_TEMPERROR
? ARES_RESULT_TEMPERROR
:
306 sr
== SPF_RESULT_PERMERROR
? ARES_RESULT_PERMERROR
:
308 origin
= DMARC_POLICY_SPF_ORIGIN_MAILFROM
;
309 spf_human_readable
= US spf_response
->header_comment
;
311 debug_printf("DMARC using SPF sender domain = %s\n", spf_sender_domain
);
313 if (strcmp( CCS spf_sender_domain
, "") == 0)
317 libdm_status
= opendmarc_policy_store_spf(dmarc_pctx
, spf_sender_domain
,
318 dmarc_spf_result
, origin
, spf_human_readable
);
319 if (libdm_status
!= DMARC_PARSE_OKAY
)
320 log_write(0, LOG_MAIN
|LOG_PANIC
, "failure to store spf for DMARC: %s",
321 opendmarc_policy_status_to_str(libdm_status
));
324 /* Now we cycle through the dkim signature results and put into
325 * the opendmarc context, further building the DMARC reply. */
326 sig
= dkim_signatures
;
327 dkim_history_buffer
= US
"";
330 int dkim_result
, dkim_ares_result
, vs
, ves
;
331 vs
= sig
->verify_status
& ~PDKIM_VERIFY_POLICY
;
332 ves
= sig
->verify_ext_status
;
333 dkim_result
= vs
== PDKIM_VERIFY_PASS
? DMARC_POLICY_DKIM_OUTCOME_PASS
:
334 vs
== PDKIM_VERIFY_FAIL
? DMARC_POLICY_DKIM_OUTCOME_FAIL
:
335 vs
== PDKIM_VERIFY_INVALID
? DMARC_POLICY_DKIM_OUTCOME_TMPFAIL
:
336 DMARC_POLICY_DKIM_OUTCOME_NONE
;
337 libdm_status
= opendmarc_policy_store_dkim(dmarc_pctx
, US sig
->domain
,
340 debug_printf("DMARC adding DKIM sender domain = %s\n", sig
->domain
);
341 if (libdm_status
!= DMARC_PARSE_OKAY
)
342 log_write(0, LOG_MAIN
|LOG_PANIC
,
343 "failure to store dkim (%s) for DMARC: %s",
344 sig
->domain
, opendmarc_policy_status_to_str(libdm_status
));
347 vs
== PDKIM_VERIFY_PASS
? ARES_RESULT_PASS
:
348 vs
== PDKIM_VERIFY_FAIL
? ARES_RESULT_FAIL
:
349 vs
== PDKIM_VERIFY_NONE
? ARES_RESULT_NONE
:
350 vs
== PDKIM_VERIFY_INVALID
?
351 ves
== PDKIM_VERIFY_INVALID_PUBKEY_UNAVAILABLE
? ARES_RESULT_PERMERROR
:
352 ves
== PDKIM_VERIFY_INVALID_BUFFER_SIZE
? ARES_RESULT_PERMERROR
:
353 ves
== PDKIM_VERIFY_INVALID_PUBKEY_DNSRECORD
? ARES_RESULT_PERMERROR
:
354 ves
== PDKIM_VERIFY_INVALID_PUBKEY_IMPORT
? ARES_RESULT_PERMERROR
:
355 ARES_RESULT_UNKNOWN
:
357 dkim_history_buffer
= string_sprintf("%sdkim %s %d\n", dkim_history_buffer
,
358 sig
->domain
, dkim_ares_result
);
361 libdm_status
= opendmarc_policy_query_dmarc(dmarc_pctx
, US
"");
362 switch (libdm_status
)
364 case DMARC_DNS_ERROR_NXDOMAIN
:
365 case DMARC_DNS_ERROR_NO_RECORD
:
367 debug_printf("DMARC no record found for %s\n", header_from_sender
);
368 has_dmarc_record
= FALSE
;
370 case DMARC_PARSE_OKAY
:
372 debug_printf("DMARC record found for %s\n", header_from_sender
);
374 case DMARC_PARSE_ERROR_BAD_VALUE
:
376 debug_printf("DMARC record parse error for %s\n", header_from_sender
);
377 has_dmarc_record
= FALSE
;
380 /* everything else, skip dmarc */
382 debug_printf("DMARC skipping (%d), unsure what to do with %s",
383 libdm_status
, from_header
->text
);
384 has_dmarc_record
= FALSE
;
388 /* Store the policy string in an expandable variable. */
390 libdm_status
= opendmarc_policy_fetch_p(dmarc_pctx
, &tmp_ans
);
391 for (c
= 0; dmarc_policy_description
[c
].name
; c
++)
392 if (tmp_ans
== dmarc_policy_description
[c
].value
)
394 dmarc_domain_policy
= string_sprintf("%s",dmarc_policy_description
[c
].name
);
398 /* Can't use exim's string manipulation functions so allocate memory
399 * for libopendmarc using its max hostname length definition. */
401 uschar
*dmarc_domain
= US
calloc(DMARC_MAXHOSTNAMELEN
, sizeof(uschar
));
402 libdm_status
= opendmarc_policy_fetch_utilized_domain(dmarc_pctx
,
403 dmarc_domain
, DMARC_MAXHOSTNAMELEN
-1);
404 dmarc_used_domain
= string_copy(dmarc_domain
);
407 if (libdm_status
!= DMARC_PARSE_OKAY
)
408 log_write(0, LOG_MAIN
|LOG_PANIC
,
409 "failure to read domainname used for DMARC lookup: %s",
410 opendmarc_policy_status_to_str(libdm_status
));
412 libdm_status
= opendmarc_get_policy_to_enforce(dmarc_pctx
);
413 dmarc_policy
= libdm_status
;
416 case DMARC_POLICY_ABSENT
: /* No DMARC record found */
417 dmarc_status
= US
"norecord";
418 dmarc_pass_fail
= US
"none";
419 dmarc_status_text
= US
"No DMARC record";
420 action
= DMARC_RESULT_ACCEPT
;
422 case DMARC_FROM_DOMAIN_ABSENT
: /* No From: domain */
423 dmarc_status
= US
"nofrom";
424 dmarc_pass_fail
= US
"temperror";
425 dmarc_status_text
= US
"No From: domain found";
426 action
= DMARC_RESULT_ACCEPT
;
428 case DMARC_POLICY_NONE
: /* Accept and report */
429 dmarc_status
= US
"none";
430 dmarc_pass_fail
= US
"none";
431 dmarc_status_text
= US
"None, Accept";
432 action
= DMARC_RESULT_ACCEPT
;
434 case DMARC_POLICY_PASS
: /* Explicit accept */
435 dmarc_status
= US
"accept";
436 dmarc_pass_fail
= US
"pass";
437 dmarc_status_text
= US
"Accept";
438 action
= DMARC_RESULT_ACCEPT
;
440 case DMARC_POLICY_REJECT
: /* Explicit reject */
441 dmarc_status
= US
"reject";
442 dmarc_pass_fail
= US
"fail";
443 dmarc_status_text
= US
"Reject";
444 action
= DMARC_RESULT_REJECT
;
446 case DMARC_POLICY_QUARANTINE
: /* Explicit quarantine */
447 dmarc_status
= US
"quarantine";
448 dmarc_pass_fail
= US
"fail";
449 dmarc_status_text
= US
"Quarantine";
450 action
= DMARC_RESULT_QUARANTINE
;
453 dmarc_status
= US
"temperror";
454 dmarc_pass_fail
= US
"temperror";
455 dmarc_status_text
= US
"Internal Policy Error";
456 action
= DMARC_RESULT_TEMPFAIL
;
460 libdm_status
= opendmarc_policy_fetch_alignment(dmarc_pctx
, &da
, &sa
);
461 if (libdm_status
!= DMARC_PARSE_OKAY
)
462 log_write(0, LOG_MAIN
|LOG_PANIC
, "failure to read DMARC alignment: %s",
463 opendmarc_policy_status_to_str(libdm_status
));
465 if (has_dmarc_record
)
467 log_write(0, LOG_MAIN
, "DMARC results: spf_domain=%s dmarc_domain=%s "
468 "spf_align=%s dkim_align=%s enforcement='%s'",
469 spf_sender_domain
, dmarc_used_domain
,
470 (sa
==DMARC_POLICY_SPF_ALIGNMENT_PASS
) ?"yes":"no",
471 (da
==DMARC_POLICY_DKIM_ALIGNMENT_PASS
)?"yes":"no",
473 history_file_status
= dmarc_write_history_file();
474 /* Now get the forensic reporting addresses, if any */
475 ruf
= opendmarc_policy_fetch_ruf(dmarc_pctx
, NULL
, 0, 1);
476 dmarc_send_forensic_report(ruf
);
480 /* shut down libopendmarc */
482 (void) opendmarc_policy_connect_shutdown(dmarc_pctx
);
483 if (!dmarc_disable_verify
)
484 (void) opendmarc_policy_library_shutdown(&dmarc_ctx
);
490 dmarc_write_history_file()
495 u_char
**rua
; /* aggregate report addressees */
496 uschar
*history_buffer
= NULL
;
498 if (!dmarc_history_file
)
499 return DMARC_HIST_DISABLED
;
500 history_file_fd
= log_create(dmarc_history_file
);
502 if (history_file_fd
< 0)
504 log_write(0, LOG_MAIN
|LOG_PANIC
, "failure to create DMARC history file: %s",
506 return DMARC_HIST_FILE_ERR
;
509 /* Generate the contents of the history file */
510 history_buffer
= string_sprintf(
511 "job %s\nreporter %s\nreceived %ld\nipaddr %s\nfrom %s\nmfrom %s\n",
512 message_id
, primary_hostname
, time(NULL
), sender_host_address
,
513 header_from_sender
, expand_string(US
"$sender_address_domain"));
516 history_buffer
= string_sprintf("%sspf %d\n", history_buffer
, dmarc_spf_ares_result
);
517 /* history_buffer = string_sprintf("%sspf -1\n", history_buffer); */
519 history_buffer
= string_sprintf(
520 "%s%spdomain %s\npolicy %d\n",
521 history_buffer
, dkim_history_buffer
, dmarc_used_domain
, dmarc_policy
);
523 if ((rua
= opendmarc_policy_fetch_rua(dmarc_pctx
, NULL
, 0, 1)))
524 for (tmp_ans
= 0; rua
[tmp_ans
]; tmp_ans
++)
525 history_buffer
= string_sprintf("%srua %s\n", history_buffer
, rua
[tmp_ans
]);
527 history_buffer
= string_sprintf("%srua -\n", history_buffer
);
529 opendmarc_policy_fetch_pct(dmarc_pctx
, &tmp_ans
);
530 history_buffer
= string_sprintf("%spct %d\n", history_buffer
, tmp_ans
);
532 opendmarc_policy_fetch_adkim(dmarc_pctx
, &tmp_ans
);
533 history_buffer
= string_sprintf("%sadkim %d\n", history_buffer
, tmp_ans
);
535 opendmarc_policy_fetch_aspf(dmarc_pctx
, &tmp_ans
);
536 history_buffer
= string_sprintf("%saspf %d\n", history_buffer
, tmp_ans
);
538 opendmarc_policy_fetch_p(dmarc_pctx
, &tmp_ans
);
539 history_buffer
= string_sprintf("%sp %d\n", history_buffer
, tmp_ans
);
541 opendmarc_policy_fetch_sp(dmarc_pctx
, &tmp_ans
);
542 history_buffer
= string_sprintf("%ssp %d\n", history_buffer
, tmp_ans
);
544 history_buffer
= string_sprintf(
545 "%salign_dkim %d\nalign_spf %d\naction %d\n",
546 history_buffer
, da
, sa
, action
);
548 /* Write the contents to the history file */
550 debug_printf("DMARC logging history data for opendmarc reporting%s\n",
551 (host_checking
|| running_in_test_harness
) ? " (not really)" : "");
552 if (host_checking
|| running_in_test_harness
)
555 debug_printf("DMARC history data for debugging:\n%s", history_buffer
);
559 written_len
= write_to_fd_buf(history_file_fd
,
561 Ustrlen(history_buffer
));
562 if (written_len
== 0)
564 log_write(0, LOG_MAIN
|LOG_PANIC
, "failure to write to DMARC history file: %s",
566 return DMARC_HIST_WRITE_ERR
;
568 (void)close(history_file_fd
);
570 return DMARC_HIST_OK
;
575 dmarc_exim_expand_query(int what
)
577 if (dmarc_disable_verify
|| !dmarc_pctx
)
578 return dmarc_exim_expand_defaults(what
);
580 if (what
== DMARC_VERIFY_STATUS
)
586 dmarc_exim_expand_defaults(int what
)
588 if (what
== DMARC_VERIFY_STATUS
)
589 return dmarc_disable_verify
? US
"off" : US
"none";
595 authres_dmarc(gstring
* g
)
597 g
= string_append(g
, 2, US
";\n\tdmarc=", dmarc_pass_fail
);
598 if (header_from_sender
)
599 g
= string_append(g
, 2, US
"header.from=", header_from_sender
);
603 # endif /* SUPPORT_SPF */
604 #endif /* EXPERIMENTAL_DMARC */