Docs: document ancillary info for more event types. Bug 2313
[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 }
d7b5f2ab
JH
112if (!dmarc_tld_file)
113 {
114 DEBUG(D_receive) debug_printf("DMARC: no dmarc_tld_file\n");
c007c974 115 dmarc_abort = TRUE;
d7b5f2ab
JH
116 }
117else if (opendmarc_tld_read_file(dmarc_tld_file, NULL, NULL, NULL))
4840604e 118 {
c007c974 119 log_write(0, LOG_MAIN|LOG_PANIC, "DMARC failure to load tld list %s: %d",
d7b5f2ab 120 dmarc_tld_file, 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{
160int c;
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
72a201e2
TM
186 for (c = 0; ruf[c]; c++)
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
4840604e 207/* dmarc_process adds the envelope sender address to the existing
c9cf9ac4
JH
208context (if any), retrieves the result, sets up expansion
209strings and evaluates the condition outcome. */
4840604e 210
c007c974
JH
211int
212dmarc_process()
213{
214int sr, origin; /* used in SPF section */
215int dmarc_spf_result = 0; /* stores spf into dmarc conn ctx */
216int tmp_ans, c;
b4757e36 217pdkim_signature * sig = dkim_signatures;
c007c974
JH
218BOOL has_dmarc_record = TRUE;
219u_char **ruf; /* forensic report addressees, if called for */
220
221/* ACLs have "control=dmarc_disable_verify" */
8768d548 222if (f.dmarc_disable_verify)
c007c974 223 return OK;
4840604e 224
c007c974
JH
225/* Store the header From: sender domain for this part of DMARC.
226 * If there is no from_header struct, then it's likely this message
227 * is locally generated and relying on fixups to add it. Just skip
228 * the entire DMARC system if we can't find a From: header....or if
229 * there was a previous error.
230 */
d7b5f2ab
JH
231if (!from_header)
232 {
233 DEBUG(D_receive) debug_printf("DMARC: no From: header\n");
c007c974 234 dmarc_abort = TRUE;
d7b5f2ab
JH
235 }
236else if (!dmarc_abort)
4840604e 237 {
b4757e36
JH
238 uschar * errormsg;
239 int dummy, domain;
240 uschar * p;
241 uschar saveend;
242
8768d548 243 f.parse_allow_group = TRUE;
b4757e36
JH
244 p = parse_find_address_end(from_header->text, FALSE);
245 saveend = *p; *p = '\0';
246 if ((header_from_sender = parse_extract_address(from_header->text, &errormsg,
247 &dummy, &dummy, &domain, FALSE)))
248 header_from_sender += domain;
249 *p = saveend;
250
251 /* The opendmarc library extracts the domain from the email address, but
252 * only try to store it if it's not empty. Otherwise, skip out of DMARC. */
253 if (!header_from_sender || (strcmp( CCS header_from_sender, "") == 0))
254 dmarc_abort = TRUE;
255 libdm_status = dmarc_abort
256 ? DMARC_PARSE_OKAY
257 : opendmarc_policy_store_from_domain(dmarc_pctx, header_from_sender);
258 if (libdm_status != DMARC_PARSE_OKAY)
4840604e 259 {
c007c974
JH
260 log_write(0, LOG_MAIN|LOG_PANIC,
261 "failure to store header From: in DMARC: %s, header was '%s'",
262 opendmarc_policy_status_to_str(libdm_status), from_header->text);
263 dmarc_abort = TRUE;
4840604e
TL
264 }
265 }
266
c007c974
JH
267/* Skip DMARC if connection is SMTP Auth. Temporarily, admin should
268 * instead do this in the ACLs. */
269if (!dmarc_abort && !sender_host_authenticated)
4840604e 270 {
b4757e36
JH
271 uschar * dmarc_domain;
272
c007c974
JH
273 /* Use the envelope sender domain for this part of DMARC */
274 spf_sender_domain = expand_string(US"$sender_address_domain");
275 if (!spf_response)
4840604e 276 {
c007c974
JH
277 /* No spf data means null envelope sender so generate a domain name
278 * from the sender_helo_name */
279 if (!spf_sender_domain)
4840604e 280 {
c007c974
JH
281 spf_sender_domain = sender_helo_name;
282 log_write(0, LOG_MAIN, "DMARC using synthesized SPF sender domain = %s\n",
283 spf_sender_domain);
284 DEBUG(D_receive)
285 debug_printf("DMARC using synthesized SPF sender domain = %s\n",
286 spf_sender_domain);
4840604e 287 }
c007c974
JH
288 dmarc_spf_result = DMARC_POLICY_SPF_OUTCOME_NONE;
289 dmarc_spf_ares_result = ARES_RESULT_UNKNOWN;
290 origin = DMARC_POLICY_SPF_ORIGIN_HELO;
291 spf_human_readable = US"";
4840604e 292 }
c007c974 293 else
4840604e 294 {
c007c974
JH
295 sr = spf_response->result;
296 dmarc_spf_result = sr == SPF_RESULT_NEUTRAL ? DMARC_POLICY_SPF_OUTCOME_NONE :
297 sr == SPF_RESULT_PASS ? DMARC_POLICY_SPF_OUTCOME_PASS :
298 sr == SPF_RESULT_FAIL ? DMARC_POLICY_SPF_OUTCOME_FAIL :
299 sr == SPF_RESULT_SOFTFAIL ? DMARC_POLICY_SPF_OUTCOME_TMPFAIL :
300 DMARC_POLICY_SPF_OUTCOME_NONE;
301 dmarc_spf_ares_result = sr == SPF_RESULT_NEUTRAL ? ARES_RESULT_NEUTRAL :
302 sr == SPF_RESULT_PASS ? ARES_RESULT_PASS :
303 sr == SPF_RESULT_FAIL ? ARES_RESULT_FAIL :
304 sr == SPF_RESULT_SOFTFAIL ? ARES_RESULT_SOFTFAIL :
305 sr == SPF_RESULT_NONE ? ARES_RESULT_NONE :
306 sr == SPF_RESULT_TEMPERROR ? ARES_RESULT_TEMPERROR :
307 sr == SPF_RESULT_PERMERROR ? ARES_RESULT_PERMERROR :
308 ARES_RESULT_UNKNOWN;
309 origin = DMARC_POLICY_SPF_ORIGIN_MAILFROM;
5903c6ff 310 spf_human_readable = US spf_response->header_comment;
c007c974
JH
311 DEBUG(D_receive)
312 debug_printf("DMARC using SPF sender domain = %s\n", spf_sender_domain);
4840604e 313 }
c007c974
JH
314 if (strcmp( CCS spf_sender_domain, "") == 0)
315 dmarc_abort = TRUE;
316 if (!dmarc_abort)
4840604e 317 {
c007c974
JH
318 libdm_status = opendmarc_policy_store_spf(dmarc_pctx, spf_sender_domain,
319 dmarc_spf_result, origin, spf_human_readable);
320 if (libdm_status != DMARC_PARSE_OKAY)
321 log_write(0, LOG_MAIN|LOG_PANIC, "failure to store spf for DMARC: %s",
322 opendmarc_policy_status_to_str(libdm_status));
4840604e 323 }
4840604e 324
c007c974
JH
325 /* Now we cycle through the dkim signature results and put into
326 * the opendmarc context, further building the DMARC reply. */
c007c974
JH
327 dkim_history_buffer = US"";
328 while (sig)
4840604e 329 {
c007c974 330 int dkim_result, dkim_ares_result, vs, ves;
b4757e36 331
6678c382 332 vs = sig->verify_status & ~PDKIM_VERIFY_POLICY;
c007c974
JH
333 ves = sig->verify_ext_status;
334 dkim_result = vs == PDKIM_VERIFY_PASS ? DMARC_POLICY_DKIM_OUTCOME_PASS :
335 vs == PDKIM_VERIFY_FAIL ? DMARC_POLICY_DKIM_OUTCOME_FAIL :
336 vs == PDKIM_VERIFY_INVALID ? DMARC_POLICY_DKIM_OUTCOME_TMPFAIL :
337 DMARC_POLICY_DKIM_OUTCOME_NONE;
5903c6ff 338 libdm_status = opendmarc_policy_store_dkim(dmarc_pctx, US sig->domain,
c007c974
JH
339 dkim_result, US"");
340 DEBUG(D_receive)
341 debug_printf("DMARC adding DKIM sender domain = %s\n", sig->domain);
342 if (libdm_status != DMARC_PARSE_OKAY)
343 log_write(0, LOG_MAIN|LOG_PANIC,
344 "failure to store dkim (%s) for DMARC: %s",
345 sig->domain, opendmarc_policy_status_to_str(libdm_status));
346
347 dkim_ares_result =
348 vs == PDKIM_VERIFY_PASS ? ARES_RESULT_PASS :
349 vs == PDKIM_VERIFY_FAIL ? ARES_RESULT_FAIL :
350 vs == PDKIM_VERIFY_NONE ? ARES_RESULT_NONE :
351 vs == PDKIM_VERIFY_INVALID ?
352 ves == PDKIM_VERIFY_INVALID_PUBKEY_UNAVAILABLE ? ARES_RESULT_PERMERROR :
353 ves == PDKIM_VERIFY_INVALID_BUFFER_SIZE ? ARES_RESULT_PERMERROR :
78f72498
JH
354 ves == PDKIM_VERIFY_INVALID_PUBKEY_DNSRECORD ? ARES_RESULT_PERMERROR :
355 ves == PDKIM_VERIFY_INVALID_PUBKEY_IMPORT ? ARES_RESULT_PERMERROR :
c007c974
JH
356 ARES_RESULT_UNKNOWN :
357 ARES_RESULT_UNKNOWN;
358 dkim_history_buffer = string_sprintf("%sdkim %s %d\n", dkim_history_buffer,
359 sig->domain, dkim_ares_result);
360 sig = sig->next;
4840604e 361 }
c007c974
JH
362 libdm_status = opendmarc_policy_query_dmarc(dmarc_pctx, US"");
363 switch (libdm_status)
4840604e 364 {
c007c974
JH
365 case DMARC_DNS_ERROR_NXDOMAIN:
366 case DMARC_DNS_ERROR_NO_RECORD:
367 DEBUG(D_receive)
368 debug_printf("DMARC no record found for %s\n", header_from_sender);
369 has_dmarc_record = FALSE;
370 break;
371 case DMARC_PARSE_OKAY:
372 DEBUG(D_receive)
373 debug_printf("DMARC record found for %s\n", header_from_sender);
374 break;
375 case DMARC_PARSE_ERROR_BAD_VALUE:
376 DEBUG(D_receive)
377 debug_printf("DMARC record parse error for %s\n", header_from_sender);
378 has_dmarc_record = FALSE;
379 break;
380 default:
381 /* everything else, skip dmarc */
382 DEBUG(D_receive)
383 debug_printf("DMARC skipping (%d), unsure what to do with %s",
384 libdm_status, from_header->text);
385 has_dmarc_record = FALSE;
386 break;
4840604e 387 }
8c8b8274 388
c007c974
JH
389/* Store the policy string in an expandable variable. */
390
391 libdm_status = opendmarc_policy_fetch_p(dmarc_pctx, &tmp_ans);
392 for (c = 0; dmarc_policy_description[c].name; c++)
393 if (tmp_ans == dmarc_policy_description[c].value)
394 {
395 dmarc_domain_policy = string_sprintf("%s",dmarc_policy_description[c].name);
396 break;
8c8b8274 397 }
8c8b8274 398
c007c974 399 /* Can't use exim's string manipulation functions so allocate memory
b4757e36 400 for libopendmarc using its max hostname length definition. */
4840604e 401
b4757e36 402 dmarc_domain = US calloc(DMARC_MAXHOSTNAMELEN, sizeof(uschar));
c007c974
JH
403 libdm_status = opendmarc_policy_fetch_utilized_domain(dmarc_pctx,
404 dmarc_domain, DMARC_MAXHOSTNAMELEN-1);
405 dmarc_used_domain = string_copy(dmarc_domain);
406 free(dmarc_domain);
407
408 if (libdm_status != DMARC_PARSE_OKAY)
409 log_write(0, LOG_MAIN|LOG_PANIC,
410 "failure to read domainname used for DMARC lookup: %s",
411 opendmarc_policy_status_to_str(libdm_status));
412
b4757e36 413 dmarc_policy = libdm_status = opendmarc_get_policy_to_enforce(dmarc_pctx);
c007c974 414 switch(libdm_status)
4840604e 415 {
c007c974
JH
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;
421 break;
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;
427 break;
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;
433 break;
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;
439 break;
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;
445 break;
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;
451 break;
452 default:
453 dmarc_status = US"temperror";
454 dmarc_pass_fail = US"temperror";
455 dmarc_status_text = US"Internal Policy Error";
456 action = DMARC_RESULT_TEMPFAIL;
457 break;
4840604e
TL
458 }
459
c007c974
JH
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));
464
c9cf9ac4 465 if (has_dmarc_record)
4840604e 466 {
c007c974
JH
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,
d341f2a2
JH
470 sa==DMARC_POLICY_SPF_ALIGNMENT_PASS ?"yes":"no",
471 da==DMARC_POLICY_DKIM_ALIGNMENT_PASS ?"yes":"no",
c007c974
JH
472 dmarc_status_text);
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);
4840604e
TL
477 }
478 }
479
c007c974 480/* shut down libopendmarc */
c9cf9ac4 481if (dmarc_pctx)
c007c974 482 (void) opendmarc_policy_connect_shutdown(dmarc_pctx);
8768d548 483if (!f.dmarc_disable_verify)
c007c974 484 (void) opendmarc_policy_library_shutdown(&dmarc_ctx);
4840604e 485
c007c974 486return OK;
4840604e
TL
487}
488
d341f2a2 489static int
c007c974 490dmarc_write_history_file()
4840604e 491{
c007c974
JH
492int history_file_fd;
493ssize_t written_len;
494int tmp_ans;
495u_char **rua; /* aggregate report addressees */
496uschar *history_buffer = NULL;
4840604e 497
c007c974 498if (!dmarc_history_file)
d341f2a2
JH
499 {
500 DEBUG(D_receive) debug_printf("DMARC history file not set\n");
c007c974 501 return DMARC_HIST_DISABLED;
d341f2a2 502 }
c007c974 503history_file_fd = log_create(dmarc_history_file);
4840604e 504
c007c974 505if (history_file_fd < 0)
5bfe3b35 506 {
c007c974
JH
507 log_write(0, LOG_MAIN|LOG_PANIC, "failure to create DMARC history file: %s",
508 dmarc_history_file);
509 return DMARC_HIST_FILE_ERR;
5bfe3b35 510 }
4840604e 511
c007c974
JH
512/* Generate the contents of the history file */
513history_buffer = string_sprintf(
514 "job %s\nreporter %s\nreceived %ld\nipaddr %s\nfrom %s\nmfrom %s\n",
515 message_id, primary_hostname, time(NULL), sender_host_address,
516 header_from_sender, expand_string(US"$sender_address_domain"));
4840604e 517
c007c974
JH
518if (spf_response)
519 history_buffer = string_sprintf("%sspf %d\n", history_buffer, dmarc_spf_ares_result);
520 /* history_buffer = string_sprintf("%sspf -1\n", history_buffer); */
4840604e 521
c007c974
JH
522history_buffer = string_sprintf(
523 "%s%spdomain %s\npolicy %d\n",
524 history_buffer, dkim_history_buffer, dmarc_used_domain, dmarc_policy);
4840604e 525
c007c974
JH
526if ((rua = opendmarc_policy_fetch_rua(dmarc_pctx, NULL, 0, 1)))
527 for (tmp_ans = 0; rua[tmp_ans]; tmp_ans++)
528 history_buffer = string_sprintf("%srua %s\n", history_buffer, rua[tmp_ans]);
529else
530 history_buffer = string_sprintf("%srua -\n", history_buffer);
4840604e 531
c007c974
JH
532opendmarc_policy_fetch_pct(dmarc_pctx, &tmp_ans);
533history_buffer = string_sprintf("%spct %d\n", history_buffer, tmp_ans);
4840604e 534
c007c974
JH
535opendmarc_policy_fetch_adkim(dmarc_pctx, &tmp_ans);
536history_buffer = string_sprintf("%sadkim %d\n", history_buffer, tmp_ans);
4840604e 537
c007c974
JH
538opendmarc_policy_fetch_aspf(dmarc_pctx, &tmp_ans);
539history_buffer = string_sprintf("%saspf %d\n", history_buffer, tmp_ans);
4840604e 540
c007c974
JH
541opendmarc_policy_fetch_p(dmarc_pctx, &tmp_ans);
542history_buffer = string_sprintf("%sp %d\n", history_buffer, tmp_ans);
543
544opendmarc_policy_fetch_sp(dmarc_pctx, &tmp_ans);
545history_buffer = string_sprintf("%ssp %d\n", history_buffer, tmp_ans);
546
547history_buffer = string_sprintf(
548 "%salign_dkim %d\nalign_spf %d\naction %d\n",
549 history_buffer, da, sa, action);
550
551/* Write the contents to the history file */
552DEBUG(D_receive)
553 debug_printf("DMARC logging history data for opendmarc reporting%s\n",
8768d548
JH
554 (host_checking || f.running_in_test_harness) ? " (not really)" : "");
555if (host_checking || f.running_in_test_harness)
4840604e 556 {
c007c974
JH
557 DEBUG(D_receive)
558 debug_printf("DMARC history data for debugging:\n%s", history_buffer);
4840604e 559 }
c007c974 560else
4840604e 561 {
c007c974
JH
562 written_len = write_to_fd_buf(history_file_fd,
563 history_buffer,
564 Ustrlen(history_buffer));
565 if (written_len == 0)
4840604e 566 {
c007c974
JH
567 log_write(0, LOG_MAIN|LOG_PANIC, "failure to write to DMARC history file: %s",
568 dmarc_history_file);
569 return DMARC_HIST_WRITE_ERR;
4840604e 570 }
c007c974 571 (void)close(history_file_fd);
4840604e 572 }
c007c974 573return DMARC_HIST_OK;
4840604e
TL
574}
575
5bfe3b35 576
c007c974
JH
577uschar *
578dmarc_exim_expand_query(int what)
4840604e 579{
8768d548 580if (f.dmarc_disable_verify || !dmarc_pctx)
c007c974 581 return dmarc_exim_expand_defaults(what);
4840604e 582
5bfe3b35
JH
583if (what == DMARC_VERIFY_STATUS)
584 return dmarc_status;
585return US"";
4840604e
TL
586}
587
c007c974
JH
588uschar *
589dmarc_exim_expand_defaults(int what)
4840604e 590{
5bfe3b35 591if (what == DMARC_VERIFY_STATUS)
8768d548 592 return f.dmarc_disable_verify ? US"off" : US"none";
5bfe3b35 593return US"";
4840604e
TL
594}
595
c007c974 596
c9cf9ac4
JH
597gstring *
598authres_dmarc(gstring * g)
599{
8768d548 600if (f.dmarc_has_been_checked)
d7b5f2ab
JH
601 {
602 g = string_append(g, 2, US";\n\tdmarc=", dmarc_pass_fail);
603 if (header_from_sender)
87e9d061 604 g = string_append(g, 2, US" header.from=", header_from_sender);
d7b5f2ab 605 }
c9cf9ac4 606return g;
4840604e
TL
607}
608
7952eef9 609# endif /* SUPPORT_SPF */
4a8ce2d8 610#endif /* EXPERIMENTAL_DMARC */
c007c974
JH
611/* vi: aw ai sw=2
612 */