ssl/bio_ssl.c

   1 /* ssl/bio_ssl.c */
   2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   3  * All rights reserved.
   4  *
   5  * This package is an SSL implementation written
   6  * by Eric Young (eay@cryptsoft.com).
   7  * The implementation was written so as to conform with Netscapes SSL.
   8  *
   9  * This library is free for commercial and non-commercial use as long as
  10  * the following conditions are aheared to.  The following conditions
  11  * apply to all code found in this distribution, be it the RC4, RSA,
  12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  13  * included with this distribution is covered by the same copyright terms
  14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15  *
  16  * Copyright remains Eric Young's, and as such any Copyright notices in
  17  * the code are not to be removed.
  18  * If this package is used in a product, Eric Young should be given attribution
  19  * as the author of the parts of the library used.
  20  * This can be in the form of a textual message at program startup or
  21  * in documentation (online or textual) provided with the package.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  * 1. Redistributions of source code must retain the copyright
  27  *    notice, this list of conditions and the following disclaimer.
  28  * 2. Redistributions in binary form must reproduce the above copyright
  29  *    notice, this list of conditions and the following disclaimer in the
  30  *    documentation and/or other materials provided with the distribution.
  31  * 3. All advertising materials mentioning features or use of this software
  32  *    must display the following acknowledgement:
  33  *    "This product includes cryptographic software written by
  34  *     Eric Young (eay@cryptsoft.com)"
  35  *    The word 'cryptographic' can be left out if the rouines from the library
  36  *    being used are not cryptographic related :-).
  37  * 4. If you include any Windows specific code (or a derivative thereof) from
  38  *    the apps directory (application code) you must include an acknowledgement:
  39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51  * SUCH DAMAGE.
  52  *
  53  * The licence and distribution terms for any publically available version or
  54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  55  * copied and put under another distribution licence
  56  * [including the GNU Public Licence.]
  57  */
  58
  59 #include <stdio.h>
  60 #include <stdlib.h>
  61 #include <string.h>
  62 #include <errno.h>
  63 #include <openssl/crypto.h>
  64 #include <openssl/bio.h>
  65 #include <openssl/err.h>
  66 #include "ssl_locl.h"
  67
  68 static int ssl_write(BIO *h, const char *buf, int num);
  69 static int ssl_read(BIO *h, char *buf, int size);
  70 static int ssl_puts(BIO *h, const char *str);
  71 static long ssl_ctrl(BIO *h, int cmd, long arg1, void *arg2);
  72 static int ssl_new(BIO *h);
  73 static int ssl_free(BIO *data);
  74 static long ssl_callback_ctrl(BIO *h, int cmd, bio_info_cb *fp);
  75 typedef struct bio_ssl_st {
  76     SSL *ssl;                   /* The ssl handle :-) */
  77     /* re-negotiate every time the total number of bytes is this size */
  78     int num_renegotiates;
  79     unsigned long renegotiate_count;
  80     unsigned long byte_count;
  81     unsigned long renegotiate_timeout;
  82     unsigned long last_time;
  83 } BIO_SSL;
  84
  85 static BIO_METHOD methods_sslp = {
  86     BIO_TYPE_SSL, "ssl",
  87     ssl_write,
  88     ssl_read,
  89     ssl_puts,
  90     NULL,                       /* ssl_gets, */
  91     ssl_ctrl,
  92     ssl_new,
  93     ssl_free,
  94     ssl_callback_ctrl,
  95 };
  96
  97 BIO_METHOD *BIO_f_ssl(void)
  98 {
  99     return (&methods_sslp);
 100 }
 101
 102 static int ssl_new(BIO *bi)
 103 {
 104     BIO_SSL *bs;
 105
 106     bs = (BIO_SSL *)OPENSSL_malloc(sizeof(BIO_SSL));
 107     if (bs == NULL) {
 108         BIOerr(BIO_F_SSL_NEW, ERR_R_MALLOC_FAILURE);
 109         return (0);
 110     }
 111     memset(bs, 0, sizeof(BIO_SSL));
 112     bi->init = 0;
 113     bi->ptr = (char *)bs;
 114     bi->flags = 0;
 115     return (1);
 116 }
 117
 118 static int ssl_free(BIO *a)
 119 {
 120     BIO_SSL *bs;
 121
 122     if (a == NULL)
 123         return (0);
 124     bs = (BIO_SSL *)a->ptr;
 125     if (bs->ssl != NULL)
 126         SSL_shutdown(bs->ssl);
 127     if (a->shutdown) {
 128         if (a->init && (bs->ssl != NULL))
 129             SSL_free(bs->ssl);
 130         a->init = 0;
 131         a->flags = 0;
 132     }
 133     if (a->ptr != NULL)
 134         OPENSSL_free(a->ptr);
 135     return (1);
 136 }
 137
 138 static int ssl_read(BIO *b, char *out, int outl)
 139 {
 140     int ret = 1;
 141     BIO_SSL *sb;
 142     SSL *ssl;
 143     int retry_reason = 0;
 144     int r = 0;
 145
 146     if (out == NULL)
 147         return (0);
 148     sb = (BIO_SSL *)b->ptr;
 149     ssl = sb->ssl;
 150
 151     BIO_clear_retry_flags(b);
 152
 153     ret = SSL_read(ssl, out, outl);
 154
 155     switch (SSL_get_error(ssl, ret)) {
 156     case SSL_ERROR_NONE:
 157         if (ret <= 0)
 158             break;
 159         if (sb->renegotiate_count > 0) {
 160             sb->byte_count += ret;
 161             if (sb->byte_count > sb->renegotiate_count) {
 162                 sb->byte_count = 0;
 163                 sb->num_renegotiates++;
 164                 SSL_renegotiate(ssl);
 165                 r = 1;
 166             }
 167         }
 168         if ((sb->renegotiate_timeout > 0) && (!r)) {
 169             unsigned long tm;
 170
 171             tm = (unsigned long)time(NULL);
 172             if (tm > sb->last_time + sb->renegotiate_timeout) {
 173                 sb->last_time = tm;
 174                 sb->num_renegotiates++;
 175                 SSL_renegotiate(ssl);
 176             }
 177         }
 178
 179         break;
 180     case SSL_ERROR_WANT_READ:
 181         BIO_set_retry_read(b);
 182         break;
 183     case SSL_ERROR_WANT_WRITE:
 184         BIO_set_retry_write(b);
 185         break;
 186     case SSL_ERROR_WANT_X509_LOOKUP:
 187         BIO_set_retry_special(b);
 188         retry_reason = BIO_RR_SSL_X509_LOOKUP;
 189         break;
 190     case SSL_ERROR_WANT_ACCEPT:
 191         BIO_set_retry_special(b);
 192         retry_reason = BIO_RR_ACCEPT;
 193         break;
 194     case SSL_ERROR_WANT_CONNECT:
 195         BIO_set_retry_special(b);
 196         retry_reason = BIO_RR_CONNECT;
 197         break;
 198     case SSL_ERROR_SYSCALL:
 199     case SSL_ERROR_SSL:
 200     case SSL_ERROR_ZERO_RETURN:
 201     default:
 202         break;
 203     }
 204
 205     b->retry_reason = retry_reason;
 206     return (ret);
 207 }
 208
 209 static int ssl_write(BIO *b, const char *out, int outl)
 210 {
 211     int ret, r = 0;
 212     int retry_reason = 0;
 213     SSL *ssl;
 214     BIO_SSL *bs;
 215
 216     if (out == NULL)
 217         return (0);
 218     bs = (BIO_SSL *)b->ptr;
 219     ssl = bs->ssl;
 220
 221     BIO_clear_retry_flags(b);
 222
 223     /*
 224      * ret=SSL_do_handshake(ssl); if (ret > 0)
 225      */
 226     ret = SSL_write(ssl, out, outl);
 227
 228     switch (SSL_get_error(ssl, ret)) {
 229     case SSL_ERROR_NONE:
 230         if (ret <= 0)
 231             break;
 232         if (bs->renegotiate_count > 0) {
 233             bs->byte_count += ret;
 234             if (bs->byte_count > bs->renegotiate_count) {
 235                 bs->byte_count = 0;
 236                 bs->num_renegotiates++;
 237                 SSL_renegotiate(ssl);
 238                 r = 1;
 239             }
 240         }
 241         if ((bs->renegotiate_timeout > 0) && (!r)) {
 242             unsigned long tm;
 243
 244             tm = (unsigned long)time(NULL);
 245             if (tm > bs->last_time + bs->renegotiate_timeout) {
 246                 bs->last_time = tm;
 247                 bs->num_renegotiates++;
 248                 SSL_renegotiate(ssl);
 249             }
 250         }
 251         break;
 252     case SSL_ERROR_WANT_WRITE:
 253         BIO_set_retry_write(b);
 254         break;
 255     case SSL_ERROR_WANT_READ:
 256         BIO_set_retry_read(b);
 257         break;
 258     case SSL_ERROR_WANT_X509_LOOKUP:
 259         BIO_set_retry_special(b);
 260         retry_reason = BIO_RR_SSL_X509_LOOKUP;
 261         break;
 262     case SSL_ERROR_WANT_CONNECT:
 263         BIO_set_retry_special(b);
 264         retry_reason = BIO_RR_CONNECT;
 265     case SSL_ERROR_SYSCALL:
 266     case SSL_ERROR_SSL:
 267     default:
 268         break;
 269     }
 270
 271     b->retry_reason = retry_reason;
 272     return (ret);
 273 }
 274
 275 static long ssl_ctrl(BIO *b, int cmd, long num, void *ptr)
 276 {
 277     SSL **sslp, *ssl;
 278     BIO_SSL *bs;
 279     BIO *dbio, *bio;
 280     long ret = 1;
 281
 282     bs = (BIO_SSL *)b->ptr;
 283     ssl = bs->ssl;
 284     if ((ssl == NULL) && (cmd != BIO_C_SET_SSL))
 285         return (0);
 286     switch (cmd) {
 287     case BIO_CTRL_RESET:
 288         SSL_shutdown(ssl);
 289
 290         if (ssl->handshake_func == ssl->method->ssl_connect)
 291             SSL_set_connect_state(ssl);
 292         else if (ssl->handshake_func == ssl->method->ssl_accept)
 293             SSL_set_accept_state(ssl);
 294
 295         SSL_clear(ssl);
 296
 297         if (b->next_bio != NULL)
 298             ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 299         else if (ssl->rbio != NULL)
 300             ret = BIO_ctrl(ssl->rbio, cmd, num, ptr);
 301         else
 302             ret = 1;
 303         break;
 304     case BIO_CTRL_INFO:
 305         ret = 0;
 306         break;
 307     case BIO_C_SSL_MODE:
 308         if (num)                /* client mode */
 309             SSL_set_connect_state(ssl);
 310         else
 311             SSL_set_accept_state(ssl);
 312         break;
 313     case BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT:
 314         ret = bs->renegotiate_timeout;
 315         if (num < 60)
 316             num = 5;
 317         bs->renegotiate_timeout = (unsigned long)num;
 318         bs->last_time = (unsigned long)time(NULL);
 319         break;
 320     case BIO_C_SET_SSL_RENEGOTIATE_BYTES:
 321         ret = bs->renegotiate_count;
 322         if ((long)num >= 512)
 323             bs->renegotiate_count = (unsigned long)num;
 324         break;
 325     case BIO_C_GET_SSL_NUM_RENEGOTIATES:
 326         ret = bs->num_renegotiates;
 327         break;
 328     case BIO_C_SET_SSL:
 329         if (ssl != NULL) {
 330             ssl_free(b);
 331             if (!ssl_new(b))
 332                 return 0;
 333         }
 334         b->shutdown = (int)num;
 335         ssl = (SSL *)ptr;
 336         ((BIO_SSL *)b->ptr)->ssl = ssl;
 337         bio = SSL_get_rbio(ssl);
 338         if (bio != NULL) {
 339             if (b->next_bio != NULL)
 340                 BIO_push(bio, b->next_bio);
 341             b->next_bio = bio;
 342             CRYPTO_add(&bio->references, 1, CRYPTO_LOCK_BIO);
 343         }
 344         b->init = 1;
 345         break;
 346     case BIO_C_GET_SSL:
 347         if (ptr != NULL) {
 348             sslp = (SSL **)ptr;
 349             *sslp = ssl;
 350         } else
 351             ret = 0;
 352         break;
 353     case BIO_CTRL_GET_CLOSE:
 354         ret = b->shutdown;
 355         break;
 356     case BIO_CTRL_SET_CLOSE:
 357         b->shutdown = (int)num;
 358         break;
 359     case BIO_CTRL_WPENDING:
 360         ret = BIO_ctrl(ssl->wbio, cmd, num, ptr);
 361         break;
 362     case BIO_CTRL_PENDING:
 363         ret = SSL_pending(ssl);
 364         if (ret == 0)
 365             ret = BIO_pending(ssl->rbio);
 366         break;
 367     case BIO_CTRL_FLUSH:
 368         BIO_clear_retry_flags(b);
 369         ret = BIO_ctrl(ssl->wbio, cmd, num, ptr);
 370         BIO_copy_next_retry(b);
 371         break;
 372     case BIO_CTRL_PUSH:
 373         if ((b->next_bio != NULL) && (b->next_bio != ssl->rbio)) {
 374             SSL_set_bio(ssl, b->next_bio, b->next_bio);
 375             CRYPTO_add(&b->next_bio->references, 1, CRYPTO_LOCK_BIO);
 376         }
 377         break;
 378     case BIO_CTRL_POP:
 379         /* Only detach if we are the BIO explicitly being popped */
 380         if (b == ptr) {
 381             /*
 382              * Shouldn't happen in practice because the rbio and wbio are the
 383              * same when pushed.
 384              */
 385             if (ssl->rbio != ssl->wbio)
 386                 BIO_free_all(ssl->wbio);
 387             if (b->next_bio != NULL)
 388                 CRYPTO_add(&b->next_bio->references, -1, CRYPTO_LOCK_BIO);
 389             ssl->wbio = NULL;
 390             ssl->rbio = NULL;
 391         }
 392         break;
 393     case BIO_C_DO_STATE_MACHINE:
 394         BIO_clear_retry_flags(b);
 395
 396         b->retry_reason = 0;
 397         ret = (int)SSL_do_handshake(ssl);
 398
 399         switch (SSL_get_error(ssl, (int)ret)) {
 400         case SSL_ERROR_WANT_READ:
 401             BIO_set_flags(b, BIO_FLAGS_READ | BIO_FLAGS_SHOULD_RETRY);
 402             break;
 403         case SSL_ERROR_WANT_WRITE:
 404             BIO_set_flags(b, BIO_FLAGS_WRITE | BIO_FLAGS_SHOULD_RETRY);
 405             break;
 406         case SSL_ERROR_WANT_CONNECT:
 407             BIO_set_flags(b, BIO_FLAGS_IO_SPECIAL | BIO_FLAGS_SHOULD_RETRY);
 408             b->retry_reason = b->next_bio->retry_reason;
 409             break;
 410         default:
 411             break;
 412         }
 413         break;
 414     case BIO_CTRL_DUP:
 415         dbio = (BIO *)ptr;
 416         if (((BIO_SSL *)dbio->ptr)->ssl != NULL)
 417             SSL_free(((BIO_SSL *)dbio->ptr)->ssl);
 418         ((BIO_SSL *)dbio->ptr)->ssl = SSL_dup(ssl);
 419         ((BIO_SSL *)dbio->ptr)->renegotiate_count =
 420             ((BIO_SSL *)b->ptr)->renegotiate_count;
 421         ((BIO_SSL *)dbio->ptr)->byte_count = ((BIO_SSL *)b->ptr)->byte_count;
 422         ((BIO_SSL *)dbio->ptr)->renegotiate_timeout =
 423             ((BIO_SSL *)b->ptr)->renegotiate_timeout;
 424         ((BIO_SSL *)dbio->ptr)->last_time = ((BIO_SSL *)b->ptr)->last_time;
 425         ret = (((BIO_SSL *)dbio->ptr)->ssl != NULL);
 426         break;
 427     case BIO_C_GET_FD:
 428         ret = BIO_ctrl(ssl->rbio, cmd, num, ptr);
 429         break;
 430     case BIO_CTRL_SET_CALLBACK:
 431         {
 432 #if 0                           /* FIXME: Should this be used? -- Richard
 433                                  * Levitte */
 434             SSLerr(SSL_F_SSL_CTRL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 435             ret = -1;
 436 #else
 437             ret = 0;
 438 #endif
 439         }
 440         break;
 441     case BIO_CTRL_GET_CALLBACK:
 442         {
 443             void (**fptr) (const SSL *xssl, int type, int val);
 444
 445             fptr = (void (**)(const SSL *xssl, int type, int val))ptr;
 446             *fptr = SSL_get_info_callback(ssl);
 447         }
 448         break;
 449     default:
 450         ret = BIO_ctrl(ssl->rbio, cmd, num, ptr);
 451         break;
 452     }
 453     return (ret);
 454 }
 455
 456 static long ssl_callback_ctrl(BIO *b, int cmd, bio_info_cb *fp)
 457 {
 458     SSL *ssl;
 459     BIO_SSL *bs;
 460     long ret = 1;
 461
 462     bs = (BIO_SSL *)b->ptr;
 463     ssl = bs->ssl;
 464     switch (cmd) {
 465     case BIO_CTRL_SET_CALLBACK:
 466         {
 467             /*
 468              * FIXME: setting this via a completely different prototype seems
 469              * like a crap idea
 470              */
 471             SSL_set_info_callback(ssl, (void (*)(const SSL *, int, int))fp);
 472         }
 473         break;
 474     default:
 475         ret = BIO_callback_ctrl(ssl->rbio, cmd, fp);
 476         break;
 477     }
 478     return (ret);
 479 }
 480
 481 static int ssl_puts(BIO *bp, const char *str)
 482 {
 483     int n, ret;
 484
 485     n = strlen(str);
 486     ret = BIO_write(bp, str, n);
 487     return (ret);
 488 }
 489
 490 BIO *BIO_new_buffer_ssl_connect(SSL_CTX *ctx)
 491 {
 492 #ifndef OPENSSL_NO_SOCK
 493     BIO *ret = NULL, *buf = NULL, *ssl = NULL;
 494
 495     if ((buf = BIO_new(BIO_f_buffer())) == NULL)
 496         return (NULL);
 497     if ((ssl = BIO_new_ssl_connect(ctx)) == NULL)
 498         goto err;
 499     if ((ret = BIO_push(buf, ssl)) == NULL)
 500         goto err;
 501     return (ret);
 502  err:
 503     if (buf != NULL)
 504         BIO_free(buf);
 505     if (ssl != NULL)
 506         BIO_free(ssl);
 507 #endif
 508     return (NULL);
 509 }
 510
 511 BIO *BIO_new_ssl_connect(SSL_CTX *ctx)
 512 {
 513 #ifndef OPENSSL_NO_SOCK
 514     BIO *ret = NULL, *con = NULL, *ssl = NULL;
 515
 516     if ((con = BIO_new(BIO_s_connect())) == NULL)
 517         return (NULL);
 518     if ((ssl = BIO_new_ssl(ctx, 1)) == NULL)
 519         goto err;
 520     if ((ret = BIO_push(ssl, con)) == NULL)
 521         goto err;
 522     return (ret);
 523  err:
 524     if (con != NULL)
 525         BIO_free(con);
 526 #endif
 527     return (NULL);
 528 }
 529
 530 BIO *BIO_new_ssl(SSL_CTX *ctx, int client)
 531 {
 532     BIO *ret;
 533     SSL *ssl;
 534
 535     if ((ret = BIO_new(BIO_f_ssl())) == NULL)
 536         return (NULL);
 537     if ((ssl = SSL_new(ctx)) == NULL) {
 538         BIO_free(ret);
 539         return (NULL);
 540     }
 541     if (client)
 542         SSL_set_connect_state(ssl);
 543     else
 544         SSL_set_accept_state(ssl);
 545
 546     BIO_set_ssl(ret, ssl, BIO_CLOSE);
 547     return (ret);
 548 }
 549
 550 int BIO_ssl_copy_session_id(BIO *t, BIO *f)
 551 {
 552     t = BIO_find_type(t, BIO_TYPE_SSL);
 553     f = BIO_find_type(f, BIO_TYPE_SSL);
 554     if ((t == NULL) || (f == NULL))
 555         return (0);
 556     if ((((BIO_SSL *)t->ptr)->ssl == NULL) ||
 557         (((BIO_SSL *)f->ptr)->ssl == NULL))
 558         return (0);
 559     SSL_copy_session_id(((BIO_SSL *)t->ptr)->ssl, ((BIO_SSL *)f->ptr)->ssl);
 560     return (1);
 561 }
 562
 563 void BIO_ssl_shutdown(BIO *b)
 564 {
 565     SSL *s;
 566
 567     while (b != NULL) {
 568         if (b->method->type == BIO_TYPE_SSL) {
 569             s = ((BIO_SSL *)b->ptr)->ssl;
 570             SSL_shutdown(s);
 571             break;
 572         }
 573         b = b->next_bio;
 574     }
 575 }