crypto/bio/bio_lib.c

   1 /* crypto/bio/bio_lib.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 <errno.h>
  61 #include <openssl/crypto.h>
  62 #include "cryptlib.h"
  63 #include <openssl/bio.h>
  64 #include <openssl/stack.h>
  65
  66 static STACK_OF(CRYPTO_EX_DATA_FUNCS) *bio_meth=NULL;
  67 static int bio_meth_num=0;
  68
  69 BIO *BIO_new(BIO_METHOD *method)
  70         {
  71         BIO *ret=NULL;
  72
  73         ret=(BIO *)OPENSSL_malloc(sizeof(BIO));
  74         if (ret == NULL)
  75                 {
  76                 BIOerr(BIO_F_BIO_NEW,ERR_R_MALLOC_FAILURE);
  77                 return(NULL);
  78                 }
  79         if (!BIO_set(ret,method))
  80                 {
  81                 OPENSSL_free(ret);
  82                 ret=NULL;
  83                 }
  84         return(ret);
  85         }
  86
  87 int BIO_set(BIO *bio, BIO_METHOD *method)
  88         {
  89         bio->method=method;
  90         bio->callback=NULL;
  91         bio->cb_arg=NULL;
  92         bio->init=0;
  93         bio->shutdown=1;
  94         bio->flags=0;
  95         bio->retry_reason=0;
  96         bio->num=0;
  97         bio->ptr=NULL;
  98         bio->prev_bio=NULL;
  99         bio->next_bio=NULL;
 100         bio->references=1;
 101         bio->num_read=0L;
 102         bio->num_write=0L;
 103         CRYPTO_new_ex_data(bio_meth,bio,&bio->ex_data);
 104         if (method->create != NULL)
 105                 if (!method->create(bio))
 106                         return(0);
 107         return(1);
 108         }
 109
 110 int BIO_free(BIO *a)
 111         {
 112         int ret=0,i;
 113
 114         if (a == NULL) return(0);
 115
 116         i=CRYPTO_add(&a->references,-1,CRYPTO_LOCK_BIO);
 117 #ifdef REF_PRINT
 118         REF_PRINT("BIO",a);
 119 #endif
 120         if (i > 0) return(1);
 121 #ifdef REF_CHECK
 122         if (i < 0)
 123                 {
 124                 fprintf(stderr,"BIO_free, bad reference count\n");
 125                 abort();
 126                 }
 127 #endif
 128         if ((a->callback != NULL) &&
 129                 ((i=(int)a->callback(a,BIO_CB_FREE,NULL,0,0L,1L)) <= 0))
 130                         return(i);
 131
 132         CRYPTO_free_ex_data(bio_meth,a,&a->ex_data);
 133
 134         if ((a->method == NULL) || (a->method->destroy == NULL)) return(1);
 135         ret=a->method->destroy(a);
 136         OPENSSL_free(a);
 137         return(1);
 138         }
 139
 140 void BIO_vfree(BIO *a)
 141     { BIO_free(a); }
 142
 143 int BIO_read(BIO *b, void *out, int outl)
 144         {
 145         int i;
 146         long (*cb)();
 147
 148         if ((b == NULL) || (b->method == NULL) || (b->method->bread == NULL))
 149                 {
 150                 BIOerr(BIO_F_BIO_READ,BIO_R_UNSUPPORTED_METHOD);
 151                 return(-2);
 152                 }
 153
 154         cb=b->callback;
 155         if ((cb != NULL) &&
 156                 ((i=(int)cb(b,BIO_CB_READ,out,outl,0L,1L)) <= 0))
 157                         return(i);
 158
 159         if (!b->init)
 160                 {
 161                 BIOerr(BIO_F_BIO_READ,BIO_R_UNINITIALIZED);
 162                 return(-2);
 163                 }
 164
 165         i=b->method->bread(b,out,outl);
 166
 167         if (i > 0) b->num_read+=(unsigned long)i;
 168
 169         if (cb != NULL)
 170                 i=(int)cb(b,BIO_CB_READ|BIO_CB_RETURN,out,outl,
 171                         0L,(long)i);
 172         return(i);
 173         }
 174
 175 int BIO_write(BIO *b, const void *in, int inl)
 176         {
 177         int i;
 178         long (*cb)();
 179
 180         if (b == NULL)
 181                 return(0);
 182
 183         cb=b->callback;
 184         if ((b->method == NULL) || (b->method->bwrite == NULL))
 185                 {
 186                 BIOerr(BIO_F_BIO_WRITE,BIO_R_UNSUPPORTED_METHOD);
 187                 return(-2);
 188                 }
 189
 190         if ((cb != NULL) &&
 191                 ((i=(int)cb(b,BIO_CB_WRITE,in,inl,0L,1L)) <= 0))
 192                         return(i);
 193
 194         if (!b->init)
 195                 {
 196                 BIOerr(BIO_F_BIO_WRITE,BIO_R_UNINITIALIZED);
 197                 return(-2);
 198                 }
 199
 200         i=b->method->bwrite(b,in,inl);
 201
 202         if (i > 0) b->num_write+=(unsigned long)i;
 203
 204         /* This is evil and not thread safe.  If the BIO has been freed,
 205          * we must not call the callback.  The only way to be able to
 206          * determine this is the reference count which is now invalid since
 207          * the memory has been free()ed.
 208          */
 209 #ifdef REF_CHECK
 210         if (b->references <= 0) abort();
 211 #endif
 212         if (cb != NULL) /* && (b->references >= 1)) */
 213                 i=(int)cb(b,BIO_CB_WRITE|BIO_CB_RETURN,in,inl,
 214                         0L,(long)i);
 215         return(i);
 216         }
 217
 218 int BIO_puts(BIO *b, const char *in)
 219         {
 220         int i;
 221         long (*cb)();
 222
 223         if ((b == NULL) || (b->method == NULL) || (b->method->bputs == NULL))
 224                 {
 225                 BIOerr(BIO_F_BIO_PUTS,BIO_R_UNSUPPORTED_METHOD);
 226                 return(-2);
 227                 }
 228
 229         cb=b->callback;
 230
 231         if ((cb != NULL) &&
 232                 ((i=(int)cb(b,BIO_CB_PUTS,in,0,0L,1L)) <= 0))
 233                         return(i);
 234
 235         if (!b->init)
 236                 {
 237                 BIOerr(BIO_F_BIO_PUTS,BIO_R_UNINITIALIZED);
 238                 return(-2);
 239                 }
 240
 241         i=b->method->bputs(b,in);
 242
 243         if (cb != NULL)
 244                 i=(int)cb(b,BIO_CB_PUTS|BIO_CB_RETURN,in,0,
 245                         0L,(long)i);
 246         return(i);
 247         }
 248
 249 int BIO_gets(BIO *b, char *in, int inl)
 250         {
 251         int i;
 252         long (*cb)();
 253
 254         if ((b == NULL) || (b->method == NULL) || (b->method->bgets == NULL))
 255                 {
 256                 BIOerr(BIO_F_BIO_GETS,BIO_R_UNSUPPORTED_METHOD);
 257                 return(-2);
 258                 }
 259
 260         cb=b->callback;
 261
 262         if ((cb != NULL) &&
 263                 ((i=(int)cb(b,BIO_CB_GETS,in,inl,0L,1L)) <= 0))
 264                         return(i);
 265
 266         if (!b->init)
 267                 {
 268                 BIOerr(BIO_F_BIO_GETS,BIO_R_UNINITIALIZED);
 269                 return(-2);
 270                 }
 271
 272         i=b->method->bgets(b,in,inl);
 273
 274         if (cb != NULL)
 275                 i=(int)cb(b,BIO_CB_GETS|BIO_CB_RETURN,in,inl,
 276                         0L,(long)i);
 277         return(i);
 278         }
 279
 280 long BIO_int_ctrl(BIO *b, int cmd, long larg, int iarg)
 281         {
 282         int i;
 283
 284         i=iarg;
 285         return(BIO_ctrl(b,cmd,larg,(char *)&i));
 286         }
 287
 288 char *BIO_ptr_ctrl(BIO *b, int cmd, long larg)
 289         {
 290         char *p=NULL;
 291
 292         if (BIO_ctrl(b,cmd,larg,(char *)&p) <= 0)
 293                 return(NULL);
 294         else
 295                 return(p);
 296         }
 297
 298 long BIO_ctrl(BIO *b, int cmd, long larg, void *parg)
 299         {
 300         long ret;
 301         long (*cb)();
 302
 303         if (b == NULL) return(0);
 304
 305         if ((b->method == NULL) || (b->method->ctrl == NULL))
 306                 {
 307                 BIOerr(BIO_F_BIO_CTRL,BIO_R_UNSUPPORTED_METHOD);
 308                 return(-2);
 309                 }
 310
 311         cb=b->callback;
 312
 313         if ((cb != NULL) &&
 314                 ((ret=cb(b,BIO_CB_CTRL,parg,cmd,larg,1L)) <= 0))
 315                 return(ret);
 316
 317         ret=b->method->ctrl(b,cmd,larg,parg);
 318
 319         if (cb != NULL)
 320                 ret=cb(b,BIO_CB_CTRL|BIO_CB_RETURN,parg,cmd,
 321                         larg,ret);
 322         return(ret);
 323         }
 324
 325 long BIO_callback_ctrl(BIO *b, int cmd, void (*fp)(struct bio_st *, int, const char *, int, long, long))
 326         {
 327         long ret;
 328         long (*cb)();
 329
 330         if (b == NULL) return(0);
 331
 332         if ((b->method == NULL) || (b->method->callback_ctrl == NULL))
 333                 {
 334                 BIOerr(BIO_F_BIO_CTRL,BIO_R_UNSUPPORTED_METHOD);
 335                 return(-2);
 336                 }
 337
 338         cb=b->callback;
 339
 340         if ((cb != NULL) &&
 341                 ((ret=cb(b,BIO_CB_CTRL,(void *)&fp,cmd,0,1L)) <= 0))
 342                 return(ret);
 343
 344         ret=b->method->callback_ctrl(b,cmd,fp);
 345
 346         if (cb != NULL)
 347                 ret=cb(b,BIO_CB_CTRL|BIO_CB_RETURN,(void *)&fp,cmd,
 348                         0,ret);
 349         return(ret);
 350         }
 351
 352 /* It is unfortunate to duplicate in functions what the BIO_(w)pending macros
 353  * do; but those macros have inappropriate return type, and for interfacing
 354  * from other programming languages, C macros aren't much of a help anyway. */
 355 size_t BIO_ctrl_pending(BIO *bio)
 356         {
 357         return BIO_ctrl(bio, BIO_CTRL_PENDING, 0, NULL);
 358         }
 359
 360 size_t BIO_ctrl_wpending(BIO *bio)
 361         {
 362         return BIO_ctrl(bio, BIO_CTRL_WPENDING, 0, NULL);
 363         }
 364
 365
 366 /* put the 'bio' on the end of b's list of operators */
 367 BIO *BIO_push(BIO *b, BIO *bio)
 368         {
 369         BIO *lb;
 370
 371         if (b == NULL) return(bio);
 372         lb=b;
 373         while (lb->next_bio != NULL)
 374                 lb=lb->next_bio;
 375         lb->next_bio=bio;
 376         if (bio != NULL)
 377                 bio->prev_bio=lb;
 378         /* called to do internal processing */
 379         BIO_ctrl(b,BIO_CTRL_PUSH,0,NULL);
 380         return(b);
 381         }
 382
 383 /* Remove the first and return the rest */
 384 BIO *BIO_pop(BIO *b)
 385         {
 386         BIO *ret;
 387
 388         if (b == NULL) return(NULL);
 389         ret=b->next_bio;
 390
 391         if (b->prev_bio != NULL)
 392                 b->prev_bio->next_bio=b->next_bio;
 393         if (b->next_bio != NULL)
 394                 b->next_bio->prev_bio=b->prev_bio;
 395
 396         b->next_bio=NULL;
 397         b->prev_bio=NULL;
 398         BIO_ctrl(b,BIO_CTRL_POP,0,NULL);
 399         return(ret);
 400         }
 401
 402 BIO *BIO_get_retry_BIO(BIO *bio, int *reason)
 403         {
 404         BIO *b,*last;
 405
 406         b=last=bio;
 407         for (;;)
 408                 {
 409                 if (!BIO_should_retry(b)) break;
 410                 last=b;
 411                 b=b->next_bio;
 412                 if (b == NULL) break;
 413                 }
 414         if (reason != NULL) *reason=last->retry_reason;
 415         return(last);
 416         }
 417
 418 int BIO_get_retry_reason(BIO *bio)
 419         {
 420         return(bio->retry_reason);
 421         }
 422
 423 BIO *BIO_find_type(BIO *bio, int type)
 424         {
 425         int mt,mask;
 426
 427         mask=type&0xff;
 428         do      {
 429                 if (bio->method != NULL)
 430                         {
 431                         mt=bio->method->type;
 432
 433                         if (!mask)
 434                                 {
 435                                 if (mt & type) return(bio);
 436                                 }
 437                         else if (mt == type)
 438                                 return(bio);
 439                         }
 440                 bio=bio->next_bio;
 441                 } while (bio != NULL);
 442         return(NULL);
 443         }
 444
 445 void BIO_free_all(BIO *bio)
 446         {
 447         BIO *b;
 448         int ref;
 449
 450         while (bio != NULL)
 451                 {
 452                 b=bio;
 453                 ref=b->references;
 454                 bio=bio->next_bio;
 455                 BIO_free(b);
 456                 /* Since ref count > 1, don't free anyone else. */
 457                 if (ref > 1) break;
 458                 }
 459         }
 460
 461 BIO *BIO_dup_chain(BIO *in)
 462         {
 463         BIO *ret=NULL,*eoc=NULL,*bio,*new;
 464
 465         for (bio=in; bio != NULL; bio=bio->next_bio)
 466                 {
 467                 if ((new=BIO_new(bio->method)) == NULL) goto err;
 468                 new->callback=bio->callback;
 469                 new->cb_arg=bio->cb_arg;
 470                 new->init=bio->init;
 471                 new->shutdown=bio->shutdown;
 472                 new->flags=bio->flags;
 473
 474                 /* This will let SSL_s_sock() work with stdin/stdout */
 475                 new->num=bio->num;
 476
 477                 if (!BIO_dup_state(bio,(char *)new))
 478                         {
 479                         BIO_free(new);
 480                         goto err;
 481                         }
 482
 483                 /* copy app data */
 484                 if (!CRYPTO_dup_ex_data(bio_meth,&new->ex_data,&bio->ex_data))
 485                         goto err;
 486
 487                 if (ret == NULL)
 488                         {
 489                         eoc=new;
 490                         ret=eoc;
 491                         }
 492                 else
 493                         {
 494                         BIO_push(eoc,new);
 495                         eoc=new;
 496                         }
 497                 }
 498         return(ret);
 499 err:
 500         if (ret != NULL)
 501                 BIO_free(ret);
 502         return(NULL);
 503         }
 504
 505 void BIO_copy_next_retry(BIO *b)
 506         {
 507         BIO_set_flags(b,BIO_get_retry_flags(b->next_bio));
 508         b->retry_reason=b->next_bio->retry_reason;
 509         }
 510
 511 int BIO_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
 512              CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func)
 513         {
 514         bio_meth_num++;
 515         return(CRYPTO_get_ex_new_index(bio_meth_num-1,&bio_meth,
 516                 argl,argp,new_func,dup_func,free_func));
 517         }
 518
 519 int BIO_set_ex_data(BIO *bio, int idx, void *data)
 520         {
 521         return(CRYPTO_set_ex_data(&(bio->ex_data),idx,data));
 522         }
 523
 524 void *BIO_get_ex_data(BIO *bio, int idx)
 525         {
 526         return(CRYPTO_get_ex_data(&(bio->ex_data),idx));
 527         }
 528
 529 unsigned long BIO_number_read(BIO *bio)
 530 {
 531         if(bio) return bio->num_read;
 532         return 0;
 533 }
 534
 535 unsigned long BIO_number_written(BIO *bio)
 536 {
 537         if(bio) return bio->num_write;
 538         return 0;
 539 }
 540
 541 IMPLEMENT_STACK_OF(BIO)