libempathy/empathy-tls-verifier.c

   1 /*
   2  * empathy-tls-verifier.c - Source for EmpathyTLSVerifier
   3  * Copyright (C) 2010 Collabora Ltd.
   4  * @author Cosimo Cecchi <cosimo.cecchi@collabora.co.uk>
   5  * @author Stef Walter <stefw@collabora.co.uk>
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20  */
  21
  22 #include <config.h>
  23
  24 #include <gnutls/gnutls.h>
  25 #include <gnutls/x509.h>
  26
  27 #include <telepathy-glib/util.h>
  28
  29 #include "empathy-tls-verifier.h"
  30
  31 #include <gcr/gcr.h>
  32
  33 #define DEBUG_FLAG EMPATHY_DEBUG_TLS
  34 #include "empathy-debug.h"
  35 #include "empathy-utils.h"
  36
  37 G_DEFINE_TYPE (EmpathyTLSVerifier, empathy_tls_verifier,
  38     G_TYPE_OBJECT)
  39
  40 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyTLSVerifier);
  41
  42 enum {
  43   PROP_TLS_CERTIFICATE = 1,
  44   PROP_HOSTNAME,
  45
  46   LAST_PROPERTY,
  47 };
  48
  49 typedef struct {
  50   EmpathyTLSCertificate *certificate;
  51   gchar *hostname;
  52
  53   GSimpleAsyncResult *verify_result;
  54   GHashTable *details;
  55
  56   gboolean dispose_run;
  57 } EmpathyTLSVerifierPriv;
  58
  59 static gboolean
  60 verification_output_to_reason (gint res,
  61     guint verify_output,
  62     EmpTLSCertificateRejectReason *reason)
  63 {
  64   gboolean retval = TRUE;
  65
  66   g_assert (reason != NULL);
  67
  68   if (res != GNUTLS_E_SUCCESS)
  69     {
  70       retval = FALSE;
  71
  72       /* the certificate is not structurally valid */
  73       switch (res)
  74         {
  75         case GNUTLS_E_INSUFFICIENT_CREDENTIALS:
  76           *reason = EMP_TLS_CERTIFICATE_REJECT_REASON_UNTRUSTED;
  77           break;
  78         case GNUTLS_E_CONSTRAINT_ERROR:
  79           *reason = EMP_TLS_CERTIFICATE_REJECT_REASON_LIMIT_EXCEEDED;
  80           break;
  81         default:
  82           *reason = EMP_TLS_CERTIFICATE_REJECT_REASON_UNKNOWN;
  83           break;
  84         }
  85
  86       goto out;
  87     }
  88
  89   /* the certificate is structurally valid, check for other errors. */
  90   if (verify_output & GNUTLS_CERT_INVALID)
  91     {
  92       retval = FALSE;
  93
  94       if (verify_output & GNUTLS_CERT_SIGNER_NOT_FOUND)
  95         *reason = EMP_TLS_CERTIFICATE_REJECT_REASON_SELF_SIGNED;
  96       else if (verify_output & GNUTLS_CERT_SIGNER_NOT_CA)
  97         *reason = EMP_TLS_CERTIFICATE_REJECT_REASON_UNTRUSTED;
  98       else if (verify_output & GNUTLS_CERT_INSECURE_ALGORITHM)
  99         *reason = EMP_TLS_CERTIFICATE_REJECT_REASON_INSECURE;
 100       else if (verify_output & GNUTLS_CERT_NOT_ACTIVATED)
 101         *reason = EMP_TLS_CERTIFICATE_REJECT_REASON_NOT_ACTIVATED;
 102       else if (verify_output & GNUTLS_CERT_EXPIRED)
 103         *reason = EMP_TLS_CERTIFICATE_REJECT_REASON_EXPIRED;
 104       else
 105         *reason = EMP_TLS_CERTIFICATE_REJECT_REASON_UNKNOWN;
 106
 107       goto out;
 108     }
 109
 110  out:
 111   return retval;
 112 }
 113
 114 static void
 115 build_certificate_list_for_gnutls (GcrCertificateChain *chain,
 116         gnutls_x509_crt_t **list,
 117         guint *n_list,
 118         gnutls_x509_crt_t **anchors,
 119         guint *n_anchors)
 120 {
 121   GcrCertificate *cert;
 122   guint idx, length;
 123   gnutls_x509_crt_t *retval;
 124   gnutls_x509_crt_t gcert;
 125   gnutls_datum_t datum;
 126   gsize n_data;
 127
 128   g_assert (list);
 129   g_assert (n_list);
 130   g_assert (anchors);
 131   g_assert (n_anchors);
 132
 133   *list = *anchors = NULL;
 134   *n_list = *n_anchors = 0;
 135
 136   length = gcr_certificate_chain_get_length (chain);
 137   retval = g_malloc0 (sizeof (gnutls_x509_crt_t) * length);
 138
 139   /* Convert the main body of the chain to gnutls */
 140   for (idx = 0; idx < length; ++idx)
 141     {
 142       cert = gcr_certificate_chain_get_certificate (chain, idx);
 143       datum.data = (gpointer)gcr_certificate_get_der_data (cert, &n_data);
 144       datum.size = n_data;
 145
 146       gnutls_x509_crt_init (&gcert);
 147       if (gnutls_x509_crt_import (gcert, &datum, GNUTLS_X509_FMT_DER) < 0)
 148         g_return_if_reached ();
 149
 150       retval[idx] = gcert;
 151     }
 152
 153   *list = retval;
 154   *n_list = length;
 155
 156   /* See if we have an anchor */
 157   if (gcr_certificate_chain_get_status (chain) ==
 158           GCR_CERTIFICATE_CHAIN_ANCHORED)
 159     {
 160       cert = gcr_certificate_chain_get_anchor (chain);
 161       g_return_if_fail (cert);
 162
 163       datum.data = (gpointer)gcr_certificate_get_der_data (cert, &n_data);
 164       datum.size = n_data;
 165
 166       gnutls_x509_crt_init (&gcert);
 167       if (gnutls_x509_crt_import (gcert, &datum, GNUTLS_X509_FMT_DER) < 0)
 168         g_return_if_reached ();
 169
 170       retval = g_malloc0 (sizeof (gnutls_x509_crt_t) * 1);
 171       retval[0] = gcert;
 172       *anchors = retval;
 173       *n_anchors = 1;
 174     }
 175 }
 176
 177 static void
 178 free_certificate_list_for_gnutls (gnutls_x509_crt_t *list,
 179         guint n_list)
 180 {
 181   guint idx;
 182
 183   for (idx = 0; idx < n_list; idx++)
 184     gnutls_x509_crt_deinit (list[idx]);
 185   g_free (list);
 186 }
 187
 188 static void
 189 complete_verification (EmpathyTLSVerifier *self)
 190 {
 191   EmpathyTLSVerifierPriv *priv = GET_PRIV (self);
 192
 193   DEBUG ("Verification successful, completing...");
 194
 195   g_simple_async_result_complete_in_idle (priv->verify_result);
 196
 197   tp_clear_object (&priv->verify_result);
 198 }
 199
 200 static void
 201 abort_verification (EmpathyTLSVerifier *self,
 202     EmpTLSCertificateRejectReason reason)
 203 {
 204   EmpathyTLSVerifierPriv *priv = GET_PRIV (self);
 205
 206   DEBUG ("Verification error %u, aborting...", reason);
 207
 208   g_simple_async_result_set_error (priv->verify_result,
 209       G_IO_ERROR, reason, "TLS verification failed with reason %u",
 210       reason);
 211   g_simple_async_result_complete_in_idle (priv->verify_result);
 212
 213   tp_clear_object (&priv->verify_result);
 214 }
 215
 216 static void
 217 debug_certificate (GcrCertificate *cert)
 218 {
 219     gchar *subject = gcr_certificate_get_subject_dn (cert);
 220     DEBUG ("Certificate: %s", subject);
 221     g_free (subject);
 222 }
 223
 224 static void
 225 debug_certificate_chain (GcrCertificateChain *chain)
 226 {
 227     GEnumClass *enum_class;
 228     GEnumValue *enum_value;
 229     gint idx, length;
 230     GcrCertificate *cert;
 231
 232     enum_class = G_ENUM_CLASS
 233             (g_type_class_peek (GCR_TYPE_CERTIFICATE_CHAIN_STATUS));
 234     enum_value = g_enum_get_value (enum_class,
 235             gcr_certificate_chain_get_status (chain));
 236     length = gcr_certificate_chain_get_length (chain);
 237     DEBUG ("Certificate chain: length %u status %s",
 238             length, enum_value ? enum_value->value_nick : "XXX");
 239
 240     for (idx = 0; idx < length; ++idx)
 241       {
 242         cert = gcr_certificate_chain_get_certificate (chain, idx);
 243         debug_certificate (cert);
 244       }
 245 }
 246
 247 static void
 248 perform_verification (EmpathyTLSVerifier *self,
 249         GcrCertificateChain *chain)
 250 {
 251   gboolean ret = FALSE;
 252   EmpTLSCertificateRejectReason reason =
 253     EMP_TLS_CERTIFICATE_REJECT_REASON_UNKNOWN;
 254   gnutls_x509_crt_t *list, *anchors;
 255   guint n_list, n_anchors;
 256   guint verify_output;
 257   gint res;
 258   EmpathyTLSVerifierPriv *priv = GET_PRIV (self);
 259
 260   DEBUG ("Performing verification");
 261   debug_certificate_chain (chain);
 262
 263   /*
 264    * If the first certificate is an pinned certificate then we completely
 265    * ignore the rest of the verification process.
 266    */
 267   if (gcr_certificate_chain_get_status (chain) == GCR_CERTIFICATE_CHAIN_PINNED)
 268     {
 269       DEBUG ("Found pinned certificate for %s", priv->hostname);
 270       complete_verification (self);
 271       goto out;
 272   }
 273
 274   build_certificate_list_for_gnutls (chain, &list, &n_list,
 275           &anchors, &n_anchors);
 276   if (list == NULL || n_list == 0) {
 277       g_warn_if_reached ();
 278       abort_verification (self, EMP_TLS_CERTIFICATE_REJECT_REASON_UNKNOWN);
 279       goto out;
 280   }
 281
 282   verify_output = 0;
 283   res = gnutls_x509_crt_list_verify (list, n_list, anchors, n_anchors,
 284            NULL, 0, 0, &verify_output);
 285   ret = verification_output_to_reason (res, verify_output, &reason);
 286
 287   DEBUG ("Certificate verification gave result %d with reason %u", ret,
 288           reason);
 289
 290   if (!ret) {
 291       abort_verification (self, reason);
 292       goto out;
 293   }
 294
 295   /* now check if the certificate matches the hostname. */
 296   if (gnutls_x509_crt_check_hostname (list[0], priv->hostname) == 0)
 297     {
 298       gchar *certified_hostname;
 299
 300       certified_hostname = empathy_get_x509_certificate_hostname (list[0]);
 301       tp_asv_set_string (priv->details,
 302           "expected-hostname", priv->hostname);
 303       tp_asv_set_string (priv->details,
 304           "certificate-hostname", certified_hostname);
 305
 306       DEBUG ("Hostname mismatch: got %s but expected %s",
 307           certified_hostname, priv->hostname);
 308
 309       g_free (certified_hostname);
 310       abort_verification (self,
 311               EMP_TLS_CERTIFICATE_REJECT_REASON_HOSTNAME_MISMATCH);
 312       goto out;
 313     }
 314
 315   DEBUG ("Hostname matched");
 316   complete_verification (self);
 317
 318  out:
 319   free_certificate_list_for_gnutls (list, n_list);
 320   free_certificate_list_for_gnutls (anchors, n_anchors);
 321 }
 322
 323 static void
 324 perform_verification_cb (GObject *object,
 325         GAsyncResult *res,
 326         gpointer user_data)
 327 {
 328   GError *error = NULL;
 329
 330   GcrCertificateChain *chain = GCR_CERTIFICATE_CHAIN (object);
 331   EmpathyTLSVerifier *self = EMPATHY_TLS_VERIFIER (user_data);
 332
 333   /* Even if building the chain fails, try verifying what we have */
 334   if (!gcr_certificate_chain_build_finish (chain, res, &error))
 335     {
 336       DEBUG ("Building of certificate chain failed: %s", error->message);
 337       g_clear_error (&error);
 338     }
 339
 340   perform_verification (self, chain);
 341
 342   /* Matches ref when staring chain build */
 343   g_object_unref (self);
 344 }
 345
 346 static void
 347 empathy_tls_verifier_get_property (GObject *object,
 348     guint property_id,
 349     GValue *value,
 350     GParamSpec *pspec)
 351 {
 352   EmpathyTLSVerifierPriv *priv = GET_PRIV (object);
 353
 354   switch (property_id)
 355     {
 356     case PROP_TLS_CERTIFICATE:
 357       g_value_set_object (value, priv->certificate);
 358       break;
 359     case PROP_HOSTNAME:
 360       g_value_set_string (value, priv->hostname);
 361       break;
 362     default:
 363       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
 364       break;
 365     }
 366 }
 367
 368 static void
 369 empathy_tls_verifier_set_property (GObject *object,
 370     guint property_id,
 371     const GValue *value,
 372     GParamSpec *pspec)
 373 {
 374   EmpathyTLSVerifierPriv *priv = GET_PRIV (object);
 375
 376   switch (property_id)
 377     {
 378     case PROP_TLS_CERTIFICATE:
 379       priv->certificate = g_value_dup_object (value);
 380       break;
 381     case PROP_HOSTNAME:
 382       priv->hostname = g_value_dup_string (value);
 383       break;
 384     default:
 385       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
 386       break;
 387     }
 388 }
 389
 390 static void
 391 empathy_tls_verifier_dispose (GObject *object)
 392 {
 393   EmpathyTLSVerifierPriv *priv = GET_PRIV (object);
 394
 395   if (priv->dispose_run)
 396     return;
 397
 398   priv->dispose_run = TRUE;
 399
 400   tp_clear_object (&priv->certificate);
 401
 402   G_OBJECT_CLASS (empathy_tls_verifier_parent_class)->dispose (object);
 403 }
 404
 405 static void
 406 empathy_tls_verifier_finalize (GObject *object)
 407 {
 408   EmpathyTLSVerifierPriv *priv = GET_PRIV (object);
 409
 410   DEBUG ("%p", object);
 411
 412   tp_clear_boxed (G_TYPE_HASH_TABLE, &priv->details);
 413   g_free (priv->hostname);
 414
 415   G_OBJECT_CLASS (empathy_tls_verifier_parent_class)->finalize (object);
 416 }
 417
 418 static void
 419 empathy_tls_verifier_init (EmpathyTLSVerifier *self)
 420 {
 421   EmpathyTLSVerifierPriv *priv;
 422
 423   priv = self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
 424       EMPATHY_TYPE_TLS_VERIFIER, EmpathyTLSVerifierPriv);
 425   priv->details = tp_asv_new (NULL, NULL);
 426 }
 427
 428 static void
 429 empathy_tls_verifier_class_init (EmpathyTLSVerifierClass *klass)
 430 {
 431   GParamSpec *pspec;
 432   GObjectClass *oclass = G_OBJECT_CLASS (klass);
 433
 434   g_type_class_add_private (klass, sizeof (EmpathyTLSVerifierPriv));
 435
 436   oclass->set_property = empathy_tls_verifier_set_property;
 437   oclass->get_property = empathy_tls_verifier_get_property;
 438   oclass->finalize = empathy_tls_verifier_finalize;
 439   oclass->dispose = empathy_tls_verifier_dispose;
 440
 441   pspec = g_param_spec_object ("certificate", "The EmpathyTLSCertificate",
 442       "The EmpathyTLSCertificate to be verified.",
 443       EMPATHY_TYPE_TLS_CERTIFICATE,
 444       G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
 445   g_object_class_install_property (oclass, PROP_TLS_CERTIFICATE, pspec);
 446
 447   pspec = g_param_spec_string ("hostname", "The hostname",
 448       "The hostname which should be certified by the certificate.",
 449       NULL,
 450       G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
 451   g_object_class_install_property (oclass, PROP_HOSTNAME, pspec);
 452 }
 453
 454 EmpathyTLSVerifier *
 455 empathy_tls_verifier_new (EmpathyTLSCertificate *certificate,
 456     const gchar *hostname)
 457 {
 458   g_assert (EMPATHY_IS_TLS_CERTIFICATE (certificate));
 459   g_assert (hostname != NULL);
 460
 461   return g_object_new (EMPATHY_TYPE_TLS_VERIFIER,
 462       "certificate", certificate,
 463       "hostname", hostname,
 464       NULL);
 465 }
 466
 467 void
 468 empathy_tls_verifier_verify_async (EmpathyTLSVerifier *self,
 469     GAsyncReadyCallback callback,
 470     gpointer user_data)
 471 {
 472   GcrCertificateChain *chain;
 473   GcrCertificate *cert;
 474   GPtrArray *cert_data = NULL;
 475   GArray *data;
 476   guint idx;
 477   EmpathyTLSVerifierPriv *priv = GET_PRIV (self);
 478
 479   DEBUG ("Starting verification");
 480
 481   g_return_if_fail (priv->verify_result == NULL);
 482
 483   g_object_get (priv->certificate, "cert-data", &cert_data, NULL);
 484   g_return_if_fail (cert_data);
 485
 486   priv->verify_result = g_simple_async_result_new (G_OBJECT (self),
 487       callback, user_data, NULL);
 488
 489   /* Create a certificate chain */
 490   chain = gcr_certificate_chain_new ();
 491   for (idx = 0; idx < cert_data->len; ++idx) {
 492     data = g_ptr_array_index (cert_data, idx);
 493     cert = gcr_simple_certificate_new (data->data, data->len);
 494     gcr_certificate_chain_add (chain, cert);
 495     g_object_unref (cert);
 496   }
 497
 498   gcr_certificate_chain_build_async (chain, GCR_PURPOSE_CLIENT_AUTH, priv->hostname, 0,
 499           NULL, perform_verification_cb, g_object_ref (self));
 500
 501   g_object_unref (chain);
 502   g_boxed_free (TP_ARRAY_TYPE_UCHAR_ARRAY_LIST, cert_data);
 503 }
 504
 505 gboolean
 506 empathy_tls_verifier_verify_finish (EmpathyTLSVerifier *self,
 507     GAsyncResult *res,
 508     EmpTLSCertificateRejectReason *reason,
 509     GHashTable **details,
 510     GError **error)
 511 {
 512   EmpathyTLSVerifierPriv *priv = GET_PRIV (self);
 513
 514   if (g_simple_async_result_propagate_error (G_SIMPLE_ASYNC_RESULT (res),
 515           error))
 516     {
 517       if (reason != NULL)
 518         *reason = (*error)->code;
 519
 520       if (details != NULL)
 521         {
 522           *details = tp_asv_new (NULL, NULL);
 523           tp_g_hash_table_update (*details, priv->details,
 524               (GBoxedCopyFunc) g_strdup,
 525               (GBoxedCopyFunc) tp_g_value_slice_dup);
 526         }
 527
 528       return FALSE;
 529     }
 530
 531   if (reason != NULL)
 532     *reason = EMP_TLS_CERTIFICATE_REJECT_REASON_UNKNOWN;
 533
 534   return TRUE;
 535 }
 536
 537 void
 538 empathy_tls_verifier_store_exception (EmpathyTLSVerifier *self)
 539 {
 540   GArray *data;
 541   GcrCertificate *cert;
 542   GPtrArray *cert_data = NULL;
 543   GError *error = NULL;
 544   EmpathyTLSVerifierPriv *priv = GET_PRIV (self);
 545
 546   g_object_get (priv->certificate, "cert-data", &cert_data, NULL);
 547   g_return_if_fail (cert_data);
 548
 549   if (!cert_data->len)
 550     {
 551       DEBUG ("No certificate to pin.");
 552       return;
 553     }
 554
 555   /* The first certificate in the chain is for the host */
 556   data = g_ptr_array_index (cert_data, 0);
 557   cert = gcr_simple_certificate_new ((gpointer)data->data, data->len);
 558
 559   DEBUG ("Storing pinned certificate:");
 560   debug_certificate (cert);
 561
 562   if (!gcr_trust_add_pinned_certificate (cert, GCR_PURPOSE_CLIENT_AUTH,
 563           priv->hostname, NULL, &error))
 564       DEBUG ("Can't store the pinned certificate: %s", error->message);
 565
 566   g_object_unref (cert);
 567   g_boxed_free (TP_ARRAY_TYPE_UCHAR_ARRAY_LIST, cert_data);
 568 }