DANE: current src version
[exim.git] / src / src / dmarc.c
CommitLineData
4840604e
TL
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4/* Experimental DMARC support.
5a66c31b 5 Copyright (c) Todd Lyons <tlyons@exim.org> 2012 - 2014
4840604e
TL
6 License: GPL */
7
8/* Portions Copyright (c) 2012, 2013, The Trusted Domain Project;
9 All rights reserved, licensed for use per LICENSE.opendmarc. */
10
11/* Code for calling dmarc checks via libopendmarc. Called from acl.c. */
12
13#include "exim.h"
14#ifdef EXPERIMENTAL_DMARC
c007c974
JH
15# if !defined EXPERIMENTAL_SPF
16# error SPF must also be enabled for DMARC
17# elif defined DISABLE_DKIM
18# error DKIM must also be enabled for DMARC
19# else
4840604e 20
c007c974
JH
21# include "functions.h"
22# include "dmarc.h"
23# include "pdkim/pdkim.h"
4840604e
TL
24
25OPENDMARC_LIB_T dmarc_ctx;
26DMARC_POLICY_T *dmarc_pctx = NULL;
27OPENDMARC_STATUS_T libdm_status, action, dmarc_policy;
28OPENDMARC_STATUS_T da, sa, action;
29BOOL dmarc_abort = FALSE;
30uschar *dmarc_pass_fail = US"skipped";
31extern pdkim_signature *dkim_signatures;
32header_line *from_header = NULL;
4840604e 33extern SPF_response_t *spf_response;
620df281 34int dmarc_spf_ares_result = 0;
4840604e
TL
35uschar *spf_sender_domain = NULL;
36uschar *spf_human_readable = NULL;
4840604e
TL
37u_char *header_from_sender = NULL;
38int history_file_status = DMARC_HIST_OK;
4840604e
TL
39uschar *dkim_history_buffer= NULL;
40
8c8b8274
TL
41typedef struct dmarc_exim_p {
42 uschar *name;
43 int value;
44} dmarc_exim_p;
45
46static 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 },
51 { NULL, 0 }
52};
4840604e
TL
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. */
56
57static error_block *
58add_to_eblock(error_block *eblock, uschar *t1, uschar *t2)
59{
c007c974
JH
60error_block *eb = malloc(sizeof(error_block));
61if (eblock == NULL)
62 eblock = eb;
63else
4840604e 64 {
c007c974
JH
65 /* Find the end of the eblock struct and point it at eb */
66 error_block *tmp = eblock;
67 while(tmp->next != NULL)
68 tmp = tmp->next;
69 tmp->next = eb;
4840604e 70 }
c007c974
JH
71eb->text1 = t1;
72eb->text2 = t2;
73eb->next = NULL;
74return eblock;
4840604e
TL
75}
76
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) */
80
4a8ce2d8
TL
81int dmarc_init()
82{
c007c974
JH
83int *netmask = NULL; /* Ignored */
84int is_ipv6 = 0;
85char *tld_file = (dmarc_tld_file == NULL) ?
86 "/etc/exim/opendmarc.tlds" :
87 (char *)dmarc_tld_file;
88
89/* Set some sane defaults. Also clears previous results when
90 * multiple messages in one connection. */
91dmarc_pctx = NULL;
92dmarc_status = US"none";
93dmarc_abort = FALSE;
94dmarc_pass_fail = US"skipped";
95dmarc_used_domain = US"";
96dmarc_ar_header = NULL;
97dmarc_has_been_checked = FALSE;
98header_from_sender = NULL;
99spf_sender_domain = NULL;
100spf_human_readable = NULL;
101
102/* ACLs have "control=dmarc_disable_verify" */
103if (dmarc_disable_verify == TRUE)
104 return OK;
105
106(void) memset(&dmarc_ctx, '\0', sizeof dmarc_ctx);
107dmarc_ctx.nscount = 0;
108libdm_status = opendmarc_policy_library_init(&dmarc_ctx);
109if (libdm_status != DMARC_PARSE_OKAY)
4840604e 110 {
c007c974
JH
111 log_write(0, LOG_MAIN|LOG_PANIC, "DMARC failure to init library: %s",
112 opendmarc_policy_status_to_str(libdm_status));
113 dmarc_abort = TRUE;
4840604e 114 }
c007c974
JH
115if (dmarc_tld_file == NULL)
116 dmarc_abort = TRUE;
117else if (opendmarc_tld_read_file(tld_file, NULL, NULL, NULL))
4840604e 118 {
c007c974
JH
119 log_write(0, LOG_MAIN|LOG_PANIC, "DMARC failure to load tld list %s: %d",
120 tld_file, errno);
121 dmarc_abort = TRUE;
4840604e 122 }
c007c974
JH
123if (sender_host_address == NULL)
124 dmarc_abort = TRUE;
125/* This catches locally originated email and startup errors above. */
126if (!dmarc_abort)
4840604e 127 {
c007c974
JH
128 is_ipv6 = string_is_ip_address(sender_host_address, netmask) == 6;
129 dmarc_pctx = opendmarc_policy_connect_init(sender_host_address, is_ipv6);
130 if (dmarc_pctx == NULL)
4840604e 131 {
c007c974
JH
132 log_write(0, LOG_MAIN|LOG_PANIC,
133 "DMARC failure creating policy context: ip=%s", sender_host_address);
134 dmarc_abort = TRUE;
4840604e
TL
135 }
136 }
137
c007c974 138return OK;
4840604e
TL
139}
140
141
142/* dmarc_store_data stores the header data so that subsequent
143 * dmarc_process can access the data */
144
145int dmarc_store_data(header_line *hdr) {
146 /* No debug output because would change every test debug output */
147 if (dmarc_disable_verify != TRUE)
148 from_header = hdr;
149 return OK;
150}
151
152
153/* dmarc_process adds the envelope sender address to the existing
154 context (if any), retrieves the result, sets up expansion
155 strings and evaluates the condition outcome. */
156
c007c974
JH
157int
158dmarc_process()
159{
160int sr, origin; /* used in SPF section */
161int dmarc_spf_result = 0; /* stores spf into dmarc conn ctx */
162int tmp_ans, c;
163pdkim_signature *sig = NULL;
164BOOL has_dmarc_record = TRUE;
165u_char **ruf; /* forensic report addressees, if called for */
166
167/* ACLs have "control=dmarc_disable_verify" */
168if (dmarc_disable_verify)
4840604e 169 {
c007c974
JH
170 dmarc_ar_header = dmarc_auth_results_header(from_header, NULL);
171 return OK;
4840604e
TL
172 }
173
c007c974
JH
174/* Store the header From: sender domain for this part of DMARC.
175 * If there is no from_header struct, then it's likely this message
176 * is locally generated and relying on fixups to add it. Just skip
177 * the entire DMARC system if we can't find a From: header....or if
178 * there was a previous error.
179 */
180if (!from_header || dmarc_abort)
181 dmarc_abort = TRUE;
182else
4840604e 183 {
d502442a
TL
184 uschar * errormsg;
185 int dummy, domain;
186 uschar * p;
187 uschar saveend;
188
189 parse_allow_group = TRUE;
190 p = parse_find_address_end(from_header->text, FALSE);
191 saveend = *p; *p = '\0';
192 if ((header_from_sender = parse_extract_address(from_header->text, &errormsg,
193 &dummy, &dummy, &domain, FALSE)))
194 header_from_sender += domain;
195 *p = saveend;
196
4840604e
TL
197 /* The opendmarc library extracts the domain from the email address, but
198 * only try to store it if it's not empty. Otherwise, skip out of DMARC. */
d502442a 199 if (!header_from_sender || (strcmp( CCS header_from_sender, "") == 0))
4840604e 200 dmarc_abort = TRUE;
d502442a 201 libdm_status = dmarc_abort ?
5a1b8443
WB
202 DMARC_PARSE_OKAY :
203 opendmarc_policy_store_from_domain(dmarc_pctx, header_from_sender);
4840604e
TL
204 if (libdm_status != DMARC_PARSE_OKAY)
205 {
c007c974
JH
206 log_write(0, LOG_MAIN|LOG_PANIC,
207 "failure to store header From: in DMARC: %s, header was '%s'",
208 opendmarc_policy_status_to_str(libdm_status), from_header->text);
209 dmarc_abort = TRUE;
4840604e
TL
210 }
211 }
212
c007c974
JH
213/* Skip DMARC if connection is SMTP Auth. Temporarily, admin should
214 * instead do this in the ACLs. */
215if (!dmarc_abort && !sender_host_authenticated)
4840604e 216 {
c007c974
JH
217 /* Use the envelope sender domain for this part of DMARC */
218 spf_sender_domain = expand_string(US"$sender_address_domain");
219 if (!spf_response)
4840604e 220 {
c007c974
JH
221 /* No spf data means null envelope sender so generate a domain name
222 * from the sender_helo_name */
223 if (!spf_sender_domain)
4840604e 224 {
c007c974
JH
225 spf_sender_domain = sender_helo_name;
226 log_write(0, LOG_MAIN, "DMARC using synthesized SPF sender domain = %s\n",
227 spf_sender_domain);
228 DEBUG(D_receive)
229 debug_printf("DMARC using synthesized SPF sender domain = %s\n",
230 spf_sender_domain);
4840604e 231 }
c007c974
JH
232 dmarc_spf_result = DMARC_POLICY_SPF_OUTCOME_NONE;
233 dmarc_spf_ares_result = ARES_RESULT_UNKNOWN;
234 origin = DMARC_POLICY_SPF_ORIGIN_HELO;
235 spf_human_readable = US"";
4840604e 236 }
c007c974 237 else
4840604e 238 {
c007c974
JH
239 sr = spf_response->result;
240 dmarc_spf_result = sr == SPF_RESULT_NEUTRAL ? DMARC_POLICY_SPF_OUTCOME_NONE :
241 sr == SPF_RESULT_PASS ? DMARC_POLICY_SPF_OUTCOME_PASS :
242 sr == SPF_RESULT_FAIL ? DMARC_POLICY_SPF_OUTCOME_FAIL :
243 sr == SPF_RESULT_SOFTFAIL ? DMARC_POLICY_SPF_OUTCOME_TMPFAIL :
244 DMARC_POLICY_SPF_OUTCOME_NONE;
245 dmarc_spf_ares_result = sr == SPF_RESULT_NEUTRAL ? ARES_RESULT_NEUTRAL :
246 sr == SPF_RESULT_PASS ? ARES_RESULT_PASS :
247 sr == SPF_RESULT_FAIL ? ARES_RESULT_FAIL :
248 sr == SPF_RESULT_SOFTFAIL ? ARES_RESULT_SOFTFAIL :
249 sr == SPF_RESULT_NONE ? ARES_RESULT_NONE :
250 sr == SPF_RESULT_TEMPERROR ? ARES_RESULT_TEMPERROR :
251 sr == SPF_RESULT_PERMERROR ? ARES_RESULT_PERMERROR :
252 ARES_RESULT_UNKNOWN;
253 origin = DMARC_POLICY_SPF_ORIGIN_MAILFROM;
254 spf_human_readable = (uschar *)spf_response->header_comment;
255 DEBUG(D_receive)
256 debug_printf("DMARC using SPF sender domain = %s\n", spf_sender_domain);
4840604e 257 }
c007c974
JH
258 if (strcmp( CCS spf_sender_domain, "") == 0)
259 dmarc_abort = TRUE;
260 if (!dmarc_abort)
4840604e 261 {
c007c974
JH
262 libdm_status = opendmarc_policy_store_spf(dmarc_pctx, spf_sender_domain,
263 dmarc_spf_result, origin, spf_human_readable);
264 if (libdm_status != DMARC_PARSE_OKAY)
265 log_write(0, LOG_MAIN|LOG_PANIC, "failure to store spf for DMARC: %s",
266 opendmarc_policy_status_to_str(libdm_status));
4840604e 267 }
4840604e 268
c007c974
JH
269 /* Now we cycle through the dkim signature results and put into
270 * the opendmarc context, further building the DMARC reply. */
271 sig = dkim_signatures;
272 dkim_history_buffer = US"";
273 while (sig)
4840604e 274 {
c007c974
JH
275 int dkim_result, dkim_ares_result, vs, ves;
276 vs = sig->verify_status;
277 ves = sig->verify_ext_status;
278 dkim_result = vs == PDKIM_VERIFY_PASS ? DMARC_POLICY_DKIM_OUTCOME_PASS :
279 vs == PDKIM_VERIFY_FAIL ? DMARC_POLICY_DKIM_OUTCOME_FAIL :
280 vs == PDKIM_VERIFY_INVALID ? DMARC_POLICY_DKIM_OUTCOME_TMPFAIL :
281 DMARC_POLICY_DKIM_OUTCOME_NONE;
282 libdm_status = opendmarc_policy_store_dkim(dmarc_pctx, (uschar *)sig->domain,
283 dkim_result, US"");
284 DEBUG(D_receive)
285 debug_printf("DMARC adding DKIM sender domain = %s\n", sig->domain);
286 if (libdm_status != DMARC_PARSE_OKAY)
287 log_write(0, LOG_MAIN|LOG_PANIC,
288 "failure to store dkim (%s) for DMARC: %s",
289 sig->domain, opendmarc_policy_status_to_str(libdm_status));
290
291 dkim_ares_result =
292 vs == PDKIM_VERIFY_PASS ? ARES_RESULT_PASS :
293 vs == PDKIM_VERIFY_FAIL ? ARES_RESULT_FAIL :
294 vs == PDKIM_VERIFY_NONE ? ARES_RESULT_NONE :
295 vs == PDKIM_VERIFY_INVALID ?
296 ves == PDKIM_VERIFY_INVALID_PUBKEY_UNAVAILABLE ? ARES_RESULT_PERMERROR :
297 ves == PDKIM_VERIFY_INVALID_BUFFER_SIZE ? ARES_RESULT_PERMERROR :
298 ves == PDKIM_VERIFY_INVALID_PUBKEY_PARSING ? ARES_RESULT_PERMERROR :
299 ARES_RESULT_UNKNOWN :
300 ARES_RESULT_UNKNOWN;
301 dkim_history_buffer = string_sprintf("%sdkim %s %d\n", dkim_history_buffer,
302 sig->domain, dkim_ares_result);
303 sig = sig->next;
4840604e 304 }
c007c974
JH
305 libdm_status = opendmarc_policy_query_dmarc(dmarc_pctx, US"");
306 switch (libdm_status)
4840604e 307 {
c007c974
JH
308 case DMARC_DNS_ERROR_NXDOMAIN:
309 case DMARC_DNS_ERROR_NO_RECORD:
310 DEBUG(D_receive)
311 debug_printf("DMARC no record found for %s\n", header_from_sender);
312 has_dmarc_record = FALSE;
313 break;
314 case DMARC_PARSE_OKAY:
315 DEBUG(D_receive)
316 debug_printf("DMARC record found for %s\n", header_from_sender);
317 break;
318 case DMARC_PARSE_ERROR_BAD_VALUE:
319 DEBUG(D_receive)
320 debug_printf("DMARC record parse error for %s\n", header_from_sender);
321 has_dmarc_record = FALSE;
322 break;
323 default:
324 /* everything else, skip dmarc */
325 DEBUG(D_receive)
326 debug_printf("DMARC skipping (%d), unsure what to do with %s",
327 libdm_status, from_header->text);
328 has_dmarc_record = FALSE;
329 break;
4840604e 330 }
8c8b8274 331
c007c974
JH
332/* Store the policy string in an expandable variable. */
333
334 libdm_status = opendmarc_policy_fetch_p(dmarc_pctx, &tmp_ans);
335 for (c = 0; dmarc_policy_description[c].name; c++)
336 if (tmp_ans == dmarc_policy_description[c].value)
337 {
338 dmarc_domain_policy = string_sprintf("%s",dmarc_policy_description[c].name);
339 break;
8c8b8274 340 }
8c8b8274 341
c007c974
JH
342 /* Can't use exim's string manipulation functions so allocate memory
343 * for libopendmarc using its max hostname length definition. */
4840604e 344
c007c974
JH
345 uschar *dmarc_domain = (uschar *)calloc(DMARC_MAXHOSTNAMELEN, sizeof(uschar));
346 libdm_status = opendmarc_policy_fetch_utilized_domain(dmarc_pctx,
347 dmarc_domain, DMARC_MAXHOSTNAMELEN-1);
348 dmarc_used_domain = string_copy(dmarc_domain);
349 free(dmarc_domain);
350
351 if (libdm_status != DMARC_PARSE_OKAY)
352 log_write(0, LOG_MAIN|LOG_PANIC,
353 "failure to read domainname used for DMARC lookup: %s",
354 opendmarc_policy_status_to_str(libdm_status));
355
356 libdm_status = opendmarc_get_policy_to_enforce(dmarc_pctx);
357 dmarc_policy = libdm_status;
358 switch(libdm_status)
4840604e 359 {
c007c974
JH
360 case DMARC_POLICY_ABSENT: /* No DMARC record found */
361 dmarc_status = US"norecord";
362 dmarc_pass_fail = US"none";
363 dmarc_status_text = US"No DMARC record";
364 action = DMARC_RESULT_ACCEPT;
365 break;
366 case DMARC_FROM_DOMAIN_ABSENT: /* No From: domain */
367 dmarc_status = US"nofrom";
368 dmarc_pass_fail = US"temperror";
369 dmarc_status_text = US"No From: domain found";
370 action = DMARC_RESULT_ACCEPT;
371 break;
372 case DMARC_POLICY_NONE: /* Accept and report */
373 dmarc_status = US"none";
374 dmarc_pass_fail = US"none";
375 dmarc_status_text = US"None, Accept";
376 action = DMARC_RESULT_ACCEPT;
377 break;
378 case DMARC_POLICY_PASS: /* Explicit accept */
379 dmarc_status = US"accept";
380 dmarc_pass_fail = US"pass";
381 dmarc_status_text = US"Accept";
382 action = DMARC_RESULT_ACCEPT;
383 break;
384 case DMARC_POLICY_REJECT: /* Explicit reject */
385 dmarc_status = US"reject";
386 dmarc_pass_fail = US"fail";
387 dmarc_status_text = US"Reject";
388 action = DMARC_RESULT_REJECT;
389 break;
390 case DMARC_POLICY_QUARANTINE: /* Explicit quarantine */
391 dmarc_status = US"quarantine";
392 dmarc_pass_fail = US"fail";
393 dmarc_status_text = US"Quarantine";
394 action = DMARC_RESULT_QUARANTINE;
395 break;
396 default:
397 dmarc_status = US"temperror";
398 dmarc_pass_fail = US"temperror";
399 dmarc_status_text = US"Internal Policy Error";
400 action = DMARC_RESULT_TEMPFAIL;
401 break;
4840604e
TL
402 }
403
c007c974
JH
404 libdm_status = opendmarc_policy_fetch_alignment(dmarc_pctx, &da, &sa);
405 if (libdm_status != DMARC_PARSE_OKAY)
406 log_write(0, LOG_MAIN|LOG_PANIC, "failure to read DMARC alignment: %s",
407 opendmarc_policy_status_to_str(libdm_status));
408
409 if (has_dmarc_record == TRUE)
4840604e 410 {
c007c974
JH
411 log_write(0, LOG_MAIN, "DMARC results: spf_domain=%s dmarc_domain=%s "
412 "spf_align=%s dkim_align=%s enforcement='%s'",
413 spf_sender_domain, dmarc_used_domain,
414 (sa==DMARC_POLICY_SPF_ALIGNMENT_PASS) ?"yes":"no",
415 (da==DMARC_POLICY_DKIM_ALIGNMENT_PASS)?"yes":"no",
416 dmarc_status_text);
417 history_file_status = dmarc_write_history_file();
418 /* Now get the forensic reporting addresses, if any */
419 ruf = opendmarc_policy_fetch_ruf(dmarc_pctx, NULL, 0, 1);
420 dmarc_send_forensic_report(ruf);
4840604e
TL
421 }
422 }
423
c007c974
JH
424/* set some global variables here */
425dmarc_ar_header = dmarc_auth_results_header(from_header, NULL);
4840604e 426
c007c974
JH
427/* shut down libopendmarc */
428if ( dmarc_pctx != NULL )
429 (void) opendmarc_policy_connect_shutdown(dmarc_pctx);
430if ( dmarc_disable_verify == FALSE )
431 (void) opendmarc_policy_library_shutdown(&dmarc_ctx);
4840604e 432
c007c974 433return OK;
4840604e
TL
434}
435
c007c974
JH
436int
437dmarc_write_history_file()
4840604e 438{
c007c974
JH
439int history_file_fd;
440ssize_t written_len;
441int tmp_ans;
442u_char **rua; /* aggregate report addressees */
443uschar *history_buffer = NULL;
4840604e 444
c007c974
JH
445if (!dmarc_history_file)
446 return DMARC_HIST_DISABLED;
447history_file_fd = log_create(dmarc_history_file);
4840604e 448
c007c974
JH
449if (history_file_fd < 0)
450{
451 log_write(0, LOG_MAIN|LOG_PANIC, "failure to create DMARC history file: %s",
452 dmarc_history_file);
453 return DMARC_HIST_FILE_ERR;
454}
4840604e 455
c007c974
JH
456/* Generate the contents of the history file */
457history_buffer = string_sprintf(
458 "job %s\nreporter %s\nreceived %ld\nipaddr %s\nfrom %s\nmfrom %s\n",
459 message_id, primary_hostname, time(NULL), sender_host_address,
460 header_from_sender, expand_string(US"$sender_address_domain"));
4840604e 461
c007c974
JH
462if (spf_response)
463 history_buffer = string_sprintf("%sspf %d\n", history_buffer, dmarc_spf_ares_result);
464 /* history_buffer = string_sprintf("%sspf -1\n", history_buffer); */
4840604e 465
c007c974
JH
466history_buffer = string_sprintf(
467 "%s%spdomain %s\npolicy %d\n",
468 history_buffer, dkim_history_buffer, dmarc_used_domain, dmarc_policy);
4840604e 469
c007c974
JH
470if ((rua = opendmarc_policy_fetch_rua(dmarc_pctx, NULL, 0, 1)))
471 for (tmp_ans = 0; rua[tmp_ans]; tmp_ans++)
472 history_buffer = string_sprintf("%srua %s\n", history_buffer, rua[tmp_ans]);
473else
474 history_buffer = string_sprintf("%srua -\n", history_buffer);
4840604e 475
c007c974
JH
476opendmarc_policy_fetch_pct(dmarc_pctx, &tmp_ans);
477history_buffer = string_sprintf("%spct %d\n", history_buffer, tmp_ans);
4840604e 478
c007c974
JH
479opendmarc_policy_fetch_adkim(dmarc_pctx, &tmp_ans);
480history_buffer = string_sprintf("%sadkim %d\n", history_buffer, tmp_ans);
4840604e 481
c007c974
JH
482opendmarc_policy_fetch_aspf(dmarc_pctx, &tmp_ans);
483history_buffer = string_sprintf("%saspf %d\n", history_buffer, tmp_ans);
4840604e 484
c007c974
JH
485opendmarc_policy_fetch_p(dmarc_pctx, &tmp_ans);
486history_buffer = string_sprintf("%sp %d\n", history_buffer, tmp_ans);
487
488opendmarc_policy_fetch_sp(dmarc_pctx, &tmp_ans);
489history_buffer = string_sprintf("%ssp %d\n", history_buffer, tmp_ans);
490
491history_buffer = string_sprintf(
492 "%salign_dkim %d\nalign_spf %d\naction %d\n",
493 history_buffer, da, sa, action);
494
495/* Write the contents to the history file */
496DEBUG(D_receive)
497 debug_printf("DMARC logging history data for opendmarc reporting%s\n",
498 (host_checking || running_in_test_harness) ? " (not really)" : "");
499if (host_checking || running_in_test_harness)
4840604e 500 {
c007c974
JH
501 DEBUG(D_receive)
502 debug_printf("DMARC history data for debugging:\n%s", history_buffer);
4840604e 503 }
c007c974 504else
4840604e 505 {
c007c974
JH
506 written_len = write_to_fd_buf(history_file_fd,
507 history_buffer,
508 Ustrlen(history_buffer));
509 if (written_len == 0)
4840604e 510 {
c007c974
JH
511 log_write(0, LOG_MAIN|LOG_PANIC, "failure to write to DMARC history file: %s",
512 dmarc_history_file);
513 return DMARC_HIST_WRITE_ERR;
4840604e 514 }
c007c974 515 (void)close(history_file_fd);
4840604e 516 }
c007c974 517return DMARC_HIST_OK;
4840604e
TL
518}
519
c007c974
JH
520void
521dmarc_send_forensic_report(u_char **ruf)
4840604e 522{
c007c974
JH
523int c;
524uschar *recipient, *save_sender;
525BOOL send_status = FALSE;
526error_block *eblock = NULL;
527FILE *message_file = NULL;
528
529/* Earlier ACL does not have *required* control=dmarc_enable_forensic */
530if (!dmarc_enable_forensic)
531 return;
532
533if ((dmarc_policy == DMARC_POLICY_REJECT && action == DMARC_RESULT_REJECT) ||
534 (dmarc_policy == DMARC_POLICY_QUARANTINE && action == DMARC_RESULT_QUARANTINE) )
535 if (ruf)
4840604e 536 {
c007c974
JH
537 eblock = add_to_eblock(eblock, US"Sender Domain", dmarc_used_domain);
538 eblock = add_to_eblock(eblock, US"Sender IP Address", sender_host_address);
539 eblock = add_to_eblock(eblock, US"Received Date", tod_stamp(tod_full));
540 eblock = add_to_eblock(eblock, US"SPF Alignment",
541 (sa==DMARC_POLICY_SPF_ALIGNMENT_PASS) ?US"yes":US"no");
542 eblock = add_to_eblock(eblock, US"DKIM Alignment",
543 (da==DMARC_POLICY_DKIM_ALIGNMENT_PASS)?US"yes":US"no");
544 eblock = add_to_eblock(eblock, US"DMARC Results", dmarc_status_text);
545 /* Set a sane default envelope sender */
546 dsn_from = dmarc_forensic_sender ? dmarc_forensic_sender :
547 dsn_from ? dsn_from :
548 string_sprintf("do-not-reply@%s",primary_hostname);
549 for (c = 0; ruf[c]; c++)
4840604e 550 {
c007c974
JH
551 recipient = string_copylc(ruf[c]);
552 if (Ustrncmp(recipient, "mailto:",7))
553 continue;
554 /* Move to first character past the colon */
555 recipient += 7;
556 DEBUG(D_receive)
557 debug_printf("DMARC forensic report to %s%s\n", recipient,
558 (host_checking || running_in_test_harness) ? " (not really)" : "");
559 if (host_checking || running_in_test_harness)
560 continue;
561
562 save_sender = sender_address;
563 sender_address = recipient;
564 send_status = moan_to_sender(ERRMESS_DMARC_FORENSIC, eblock,
565 header_list, message_file, FALSE);
566 sender_address = save_sender;
567 if (!send_status)
568 log_write(0, LOG_MAIN|LOG_PANIC,
569 "failure to send DMARC forensic report to %s", recipient);
4840604e
TL
570 }
571 }
4840604e
TL
572}
573
c007c974
JH
574uschar *
575dmarc_exim_expand_query(int what)
4840604e 576{
c007c974
JH
577if (dmarc_disable_verify || !dmarc_pctx)
578 return dmarc_exim_expand_defaults(what);
4840604e 579
c007c974
JH
580switch(what)
581 {
582 case DMARC_VERIFY_STATUS:
583 return(dmarc_status);
584 default:
585 return US"";
4840604e
TL
586 }
587}
588
c007c974
JH
589uschar *
590dmarc_exim_expand_defaults(int what)
4840604e 591{
c007c974
JH
592switch(what)
593 {
594 case DMARC_VERIFY_STATUS:
595 return dmarc_disable_verify ? US"off" : US"none";
596 default:
597 return US"";
4840604e
TL
598 }
599}
600
c007c974
JH
601uschar *
602dmarc_auth_results_header(header_line *from_header, uschar *hostname)
4840604e 603{
c007c974 604uschar *hdr_tmp = US"";
4840604e 605
c007c974
JH
606/* Allow a server hostname to be passed to this function, but is
607 * currently unused */
608if (!hostname)
609 hostname = primary_hostname;
610hdr_tmp = string_sprintf("%s %s;", DMARC_AR_HEADER, hostname);
4840604e
TL
611
612#if 0
c007c974
JH
613/* I don't think this belongs here, but left it here commented out
614 * because it was a lot of work to get working right. */
615if (spf_response != NULL) {
616 uschar *dmarc_ar_spf = US"";
617 int sr = 0;
618 sr = spf_response->result;
619 dmarc_ar_spf = (sr == SPF_RESULT_NEUTRAL) ? US"neutral" :
620 (sr == SPF_RESULT_PASS) ? US"pass" :
621 (sr == SPF_RESULT_FAIL) ? US"fail" :
622 (sr == SPF_RESULT_SOFTFAIL) ? US"softfail" :
623 US"none";
624 hdr_tmp = string_sprintf("%s spf=%s (%s) smtp.mail=%s;",
625 hdr_tmp, dmarc_ar_spf_result,
626 spf_response->header_comment,
627 expand_string(US"$sender_address") );
628}
4840604e 629#endif
c007c974
JH
630
631hdr_tmp = string_sprintf("%s dmarc=%s", hdr_tmp, dmarc_pass_fail);
632if (header_from_sender)
633 hdr_tmp = string_sprintf("%s header.from=%s",
634 hdr_tmp, header_from_sender);
635return hdr_tmp;
4840604e
TL
636}
637
c007c974 638# endif /* EXPERIMENTAL_SPF */
4a8ce2d8 639#endif /* EXPERIMENTAL_DMARC */
c007c974
JH
640/* vi: aw ai sw=2
641 */