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