Track tainted data and refuse to expand it
[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
7952eef9 15# if !defined SUPPORT_SPF
c007c974
JH
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";
4840604e 31header_line *from_header = NULL;
4840604e 32extern SPF_response_t *spf_response;
620df281 33int dmarc_spf_ares_result = 0;
4840604e
TL
34uschar *spf_sender_domain = NULL;
35uschar *spf_human_readable = NULL;
4840604e
TL
36u_char *header_from_sender = NULL;
37int history_file_status = DMARC_HIST_OK;
4840604e
TL
38uschar *dkim_history_buffer= NULL;
39
8c8b8274
TL
40typedef struct dmarc_exim_p {
41 uschar *name;
42 int value;
43} dmarc_exim_p;
44
45static dmarc_exim_p dmarc_policy_description[] = {
f2ed27cf 46 /* name value */
8c8b8274
TL
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{
40c90bca 60error_block *eb = store_malloc(sizeof(error_block));
c007c974
JH
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
5bfe3b35
JH
81int
82dmarc_init()
4a8ce2d8 83{
c007c974
JH
84int *netmask = NULL; /* Ignored */
85int is_ipv6 = 0;
c007c974
JH
86
87/* Set some sane defaults. Also clears previous results when
88 * multiple messages in one connection. */
89dmarc_pctx = NULL;
90dmarc_status = US"none";
91dmarc_abort = FALSE;
92dmarc_pass_fail = US"skipped";
93dmarc_used_domain = US"";
8768d548 94f.dmarc_has_been_checked = FALSE;
c007c974
JH
95header_from_sender = NULL;
96spf_sender_domain = NULL;
97spf_human_readable = NULL;
98
99/* ACLs have "control=dmarc_disable_verify" */
8768d548 100if (f.dmarc_disable_verify == TRUE)
c007c974
JH
101 return OK;
102
103(void) memset(&dmarc_ctx, '\0', sizeof dmarc_ctx);
104dmarc_ctx.nscount = 0;
105libdm_status = opendmarc_policy_library_init(&dmarc_ctx);
106if (libdm_status != DMARC_PARSE_OKAY)
4840604e 107 {
c007c974
JH
108 log_write(0, LOG_MAIN|LOG_PANIC, "DMARC failure to init library: %s",
109 opendmarc_policy_status_to_str(libdm_status));
110 dmarc_abort = TRUE;
4840604e 111 }
590fd9ee 112if (!dmarc_tld_file || !*dmarc_tld_file)
d7b5f2ab
JH
113 {
114 DEBUG(D_receive) debug_printf("DMARC: no dmarc_tld_file\n");
c007c974 115 dmarc_abort = TRUE;
d7b5f2ab 116 }
48224640 117else if (opendmarc_tld_read_file(CS dmarc_tld_file, NULL, NULL, NULL))
4840604e 118 {
590fd9ee
JH
119 log_write(0, LOG_MAIN|LOG_PANIC, "DMARC failure to load tld list '%s': %s",
120 dmarc_tld_file, strerror(errno));
c007c974 121 dmarc_abort = TRUE;
4840604e 122 }
d7b5f2ab
JH
123if (!sender_host_address)
124 {
125 DEBUG(D_receive) debug_printf("DMARC: no sender_host_address\n");
c007c974 126 dmarc_abort = TRUE;
d7b5f2ab 127 }
c007c974
JH
128/* This catches locally originated email and startup errors above. */
129if (!dmarc_abort)
4840604e 130 {
c007c974 131 is_ipv6 = string_is_ip_address(sender_host_address, netmask) == 6;
d7b5f2ab 132 if (!(dmarc_pctx = opendmarc_policy_connect_init(sender_host_address, is_ipv6)))
4840604e 133 {
c007c974
JH
134 log_write(0, LOG_MAIN|LOG_PANIC,
135 "DMARC failure creating policy context: ip=%s", sender_host_address);
136 dmarc_abort = TRUE;
4840604e
TL
137 }
138 }
139
c007c974 140return OK;
4840604e
TL
141}
142
143
144/* dmarc_store_data stores the header data so that subsequent
c9cf9ac4 145dmarc_process can access the data */
4840604e 146
c9cf9ac4
JH
147int
148dmarc_store_data(header_line *hdr)
149{
150/* No debug output because would change every test debug output */
8768d548 151if (!f.dmarc_disable_verify)
c9cf9ac4
JH
152 from_header = hdr;
153return OK;
4840604e
TL
154}
155
156
72a201e2
TM
157static void
158dmarc_send_forensic_report(u_char **ruf)
159{
72a201e2
TM
160uschar *recipient, *save_sender;
161BOOL send_status = FALSE;
162error_block *eblock = NULL;
163FILE *message_file = NULL;
164
165/* Earlier ACL does not have *required* control=dmarc_enable_forensic */
8768d548 166if (!f.dmarc_enable_forensic)
72a201e2
TM
167 return;
168
169if ( dmarc_policy == DMARC_POLICY_REJECT && action == DMARC_RESULT_REJECT
170 || dmarc_policy == DMARC_POLICY_QUARANTINE && action == DMARC_RESULT_QUARANTINE
171 || dmarc_policy == DMARC_POLICY_NONE && action == DMARC_RESULT_REJECT
172 || dmarc_policy == DMARC_POLICY_NONE && action == DMARC_RESULT_QUARANTINE
173 )
174 if (ruf)
175 {
176 eblock = add_to_eblock(eblock, US"Sender Domain", dmarc_used_domain);
177 eblock = add_to_eblock(eblock, US"Sender IP Address", sender_host_address);
178 eblock = add_to_eblock(eblock, US"Received Date", tod_stamp(tod_full));
179 eblock = add_to_eblock(eblock, US"SPF Alignment",
5455f548 180 sa == DMARC_POLICY_SPF_ALIGNMENT_PASS ? US"yes" : US"no");
72a201e2 181 eblock = add_to_eblock(eblock, US"DKIM Alignment",
5455f548 182 da == DMARC_POLICY_DKIM_ALIGNMENT_PASS ? US"yes" : US"no");
72a201e2 183 eblock = add_to_eblock(eblock, US"DMARC Results", dmarc_status_text);
5455f548 184
d7978c0f 185 for (int c = 0; ruf[c]; c++)
72a201e2
TM
186 {
187 recipient = string_copylc(ruf[c]);
188 if (Ustrncmp(recipient, "mailto:",7))
189 continue;
190 /* Move to first character past the colon */
191 recipient += 7;
192 DEBUG(D_receive)
193 debug_printf("DMARC forensic report to %s%s\n", recipient,
8768d548
JH
194 (host_checking || f.running_in_test_harness) ? " (not really)" : "");
195 if (host_checking || f.running_in_test_harness)
72a201e2
TM
196 continue;
197
5455f548
JH
198 if (!moan_send_message(recipient, ERRMESS_DMARC_FORENSIC, eblock,
199 header_list, message_file, NULL))
72a201e2
TM
200 log_write(0, LOG_MAIN|LOG_PANIC,
201 "failure to send DMARC forensic report to %s", recipient);
202 }
203 }
204}
205
4840604e 206/* dmarc_process adds the envelope sender address to the existing
c9cf9ac4
JH
207context (if any), retrieves the result, sets up expansion
208strings and evaluates the condition outcome. */
4840604e 209
c007c974
JH
210int
211dmarc_process()
212{
213int sr, origin; /* used in SPF section */
214int dmarc_spf_result = 0; /* stores spf into dmarc conn ctx */
215int tmp_ans, c;
b4757e36 216pdkim_signature * sig = dkim_signatures;
c007c974
JH
217BOOL has_dmarc_record = TRUE;
218u_char **ruf; /* forensic report addressees, if called for */
219
220/* ACLs have "control=dmarc_disable_verify" */
8768d548 221if (f.dmarc_disable_verify)
c007c974 222 return OK;
4840604e 223
c007c974
JH
224/* Store the header From: sender domain for this part of DMARC.
225 * If there is no from_header struct, then it's likely this message
226 * is locally generated and relying on fixups to add it. Just skip
227 * the entire DMARC system if we can't find a From: header....or if
228 * there was a previous error.
229 */
d7b5f2ab
JH
230if (!from_header)
231 {
232 DEBUG(D_receive) debug_printf("DMARC: no From: header\n");
c007c974 233 dmarc_abort = TRUE;
d7b5f2ab
JH
234 }
235else if (!dmarc_abort)
4840604e 236 {
b4757e36
JH
237 uschar * errormsg;
238 int dummy, domain;
239 uschar * p;
240 uschar saveend;
241
8768d548 242 f.parse_allow_group = TRUE;
b4757e36
JH
243 p = parse_find_address_end(from_header->text, FALSE);
244 saveend = *p; *p = '\0';
245 if ((header_from_sender = parse_extract_address(from_header->text, &errormsg,
246 &dummy, &dummy, &domain, FALSE)))
247 header_from_sender += domain;
248 *p = saveend;
249
250 /* The opendmarc library extracts the domain from the email address, but
251 * only try to store it if it's not empty. Otherwise, skip out of DMARC. */
252 if (!header_from_sender || (strcmp( CCS header_from_sender, "") == 0))
253 dmarc_abort = TRUE;
254 libdm_status = dmarc_abort
255 ? DMARC_PARSE_OKAY
256 : opendmarc_policy_store_from_domain(dmarc_pctx, header_from_sender);
257 if (libdm_status != DMARC_PARSE_OKAY)
4840604e 258 {
c007c974
JH
259 log_write(0, LOG_MAIN|LOG_PANIC,
260 "failure to store header From: in DMARC: %s, header was '%s'",
261 opendmarc_policy_status_to_str(libdm_status), from_header->text);
262 dmarc_abort = TRUE;
4840604e
TL
263 }
264 }
265
c007c974
JH
266/* Skip DMARC if connection is SMTP Auth. Temporarily, admin should
267 * instead do this in the ACLs. */
268if (!dmarc_abort && !sender_host_authenticated)
4840604e 269 {
b4757e36
JH
270 uschar * dmarc_domain;
271
c007c974
JH
272 /* Use the envelope sender domain for this part of DMARC */
273 spf_sender_domain = expand_string(US"$sender_address_domain");
274 if (!spf_response)
4840604e 275 {
c007c974
JH
276 /* No spf data means null envelope sender so generate a domain name
277 * from the sender_helo_name */
278 if (!spf_sender_domain)
4840604e 279 {
c007c974
JH
280 spf_sender_domain = sender_helo_name;
281 log_write(0, LOG_MAIN, "DMARC using synthesized SPF sender domain = %s\n",
282 spf_sender_domain);
283 DEBUG(D_receive)
284 debug_printf("DMARC using synthesized SPF sender domain = %s\n",
285 spf_sender_domain);
4840604e 286 }
c007c974
JH
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"";
4840604e 291 }
c007c974 292 else
4840604e 293 {
c007c974
JH
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 :
307 ARES_RESULT_UNKNOWN;
308 origin = DMARC_POLICY_SPF_ORIGIN_MAILFROM;
5903c6ff 309 spf_human_readable = US spf_response->header_comment;
c007c974
JH
310 DEBUG(D_receive)
311 debug_printf("DMARC using SPF sender domain = %s\n", spf_sender_domain);
4840604e 312 }
c007c974
JH
313 if (strcmp( CCS spf_sender_domain, "") == 0)
314 dmarc_abort = TRUE;
315 if (!dmarc_abort)
4840604e 316 {
c007c974
JH
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));
4840604e 322 }
4840604e 323
c007c974
JH
324 /* Now we cycle through the dkim signature results and put into
325 * the opendmarc context, further building the DMARC reply. */
c007c974
JH
326 dkim_history_buffer = US"";
327 while (sig)
4840604e 328 {
c007c974 329 int dkim_result, dkim_ares_result, vs, ves;
b4757e36 330
6678c382 331 vs = sig->verify_status & ~PDKIM_VERIFY_POLICY;
c007c974
JH
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;
5903c6ff 337 libdm_status = opendmarc_policy_store_dkim(dmarc_pctx, US sig->domain,
c007c974
JH
338 dkim_result, US"");
339 DEBUG(D_receive)
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));
345
346 dkim_ares_result =
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 :
78f72498
JH
353 ves == PDKIM_VERIFY_INVALID_PUBKEY_DNSRECORD ? ARES_RESULT_PERMERROR :
354 ves == PDKIM_VERIFY_INVALID_PUBKEY_IMPORT ? ARES_RESULT_PERMERROR :
c007c974
JH
355 ARES_RESULT_UNKNOWN :
356 ARES_RESULT_UNKNOWN;
357 dkim_history_buffer = string_sprintf("%sdkim %s %d\n", dkim_history_buffer,
358 sig->domain, dkim_ares_result);
359 sig = sig->next;
4840604e 360 }
c007c974
JH
361 libdm_status = opendmarc_policy_query_dmarc(dmarc_pctx, US"");
362 switch (libdm_status)
4840604e 363 {
c007c974
JH
364 case DMARC_DNS_ERROR_NXDOMAIN:
365 case DMARC_DNS_ERROR_NO_RECORD:
366 DEBUG(D_receive)
367 debug_printf("DMARC no record found for %s\n", header_from_sender);
368 has_dmarc_record = FALSE;
369 break;
370 case DMARC_PARSE_OKAY:
371 DEBUG(D_receive)
372 debug_printf("DMARC record found for %s\n", header_from_sender);
373 break;
374 case DMARC_PARSE_ERROR_BAD_VALUE:
375 DEBUG(D_receive)
376 debug_printf("DMARC record parse error for %s\n", header_from_sender);
377 has_dmarc_record = FALSE;
378 break;
379 default:
380 /* everything else, skip dmarc */
381 DEBUG(D_receive)
382 debug_printf("DMARC skipping (%d), unsure what to do with %s",
383 libdm_status, from_header->text);
384 has_dmarc_record = FALSE;
385 break;
4840604e 386 }
8c8b8274 387
c007c974
JH
388/* Store the policy string in an expandable variable. */
389
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)
393 {
394 dmarc_domain_policy = string_sprintf("%s",dmarc_policy_description[c].name);
395 break;
8c8b8274 396 }
8c8b8274 397
c007c974 398 /* Can't use exim's string manipulation functions so allocate memory
b4757e36 399 for libopendmarc using its max hostname length definition. */
4840604e 400
f3ebb786 401 dmarc_domain = store_get(DMARC_MAXHOSTNAMELEN, TRUE);
c007c974
JH
402 libdm_status = opendmarc_policy_fetch_utilized_domain(dmarc_pctx,
403 dmarc_domain, DMARC_MAXHOSTNAMELEN-1);
f3ebb786
JH
404 store_release_above(dmarc_domain + Ustrlen(dmarc_domain)+1);
405 dmarc_used_domain = dmarc_domain;
c007c974
JH
406
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));
411
b4757e36 412 dmarc_policy = libdm_status = opendmarc_get_policy_to_enforce(dmarc_pctx);
c007c974 413 switch(libdm_status)
4840604e 414 {
c007c974
JH
415 case DMARC_POLICY_ABSENT: /* No DMARC record found */
416 dmarc_status = US"norecord";
417 dmarc_pass_fail = US"none";
418 dmarc_status_text = US"No DMARC record";
419 action = DMARC_RESULT_ACCEPT;
420 break;
421 case DMARC_FROM_DOMAIN_ABSENT: /* No From: domain */
422 dmarc_status = US"nofrom";
423 dmarc_pass_fail = US"temperror";
424 dmarc_status_text = US"No From: domain found";
425 action = DMARC_RESULT_ACCEPT;
426 break;
427 case DMARC_POLICY_NONE: /* Accept and report */
428 dmarc_status = US"none";
429 dmarc_pass_fail = US"none";
430 dmarc_status_text = US"None, Accept";
431 action = DMARC_RESULT_ACCEPT;
432 break;
433 case DMARC_POLICY_PASS: /* Explicit accept */
434 dmarc_status = US"accept";
435 dmarc_pass_fail = US"pass";
436 dmarc_status_text = US"Accept";
437 action = DMARC_RESULT_ACCEPT;
438 break;
439 case DMARC_POLICY_REJECT: /* Explicit reject */
440 dmarc_status = US"reject";
441 dmarc_pass_fail = US"fail";
442 dmarc_status_text = US"Reject";
443 action = DMARC_RESULT_REJECT;
444 break;
445 case DMARC_POLICY_QUARANTINE: /* Explicit quarantine */
446 dmarc_status = US"quarantine";
447 dmarc_pass_fail = US"fail";
448 dmarc_status_text = US"Quarantine";
449 action = DMARC_RESULT_QUARANTINE;
450 break;
451 default:
452 dmarc_status = US"temperror";
453 dmarc_pass_fail = US"temperror";
454 dmarc_status_text = US"Internal Policy Error";
455 action = DMARC_RESULT_TEMPFAIL;
456 break;
4840604e
TL
457 }
458
c007c974
JH
459 libdm_status = opendmarc_policy_fetch_alignment(dmarc_pctx, &da, &sa);
460 if (libdm_status != DMARC_PARSE_OKAY)
461 log_write(0, LOG_MAIN|LOG_PANIC, "failure to read DMARC alignment: %s",
462 opendmarc_policy_status_to_str(libdm_status));
463
c9cf9ac4 464 if (has_dmarc_record)
4840604e 465 {
c007c974
JH
466 log_write(0, LOG_MAIN, "DMARC results: spf_domain=%s dmarc_domain=%s "
467 "spf_align=%s dkim_align=%s enforcement='%s'",
468 spf_sender_domain, dmarc_used_domain,
d341f2a2
JH
469 sa==DMARC_POLICY_SPF_ALIGNMENT_PASS ?"yes":"no",
470 da==DMARC_POLICY_DKIM_ALIGNMENT_PASS ?"yes":"no",
c007c974
JH
471 dmarc_status_text);
472 history_file_status = dmarc_write_history_file();
473 /* Now get the forensic reporting addresses, if any */
474 ruf = opendmarc_policy_fetch_ruf(dmarc_pctx, NULL, 0, 1);
475 dmarc_send_forensic_report(ruf);
4840604e
TL
476 }
477 }
478
c007c974 479/* shut down libopendmarc */
c9cf9ac4 480if (dmarc_pctx)
c007c974 481 (void) opendmarc_policy_connect_shutdown(dmarc_pctx);
8768d548 482if (!f.dmarc_disable_verify)
c007c974 483 (void) opendmarc_policy_library_shutdown(&dmarc_ctx);
4840604e 484
c007c974 485return OK;
4840604e
TL
486}
487
d341f2a2 488static int
c007c974 489dmarc_write_history_file()
4840604e 490{
c007c974
JH
491int history_file_fd;
492ssize_t written_len;
493int tmp_ans;
494u_char **rua; /* aggregate report addressees */
495uschar *history_buffer = NULL;
4840604e 496
c007c974 497if (!dmarc_history_file)
d341f2a2
JH
498 {
499 DEBUG(D_receive) debug_printf("DMARC history file not set\n");
c007c974 500 return DMARC_HIST_DISABLED;
d341f2a2 501 }
c007c974 502history_file_fd = log_create(dmarc_history_file);
4840604e 503
c007c974 504if (history_file_fd < 0)
5bfe3b35 505 {
c007c974
JH
506 log_write(0, LOG_MAIN|LOG_PANIC, "failure to create DMARC history file: %s",
507 dmarc_history_file);
508 return DMARC_HIST_FILE_ERR;
5bfe3b35 509 }
4840604e 510
c007c974
JH
511/* Generate the contents of the history file */
512history_buffer = string_sprintf(
513 "job %s\nreporter %s\nreceived %ld\nipaddr %s\nfrom %s\nmfrom %s\n",
514 message_id, primary_hostname, time(NULL), sender_host_address,
515 header_from_sender, expand_string(US"$sender_address_domain"));
4840604e 516
c007c974
JH
517if (spf_response)
518 history_buffer = string_sprintf("%sspf %d\n", history_buffer, dmarc_spf_ares_result);
519 /* history_buffer = string_sprintf("%sspf -1\n", history_buffer); */
4840604e 520
c007c974
JH
521history_buffer = string_sprintf(
522 "%s%spdomain %s\npolicy %d\n",
523 history_buffer, dkim_history_buffer, dmarc_used_domain, dmarc_policy);
4840604e 524
c007c974
JH
525if ((rua = opendmarc_policy_fetch_rua(dmarc_pctx, NULL, 0, 1)))
526 for (tmp_ans = 0; rua[tmp_ans]; tmp_ans++)
527 history_buffer = string_sprintf("%srua %s\n", history_buffer, rua[tmp_ans]);
528else
529 history_buffer = string_sprintf("%srua -\n", history_buffer);
4840604e 530
c007c974
JH
531opendmarc_policy_fetch_pct(dmarc_pctx, &tmp_ans);
532history_buffer = string_sprintf("%spct %d\n", history_buffer, tmp_ans);
4840604e 533
c007c974
JH
534opendmarc_policy_fetch_adkim(dmarc_pctx, &tmp_ans);
535history_buffer = string_sprintf("%sadkim %d\n", history_buffer, tmp_ans);
4840604e 536
c007c974
JH
537opendmarc_policy_fetch_aspf(dmarc_pctx, &tmp_ans);
538history_buffer = string_sprintf("%saspf %d\n", history_buffer, tmp_ans);
4840604e 539
c007c974
JH
540opendmarc_policy_fetch_p(dmarc_pctx, &tmp_ans);
541history_buffer = string_sprintf("%sp %d\n", history_buffer, tmp_ans);
542
543opendmarc_policy_fetch_sp(dmarc_pctx, &tmp_ans);
544history_buffer = string_sprintf("%ssp %d\n", history_buffer, tmp_ans);
545
546history_buffer = string_sprintf(
547 "%salign_dkim %d\nalign_spf %d\naction %d\n",
548 history_buffer, da, sa, action);
549
550/* Write the contents to the history file */
551DEBUG(D_receive)
552 debug_printf("DMARC logging history data for opendmarc reporting%s\n",
8768d548
JH
553 (host_checking || f.running_in_test_harness) ? " (not really)" : "");
554if (host_checking || f.running_in_test_harness)
4840604e 555 {
c007c974
JH
556 DEBUG(D_receive)
557 debug_printf("DMARC history data for debugging:\n%s", history_buffer);
4840604e 558 }
c007c974 559else
4840604e 560 {
c007c974
JH
561 written_len = write_to_fd_buf(history_file_fd,
562 history_buffer,
563 Ustrlen(history_buffer));
564 if (written_len == 0)
4840604e 565 {
c007c974
JH
566 log_write(0, LOG_MAIN|LOG_PANIC, "failure to write to DMARC history file: %s",
567 dmarc_history_file);
568 return DMARC_HIST_WRITE_ERR;
4840604e 569 }
c007c974 570 (void)close(history_file_fd);
4840604e 571 }
c007c974 572return DMARC_HIST_OK;
4840604e
TL
573}
574
5bfe3b35 575
c007c974
JH
576uschar *
577dmarc_exim_expand_query(int what)
4840604e 578{
8768d548 579if (f.dmarc_disable_verify || !dmarc_pctx)
c007c974 580 return dmarc_exim_expand_defaults(what);
4840604e 581
5bfe3b35
JH
582if (what == DMARC_VERIFY_STATUS)
583 return dmarc_status;
584return US"";
4840604e
TL
585}
586
c007c974
JH
587uschar *
588dmarc_exim_expand_defaults(int what)
4840604e 589{
5bfe3b35 590if (what == DMARC_VERIFY_STATUS)
8768d548 591 return f.dmarc_disable_verify ? US"off" : US"none";
5bfe3b35 592return US"";
4840604e
TL
593}
594
c007c974 595
c9cf9ac4
JH
596gstring *
597authres_dmarc(gstring * g)
598{
8768d548 599if (f.dmarc_has_been_checked)
d7b5f2ab
JH
600 {
601 g = string_append(g, 2, US";\n\tdmarc=", dmarc_pass_fail);
602 if (header_from_sender)
87e9d061 603 g = string_append(g, 2, US" header.from=", header_from_sender);
d7b5f2ab 604 }
c9cf9ac4 605return g;
4840604e
TL
606}
607
7952eef9 608# endif /* SUPPORT_SPF */
4a8ce2d8 609#endif /* EXPERIMENTAL_DMARC */
c007c974
JH
610/* vi: aw ai sw=2
611 */