src/src/dkim.c

   1 /* $Cambridge: exim/src/src/dkim.c,v 1.1.2.8 2009/05/19 08:24:47 tom Exp $ */
   2
   3 /*************************************************
   4 *     Exim - an Internet mail transport agent    *
   5 *************************************************/
   6
   7 /* Copyright (c) University of Cambridge 2009 */
   8 /* See the file NOTICE for conditions of use and distribution. */
   9
  10 /* Code for DKIM support. Other DKIM relevant code is in
  11    receive.c, transport.c and transports/smtp.c */
  12
  13 #include "exim.h"
  14
  15 #ifndef DISABLE_DKIM
  16
  17 #include "pdkim/pdkim.h"
  18
  19 pdkim_ctx       *dkim_verify_ctx = NULL;
  20 pdkim_signature *dkim_signatures = NULL;
  21
  22 int dkim_exim_query_dns_txt(char *name, char *answer) {
  23   dns_answer dnsa;
  24   dns_scan   dnss;
  25   dns_record *rr;
  26
  27   if (dns_lookup(&dnsa, (uschar *)name, T_TXT, NULL) != DNS_SUCCEED) return 1;
  28
  29   /* Search for TXT record */
  30   for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
  31        rr != NULL;
  32        rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
  33     if (rr->type == T_TXT) break;
  34
  35   /* Copy record content to the answer buffer */
  36   if (rr != NULL) {
  37     int rr_offset = 0;
  38     int answer_offset = 0;
  39     while (rr_offset < rr->size) {
  40       uschar len = (rr->data)[rr_offset++];
  41       snprintf(answer+(answer_offset),
  42                PDKIM_DNS_TXT_MAX_RECLEN-(answer_offset),
  43                "%.*s", (int)len, (char *)((rr->data)+rr_offset));
  44       rr_offset+=len;
  45       answer_offset+=len;
  46     }
  47   }
  48   else return 1;
  49
  50   return PDKIM_OK;
  51 }
  52
  53
  54 int dkim_exim_verify_init(void) {
  55
  56   /* Free previous context if there is one */
  57   if (dkim_verify_ctx) pdkim_free_ctx(dkim_verify_ctx);
  58
  59   /* Create new context */
  60   dkim_verify_ctx = pdkim_init_verify(PDKIM_INPUT_SMTP,
  61                                       &dkim_exim_query_dns_txt
  62                                      );
  63
  64   if (dkim_verify_ctx != NULL) {
  65     dkim_collect_input = 1;
  66     pdkim_set_debug_stream(dkim_verify_ctx,debug_file);
  67     return 1;
  68   }
  69   else {
  70     dkim_collect_input = 0;
  71     return 0;
  72   }
  73 }
  74
  75
  76 int dkim_exim_verify_feed(uschar *data, int len) {
  77   if (pdkim_feed(dkim_verify_ctx,
  78                  (char *)data,
  79                  len) != PDKIM_OK) return 0;
  80   return 1;
  81 }
  82
  83
  84 int dkim_exim_verify_finish(void) {
  85   dkim_signatures = NULL;
  86   dkim_collect_input = 0;
  87   if (pdkim_feed_finish(dkim_verify_ctx,&dkim_signatures) != PDKIM_OK) return 0;
  88
  89   while (dkim_signatures != NULL) {
  90     uschar *dkim_log = string_sprintf("DKIM: v=%u d=%s s=%s c=%s/%s a=%s ",
  91                                       dkim_signatures->version,
  92                                       dkim_signatures->domain,
  93                                       dkim_signatures->selector,
  94                                       (dkim_signatures->canon_headers == PDKIM_CANON_SIMPLE)?"simple":"relaxed",
  95                                       (dkim_signatures->canon_body    == PDKIM_CANON_SIMPLE)?"simple":"relaxed",
  96                                       (dkim_signatures->algo          == PDKIM_ALGO_RSA_SHA256)?"rsa-sha256":"rsa-sha1"
  97
  98
  99                                       (dkim_signatures->identity != NULL)?dkim_signatures->identity:"<void>",
 100                                       (dkim_signatures->created>0)?
 101
 102                                       );
 103
 104     dkim_log = string_cat(dkim_log);
 105
 106
 107
 108     switch(dkim_signatures->verify_status) {
 109       case PDKIM_VERIFY_NONE:
 110         debug_printf("not verified\n");
 111         log_write(0, LOG_MAIN, "DKIM: Signature from domain '%s', selector '%s': "
 112                   "not verified", dkim_signatures->domain, dkim_signatures->selector);
 113       break;
 114       case PDKIM_VERIFY_INVALID:
 115         debug_printf("invalid\n");
 116         log_write(0, LOG_MAIN, "DKIM: Signature from domain '%s', selector '%s': "
 117                   "invalid", dkim_signatures->domain, dkim_signatures->selector);
 118       break;
 119       case PDKIM_VERIFY_FAIL:
 120         debug_printf("verification failed\n");
 121         log_write(0, LOG_MAIN, "DKIM: Signature from domain '%s', selector '%s': "
 122                   "verification failed", dkim_signatures->domain, dkim_signatures->selector);
 123       break;
 124       case PDKIM_VERIFY_PASS:
 125         debug_printf("verification succeeded\n");
 126         log_write(0, LOG_MAIN, "DKIM: Signature from domain '%s', selector '%s': "
 127                   "verification succeeded", dkim_signatures->domain, dkim_signatures->selector);
 128       break;
 129     }
 130     /* Try next signature */
 131     dkim_signatures = dkim_signatures->next;
 132   }
 133
 134   return dkim_signatures?1:0;
 135 }
 136
 137
 138 int dkim_exim_verify_result(uschar *domain, uschar **result, uschar **error) {
 139
 140   if (dkim_verify_ctx) {
 141
 142   }
 143
 144   return OK;
 145 }
 146
 147
 148 uschar *dkim_exim_sign(int dkim_fd,
 149                        uschar *dkim_private_key,
 150                        uschar *dkim_domain,
 151                        uschar *dkim_selector,
 152                        uschar *dkim_canon,
 153                        uschar *dkim_sign_headers) {
 154   pdkim_ctx *ctx = NULL;
 155   uschar *rc = NULL;
 156   pdkim_signature *signature;
 157   int pdkim_canon;
 158   int sread;
 159   char buf[4096];
 160   int save_errno = 0;
 161   int old_pool = store_pool;
 162
 163   dkim_domain = expand_string(dkim_domain);
 164   if (dkim_domain == NULL) {
 165     /* expansion error, do not send message. */
 166     log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand "
 167           "dkim_domain: %s", expand_string_message);
 168     rc = NULL;
 169     goto CLEANUP;
 170   }
 171   /* Set up $dkim_domain expansion variable. */
 172   dkim_signing_domain = dkim_domain;
 173
 174   /* Get selector to use. */
 175   dkim_selector = expand_string(dkim_selector);
 176   if (dkim_selector == NULL) {
 177     log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand "
 178       "dkim_selector: %s", expand_string_message);
 179     rc = NULL;
 180     goto CLEANUP;
 181   }
 182   /* Set up $dkim_selector expansion variable. */
 183   dkim_signing_selector = dkim_selector;
 184
 185   /* Get canonicalization to use */
 186   dkim_canon = expand_string(dkim_canon?dkim_canon:US"relaxed");
 187   if (dkim_canon == NULL) {
 188     /* expansion error, do not send message. */
 189     log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand "
 190           "dkim_canon: %s", expand_string_message);
 191     rc = NULL;
 192     goto CLEANUP;
 193   }
 194   if (Ustrcmp(dkim_canon, "relaxed") == 0)
 195     pdkim_canon = PDKIM_CANON_RELAXED;
 196   else if (Ustrcmp(dkim_canon, "simple") == 0)
 197     pdkim_canon = PDKIM_CANON_RELAXED;
 198   else {
 199     log_write(0, LOG_MAIN, "DKIM: unknown canonicalization method '%s', defaulting to 'relaxed'.\n",dkim_canon);
 200     pdkim_canon = PDKIM_CANON_RELAXED;
 201   }
 202
 203   /* Expand signing headers once */
 204   if (dkim_sign_headers != NULL) {
 205     dkim_sign_headers = expand_string(dkim_sign_headers);
 206     if (dkim_sign_headers == NULL) {
 207       log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand "
 208         "dkim_sign_headers: %s", expand_string_message);
 209       rc = NULL;
 210       goto CLEANUP;
 211     }
 212   }
 213
 214   /* Get private key to use. */
 215   dkim_private_key = expand_string(dkim_private_key);
 216   if (dkim_private_key == NULL) {
 217     log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand "
 218       "dkim_private_key: %s", expand_string_message);
 219     rc = NULL;
 220     goto CLEANUP;
 221   }
 222   if ( (Ustrlen(dkim_private_key) == 0) ||
 223        (Ustrcmp(dkim_private_key,"0") == 0) ||
 224        (Ustrcmp(dkim_private_key,"false") == 0) ) {
 225     /* don't sign, but no error */
 226     rc = US"";
 227     goto CLEANUP;
 228   }
 229
 230   if (dkim_private_key[0] == '/') {
 231     int privkey_fd = 0;
 232     /* Looks like a filename, load the private key. */
 233     memset(big_buffer,0,big_buffer_size);
 234     privkey_fd = open(CS dkim_private_key,O_RDONLY);
 235     (void)read(privkey_fd,big_buffer,16383);
 236     (void)close(privkey_fd);
 237     dkim_private_key = big_buffer;
 238   }
 239
 240   ctx = pdkim_init_sign(PDKIM_INPUT_SMTP,
 241                         (char *)dkim_signing_domain,
 242                         (char *)dkim_signing_selector,
 243                         (char *)dkim_private_key
 244                        );
 245
 246   pdkim_set_debug_stream(ctx,debug_file);
 247
 248   pdkim_set_optional(ctx,
 249                      (char *)dkim_sign_headers,
 250                      NULL,
 251                      pdkim_canon,
 252                      pdkim_canon,
 253                      -1,
 254                      PDKIM_ALGO_RSA_SHA256,
 255                      0,
 256                      0);
 257
 258   while((sread = read(dkim_fd,&buf,4096)) > 0) {
 259     if (pdkim_feed(ctx,buf,sread) != PDKIM_OK) {
 260       rc = NULL;
 261       goto CLEANUP;
 262     }
 263   }
 264   /* Handle failed read above. */
 265   if (sread == -1) {
 266     debug_printf("DKIM: Error reading -K file.\n");
 267     save_errno = errno;
 268     rc = NULL;
 269     goto CLEANUP;
 270   }
 271
 272   if (pdkim_feed_finish(ctx,&signature) != PDKIM_OK)
 273     goto CLEANUP;
 274
 275   rc = store_get(strlen(signature->signature_header)+3);
 276   Ustrcpy(rc,US signature->signature_header);
 277   Ustrcat(rc,US"\r\n");
 278
 279   CLEANUP:
 280   if (ctx != NULL) {
 281     pdkim_free_ctx(ctx);
 282   }
 283   store_pool = old_pool;
 284   errno = save_errno;
 285   return rc;
 286 };
 287
 288 #endif