2 * PDKIM - a RFC4871 (DKIM) implementation
4 * Copyright (C) 2016 Exim maintainers
6 * signing/verification interface
11 #ifndef DISABLE_DKIM /* entire file */
14 # error Need SUPPORT_TLS for DKIM
17 #include "crypt_ver.h"
21 /******************************************************************************/
30 /* accumulate data (gnutls-only). String to be appended must be nul-terminated. */
32 exim_dkim_data_append(blob * b, int * alloc, uschar * s)
35 b->data = string_append(b->data, alloc, &len, 1, s);
42 /* import private key from PEM string in memory.
43 Return: NULL for success, or an error string */
46 exim_dkim_signing_init(uschar * privkey_pem, es_ctx * sign_ctx)
52 k.size = strlen(privkey_pem);
54 if ( (rc = gnutls_x509_privkey_init(&sign_ctx->key)) != GNUTLS_E_SUCCESS
55 || (rc = gnutls_x509_privkey_import(sign_ctx->key, &k,
56 GNUTLS_X509_FMT_PEM)) != GNUTLS_E_SUCCESS
58 return gnutls_strerror(rc);
65 /* allocate mem for signature (when signing) */
66 /* sign data (gnutls_only)
70 Return: NULL for success, or an error string */
73 exim_dkim_sign(es_ctx * sign_ctx, hashmethod hash, blob * data, blob * sig)
75 gnutls_digest_algorithm_t dig;
79 const uschar * ret = NULL;
83 case HASH_SHA1: dig = GNUTLS_DIG_SHA1; break;
84 case HASH_SHA2_256: dig = GNUTLS_DIG_SHA256; break;
85 case HASH_SHA2_512: dig = GNUTLS_DIG_SHA512; break;
86 default: return US"nonhandled hash type";
89 /* Allocate mem for signature */
92 (void) gnutls_x509_privkey_sign_data(sign_ctx->key, dig,
93 0, &k, NULL, &sigsize);
95 sig->data = store_get(sigsize);
99 if ((rc = gnutls_x509_privkey_sign_data(sign_ctx->key, dig,
100 0, &k, sig->data, &sigsize)) != GNUTLS_E_SUCCESS
102 ret = gnutls_strerror(rc);
104 gnutls_x509_privkey_deinit(sign_ctx->key);
110 /* import public key (from DER in memory)
111 Return: NULL for success, or an error string */
114 exim_dkim_verify_init(blob * pubkey_der, ev_ctx * verify_ctx)
118 const uschar * ret = NULL;
120 gnutls_pubkey_init(&verify_ctx->key);
122 k.data = pubkey_der->data;
123 k.size = pubkey_der->len;
125 if ((rc = gnutls_pubkey_import(verify_ctx->key, &k, GNUTLS_X509_FMT_DER))
127 ret = gnutls_strerror(rc);
132 /* verify signature (of hash) (given pubkey & alleged sig)
133 Return: NULL for success, or an error string */
136 exim_dkim_verify(ev_ctx * verify_ctx, hashmethod hash, blob * data_hash, blob * sig)
138 gnutls_sign_algorithm_t algo;
141 const uschar * ret = NULL;
143 /*XXX needs extension for non-rsa */
146 case HASH_SHA1: algo = GNUTLS_SIGN_RSA_SHA1; break;
147 case HASH_SHA2_256: algo = GNUTLS_SIGN_RSA_SHA256; break;
148 case HASH_SHA2_512: algo = GNUTLS_SIGN_RSA_SHA512; break;
149 default: return US"nonhandled hash type";
152 k.data = data_hash->data;
153 k.size = data_hash->len;
156 if ((rc = gnutls_pubkey_verify_hash2(verify_ctx->key, algo, 0, &k, &s)) < 0)
157 ret = gnutls_strerror(rc);
159 gnutls_pubkey_deinit(verify_ctx->key);
166 #elif defined(SIGN_GCRYPT)
167 /******************************************************************************/
168 /* This variant is used under pre-3.0.0 GnuTLS. Only rsa-sha1 and rsa-sha256 */
171 /* Internal service routine:
172 Read and move past an asn.1 header, checking class & tag,
173 optionally returning the data-length */
176 as_tag(blob * der, uschar req_cls, long req_tag, long * alen)
183 /* debug_printf_indent("as_tag: %02x %02x %02x %02x\n",
184 der->data[0], der->data[1], der->data[2], der->data[3]); */
186 if ((rc = asn1_get_tag_der(der->data++, der->len--, &tag_class, &taglen, &tag))
190 if (tag_class != req_cls || tag != req_tag) return ASN1_ELEMENT_NOT_FOUND;
192 if ((len = asn1_get_length_der(der->data, der->len, &taglen)) < 0)
193 return ASN1_DER_ERROR;
194 if (alen) *alen = len;
196 /* debug_printf_indent("as_tag: tlen %d dlen %d\n", taglen, (int)len); */
203 /* Internal service routine:
204 Read and move over an asn.1 integer, setting an MPI to the value
208 as_mpi(blob * der, gcry_mpi_t * mpi)
214 /* integer; move past the header */
215 if ((rc = as_tag(der, 0, ASN1_TAG_INTEGER, &alen)) != ASN1_SUCCESS)
216 return US asn1_strerror(rc);
219 if ((gerr = gcry_mpi_scan(mpi, GCRYMPI_FMT_STD, der->data, alen, NULL)))
220 return US gcry_strerror(gerr);
222 /* move over the data */
223 der->data += alen; der->len -= alen;
232 /* Version check should be the very first call because it
233 makes sure that important subsystems are initialized. */
234 if (!gcry_check_version (GCRYPT_VERSION))
236 fputs ("libgcrypt version mismatch\n", stderr);
240 /* We don't want to see any warnings, e.g. because we have not yet
241 parsed program options which might be used to suppress such
243 gcry_control (GCRYCTL_SUSPEND_SECMEM_WARN);
245 /* ... If required, other initialization goes here. Note that the
246 process might still be running with increased privileges and that
247 the secure memory has not been initialized. */
249 /* Allocate a pool of 16k secure memory. This make the secure memory
250 available and also drops privileges where needed. */
251 gcry_control (GCRYCTL_INIT_SECMEM, 16384, 0);
253 /* It is now okay to let Libgcrypt complain when there was/is
254 a problem with the secure memory. */
255 gcry_control (GCRYCTL_RESUME_SECMEM_WARN);
257 /* ... If required, other initialization goes here. */
259 /* Tell Libgcrypt that initialization has completed. */
260 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
268 /* Accumulate data (gnutls-only).
269 String to be appended must be nul-terminated. */
272 exim_dkim_data_append(blob * b, int * alloc, uschar * s)
279 /* import private key from PEM string in memory.
280 Return: NULL for success, or an error string */
283 exim_dkim_signing_init(uschar * privkey_pem, es_ctx * sign_ctx)
290 /*XXX will need extension to _spot_ as well as handle a
291 non-RSA key? I think... */
294 * RSAPrivateKey ::= SEQUENCE
296 * modulus INTEGER, -- n
297 * publicExponent INTEGER, -- e
298 * privateExponent INTEGER, -- d
299 * prime1 INTEGER, -- p
300 * prime2 INTEGER, -- q
301 * exponent1 INTEGER, -- d mod (p-1)
302 * exponent2 INTEGER, -- d mod (q-1)
303 * coefficient INTEGER, -- (inverse of q) mod p
304 * otherPrimeInfos OtherPrimeInfos OPTIONAL
307 if ( !(s1 = Ustrstr(CS privkey_pem, "-----BEGIN RSA PRIVATE KEY-----"))
308 || !(s2 = Ustrstr(CS (s1+=31), "-----END RSA PRIVATE KEY-----" ))
310 return US"Bad PEM wrapper";
314 if ((der.len = b64decode(s1, &der.data)) < 0)
315 return US"Bad PEM-DER b64 decode";
319 /* sequence; just move past the header */
320 if ((rc = as_tag(&der, ASN1_CLASS_STRUCTURED, ASN1_TAG_SEQUENCE, NULL))
321 != ASN1_SUCCESS) goto asn_err;
323 /* integer version; move past the header, check is zero */
324 if ((rc = as_tag(&der, 0, ASN1_TAG_INTEGER, &alen)) != ASN1_SUCCESS)
326 if (alen != 1 || *der.data != 0)
327 return US"Bad version number";
328 der.data++; der.len--;
330 if ( (s1 = as_mpi(&der, &sign_ctx->n))
331 || (s1 = as_mpi(&der, &sign_ctx->e))
332 || (s1 = as_mpi(&der, &sign_ctx->d))
333 || (s1 = as_mpi(&der, &sign_ctx->p))
334 || (s1 = as_mpi(&der, &sign_ctx->q))
335 || (s1 = as_mpi(&der, &sign_ctx->dp))
336 || (s1 = as_mpi(&der, &sign_ctx->dq))
337 || (s1 = as_mpi(&der, &sign_ctx->qp))
342 DEBUG(D_acl) debug_printf_indent("rsa_signing_init:\n");
345 gcry_mpi_aprint (GCRYMPI_FMT_HEX, &s, NULL, sign_ctx->n);
346 debug_printf_indent(" N : %s\n", s);
347 gcry_mpi_aprint (GCRYMPI_FMT_HEX, &s, NULL, sign_ctx->e);
348 debug_printf_indent(" E : %s\n", s);
349 gcry_mpi_aprint (GCRYMPI_FMT_HEX, &s, NULL, sign_ctx->d);
350 debug_printf_indent(" D : %s\n", s);
351 gcry_mpi_aprint (GCRYMPI_FMT_HEX, &s, NULL, sign_ctx->p);
352 debug_printf_indent(" P : %s\n", s);
353 gcry_mpi_aprint (GCRYMPI_FMT_HEX, &s, NULL, sign_ctx->q);
354 debug_printf_indent(" Q : %s\n", s);
355 gcry_mpi_aprint (GCRYMPI_FMT_HEX, &s, NULL, sign_ctx->dp);
356 debug_printf_indent(" DP: %s\n", s);
357 gcry_mpi_aprint (GCRYMPI_FMT_HEX, &s, NULL, sign_ctx->dq);
358 debug_printf_indent(" DQ: %s\n", s);
359 gcry_mpi_aprint (GCRYMPI_FMT_HEX, &s, NULL, sign_ctx->qp);
360 debug_printf_indent(" QP: %s\n", s);
365 asn_err: return US asn1_strerror(rc);
370 /* allocate mem for signature (when signing) */
371 /* sign data (gnutls_only)
375 Return: NULL for success, or an error string */
378 exim_dkim_sign(es_ctx * sign_ctx, hashmethod hash, blob * data, blob * sig)
381 gcry_sexp_t s_hash = NULL, s_key = NULL, s_sig = NULL;
386 /*XXX will need extension for hash types (though, possibly, should
387 be re-specced to not rehash but take an already-hashed value? Actually
388 current impl looks WRONG - it _is_ given a hash so should not be
389 re-hashing. Has this been tested?
391 Will need extension for non-RSA sugning algos. */
395 case HASH_SHA1: sexp_hash = "(data(flags pkcs1)(hash sha1 %b))"; break;
396 case HASH_SHA2_256: sexp_hash = "(data(flags pkcs1)(hash sha256 %b))"; break;
397 default: return US"nonhandled hash type";
401 sig->data = store_get(SIGSPACE);
403 if (gcry_mpi_cmp (sign_ctx->p, sign_ctx->q) > 0)
405 gcry_mpi_swap (sign_ctx->p, sign_ctx->q);
406 gcry_mpi_invm (sign_ctx->qp, sign_ctx->p, sign_ctx->q);
409 if ( (gerr = gcry_sexp_build (&s_key, NULL,
410 "(private-key (rsa (n%m)(e%m)(d%m)(p%m)(q%m)(u%m)))",
411 sign_ctx->n, sign_ctx->e,
412 sign_ctx->d, sign_ctx->p,
413 sign_ctx->q, sign_ctx->qp))
414 || (gerr = gcry_sexp_build (&s_hash, NULL, sexp_hash,
415 (int) data->len, CS data->data))
416 || (gerr = gcry_pk_sign (&s_sig, s_hash, s_key))
418 return US gcry_strerror(gerr);
420 /* gcry_sexp_dump(s_sig); */
422 if ( !(s_sig = gcry_sexp_find_token(s_sig, "s", 0))
424 return US"no sig result";
426 m_sig = gcry_sexp_nth_mpi(s_sig, 1, GCRYMPI_FMT_USG);
432 gcry_mpi_aprint (GCRYMPI_FMT_HEX, &s, NULL, m_sig);
433 debug_printf_indent(" SG: %s\n", s);
437 gerr = gcry_mpi_print(GCRYMPI_FMT_USG, sig->data, SIGSPACE, &sig->len, m_sig);
440 debug_printf_indent("signature conversion from MPI to buffer failed\n");
441 return US gcry_strerror(gerr);
449 /* import public key (from DER in memory)
450 Return: NULL for success, or an error string */
453 exim_dkim_verify_init(blob * pubkey_der, ev_ctx * verify_ctx)
456 in code sequence per b81207d2bfa92 rsa_parse_public_key() and asn1_get_mpi()
464 uschar * stage = US"S1";
471 BIT STRING:RSAPublicKey
473 INTEGER:Public modulus
474 INTEGER:Public exponent
476 openssl rsa -in aux-fixed/dkim/dkim.private -pubout -outform DER | od -t x1 | head;
477 openssl rsa -in aux-fixed/dkim/dkim.private -pubout | openssl asn1parse -dump;
478 openssl rsa -in aux-fixed/dkim/dkim.private -pubout | openssl asn1parse -dump -offset 22;
481 /* sequence; just move past the header */
482 if ((rc = as_tag(pubkey_der, ASN1_CLASS_STRUCTURED, ASN1_TAG_SEQUENCE, NULL))
483 != ASN1_SUCCESS) goto asn_err;
485 /* sequence; skip the entire thing */
486 DEBUG(D_acl) stage = US"S2";
487 if ((rc = as_tag(pubkey_der, ASN1_CLASS_STRUCTURED, ASN1_TAG_SEQUENCE, &alen))
488 != ASN1_SUCCESS) goto asn_err;
489 pubkey_der->data += alen; pubkey_der->len -= alen;
492 /* bitstring: limit range to size of bitstring;
493 move over header + content wrapper */
494 DEBUG(D_acl) stage = US"BS";
495 if ((rc = as_tag(pubkey_der, 0, ASN1_TAG_BIT_STRING, &alen)) != ASN1_SUCCESS)
497 pubkey_der->len = alen;
498 pubkey_der->data++; pubkey_der->len--;
500 /* sequence; just move past the header */
501 DEBUG(D_acl) stage = US"S3";
502 if ((rc = as_tag(pubkey_der, ASN1_CLASS_STRUCTURED, ASN1_TAG_SEQUENCE, NULL))
503 != ASN1_SUCCESS) goto asn_err;
505 /* read two integers */
506 DEBUG(D_acl) stage = US"MPI";
507 if ( (errstr = as_mpi(pubkey_der, &verify_ctx->n))
508 || (errstr = as_mpi(pubkey_der, &verify_ctx->e))
513 DEBUG(D_acl) debug_printf_indent("rsa_verify_init:\n");
516 gcry_mpi_aprint (GCRYMPI_FMT_HEX, &s, NULL, verify_ctx->n);
517 debug_printf_indent(" N : %s\n", s);
518 gcry_mpi_aprint (GCRYMPI_FMT_HEX, &s, NULL, verify_ctx->e);
519 debug_printf_indent(" E : %s\n", s);
526 DEBUG(D_acl) return string_sprintf("%s: %s", stage, asn1_strerror(rc));
527 return US asn1_strerror(rc);
531 /* verify signature (of hash) (given pubkey & alleged sig)
532 Return: NULL for success, or an error string */
535 exim_dkim_verify(ev_ctx * verify_ctx, hashmethod hash, blob * data_hash, blob * sig)
538 cf. libgnutls 2.8.5 _wrap_gcry_pk_verify()
542 gcry_sexp_t s_sig = NULL, s_hash = NULL, s_pkey = NULL;
546 /*XXX needs extension for SHA512 */
549 case HASH_SHA1: sexp_hash = "(data(flags pkcs1)(hash sha1 %b))"; break;
550 case HASH_SHA2_256: sexp_hash = "(data(flags pkcs1)(hash sha256 %b))"; break;
551 default: return US"nonhandled hash type";
554 if ( (stage = US"pkey sexp build",
555 gerr = gcry_sexp_build (&s_pkey, NULL, "(public-key(rsa(n%m)(e%m)))",
556 verify_ctx->n, verify_ctx->e))
557 || (stage = US"data sexp build",
558 gerr = gcry_sexp_build (&s_hash, NULL, sexp_hash,
559 (int) data_hash->len, CS data_hash->data))
560 || (stage = US"sig mpi scan",
561 gerr = gcry_mpi_scan(&m_sig, GCRYMPI_FMT_USG, sig->data, sig->len, NULL))
562 || (stage = US"sig sexp build",
563 gerr = gcry_sexp_build (&s_sig, NULL, "(sig-val(rsa(s%m)))", m_sig))
564 || (stage = US"verify",
565 gerr = gcry_pk_verify (s_sig, s_hash, s_pkey))
568 DEBUG(D_acl) debug_printf_indent("verify: error in stage '%s'\n", stage);
569 return US gcry_strerror(gerr);
572 if (s_sig) gcry_sexp_release (s_sig);
573 if (s_hash) gcry_sexp_release (s_hash);
574 if (s_pkey) gcry_sexp_release (s_pkey);
575 gcry_mpi_release (m_sig);
576 gcry_mpi_release (verify_ctx->n);
577 gcry_mpi_release (verify_ctx->e);
585 #elif defined(SIGN_OPENSSL)
586 /******************************************************************************/
591 ERR_load_crypto_strings();
595 /* accumulate data (gnutls-only) */
597 exim_dkim_data_append(blob * b, int * alloc, uschar * s)
603 /* import private key from PEM string in memory.
604 Return: NULL for success, or an error string */
607 exim_dkim_signing_init(uschar * privkey_pem, es_ctx * sign_ctx)
609 BIO * bp = BIO_new_mem_buf(privkey_pem, -1);
611 if (!(sign_ctx->key = PEM_read_bio_PrivateKey(bp, NULL, NULL, NULL)))
612 return US ERR_error_string(ERR_get_error(), NULL);
618 /* allocate mem for signature (when signing) */
619 /* sign data (gnutls_only)
623 Return: NULL for success with the signaature in the sig blob, or an error string */
626 exim_dkim_sign(es_ctx * sign_ctx, hashmethod hash, blob * data, blob * sig)
634 case HASH_SHA1: md = EVP_sha1(); break;
635 case HASH_SHA2_256: md = EVP_sha256(); break;
636 case HASH_SHA2_512: md = EVP_sha512(); break;
637 default: return US"nonhandled hash type";
640 if ( (ctx = EVP_PKEY_CTX_new(sign_ctx->key, NULL))
641 && EVP_PKEY_sign_init(ctx) > 0
642 && EVP_PKEY_CTX_set_rsa_padding(ctx, RSA_PKCS1_PADDING) > 0
643 && EVP_PKEY_CTX_set_signature_md(ctx, md) > 0
644 && EVP_PKEY_sign(ctx, NULL, &siglen, data->data, data->len) > 0
647 /* Allocate mem for signature */
648 sig->data = store_get(siglen);
650 if (EVP_PKEY_sign(ctx, sig->data, &siglen, data->data, data->len) > 0)
652 EVP_PKEY_CTX_free(ctx);
658 if (ctx) EVP_PKEY_CTX_free(ctx);
659 return US ERR_error_string(ERR_get_error(), NULL);
664 /* import public key (from DER in memory)
665 Return: NULL for success, or an error string */
668 exim_dkim_verify_init(blob * pubkey_der, ev_ctx * verify_ctx)
670 const uschar * s = pubkey_der->data;
672 /*XXX hmm, we never free this */
674 if ((verify_ctx->key = d2i_PUBKEY(NULL, &s, pubkey_der->len)))
676 return US ERR_error_string(ERR_get_error(), NULL);
682 /* verify signature (of hash) (given pubkey & alleged sig)
683 Return: NULL for success, or an error string */
686 exim_dkim_verify(ev_ctx * verify_ctx, hashmethod hash, blob * data_hash, blob * sig)
693 case HASH_SHA1: md = EVP_sha1(); break;
694 case HASH_SHA2_256: md = EVP_sha256(); break;
695 case HASH_SHA2_512: md = EVP_sha512(); break;
696 default: return US"nonhandled hash type";
699 if ( (ctx = EVP_PKEY_CTX_new(verify_ctx->key, NULL))
700 && EVP_PKEY_verify_init(ctx) > 0
701 && EVP_PKEY_CTX_set_rsa_padding(ctx, RSA_PKCS1_PADDING) > 0
702 && EVP_PKEY_CTX_set_signature_md(ctx, md) > 0
703 && EVP_PKEY_verify(ctx, sig->data, sig->len,
704 data_hash->data, data_hash->len) == 1
706 { EVP_PKEY_CTX_free(ctx); return NULL; }
708 if (ctx) EVP_PKEY_CTX_free(ctx);
709 return US ERR_error_string(ERR_get_error(), NULL);
715 /******************************************************************************/
717 #endif /*DISABLE_DKIM*/