Copyright year bumps for substantive changes 2017
[exim.git] / src / src / tlscert-openssl.c
CommitLineData
9d1c15ef
JH
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
9242a7e8 5/* Copyright (c) Jeremy Harris 2014 - 2017 */
9d1c15ef
JH
6
7/* This module provides TLS (aka SSL) support for Exim using the OpenSSL
8library. It is #included into the tls.c file when that library is used.
9*/
10
11
12/* Heading stuff */
13
14#include <openssl/lhash.h>
15#include <openssl/ssl.h>
16#include <openssl/err.h>
17#include <openssl/rand.h>
51424d08 18#include <openssl/x509v3.h>
9d1c15ef 19
c8dfb21d
JH
20#if OPENSSL_VERSION_NUMBER >= 0x10100000L
21# define EXIM_HAVE_ASN1_MACROS
22#endif
23
9d1c15ef
JH
24
25/*****************************************************
26* Export/import a certificate, binary/printable
27*****************************************************/
28int
29tls_export_cert(uschar * buf, size_t buflen, void * cert)
30{
31BIO * bp = BIO_new(BIO_s_mem());
32int fail;
33
34if ((fail = PEM_write_bio_X509(bp, (X509 *)cert) ? 0 : 1))
35 log_write(0, LOG_MAIN, "TLS error in certificate export: %s",
36 ERR_error_string(ERR_get_error(), NULL));
37else
38 {
39 char * cp = CS buf;
40 int n;
41 buflen -= 2;
42 for(;;)
43 {
44 if ((n = BIO_gets(bp, cp, (int)buflen)) <= 0) break;
45 cp += n+1;
46 buflen -= n+1;
47 cp[-2] = '\\'; cp[-1] = 'n'; /* newline->"\n" */
48 } /* compat with string_printing() */
49 *cp = '\0';
50 }
51
52BIO_free(bp);
53return fail;
54}
55
56int
57tls_import_cert(const uschar * buf, void ** cert)
58{
59void * reset_point = store_get(0);
60const uschar * cp = string_unprinting(US buf);
61BIO * bp;
152e7604 62X509 * x = *(X509 **)cert;
c03fae8a 63int fail = 0;
9d1c15ef 64
152e7604
JH
65if (x) X509_free(x);
66
9d1c15ef 67bp = BIO_new_mem_buf(US cp, -1);
c03fae8a
JH
68if (!(x = PEM_read_bio_X509(bp, NULL, 0, NULL)))
69 {
70 log_write(0, LOG_MAIN, "TLS error in certificate import: %s",
71 ERR_error_string(ERR_get_error(), NULL));
9d1c15ef 72 fail = 1;
c03fae8a 73 }
9d1c15ef
JH
74else
75 *cert = (void *)x;
76BIO_free(bp);
77store_reset(reset_point);
78return fail;
79}
80
81void
790fbb71 82tls_free_cert(void ** cert)
9d1c15ef 83{
790fbb71
JH
84X509 * x = *(X509 **)cert;
85if (x)
86 {
87 X509_free(x);
88 *cert = NULL;
89 }
9d1c15ef
JH
90}
91
c03fae8a 92
9d1c15ef
JH
93/*****************************************************
94* Certificate field extraction routines
95*****************************************************/
c03fae8a
JH
96
97/* First, some internal service functions */
98
99static uschar *
100badalloc(void)
101{
102expand_string_message = US"allocation failure";
103return NULL;
104}
105
9d1c15ef
JH
106static uschar *
107bio_string_copy(BIO * bp, int len)
108{
e3dd1d67 109uschar * cp = US"";
9d1c15ef
JH
110len = len > 0 ? (int) BIO_get_mem_data(bp, &cp) : 0;
111cp = string_copyn(cp, len);
112BIO_free(bp);
113return cp;
114}
115
116static uschar *
e9477a08 117asn1_time_copy(const ASN1_TIME * asntime, uschar * mod)
9d1c15ef 118{
e9477a08 119uschar * s = NULL;
9d1c15ef 120BIO * bp = BIO_new(BIO_s_mem());
c03fae8a
JH
121int len;
122
e9477a08
JH
123if (!bp)
124 return badalloc();
125len = ASN1_TIME_print(bp, asntime);
d4ff61d1 126len = len > 0 ? (int) BIO_get_mem_data(bp, CSS &s) : 0;
c03fae8a 127
e9477a08
JH
128if (mod && Ustrcmp(mod, "raw") == 0) /* native ASN */
129 s = string_copyn(s, len);
130else
131 {
132 struct tm tm;
133 struct tm * tm_p = &tm;
755762fd 134 BOOL mod_tz = TRUE;
45500060 135 uschar * tz = to_tz(US"GMT0"); /* need to call strptime with baseline TZ */
e9477a08
JH
136
137 /* Parse OpenSSL ASN1_TIME_print output. A shame there seems to
138 be no other interface for the times.
139 */
140
141 /*XXX %Z might be glibc-specific? Solaris has it, at least*/
142 /*XXX should we switch to POSIX locale for this? */
143 tm.tm_isdst = 0;
d4ff61d1 144 if (!len || !strptime(CCS s, "%b %e %T %Y %Z", &tm))
e9477a08
JH
145 expand_string_message = US"failed time conversion";
146
147 else
148 {
149 time_t t = mktime(&tm); /* make the tm self-consistent */
150
151 if (mod && Ustrcmp(mod, "int") == 0) /* seconds since epoch */
bb07bcd3 152 s = string_sprintf(TIME_T_FMT, t);
e9477a08
JH
153
154 else
155 {
156 if (!timestamps_utc) /* decoded string in local TZ */
157 { /* shift to local TZ */
158 restore_tz(tz);
159 mod_tz = FALSE;
160 tm_p = localtime(&t);
161 }
162 /* "utc" is default, and rfc5280 says cert times should be Zulu */
163
164 /* convert to string in our format */
165 len = 32;
166 s = store_get(len);
167 strftime(CS s, (size_t)len, "%b %e %T %Y %z", tm_p);
168 }
169 }
170
755762fd 171 if (mod_tz)
e9477a08
JH
172 restore_tz(tz);
173 }
174BIO_free(bp);
175return s;
9d1c15ef
JH
176}
177
178static uschar *
179x509_name_copy(X509_NAME * name)
180{
181BIO * bp = BIO_new(BIO_s_mem());
c03fae8a
JH
182int len_good;
183
184if (!bp) return badalloc();
185
186len_good =
9d1c15ef
JH
187 X509_NAME_print_ex(bp, name, 0, XN_FLAG_RFC2253) >= 0
188 ? 1 : 0;
189return bio_string_copy(bp, len_good);
190}
191
192/**/
c03fae8a
JH
193/* Now the extractors, called from expand.c
194Arguments:
195 cert The certificate
196 mod Optional modifiers for the operator
197
198Return:
199 Allocated string with extracted value
200*/
9d1c15ef
JH
201
202uschar *
9e4dddbd 203tls_cert_issuer(void * cert, uschar * mod)
9d1c15ef 204{
812a6045
JH
205uschar * cp = x509_name_copy(X509_get_issuer_name((X509 *)cert));
206return mod ? tls_field_from_dn(cp, mod) : cp;
9d1c15ef
JH
207}
208
209uschar *
9e4dddbd 210tls_cert_not_before(void * cert, uschar * mod)
9d1c15ef 211{
25ba2544 212return asn1_time_copy(X509_get_notBefore((X509 *)cert), mod);
9d1c15ef
JH
213}
214
215uschar *
9e4dddbd 216tls_cert_not_after(void * cert, uschar * mod)
9d1c15ef 217{
25ba2544 218return asn1_time_copy(X509_get_notAfter((X509 *)cert), mod);
9d1c15ef
JH
219}
220
221uschar *
9e4dddbd 222tls_cert_serial_number(void * cert, uschar * mod)
9d1c15ef
JH
223{
224uschar txt[256];
225BIO * bp = BIO_new(BIO_s_mem());
c03fae8a 226int len;
9d1c15ef 227
c03fae8a
JH
228if (!bp) return badalloc();
229
230len = i2a_ASN1_INTEGER(bp, X509_get_serialNumber((X509 *)cert));
9d1c15ef
JH
231if (len < sizeof(txt))
232 BIO_read(bp, txt, len);
233else
234 len = 0;
235BIO_free(bp);
236return string_copynlc(txt, len); /* lowercase */
237}
238
239uschar *
9e4dddbd 240tls_cert_signature(void * cert, uschar * mod)
9d1c15ef 241{
9d1c15ef 242uschar * cp = NULL;
c03fae8a
JH
243BIO * bp = BIO_new(BIO_s_mem());
244
245if (!bp) return badalloc();
9d1c15ef
JH
246
247if (X509_print_ex(bp, (X509 *)cert, 0,
94431adb
HSHR
248 X509_FLAG_NO_HEADER | X509_FLAG_NO_VERSION | X509_FLAG_NO_SERIAL |
249 X509_FLAG_NO_SIGNAME | X509_FLAG_NO_ISSUER | X509_FLAG_NO_VALIDITY |
250 X509_FLAG_NO_SUBJECT | X509_FLAG_NO_PUBKEY | X509_FLAG_NO_EXTENSIONS |
9d1c15ef
JH
251 /* X509_FLAG_NO_SIGDUMP is the missing one */
252 X509_FLAG_NO_AUX) == 1)
253 {
254 long len = BIO_get_mem_data(bp, &cp);
315e209a
JH
255
256 /* Strip leading "Signature Algorithm" line */
257 while (*cp && *cp != '\n') { cp++; len--; }
258
259 cp = string_copyn(cp+1, len-1);
9d1c15ef
JH
260 }
261BIO_free(bp);
262return cp;
263}
264
265uschar *
9e4dddbd 266tls_cert_signature_algorithm(void * cert, uschar * mod)
9d1c15ef 267{
315e209a
JH
268uschar * cp = NULL;
269BIO * bp = BIO_new(BIO_s_mem());
270
271if (!bp) return badalloc();
272
273if (X509_print_ex(bp, (X509 *)cert, 0,
94431adb 274 X509_FLAG_NO_HEADER | X509_FLAG_NO_VERSION | X509_FLAG_NO_SERIAL |
315e209a 275 /* X509_FLAG_NO_SIGNAME is the missing one */
94431adb
HSHR
276 X509_FLAG_NO_ISSUER | X509_FLAG_NO_VALIDITY |
277 X509_FLAG_NO_SUBJECT | X509_FLAG_NO_PUBKEY | X509_FLAG_NO_EXTENSIONS |
315e209a
JH
278 X509_FLAG_NO_SIGDUMP | X509_FLAG_NO_AUX) == 1)
279 {
280 long len = BIO_get_mem_data(bp, &cp);
281
282 /* Strip leading " Signature Algorithm: " and trailing newline */
283 while (*cp && *cp != ':') { cp++; len--; }
284 do { cp++; len--; } while (*cp && *cp == ' ');
285 if (cp[len-1] == '\n') len--;
286
287 cp = string_copyn(cp, len);
288 }
289BIO_free(bp);
290return cp;
9d1c15ef
JH
291}
292
293uschar *
9e4dddbd 294tls_cert_subject(void * cert, uschar * mod)
9d1c15ef 295{
812a6045
JH
296uschar * cp = x509_name_copy(X509_get_subject_name((X509 *)cert));
297return mod ? tls_field_from_dn(cp, mod) : cp;
9d1c15ef
JH
298}
299
300uschar *
9e4dddbd 301tls_cert_version(void * cert, uschar * mod)
9d1c15ef 302{
bb07bcd3 303return string_sprintf("%ld", X509_get_version((X509 *)cert));
9d1c15ef
JH
304}
305
306uschar *
307tls_cert_ext_by_oid(void * cert, uschar * oid, int idx)
308{
e3dd1d67 309int nid = OBJ_create(CS oid, "", "");
9d1c15ef
JH
310int nidx = X509_get_ext_by_NID((X509 *)cert, nid, idx);
311X509_EXTENSION * ex = X509_get_ext((X509 *)cert, nidx);
312ASN1_OCTET_STRING * adata = X509_EXTENSION_get_data(ex);
313BIO * bp = BIO_new(BIO_s_mem());
314long len;
315uschar * cp1;
316uschar * cp2;
317uschar * cp3;
318
c03fae8a
JH
319if (!bp) return badalloc();
320
c8dfb21d
JH
321#ifdef EXIM_HAVE_ASN1_MACROS
322ASN1_STRING_print(bp, adata);
323#else
9d1c15ef 324M_ASN1_OCTET_STRING_print(bp, adata);
c8dfb21d 325#endif
9d1c15ef 326
c8dfb21d 327/* binary data, DER encoded */
9d1c15ef
JH
328/* just dump for now */
329len = BIO_get_mem_data(bp, &cp1);
330cp3 = cp2 = store_get(len*3+1);
331
332while(len)
333 {
5976eb99 334 cp2 += sprintf(CS cp2, "%.2x ", *cp1++);
9d1c15ef
JH
335 len--;
336 }
337cp2[-1] = '\0';
338
339return cp3;
340}
341
342uschar *
9e4dddbd 343tls_cert_subject_altname(void * cert, uschar * mod)
9d1c15ef 344{
acec9514 345gstring * list = NULL;
9d1c15ef
JH
346STACK_OF(GENERAL_NAME) * san = (STACK_OF(GENERAL_NAME) *)
347 X509_get_ext_d2i((X509 *)cert, NID_subject_alt_name, NULL, NULL);
b3ef41c9 348uschar osep = '\n';
9e4dddbd
JH
349uschar * tag = US"";
350uschar * ele;
351int match = -1;
e51c7be2 352int len;
9d1c15ef
JH
353
354if (!san) return NULL;
355
b3ef41c9 356while (mod && *mod)
9e4dddbd 357 {
b3ef41c9
JH
358 if (*mod == '>' && *++mod) osep = *mod++;
359 else if (Ustrncmp(mod,"dns",3)==0) { match = GEN_DNS; mod += 3; }
360 else if (Ustrncmp(mod,"uri",3)==0) { match = GEN_URI; mod += 3; }
361 else if (Ustrncmp(mod,"mail",4)==0) { match = GEN_EMAIL; mod += 4; }
362 else mod++;
9e4dddbd 363
b3ef41c9 364 if (*mod == ',') mod++;
9e4dddbd
JH
365 }
366
9d1c15ef
JH
367while (sk_GENERAL_NAME_num(san) > 0)
368 {
369 GENERAL_NAME * namePart = sk_GENERAL_NAME_pop(san);
9e4dddbd
JH
370 if (match != -1 && match != namePart->type)
371 continue;
9d1c15ef
JH
372 switch (namePart->type)
373 {
9e4dddbd
JH
374 case GEN_DNS:
375 tag = US"DNS";
376 ele = ASN1_STRING_data(namePart->d.dNSName);
e51c7be2 377 len = ASN1_STRING_length(namePart->d.dNSName);
9e4dddbd 378 break;
9d1c15ef 379 case GEN_URI:
9e4dddbd
JH
380 tag = US"URI";
381 ele = ASN1_STRING_data(namePart->d.uniformResourceIdentifier);
e51c7be2 382 len = ASN1_STRING_length(namePart->d.uniformResourceIdentifier);
9e4dddbd 383 break;
9d1c15ef 384 case GEN_EMAIL:
9e4dddbd
JH
385 tag = US"MAIL";
386 ele = ASN1_STRING_data(namePart->d.rfc822Name);
e51c7be2 387 len = ASN1_STRING_length(namePart->d.rfc822Name);
9e4dddbd 388 break;
9d1c15ef 389 default:
9e4dddbd 390 continue; /* ignore unrecognised types */
9d1c15ef 391 }
e51c7be2
JH
392 if (ele[len]) /* not nul-terminated */
393 ele = string_copyn(ele, len);
394
9acf6b94 395 if (Ustrlen(ele) == len) /* ignore any with embedded nul */
acec9514 396 list = string_append_listele(list, osep,
9e4dddbd 397 match == -1 ? string_sprintf("%s=%s", tag, ele) : ele);
9d1c15ef
JH
398 }
399
9e4dddbd 400sk_GENERAL_NAME_free(san);
acec9514 401return string_from_gstring(list);
9d1c15ef
JH
402}
403
404uschar *
9e4dddbd 405tls_cert_ocsp_uri(void * cert, uschar * mod)
9d1c15ef
JH
406{
407STACK_OF(ACCESS_DESCRIPTION) * ads = (STACK_OF(ACCESS_DESCRIPTION) *)
408 X509_get_ext_d2i((X509 *)cert, NID_info_access, NULL, NULL);
409int adsnum = sk_ACCESS_DESCRIPTION_num(ads);
410int i;
9e4dddbd 411uschar sep = '\n';
acec9514 412gstring * list = NULL;
9e4dddbd
JH
413
414if (mod)
415 if (*mod == '>' && *++mod) sep = *mod++;
9d1c15ef
JH
416
417for (i = 0; i < adsnum; i++)
418 {
419 ACCESS_DESCRIPTION * ad = sk_ACCESS_DESCRIPTION_value(ads, i);
420
421 if (ad && OBJ_obj2nid(ad->method) == NID_ad_OCSP)
acec9514 422 list = string_append_listele_n(list, sep,
4226691b
JH
423 ASN1_STRING_data(ad->location->d.ia5),
424 ASN1_STRING_length(ad->location->d.ia5));
9d1c15ef 425 }
00ba27c5 426sk_ACCESS_DESCRIPTION_free(ads);
acec9514 427return string_from_gstring(list);
9d1c15ef
JH
428}
429
430uschar *
9e4dddbd 431tls_cert_crl_uri(void * cert, uschar * mod)
9d1c15ef
JH
432{
433STACK_OF(DIST_POINT) * dps = (STACK_OF(DIST_POINT) *)
434 X509_get_ext_d2i((X509 *)cert, NID_crl_distribution_points,
435 NULL, NULL);
436DIST_POINT * dp;
437int dpsnum = sk_DIST_POINT_num(dps);
438int i;
9e4dddbd 439uschar sep = '\n';
acec9514 440gstring * list = NULL;
9e4dddbd
JH
441
442if (mod)
443 if (*mod == '>' && *++mod) sep = *mod++;
9d1c15ef
JH
444
445if (dps) for (i = 0; i < dpsnum; i++)
446 if ((dp = sk_DIST_POINT_value(dps, i)))
447 {
448 STACK_OF(GENERAL_NAME) * names = dp->distpoint->name.fullname;
449 GENERAL_NAME * np;
450 int nnum = sk_GENERAL_NAME_num(names);
451 int j;
452
453 for (j = 0; j < nnum; j++)
454 if ( (np = sk_GENERAL_NAME_value(names, j))
455 && np->type == GEN_URI
456 )
acec9514 457 list = string_append_listele_n(list, sep,
4226691b
JH
458 ASN1_STRING_data(np->d.uniformResourceIdentifier),
459 ASN1_STRING_length(np->d.uniformResourceIdentifier));
9d1c15ef 460 }
00ba27c5 461sk_DIST_POINT_free(dps);
acec9514 462return string_from_gstring(list);
9d1c15ef
JH
463}
464
6a8a60e0
JH
465
466
467/*****************************************************
468* Certificate operator routines
469*****************************************************/
59b87190
JH
470uschar *
471tls_cert_der_b64(void * cert)
472{
473BIO * bp = BIO_new(BIO_s_mem());
474uschar * cp = NULL;
475
476if (!i2d_X509_bio(bp, (X509 *)cert))
477 log_write(0, LOG_MAIN, "TLS error in certificate export: %s",
478 ERR_error_string(ERR_get_error(), NULL));
479else
480 {
481 long len = BIO_get_mem_data(bp, &cp);
482 cp = b64encode(cp, (int)len);
483 }
484
485BIO_free(bp);
486return cp;
487}
488
489
6a8a60e0
JH
490static uschar *
491fingerprint(X509 * cert, const EVP_MD * fdig)
492{
493int j;
494unsigned int n;
495uschar md[EVP_MAX_MD_SIZE];
496uschar * cp;
497
498if (!X509_digest(cert,fdig,md,&n))
499 {
500 expand_string_message = US"tls_cert_fprt: out of mem\n";
501 return NULL;
502 }
503cp = store_get(n*2+1);
e3dd1d67 504for (j = 0; j < (int)n; j++) sprintf(CS cp+2*j, "%02X", md[j]);
6a8a60e0
JH
505return(cp);
506}
507
94431adb 508uschar *
6a8a60e0
JH
509tls_cert_fprt_md5(void * cert)
510{
511return fingerprint((X509 *)cert, EVP_md5());
512}
513
94431adb 514uschar *
6a8a60e0
JH
515tls_cert_fprt_sha1(void * cert)
516{
517return fingerprint((X509 *)cert, EVP_sha1());
518}
519
94431adb 520uschar *
9ef9101c
JH
521tls_cert_fprt_sha256(void * cert)
522{
523return fingerprint((X509 *)cert, EVP_sha256());
524}
525
6a8a60e0 526
9d1c15ef
JH
527/* vi: aw ai sw=2
528*/
529/* End of tlscert-openssl.c */