git.sesse.net Git - vlc/blob - modules/misc/gnutls.c

   1 /*****************************************************************************
   2  * gnutls.c
   3  *****************************************************************************
   4  * Copyright (C) 2004-2006 Rémi Denis-Courmont
   5  * $Id$
   6  *
   7  * Authors: Rémi Denis-Courmont <rem # videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc/vlc.h>
  33 #include <errno.h>
  34 #include <time.h>
  35
  36 #include <sys/types.h>
  37 #include <errno.h>
  38 #ifdef HAVE_DIRENT_H
  39 # include <dirent.h>
  40 #endif
  41 #ifdef HAVE_SYS_STAT_H
  42 # include <sys/stat.h>
  43 # ifdef HAVE_UNISTD_H
  44 #  include <unistd.h>
  45 # endif
  46 #endif
  47
  48
  49 #include <vlc_tls.h>
  50 #include <vlc_charset.h>
  51
  52 #include <gcrypt.h>
  53 #include <gnutls/gnutls.h>
  54 #include <gnutls/x509.h>
  55
  56 #include <vlc_gcrypt.h>
  57
  58 #define CACHE_TIMEOUT     3600
  59 #define CACHE_SIZE          64
  60
  61 #include "dhparams.h"
  62
  63 /*****************************************************************************
  64  * Module descriptor
  65  *****************************************************************************/
  66 static int  OpenClient  (vlc_object_t *);
  67 static void CloseClient (vlc_object_t *);
  68 static int  OpenServer  (vlc_object_t *);
  69 static void CloseServer (vlc_object_t *);
  70
  71 #define CACHE_TIMEOUT_TEXT N_("Expiration time for resumed TLS sessions")
  72 #define CACHE_TIMEOUT_LONGTEXT N_( \
  73     "It is possible to cache the resumed TLS sessions. This is the expiration "\
  74     "time of the sessions stored in this cache, in seconds." )
  75
  76 #define CACHE_SIZE_TEXT N_("Number of resumed TLS sessions")
  77 #define CACHE_SIZE_LONGTEXT N_( \
  78     "This is the maximum number of resumed TLS sessions that " \
  79     "the cache will hold." )
  80
  81 vlc_module_begin();
  82     set_shortname( "GnuTLS" );
  83     set_description( _("GnuTLS transport layer security") );
  84     set_capability( "tls client", 1 );
  85     set_callbacks( OpenClient, CloseClient );
  86     set_category( CAT_ADVANCED );
  87     set_subcategory( SUBCAT_ADVANCED_MISC );
  88
  89     add_obsolete_bool( "tls-check-cert" );
  90     add_obsolete_bool( "tls-check-hostname" );
  91
  92     add_submodule();
  93         set_description( _("GnuTLS server") );
  94         set_capability( "tls server", 1 );
  95         set_category( CAT_ADVANCED );
  96         set_subcategory( SUBCAT_ADVANCED_MISC );
  97         set_callbacks( OpenServer, CloseServer );
  98
  99         add_obsolete_integer( "gnutls-dh-bits" );
 100         add_integer( "gnutls-cache-timeout", CACHE_TIMEOUT, NULL,
 101                     CACHE_TIMEOUT_TEXT, CACHE_TIMEOUT_LONGTEXT, true );
 102         add_integer( "gnutls-cache-size", CACHE_SIZE, NULL, CACHE_SIZE_TEXT,
 103                     CACHE_SIZE_LONGTEXT, true );
 104 vlc_module_end();
 105
 106 /**
 107  * Initializes GnuTLS with proper locking.
 108  * @return VLC_SUCCESS on success, a VLC error code otherwise.
 109  */
 110 static int gnutls_Init (vlc_object_t *p_this)
 111 {
 112     int ret = VLC_EGENERIC;
 113
 114     vlc_gcrypt_init (); /* GnuTLS depends on gcrypt */
 115
 116     vlc_mutex_t *lock = var_AcquireMutex ("gnutls_mutex");
 117     if (gnutls_global_init ())
 118     {
 119         msg_Err (p_this, "cannot initialize GnuTLS");
 120         goto error;
 121     }
 122
 123     const char *psz_version = gnutls_check_version ("1.3.3");
 124     if (psz_version == NULL)
 125     {
 126         msg_Err (p_this, "unsupported GnuTLS version");
 127         gnutls_global_deinit ();
 128         goto error;
 129     }
 130
 131     msg_Dbg (p_this, "GnuTLS v%s initialized", psz_version);
 132     ret = VLC_SUCCESS;
 133
 134 error:
 135     vlc_mutex_unlock (lock);
 136     return ret;
 137 }
 138
 139
 140 /**
 141  * Deinitializes GnuTLS.
 142  */
 143 static void gnutls_Deinit (vlc_object_t *p_this)
 144 {
 145     vlc_mutex_t *lock = var_AcquireMutex( "gnutls_mutex" );
 146
 147     gnutls_global_deinit ();
 148     msg_Dbg (p_this, "GnuTLS deinitialized");
 149     vlc_mutex_unlock (lock);
 150 }
 151
 152
 153 static int gnutls_Error (vlc_object_t *obj, int val)
 154 {
 155     switch (val)
 156     {
 157         case GNUTLS_E_AGAIN:
 158 #ifndef WIN32
 159             errno = EAGAIN;
 160             break;
 161 #endif
 162             /* WinSock does not return EAGAIN, return EINTR instead */
 163
 164         case GNUTLS_E_INTERRUPTED:
 165 #ifdef WIN32
 166             WSASetLastError (WSAEINTR);
 167 #else
 168             errno = EINTR;
 169 #endif
 170             break;
 171
 172         default:
 173             msg_Err (obj, "%s", gnutls_strerror (val));
 174 #ifndef NDEBUG
 175             if (!gnutls_error_is_fatal (val))
 176                 msg_Err (obj, "Error above should be handled");
 177 #endif
 178 #ifdef WIN32
 179             WSASetLastError (WSAECONNRESET);
 180 #else
 181             errno = ECONNRESET;
 182 #endif
 183     }
 184     return -1;
 185 }
 186
 187
 188 struct tls_session_sys_t
 189 {
 190     gnutls_session_t session;
 191     char            *psz_hostname;
 192     bool       b_handshaked;
 193 };
 194
 195
 196 /**
 197  * Sends data through a TLS session.
 198  */
 199 static int
 200 gnutls_Send( void *p_session, const void *buf, int i_length )
 201 {
 202     int val;
 203     tls_session_sys_t *p_sys;
 204
 205     p_sys = (tls_session_sys_t *)(((tls_session_t *)p_session)->p_sys);
 206
 207     val = gnutls_record_send( p_sys->session, buf, i_length );
 208     return (val < 0) ? gnutls_Error ((vlc_object_t *)p_session, val) : val;
 209 }
 210
 211
 212 /**
 213  * Receives data through a TLS session.
 214  */
 215 static int
 216 gnutls_Recv( void *p_session, void *buf, int i_length )
 217 {
 218     int val;
 219     tls_session_sys_t *p_sys;
 220
 221     p_sys = (tls_session_sys_t *)(((tls_session_t *)p_session)->p_sys);
 222
 223     val = gnutls_record_recv( p_sys->session, buf, i_length );
 224     return (val < 0) ? gnutls_Error ((vlc_object_t *)p_session, val) : val;
 225 }
 226
 227
 228 /**
 229  * Starts or continues the TLS handshake.
 230  *
 231  * @return -1 on fatal error, 0 on succesful handshake completion,
 232  * 1 if more would-be blocking recv is needed,
 233  * 2 if more would-be blocking send is required.
 234  */
 235 static int
 236 gnutls_ContinueHandshake (tls_session_t *p_session)
 237 {
 238     tls_session_sys_t *p_sys = p_session->p_sys;
 239     int val;
 240
 241 #ifdef WIN32
 242     WSASetLastError( 0 );
 243 #endif
 244     val = gnutls_handshake( p_sys->session );
 245     if( ( val == GNUTLS_E_AGAIN ) || ( val == GNUTLS_E_INTERRUPTED ) )
 246         return 1 + gnutls_record_get_direction( p_sys->session );
 247
 248     if( val < 0 )
 249     {
 250 #ifdef WIN32
 251         msg_Dbg( p_session, "Winsock error %d", WSAGetLastError( ) );
 252 #endif
 253         msg_Err( p_session, "TLS handshake error: %s",
 254                  gnutls_strerror( val ) );
 255         return -1;
 256     }
 257
 258     p_sys->b_handshaked = true;
 259     return 0;
 260 }
 261
 262
 263 typedef struct
 264 {
 265     int flag;
 266     const char *msg;
 267 } error_msg_t;
 268
 269 static const error_msg_t cert_errors[] =
 270 {
 271     { GNUTLS_CERT_INVALID,
 272         "Certificate could not be verified" },
 273     { GNUTLS_CERT_REVOKED,
 274         "Certificate was revoked" },
 275     { GNUTLS_CERT_SIGNER_NOT_FOUND,
 276         "Certificate's signer was not found" },
 277     { GNUTLS_CERT_SIGNER_NOT_CA,
 278         "Certificate's signer is not a CA" },
 279     { GNUTLS_CERT_INSECURE_ALGORITHM,
 280         "Insecure certificate signature algorithm" },
 281     { 0, NULL }
 282 };
 283
 284
 285 static int
 286 gnutls_HandshakeAndValidate( tls_session_t *session )
 287 {
 288     int val = gnutls_ContinueHandshake( session );
 289     if( val )
 290         return val;
 291
 292     tls_session_sys_t *p_sys = (tls_session_sys_t *)(session->p_sys);
 293
 294     /* certificates chain verification */
 295     unsigned status;
 296     val = gnutls_certificate_verify_peers2( p_sys->session, &status );
 297
 298     if( val )
 299     {
 300         msg_Err( session, "Certificate verification failed: %s",
 301                  gnutls_strerror( val ) );
 302         return -1;
 303     }
 304
 305     if( status )
 306     {
 307         msg_Err( session, "TLS session: access denied" );
 308         for( const error_msg_t *e = cert_errors; e->flag; e++ )
 309         {
 310             if( status & e->flag )
 311             {
 312                 msg_Err( session, "%s", e->msg );
 313                 status &= ~e->flag;
 314             }
 315         }
 316
 317         if( status )
 318             msg_Err( session,
 319                      "unknown certificate error (you found a bug in VLC)" );
 320
 321         return -1;
 322     }
 323
 324     /* certificate (host)name verification */
 325     const gnutls_datum_t *data;
 326     data = gnutls_certificate_get_peers (p_sys->session, &(unsigned){0});
 327     if( data == NULL )
 328     {
 329         msg_Err( session, "Peer certificate not available" );
 330         return -1;
 331     }
 332
 333     gnutls_x509_crt_t cert;
 334     val = gnutls_x509_crt_init( &cert );
 335     if( val )
 336     {
 337         msg_Err( session, "x509 fatal error: %s", gnutls_strerror( val ) );
 338         return -1;
 339     }
 340
 341     val = gnutls_x509_crt_import( cert, data, GNUTLS_X509_FMT_DER );
 342     if( val )
 343     {
 344         msg_Err( session, "Certificate import error: %s",
 345                  gnutls_strerror( val ) );
 346         goto error;
 347     }
 348
 349     assert( p_sys->psz_hostname != NULL );
 350     if ( !gnutls_x509_crt_check_hostname( cert, p_sys->psz_hostname ) )
 351     {
 352         msg_Err( session, "Certificate does not match \"%s\"",
 353                  p_sys->psz_hostname );
 354         goto error;
 355     }
 356
 357     if( gnutls_x509_crt_get_expiration_time( cert ) < time( NULL ) )
 358     {
 359         msg_Err( session, "Certificate expired" );
 360         goto error;
 361     }
 362
 363     if( gnutls_x509_crt_get_activation_time( cert ) > time ( NULL ) )
 364     {
 365         msg_Err( session, "Certificate not yet valid" );
 366         goto error;
 367     }
 368
 369     gnutls_x509_crt_deinit( cert );
 370     msg_Dbg( session, "TLS/x509 certificate verified" );
 371     return 0;
 372
 373 error:
 374     gnutls_x509_crt_deinit( cert );
 375     return -1;
 376 }
 377
 378 /**
 379  * Sets the operating system file descriptor backend for the TLS sesison.
 380  *
 381  * @param fd stream socket already connected with the peer.
 382  */
 383 static void
 384 gnutls_SetFD (tls_session_t *p_session, int fd)
 385 {
 386     gnutls_transport_set_ptr (p_session->p_sys->session,
 387                               (gnutls_transport_ptr_t)(intptr_t)fd);
 388 }
 389
 390 typedef int (*tls_prio_func) (gnutls_session_t, const int *);
 391
 392 static int
 393 gnutls_SetPriority (vlc_object_t *restrict obj, const char *restrict name,
 394                     tls_prio_func func, gnutls_session_t session,
 395                     const int *restrict values)
 396 {
 397     int val = func (session, values);
 398     if (val < 0)
 399     {
 400         msg_Err (obj, "cannot set %s priorities: %s", name,
 401                  gnutls_strerror (val));
 402         return VLC_EGENERIC;
 403     }
 404     return VLC_SUCCESS;
 405 }
 406
 407
 408 static int
 409 gnutls_SessionPrioritize (vlc_object_t *obj, gnutls_session_t session)
 410 {
 411     /* Note that ordering matters (on the client side) */
 412     static const int protos[] =
 413     {
 414         GNUTLS_TLS1_1,
 415         GNUTLS_TLS1_0,
 416         GNUTLS_SSL3,
 417         0
 418     };
 419     static const int comps[] =
 420     {
 421         GNUTLS_COMP_DEFLATE,
 422         GNUTLS_COMP_NULL,
 423         0
 424     };
 425     static const int macs[] =
 426     {
 427         GNUTLS_MAC_SHA1,
 428         GNUTLS_MAC_RMD160, // RIPEMD
 429         GNUTLS_MAC_MD5,
 430         //GNUTLS_MAC_MD2,
 431         //GNUTLS_MAC_NULL,
 432         0
 433     };
 434     static const int ciphers[] =
 435     {
 436         GNUTLS_CIPHER_AES_256_CBC,
 437         GNUTLS_CIPHER_AES_128_CBC,
 438         GNUTLS_CIPHER_3DES_CBC,
 439         GNUTLS_CIPHER_ARCFOUR_128,
 440         //GNUTLS_CIPHER_DES_CBC,
 441         //GNUTLS_CIPHER_ARCFOUR_40,
 442         //GNUTLS_CIPHER_RC2_40_CBC,
 443         //GNUTLS_CIPHER_NULL,
 444         0
 445     };
 446     static const int kx[] =
 447     {
 448         GNUTLS_KX_DHE_RSA,
 449         GNUTLS_KX_DHE_DSS,
 450         GNUTLS_KX_RSA,
 451         //GNUTLS_KX_RSA_EXPORT,
 452         //GNUTLS_KX_DHE_PSK, TODO
 453         //GNUTLS_KX_PSK,     TODO
 454         //GNUTLS_KX_SRP_RSA, TODO
 455         //GNUTLS_KX_SRP_DSS, TODO
 456         //GNUTLS_KX_SRP,     TODO
 457         //GNUTLS_KX_ANON_DH,
 458         0
 459     };
 460     static const int cert_types[] =
 461     {
 462         GNUTLS_CRT_X509,
 463         //GNUTLS_CRT_OPENPGP, TODO
 464         0
 465     };
 466
 467     int val = gnutls_set_default_priority (session);
 468     if (val < 0)
 469     {
 470         msg_Err (obj, "cannot set default TLS priorities: %s",
 471                  gnutls_strerror (val));
 472         return VLC_EGENERIC;
 473     }
 474
 475     if (gnutls_SetPriority (obj, "protocols",
 476                             gnutls_protocol_set_priority, session, protos)
 477      || gnutls_SetPriority (obj, "compression algorithms",
 478                             gnutls_compression_set_priority, session, comps)
 479      || gnutls_SetPriority (obj, "MAC algorithms",
 480                             gnutls_mac_set_priority, session, macs)
 481      || gnutls_SetPriority (obj, "ciphers",
 482                             gnutls_cipher_set_priority, session, ciphers)
 483      || gnutls_SetPriority (obj, "key exchange algorithms",
 484                             gnutls_kx_set_priority, session, kx)
 485      || gnutls_SetPriority (obj, "certificate types",
 486                             gnutls_certificate_type_set_priority, session,
 487                             cert_types))
 488         return VLC_EGENERIC;
 489
 490     return VLC_SUCCESS;
 491 }
 492
 493
 494 static int
 495 gnutls_Addx509File( vlc_object_t *p_this,
 496                     gnutls_certificate_credentials_t cred,
 497                     const char *psz_path, bool b_priv );
 498
 499 static int
 500 gnutls_Addx509Directory( vlc_object_t *p_this,
 501                          gnutls_certificate_credentials_t cred,
 502                          const char *psz_dirname,
 503                          bool b_priv )
 504 {
 505     DIR* dir;
 506
 507     if( *psz_dirname == '\0' )
 508         psz_dirname = ".";
 509
 510     dir = utf8_opendir( psz_dirname );
 511     if( dir == NULL )
 512     {
 513         if (errno != ENOENT)
 514         {
 515             msg_Err (p_this, "cannot open directory (%s): %m", psz_dirname);
 516             return VLC_EGENERIC;
 517         }
 518
 519         msg_Dbg (p_this, "creating empty certificate directory: %s",
 520                  psz_dirname);
 521         utf8_mkdir (psz_dirname, b_priv ? 0700 : 0755);
 522         return VLC_SUCCESS;
 523     }
 524 #ifdef S_ISLNK
 525     else
 526     {
 527         struct stat st1, st2;
 528         int fd = dirfd( dir );
 529
 530         /*
 531          * Gets stats for the directory path, checks that it is not a
 532          * symbolic link (to avoid possibly infinite recursion), and verifies
 533          * that the inode is still the same, to avoid TOCTOU race condition.
 534          */
 535         if( ( fd == -1)
 536          || fstat( fd, &st1 ) || utf8_lstat( psz_dirname, &st2 )
 537          || S_ISLNK( st2.st_mode ) || ( st1.st_ino != st2.st_ino ) )
 538         {
 539             closedir( dir );
 540             return VLC_EGENERIC;
 541         }
 542     }
 543 #endif
 544
 545     for (;;)
 546     {
 547         char *ent = utf8_readdir (dir);
 548         if (ent == NULL)
 549             break;
 550
 551         if ((strcmp (ent, ".") == 0) || (strcmp (ent, "..") == 0))
 552             continue;
 553
 554         char path[strlen (psz_dirname) + strlen (ent) + 2];
 555         sprintf (path, "%s"DIR_SEP"%s", psz_dirname, ent);
 556         free (ent);
 557
 558         gnutls_Addx509File( p_this, cred, path, b_priv );
 559     }
 560
 561     closedir( dir );
 562     return VLC_SUCCESS;
 563 }
 564
 565
 566 static int
 567 gnutls_Addx509File( vlc_object_t *p_this,
 568                     gnutls_certificate_credentials cred,
 569                     const char *psz_path, bool b_priv )
 570 {
 571     struct stat st;
 572
 573     if( utf8_stat( psz_path, &st ) == 0 )
 574     {
 575         if( S_ISREG( st.st_mode ) )
 576         {
 577             char *psz_localname = ToLocale( psz_path );
 578             int i = b_priv
 579                     ? gnutls_certificate_set_x509_key_file( cred,
 580                     psz_localname,  psz_localname, GNUTLS_X509_FMT_PEM )
 581                 : gnutls_certificate_set_x509_trust_file( cred,
 582                         psz_localname, GNUTLS_X509_FMT_PEM );
 583             LocaleFree( psz_localname );
 584
 585             if( i < 0 )
 586             {
 587                 msg_Warn( p_this, "cannot add x509 credentials (%s): %s",
 588                           psz_path, gnutls_strerror( i ) );
 589                 return VLC_EGENERIC;
 590             }
 591             else
 592             {
 593                 msg_Dbg( p_this, "added x509 credentials (%s)",
 594                          psz_path );
 595                 return VLC_SUCCESS;
 596             }
 597         }
 598         else if( S_ISDIR( st.st_mode ) )
 599         {
 600             msg_Dbg( p_this,
 601                      "looking recursively for x509 credentials in %s",
 602                      psz_path );
 603             return gnutls_Addx509Directory( p_this, cred, psz_path, b_priv);
 604         }
 605     }
 606     else
 607         msg_Warn( p_this, "cannot add x509 credentials (%s): %m", psz_path );
 608     return VLC_EGENERIC;
 609 }
 610
 611
 612 /** TLS client session data */
 613 typedef struct tls_client_sys_t
 614 {
 615     struct tls_session_sys_t         session;
 616     gnutls_certificate_credentials_t x509_cred;
 617 } tls_client_sys_t;
 618
 619
 620 /**
 621  * Initializes a client-side TLS session.
 622  */
 623 static int OpenClient (vlc_object_t *obj)
 624 {
 625     tls_session_t *p_session = (tls_session_t *)obj;
 626     int i_val;
 627
 628     if (gnutls_Init (obj))
 629         return VLC_EGENERIC;
 630
 631     tls_client_sys_t *p_sys = malloc (sizeof (*p_sys));
 632     if (p_sys == NULL)
 633     {
 634         gnutls_Deinit (obj);
 635         return VLC_ENOMEM;
 636     }
 637
 638     p_session->p_sys = &p_sys->session;
 639     p_session->sock.p_sys = p_session;
 640     p_session->sock.pf_send = gnutls_Send;
 641     p_session->sock.pf_recv = gnutls_Recv;
 642     p_session->pf_set_fd = gnutls_SetFD;
 643
 644     p_sys->session.b_handshaked = false;
 645
 646     i_val = gnutls_certificate_allocate_credentials (&p_sys->x509_cred);
 647     if (i_val != 0)
 648     {
 649         msg_Err (obj, "cannot allocate X509 credentials: %s",
 650                  gnutls_strerror (i_val));
 651         goto error;
 652     }
 653
 654     char *userdir = config_GetUserDataDir ();
 655     if (userdir != NULL)
 656     {
 657         char path[strlen (userdir) + sizeof ("/ssl/private")];
 658         sprintf (path, "%s/ssl", userdir);
 659         utf8_mkdir (path, 0755);
 660
 661         sprintf (path, "%s/ssl/certs", userdir);
 662         gnutls_Addx509Directory (VLC_OBJECT (p_session),
 663                                  p_sys->x509_cred, path, false);
 664         sprintf (path, "%s/ssl/private", userdir);
 665         gnutls_Addx509Directory (VLC_OBJECT (p_session), p_sys->x509_cred,
 666                                  path, true);
 667         free (userdir);
 668     }
 669
 670     const char *datadir = config_GetDataDir ();
 671     {
 672         char path[strlen (datadir) + sizeof ("/ca-certificates.crt")];
 673         sprintf (path, "%s/ca-certificates.crt", datadir);
 674         gnutls_Addx509File (VLC_OBJECT (p_session),
 675                             p_sys->x509_cred, path, false);
 676     }
 677     p_session->pf_handshake = gnutls_HandshakeAndValidate;
 678     /*p_session->pf_handshake = gnutls_ContinueHandshake;*/
 679
 680     i_val = gnutls_init (&p_sys->session.session, GNUTLS_CLIENT);
 681     if (i_val != 0)
 682     {
 683         msg_Err (obj, "cannot initialize TLS session: %s",
 684                  gnutls_strerror (i_val));
 685         gnutls_certificate_free_credentials (p_sys->x509_cred);
 686         goto error;
 687     }
 688
 689     if (gnutls_SessionPrioritize (VLC_OBJECT (p_session),
 690                                   p_sys->session.session))
 691         goto s_error;
 692
 693     /* minimum DH prime bits */
 694     gnutls_dh_set_prime_bits (p_sys->session.session, 1024);
 695
 696     i_val = gnutls_credentials_set (p_sys->session.session,
 697                                     GNUTLS_CRD_CERTIFICATE,
 698                                     p_sys->x509_cred);
 699     if (i_val < 0)
 700     {
 701         msg_Err (obj, "cannot set TLS session credentials: %s",
 702                  gnutls_strerror (i_val));
 703         goto s_error;
 704     }
 705
 706     char *servername = var_GetNonEmptyString (p_session, "tls-server-name");
 707     if (servername == NULL )
 708         msg_Err (p_session, "server name missing for TLS session");
 709
 710     p_sys->session.psz_hostname = servername;
 711     gnutls_server_name_set (p_sys->session.session, GNUTLS_NAME_DNS,
 712                             servername, strlen (servername));
 713
 714     return VLC_SUCCESS;
 715
 716 s_error:
 717     gnutls_deinit (p_sys->session.session);
 718     gnutls_certificate_free_credentials (p_sys->x509_cred);
 719 error:
 720     gnutls_Deinit (obj);
 721     free (p_sys);
 722     return VLC_EGENERIC;
 723 }
 724
 725
 726 static void CloseClient (vlc_object_t *obj)
 727 {
 728     tls_session_t *client = (tls_session_t *)obj;
 729     tls_client_sys_t *p_sys = (tls_client_sys_t *)(client->p_sys);
 730
 731     if (p_sys->session.b_handshaked == true)
 732         gnutls_bye (p_sys->session.session, GNUTLS_SHUT_WR);
 733     gnutls_deinit (p_sys->session.session);
 734     /* credentials must be free'd *after* gnutls_deinit() */
 735     gnutls_certificate_free_credentials (p_sys->x509_cred);
 736
 737     gnutls_Deinit (obj);
 738     free (p_sys->session.psz_hostname);
 739     free (p_sys);
 740 }
 741
 742
 743 /**
 744  * Server-side TLS
 745  */
 746 struct tls_server_sys_t
 747 {
 748     gnutls_certificate_credentials_t x509_cred;
 749     gnutls_dh_params_t               dh_params;
 750
 751     struct saved_session_t          *p_cache;
 752     struct saved_session_t          *p_store;
 753     int                              i_cache_size;
 754     vlc_mutex_t                      cache_lock;
 755
 756     int                            (*pf_handshake) (tls_session_t *);
 757 };
 758
 759
 760 /**
 761  * TLS session resumption callbacks (server-side)
 762  */
 763 #define MAX_SESSION_ID    32
 764 #define MAX_SESSION_DATA  1024
 765
 766 typedef struct saved_session_t
 767 {
 768     char id[MAX_SESSION_ID];
 769     char data[MAX_SESSION_DATA];
 770
 771     unsigned i_idlen;
 772     unsigned i_datalen;
 773 } saved_session_t;
 774
 775
 776 static int cb_store( void *p_server, gnutls_datum key, gnutls_datum data )
 777 {
 778     tls_server_sys_t *p_sys = ((tls_server_t *)p_server)->p_sys;
 779
 780     if( ( p_sys->i_cache_size == 0 )
 781      || ( key.size > MAX_SESSION_ID )
 782      || ( data.size > MAX_SESSION_DATA ) )
 783         return -1;
 784
 785     vlc_mutex_lock( &p_sys->cache_lock );
 786
 787     memcpy( p_sys->p_store->id, key.data, key.size);
 788     memcpy( p_sys->p_store->data, data.data, data.size );
 789     p_sys->p_store->i_idlen = key.size;
 790     p_sys->p_store->i_datalen = data.size;
 791
 792     p_sys->p_store++;
 793     if( ( p_sys->p_store - p_sys->p_cache ) == p_sys->i_cache_size )
 794         p_sys->p_store = p_sys->p_cache;
 795
 796     vlc_mutex_unlock( &p_sys->cache_lock );
 797
 798     return 0;
 799 }
 800
 801
 802 static gnutls_datum cb_fetch( void *p_server, gnutls_datum key )
 803 {
 804     static const gnutls_datum_t err_datum = { NULL, 0 };
 805     tls_server_sys_t *p_sys = ((tls_server_t *)p_server)->p_sys;
 806     saved_session_t *p_session, *p_end;
 807
 808     p_session = p_sys->p_cache;
 809     p_end = p_session + p_sys->i_cache_size;
 810
 811     vlc_mutex_lock( &p_sys->cache_lock );
 812
 813     while( p_session < p_end )
 814     {
 815         if( ( p_session->i_idlen == key.size )
 816          && !memcmp( p_session->id, key.data, key.size ) )
 817         {
 818             gnutls_datum_t data;
 819
 820             data.size = p_session->i_datalen;
 821
 822             data.data = gnutls_malloc( data.size );
 823             if( data.data == NULL )
 824             {
 825                 vlc_mutex_unlock( &p_sys->cache_lock );
 826                 return err_datum;
 827             }
 828
 829             memcpy( data.data, p_session->data, data.size );
 830             vlc_mutex_unlock( &p_sys->cache_lock );
 831             return data;
 832         }
 833         p_session++;
 834     }
 835
 836     vlc_mutex_unlock( &p_sys->cache_lock );
 837
 838     return err_datum;
 839 }
 840
 841
 842 static int cb_delete( void *p_server, gnutls_datum key )
 843 {
 844     tls_server_sys_t *p_sys = ((tls_server_t *)p_server)->p_sys;
 845     saved_session_t *p_session, *p_end;
 846
 847     p_session = p_sys->p_cache;
 848     p_end = p_session + p_sys->i_cache_size;
 849
 850     vlc_mutex_lock( &p_sys->cache_lock );
 851
 852     while( p_session < p_end )
 853     {
 854         if( ( p_session->i_idlen == key.size )
 855          && !memcmp( p_session->id, key.data, key.size ) )
 856         {
 857             p_session->i_datalen = p_session->i_idlen = 0;
 858             vlc_mutex_unlock( &p_sys->cache_lock );
 859             return 0;
 860         }
 861         p_session++;
 862     }
 863
 864     vlc_mutex_unlock( &p_sys->cache_lock );
 865
 866     return -1;
 867 }
 868
 869
 870 /**
 871  * Terminates TLS session and releases session data.
 872  * You still have to close the socket yourself.
 873  */
 874 static void
 875 gnutls_SessionClose (tls_server_t *p_server, tls_session_t *p_session)
 876 {
 877     tls_session_sys_t *p_sys = p_session->p_sys;
 878     (void)p_server;
 879
 880     if( p_sys->b_handshaked == true )
 881         gnutls_bye( p_sys->session, GNUTLS_SHUT_WR );
 882     gnutls_deinit( p_sys->session );
 883
 884     vlc_object_detach( p_session );
 885     vlc_object_release( p_session );
 886
 887     free( p_sys );
 888 }
 889
 890
 891 /**
 892  * Initializes a server-side TLS session.
 893  */
 894 static tls_session_t *
 895 gnutls_ServerSessionPrepare( tls_server_t *p_server )
 896 {
 897     tls_session_t *p_session;
 898     tls_server_sys_t *p_server_sys;
 899     gnutls_session_t session;
 900     int i_val;
 901
 902     p_session = vlc_object_create( p_server, sizeof (struct tls_session_t) );
 903     if( p_session == NULL )
 904         return NULL;
 905
 906     p_session->p_sys = malloc( sizeof(struct tls_session_sys_t) );
 907     if( p_session->p_sys == NULL )
 908     {
 909         vlc_object_release( p_session );
 910         return NULL;
 911     }
 912
 913     p_server_sys = p_server->p_sys;
 914     p_session->sock.p_sys = p_session;
 915     p_session->sock.pf_send = gnutls_Send;
 916     p_session->sock.pf_recv = gnutls_Recv;
 917     p_session->pf_set_fd = gnutls_SetFD;
 918     p_session->pf_handshake = p_server_sys->pf_handshake;
 919
 920     p_session->p_sys->b_handshaked = false;
 921     p_session->p_sys->psz_hostname = NULL;
 922
 923     i_val = gnutls_init( &session, GNUTLS_SERVER );
 924     if( i_val != 0 )
 925     {
 926         msg_Err( p_server, "cannot initialize TLS session: %s",
 927                  gnutls_strerror( i_val ) );
 928         goto error;
 929     }
 930
 931     p_session->p_sys->session = session;
 932
 933     if (gnutls_SessionPrioritize (VLC_OBJECT (p_session), session))
 934     {
 935         gnutls_deinit( session );
 936         goto error;
 937     }
 938
 939     i_val = gnutls_credentials_set( session, GNUTLS_CRD_CERTIFICATE,
 940                                     p_server_sys->x509_cred );
 941     if( i_val < 0 )
 942     {
 943         msg_Err( p_server, "cannot set TLS session credentials: %s",
 944                  gnutls_strerror( i_val ) );
 945         gnutls_deinit( session );
 946         goto error;
 947     }
 948
 949     if (p_session->pf_handshake == gnutls_HandshakeAndValidate)
 950         gnutls_certificate_server_set_request (session, GNUTLS_CERT_REQUIRE);
 951
 952     /* Session resumption support */
 953     i_val = config_GetInt (p_server, "gnutls-cache-timeout");
 954     gnutls_db_set_cache_expiration (session, i_val);
 955     gnutls_db_set_retrieve_function( session, cb_fetch );
 956     gnutls_db_set_remove_function( session, cb_delete );
 957     gnutls_db_set_store_function( session, cb_store );
 958     gnutls_db_set_ptr( session, p_server );
 959
 960     return p_session;
 961
 962 error:
 963     free( p_session->p_sys );
 964     vlc_object_detach( p_session );
 965     vlc_object_release( p_session );
 966     return NULL;
 967 }
 968
 969
 970 /**
 971  * Adds one or more certificate authorities.
 972  *
 973  * @param psz_ca_path (Unicode) path to an x509 certificates list.
 974  *
 975  * @return -1 on error, 0 on success.
 976  */
 977 static int
 978 gnutls_ServerAddCA( tls_server_t *p_server, const char *psz_ca_path )
 979 {
 980     tls_server_sys_t *p_sys;
 981     char *psz_local_path;
 982     int val;
 983
 984     p_sys = (tls_server_sys_t *)(p_server->p_sys);
 985
 986     psz_local_path = ToLocale( psz_ca_path );
 987     val = gnutls_certificate_set_x509_trust_file( p_sys->x509_cred,
 988                                                   psz_local_path,
 989                                                   GNUTLS_X509_FMT_PEM );
 990     LocaleFree( psz_local_path );
 991     if( val < 0 )
 992     {
 993         msg_Err( p_server, "cannot add trusted CA (%s): %s", psz_ca_path,
 994                  gnutls_strerror( val ) );
 995         return VLC_EGENERIC;
 996     }
 997     msg_Dbg( p_server, " %d trusted CA added (%s)", val, psz_ca_path );
 998
 999     /* enables peer's certificate verification */
1000     p_sys->pf_handshake = gnutls_HandshakeAndValidate;
1001
1002     return VLC_SUCCESS;
1003 }
1004
1005
1006 /**
1007  * Adds a certificates revocation list to be sent to TLS clients.
1008  *
1009  * @param psz_crl_path (Unicode) path of the CRL file.
1010  *
1011  * @return -1 on error, 0 on success.
1012  */
1013 static int
1014 gnutls_ServerAddCRL( tls_server_t *p_server, const char *psz_crl_path )
1015 {
1016     int val;
1017     char *psz_local_path = ToLocale( psz_crl_path );
1018
1019     val = gnutls_certificate_set_x509_crl_file( ((tls_server_sys_t *)
1020                                                 (p_server->p_sys))->x509_cred,
1021                                                 psz_local_path,
1022                                                 GNUTLS_X509_FMT_PEM );
1023     LocaleFree( psz_crl_path );
1024     if( val < 0 )
1025     {
1026         msg_Err( p_server, "cannot add CRL (%s): %s", psz_crl_path,
1027                  gnutls_strerror( val ) );
1028         return VLC_EGENERIC;
1029     }
1030     msg_Dbg( p_server, "%d CRL added (%s)", val, psz_crl_path );
1031     return VLC_SUCCESS;
1032 }
1033
1034
1035 /**
1036  * Allocates a whole server's TLS credentials.
1037  */
1038 static int OpenServer (vlc_object_t *obj)
1039 {
1040     tls_server_t *p_server = (tls_server_t *)obj;
1041     tls_server_sys_t *p_sys;
1042     int val;
1043
1044     if (gnutls_Init (obj))
1045         return VLC_EGENERIC;
1046
1047     msg_Dbg (obj, "creating TLS server");
1048
1049     p_sys = (tls_server_sys_t *)malloc( sizeof(struct tls_server_sys_t) );
1050     if( p_sys == NULL )
1051         return VLC_ENOMEM;
1052
1053     p_sys->i_cache_size = config_GetInt (obj, "gnutls-cache-size");
1054     p_sys->p_cache = calloc (p_sys->i_cache_size,
1055                              sizeof (struct saved_session_t));
1056     if (p_sys->p_cache == NULL)
1057     {
1058         free (p_sys);
1059         return VLC_ENOMEM;
1060     }
1061
1062     p_sys->p_store = p_sys->p_cache;
1063     p_server->p_sys = p_sys;
1064     p_server->pf_add_CA  = gnutls_ServerAddCA;
1065     p_server->pf_add_CRL = gnutls_ServerAddCRL;
1066     p_server->pf_open    = gnutls_ServerSessionPrepare;
1067     p_server->pf_close   = gnutls_SessionClose;
1068
1069     /* No certificate validation by default */
1070     p_sys->pf_handshake  = gnutls_ContinueHandshake;
1071
1072     vlc_mutex_init( &p_sys->cache_lock );
1073
1074     /* Sets server's credentials */
1075     val = gnutls_certificate_allocate_credentials( &p_sys->x509_cred );
1076     if( val != 0 )
1077     {
1078         msg_Err( p_server, "cannot allocate X509 credentials: %s",
1079                  gnutls_strerror( val ) );
1080         goto error;
1081     }
1082
1083     char *psz_cert_path = var_GetNonEmptyString (obj, "tls-x509-cert");
1084     char *psz_key_path = var_GetNonEmptyString (obj, "tls-x509-key");
1085     const char *psz_local_cert = ToLocale (psz_cert_path);
1086     const char *psz_local_key = ToLocale (psz_key_path);
1087     val = gnutls_certificate_set_x509_key_file (p_sys->x509_cred,
1088                                                 psz_local_cert, psz_local_key,
1089                                                 GNUTLS_X509_FMT_PEM );
1090     LocaleFree (psz_local_key);
1091     free (psz_key_path);
1092     LocaleFree (psz_local_cert);
1093     free (psz_cert_path);
1094
1095     if( val < 0 )
1096     {
1097         msg_Err( p_server, "cannot set certificate chain or private key: %s",
1098                  gnutls_strerror( val ) );
1099         gnutls_certificate_free_credentials( p_sys->x509_cred );
1100         goto error;
1101     }
1102
1103     /* FIXME:
1104      * - support other ciper suites
1105      */
1106     val = gnutls_dh_params_init (&p_sys->dh_params);
1107     if (val >= 0)
1108     {
1109         const gnutls_datum_t data = {
1110             .data = (unsigned char *)dh_params,
1111             .size = sizeof (dh_params) - 1,
1112         };
1113
1114         val = gnutls_dh_params_import_pkcs3 (p_sys->dh_params, &data,
1115                                              GNUTLS_X509_FMT_PEM);
1116         if (val == 0)
1117             gnutls_certificate_set_dh_params (p_sys->x509_cred,
1118                                               p_sys->dh_params);
1119     }
1120     if (val < 0)
1121     {
1122         msg_Err (p_server, "cannot initialize DHE cipher suites: %s",
1123                  gnutls_strerror (val));
1124     }
1125
1126     return VLC_SUCCESS;
1127
1128 error:
1129     vlc_mutex_destroy (&p_sys->cache_lock);
1130     free (p_sys->p_cache);
1131     free (p_sys);
1132     return VLC_EGENERIC;
1133 }
1134
1135 /**
1136  * Destroys a TLS server object.
1137  */
1138 static void CloseServer (vlc_object_t *p_server)
1139 {
1140     tls_server_sys_t *p_sys = ((tls_server_t *)p_server)->p_sys;
1141
1142     vlc_mutex_destroy (&p_sys->cache_lock);
1143     free (p_sys->p_cache);
1144
1145     /* all sessions depending on the server are now deinitialized */
1146     gnutls_certificate_free_credentials (p_sys->x509_cred);
1147     gnutls_dh_params_deinit (p_sys->dh_params);
1148     free (p_sys);
1149
1150     gnutls_Deinit (p_server);
1151 }