string handling: strlen for gstring
[exim.git] / src / src / tlscert-gnu.c
... / ...
CommitLineData
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
5/* Copyright (c) Jeremy Harris 2014 - 2018 */
6
7/* This file provides TLS/SSL support for Exim using the GnuTLS library,
8one of the available supported implementations. This file is #included into
9tls.c when USE_GNUTLS has been set.
10*/
11
12#include <gnutls/gnutls.h>
13/* needed for cert checks in verification and DN extraction: */
14#include <gnutls/x509.h>
15/* needed to disable PKCS11 autoload unless requested */
16#if GNUTLS_VERSION_NUMBER >= 0x020c00
17# include <gnutls/pkcs11.h>
18#endif
19
20
21/*****************************************************
22* Export/import a certificate, binary/printable
23******************************************************
24Return: boolean success
25*/
26
27BOOL
28tls_export_cert(uschar * buf, size_t buflen, void * cert)
29{
30size_t sz = buflen;
31rmark reset_point = store_mark();
32BOOL fail;
33const uschar * cp;
34
35if ((fail = gnutls_x509_crt_export((gnutls_x509_crt_t)cert,
36 GNUTLS_X509_FMT_PEM, buf, &sz)))
37 {
38 log_write(0, LOG_MAIN, "TLS error in certificate export: %s",
39 gnutls_strerror(fail));
40 return FALSE;
41 }
42if ((cp = string_printing(buf)) != buf)
43 {
44 Ustrncpy(buf, cp, buflen);
45 if (buf[buflen-1])
46 fail = 1;
47 }
48store_reset(reset_point);
49return !fail;
50}
51
52/* On error, NULL out the destination */
53BOOL
54tls_import_cert(const uschar * buf, void ** cert)
55{
56rmark reset_point = store_mark();
57gnutls_datum_t datum;
58gnutls_x509_crt_t crt = *(gnutls_x509_crt_t *)cert;
59int rc;
60
61if (crt)
62 gnutls_x509_crt_deinit(crt);
63else
64 gnutls_global_init();
65
66gnutls_x509_crt_init(&crt);
67
68datum.data = string_unprinting(US buf);
69datum.size = Ustrlen(datum.data);
70if ((rc = gnutls_x509_crt_import(crt, &datum, GNUTLS_X509_FMT_PEM)))
71 {
72 log_write(0, LOG_MAIN, "TLS error in certificate import: %s",
73 gnutls_strerror(rc));
74 crt = NULL;
75 }
76*cert = (void *)crt;
77store_reset(reset_point);
78return rc != 0;
79}
80
81void
82tls_free_cert(void ** cert)
83{
84gnutls_x509_crt_t crt = *(gnutls_x509_crt_t *)cert;
85if (crt)
86 {
87 gnutls_x509_crt_deinit(crt);
88 gnutls_global_deinit();
89 *cert = NULL;
90 }
91}
92
93/*****************************************************
94* Certificate field extraction routines
95*****************************************************/
96
97/* First, some internal service functions */
98
99static uschar *
100g_err(const char * tag, const char * from, int gnutls_err)
101{
102expand_string_message = string_sprintf("%s: %s fail: %s\n",
103 from, tag, gnutls_strerror(gnutls_err));
104return NULL;
105}
106
107
108static uschar *
109time_copy(time_t t, uschar * mod)
110{
111uschar * cp;
112size_t len = 32;
113
114if (mod && Ustrcmp(mod, "int") == 0)
115 return string_sprintf("%u", (unsigned)t);
116
117cp = store_get(len, FALSE);
118if (f.timestamps_utc)
119 {
120 uschar * tz = to_tz(US"GMT0");
121 len = strftime(CS cp, len, "%b %e %T %Y %Z", gmtime(&t));
122 restore_tz(tz);
123 }
124else
125 len = strftime(CS cp, len, "%b %e %T %Y %Z", localtime(&t));
126return len > 0 ? cp : NULL;
127}
128
129
130/**/
131/* Now the extractors, called from expand.c
132Arguments:
133 cert The certificate
134 mod Optional modifiers for the operator
135
136Return:
137 Allocated string with extracted value
138*/
139
140uschar *
141tls_cert_issuer(void * cert, uschar * mod)
142{
143uschar * cp = NULL;
144int ret;
145size_t siz = 0;
146
147if ((ret = gnutls_x509_crt_get_issuer_dn(cert, CS cp, &siz))
148 != GNUTLS_E_SHORT_MEMORY_BUFFER)
149 return g_err("gi0", __FUNCTION__, ret);
150
151cp = store_get(siz, TRUE);
152if ((ret = gnutls_x509_crt_get_issuer_dn(cert, CS cp, &siz)) < 0)
153 return g_err("gi1", __FUNCTION__, ret);
154
155return mod ? tls_field_from_dn(cp, mod) : cp;
156}
157
158uschar *
159tls_cert_not_after(void * cert, uschar * mod)
160{
161return time_copy(
162 gnutls_x509_crt_get_expiration_time((gnutls_x509_crt_t)cert),
163 mod);
164}
165
166uschar *
167tls_cert_not_before(void * cert, uschar * mod)
168{
169return time_copy(
170 gnutls_x509_crt_get_activation_time((gnutls_x509_crt_t)cert),
171 mod);
172}
173
174uschar *
175tls_cert_serial_number(void * cert, uschar * mod)
176{
177uschar bin[50], txt[150];
178uschar * sp = bin;
179size_t sz = sizeof(bin);
180int ret;
181
182if ((ret = gnutls_x509_crt_get_serial((gnutls_x509_crt_t)cert,
183 bin, &sz)))
184 return g_err("gs0", __FUNCTION__, ret);
185
186for(uschar * dp = txt; sz; sz--)
187 dp += sprintf(CS dp, "%.2x", *sp++);
188for(sp = txt; sp[0]=='0' && sp[1]; ) sp++; /* leading zeroes */
189return string_copy(sp);
190}
191
192uschar *
193tls_cert_signature(void * cert, uschar * mod)
194{
195uschar * cp1 = NULL;
196uschar * cp2;
197uschar * cp3;
198size_t len = 0;
199int ret;
200
201if ((ret = gnutls_x509_crt_get_signature((gnutls_x509_crt_t)cert, CS cp1, &len))
202 != GNUTLS_E_SHORT_MEMORY_BUFFER)
203 return g_err("gs0", __FUNCTION__, ret);
204
205cp1 = store_get(len*4+1, TRUE);
206if (gnutls_x509_crt_get_signature((gnutls_x509_crt_t)cert, CS cp1, &len) != 0)
207 return g_err("gs1", __FUNCTION__, ret);
208
209for(cp3 = cp2 = cp1+len; cp1 < cp2; cp1++)
210 cp3 += sprintf(CS cp3, "%.2x ", *cp1);
211cp3[-1]= '\0';
212
213return cp2;
214}
215
216uschar *
217tls_cert_signature_algorithm(void * cert, uschar * mod)
218{
219gnutls_sign_algorithm_t algo =
220 gnutls_x509_crt_get_signature_algorithm((gnutls_x509_crt_t)cert);
221return algo < 0 ? NULL : string_copy(US gnutls_sign_get_name(algo));
222}
223
224uschar *
225tls_cert_subject(void * cert, uschar * mod)
226{
227uschar * cp = NULL;
228int ret;
229size_t siz = 0;
230
231if ((ret = gnutls_x509_crt_get_dn(cert, CS cp, &siz))
232 != GNUTLS_E_SHORT_MEMORY_BUFFER)
233 return g_err("gs0", __FUNCTION__, ret);
234
235cp = store_get(siz, TRUE);
236if ((ret = gnutls_x509_crt_get_dn(cert, CS cp, &siz)) < 0)
237 return g_err("gs1", __FUNCTION__, ret);
238
239return mod ? tls_field_from_dn(cp, mod) : cp;
240}
241
242uschar *
243tls_cert_version(void * cert, uschar * mod)
244{
245return string_sprintf("%d", gnutls_x509_crt_get_version(cert));
246}
247
248uschar *
249tls_cert_ext_by_oid(void * cert, uschar * oid, int idx)
250{
251uschar * cp1 = NULL;
252uschar * cp2;
253uschar * cp3;
254size_t siz = 0;
255unsigned int crit;
256int ret;
257
258ret = gnutls_x509_crt_get_extension_by_oid ((gnutls_x509_crt_t)cert,
259 CS oid, idx, CS cp1, &siz, &crit);
260if (ret != GNUTLS_E_SHORT_MEMORY_BUFFER)
261 return g_err("ge0", __FUNCTION__, ret);
262
263cp1 = store_get(siz*4 + 1, TRUE);
264
265ret = gnutls_x509_crt_get_extension_by_oid ((gnutls_x509_crt_t)cert,
266 CS oid, idx, CS cp1, &siz, &crit);
267if (ret < 0)
268 return g_err("ge1", __FUNCTION__, ret);
269
270/* binary data, DER encoded */
271
272/* just dump for now */
273for(cp3 = cp2 = cp1+siz; cp1 < cp2; cp1++)
274 cp3 += sprintf(CS cp3, "%.2x ", *cp1);
275cp3[-1]= '\0';
276
277return cp2;
278}
279
280uschar *
281tls_cert_subject_altname(void * cert, uschar * mod)
282{
283gstring * list = NULL;
284size_t siz;
285int ret;
286uschar sep = '\n';
287uschar * tag = US"";
288uschar * ele;
289int match = -1;
290
291while (mod)
292 {
293 if (*mod == '>' && *++mod) sep = *mod++;
294 else if (Ustrcmp(mod, "dns")==0) { match = GNUTLS_SAN_DNSNAME; mod += 3; }
295 else if (Ustrcmp(mod, "uri")==0) { match = GNUTLS_SAN_URI; mod += 3; }
296 else if (Ustrcmp(mod, "mail")==0) { match = GNUTLS_SAN_RFC822NAME; mod += 4; }
297 else continue;
298
299 if (*mod++ != ',')
300 break;
301 }
302
303for (int index = 0;; index++)
304 {
305 siz = 0;
306 switch(ret = gnutls_x509_crt_get_subject_alt_name(
307 (gnutls_x509_crt_t)cert, index, NULL, &siz, NULL))
308 {
309 case GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE:
310 return string_from_gstring(list); /* no more elements; normal exit */
311
312 case GNUTLS_E_SHORT_MEMORY_BUFFER:
313 break;
314
315 default:
316 return g_err("gs0", __FUNCTION__, ret);
317 }
318
319 ele = store_get(siz+1, TRUE);
320 if ((ret = gnutls_x509_crt_get_subject_alt_name(
321 (gnutls_x509_crt_t)cert, index, ele, &siz, NULL)) < 0)
322 return g_err("gs1", __FUNCTION__, ret);
323 ele[siz] = '\0';
324
325 if ( match != -1 && match != ret /* wrong type of SAN */
326 || Ustrlen(ele) != siz) /* contains a NUL */
327 continue;
328 switch (ret)
329 {
330 case GNUTLS_SAN_DNSNAME: tag = US"DNS"; break;
331 case GNUTLS_SAN_URI: tag = US"URI"; break;
332 case GNUTLS_SAN_RFC822NAME: tag = US"MAIL"; break;
333 default: continue; /* ignore unrecognised types */
334 }
335 list = string_append_listele(list, sep,
336 match == -1 ? string_sprintf("%s=%s", tag, ele) : ele);
337 }
338/*NOTREACHED*/
339}
340
341uschar *
342tls_cert_ocsp_uri(void * cert, uschar * mod)
343{
344#if GNUTLS_VERSION_NUMBER >= 0x030000
345gnutls_datum_t uri;
346int ret;
347uschar sep = '\n';
348gstring * list = NULL;
349
350if (mod)
351 if (*mod == '>' && *++mod) sep = *mod++;
352
353for (int index = 0;; index++)
354 {
355 ret = gnutls_x509_crt_get_authority_info_access((gnutls_x509_crt_t)cert,
356 index, GNUTLS_IA_OCSP_URI, &uri, NULL);
357
358 if (ret == GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE)
359 return string_from_gstring(list);
360 if (ret < 0)
361 return g_err("gai", __FUNCTION__, ret);
362
363 list = string_append_listele_n(list, sep, uri.data, uri.size);
364 }
365/*NOTREACHED*/
366
367#else
368
369expand_string_message =
370 string_sprintf("%s: OCSP support with GnuTLS requires version 3.0.0\n",
371 __FUNCTION__);
372return NULL;
373
374#endif
375}
376
377uschar *
378tls_cert_crl_uri(void * cert, uschar * mod)
379{
380int ret;
381uschar sep = '\n';
382gstring * list = NULL;
383uschar * ele;
384
385if (mod)
386 if (*mod == '>' && *++mod) sep = *mod++;
387
388for (int index = 0;; index++)
389 {
390 size_t siz = 0;
391 switch(ret = gnutls_x509_crt_get_crl_dist_points(
392 (gnutls_x509_crt_t)cert, index, NULL, &siz, NULL, NULL))
393 {
394 case GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE:
395 return string_from_gstring(list);
396 case GNUTLS_E_SHORT_MEMORY_BUFFER:
397 break;
398 default:
399 return g_err("gc0", __FUNCTION__, ret);
400 }
401
402 ele = store_get(siz, TRUE);
403 if ((ret = gnutls_x509_crt_get_crl_dist_points(
404 (gnutls_x509_crt_t)cert, index, ele, &siz, NULL, NULL)) < 0)
405 return g_err("gc1", __FUNCTION__, ret);
406
407 list = string_append_listele_n(list, sep, ele, siz);
408 }
409/*NOTREACHED*/
410}
411
412
413/*****************************************************
414* Certificate operator routines
415*****************************************************/
416uschar *
417tls_cert_der_b64(void * cert)
418{
419size_t len = 0;
420uschar * cp = NULL;
421int fail;
422
423if ( (fail = gnutls_x509_crt_export((gnutls_x509_crt_t)cert,
424 GNUTLS_X509_FMT_DER, cp, &len)) != GNUTLS_E_SHORT_MEMORY_BUFFER
425 || !(cp = store_get((int)len, TRUE), TRUE) /* tainted */
426 || (fail = gnutls_x509_crt_export((gnutls_x509_crt_t)cert,
427 GNUTLS_X509_FMT_DER, cp, &len))
428 )
429 {
430 log_write(0, LOG_MAIN, "TLS error in certificate export: %s",
431 gnutls_strerror(fail));
432 return NULL;
433 }
434return b64encode(CUS cp, (int)len);
435}
436
437
438static uschar *
439fingerprint(gnutls_x509_crt_t cert, gnutls_digest_algorithm_t algo)
440{
441int ret;
442size_t siz = 0;
443uschar * cp;
444uschar * cp2;
445
446if ((ret = gnutls_x509_crt_get_fingerprint(cert, algo, NULL, &siz))
447 != GNUTLS_E_SHORT_MEMORY_BUFFER)
448 return g_err("gf0", __FUNCTION__, ret);
449
450cp = store_get(siz*3+1, TRUE);
451if ((ret = gnutls_x509_crt_get_fingerprint(cert, algo, cp, &siz)) < 0)
452 return g_err("gf1", __FUNCTION__, ret);
453
454for (uschar * cp3 = cp2 = cp+siz; cp < cp2; cp++)
455 cp3 += sprintf(CS cp3, "%02X", *cp);
456return cp2;
457}
458
459
460uschar *
461tls_cert_fprt_md5(void * cert)
462{
463return fingerprint((gnutls_x509_crt_t)cert, GNUTLS_DIG_MD5);
464}
465
466uschar *
467tls_cert_fprt_sha1(void * cert)
468{
469return fingerprint((gnutls_x509_crt_t)cert, GNUTLS_DIG_SHA1);
470}
471
472uschar *
473tls_cert_fprt_sha256(void * cert)
474{
475return fingerprint((gnutls_x509_crt_t)cert, GNUTLS_DIG_SHA256);
476}
477
478
479/* vi: aw ai sw=2
480*/
481/* End of tlscert-gnu.c */