src/src/dmarc.c

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