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