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