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 <openssl/ssl.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, void (*fp)());
  75 typedef struct bio_ssl_st
  76         {
  77         SSL *ssl; /* The ssl handle :-) */
  78         /* re-negotiate every time the total number of bytes is this size */
  79         int num_renegotiates;
  80         unsigned long renegotiate_count;
  81         unsigned long byte_count;
  82         unsigned long renegotiate_timeout;
  83         unsigned long last_time;
  84         } BIO_SSL;
  85
  86 static BIO_METHOD methods_sslp=
  87         {
  88         BIO_TYPE_SSL,"ssl",
  89         ssl_write,
  90         ssl_read,
  91         ssl_puts,
  92         NULL, /* ssl_gets, */
  93         ssl_ctrl,
  94         ssl_new,
  95         ssl_free,
  96         ssl_callback_ctrl,
  97         };
  98
  99 BIO_METHOD *BIO_f_ssl(void)
 100         {
 101         return(&methods_sslp);
 102         }
 103
 104 static int ssl_new(BIO *bi)
 105         {
 106         BIO_SSL *bs;
 107
 108         bs=(BIO_SSL *)OPENSSL_malloc(sizeof(BIO_SSL));
 109         if (bs == NULL)
 110                 {
 111                 BIOerr(BIO_F_SSL_NEW,ERR_R_MALLOC_FAILURE);
 112                 return(0);
 113                 }
 114         memset(bs,0,sizeof(BIO_SSL));
 115         bi->init=0;
 116         bi->ptr=(char *)bs;
 117         bi->flags=0;
 118         return(1);
 119         }
 120
 121 static int ssl_free(BIO *a)
 122         {
 123         BIO_SSL *bs;
 124
 125         if (a == NULL) return(0);
 126         bs=(BIO_SSL *)a->ptr;
 127         if (bs->ssl != NULL) SSL_shutdown(bs->ssl);
 128         if (a->shutdown)
 129                 {
 130                 if (a->init && (bs->ssl != NULL))
 131                         SSL_free(bs->ssl);
 132                 a->init=0;
 133                 a->flags=0;
 134                 }
 135         if (a->ptr != NULL)
 136                 OPENSSL_free(a->ptr);
 137         return(1);
 138         }
 139
 140 static int ssl_read(BIO *b, char *out, int outl)
 141         {
 142         int ret=1;
 143         BIO_SSL *sb;
 144         SSL *ssl;
 145         int retry_reason=0;
 146         int r=0;
 147
 148         if (out == NULL) return(0);
 149         sb=(BIO_SSL *)b->ptr;
 150         ssl=sb->ssl;
 151
 152         BIO_clear_retry_flags(b);
 153
 154 #if 0
 155         if (!SSL_is_init_finished(ssl))
 156                 {
 157 /*              ret=SSL_do_handshake(ssl); */
 158                 if (ret > 0)
 159                         {
 160
 161                         outflags=(BIO_FLAGS_READ|BIO_FLAGS_SHOULD_RETRY);
 162                         ret= -1;
 163                         goto end;
 164                         }
 165                 }
 166 #endif
 167 /*      if (ret > 0) */
 168         ret=SSL_read(ssl,out,outl);
 169
 170         switch (SSL_get_error(ssl,ret))
 171                 {
 172         case SSL_ERROR_NONE:
 173                 if (ret <= 0) break;
 174                 if (sb->renegotiate_count > 0)
 175                         {
 176                         sb->byte_count+=ret;
 177                         if (sb->byte_count > sb->renegotiate_count)
 178                                 {
 179                                 sb->byte_count=0;
 180                                 sb->num_renegotiates++;
 181                                 SSL_renegotiate(ssl);
 182                                 r=1;
 183                                 }
 184                         }
 185                 if ((sb->renegotiate_timeout > 0) && (!r))
 186                         {
 187                         unsigned long tm;
 188
 189                         tm=(unsigned long)time(NULL);
 190                         if (tm > sb->last_time+sb->renegotiate_timeout)
 191                                 {
 192                                 sb->last_time=tm;
 193                                 sb->num_renegotiates++;
 194                                 SSL_renegotiate(ssl);
 195                                 }
 196                         }
 197
 198                 break;
 199         case SSL_ERROR_WANT_READ:
 200                 BIO_set_retry_read(b);
 201                 break;
 202         case SSL_ERROR_WANT_WRITE:
 203                 BIO_set_retry_write(b);
 204                 break;
 205         case SSL_ERROR_WANT_X509_LOOKUP:
 206                 BIO_set_retry_special(b);
 207                 retry_reason=BIO_RR_SSL_X509_LOOKUP;
 208                 break;
 209         case SSL_ERROR_WANT_CONNECT:
 210                 BIO_set_retry_special(b);
 211                 retry_reason=BIO_RR_CONNECT;
 212                 break;
 213         case SSL_ERROR_SYSCALL:
 214         case SSL_ERROR_SSL:
 215         case SSL_ERROR_ZERO_RETURN:
 216         default:
 217                 break;
 218                 }
 219
 220         b->retry_reason=retry_reason;
 221         return(ret);
 222         }
 223
 224 static int ssl_write(BIO *b, const char *out, int outl)
 225         {
 226         int ret,r=0;
 227         int retry_reason=0;
 228         SSL *ssl;
 229         BIO_SSL *bs;
 230
 231         if (out == NULL) return(0);
 232         bs=(BIO_SSL *)b->ptr;
 233         ssl=bs->ssl;
 234
 235         BIO_clear_retry_flags(b);
 236
 237 /*      ret=SSL_do_handshake(ssl);
 238         if (ret > 0) */
 239         ret=SSL_write(ssl,out,outl);
 240
 241         switch (SSL_get_error(ssl,ret))
 242                 {
 243         case SSL_ERROR_NONE:
 244                 if (ret <= 0) break;
 245                 if (bs->renegotiate_count > 0)
 246                         {
 247                         bs->byte_count+=ret;
 248                         if (bs->byte_count > bs->renegotiate_count)
 249                                 {
 250                                 bs->byte_count=0;
 251                                 bs->num_renegotiates++;
 252                                 SSL_renegotiate(ssl);
 253                                 r=1;
 254                                 }
 255                         }
 256                 if ((bs->renegotiate_timeout > 0) && (!r))
 257                         {
 258                         unsigned long tm;
 259
 260                         tm=(unsigned long)time(NULL);
 261                         if (tm > bs->last_time+bs->renegotiate_timeout)
 262                                 {
 263                                 bs->last_time=tm;
 264                                 bs->num_renegotiates++;
 265                                 SSL_renegotiate(ssl);
 266                                 }
 267                         }
 268                 break;
 269         case SSL_ERROR_WANT_WRITE:
 270                 BIO_set_retry_write(b);
 271                 break;
 272         case SSL_ERROR_WANT_READ:
 273                 BIO_set_retry_read(b);
 274                 break;
 275         case SSL_ERROR_WANT_X509_LOOKUP:
 276                 BIO_set_retry_special(b);
 277                 retry_reason=BIO_RR_SSL_X509_LOOKUP;
 278                 break;
 279         case SSL_ERROR_WANT_CONNECT:
 280                 BIO_set_retry_special(b);
 281                 retry_reason=BIO_RR_CONNECT;
 282         case SSL_ERROR_SYSCALL:
 283         case SSL_ERROR_SSL:
 284         default:
 285                 break;
 286                 }
 287
 288         b->retry_reason=retry_reason;
 289         return(ret);
 290         }
 291
 292 static long ssl_ctrl(BIO *b, int cmd, long num, void *ptr)
 293         {
 294         SSL **sslp,*ssl;
 295         BIO_SSL *bs;
 296         BIO *dbio,*bio;
 297         long ret=1;
 298
 299         bs=(BIO_SSL *)b->ptr;
 300         ssl=bs->ssl;
 301         if ((ssl == NULL)  && (cmd != BIO_C_SET_SSL))
 302                 return(0);
 303         switch (cmd)
 304                 {
 305         case BIO_CTRL_RESET:
 306                 SSL_shutdown(ssl);
 307
 308                 if (ssl->handshake_func == ssl->method->ssl_connect)
 309                         SSL_set_connect_state(ssl);
 310                 else if (ssl->handshake_func == ssl->method->ssl_accept)
 311                         SSL_set_accept_state(ssl);
 312
 313                 SSL_clear(ssl);
 314
 315                 if (b->next_bio != NULL)
 316                         ret=BIO_ctrl(b->next_bio,cmd,num,ptr);
 317                 else if (ssl->rbio != NULL)
 318                         ret=BIO_ctrl(ssl->rbio,cmd,num,ptr);
 319                 else
 320                         ret=1;
 321                 break;
 322         case BIO_CTRL_INFO:
 323                 ret=0;
 324                 break;
 325         case BIO_C_SSL_MODE:
 326                 if (num) /* client mode */
 327                         SSL_set_connect_state(ssl);
 328                 else
 329                         SSL_set_accept_state(ssl);
 330                 break;
 331         case BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT:
 332                 ret=bs->renegotiate_timeout;
 333                 if (num < 60) num=5;
 334                 bs->renegotiate_timeout=(unsigned long)num;
 335                 bs->last_time=(unsigned long)time(NULL);
 336                 break;
 337         case BIO_C_SET_SSL_RENEGOTIATE_BYTES:
 338                 ret=bs->renegotiate_count;
 339                 if ((long)num >=512)
 340                         bs->renegotiate_count=(unsigned long)num;
 341                 break;
 342         case BIO_C_GET_SSL_NUM_RENEGOTIATES:
 343                 ret=bs->num_renegotiates;
 344                 break;
 345         case BIO_C_SET_SSL:
 346                 if (ssl != NULL)
 347                         ssl_free(b);
 348                 b->shutdown=(int)num;
 349                 ssl=(SSL *)ptr;
 350                 ((BIO_SSL *)b->ptr)->ssl=ssl;
 351                 bio=SSL_get_rbio(ssl);
 352                 if (bio != NULL)
 353                         {
 354                         if (b->next_bio != NULL)
 355                                 BIO_push(bio,b->next_bio);
 356                         b->next_bio=bio;
 357                         CRYPTO_add(&bio->references,1,CRYPTO_LOCK_BIO);
 358                         }
 359                 b->init=1;
 360                 break;
 361         case BIO_C_GET_SSL:
 362                 if (ptr != NULL)
 363                         {
 364                         sslp=(SSL **)ptr;
 365                         *sslp=ssl;
 366                         }
 367                 else
 368                         ret=0;
 369                 break;
 370         case BIO_CTRL_GET_CLOSE:
 371                 ret=b->shutdown;
 372                 break;
 373         case BIO_CTRL_SET_CLOSE:
 374                 b->shutdown=(int)num;
 375                 break;
 376         case BIO_CTRL_WPENDING:
 377                 ret=BIO_ctrl(ssl->wbio,cmd,num,ptr);
 378                 break;
 379         case BIO_CTRL_PENDING:
 380                 ret=SSL_pending(ssl);
 381                 if (ret == 0)
 382                         ret=BIO_pending(ssl->rbio);
 383                 break;
 384         case BIO_CTRL_FLUSH:
 385                 BIO_clear_retry_flags(b);
 386                 ret=BIO_ctrl(ssl->wbio,cmd,num,ptr);
 387                 BIO_copy_next_retry(b);
 388                 break;
 389         case BIO_CTRL_PUSH:
 390                 if ((b->next_bio != NULL) && (b->next_bio != ssl->rbio))
 391                         {
 392                         SSL_set_bio(ssl,b->next_bio,b->next_bio);
 393                         CRYPTO_add(&b->next_bio->references,1,CRYPTO_LOCK_BIO);
 394                         }
 395                 break;
 396         case BIO_CTRL_POP:
 397                 /* ugly bit of a hack */
 398                 if (ssl->rbio != ssl->wbio) /* we are in trouble :-( */
 399                         {
 400                         BIO_free_all(ssl->wbio);
 401                         }
 402                 ssl->wbio=NULL;
 403                 ssl->rbio=NULL;
 404                 break;
 405         case BIO_C_DO_STATE_MACHINE:
 406                 BIO_clear_retry_flags(b);
 407
 408                 b->retry_reason=0;
 409                 ret=(int)SSL_do_handshake(ssl);
 410
 411                 switch (SSL_get_error(ssl,(int)ret))
 412                         {
 413                 case SSL_ERROR_WANT_READ:
 414                         BIO_set_flags(b,
 415                                 BIO_FLAGS_READ|BIO_FLAGS_SHOULD_RETRY);
 416                         break;
 417                 case SSL_ERROR_WANT_WRITE:
 418                         BIO_set_flags(b,
 419                                 BIO_FLAGS_WRITE|BIO_FLAGS_SHOULD_RETRY);
 420                         break;
 421                 case SSL_ERROR_WANT_CONNECT:
 422                         BIO_set_flags(b,
 423                                 BIO_FLAGS_IO_SPECIAL|BIO_FLAGS_SHOULD_RETRY);
 424                         b->retry_reason=b->next_bio->retry_reason;
 425                         break;
 426                 default:
 427                         break;
 428                         }
 429                 break;
 430         case BIO_CTRL_DUP:
 431                 dbio=(BIO *)ptr;
 432                 if (((BIO_SSL *)dbio->ptr)->ssl != NULL)
 433                         SSL_free(((BIO_SSL *)dbio->ptr)->ssl);
 434                 ((BIO_SSL *)dbio->ptr)->ssl=SSL_dup(ssl);
 435                 ((BIO_SSL *)dbio->ptr)->renegotiate_count=
 436                         ((BIO_SSL *)b->ptr)->renegotiate_count;
 437                 ((BIO_SSL *)dbio->ptr)->byte_count=
 438                         ((BIO_SSL *)b->ptr)->byte_count;
 439                 ((BIO_SSL *)dbio->ptr)->renegotiate_timeout=
 440                         ((BIO_SSL *)b->ptr)->renegotiate_timeout;
 441                 ((BIO_SSL *)dbio->ptr)->last_time=
 442                         ((BIO_SSL *)b->ptr)->last_time;
 443                 ret=(((BIO_SSL *)dbio->ptr)->ssl != NULL);
 444                 break;
 445         case BIO_C_GET_FD:
 446                 ret=BIO_ctrl(ssl->rbio,cmd,num,ptr);
 447                 break;
 448         case BIO_CTRL_SET_CALLBACK:
 449                 {
 450 #if 0 /* FIXME: Should this be used?  -- Richard Levitte */
 451                 BIOerr(SSL_F_SSL_CTRL, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 452                 ret = -1;
 453 #else
 454                 ret=0;
 455 #endif
 456                 }
 457                 break;
 458         case BIO_CTRL_GET_CALLBACK:
 459                 {
 460                 void (**fptr)();
 461
 462                 fptr=(void (**)())ptr;
 463                 *fptr=SSL_get_info_callback(ssl);
 464                 }
 465                 break;
 466         default:
 467                 ret=BIO_ctrl(ssl->rbio,cmd,num,ptr);
 468                 break;
 469                 }
 470         return(ret);
 471         }
 472
 473 static long ssl_callback_ctrl(BIO *b, int cmd, void (*fp)())
 474         {
 475         SSL *ssl;
 476         BIO_SSL *bs;
 477         long ret=1;
 478
 479         bs=(BIO_SSL *)b->ptr;
 480         ssl=bs->ssl;
 481         switch (cmd)
 482                 {
 483         case BIO_CTRL_SET_CALLBACK:
 484                 {
 485                 SSL_set_info_callback(ssl,fp);
 486                 }
 487                 break;
 488         default:
 489                 ret=BIO_callback_ctrl(ssl->rbio,cmd,fp);
 490                 break;
 491                 }
 492         return(ret);
 493         }
 494
 495 static int ssl_puts(BIO *bp, const char *str)
 496         {
 497         int n,ret;
 498
 499         n=strlen(str);
 500         ret=BIO_write(bp,str,n);
 501         return(ret);
 502         }
 503
 504 BIO *BIO_new_buffer_ssl_connect(SSL_CTX *ctx)
 505         {
 506         BIO *ret=NULL,*buf=NULL,*ssl=NULL;
 507
 508         if ((buf=BIO_new(BIO_f_buffer())) == NULL)
 509                 return(NULL);
 510         if ((ssl=BIO_new_ssl_connect(ctx)) == NULL)
 511                 goto err;
 512         if ((ret=BIO_push(buf,ssl)) == NULL)
 513                 goto err;
 514         return(ret);
 515 err:
 516         if (buf != NULL) BIO_free(buf);
 517         if (ssl != NULL) BIO_free(ssl);
 518         return(NULL);
 519         }
 520
 521 BIO *BIO_new_ssl_connect(SSL_CTX *ctx)
 522         {
 523         BIO *ret=NULL,*con=NULL,*ssl=NULL;
 524
 525         if ((con=BIO_new(BIO_s_connect())) == NULL)
 526                 return(NULL);
 527         if ((ssl=BIO_new_ssl(ctx,1)) == NULL)
 528                 goto err;
 529         if ((ret=BIO_push(ssl,con)) == NULL)
 530                 goto err;
 531         return(ret);
 532 err:
 533         if (con != NULL) BIO_free(con);
 534         if (ret != NULL) BIO_free(ret);
 535         return(NULL);
 536         }
 537
 538 BIO *BIO_new_ssl(SSL_CTX *ctx, int client)
 539         {
 540         BIO *ret;
 541         SSL *ssl;
 542
 543         if ((ret=BIO_new(BIO_f_ssl())) == NULL)
 544                 return(NULL);
 545         if ((ssl=SSL_new(ctx)) == NULL)
 546                 {
 547                 BIO_free(ret);
 548                 return(NULL);
 549                 }
 550         if (client)
 551                 SSL_set_connect_state(ssl);
 552         else
 553                 SSL_set_accept_state(ssl);
 554
 555         BIO_set_ssl(ret,ssl,BIO_CLOSE);
 556         return(ret);
 557         }
 558
 559 int BIO_ssl_copy_session_id(BIO *t, BIO *f)
 560         {
 561         t=BIO_find_type(t,BIO_TYPE_SSL);
 562         f=BIO_find_type(f,BIO_TYPE_SSL);
 563         if ((t == NULL) || (f == NULL))
 564                 return(0);
 565         if (    (((BIO_SSL *)t->ptr)->ssl == NULL) ||
 566                 (((BIO_SSL *)f->ptr)->ssl == NULL))
 567                 return(0);
 568         SSL_copy_session_id(((BIO_SSL *)t->ptr)->ssl,((BIO_SSL *)f->ptr)->ssl);
 569         return(1);
 570         }
 571
 572 void BIO_ssl_shutdown(BIO *b)
 573         {
 574         SSL *s;
 575
 576         while (b != NULL)
 577                 {
 578                 if (b->method->type == BIO_TYPE_SSL)
 579                         {
 580                         s=((BIO_SSL *)b->ptr)->ssl;
 581                         SSL_shutdown(s);
 582                         break;
 583                         }
 584                 b=b->next_bio;
 585                 }
 586         }