OpenSSL ssl_recv_data(): Include the file descriptor in the log messages
[privoxy.git] / openssl.c
1 /*********************************************************************
2  *
3  * File        :  $Source: /cvsroot/ijbswa/current/openssl.c,v $
4  *
5  * Purpose     :  File with TLS/SSL extension. Contains methods for
6  *                creating, using and closing TLS/SSL connections.
7  *
8  * Copyright   :  Written by and Copyright (c) 2020 Maxim Antonov <mantonov@gmail.com>
9  *                Copyright (C) 2017 Vaclav Svec. FIT CVUT.
10  *                Copyright (C) 2018-2020 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
32 #include <string.h>
33 #include <unistd.h>
34
35 #include <openssl/bn.h>
36 #include <openssl/opensslv.h>
37 #include <openssl/pem.h>
38 #include <openssl/md5.h>
39 #include <openssl/x509v3.h>
40
41 #include "config.h"
42 #include "project.h"
43 #include "miscutil.h"
44 #include "errlog.h"
45 #include "encode.h"
46 #include "jcc.h"
47 #include "ssl.h"
48 #include "ssl_common.h"
49
50 /*
51  * Macros for openssl.c
52  */
53 #define CERTIFICATE_BASIC_CONSTRAINTS            "CA:FALSE"
54 #define CERTIFICATE_SUBJECT_KEY                  "hash"
55 #define CERTIFICATE_AUTHORITY_KEY                "keyid:always"
56 #define CERTIFICATE_ALT_NAME_PREFIX              "DNS:"
57 #define CERTIFICATE_VERSION                      2
58 #define VALID_DATETIME_FMT                       "%y%m%d%H%M%SZ"
59 #define VALID_DATETIME_BUFLEN                    16
60
61 static int generate_webpage_certificate(struct client_state *csp);
62 static void free_client_ssl_structures(struct client_state *csp);
63 static void free_server_ssl_structures(struct client_state *csp);
64 static int ssl_store_cert(struct client_state *csp, X509* crt);
65 static void log_ssl_errors(int debuglevel, const char* fmt, ...) __attribute__((format(printf, 2, 3)));
66
67 static int ssl_inited = 0;
68
69 #if OPENSSL_VERSION_NUMBER < 0x10100000L
70 #define X509_set1_notBefore X509_set_notBefore
71 #define X509_set1_notAfter X509_set_notAfter
72 #define X509_get0_serialNumber X509_get_serialNumber
73 #define X509_get0_notBefore X509_get_notBefore
74 #define X509_get0_notAfter X509_get_notAfter
75 #endif
76
77 /*********************************************************************
78  *
79  * Function    :  openssl_init
80  *
81  * Description :  Initializes OpenSSL library once
82  *
83  * Parameters  :  N/A
84  *
85  * Returns     :  N/A
86  *
87  *********************************************************************/
88 static void openssl_init(void)
89 {
90    if (ssl_inited == 0)
91    {
92       privoxy_mutex_lock(&ssl_init_mutex);
93       if (ssl_inited == 0)
94       {
95 #if OPENSSL_VERSION_NUMBER < 0x10100000L
96          SSL_library_init();
97 #else
98          OPENSSL_init_ssl(0, NULL);
99 #endif
100          SSL_load_error_strings();
101          OpenSSL_add_ssl_algorithms();
102          ssl_inited = 1;
103       }
104       privoxy_mutex_unlock(&ssl_init_mutex);
105    }
106 }
107
108
109 /*********************************************************************
110  *
111  * Function    :  is_ssl_pending
112  *
113  * Description :  Tests if there are some waiting data on ssl connection.
114  *                Only considers data that has actually been received
115  *                locally and ignores data that is still on the fly
116  *                or has not yet been sent by the remote end.
117  *
118  * Parameters  :
119  *          1  :  ssl_attr = SSL context to test
120  *
121  * Returns     :   0 => No data are pending
122  *                >0 => Pending data length
123  *
124  *********************************************************************/
125 extern size_t is_ssl_pending(struct ssl_attr *ssl_attr)
126 {
127    BIO *bio = ssl_attr->openssl_attr.bio;
128    if (bio == NULL)
129    {
130       return 0;
131    }
132
133    return (size_t)BIO_pending(bio);
134 }
135
136
137 /*********************************************************************
138  *
139  * Function    :  ssl_send_data
140  *
141  * Description :  Sends the content of buf (for n bytes) to given SSL
142  *                connection context.
143  *
144  * Parameters  :
145  *          1  :  ssl_attr = SSL context to send data to
146  *          2  :  buf = Pointer to data to be sent
147  *          3  :  len = Length of data to be sent to the SSL context
148  *
149  * Returns     :  Length of sent data or negative value on error.
150  *
151  *********************************************************************/
152 extern int ssl_send_data(struct ssl_attr *ssl_attr, const unsigned char *buf, size_t len)
153 {
154    BIO *bio = ssl_attr->openssl_attr.bio;
155    int ret = 0;
156    int pos = 0; /* Position of unsent part in buffer */
157
158    if (len == 0)
159    {
160       return 0;
161    }
162
163    while (pos < len)
164    {
165       int send_len = (int)len - pos;
166
167       log_error(LOG_LEVEL_WRITING, "TLS: %N", send_len, buf+pos);
168
169       /*
170        * Sending one part of the buffer
171        */
172       while ((ret = BIO_write(bio,
173          (const unsigned char *)(buf + pos),
174          send_len)) <= 0)
175       {
176          if (!BIO_should_retry(bio))
177          {
178             log_ssl_errors(LOG_LEVEL_ERROR,
179                "Sending data over TLS/SSL failed");
180             return -1;
181          }
182       }
183       /* Adding count of sent bytes to position in buffer */
184       pos = pos + ret;
185    }
186
187    return (int)len;
188 }
189
190
191 /*********************************************************************
192  *
193  * Function    :  ssl_recv_data
194  *
195  * Description :  Receives data from given SSL context and puts
196  *                it into buffer.
197  *
198  * Parameters  :
199  *          1  :  ssl_attr = SSL context to receive data from
200  *          2  :  buf = Pointer to buffer where data will be written
201  *          3  :  max_length = Maximum number of bytes to read
202  *
203  * Returns     :  Number of bytes read, 0 for EOF, or -1
204  *                on error.
205  *
206  *********************************************************************/
207 extern int ssl_recv_data(struct ssl_attr *ssl_attr, unsigned char *buf, size_t max_length)
208 {
209    BIO *bio = ssl_attr->openssl_attr.bio;
210    SSL *ssl;
211    int ret = 0;
212    int fd = -1;
213
214    memset(buf, 0, max_length);
215
216    /*
217     * Receiving data from SSL context into buffer
218     */
219    do
220    {
221       ret = BIO_read(bio, buf, (int)max_length);
222    } while (ret <= 0 && BIO_should_retry(bio));
223
224    if (ret < 0)
225    {
226       log_ssl_errors(LOG_LEVEL_ERROR,
227          "Receiving data on socket %d over TLS/SSL failed", fd);
228
229       return -1;
230    }
231
232    if (BIO_get_ssl(bio, &ssl) == 1)
233    {
234       fd = SSL_get_fd(ssl);
235    }
236
237    log_error(LOG_LEVEL_RECEIVED, "TLS from socket %d: %N",
238       fd, ret, buf);
239
240    return ret;
241 }
242
243
244 /*********************************************************************
245  *
246  * Function    :  ssl_store_cert
247  *
248  * Description : This function is called once for each certificate in the
249  *               server's certificate trusted chain and prepares
250  *               information about the certificate. The information can
251  *               be used to inform the user about invalid certificates.
252  *
253  * Parameters  :
254  *          1  :  csp = Current client state (buffers, headers, etc...)
255  *          2  :  crt = certificate from trusted chain
256  *
257  * Returns     :  0 on success and negative value on error
258  *
259  *********************************************************************/
260 static int ssl_store_cert(struct client_state *csp, X509* crt)
261 {
262    long len = 0;
263    struct certs_chain  *last = &(csp->server_certs_chain);
264    int ret = 0;
265    BIO *bio = BIO_new(BIO_s_mem());
266    EVP_PKEY *pkey = NULL;
267    char *bio_mem_data = 0;
268    char *encoded_text;
269    long l;
270    const ASN1_INTEGER *bs;
271 #if OPENSSL_VERSION_NUMBER > 0x10100000L
272    const X509_ALGOR *tsig_alg;
273 #endif
274    int loc;
275
276    if (!bio)
277    {
278       log_ssl_errors(LOG_LEVEL_ERROR, "BIO_new_mem_buf() failed");
279       return -1;
280    }
281
282    /*
283     * Searching for last item in certificates linked list
284     */
285    while (last->next != NULL)
286    {
287       last = last->next;
288    }
289
290    /*
291     * Preparing next item in linked list for next certificate
292     */
293    last->next = malloc_or_die(sizeof(struct certs_chain));
294    last->next->next = NULL;
295    memset(last->next->info_buf, 0, sizeof(last->next->info_buf));
296    memset(last->next->file_buf, 0, sizeof(last->next->file_buf));
297
298    /*
299     * Saving certificate file into buffer
300     */
301    if (!PEM_write_bio_X509(bio, crt))
302    {
303       log_ssl_errors(LOG_LEVEL_ERROR, "PEM_write_X509() failed");
304       ret = -1;
305       goto exit;
306    }
307
308    len = BIO_get_mem_data(bio, &bio_mem_data);
309
310    if (len > (sizeof(last->file_buf) - 1))
311    {
312       log_error(LOG_LEVEL_ERROR,
313          "X509 PEM cert len %ld is larger than buffer len %lu",
314          len, sizeof(last->file_buf) - 1);
315       len = sizeof(last->file_buf) - 1;
316    }
317
318    strncpy(last->file_buf, bio_mem_data, (size_t)len);
319    BIO_free(bio);
320    bio = BIO_new(BIO_s_mem());
321    if (!bio)
322    {
323       log_ssl_errors(LOG_LEVEL_ERROR, "BIO_new_mem_buf() failed");
324       ret = -1;
325       goto exit;
326    }
327
328    /*
329     * Saving certificate information into buffer
330     */
331    l = X509_get_version(crt);
332    if (l >= 0 && l <= 2)
333    {
334       if (BIO_printf(bio, "cert. version     : %ld\n", l + 1) <= 0)
335       {
336          log_ssl_errors(LOG_LEVEL_ERROR, "BIO_printf() for version failed");
337          ret = -1;
338          goto exit;
339       }
340    }
341    else
342    {
343       if (BIO_printf(bio, "cert. version     : Unknown (%ld)\n", l) <= 0)
344       {
345          log_ssl_errors(LOG_LEVEL_ERROR, "BIO_printf() for version failed");
346          ret = -1;
347          goto exit;
348       }
349    }
350
351    if (BIO_puts(bio, "serial number     : ") <= 0)
352    {
353       log_ssl_errors(LOG_LEVEL_ERROR, "BIO_puts() for serial failed");
354       ret = -1;
355       goto exit;
356    }
357    bs = X509_get0_serialNumber(crt);
358    if (bs->length <= (int)sizeof(long))
359    {
360       ERR_set_mark();
361       l = ASN1_INTEGER_get(bs);
362       ERR_pop_to_mark();
363    }
364    else
365    {
366       l = -1;
367    }
368    if (l != -1)
369    {
370       unsigned long ul;
371       const char *neg;
372       if (bs->type == V_ASN1_NEG_INTEGER)
373       {
374          ul = 0 - (unsigned long)l;
375          neg = "-";
376       }
377       else
378       {
379          ul = (unsigned long)l;
380          neg = "";
381       }
382       if (BIO_printf(bio, " %s%lu (%s0x%lx)\n", neg, ul, neg, ul) <= 0)
383       {
384          log_ssl_errors(LOG_LEVEL_ERROR, "BIO_printf() for serial failed");
385          ret = -1;
386          goto exit;
387       }
388    }
389    else
390    {
391       if (bs->type == V_ASN1_NEG_INTEGER)
392       {
393          if (BIO_puts(bio, " (Negative)") < 0)
394          {
395             log_ssl_errors(LOG_LEVEL_ERROR, "BIO_puts() for serial failed");
396             ret = -1;
397             goto exit;
398          }
399       }
400       for (int i = 0; i < bs->length; i++)
401       {
402          if (BIO_printf(bio, "%02x%c", bs->data[i],
403                ((i + 1 == bs->length) ? '\n' : ':')) <= 0)
404          {
405             log_ssl_errors(LOG_LEVEL_ERROR, "BIO_printf() for serial failed");
406             ret = -1;
407             goto exit;
408          }
409       }
410    }
411
412    if (BIO_puts(bio, "issuer name       : ") <= 0)
413    {
414       log_ssl_errors(LOG_LEVEL_ERROR, "BIO_puts() for issuer failed");
415       ret = -1;
416       goto exit;
417    }
418    if (X509_NAME_print_ex(bio, X509_get_issuer_name(crt), 0, 0) < 0)
419    {
420       log_ssl_errors(LOG_LEVEL_ERROR, "X509_NAME_print_ex() for issuer failed");
421       ret = -1;
422       goto exit;
423    }
424
425    if (BIO_puts(bio, "\nsubject name      : ") <= 0)
426    {
427       log_ssl_errors(LOG_LEVEL_ERROR, "BIO_puts() for subject failed");
428       ret = -1;
429       goto exit;
430    }
431    if (X509_NAME_print_ex(bio, X509_get_subject_name(crt), 0, 0) < 0) {
432       log_ssl_errors(LOG_LEVEL_ERROR, "X509_NAME_print_ex() for subject failed");
433       ret = -1;
434       goto exit;
435    }
436
437    if (BIO_puts(bio, "\nissued  on        : ") <= 0)
438    {
439       log_ssl_errors(LOG_LEVEL_ERROR, "BIO_puts() for issued on failed");
440       ret = -1;
441       goto exit;
442    }
443    if (!ASN1_TIME_print(bio, X509_get0_notBefore(crt)))
444    {
445       log_ssl_errors(LOG_LEVEL_ERROR, "ASN1_TIME_print() for issued on failed");
446       ret = -1;
447       goto exit;
448    }
449
450    if (BIO_puts(bio, "\nexpires on        : ") <= 0)
451    {
452       log_ssl_errors(LOG_LEVEL_ERROR, "BIO_puts() for expires on failed");
453       ret = -1;
454       goto exit;
455    }
456    if (!ASN1_TIME_print(bio, X509_get0_notAfter(crt)))
457    {
458       log_ssl_errors(LOG_LEVEL_ERROR, "ASN1_TIME_print() for expires on failed");
459       ret = -1;
460       goto exit;
461    }
462
463 #if OPENSSL_VERSION_NUMBER > 0x10100000L
464    if (BIO_puts(bio, "\nsigned using      : ") <= 0)
465    {
466       log_ssl_errors(LOG_LEVEL_ERROR, "BIO_puts() for signed using failed");
467       ret = -1;
468       goto exit;
469    }
470    tsig_alg = X509_get0_tbs_sigalg(crt);
471    if (!i2a_ASN1_OBJECT(bio, tsig_alg->algorithm))
472    {
473       log_ssl_errors(LOG_LEVEL_ERROR, "i2a_ASN1_OBJECT() for signed using failed");
474       ret = -1;
475       goto exit;
476    }
477 #endif
478    pkey = X509_get_pubkey(crt);
479    if (!pkey)
480    {
481       log_ssl_errors(LOG_LEVEL_ERROR, "X509_get_pubkey() failed");
482       ret = -1;
483       goto exit;
484    }
485 #define BC              "18"
486    switch (EVP_PKEY_base_id(pkey))
487    {
488       case EVP_PKEY_RSA:
489          ret = BIO_printf(bio, "\n%-" BC "s: %d bits", "RSA key size", EVP_PKEY_bits(pkey));
490          break;
491       case EVP_PKEY_DSA:
492          ret = BIO_printf(bio, "\n%-" BC "s: %d bits", "DSA key size", EVP_PKEY_bits(pkey));
493          break;
494       default:
495          ret = BIO_printf(bio, "\n%-" BC "s: %d bits", "non-RSA/DSA key size", EVP_PKEY_bits(pkey));
496          break;
497    }
498    if (ret <= 0)
499    {
500       log_ssl_errors(LOG_LEVEL_ERROR, "BIO_printf() for key size failed");
501       ret = -1;
502       goto exit;
503    }
504
505    loc = X509_get_ext_by_NID(crt, NID_basic_constraints, -1);
506    if (loc != -1)
507    {
508       X509_EXTENSION *ex = X509_get_ext(crt, loc);
509       if (BIO_puts(bio, "\nbasic constraints : ") <= 0)
510       {
511          log_ssl_errors(LOG_LEVEL_ERROR,
512             "BIO_printf() for basic constraints failed");
513          ret = -1;
514          goto exit;
515       }
516       if (!X509V3_EXT_print(bio, ex, 0, 0))
517       {
518          if (!ASN1_STRING_print_ex(bio, X509_EXTENSION_get_data(ex), ASN1_STRFLGS_RFC2253))
519          {
520             log_ssl_errors(LOG_LEVEL_ERROR,
521                "ASN1_STRING_print_ex() for basic constraints failed");
522             ret = -1;
523             goto exit;
524          }
525       }
526    }
527
528    loc = X509_get_ext_by_NID(crt, NID_subject_alt_name, -1);
529    if (loc != -1)
530    {
531       X509_EXTENSION *ex = X509_get_ext(crt, loc);
532       if (BIO_puts(bio, "\nsubject alt name  : ") <= 0)
533       {
534          log_ssl_errors(LOG_LEVEL_ERROR, "BIO_printf() for alt name failed");
535          ret = -1;
536          goto exit;
537       }
538       if (!X509V3_EXT_print(bio, ex, 0, 0))
539       {
540          if (!ASN1_STRING_print_ex(bio, X509_EXTENSION_get_data(ex),
541                ASN1_STRFLGS_RFC2253))
542          {
543             log_ssl_errors(LOG_LEVEL_ERROR,
544                "ASN1_STRING_print_ex() for alt name failed");
545             ret = -1;
546             goto exit;
547          }
548       }
549    }
550
551    loc = X509_get_ext_by_NID(crt, NID_netscape_cert_type, -1);
552    if (loc != -1)
553    {
554       X509_EXTENSION *ex = X509_get_ext(crt, loc);
555       if (BIO_puts(bio, "\ncert. type        : ") <= 0)
556       {
557          log_ssl_errors(LOG_LEVEL_ERROR, "BIO_printf() for cert type failed");
558          ret = -1;
559          goto exit;
560       }
561       if (!X509V3_EXT_print(bio, ex, 0, 0))
562       {
563          if (!ASN1_STRING_print_ex(bio, X509_EXTENSION_get_data(ex),
564                ASN1_STRFLGS_RFC2253))
565          {
566             log_ssl_errors(LOG_LEVEL_ERROR,
567                "ASN1_STRING_print_ex() for cert type failed");
568             ret = -1;
569             goto exit;
570          }
571       }
572    }
573
574    loc = X509_get_ext_by_NID(crt, NID_key_usage, -1);
575    if (loc != -1)
576    {
577       X509_EXTENSION *ex = X509_get_ext(crt, loc);
578       if (BIO_puts(bio, "\nkey usage         : ") <= 0)
579       {
580          log_ssl_errors(LOG_LEVEL_ERROR, "BIO_printf() for key usage failed");
581          ret = -1;
582          goto exit;
583       }
584       if (!X509V3_EXT_print(bio, ex, 0, 0))
585       {
586          if (!ASN1_STRING_print_ex(bio, X509_EXTENSION_get_data(ex),
587                ASN1_STRFLGS_RFC2253))
588          {
589             log_ssl_errors(LOG_LEVEL_ERROR,
590                "ASN1_STRING_print_ex() for key usage failed");
591             ret = -1;
592             goto exit;
593          }
594       }
595    }
596
597    loc = X509_get_ext_by_NID(crt, NID_ext_key_usage, -1);
598    if (loc != -1) {
599       X509_EXTENSION *ex = X509_get_ext(crt, loc);
600       if (BIO_puts(bio, "\next key usage     : ") <= 0)
601       {
602          log_ssl_errors(LOG_LEVEL_ERROR,
603             "BIO_printf() for ext key usage failed");
604          ret = -1;
605          goto exit;
606       }
607       if (!X509V3_EXT_print(bio, ex, 0, 0))
608       {
609          if (!ASN1_STRING_print_ex(bio, X509_EXTENSION_get_data(ex),
610                ASN1_STRFLGS_RFC2253))
611          {
612             log_ssl_errors(LOG_LEVEL_ERROR,
613                "ASN1_STRING_print_ex() for ext key usage failed");
614             ret = -1;
615             goto exit;
616          }
617       }
618    }
619
620    loc = X509_get_ext_by_NID(crt, NID_certificate_policies, -1);
621    if (loc != -1)
622    {
623       X509_EXTENSION *ex = X509_get_ext(crt, loc);
624       if (BIO_puts(bio, "\ncertificate policies : ") <= 0)
625       {
626          log_ssl_errors(LOG_LEVEL_ERROR, "BIO_printf() for certificate policies failed");
627          ret = -1;
628          goto exit;
629       }
630       if (!X509V3_EXT_print(bio, ex, 0, 0))
631       {
632          if (!ASN1_STRING_print_ex(bio, X509_EXTENSION_get_data(ex),
633                ASN1_STRFLGS_RFC2253))
634          {
635             log_ssl_errors(LOG_LEVEL_ERROR,
636                "ASN1_STRING_print_ex() for certificate policies failed");
637             ret = -1;
638             goto exit;
639          }
640       }
641    }
642
643    /* make valgrind happy */
644    static const char zero = 0;
645    BIO_write(bio, &zero, 1);
646
647    len = BIO_get_mem_data(bio, &bio_mem_data);
648    encoded_text = html_encode(bio_mem_data);
649    if (encoded_text == NULL)
650    {
651       log_error(LOG_LEVEL_ERROR,
652          "Failed to HTML-encode the certificate information");
653       ret = -1;
654       goto exit;
655    }
656
657    strlcpy(last->info_buf, encoded_text, sizeof(last->info_buf));
658    freez(encoded_text);
659    ret = 0;
660
661 exit:
662    if (bio)
663    {
664       BIO_free(bio);
665    }
666    if (pkey)
667    {
668       EVP_PKEY_free(pkey);
669    }
670    return ret;
671 }
672
673
674 /*********************************************************************
675  *
676  * Function    :  host_to_hash
677  *
678  * Description :  Creates MD5 hash from host name. Host name is loaded
679  *                from structure csp and saved again into it.
680  *
681  * Parameters  :
682  *          1  :  csp = Current client state (buffers, headers, etc...)
683  *
684  * Returns     :  1 => Error while creating hash
685  *                0 => Hash created successfully
686  *
687  *********************************************************************/
688 static int host_to_hash(struct client_state *csp)
689 {
690    int ret = 0;
691
692    memset(csp->http->hash_of_host, 0, sizeof(csp->http->hash_of_host));
693    MD5((unsigned char *)csp->http->host, strlen(csp->http->host),
694       csp->http->hash_of_host);
695
696    /* Converting hash into string with hex */
697    size_t i = 0;
698    for (; i < 16; i++)
699    {
700       if ((ret = sprintf((char *)csp->http->hash_of_host_hex + 2 * i, "%02x",
701          csp->http->hash_of_host[i])) < 0)
702       {
703          log_error(LOG_LEVEL_ERROR, "Sprintf return value: %d", ret);
704          return -1;
705       }
706    }
707
708    return 0;
709 }
710
711
712 /*********************************************************************
713  *
714  * Function    :  create_client_ssl_connection
715  *
716  * Description :  Creates TLS/SSL secured connection with client
717  *
718  * Parameters  :
719  *          1  :  csp = Current client state (buffers, headers, etc...)
720  *
721  * Returns     :  0 on success, negative value if connection wasn't created
722  *                successfully.
723  *
724  *********************************************************************/
725 extern int create_client_ssl_connection(struct client_state *csp)
726 {
727    struct ssl_attr *ssl_attr = &csp->ssl_client_attr;
728    /* Paths to certificates file and key file */
729    char *key_file  = NULL;
730    char *ca_file   = NULL;
731    char *cert_file = NULL;
732    int ret = 0;
733    SSL *ssl;
734
735    /*
736     * Initializing OpenSSL structures for TLS/SSL connection
737     */
738    openssl_init();
739
740    /*
741     * Preparing hash of host for creating certificates
742     */
743    ret = host_to_hash(csp);
744    if (ret != 0)
745    {
746       log_error(LOG_LEVEL_ERROR, "Generating hash of host failed: %d", ret);
747       ret = -1;
748       goto exit;
749    }
750
751    /*
752     * Preparing paths to certificates files and key file
753     */
754    ca_file   = csp->config->ca_cert_file;
755    cert_file = make_certs_path(csp->config->certificate_directory,
756       (const char *)csp->http->hash_of_host_hex, CERT_FILE_TYPE);
757    key_file  = make_certs_path(csp->config->certificate_directory,
758       (const char *)csp->http->hash_of_host_hex, KEY_FILE_TYPE);
759
760    if (cert_file == NULL || key_file == NULL)
761    {
762       ret = -1;
763       goto exit;
764    }
765
766    /*
767     * Generating certificate for requested host. Mutex to prevent
768     * certificate and key inconsistence must be locked.
769     */
770    privoxy_mutex_lock(&certificate_mutex);
771
772    ret = generate_webpage_certificate(csp);
773    if (ret < 0)
774    {
775       log_error(LOG_LEVEL_ERROR,
776          "Generate_webpage_certificate failed: %d", ret);
777       privoxy_mutex_unlock(&certificate_mutex);
778       ret = -1;
779       goto exit;
780    }
781    privoxy_mutex_unlock(&certificate_mutex);
782
783    if (!(ssl_attr->openssl_attr.ctx = SSL_CTX_new(SSLv23_server_method())))
784    {
785       log_ssl_errors(LOG_LEVEL_ERROR, "Unable to create SSL context");
786       ret = -1;
787       goto exit;
788    }
789
790    /* Set the key and cert */
791    if (SSL_CTX_use_certificate_file(ssl_attr->openssl_attr.ctx,
792          cert_file, SSL_FILETYPE_PEM) != 1)
793    {
794       log_ssl_errors(LOG_LEVEL_ERROR,
795          "Loading webpage certificate %s failed", cert_file);
796       ret = -1;
797       goto exit;
798    }
799
800    if (SSL_CTX_use_PrivateKey_file(ssl_attr->openssl_attr.ctx,
801          key_file, SSL_FILETYPE_PEM) != 1)
802    {
803       log_ssl_errors(LOG_LEVEL_ERROR,
804          "Loading webpage certificate private key %s failed", key_file);
805       ret = -1;
806       goto exit;
807    }
808
809    SSL_CTX_set_options(ssl_attr->openssl_attr.ctx, SSL_OP_NO_SSLv3);
810
811    if (!(ssl_attr->openssl_attr.bio = BIO_new_ssl(ssl_attr->openssl_attr.ctx, 0)))
812    {
813       log_ssl_errors(LOG_LEVEL_ERROR, "Unable to create BIO structure");
814       ret = -1;
815       goto exit;
816    }
817
818    if (BIO_get_ssl(ssl_attr->openssl_attr.bio, &ssl) != 1)
819    {
820       log_ssl_errors(LOG_LEVEL_ERROR, "BIO_get_ssl failed");
821       ret = -1;
822       goto exit;
823    }
824
825    if (!SSL_set_fd(ssl, csp->cfd))
826    {
827       log_ssl_errors(LOG_LEVEL_ERROR, "SSL_set_fd failed");
828       ret = -1;
829       goto exit;
830    }
831
832    /*
833     *  Handshake with client
834     */
835    log_error(LOG_LEVEL_CONNECT,
836       "Performing the TLS/SSL handshake with client. Hash of host: %s",
837       csp->http->hash_of_host_hex);
838    if (BIO_do_handshake(ssl_attr->openssl_attr.bio) != 1)
839    {
840        log_ssl_errors(LOG_LEVEL_ERROR,
841           "The TLS/SSL handshake with the client failed");
842        ret = -1;
843        goto exit;
844    }
845
846    log_error(LOG_LEVEL_CONNECT, "Client successfully connected over TLS/SSL");
847    csp->ssl_with_client_is_opened = 1;
848    ret = 0;
849
850 exit:
851    /*
852     * Freeing allocated paths to files
853     */
854    freez(cert_file);
855    freez(key_file);
856
857    /* Freeing structures if connection wasn't created successfully */
858    if (ret < 0)
859    {
860       free_client_ssl_structures(csp);
861    }
862    return ret;
863 }
864
865
866 /*********************************************************************
867  *
868  * Function    :  close_client_ssl_connection
869  *
870  * Description :  Closes TLS/SSL connection with client. This function
871  *                checks if this connection is already created.
872  *
873  * Parameters  :
874  *          1  :  csp = Current client state (buffers, headers, etc...)
875  *
876  * Returns     :  N/A
877  *
878  *********************************************************************/
879 extern void close_client_ssl_connection(struct client_state *csp)
880 {
881    struct ssl_attr *ssl_attr = &csp->ssl_client_attr;
882    SSL *ssl;
883
884    if (csp->ssl_with_client_is_opened == 0)
885    {
886       return;
887    }
888
889    /*
890     * Notifying the peer that the connection is being closed.
891     */
892    BIO_ssl_shutdown(ssl_attr->openssl_attr.bio);
893    if (BIO_get_ssl(ssl_attr->openssl_attr.bio, &ssl) != 1)
894    {
895       log_ssl_errors(LOG_LEVEL_ERROR,
896          "BIO_get_ssl() failed in close_client_ssl_connection()");
897    }
898    else
899    {
900       /*
901        * Pretend we received a shutdown alert so
902        * the BIO_free_all() call later on returns
903        * quickly.
904        */
905       SSL_set_shutdown(ssl, SSL_RECEIVED_SHUTDOWN);
906    }
907    free_client_ssl_structures(csp);
908    csp->ssl_with_client_is_opened = 0;
909 }
910
911
912 /*********************************************************************
913  *
914  * Function    :  free_client_ssl_structures
915  *
916  * Description :  Frees structures used for SSL communication with
917  *                client.
918  *
919  * Parameters  :
920  *          1  :  csp = Current client state (buffers, headers, etc...)
921  *
922  * Returns     :  N/A
923  *
924  *********************************************************************/
925 static void free_client_ssl_structures(struct client_state *csp)
926 {
927    struct ssl_attr *ssl_attr = &csp->ssl_client_attr;
928
929    if (ssl_attr->openssl_attr.bio)
930    {
931       BIO_free_all(ssl_attr->openssl_attr.bio);
932    }
933    if (ssl_attr->openssl_attr.ctx)
934    {
935       SSL_CTX_free(ssl_attr->openssl_attr.ctx);
936    }
937 }
938
939
940 /*********************************************************************
941  *
942  * Function    :  close_server_ssl_connection
943  *
944  * Description :  Closes TLS/SSL connection with server. This function
945  *                checks if this connection is already opened.
946  *
947  * Parameters  :
948  *          1  :  csp = Current client state (buffers, headers, etc...)
949  *
950  * Returns     :  N/A
951  *
952  *********************************************************************/
953 extern void close_server_ssl_connection(struct client_state *csp)
954 {
955    struct ssl_attr *ssl_attr = &csp->ssl_server_attr;
956    SSL *ssl;
957
958    if (csp->ssl_with_server_is_opened == 0)
959    {
960       return;
961    }
962
963    /*
964    * Notifying the peer that the connection is being closed.
965    */
966    BIO_ssl_shutdown(ssl_attr->openssl_attr.bio);
967    if (BIO_get_ssl(ssl_attr->openssl_attr.bio, &ssl) != 1)
968    {
969       log_ssl_errors(LOG_LEVEL_ERROR,
970          "BIO_get_ssl() failed in close_server_ssl_connection()");
971    }
972    else
973    {
974       /*
975        * Pretend we received a shutdown alert so
976        * the BIO_free_all() call later on returns
977        * quickly.
978        */
979       SSL_set_shutdown(ssl, SSL_RECEIVED_SHUTDOWN);
980    }
981    free_server_ssl_structures(csp);
982    csp->ssl_with_server_is_opened = 0;
983 }
984
985
986 /*********************************************************************
987  *
988  * Function    :  create_server_ssl_connection
989  *
990  * Description :  Creates TLS/SSL secured connection with server.
991  *
992  * Parameters  :
993  *          1  :  csp = Current client state (buffers, headers, etc...)
994  *
995  * Returns     :  0 on success, negative value if connection wasn't created
996  *                successfully.
997  *
998  *********************************************************************/
999 extern int create_server_ssl_connection(struct client_state *csp)
1000 {
1001    openssl_connection_attr *ssl_attrs = &csp->ssl_server_attr.openssl_attr;
1002    int ret = 0;
1003    char *trusted_cas_file = NULL;
1004    STACK_OF(X509) *chain;
1005    SSL *ssl;
1006
1007    csp->server_cert_verification_result = SSL_CERT_NOT_VERIFIED;
1008    csp->server_certs_chain.next = NULL;
1009
1010    /* Setting path to file with trusted CAs */
1011    trusted_cas_file = csp->config->trusted_cas_file;
1012
1013    ssl_attrs->ctx = SSL_CTX_new(SSLv23_method());
1014    if (!ssl_attrs->ctx)
1015    {
1016       log_ssl_errors(LOG_LEVEL_ERROR, "SSL context creation failed");
1017       ret = -1;
1018       goto exit;
1019    }
1020
1021    /*
1022     * Loading file with trusted CAs
1023     */
1024    if (!SSL_CTX_load_verify_locations(ssl_attrs->ctx, trusted_cas_file, NULL))
1025    {
1026       log_ssl_errors(LOG_LEVEL_ERROR, "Loading trusted CAs file %s failed",
1027          trusted_cas_file);
1028       ret = -1;
1029       goto exit;
1030    }
1031
1032    SSL_CTX_set_verify(ssl_attrs->ctx, SSL_VERIFY_NONE, NULL);
1033    SSL_CTX_set_options(ssl_attrs->ctx, SSL_OP_NO_SSLv3);
1034
1035    if (!(ssl_attrs->bio = BIO_new_ssl(ssl_attrs->ctx, 1)))
1036    {
1037       log_ssl_errors(LOG_LEVEL_ERROR, "Unable to create BIO structure");
1038       ret = -1;
1039       goto exit;
1040    }
1041
1042    if (BIO_get_ssl(ssl_attrs->bio, &ssl) != 1)
1043    {
1044       log_ssl_errors(LOG_LEVEL_ERROR, "BIO_get_ssl failed");
1045       ret = -1;
1046       goto exit;
1047    }
1048
1049    if (!SSL_set_fd(ssl, csp->server_connection.sfd))
1050    {
1051       log_ssl_errors(LOG_LEVEL_ERROR, "SSL_set_fd failed");
1052       ret = -1;
1053       goto exit;
1054    }
1055
1056    /*
1057     * Set the hostname to check against the received server certificate
1058     */
1059 #if OPENSSL_VERSION_NUMBER > 0x10100000L
1060    if (!SSL_set1_host(ssl, csp->http->host))
1061    {
1062       log_ssl_errors(LOG_LEVEL_ERROR, "SSL_set1_host failed");
1063       ret = -1;
1064       goto exit;
1065    }
1066 #else
1067    if (host_is_ip_address(csp->http->host))
1068    {
1069       if (X509_VERIFY_PARAM_set1_ip_asc(ssl->param,  csp->http->host) != 1)
1070       {
1071          log_ssl_errors(LOG_LEVEL_ERROR,
1072             "X509_VERIFY_PARAM_set1_ip_asc() failed");
1073          ret = -1;
1074          goto exit;
1075       }
1076    }
1077    else
1078    {
1079       if (X509_VERIFY_PARAM_set1_host(ssl->param,  csp->http->host, 0) != 1)
1080       {
1081          log_ssl_errors(LOG_LEVEL_ERROR,
1082             "X509_VERIFY_PARAM_set1_host() failed");
1083          ret = -1;
1084          goto exit;
1085       }
1086    }
1087 #endif
1088    /* SNI extension */
1089    if (!SSL_set_tlsext_host_name(ssl, csp->http->host))
1090    {
1091       log_ssl_errors(LOG_LEVEL_ERROR, "SSL_set_tlsext_host_name failed");
1092       ret = -1;
1093       goto exit;
1094    }
1095
1096    /*
1097     * Handshake with server
1098     */
1099    log_error(LOG_LEVEL_CONNECT,
1100       "Performing the TLS/SSL handshake with the server");
1101
1102    if (BIO_do_handshake(ssl_attrs->bio) != 1)
1103    {
1104       log_ssl_errors(LOG_LEVEL_ERROR,
1105          "The TLS/SSL handshake with the server failed");
1106       ret = -1;
1107       goto exit;
1108    }
1109
1110    chain = SSL_get_peer_cert_chain(ssl);
1111    if (chain)
1112    {
1113       for (int i = 0; i < sk_X509_num(chain); i++)
1114       {
1115          if (ssl_store_cert(csp, sk_X509_value(chain, i)) != 0)
1116          {
1117             log_error(LOG_LEVEL_ERROR, "ssl_store_cert failed");
1118             ret = -1;
1119             goto exit;
1120          }
1121       }
1122    }
1123
1124    if (!csp->dont_verify_certificate)
1125    {
1126       long verify_result = SSL_get_verify_result(ssl);
1127       if (verify_result == X509_V_OK)
1128       {
1129          ret = 0;
1130          csp->server_cert_verification_result = SSL_CERT_VALID;
1131       }
1132       else
1133       {
1134          csp->server_cert_verification_result = verify_result;
1135          log_error(LOG_LEVEL_ERROR,
1136             "X509 certificate verification for %s failed: %s",
1137             csp->http->hostport, X509_verify_cert_error_string(verify_result));
1138          ret = -1;
1139          goto exit;
1140       }
1141    }
1142
1143    log_error(LOG_LEVEL_CONNECT, "Server successfully connected over TLS/SSL");
1144
1145    /*
1146     * Server certificate chain is valid, so we can clean
1147     * chain, because we will not send it to client.
1148     */
1149    free_certificate_chain(csp);
1150
1151    csp->ssl_with_server_is_opened = 1;
1152 exit:
1153    /* Freeing structures if connection wasn't created successfully */
1154    if (ret < 0)
1155    {
1156       free_server_ssl_structures(csp);
1157    }
1158
1159    return ret;
1160 }
1161
1162
1163 /*********************************************************************
1164  *
1165  * Function    :  free_server_ssl_structures
1166  *
1167  * Description :  Frees structures used for SSL communication with server
1168  *
1169  * Parameters  :
1170  *          1  :  csp = Current client state (buffers, headers, etc...)
1171  *
1172  * Returns     :  N/A
1173  *
1174  *********************************************************************/
1175 static void free_server_ssl_structures(struct client_state *csp)
1176 {
1177    struct ssl_attr *ssl_attr = &csp->ssl_server_attr;
1178
1179    if (ssl_attr->openssl_attr.bio)
1180    {
1181       BIO_free_all(ssl_attr->openssl_attr.bio);
1182    }
1183    if (ssl_attr->openssl_attr.ctx)
1184    {
1185       SSL_CTX_free(ssl_attr->openssl_attr.ctx);
1186    }
1187 }
1188
1189
1190 /*********************************************************************
1191  *
1192  * Function    :  log_ssl_errors
1193  *
1194  * Description :  Log SSL errors
1195  *
1196  * Parameters  :
1197  *          1  :  debuglevel = Debug level
1198  *          2  :  desc = Error description
1199  *
1200  * Returns     :  N/A
1201  *
1202  *********************************************************************/
1203 static void log_ssl_errors(int debuglevel, const char* fmt, ...)
1204 {
1205    unsigned long err_code;
1206    char prefix[ERROR_BUF_SIZE];
1207    va_list args;
1208    va_start(args, fmt);
1209    vsnprintf(prefix, sizeof(prefix), fmt, args);
1210    int reported = 0;
1211
1212    while ((err_code = ERR_get_error()))
1213    {
1214       char err_buf[ERROR_BUF_SIZE];
1215       reported = 1;
1216       ERR_error_string_n(err_code, err_buf, sizeof(err_buf));
1217       log_error(debuglevel, "%s: %s", prefix, err_buf);
1218    }
1219    va_end(args);
1220    /*
1221     * In case if called by mistake and there were
1222     * no TLS/SSL errors let's report it to the log.
1223     */
1224    if (!reported)
1225    {
1226       log_error(debuglevel, "%s: no TLS/SSL errors detected", prefix);
1227    }
1228 }
1229
1230
1231 /*********************************************************************
1232  *
1233  * Function    :  ssl_base64_encode
1234  *
1235  * Description :  Encode a buffer into base64 format.
1236  *
1237  * Parameters  :
1238  *          1  :  dst = Destination buffer
1239  *          2  :  dlen = Destination buffer length
1240  *          3  :  olen = Number of bytes written
1241  *          4  :  src = Source buffer
1242  *          5  :  slen = Amount of data to be encoded
1243  *
1244  * Returns     :  0 on success, error code othervise
1245  *
1246  *********************************************************************/
1247 extern int ssl_base64_encode(unsigned char *dst, size_t dlen, size_t *olen,
1248                              const unsigned char *src, size_t slen)
1249 {
1250    *olen = 4 * ((slen/3)  + ((slen%3) ? 1 : 0)) + 1;
1251    if (*olen < dlen)
1252    {
1253       return ENOBUFS;
1254    }
1255    *olen = (size_t)EVP_EncodeBlock(dst, src, (int)slen) + 1;
1256    return 0;
1257 }
1258
1259
1260 /*********************************************************************
1261  *
1262  * Function    :  close_file_stream
1263  *
1264  * Description :  Close file stream, report error on close error
1265  *
1266  * Parameters  :
1267  *          1  :  f = file stream to close
1268  *          2  :  path = path for error report
1269  *
1270  * Returns     :  N/A
1271  *
1272  *********************************************************************/
1273 static void close_file_stream(FILE *f, const char *path)
1274 {
1275    if (fclose(f) != 0)
1276    {
1277       log_error(LOG_LEVEL_ERROR,
1278          "Error closing file %s: %s", path, strerror(errno));
1279    }
1280 }
1281
1282
1283 /*********************************************************************
1284  *
1285  * Function    :  write_certificate
1286  *
1287  * Description :  Writes certificate into file.
1288  *
1289  * Parameters  :
1290  *          1  :  crt = certificate to write into file
1291  *          2  :  output_file = path to save certificate file
1292  *
1293  *                on error
1294  * Returns     :  1 on success success or negative value
1295  *
1296  *********************************************************************/
1297 static int write_certificate(X509 *crt, const char *output_file)
1298 {
1299    FILE *f = NULL;
1300    int ret = -1;
1301
1302    /*
1303     * Saving certificate into file
1304     */
1305    if ((f = fopen(output_file, "w")) == NULL)
1306    {
1307       log_error(LOG_LEVEL_ERROR, "Opening file %s to save certificate failed",
1308          output_file);
1309       return ret;
1310    }
1311
1312    ret = PEM_write_X509(f, crt);
1313    if (!ret)
1314    {
1315       log_ssl_errors(LOG_LEVEL_ERROR,
1316          "Writing certificate into file %s failed", output_file);
1317       ret = -1;
1318    }
1319
1320    close_file_stream(f, output_file);
1321
1322    return ret;
1323 }
1324
1325 /*********************************************************************
1326  *
1327  * Function    :  write_private_key
1328  *
1329  * Description :  Writes private key into file and copies saved
1330  *                content into given pointer to string. If function
1331  *                returns 0 for success, this copy must be freed by
1332  *                caller.
1333  *
1334  * Parameters  :
1335  *          1  :  key = key to write into file
1336  *          2  :  ret_buf = pointer to string with created key file content
1337  *          3  :  key_file_path = path where to save key file
1338  *
1339  * Returns     :  Length of written private key on success or negative value
1340  *                on error
1341  *
1342  *********************************************************************/
1343 static int write_private_key(EVP_PKEY *key, char **ret_buf,
1344                              const char *key_file_path)
1345 {
1346    size_t len = 0;                /* Length of created key    */
1347    FILE *f = NULL;                /* File to save certificate */
1348    int ret = 0;
1349    BIO *bio_mem = BIO_new(BIO_s_mem());
1350    char *bio_mem_data = 0;
1351
1352    if (bio_mem == NULL)
1353    {
1354       log_ssl_errors(LOG_LEVEL_ERROR, "write_private_key memory allocation failure");
1355       return -1;
1356    }
1357
1358    /*
1359     * Writing private key into PEM string
1360     */
1361    if (!PEM_write_bio_PrivateKey(bio_mem, key, NULL, NULL, 0, NULL, NULL))
1362    {
1363       log_ssl_errors(LOG_LEVEL_ERROR,
1364          "Writing private key into PEM string failed");
1365       ret = -1;
1366       goto exit;
1367    }
1368
1369    len = (size_t)BIO_get_mem_data(bio_mem, &bio_mem_data);
1370
1371    /* Initializing buffer for key file content */
1372    *ret_buf = zalloc_or_die(len + 1);
1373    (*ret_buf)[len] = 0;
1374
1375    strncpy(*ret_buf, bio_mem_data, len);
1376
1377    /*
1378     * Saving key into file
1379     */
1380    if ((f = fopen(key_file_path, "wb")) == NULL)
1381    {
1382       log_error(LOG_LEVEL_ERROR,
1383          "Opening file %s to save private key failed: %E",
1384          key_file_path);
1385       ret = -1;
1386       goto exit;
1387    }
1388
1389    if (fwrite(*ret_buf, 1, len, f) != len)
1390    {
1391       log_error(LOG_LEVEL_ERROR,
1392          "Writing private key into file %s failed",
1393          key_file_path);
1394       close_file_stream(f, key_file_path);
1395       ret = -1;
1396       goto exit;
1397    }
1398
1399    close_file_stream(f, key_file_path);
1400
1401 exit:
1402    BIO_free(bio_mem);
1403    if (ret < 0)
1404    {
1405       freez(*ret_buf);
1406       *ret_buf = NULL;
1407       return ret;
1408    }
1409    return (int)len;
1410 }
1411
1412
1413 /*********************************************************************
1414  *
1415  * Function    :  generate_key
1416  *
1417  * Description : Tests if private key for host saved in csp already
1418  *               exists.  If this file doesn't exists, a new key is
1419  *               generated and saved in a file. The generated key is also
1420  *               copied into given parameter key_buf, which must be then
1421  *               freed by caller. If file with key exists, key_buf
1422  *               contain NULL and no private key is generated.
1423  *
1424  * Parameters  :
1425  *          1  :  csp = Current client state (buffers, headers, etc...)
1426  *          2  :  key_buf = buffer to save new generated key
1427  *
1428  * Returns     :  -1 => Error while generating private key
1429  *                 0 => Key already exists
1430  *                >0 => Length of generated private key
1431  *
1432  *********************************************************************/
1433 static int generate_key(struct client_state *csp, char **key_buf)
1434 {
1435    int ret = 0;
1436    char* key_file_path = NULL;
1437    BIGNUM *exp = BN_new();
1438    RSA *rsa = RSA_new();
1439    EVP_PKEY *key = EVP_PKEY_new();
1440
1441    if (exp == NULL || rsa == NULL || key == NULL)
1442    {
1443       log_ssl_errors(LOG_LEVEL_ERROR, "RSA key memory allocation failure");
1444       ret = -1;
1445       goto exit;
1446    }
1447
1448    if (BN_set_word(exp, RSA_KEY_PUBLIC_EXPONENT) != 1)
1449    {
1450       log_ssl_errors(LOG_LEVEL_ERROR, "Setting RSA key exponent failed");
1451       ret = -1;
1452       goto exit;
1453    }
1454
1455    key_file_path = make_certs_path(csp->config->certificate_directory,
1456       (char *)csp->http->hash_of_host_hex, KEY_FILE_TYPE);
1457    if (key_file_path == NULL)
1458    {
1459       ret = -1;
1460       goto exit;
1461    }
1462
1463    /*
1464     * Test if key already exists. If so, we don't have to create it again.
1465     */
1466    if (file_exists(key_file_path) == 1)
1467    {
1468       ret = 0;
1469       goto exit;
1470    }
1471
1472    ret = RSA_generate_key_ex(rsa, RSA_KEYSIZE, exp, NULL);
1473    if (ret == 0)
1474    {
1475       log_ssl_errors(LOG_LEVEL_ERROR, "RSA key generation failure");
1476       ret = -1;
1477       goto exit;
1478    }
1479
1480    if (!EVP_PKEY_set1_RSA(key, rsa))
1481    {
1482       log_ssl_errors(LOG_LEVEL_ERROR,
1483          "Error assigning RSA key pair to PKEY structure");
1484       ret = -1;
1485       goto exit;
1486    }
1487
1488    /*
1489     * Exporting private key into file
1490     */
1491    if ((ret = write_private_key(key, key_buf, key_file_path)) < 0)
1492    {
1493       log_error(LOG_LEVEL_ERROR,
1494          "Writing private key into file %s failed", key_file_path);
1495       ret = -1;
1496       goto exit;
1497    }
1498
1499 exit:
1500    /*
1501     * Freeing used variables
1502     */
1503    if (exp)
1504    {
1505       BN_free(exp);
1506    }
1507    if (rsa)
1508    {
1509       RSA_free(rsa);
1510    }
1511    if (key)
1512    {
1513       EVP_PKEY_free(key);
1514    }
1515    freez(key_file_path);
1516
1517    return ret;
1518 }
1519
1520
1521 /*********************************************************************
1522  *
1523  * Function    :  ssl_certificate_load
1524  *
1525  * Description :  Loads certificate from file.
1526  *
1527  * Parameters  :
1528  *          1  :  cert_path = The certificate path to load
1529  *
1530  * Returns     :   NULL => error loading certificate,
1531  *                   pointer to certificate instance otherwise
1532  *
1533  *********************************************************************/
1534 static X509* ssl_certificate_load(const char *cert_path)
1535 {
1536    X509 *cert = NULL;
1537    FILE *cert_f = NULL;
1538
1539    if (!(cert_f = fopen(cert_path, "r")))
1540    {
1541       log_error(LOG_LEVEL_ERROR,
1542          "Error opening certificate file %s: %s", cert_path, strerror(errno));
1543       return NULL;
1544    }
1545
1546    if (!(cert = PEM_read_X509(cert_f, NULL, NULL, NULL)))
1547    {
1548       log_ssl_errors(LOG_LEVEL_ERROR,
1549          "Error reading certificate file %s", cert_path);
1550    }
1551
1552    close_file_stream(cert_f, cert_path);
1553    return cert;
1554 }
1555
1556
1557 /*********************************************************************
1558  *
1559  * Function    :  ssl_certificate_is_invalid
1560  *
1561  * Description :  Checks whether or not a certificate is valid.
1562  *                Currently only checks that the certificate can be
1563  *                parsed and that the "valid to" date is in the future.
1564  *
1565  * Parameters  :
1566  *          1  :  cert_file = The certificate to check
1567  *
1568  * Returns     :   0 => The certificate is valid.
1569  *                 1 => The certificate is invalid
1570  *
1571  *********************************************************************/
1572 static int ssl_certificate_is_invalid(const char *cert_file)
1573 {
1574    int ret;
1575
1576    X509 *cert = NULL;
1577
1578    if (!(cert = ssl_certificate_load(cert_file)))
1579    {
1580       log_ssl_errors(LOG_LEVEL_ERROR,
1581          "Error reading certificate file %s", cert_file);
1582       return 1;
1583    }
1584
1585    ret = X509_cmp_current_time(X509_get_notAfter(cert));
1586    if (ret == 0)
1587    {
1588       log_ssl_errors(LOG_LEVEL_ERROR,
1589          "Error checking certificate %s validity", cert_file);
1590       ret = -1;
1591    }
1592
1593    X509_free(cert);
1594
1595    return ret == -1 ? 1 : 0;
1596 }
1597
1598
1599 /*********************************************************************
1600  *
1601  * Function    :  set_x509_ext
1602  *
1603  * Description :  Sets the X509V3 extension data
1604  *
1605  * Parameters  :
1606  *          1  :  cert = The certificate to modify
1607  *          2  :  issuer = Issuer certificate
1608  *          3  :  nid = OpenSSL NID
1609  *          4  :  value = extension value
1610  *
1611  * Returns     :   0 => Error while setting extensuon data
1612  *                 1 => It worked
1613  *
1614  *********************************************************************/
1615 static int set_x509_ext(X509 *cert, X509 *issuer, int nid, char *value)
1616 {
1617    X509_EXTENSION *ext = NULL;
1618    X509V3_CTX ctx;
1619    int ret = 0;
1620
1621    X509V3_set_ctx(&ctx, issuer, cert, NULL, NULL, 0);
1622    ext = X509V3_EXT_conf_nid(NULL, &ctx, nid, value);
1623    if (!ext)
1624    {
1625       log_ssl_errors(LOG_LEVEL_ERROR, "X509V3_EXT_conf_nid failure");
1626       goto exit;
1627    }
1628
1629    if (!X509_add_ext(cert, ext, -1))
1630    {
1631       log_ssl_errors(LOG_LEVEL_ERROR, "X509_add_ext failure");
1632       goto exit;
1633    }
1634
1635    ret = 1;
1636 exit:
1637    if (ext)
1638    {
1639       X509_EXTENSION_free(ext);
1640    }
1641    return ret;
1642 }
1643
1644
1645 /*********************************************************************
1646  *
1647  * Function    :  set_subject_alternative_name
1648  *
1649  * Description :  Sets the Subject Alternative Name extension to a cert
1650  *
1651  * Parameters  :
1652  *          1  :  cert = The certificate to modify
1653  *          2  :  issuer = Issuer certificate
1654  *          3  :  hostname = The hostname to add
1655  *
1656  * Returns     :   0 => Error while creating certificate.
1657  *                 1 => It worked
1658  *
1659  *********************************************************************/
1660 static int set_subject_alternative_name(X509 *cert, X509 *issuer, const char *hostname)
1661 {
1662    size_t altname_len = strlen(hostname) + sizeof(CERTIFICATE_ALT_NAME_PREFIX);
1663    char alt_name_buf[altname_len];
1664
1665    snprintf(alt_name_buf, sizeof(alt_name_buf),
1666       CERTIFICATE_ALT_NAME_PREFIX"%s", hostname);
1667    return set_x509_ext(cert, issuer, NID_subject_alt_name, alt_name_buf);
1668 }
1669
1670
1671 /*********************************************************************
1672  *
1673  * Function    :  generate_webpage_certificate
1674  *
1675  * Description :  Creates certificate file in presetted directory.
1676  *                If certificate already exists, no other certificate
1677  *                will be created. Subject of certificate is named
1678  *                by csp->http->host from parameter. This function also
1679  *                triggers generating of private key for new certificate.
1680  *
1681  * Parameters  :
1682  *          1  :  csp = Current client state (buffers, headers, etc...)
1683  *
1684  * Returns     :  -1 => Error while creating certificate.
1685  *                 0 => Certificate already exists.
1686  *                 1 => Certificate created
1687  *
1688  *********************************************************************/
1689 static int generate_webpage_certificate(struct client_state *csp)
1690 {
1691    char *key_buf = NULL;    /* Buffer for created key */
1692    X509 *issuer_cert = NULL;
1693    X509 *cert = NULL;
1694    BIO *pk_bio = NULL;
1695    EVP_PKEY *loaded_subject_key = NULL;
1696    EVP_PKEY *loaded_issuer_key = NULL;
1697    X509_NAME *issuer_name;
1698    X509_NAME *subject_name = NULL;
1699    ASN1_TIME *asn_time = NULL;
1700    ASN1_INTEGER *serial = NULL;
1701    BIGNUM *serial_num = NULL;
1702
1703    int ret = 0;
1704    cert_options cert_opt;
1705    char cert_valid_from[VALID_DATETIME_BUFLEN];
1706    char cert_valid_to[VALID_DATETIME_BUFLEN];
1707
1708    /* Paths to keys and certificates needed to create certificate */
1709    cert_opt.issuer_key  = NULL;
1710    cert_opt.subject_key = NULL;
1711    cert_opt.issuer_crt  = NULL;
1712
1713    cert_opt.output_file = make_certs_path(csp->config->certificate_directory,
1714       (const char *)csp->http->hash_of_host_hex, CERT_FILE_TYPE);
1715    if (cert_opt.output_file == NULL)
1716    {
1717       return -1;
1718    }
1719
1720    cert_opt.subject_key = make_certs_path(csp->config->certificate_directory,
1721       (const char *)csp->http->hash_of_host_hex, KEY_FILE_TYPE);
1722    if (cert_opt.subject_key == NULL)
1723    {
1724       freez(cert_opt.output_file);
1725       return -1;
1726    }
1727
1728    if (file_exists(cert_opt.output_file) == 1)
1729    {
1730       /* The file exists, but is it valid? */
1731       if (ssl_certificate_is_invalid(cert_opt.output_file))
1732       {
1733          log_error(LOG_LEVEL_CONNECT,
1734             "Certificate %s is no longer valid. Removing it.",
1735             cert_opt.output_file);
1736          if (unlink(cert_opt.output_file))
1737          {
1738             log_error(LOG_LEVEL_ERROR, "Failed to unlink %s: %E",
1739                cert_opt.output_file);
1740
1741             freez(cert_opt.output_file);
1742             freez(cert_opt.subject_key);
1743
1744             return -1;
1745          }
1746          if (unlink(cert_opt.subject_key))
1747          {
1748             log_error(LOG_LEVEL_ERROR, "Failed to unlink %s: %E",
1749                cert_opt.subject_key);
1750
1751             freez(cert_opt.output_file);
1752             freez(cert_opt.subject_key);
1753
1754             return -1;
1755          }
1756       }
1757       else
1758       {
1759          freez(cert_opt.output_file);
1760          freez(cert_opt.subject_key);
1761
1762          return 0;
1763       }
1764    }
1765
1766    /*
1767     * Create key for requested host
1768     */
1769    int subject_key_len = generate_key(csp, &key_buf);
1770    if (subject_key_len < 0)
1771    {
1772       freez(cert_opt.output_file);
1773       freez(cert_opt.subject_key);
1774       log_error(LOG_LEVEL_ERROR, "Key generating failed");
1775       return -1;
1776    }
1777
1778    /*
1779     * Converting unsigned long serial number to char * serial number.
1780     * We must compute length of serial number in string + terminating null.
1781     */
1782    unsigned long certificate_serial = get_certificate_serial(csp);
1783    unsigned long certificate_serial_time = (unsigned long)time(NULL);
1784    int serial_num_size = snprintf(NULL, 0, "%lu%lu",
1785       certificate_serial_time, certificate_serial) + 1;
1786    if (serial_num_size <= 0)
1787    {
1788       serial_num_size = 1;
1789    }
1790
1791    char serial_num_text[serial_num_size];  /* Buffer for serial number */
1792    ret = snprintf(serial_num_text, (size_t)serial_num_size, "%lu%lu",
1793       certificate_serial_time, certificate_serial);
1794    if (ret < 0 || ret >= serial_num_size)
1795    {
1796       log_error(LOG_LEVEL_ERROR,
1797          "Converting certificate serial number into string failed");
1798       ret = -1;
1799       goto exit;
1800    }
1801
1802    /*
1803     * Preparing parameters for certificate
1804     */
1805    subject_name = X509_NAME_new();
1806    if (!subject_name)
1807    {
1808       log_ssl_errors(LOG_LEVEL_ERROR, "RSA key memory allocation failure");
1809       ret = -1;
1810       goto exit;
1811    }
1812
1813    if (!X509_NAME_add_entry_by_txt(subject_name, CERT_PARAM_COMMON_NAME_FCODE,
1814          MBSTRING_ASC, (void *)csp->http->host, -1, -1, 0))
1815    {
1816       log_ssl_errors(LOG_LEVEL_ERROR,
1817          "X509 subject name (code: %s, val: %s) error",
1818          CERT_PARAM_COMMON_NAME_FCODE, csp->http->host);
1819       ret = -1;
1820       goto exit;
1821    }
1822    if (!X509_NAME_add_entry_by_txt(subject_name, CERT_PARAM_ORGANIZATION_FCODE,
1823          MBSTRING_ASC, (void *)csp->http->host, -1, -1, 0))
1824    {
1825       log_ssl_errors(LOG_LEVEL_ERROR,
1826          "X509 subject name (code: %s, val: %s) error",
1827          CERT_PARAM_ORGANIZATION_FCODE, csp->http->host);
1828       ret = -1;
1829       goto exit;
1830    }
1831    if (!X509_NAME_add_entry_by_txt(subject_name, CERT_PARAM_ORG_UNIT_FCODE,
1832          MBSTRING_ASC, (void *)csp->http->host, -1, -1, 0))
1833    {
1834       log_ssl_errors(LOG_LEVEL_ERROR,
1835          "X509 subject name (code: %s, val: %s) error",
1836          CERT_PARAM_ORG_UNIT_FCODE, csp->http->host);
1837       ret = -1;
1838       goto exit;
1839    }
1840    if (!X509_NAME_add_entry_by_txt(subject_name, CERT_PARAM_COUNTRY_FCODE,
1841          MBSTRING_ASC, (void *)CERT_PARAM_COUNTRY_CODE, -1, -1, 0))
1842    {
1843       log_ssl_errors(LOG_LEVEL_ERROR,
1844          "X509 subject name (code: %s, val: %s) error",
1845          CERT_PARAM_COUNTRY_FCODE, csp->http->host);
1846       ret = -1;
1847       goto exit;
1848    }
1849
1850    cert_opt.issuer_crt = csp->config->ca_cert_file;
1851    cert_opt.issuer_key = csp->config->ca_key_file;
1852
1853    if (get_certificate_valid_from_date(cert_valid_from,
1854          sizeof(cert_valid_from), VALID_DATETIME_FMT)
1855     || get_certificate_valid_to_date(cert_valid_to,
1856          sizeof(cert_valid_to), VALID_DATETIME_FMT))
1857    {
1858       log_error(LOG_LEVEL_ERROR, "Generating one of the validity dates failed");
1859       ret = -1;
1860       goto exit;
1861    }
1862
1863    cert_opt.subject_pwd = CERT_SUBJECT_PASSWORD;
1864    cert_opt.issuer_pwd  = csp->config->ca_password;
1865    cert_opt.not_before  = cert_valid_from;
1866    cert_opt.not_after   = cert_valid_to;
1867    cert_opt.serial      = serial_num_text;
1868    cert_opt.max_pathlen = -1;
1869
1870    /*
1871     * Test if the private key was already created.
1872     * XXX: Can this still happen?
1873     */
1874    if (subject_key_len == 0)
1875    {
1876       log_error(LOG_LEVEL_ERROR, "Subject key was already created");
1877       ret = 0;
1878       goto exit;
1879    }
1880
1881    /*
1882     * Parse serial to MPI
1883     */
1884    serial_num = BN_new();
1885    if (!serial_num)
1886    {
1887       log_error(LOG_LEVEL_ERROR, "generate_webpage_certificate: memory error");
1888       ret = -1;
1889       goto exit;
1890    }
1891    if (!BN_dec2bn(&serial_num, cert_opt.serial))
1892    {
1893       log_ssl_errors(LOG_LEVEL_ERROR, "Failed to parse serial %s", cert_opt.serial);
1894       ret = -1;
1895       goto exit;
1896    }
1897
1898    if (!(serial = BN_to_ASN1_INTEGER(serial_num, NULL)))
1899    {
1900       log_ssl_errors(LOG_LEVEL_ERROR, "Failed to generate serial ASN1 representation");
1901       ret = -1;
1902       goto exit;
1903    }
1904
1905    /*
1906     * Loading certificates
1907     */
1908    if (!(issuer_cert = ssl_certificate_load(cert_opt.issuer_crt)))
1909    {
1910       log_error(LOG_LEVEL_ERROR, "Loading issuer certificate %s failed",
1911          cert_opt.issuer_crt);
1912       ret = -1;
1913       goto exit;
1914    }
1915
1916    issuer_name = X509_get_issuer_name(issuer_cert);
1917
1918    /*
1919     * Loading keys from file or from buffer
1920     */
1921    if (key_buf != NULL && subject_key_len > 0)
1922    {
1923       pk_bio = BIO_new_mem_buf(key_buf, subject_key_len);
1924    }
1925    else if (!(pk_bio = BIO_new_file(cert_opt.subject_key, "r")))
1926    {
1927       log_ssl_errors(LOG_LEVEL_ERROR,
1928          "Failure opening subject key %s BIO", cert_opt.subject_key);
1929       ret = -1;
1930       goto exit;
1931    }
1932
1933    loaded_subject_key = PEM_read_bio_PrivateKey(pk_bio, NULL, NULL,
1934       (void *)cert_opt.subject_pwd);
1935    if (!loaded_subject_key)
1936    {
1937       log_ssl_errors(LOG_LEVEL_ERROR, "Parsing subject key %s failed",
1938          cert_opt.subject_key);
1939       ret = -1;
1940       goto exit;
1941    }
1942
1943    if (!BIO_free(pk_bio))
1944    {
1945       log_ssl_errors(LOG_LEVEL_ERROR, "Error closing subject key BIO");
1946    }
1947
1948    if (!(pk_bio = BIO_new_file(cert_opt.issuer_key, "r")))
1949    {
1950       log_ssl_errors(LOG_LEVEL_ERROR, "Failure opening issuer key %s BIO",
1951          cert_opt.issuer_key);
1952       ret = -1;
1953       goto exit;
1954    }
1955
1956    loaded_issuer_key = PEM_read_bio_PrivateKey(pk_bio, NULL, NULL,
1957       (void *)cert_opt.issuer_pwd);
1958    if (!loaded_issuer_key)
1959    {
1960       log_ssl_errors(LOG_LEVEL_ERROR, "Parsing issuer key %s failed",
1961          cert_opt.subject_key);
1962       ret = -1;
1963       goto exit;
1964    }
1965
1966    cert = X509_new();
1967    if (!cert)
1968    {
1969       log_ssl_errors(LOG_LEVEL_ERROR, "Certificate allocation error");
1970       ret = -1;
1971       goto exit;
1972    }
1973
1974    if (!X509_set_version(cert, CERTIFICATE_VERSION))
1975    {
1976       log_ssl_errors(LOG_LEVEL_ERROR, "X509_set_version failed");
1977       ret = -1;
1978       goto exit;
1979    }
1980
1981    /*
1982     * Setting parameters of signed certificate
1983     */
1984    if (!X509_set_pubkey(cert, loaded_subject_key))
1985    {
1986       log_ssl_errors(LOG_LEVEL_ERROR,
1987          "Setting public key in signed certificate failed");
1988       ret = -1;
1989       goto exit;
1990    }
1991
1992    if (!X509_set_subject_name(cert, subject_name))
1993    {
1994       log_ssl_errors(LOG_LEVEL_ERROR,
1995          "Setting subject name in signed certificate failed");
1996       ret = -1;
1997       goto exit;
1998    }
1999
2000    if (!X509_set_issuer_name(cert, issuer_name))
2001    {
2002       log_ssl_errors(LOG_LEVEL_ERROR,
2003          "Setting issuer name in signed certificate failed");
2004       ret = -1;
2005       goto exit;
2006    }
2007
2008    if (!X509_set_serialNumber(cert, serial))
2009    {
2010       log_ssl_errors(LOG_LEVEL_ERROR,
2011          "Setting serial number in signed certificate failed");
2012       ret = -1;
2013       goto exit;
2014    }
2015
2016    asn_time = ASN1_TIME_new();
2017    if (!asn_time)
2018    {
2019       log_ssl_errors(LOG_LEVEL_ERROR, "ASN1 time memory allocation failure");
2020       ret = -1;
2021       goto exit;
2022    }
2023
2024    if (!ASN1_TIME_set_string(asn_time, cert_opt.not_after))
2025    {
2026       log_ssl_errors(LOG_LEVEL_ERROR, "ASN1 time [%s] encode error", cert_opt.not_after);
2027       ret = -1;
2028       goto exit;
2029    }
2030
2031    if (!X509_set1_notAfter(cert, asn_time))
2032    {
2033       log_ssl_errors(LOG_LEVEL_ERROR,
2034          "Setting valid not after in signed certificate failed");
2035       ret = -1;
2036       goto exit;
2037    }
2038
2039    if (!ASN1_TIME_set_string(asn_time, cert_opt.not_before))
2040    {
2041       log_ssl_errors(LOG_LEVEL_ERROR, "ASN1 time encode error");
2042       ret = -1;
2043       goto exit;
2044    }
2045
2046    if (!X509_set1_notBefore(cert, asn_time))
2047    {
2048       log_ssl_errors(LOG_LEVEL_ERROR,
2049          "Setting valid not before in signed certificate failed");
2050       ret = -1;
2051       goto exit;
2052    }
2053
2054    if (!set_x509_ext(cert, issuer_cert, NID_basic_constraints, CERTIFICATE_BASIC_CONSTRAINTS))
2055    {
2056       log_ssl_errors(LOG_LEVEL_ERROR, "Setting the basicConstraints extension "
2057          "in signed certificate failed");
2058       ret = -1;
2059       goto exit;
2060    }
2061
2062    if (!set_x509_ext(cert, issuer_cert, NID_subject_key_identifier, CERTIFICATE_SUBJECT_KEY))
2063    {
2064       log_ssl_errors(LOG_LEVEL_ERROR,
2065          "Setting the Subject Key Identifier extension failed");
2066       ret = -1;
2067       goto exit;
2068    }
2069
2070    if (!set_x509_ext(cert, issuer_cert, NID_authority_key_identifier, CERTIFICATE_AUTHORITY_KEY))
2071    {
2072       log_ssl_errors(LOG_LEVEL_ERROR,
2073          "Setting the Authority Key Identifier extension failed");
2074       ret = -1;
2075       goto exit;
2076    }
2077
2078    if (!host_is_ip_address(csp->http->host) &&
2079        !set_subject_alternative_name(cert, issuer_cert, csp->http->host))
2080    {
2081       log_ssl_errors(LOG_LEVEL_ERROR,
2082          "Setting the Subject Alt Name extension failed");
2083       ret = -1;
2084       goto exit;
2085    }
2086
2087    if (!X509_sign(cert, loaded_issuer_key, EVP_sha256()))
2088    {
2089       log_ssl_errors(LOG_LEVEL_ERROR, "Signing certificate failed");
2090       ret = -1;
2091       goto exit;
2092    }
2093
2094    /*
2095     * Writing certificate into file
2096     */
2097    if (write_certificate(cert, cert_opt.output_file) < 0)
2098    {
2099       log_error(LOG_LEVEL_ERROR, "Writing certificate into file failed");
2100       ret = -1;
2101       goto exit;
2102    }
2103
2104    ret = 1;
2105
2106 exit:
2107    /*
2108     * Freeing used structures
2109     */
2110    if (issuer_cert)
2111    {
2112       X509_free(issuer_cert);
2113    }
2114    if (cert)
2115    {
2116       X509_free(cert);
2117    }
2118    if (pk_bio && !BIO_free(pk_bio))
2119    {
2120       log_ssl_errors(LOG_LEVEL_ERROR, "Error closing pk BIO");
2121    }
2122    if (loaded_subject_key)
2123    {
2124       EVP_PKEY_free(loaded_subject_key);
2125    }
2126    if (loaded_issuer_key)
2127    {
2128       EVP_PKEY_free(loaded_issuer_key);
2129    }
2130    if (subject_name)
2131    {
2132       X509_NAME_free(subject_name);
2133    }
2134    if (asn_time)
2135    {
2136       ASN1_TIME_free(asn_time);
2137    }
2138    if (serial_num)
2139    {
2140       BN_free(serial_num);
2141    }
2142    if (serial)
2143    {
2144       ASN1_INTEGER_free(serial);
2145    }
2146    freez(cert_opt.subject_key);
2147    freez(cert_opt.output_file);
2148    freez(key_buf);
2149
2150    return ret;
2151 }
2152
2153
2154 /*********************************************************************
2155  *
2156  * Function    :  ssl_crt_verify_info
2157  *
2158  * Description :  Returns an informational string about the verification
2159  *                status of a certificate.
2160  *
2161  * Parameters  :
2162  *          1  :  buf = Buffer to write to
2163  *          2  :  size = Maximum size of buffer
2164  *          3  :  csp = client state
2165  *
2166  * Returns     :  N/A
2167  *
2168  *********************************************************************/
2169 extern void ssl_crt_verify_info(char *buf, size_t size, struct client_state *csp)
2170 {
2171    strncpy(buf, X509_verify_cert_error_string(csp->server_cert_verification_result), size);
2172    buf[size - 1] = 0;
2173 }
2174
2175
2176 /*********************************************************************
2177  *
2178  * Function    :  ssl_release
2179  *
2180  * Description :  Release all SSL resources
2181  *
2182  * Parameters  :
2183  *
2184  * Returns     :  N/A
2185  *
2186  *********************************************************************/
2187 extern void ssl_release(void)
2188 {
2189    if (ssl_inited == 1)
2190    {
2191 #ifndef OPENSSL_NO_COMP
2192       SSL_COMP_free_compression_methods();
2193 #endif
2194       CONF_modules_free();
2195       CONF_modules_unload(1);
2196 #ifndef OPENSSL_NO_COMP
2197       COMP_zlib_cleanup();
2198 #endif
2199
2200       ERR_free_strings();
2201       EVP_cleanup();
2202
2203       CRYPTO_cleanup_all_ex_data();
2204    }
2205 }
2206