ssl_common.c

   1 /*********************************************************************
   2  *
   3  * File        :  $Source: /cvsroot/ijbswa/current/ssl_common.c,v $
   4  *
   5  * Purpose     :  File with TLS/SSL extension. Contains methods for
   6  *                creating, using and closing TLS/SSL connections that do
   7  *                not depend on particular TLS/SSL library.
   8  *
   9  * Copyright   :  Written by and Copyright (c) 2017 Vaclav Svec. FIT CVUT.
  10  *                Copyright (C) 2018-2021 by Fabian Keil <fk@fabiankeil.de>
  11  *
  12  *                This program is free software; you can redistribute it
  13  *                and/or modify it under the terms of the GNU General
  14  *                Public License as published by the Free Software
  15  *                Foundation; either version 2 of the License, or (at
  16  *                your option) any later version.
  17  *
  18  *                This program is distributed in the hope that it will
  19  *                be useful, but WITHOUT ANY WARRANTY; without even the
  20  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  21  *                PARTICULAR PURPOSE.  See the GNU General Public
  22  *                License for more details.
  23  *
  24  *                The GNU General Public License should be included with
  25  *                this file.  If not, you can view it at
  26  *                http://www.gnu.org/copyleft/gpl.html
  27  *                or write to the Free Software Foundation, Inc., 59
  28  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  29  *
  30  *********************************************************************/
  31 #include <string.h>
  32
  33 #include <ctype.h>
  34 #include <unistd.h>
  35 #include "config.h"
  36 #include "project.h"
  37 #include "miscutil.h"
  38 #include "errlog.h"
  39 #include "ssl.h"
  40 #include "ssl_common.h"
  41
  42 /*
  43  * Macros for ssl_common.c
  44  */
  45 #define CERT_SERIAL_NUM_LENGTH           4                 /* Bytes of hash to be used for creating serial number of certificate. Min=2 and max=16 */
  46
  47 /*********************************************************************
  48  *
  49  * Function    :  client_use_ssl
  50  *
  51  * Description :  Tests if client in current client state structure
  52  *                should use SSL connection or standard connection.
  53  *
  54  * Parameters  :
  55  *          1  :  csp = Current client state (buffers, headers, etc...)
  56  *
  57  * Returns     :  If client should use TLS/SSL connection, 1 is returned.
  58  *                Otherwise 0 is returned.
  59  *
  60  *********************************************************************/
  61 extern int client_use_ssl(const struct client_state *csp)
  62 {
  63    return csp->http->client_ssl;
  64 }
  65
  66
  67 /*********************************************************************
  68  *
  69  * Function    :  server_use_ssl
  70  *
  71  * Description :  Tests if server in current client state structure
  72  *                should use SSL connection or standard connection.
  73  *
  74  * Parameters  :
  75  *          1  :  csp = Current client state (buffers, headers, etc...)
  76  *
  77  * Returns     :  If server should use TLS/SSL connection, 1 is returned.
  78  *                Otherwise 0 is returned.
  79  *
  80  *********************************************************************/
  81 extern int server_use_ssl(const struct client_state *csp)
  82 {
  83    return csp->http->server_ssl;
  84 }
  85
  86
  87 /*********************************************************************
  88  *
  89  * Function    :  ssl_send_data_delayed
  90  *
  91  * Description :  Sends the contents of buf (for n bytes) to given SSL
  92  *                connection, optionally delaying the operation.
  93  *
  94  * Parameters  :
  95  *          1  :  ssl_attr = SSL context to send data to
  96  *          2  :  buf = Pointer to data to be sent
  97  *          3  :  len = Length of data to be sent to the SSL context
  98  *          4  :  delay = Delay in milliseconds.
  99  *
 100  * Returns     :  0 on success (entire buffer sent).
 101  *                nonzero on error.
 102  *
 103  *********************************************************************/
 104 extern int ssl_send_data_delayed(struct ssl_attr* ssl_attr,
 105                                  const unsigned char *buf, size_t len,
 106                                  unsigned int delay)
 107 {
 108    size_t i = 0;
 109
 110    if (delay == 0)
 111    {
 112       if (ssl_send_data(ssl_attr, buf, len) < 0)
 113       {
 114          return -1;
 115       }
 116       else
 117       {
 118          return 0;
 119       }
 120    }
 121
 122    while (i < len)
 123    {
 124       size_t write_length;
 125       enum { MAX_WRITE_LENGTH = 10 };
 126
 127       if ((i + MAX_WRITE_LENGTH) > len)
 128       {
 129          write_length = len - i;
 130       }
 131       else
 132       {
 133          write_length = MAX_WRITE_LENGTH;
 134       }
 135
 136       privoxy_millisleep(delay);
 137
 138       if (ssl_send_data(ssl_attr, buf + i, write_length) < 0)
 139       {
 140          return -1;
 141       }
 142       i += write_length;
 143    }
 144
 145    return 0;
 146
 147 }
 148
 149
 150 /*********************************************************************
 151  *
 152  * Function    :  ssl_flush_socket
 153  *
 154  * Description :  Send any pending "buffered" content with given
 155  *                SSL connection. Alternative to function flush_socket.
 156  *
 157  * Parameters  :
 158  *          1  :  ssl_attr = SSL context to send buffer to
 159  *          2  :  iob = The I/O buffer to flush, usually csp->iob.
 160  *
 161  * Returns     :  On success, the number of bytes send are returned (zero
 162  *                indicates nothing was sent).  On error, -1 is returned.
 163  *
 164  *********************************************************************/
 165 extern long ssl_flush_socket(struct ssl_attr *ssl_attr, struct iob *iob)
 166 {
 167    /* Computing length of buffer part to send */
 168    long len = iob->eod - iob->cur;
 169
 170    if (len <= 0)
 171    {
 172       return(0);
 173    }
 174
 175    /* Sending data to given SSl context */
 176    if (ssl_send_data(ssl_attr, (const unsigned char *)iob->cur, (size_t)len) < 0)
 177    {
 178       return -1;
 179    }
 180    iob->eod = iob->cur = iob->buf;
 181    return(len);
 182 }
 183
 184
 185 /*********************************************************************
 186  *
 187  * Function    :  close_client_and_server_ssl_connections
 188  *
 189  * Description :  Checks if client or server should use secured
 190  *                connection over SSL and if so, closes all of them.
 191  *
 192  * Parameters  :
 193  *          1  :  csp = Current client state (buffers, headers, etc...)
 194  *
 195  * Returns     :  N/A
 196  *
 197  *********************************************************************/
 198 extern void close_client_and_server_ssl_connections(struct client_state *csp)
 199 {
 200    if (client_use_ssl(csp) == 1)
 201    {
 202       close_client_ssl_connection(csp);
 203    }
 204    if (server_use_ssl(csp) == 1)
 205    {
 206       close_server_ssl_connection(csp);
 207    }
 208 }
 209
 210
 211 /*********************************************************************
 212  *
 213  * Function    :  tunnel_established_successfully
 214  *
 215  * Description :  Check if parent proxy server response contains
 216  *                information about successfully created connection with
 217  *                destination server. (HTTP/... 2xx ...)
 218  *
 219  * Parameters  :
 220  *          1  :  server_response = Buffer with parent proxy server response
 221  *          2  :  response_len = Length of server_response
 222  *
 223  * Returns     :  1 => Connection created successfully
 224  *                0 => Connection wasn't created successfully
 225  *
 226  *********************************************************************/
 227 extern int tunnel_established_successfully(const char *server_response,
 228    unsigned int response_len)
 229 {
 230    unsigned int pos = 0;
 231
 232    if (server_response == NULL)
 233    {
 234       return 0;
 235    }
 236
 237    /* Tests if "HTTP/" string is at the begin of received response */
 238    if (strncmp(server_response, "HTTP/", 5) != 0)
 239    {
 240       return 0;
 241    }
 242
 243    for (pos = 0; pos < response_len; pos++)
 244    {
 245       if (server_response[pos] == ' ')
 246       {
 247          break;
 248       }
 249    }
 250
 251    /*
 252     * response_len -3 because of buffer end, response structure and 200 code.
 253     * There must be at least 3 chars after space.
 254     * End of buffer: ... 2xx'\0'
 255     *             pos = |
 256     */
 257    if (pos >= (response_len - 3))
 258    {
 259       return 0;
 260    }
 261
 262    /* Test HTTP status code */
 263    if (server_response[pos + 1] != '2')
 264    {
 265       return 0;
 266    }
 267
 268    return 1;
 269 }
 270
 271
 272 /*********************************************************************
 273  *
 274  * Function    :  free_certificate_chain
 275  *
 276  * Description :  Frees certificates linked list. This linked list is
 277  *                used to save information about certificates in
 278  *                trusted chain.
 279  *
 280  * Parameters  :
 281  *          1  :  csp = Current client state (buffers, headers, etc...)
 282  *
 283  * Returns     :  N/A
 284  *
 285  *********************************************************************/
 286 extern void free_certificate_chain(struct client_state *csp)
 287 {
 288    struct certs_chain *cert = csp->server_certs_chain.next;
 289
 290    /* Cleaning buffers */
 291    memset(csp->server_certs_chain.info_buf, 0,
 292       sizeof(csp->server_certs_chain.info_buf));
 293    memset(csp->server_certs_chain.file_buf, 0,
 294       sizeof(csp->server_certs_chain.file_buf));
 295    csp->server_certs_chain.next = NULL;
 296
 297    /* Freeing memory in whole linked list */
 298    while (cert != NULL)
 299    {
 300       struct certs_chain *cert_for_free = cert;
 301       cert = cert->next;
 302       freez(cert_for_free);
 303    }
 304 }
 305
 306
 307 /*********************************************************************
 308  *
 309  * Function    :  ssl_send_certificate_error
 310  *
 311  * Description :  Sends info about invalid server certificate to client.
 312  *                Sent message is including all trusted chain certificates,
 313  *                that can be downloaded in web browser.
 314  *
 315  * Parameters  :
 316  *          1  :  csp = Current client state (buffers, headers, etc...)
 317  *
 318  * Returns     :  N/A
 319  *
 320  *********************************************************************/
 321 extern void ssl_send_certificate_error(struct client_state *csp)
 322 {
 323    struct ssl_attr *ssl_attr = &csp->ssl_client_attr;
 324    size_t message_len = 0;
 325    int ret = 0;
 326    struct certs_chain *cert = NULL;
 327    const size_t head_length = 63;
 328
 329    /* Header of message with certificate information */
 330    const char message_begin[] =
 331       "HTTP/1.1 403 Certificate validation failed\r\n"
 332       "Content-Type: text/html\r\n"
 333       "Connection: close\r\n\r\n"
 334       "<!DOCTYPE html>\n"
 335       "<html><head><title>Server certificate verification failed</title></head>\n"
 336       "<body><h1>Server certificate verification failed</h1>\n"
 337       "<p><a href=\"https://" CGI_SITE_2_HOST "/\">Privoxy</a> was unable "
 338       "to securely connect to the destination server.</p>"
 339       "<p>Reason: ";
 340    const char message_end[] = "</body></html>\n";
 341    char reason[INVALID_CERT_INFO_BUF_SIZE];
 342    memset(reason, 0, sizeof(reason));
 343
 344    /* Get verification message from verification return code */
 345    ssl_crt_verify_info(reason, sizeof(reason), csp);
 346
 347    /*
 348     * Computing total length of message with all certificates inside
 349     */
 350    message_len = strlen(message_begin) + strlen(message_end)
 351                  + strlen(reason) + strlen("</p>") + 1;
 352
 353    cert = &(csp->server_certs_chain);
 354    while (cert->next != NULL)
 355    {
 356       size_t base64_len = 4 * ((strlen(cert->file_buf) + 2) / 3) + 1;
 357
 358       message_len += strlen(cert->info_buf) + strlen("<pre></pre>\n")
 359                      +  base64_len + strlen("<a href=\"data:application"
 360                         "/x-x509-ca-cert;base64,\">Download certificate</a>");
 361       cert = cert->next;
 362    }
 363
 364    /*
 365     * Joining all blocks in one long message
 366     */
 367    char message[message_len];
 368    memset(message, 0, message_len);
 369
 370    strlcpy(message, message_begin, message_len);
 371    strlcat(message, reason       , message_len);
 372    strlcat(message, "</p>"       , message_len);
 373
 374    cert = &(csp->server_certs_chain);
 375    while (cert->next != NULL)
 376    {
 377       size_t olen = 0;
 378       size_t base64_len = 4 * ((strlen(cert->file_buf) + 2) / 3) + 1; /* +1 for terminating null*/
 379       char base64_buf[base64_len];
 380       memset(base64_buf, 0, base64_len);
 381
 382       /* Encoding certificate into base64 code */
 383       ret = ssl_base64_encode((unsigned char*)base64_buf,
 384                base64_len, &olen, (const unsigned char*)cert->file_buf,
 385                strlen(cert->file_buf));
 386       if (ret != 0)
 387       {
 388          log_error(LOG_LEVEL_ERROR,
 389             "Encoding to base64 failed, buffer is to small");
 390       }
 391
 392       strlcat(message, "<pre>",        message_len);
 393       strlcat(message, cert->info_buf, message_len);
 394       strlcat(message, "</pre>\n",     message_len);
 395
 396       if (ret == 0)
 397       {
 398          strlcat(message, "<a href=\"data:application/x-x509-ca-cert;base64,",
 399             message_len);
 400          strlcat(message, base64_buf, message_len);
 401          strlcat(message, "\">Download certificate</a>", message_len);
 402       }
 403
 404       cert = cert->next;
 405    }
 406    strlcat(message, message_end, message_len);
 407
 408    if (0 == strcmpic(csp->http->gpc, "HEAD"))
 409    {
 410       /* Cut off body */
 411       char *header_end = strstr(message, "\r\n\r\n");
 412       if (header_end != NULL)
 413       {
 414          header_end[3] = '\0';
 415       }
 416    }
 417
 418    /*
 419     * Sending final message to client
 420     */
 421    (void)ssl_send_data(ssl_attr, (const unsigned char *)message, strlen(message));
 422
 423    free_certificate_chain(csp);
 424
 425    log_error(LOG_LEVEL_CRUNCH, "Certificate error: %s: https://%s%s",
 426       reason, csp->http->hostport, csp->http->path);
 427    log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s https://%s%s %s\" 403 %lu",
 428       csp->ip_addr_str, csp->http->gpc, csp->http->hostport, csp->http->path,
 429       csp->http->version, message_len-head_length);
 430
 431 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
 432    csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
 433    csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
 434 #endif
 435 }
 436
 437
 438 /*********************************************************************
 439  *
 440  * Function    :  file_exists
 441  *
 442  * Description :  Tests if file exists and is readable.
 443  *
 444  * Parameters  :
 445  *          1  :  path = Path to tested file.
 446  *
 447  * Returns     :  1 => File exists and is readable.
 448  *                0 => File doesn't exist or is not readable.
 449  *
 450  *********************************************************************/
 451 extern int file_exists(const char *path)
 452 {
 453    FILE *f;
 454    if ((f = fopen(path, "r")) != NULL)
 455    {
 456       fclose(f);
 457       return 1;
 458    }
 459
 460    return 0;
 461 }
 462
 463
 464 /*********************************************************************
 465  *
 466  * Function    :  make_certs_path
 467  *
 468  * Description : Creates path to file from three pieces. This function
 469  *               takes parameters and puts them in one new mallocated
 470  *               char * in correct order. Returned variable must be freed
 471  *               by caller. This function is mainly used for creating
 472  *               paths of certificates and keys files.
 473  *
 474  * Parameters  :
 475  *          1  :  conf_dir  = Name/path of directory where is the file.
 476  *                            '.' can be used for current directory.
 477  *          2  :  file_name = Name of file in conf_dir without suffix.
 478  *          3  :  suffix    = Suffix of given file_name.
 479  *
 480  * Returns     :  path => Path was built up successfully
 481  *                NULL => Path can't be built up
 482  *
 483  *********************************************************************/
 484 extern char *make_certs_path(const char *conf_dir, const char *file_name,
 485    const char *suffix)
 486 {
 487    /* Test if all given parameters are valid */
 488    if (conf_dir == NULL || *conf_dir == '\0' || file_name == NULL ||
 489       *file_name == '\0' || suffix == NULL || *suffix == '\0')
 490    {
 491       log_error(LOG_LEVEL_ERROR,
 492          "make_certs_path failed: bad input parameters");
 493       return NULL;
 494    }
 495
 496    char *path = NULL;
 497    size_t path_size = strlen(conf_dir)
 498       + strlen(file_name) + strlen(suffix) + 2;
 499
 500    /* Setting delimiter and editing path length */
 501 #if defined(_WIN32)
 502    char delim[] = "\\";
 503    path_size += 1;
 504 #else /* ifndef _WIN32 */
 505    char delim[] = "/";
 506 #endif /* ifndef _WIN32 */
 507
 508    /*
 509     * Building up path from many parts
 510     */
 511 #if defined(unix)
 512    if (*conf_dir != '/' && basedir && *basedir)
 513    {
 514       /*
 515        * Replacing conf_dir with basedir. This new variable contains
 516        * absolute path to cwd.
 517        */
 518       path_size += strlen(basedir) + 2;
 519       path = zalloc_or_die(path_size);
 520
 521       strlcpy(path, basedir,   path_size);
 522       strlcat(path, delim,     path_size);
 523       strlcat(path, conf_dir,  path_size);
 524       strlcat(path, delim,     path_size);
 525       strlcat(path, file_name, path_size);
 526       strlcat(path, suffix,    path_size);
 527    }
 528    else
 529 #endif /* defined unix */
 530    {
 531       path = zalloc_or_die(path_size);
 532
 533       strlcpy(path, conf_dir,  path_size);
 534       strlcat(path, delim,     path_size);
 535       strlcat(path, file_name, path_size);
 536       strlcat(path, suffix,    path_size);
 537    }
 538
 539    return path;
 540 }
 541
 542
 543 /*********************************************************************
 544  *
 545  * Function    :  get_certificate_serial
 546  *
 547  * Description :  Computes serial number for new certificate from host
 548  *                name hash. This hash must be already saved in csp
 549  *                structure.
 550  *
 551  * Parameters  :
 552  *          1  :  csp = Current client state (buffers, headers, etc...)
 553  *
 554  * Returns     :  Serial number for new certificate
 555  *
 556  *********************************************************************/
 557 extern unsigned long get_certificate_serial(struct client_state *csp)
 558 {
 559    unsigned long exp    = 1;
 560    unsigned long serial = 0;
 561
 562    int i = CERT_SERIAL_NUM_LENGTH;
 563
 564    for (; i >= 0; i--)
 565    {
 566       serial += exp * (unsigned)csp->http->hash_of_host[i];
 567       exp *= 256;
 568    }
 569    return serial;
 570 }
 571
 572
 573 /*********************************************************************
 574  *
 575  * Function    :  generate_certificate_valid_date
 576  *
 577  * Description :  Turns a time_t into the format expected by mbedTLS.
 578  *
 579  * Parameters  :
 580  *          1  :  time_spec = The timestamp to convert
 581  *          2  :  buffer = The buffer to write the date to
 582  *          3  :  buffer_size = The size of the buffer
 583  *          4  :  fmt = format
 584  *
 585  * Returns     :   0 => The conversion worked
 586  *                 1 => The conversion failed
 587  *
 588  *********************************************************************/
 589 static int generate_certificate_valid_date(time_t time_spec, char *buffer,
 590                                            size_t buffer_size, const char *fmt)
 591 {
 592    struct tm valid_date;
 593    struct tm *timeptr;
 594    size_t ret;
 595
 596    timeptr = privoxy_gmtime_r(&time_spec, &valid_date);
 597    if (NULL == timeptr)
 598    {
 599       return 1;
 600    }
 601
 602    ret = strftime(buffer, buffer_size, fmt, timeptr);
 603    if (ret <= 0)
 604    {
 605       return 1;
 606    }
 607
 608    return 0;
 609
 610 }
 611
 612
 613 /*********************************************************************
 614  *
 615  * Function    :  get_certificate_valid_from_date
 616  *
 617  * Description :  Generates a "valid from" date in the format
 618  *                expected by mbedTLS.
 619  *
 620  * Parameters  :
 621  *          1  :  buffer = The buffer to write the date to
 622  *          2  :  buffer_size = The size of the buffer
 623  *          3  :  fmt = format
 624  *
 625  * Returns     :   0 => The generation worked
 626  *                 1 => The generation failed
 627  *
 628  *********************************************************************/
 629 extern int get_certificate_valid_from_date(char *buffer, size_t buffer_size, const char *fmt)
 630 {
 631    time_t time_spec;
 632
 633    time_spec = time(NULL);
 634    /* 1 month in the past */
 635    time_spec -= 30 * 24 * 60 * 60;
 636
 637    return generate_certificate_valid_date(time_spec, buffer, buffer_size, fmt);
 638
 639 }
 640
 641
 642 /*********************************************************************
 643  *
 644  * Function    :  get_certificate_valid_to_date
 645  *
 646  * Description :  Generates a "valid to" date in the format
 647  *                expected by mbedTLS.
 648  *
 649  * Parameters  :
 650  *          1  :  buffer = The buffer to write the date to
 651  *          2  :  buffer_size = The size of the buffer
 652  *          3  :  fmt = format
 653  *
 654  * Returns     :   0 => The generation worked
 655  *                 1 => The generation failed
 656  *
 657  *********************************************************************/
 658 extern int get_certificate_valid_to_date(char *buffer, size_t buffer_size, const char *fmt)
 659 {
 660    time_t time_spec;
 661
 662    time_spec = time(NULL);
 663    /* Three months in the future */
 664    time_spec += 90 * 24 * 60 * 60;
 665
 666    return generate_certificate_valid_date(time_spec, buffer, buffer_size, fmt);
 667
 668 }
 669
 670
 671 /*********************************************************************
 672  *
 673  * Function    :  host_is_ip_address
 674  *
 675  * Description :  Checks whether or not a host is specified by
 676  *                IP address. Does not actually validate the
 677  *                address.
 678  *
 679  * Parameters  :
 680  *          1  :  host = The host name to check
 681  *
 682  * Returns     :   1 => Yes
 683  *                 0 => No
 684  *
 685  *********************************************************************/
 686 extern int host_is_ip_address(const char *host)
 687 {
 688    const char *p;
 689
 690    if (NULL != strstr(host, ":"))
 691    {
 692       /* Assume an IPv6 address. */
 693       return 1;
 694    }
 695
 696    for (p = host; *p; p++)
 697    {
 698       if ((*p != '.') && !privoxy_isdigit(*p))
 699       {
 700          /* Not a dot or digit so it can't be an IPv4 address. */
 701          return 0;
 702       }
 703    }
 704
 705    /*
 706     * Host only consists of dots and digits so
 707     * assume that is an IPv4 address.
 708     */
 709    return 1;
 710
 711 }
 712
 713
 714 /*********************************************************************
 715  *
 716  * Function    :  enforce_sane_certificate_state
 717  *
 718  * Description :  Makes sure the certificate state is sane.
 719  *
 720  * Parameters  :
 721  *          1  :  certificate = Path to the potentionally existing certifcate.
 722  *          2  :  key = Path to the potentionally existing key.
 723  *
 724  * Returns     :   -1 => Error
 725  *                 0 => Certificate state is sane
 726  *
 727  *********************************************************************/
 728 extern int enforce_sane_certificate_state(const char *certificate, const char *key)
 729 {
 730    const int certificate_exists = file_exists(certificate);
 731    const int key_exists = file_exists(key);
 732
 733    if (!certificate_exists && key_exists)
 734    {
 735       log_error(LOG_LEVEL_ERROR,
 736          "A website key already exists but there's no matching certificate. "
 737          "Removing %s before creating a new key and certificate.", key);
 738       if (unlink(key))
 739       {
 740          log_error(LOG_LEVEL_ERROR, "Failed to unlink %s: %E", key);
 741
 742          return -1;
 743       }
 744    }
 745    if (certificate_exists && !key_exists)
 746    {
 747       log_error(LOG_LEVEL_ERROR,
 748          "A certificate exists but there's no matching key. "
 749          "Removing %s before creating a new key and certificate.", certificate);
 750       if (unlink(certificate))
 751       {
 752          log_error(LOG_LEVEL_ERROR, "Failed to unlink %s: %E", certificate);
 753
 754          return -1;
 755       }
 756    }
 757
 758    return 0;
 759
 760 }