NeoMutt  2024-12-12-19-ge4b57e
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
gnutls.c
Go to the documentation of this file.
1
30#include "config.h"
31#include <gnutls/gnutls.h>
32#include <gnutls/x509.h>
33#include <stdbool.h>
34#include <stdio.h>
35#include <string.h>
36#include <sys/stat.h>
37#include <time.h>
38#include "private.h"
39#include "mutt/lib.h"
40#include "config/lib.h"
41#include "core/lib.h"
42#include "lib.h"
43#include "connaccount.h"
44#include "connection.h"
45#include "globals.h"
46#include "muttlib.h"
47#include "ssl.h"
48
49int gnutls_protocol_set_priority(gnutls_session_t session, const int *list);
50
51// clang-format off
52/* certificate error bitmap values */
53#define CERTERR_VALID 0
54#define CERTERR_EXPIRED (1 << 0)
55#define CERTERR_NOTYETVALID (1 << 1)
56#define CERTERR_REVOKED (1 << 2)
57#define CERTERR_NOTTRUSTED (1 << 3)
58#define CERTERR_HOSTNAME (1 << 4)
59#define CERTERR_SIGNERNOTCA (1 << 5)
60#define CERTERR_INSECUREALG (1 << 6)
61#define CERTERR_OTHER (1 << 7)
62// clang-format on
63
64#define CERT_SEP "-----BEGIN"
65
66#ifndef HAVE_GNUTLS_PRIORITY_SET_DIRECT
75static int ProtocolPriority[] = { GNUTLS_TLS1_2, GNUTLS_TLS1_1, GNUTLS_TLS1, GNUTLS_SSL3, 0 };
76#endif
77
82{
83 gnutls_session_t session;
84 gnutls_certificate_credentials_t xcred;
85};
86
92static int tls_init(void)
93{
94 static bool init_complete = false;
95 int err;
96
97 if (init_complete)
98 return 0;
99
100 err = gnutls_global_init();
101 if (err < 0)
102 {
103 mutt_error("gnutls_global_init: %s", gnutls_strerror(err));
104 return -1;
105 }
106
107 init_complete = true;
108 return 0;
109}
110
122static int tls_verify_peers(gnutls_session_t tlsstate, gnutls_certificate_status_t *certstat)
123{
124 /* gnutls_certificate_verify_peers2() chains to
125 * gnutls_x509_trust_list_verify_crt2(). That function's documentation says:
126 *
127 * When a certificate chain of cert_list_size with more than one
128 * certificates is provided, the verification status will apply to
129 * the first certificate in the chain that failed
130 * verification. The verification process starts from the end of
131 * the chain(from CA to end certificate). The first certificate
132 * in the chain must be the end-certificate while the rest of the
133 * members may be sorted or not.
134 *
135 * This is why tls_check_certificate() loops from CA to host in that order,
136 * calling the menu, and recalling tls_verify_peers() for each approved
137 * cert in the chain.
138 */
139 int rc = gnutls_certificate_verify_peers2(tlsstate, certstat);
140
141 /* certstat was set */
142 if (rc == 0)
143 return 0;
144
145 if (rc == GNUTLS_E_NO_CERTIFICATE_FOUND)
146 mutt_error(_("Unable to get certificate from peer"));
147 else
148 mutt_error(_("Certificate verification error (%s)"), gnutls_strerror(rc));
149
150 return rc;
151}
152
159static void tls_fingerprint(gnutls_digest_algorithm_t algo, struct Buffer *buf,
160 const gnutls_datum_t *data)
161{
162 unsigned char md[128] = { 0 };
163 size_t n = 64;
164
165 if (gnutls_fingerprint(algo, data, (char *) md, &n) < 0)
166 {
167 buf_strcpy(buf, _("[unable to calculate]"));
168 return;
169 }
170
171 for (size_t i = 0; i < n; i++)
172 {
173 buf_add_printf(buf, "%02X", md[i]);
174
175 // Put a space after a pair of bytes (except for the last one)
176 if (((i % 2) == 1) && (i < (n - 1)))
177 buf_addch(buf, ' ');
178 }
179}
180
188static bool tls_check_stored_hostname(const gnutls_datum_t *cert, const char *hostname)
189{
190 char *linestr = NULL;
191 size_t linestrsize = 0;
192
193 /* try checking against names stored in stored certs file */
194 const char *const c_certificate_file = cs_subset_path(NeoMutt->sub, "certificate_file");
195 FILE *fp = mutt_file_fopen(c_certificate_file, "r");
196 if (!fp)
197 return false;
198
199 struct Buffer *buf = buf_pool_get();
200
201 tls_fingerprint(GNUTLS_DIG_MD5, buf, cert);
202 while ((linestr = mutt_file_read_line(linestr, &linestrsize, fp, NULL, MUTT_RL_NO_FLAGS)))
203 {
204 regmatch_t *match = mutt_prex_capture(PREX_GNUTLS_CERT_HOST_HASH, linestr);
205 if (match)
206 {
207 regmatch_t *mhost = &match[PREX_GNUTLS_CERT_HOST_HASH_MATCH_HOST];
208 regmatch_t *mhash = &match[PREX_GNUTLS_CERT_HOST_HASH_MATCH_HASH];
209 linestr[mutt_regmatch_end(mhost)] = '\0';
210 linestr[mutt_regmatch_end(mhash)] = '\0';
211 if ((mutt_str_equal(linestr + mutt_regmatch_start(mhost), hostname)) &&
212 (mutt_str_equal(linestr + mutt_regmatch_start(mhash), buf_string(buf))))
213 {
214 FREE(&linestr);
215 mutt_file_fclose(&fp);
216 buf_pool_release(&buf);
217 return true;
218 }
219 }
220 }
221
222 mutt_file_fclose(&fp);
223 buf_pool_release(&buf);
224
225 /* not found a matching name */
226 return false;
227}
228
235static int tls_compare_certificates(const gnutls_datum_t *peercert)
236{
237 gnutls_datum_t cert = { 0 };
238 unsigned char *ptr = NULL;
239 gnutls_datum_t b64_data = { 0 };
240 unsigned char *b64_data_data = NULL;
241 struct stat st = { 0 };
242
243 const char *const c_certificate_file = cs_subset_path(NeoMutt->sub, "certificate_file");
244 if (stat(c_certificate_file, &st) == -1)
245 return 0;
246
247 b64_data.size = st.st_size;
248 b64_data_data = MUTT_MEM_CALLOC(b64_data.size + 1, unsigned char);
249 b64_data.data = b64_data_data;
250
251 FILE *fp = mutt_file_fopen(c_certificate_file, "r");
252 if (!fp)
253 return 0;
254
255 b64_data.size = fread(b64_data.data, 1, b64_data.size, fp);
256 b64_data.data[b64_data.size] = '\0';
257 mutt_file_fclose(&fp);
258
259 do
260 {
261 const int rc = gnutls_pem_base64_decode_alloc(NULL, &b64_data, &cert);
262 if (rc != 0)
263 {
264 FREE(&b64_data_data);
265 return 0;
266 }
267
268 /* find start of cert, skipping junk */
269 ptr = (unsigned char *) strstr((char *) b64_data.data, CERT_SEP);
270 if (!ptr)
271 {
272 gnutls_free(cert.data);
273 FREE(&b64_data_data);
274 return 0;
275 }
276 /* find start of next cert */
277 ptr = (unsigned char *) strstr((char *) ptr + 1, CERT_SEP);
278
279 b64_data.size = b64_data.size - (ptr - b64_data.data);
280 b64_data.data = ptr;
281
282 if (cert.size == peercert->size)
283 {
284 if (memcmp(cert.data, peercert->data, cert.size) == 0)
285 {
286 /* match found */
287 gnutls_free(cert.data);
288 FREE(&b64_data_data);
289 return 1;
290 }
291 }
292
293 gnutls_free(cert.data);
294 } while (ptr);
295
296 /* no match found */
297 FREE(&b64_data_data);
298 return 0;
299}
300
312static int tls_check_preauth(const gnutls_datum_t *certdata,
313 gnutls_certificate_status_t certstat, const char *hostname,
314 int chainidx, int *certerr, int *savedcert)
315{
316 gnutls_x509_crt_t cert;
317
318 *certerr = CERTERR_VALID;
319 *savedcert = 0;
320
321 if (gnutls_x509_crt_init(&cert) < 0)
322 {
323 mutt_error(_("Error initialising gnutls certificate data"));
324 return -1;
325 }
326
327 if (gnutls_x509_crt_import(cert, certdata, GNUTLS_X509_FMT_DER) < 0)
328 {
329 mutt_error(_("Error processing certificate data"));
330 gnutls_x509_crt_deinit(cert);
331 return -1;
332 }
333
334 /* Note: tls_negotiate() contains a call to
335 * gnutls_certificate_set_verify_flags() with a flag disabling
336 * GnuTLS checking of the dates. So certstat shouldn't have the
337 * GNUTLS_CERT_EXPIRED and GNUTLS_CERT_NOT_ACTIVATED bits set. */
338 const bool c_ssl_verify_dates = cs_subset_bool(NeoMutt->sub, "ssl_verify_dates");
339 if (c_ssl_verify_dates != MUTT_NO)
340 {
341 if (gnutls_x509_crt_get_expiration_time(cert) < mutt_date_now())
342 *certerr |= CERTERR_EXPIRED;
343 if (gnutls_x509_crt_get_activation_time(cert) > mutt_date_now())
344 *certerr |= CERTERR_NOTYETVALID;
345 }
346
347 const bool c_ssl_verify_host = cs_subset_bool(NeoMutt->sub, "ssl_verify_host");
348 if ((chainidx == 0) && (c_ssl_verify_host != MUTT_NO) &&
349 !gnutls_x509_crt_check_hostname(cert, hostname) &&
350 !tls_check_stored_hostname(certdata, hostname))
351 {
352 *certerr |= CERTERR_HOSTNAME;
353 }
354
355 if (certstat & GNUTLS_CERT_REVOKED)
356 {
357 *certerr |= CERTERR_REVOKED;
358 certstat ^= GNUTLS_CERT_REVOKED;
359 }
360
361 /* see whether certificate is in our cache (certificates file) */
362 if (tls_compare_certificates(certdata))
363 {
364 *savedcert = 1;
365
366 /* We check above for certs with bad dates or that are revoked.
367 * These must be accepted manually each time. Otherwise, we
368 * accept saved certificates as valid. */
369 if (*certerr == CERTERR_VALID)
370 {
371 gnutls_x509_crt_deinit(cert);
372 return 0;
373 }
374 }
375
376 if (certstat & GNUTLS_CERT_INVALID)
377 {
378 *certerr |= CERTERR_NOTTRUSTED;
379 certstat ^= GNUTLS_CERT_INVALID;
380 }
381
382 if (certstat & GNUTLS_CERT_SIGNER_NOT_FOUND)
383 {
384 /* NB: already cleared if cert in cache */
385 *certerr |= CERTERR_NOTTRUSTED;
386 certstat ^= GNUTLS_CERT_SIGNER_NOT_FOUND;
387 }
388
389 if (certstat & GNUTLS_CERT_SIGNER_NOT_CA)
390 {
391 /* NB: already cleared if cert in cache */
392 *certerr |= CERTERR_SIGNERNOTCA;
393 certstat ^= GNUTLS_CERT_SIGNER_NOT_CA;
394 }
395
396 if (certstat & GNUTLS_CERT_INSECURE_ALGORITHM)
397 {
398 /* NB: already cleared if cert in cache */
399 *certerr |= CERTERR_INSECUREALG;
400 certstat ^= GNUTLS_CERT_INSECURE_ALGORITHM;
401 }
402
403 /* we've been zeroing the interesting bits in certstat -
404 * don't return OK if there are any unhandled bits we don't
405 * understand */
406 if (certstat != 0)
407 *certerr |= CERTERR_OTHER;
408
409 gnutls_x509_crt_deinit(cert);
410
411 if (*certerr == CERTERR_VALID)
412 return 0;
413
414 return -1;
415}
416
424static void add_cert(const char *title, gnutls_x509_crt_t cert, bool issuer,
425 struct CertArray *carr)
426{
427 static const char *part[] = {
428 GNUTLS_OID_X520_COMMON_NAME, // CN
429 GNUTLS_OID_PKCS9_EMAIL, // Email
430 GNUTLS_OID_X520_ORGANIZATION_NAME, // O
431 GNUTLS_OID_X520_ORGANIZATIONAL_UNIT_NAME, // OU
432 GNUTLS_OID_X520_LOCALITY_NAME, // L
433 GNUTLS_OID_X520_STATE_OR_PROVINCE_NAME, // ST
434 GNUTLS_OID_X520_COUNTRY_NAME, // C
435 };
436
437 char buf[128] = { 0 };
438 int rc;
439
440 // Allocate formatted strings and let the array take ownership
441 ARRAY_ADD(carr, mutt_str_dup(title));
442
443 for (size_t i = 0; i < mutt_array_size(part); i++)
444 {
445 size_t buflen = sizeof(buf);
446 if (issuer)
447 rc = gnutls_x509_crt_get_issuer_dn_by_oid(cert, part[i], 0, 0, buf, &buflen);
448 else
449 rc = gnutls_x509_crt_get_dn_by_oid(cert, part[i], 0, 0, buf, &buflen);
450 if (rc != 0)
451 continue;
452
453 char *line = NULL;
454 mutt_str_asprintf(&line, " %s", buf);
455 ARRAY_ADD(carr, line);
456 }
457}
458
469static int tls_check_one_certificate(const gnutls_datum_t *certdata,
470 gnutls_certificate_status_t certstat,
471 const char *hostname, int idx, size_t len)
472{
473 struct CertArray carr = ARRAY_HEAD_INITIALIZER;
474 int certerr, savedcert;
475 gnutls_x509_crt_t cert;
476 struct Buffer *fpbuf = NULL;
477 time_t t;
478 char datestr[30] = { 0 };
479 char title[256] = { 0 };
480 gnutls_datum_t pemdata = { 0 };
481
482 if (tls_check_preauth(certdata, certstat, hostname, idx, &certerr, &savedcert) == 0)
483 return 1;
484
485 if (OptNoCurses)
486 {
487 mutt_debug(LL_DEBUG1, "unable to prompt for certificate in batch mode\n");
488 mutt_error(_("Untrusted server certificate"));
489 return 0;
490 }
491
492 /* interactive check from user */
493 if (gnutls_x509_crt_init(&cert) < 0)
494 {
495 mutt_error(_("Error initialising gnutls certificate data"));
496 return 0;
497 }
498
499 if (gnutls_x509_crt_import(cert, certdata, GNUTLS_X509_FMT_DER) < 0)
500 {
501 mutt_error(_("Error processing certificate data"));
502 gnutls_x509_crt_deinit(cert);
503 return 0;
504 }
505
506 add_cert(_("This certificate belongs to:"), cert, false, &carr);
507 ARRAY_ADD(&carr, NULL);
508 add_cert(_("This certificate was issued by:"), cert, true, &carr);
509
510 ARRAY_ADD(&carr, NULL);
511 ARRAY_ADD(&carr, mutt_str_dup(_("This certificate is valid")));
512
513 char *line = NULL;
514 t = gnutls_x509_crt_get_activation_time(cert);
515 mutt_date_make_tls(datestr, sizeof(datestr), t);
516 mutt_str_asprintf(&line, _(" from %s"), datestr);
517 ARRAY_ADD(&carr, line);
518
519 t = gnutls_x509_crt_get_expiration_time(cert);
520 mutt_date_make_tls(datestr, sizeof(datestr), t);
521 mutt_str_asprintf(&line, _(" to %s"), datestr);
522 ARRAY_ADD(&carr, line);
523 ARRAY_ADD(&carr, NULL);
524
525 fpbuf = buf_pool_get();
526 tls_fingerprint(GNUTLS_DIG_SHA, fpbuf, certdata);
527 mutt_str_asprintf(&line, _("SHA1 Fingerprint: %s"), buf_string(fpbuf));
528 ARRAY_ADD(&carr, line);
529
530 tls_fingerprint(GNUTLS_DIG_SHA256, fpbuf, certdata);
531 fpbuf->data[39] = '\0'; // Divide into two lines of output
532 mutt_str_asprintf(&line, "%s%s", _("SHA256 Fingerprint: "), buf_string(fpbuf));
533 ARRAY_ADD(&carr, line);
534 mutt_str_asprintf(&line, "%*s%s", (int) mutt_str_len(_("SHA256 Fingerprint: ")),
535 "", fpbuf->data + 40);
536 ARRAY_ADD(&carr, line);
537
538 if (certerr)
539 ARRAY_ADD(&carr, NULL);
540
541 if (certerr & CERTERR_NOTYETVALID)
542 {
543 ARRAY_ADD(&carr, mutt_str_dup(_("WARNING: Server certificate is not yet valid")));
544 }
545 if (certerr & CERTERR_EXPIRED)
546 {
547 ARRAY_ADD(&carr, mutt_str_dup(_("WARNING: Server certificate has expired")));
548 }
549 if (certerr & CERTERR_REVOKED)
550 {
551 ARRAY_ADD(&carr, mutt_str_dup(_("WARNING: Server certificate has been revoked")));
552 }
553 if (certerr & CERTERR_HOSTNAME)
554 {
555 ARRAY_ADD(&carr, mutt_str_dup(_("WARNING: Server hostname does not match certificate")));
556 }
557 if (certerr & CERTERR_SIGNERNOTCA)
558 {
559 ARRAY_ADD(&carr, mutt_str_dup(_("WARNING: Signer of server certificate is not a CA")));
560 }
561 if (certerr & CERTERR_INSECUREALG)
562 {
563 ARRAY_ADD(&carr, mutt_str_dup(_("Warning: Server certificate was signed using an insecure algorithm")));
564 }
565
566 snprintf(title, sizeof(title),
567 _("SSL Certificate check (certificate %zu of %zu in chain)"), len - idx, len);
568
569 const char *const c_certificate_file = cs_subset_path(NeoMutt->sub, "certificate_file");
570 const bool allow_always = (c_certificate_file && !savedcert &&
572 int rc = dlg_certificate(title, &carr, allow_always, false);
573 if (rc == 3) // Accept always
574 {
575 bool saved = false;
576 FILE *fp = mutt_file_fopen(c_certificate_file, "a");
577 if (fp)
578 {
579 if (certerr & CERTERR_HOSTNAME) // Save hostname if necessary
580 {
581 buf_reset(fpbuf);
582 tls_fingerprint(GNUTLS_DIG_MD5, fpbuf, certdata);
583 fprintf(fp, "#H %s %s\n", hostname, buf_string(fpbuf));
584 saved = true;
585 }
586 if (certerr ^ CERTERR_HOSTNAME) // Save the cert for all other errors
587 {
588 int rc2 = gnutls_pem_base64_encode_alloc("CERTIFICATE", certdata, &pemdata);
589 if (rc2 == 0)
590 {
591 if (fwrite(pemdata.data, pemdata.size, 1, fp) == 1)
592 {
593 saved = true;
594 }
595 gnutls_free(pemdata.data);
596 }
597 }
598 mutt_file_fclose(&fp);
599 }
600 if (saved)
601 mutt_message(_("Certificate saved"));
602 else
603 mutt_error(_("Warning: Couldn't save certificate"));
604 }
605
606 buf_pool_release(&fpbuf);
607 cert_array_clear(&carr);
608 ARRAY_FREE(&carr);
609 gnutls_x509_crt_deinit(cert);
610 return (rc > 1);
611}
612
619static int tls_check_certificate(struct Connection *conn)
620{
621 struct TlsSockData *data = conn->sockdata;
622 gnutls_session_t session = data->session;
623 const gnutls_datum_t *cert_list = NULL;
624 unsigned int cert_list_size = 0;
625 gnutls_certificate_status_t certstat;
626 int certerr, savedcert, rc = 0;
627 int max_preauth_pass = -1;
628
629 /* tls_verify_peers() calls gnutls_certificate_verify_peers2(),
630 * which verifies the auth_type is GNUTLS_CRD_CERTIFICATE
631 * and that get_certificate_type() for the server is GNUTLS_CRT_X509.
632 * If it returns 0, certstat will be set with failure codes for the first
633 * cert in the chain(from CA to host) with an error.
634 */
635 if (tls_verify_peers(session, &certstat) != 0)
636 return 0;
637
638 cert_list = gnutls_certificate_get_peers(session, &cert_list_size);
639 if (!cert_list || (cert_list_size == 0))
640 {
641 mutt_error(_("Unable to get certificate from peer"));
642 return 0;
643 }
644
645 /* tls_verify_peers doesn't check hostname or expiration, so walk
646 * from most specific to least checking these. If we see a saved certificate,
647 * its status short-circuits the remaining checks. */
648 int preauthrc = 0;
649 for (int i = 0; i < cert_list_size; i++)
650 {
651 rc = tls_check_preauth(&cert_list[i], certstat, conn->account.host, i,
652 &certerr, &savedcert);
653 preauthrc += rc;
654 if (!preauthrc)
655 max_preauth_pass = i;
656
657 if (savedcert)
658 {
659 if (preauthrc == 0)
660 return 1;
661 break;
662 }
663 }
664
665 /* then check interactively, starting from chain root */
666 for (int i = cert_list_size - 1; i >= 0; i--)
667 {
668 rc = tls_check_one_certificate(&cert_list[i], certstat, conn->account.host,
669 i, cert_list_size);
670
671 /* Stop checking if the menu cert is aborted or rejected. */
672 if (rc == 0)
673 break;
674
675 /* add signers to trust set, then reverify */
676 if (i)
677 {
678 int rcsettrust = gnutls_certificate_set_x509_trust_mem(data->xcred, &cert_list[i],
679 GNUTLS_X509_FMT_DER);
680 if (rcsettrust != 1)
681 mutt_debug(LL_DEBUG1, "error trusting certificate %d: %d\n", i, rcsettrust);
682
683 if (tls_verify_peers(session, &certstat) != 0)
684 return 0;
685
686 /* If the cert chain now verifies, and all lower certs already
687 * passed preauth, we are done. */
688 if (!certstat && (max_preauth_pass >= (i - 1)))
689 return 1;
690 }
691 }
692
693 return rc;
694}
695
703static void tls_get_client_cert(struct Connection *conn)
704{
705 struct TlsSockData *data = conn->sockdata;
706 gnutls_x509_crt_t clientcrt;
707 char *cn = NULL;
708 size_t cnlen = 0;
709 int rc;
710
711 /* get our cert CN if we have one */
712 const gnutls_datum_t *crtdata = gnutls_certificate_get_ours(data->session);
713 if (!crtdata)
714 return;
715
716 if (gnutls_x509_crt_init(&clientcrt) < 0)
717 {
718 mutt_debug(LL_DEBUG1, "Failed to init gnutls crt\n");
719 return;
720 }
721
722 if (gnutls_x509_crt_import(clientcrt, crtdata, GNUTLS_X509_FMT_DER) < 0)
723 {
724 mutt_debug(LL_DEBUG1, "Failed to import gnutls client crt\n");
725 goto err;
726 }
727
728 /* get length of CN, then grab it. */
729 rc = gnutls_x509_crt_get_dn_by_oid(clientcrt, GNUTLS_OID_X520_COMMON_NAME, 0,
730 0, NULL, &cnlen);
731 if (((rc >= 0) || (rc == GNUTLS_E_SHORT_MEMORY_BUFFER)) && (cnlen > 0))
732 {
733 cn = MUTT_MEM_CALLOC(cnlen, char);
734 if (gnutls_x509_crt_get_dn_by_oid(clientcrt, GNUTLS_OID_X520_COMMON_NAME, 0,
735 0, cn, &cnlen) < 0)
736 {
737 goto err;
738 }
739 mutt_debug(LL_DEBUG2, "client certificate CN: %s\n", cn);
740 }
741
742err:
743 FREE(&cn);
744 gnutls_x509_crt_deinit(clientcrt);
745}
746
747#ifdef HAVE_GNUTLS_PRIORITY_SET_DIRECT
754static int tls_set_priority(struct TlsSockData *data)
755{
756 size_t nproto = 5;
757 int rv = -1;
758
759 struct Buffer *priority = buf_pool_get();
760
761 const char *const c_ssl_ciphers = cs_subset_string(NeoMutt->sub, "ssl_ciphers");
762 if (c_ssl_ciphers)
763 buf_strcpy(priority, c_ssl_ciphers);
764 else
765 buf_strcpy(priority, "NORMAL");
766
767 const bool c_ssl_use_tlsv1_3 = cs_subset_bool(NeoMutt->sub, "ssl_use_tlsv1_3");
768 if (!c_ssl_use_tlsv1_3)
769 {
770 nproto--;
771 buf_addstr(priority, ":-VERS-TLS1.3");
772 }
773 const bool c_ssl_use_tlsv1_2 = cs_subset_bool(NeoMutt->sub, "ssl_use_tlsv1_2");
774 if (!c_ssl_use_tlsv1_2)
775 {
776 nproto--;
777 buf_addstr(priority, ":-VERS-TLS1.2");
778 }
779 const bool c_ssl_use_tlsv1_1 = cs_subset_bool(NeoMutt->sub, "ssl_use_tlsv1_1");
780 if (!c_ssl_use_tlsv1_1)
781 {
782 nproto--;
783 buf_addstr(priority, ":-VERS-TLS1.1");
784 }
785 const bool c_ssl_use_tlsv1 = cs_subset_bool(NeoMutt->sub, "ssl_use_tlsv1");
786 if (!c_ssl_use_tlsv1)
787 {
788 nproto--;
789 buf_addstr(priority, ":-VERS-TLS1.0");
790 }
791 const bool c_ssl_use_sslv3 = cs_subset_bool(NeoMutt->sub, "ssl_use_sslv3");
792 if (!c_ssl_use_sslv3)
793 {
794 nproto--;
795 buf_addstr(priority, ":-VERS-SSL3.0");
796 }
797
798 if (nproto == 0)
799 {
800 mutt_error(_("All available protocols for TLS/SSL connection disabled"));
801 goto cleanup;
802 }
803
804 int err = gnutls_priority_set_direct(data->session, buf_string(priority), NULL);
805 if (err < 0)
806 {
807 mutt_error("gnutls_priority_set_direct(%s): %s", buf_string(priority),
808 gnutls_strerror(err));
809 goto cleanup;
810 }
811
812 rv = 0;
813
814cleanup:
815 buf_pool_release(&priority);
816 return rv;
817}
818
819#else
827{
828 size_t nproto = 0; /* number of tls/ssl protocols */
829
830 const bool c_ssl_use_tlsv1_2 = cs_subset_bool(NeoMutt->sub, "ssl_use_tlsv1_2");
831 if (c_ssl_use_tlsv1_2)
832 ProtocolPriority[nproto++] = GNUTLS_TLS1_2;
833 const bool c_ssl_use_tlsv1_1 = cs_subset_bool(NeoMutt->sub, "ssl_use_tlsv1_1");
834 if (c_ssl_use_tlsv1_1)
835 ProtocolPriority[nproto++] = GNUTLS_TLS1_1;
836 const bool c_ssl_use_tlsv1 = cs_subset_bool(NeoMutt->sub, "ssl_use_tlsv1");
837 if (c_ssl_use_tlsv1)
838 ProtocolPriority[nproto++] = GNUTLS_TLS1;
839 const bool c_ssl_use_sslv3 = cs_subset_bool(NeoMutt->sub, "ssl_use_sslv3");
840 if (c_ssl_use_sslv3)
841 ProtocolPriority[nproto++] = GNUTLS_SSL3;
842 ProtocolPriority[nproto] = 0;
843
844 if (nproto == 0)
845 {
846 mutt_error(_("All available protocols for TLS/SSL connection disabled"));
847 return -1;
848 }
849
850 const char *const c_ssl_ciphers = cs_subset_string(NeoMutt->sub, "ssl_ciphers");
851 if (c_ssl_ciphers)
852 {
853 mutt_error(_("Explicit ciphersuite selection via $ssl_ciphers not supported"));
854 }
855
856 /* We use default priorities (see gnutls documentation),
857 * except for protocol version */
858 gnutls_set_default_priority(data->session);
860 return 0;
861}
862#endif
863
873static int tls_negotiate(struct Connection *conn)
874{
875 struct TlsSockData *data = MUTT_MEM_CALLOC(1, struct TlsSockData);
876 conn->sockdata = data;
877 int err = gnutls_certificate_allocate_credentials(&data->xcred);
878 if (err < 0)
879 {
880 FREE(&conn->sockdata);
881 mutt_error("gnutls_certificate_allocate_credentials: %s", gnutls_strerror(err));
882 return -1;
883 }
884
885 const char *const c_certificate_file = cs_subset_path(NeoMutt->sub, "certificate_file");
886 gnutls_certificate_set_x509_trust_file(data->xcred, c_certificate_file, GNUTLS_X509_FMT_PEM);
887 /* ignore errors, maybe file doesn't exist yet */
888
889 const char *const c_ssl_ca_certificates_file = cs_subset_path(NeoMutt->sub, "ssl_ca_certificates_file");
890 if (c_ssl_ca_certificates_file)
891 {
892 gnutls_certificate_set_x509_trust_file(data->xcred, c_ssl_ca_certificates_file,
893 GNUTLS_X509_FMT_PEM);
894 }
895
896 const char *const c_ssl_client_cert = cs_subset_path(NeoMutt->sub, "ssl_client_cert");
897 if (c_ssl_client_cert)
898 {
899 mutt_debug(LL_DEBUG2, "Using client certificate %s\n", c_ssl_client_cert);
900 gnutls_certificate_set_x509_key_file(data->xcred, c_ssl_client_cert,
901 c_ssl_client_cert, GNUTLS_X509_FMT_PEM);
902 }
903
904#ifdef HAVE_DECL_GNUTLS_VERIFY_DISABLE_TIME_CHECKS
905 /* disable checking certificate activation/expiration times
906 * in gnutls, we do the checks ourselves */
907 gnutls_certificate_set_verify_flags(data->xcred, GNUTLS_VERIFY_DISABLE_TIME_CHECKS);
908#endif
909
910 err = gnutls_init(&data->session, GNUTLS_CLIENT);
911 if (err)
912 {
913 mutt_error("gnutls_init: %s", gnutls_strerror(err));
914 goto fail;
915 }
916
917 /* set socket */
918 gnutls_transport_set_ptr(data->session, (gnutls_transport_ptr_t) (long) conn->fd);
919
920 if (gnutls_server_name_set(data->session, GNUTLS_NAME_DNS, conn->account.host,
921 mutt_str_len(conn->account.host)))
922 {
923 mutt_error(_("Warning: unable to set TLS SNI host name"));
924 }
925
926 if (tls_set_priority(data) < 0)
927 {
928 goto fail;
929 }
930
931 const short c_ssl_min_dh_prime_bits = cs_subset_number(NeoMutt->sub, "ssl_min_dh_prime_bits");
932 if (c_ssl_min_dh_prime_bits > 0)
933 {
934 gnutls_dh_set_prime_bits(data->session, c_ssl_min_dh_prime_bits);
935 }
936
937 gnutls_credentials_set(data->session, GNUTLS_CRD_CERTIFICATE, data->xcred);
938
939 do
940 {
941 err = gnutls_handshake(data->session);
942 } while ((err == GNUTLS_E_AGAIN) || (err == GNUTLS_E_INTERRUPTED));
943
944 if (err < 0)
945 {
946 if (err == GNUTLS_E_FATAL_ALERT_RECEIVED)
947 {
948 mutt_error("gnutls_handshake: %s(%s)", gnutls_strerror(err),
949 gnutls_alert_get_name(gnutls_alert_get(data->session)));
950 }
951 else
952 {
953 mutt_error("gnutls_handshake: %s", gnutls_strerror(err));
954 }
955 goto fail;
956 }
957
958 if (tls_check_certificate(conn) == 0)
959 goto fail;
960
961 /* set Security Strength Factor (SSF) for SASL */
962 /* NB: gnutls_cipher_get_key_size() returns key length in bytes */
963 conn->ssf = gnutls_cipher_get_key_size(gnutls_cipher_get(data->session)) * 8;
964
966
967 if (!OptNoCurses)
968 {
969 mutt_message(_("SSL/TLS connection using %s (%s/%s/%s)"),
970 gnutls_protocol_get_name(gnutls_protocol_get_version(data->session)),
971 gnutls_kx_get_name(gnutls_kx_get(data->session)),
972 gnutls_cipher_get_name(gnutls_cipher_get(data->session)),
973 gnutls_mac_get_name(gnutls_mac_get(data->session)));
974 mutt_sleep(0);
975 }
976
977 return 0;
978
979fail:
980 gnutls_certificate_free_credentials(data->xcred);
981 gnutls_deinit(data->session);
982 FREE(&conn->sockdata);
983 return -1;
984}
985
989static int tls_socket_poll(struct Connection *conn, time_t wait_secs)
990{
991 struct TlsSockData *data = conn->sockdata;
992 if (!data)
993 return -1;
994
995 if (gnutls_record_check_pending(data->session))
996 return 1;
997
998 return raw_socket_poll(conn, wait_secs);
999}
1000
1004static int tls_socket_close(struct Connection *conn)
1005{
1006 struct TlsSockData *data = conn->sockdata;
1007 if (data)
1008 {
1009 /* shut down only the write half to avoid hanging waiting for the remote to respond.
1010 *
1011 * RFC5246 7.2.1. "Closure Alerts"
1012 *
1013 * It is not required for the initiator of the close to wait for the
1014 * responding close_notify alert before closing the read side of the
1015 * connection. */
1016 gnutls_bye(data->session, GNUTLS_SHUT_WR);
1017
1018 gnutls_certificate_free_credentials(data->xcred);
1019 gnutls_deinit(data->session);
1020 FREE(&conn->sockdata);
1021 }
1022
1023 return raw_socket_close(conn);
1024}
1025
1029static int tls_socket_open(struct Connection *conn)
1030{
1031 if (raw_socket_open(conn) < 0)
1032 return -1;
1033
1034 if (tls_negotiate(conn) < 0)
1035 {
1036 tls_socket_close(conn);
1037 return -1;
1038 }
1039
1040 return 0;
1041}
1042
1046static int tls_socket_read(struct Connection *conn, char *buf, size_t count)
1047{
1048 struct TlsSockData *data = conn->sockdata;
1049 if (!data)
1050 {
1051 mutt_error(_("Error: no TLS socket open"));
1052 return -1;
1053 }
1054
1055 int rc;
1056 do
1057 {
1058 rc = gnutls_record_recv(data->session, buf, count);
1059 } while ((rc == GNUTLS_E_AGAIN) || (rc == GNUTLS_E_INTERRUPTED));
1060
1061 if (rc < 0)
1062 {
1063 mutt_error("tls_socket_read (%s)", gnutls_strerror(rc));
1064 return -1;
1065 }
1066
1067 return rc;
1068}
1069
1073static int tls_socket_write(struct Connection *conn, const char *buf, size_t count)
1074{
1075 struct TlsSockData *data = conn->sockdata;
1076 size_t sent = 0;
1077
1078 if (!data)
1079 {
1080 mutt_error(_("Error: no TLS socket open"));
1081 return -1;
1082 }
1083
1084 do
1085 {
1086 int rc;
1087 do
1088 {
1089 rc = gnutls_record_send(data->session, buf + sent, count - sent);
1090 } while ((rc == GNUTLS_E_AGAIN) || (rc == GNUTLS_E_INTERRUPTED));
1091
1092 if (rc < 0)
1093 {
1094 mutt_error("tls_socket_write (%s)", gnutls_strerror(rc));
1095 return -1;
1096 }
1097
1098 sent += rc;
1099 } while (sent < count);
1100
1101 return sent;
1102}
1103
1107static int tls_starttls_close(struct Connection *conn)
1108{
1109 int rc;
1110
1111 rc = tls_socket_close(conn);
1112 conn->read = raw_socket_read;
1113 conn->write = raw_socket_write;
1114 conn->close = raw_socket_close;
1115 conn->poll = raw_socket_poll;
1116
1117 return rc;
1118}
1119
1127{
1128 if (tls_init() < 0)
1129 return -1;
1130
1131 conn->open = tls_socket_open;
1132 conn->read = tls_socket_read;
1133 conn->write = tls_socket_write;
1134 conn->close = tls_socket_close;
1135 conn->poll = tls_socket_poll;
1136
1137 return 0;
1138}
1139
1147{
1148 if (tls_init() < 0)
1149 return -1;
1150
1151 if (tls_negotiate(conn) < 0)
1152 return -1;
1153
1154 conn->read = tls_socket_read;
1155 conn->write = tls_socket_write;
1156 conn->close = tls_starttls_close;
1157 conn->poll = tls_socket_poll;
1158
1159 return 0;
1160}
#define ARRAY_ADD(head, elem)
Add an element at the end of the array.
Definition: array.h:156
#define ARRAY_FREE(head)
Release all memory.
Definition: array.h:204
#define ARRAY_HEAD_INITIALIZER
Static initializer for arrays.
Definition: array.h:58
int buf_add_printf(struct Buffer *buf, const char *fmt,...)
Format a string appending a Buffer.
Definition: buffer.c:204
void buf_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition: buffer.c:76
size_t buf_addch(struct Buffer *buf, char c)
Add a single character to a Buffer.
Definition: buffer.c:241
size_t buf_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition: buffer.c:226
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:395
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:96
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition: helpers.c:291
short cs_subset_number(const struct ConfigSubset *sub, const char *name)
Get a number config item by name.
Definition: helpers.c:143
const char * cs_subset_path(const struct ConfigSubset *sub, const char *name)
Get a path config item by name.
Definition: helpers.c:168
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:47
Convenience wrapper for the config headers.
Connection Credentials.
An open network connection (socket)
Convenience wrapper for the core headers.
void cert_array_clear(struct CertArray *carr)
Free all memory of a CertArray.
char * mutt_file_read_line(char *line, size_t *size, FILE *fp, int *line_num, ReadLineFlags flags)
Read a line from a file.
Definition: file.c:808
#define mutt_file_fclose(FP)
Definition: file.h:138
#define mutt_file_fopen(PATH, MODE)
Definition: file.h:137
#define MUTT_RL_NO_FLAGS
No flags are set.
Definition: file.h:40
bool OptNoCurses
(pseudo) when sending in batch mode
Definition: globals.c:69
#define CERTERR_INSECUREALG
Definition: gnutls.c:60
#define CERTERR_VALID
Definition: gnutls.c:53
static int tls_check_preauth(const gnutls_datum_t *certdata, gnutls_certificate_status_t certstat, const char *hostname, int chainidx, int *certerr, int *savedcert)
Prepare a certificate for authentication.
Definition: gnutls.c:312
static int tls_check_certificate(struct Connection *conn)
Check a connection's certificate.
Definition: gnutls.c:619
#define CERTERR_HOSTNAME
Definition: gnutls.c:58
#define CERTERR_EXPIRED
Definition: gnutls.c:54
int mutt_ssl_starttls(struct Connection *conn)
Negotiate TLS over an already opened connection.
Definition: gnutls.c:1146
#define CERT_SEP
Definition: gnutls.c:64
static bool tls_check_stored_hostname(const gnutls_datum_t *cert, const char *hostname)
Does the hostname match a stored certificate?
Definition: gnutls.c:188
#define CERTERR_NOTTRUSTED
Definition: gnutls.c:57
static int tls_verify_peers(gnutls_session_t tlsstate, gnutls_certificate_status_t *certstat)
Wrapper for gnutls_certificate_verify_peers()
Definition: gnutls.c:122
#define CERTERR_NOTYETVALID
Definition: gnutls.c:55
static int ProtocolPriority[]
This array needs to be large enough to hold all the possible values support by NeoMutt.
Definition: gnutls.c:75
int gnutls_protocol_set_priority(gnutls_session_t session, const int *list)
static int tls_compare_certificates(const gnutls_datum_t *peercert)
Compare certificates against $certificate_file
Definition: gnutls.c:235
static void tls_fingerprint(gnutls_digest_algorithm_t algo, struct Buffer *buf, const gnutls_datum_t *data)
Create a fingerprint of a TLS Certificate.
Definition: gnutls.c:159
static int tls_init(void)
Set up Gnu TLS.
Definition: gnutls.c:92
#define CERTERR_OTHER
Definition: gnutls.c:61
static void tls_get_client_cert(struct Connection *conn)
Get the client certificate for a TLS connection.
Definition: gnutls.c:703
static int tls_check_one_certificate(const gnutls_datum_t *certdata, gnutls_certificate_status_t certstat, const char *hostname, int idx, size_t len)
Check a GnuTLS certificate.
Definition: gnutls.c:469
static int tls_negotiate(struct Connection *conn)
Negotiate TLS connection.
Definition: gnutls.c:873
int mutt_ssl_socket_setup(struct Connection *conn)
Set up SSL socket mulitplexor.
Definition: gnutls.c:1126
#define CERTERR_SIGNERNOTCA
Definition: gnutls.c:59
static void add_cert(const char *title, gnutls_x509_crt_t cert, bool issuer, struct CertArray *carr)
Look up certificate info and save it to a list.
Definition: gnutls.c:424
static int tls_set_priority(struct TlsSockData *data)
Set the priority of various protocols.
Definition: gnutls.c:826
#define CERTERR_REVOKED
Definition: gnutls.c:56
static int tls_starttls_close(struct Connection *conn)
Close a TLS connection - Implements Connection::close() -.
Definition: gnutls.c:1107
static int tls_socket_close(struct Connection *conn)
Close a TLS socket - Implements Connection::close() -.
Definition: gnutls.c:1004
int raw_socket_close(struct Connection *conn)
Close a socket - Implements Connection::close() -.
Definition: raw.c:393
static int tls_socket_open(struct Connection *conn)
Open a TLS socket - Implements Connection::open() -.
Definition: gnutls.c:1029
int raw_socket_open(struct Connection *conn)
Open a socket - Implements Connection::open() -.
Definition: raw.c:148
static int tls_socket_poll(struct Connection *conn, time_t wait_secs)
Check if any data is waiting on a socket - Implements Connection::poll() -.
Definition: gnutls.c:989
int raw_socket_poll(struct Connection *conn, time_t wait_secs)
Check if any data is waiting on a socket - Implements Connection::poll() -.
Definition: raw.c:355
static int tls_socket_read(struct Connection *conn, char *buf, size_t count)
Read data from a TLS socket - Implements Connection::read() -.
Definition: gnutls.c:1046
int raw_socket_read(struct Connection *conn, char *buf, size_t len)
Read data from a socket - Implements Connection::read() -.
Definition: raw.c:295
int raw_socket_write(struct Connection *conn, const char *buf, size_t count)
Write data to a socket - Implements Connection::write() -.
Definition: raw.c:325
static int tls_socket_write(struct Connection *conn, const char *buf, size_t count)
Write data to a TLS socket - Implements Connection::write() -.
Definition: gnutls.c:1073
int dlg_certificate(const char *title, struct CertArray *carr, bool allow_always, bool allow_skip)
Ask the user to validate the certificate -.
#define mutt_error(...)
Definition: logging2.h:92
#define mutt_message(...)
Definition: logging2.h:91
#define mutt_debug(LEVEL,...)
Definition: logging2.h:89
@ LL_DEBUG2
Log at debug level 2.
Definition: logging2.h:44
@ LL_DEBUG1
Log at debug level 1.
Definition: logging2.h:43
#define FREE(x)
Definition: memory.h:55
#define MUTT_MEM_CALLOC(n, type)
Definition: memory.h:40
#define mutt_array_size(x)
Definition: memory.h:38
int mutt_date_make_tls(char *buf, size_t buflen, time_t timestamp)
Format date in TLS certificate verification style.
Definition: date.c:837
time_t mutt_date_now(void)
Return the number of seconds since the Unix epoch.
Definition: date.c:456
Convenience wrapper for the library headers.
#define _(a)
Definition: message.h:28
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:253
int mutt_str_asprintf(char **strp, const char *fmt,...)
Definition: string.c:803
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:660
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition: string.c:496
void mutt_sleep(short s)
Sleep for a while.
Definition: muttlib.c:843
Some miscellaneous functions.
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:82
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:96
regmatch_t * mutt_prex_capture(enum Prex which, const char *str)
Match a precompiled regex against a string.
Definition: prex.c:298
@ PREX_GNUTLS_CERT_HOST_HASH
[#H foo.com A76D 954B EB79 1F49 5B3A 0A0E 0681 65B1]
Definition: prex.h:37
@ PREX_GNUTLS_CERT_HOST_HASH_MATCH_HASH
#H foo.com [A76D ... 65B1]
Definition: prex.h:112
@ PREX_GNUTLS_CERT_HOST_HASH_MATCH_HOST
#H [foo.com] A76D ... 65B1
Definition: prex.h:111
@ MUTT_NO
User answered 'No', or assume 'No'.
Definition: quad.h:38
static regoff_t mutt_regmatch_end(const regmatch_t *match)
Return the end of a match.
Definition: regex3.h:67
static regoff_t mutt_regmatch_start(const regmatch_t *match)
Return the start of a match.
Definition: regex3.h:57
GUI display the mailboxes in a side panel.
Handling of SSL encryption.
Key value store.
String manipulation buffer.
Definition: buffer.h:36
char * data
Pointer to data.
Definition: buffer.h:37
char host[128]
Server to login to.
Definition: connaccount.h:54
void * sockdata
Backend-specific socket data.
Definition: connection.h:55
int(* poll)(struct Connection *conn, time_t wait_secs)
Definition: connection.h:105
int(* write)(struct Connection *conn, const char *buf, size_t count)
Definition: connection.h:92
unsigned int ssf
Security strength factor, in bits (see notes)
Definition: connection.h:50
int(* close)(struct Connection *conn)
Definition: connection.h:116
struct ConnAccount account
Account details: username, password, etc.
Definition: connection.h:49
int(* open)(struct Connection *conn)
Definition: connection.h:66
int fd
Socket file descriptor.
Definition: connection.h:53
int(* read)(struct Connection *conn, char *buf, size_t count)
Definition: connection.h:79
Container for Accounts, Notifications.
Definition: neomutt.h:42
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:46
TLS socket data -.
Definition: gnutls.c:82
gnutls_certificate_credentials_t xcred
Definition: gnutls.c:84
gnutls_session_t session
Definition: gnutls.c:83