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         if (b->references <= 0) abort();
 210         if (cb != NULL) /* && (b->references >= 1)) */
 211                 i=(int)cb(b,BIO_CB_WRITE|BIO_CB_RETURN,in,inl,
 212                         0L,(long)i);
 213         return(i);
 214         }
 215
 216 int BIO_puts(BIO *b, const char *in)
 217         {
 218         int i;
 219         long (*cb)();
 220
 221         if ((b == NULL) || (b->method == NULL) || (b->method->bputs == NULL))
 222                 {
 223                 BIOerr(BIO_F_BIO_PUTS,BIO_R_UNSUPPORTED_METHOD);
 224                 return(-2);
 225                 }
 226
 227         cb=b->callback;
 228
 229         if ((cb != NULL) &&
 230                 ((i=(int)cb(b,BIO_CB_PUTS,in,0,0L,1L)) <= 0))
 231                         return(i);
 232
 233         if (!b->init)
 234                 {
 235                 BIOerr(BIO_F_BIO_PUTS,BIO_R_UNINITIALIZED);
 236                 return(-2);
 237                 }
 238
 239         i=b->method->bputs(b,in);
 240
 241         if (cb != NULL)
 242                 i=(int)cb(b,BIO_CB_PUTS|BIO_CB_RETURN,in,0,
 243                         0L,(long)i);
 244         return(i);
 245         }
 246
 247 int BIO_gets(BIO *b, char *in, int inl)
 248         {
 249         int i;
 250         long (*cb)();
 251
 252         if ((b == NULL) || (b->method == NULL) || (b->method->bgets == NULL))
 253                 {
 254                 BIOerr(BIO_F_BIO_GETS,BIO_R_UNSUPPORTED_METHOD);
 255                 return(-2);
 256                 }
 257
 258         cb=b->callback;
 259
 260         if ((cb != NULL) &&
 261                 ((i=(int)cb(b,BIO_CB_GETS,in,inl,0L,1L)) <= 0))
 262                         return(i);
 263
 264         if (!b->init)
 265                 {
 266                 BIOerr(BIO_F_BIO_GETS,BIO_R_UNINITIALIZED);
 267                 return(-2);
 268                 }
 269
 270         i=b->method->bgets(b,in,inl);
 271
 272         if (cb != NULL)
 273                 i=(int)cb(b,BIO_CB_GETS|BIO_CB_RETURN,in,inl,
 274                         0L,(long)i);
 275         return(i);
 276         }
 277
 278 long BIO_int_ctrl(BIO *b, int cmd, long larg, int iarg)
 279         {
 280         int i;
 281
 282         i=iarg;
 283         return(BIO_ctrl(b,cmd,larg,(char *)&i));
 284         }
 285
 286 char *BIO_ptr_ctrl(BIO *b, int cmd, long larg)
 287         {
 288         char *p=NULL;
 289
 290         if (BIO_ctrl(b,cmd,larg,(char *)&p) <= 0)
 291                 return(NULL);
 292         else
 293                 return(p);
 294         }
 295
 296 long BIO_ctrl(BIO *b, int cmd, long larg, void *parg)
 297         {
 298         long ret;
 299         long (*cb)();
 300
 301         if (b == NULL) return(0);
 302
 303         if ((b->method == NULL) || (b->method->ctrl == NULL))
 304                 {
 305                 BIOerr(BIO_F_BIO_CTRL,BIO_R_UNSUPPORTED_METHOD);
 306                 return(-2);
 307                 }
 308
 309         cb=b->callback;
 310
 311         if ((cb != NULL) &&
 312                 ((ret=cb(b,BIO_CB_CTRL,parg,cmd,larg,1L)) <= 0))
 313                 return(ret);
 314
 315         ret=b->method->ctrl(b,cmd,larg,parg);
 316
 317         if (cb != NULL)
 318                 ret=cb(b,BIO_CB_CTRL|BIO_CB_RETURN,parg,cmd,
 319                         larg,ret);
 320         return(ret);
 321         }
 322
 323 long BIO_callback_ctrl(BIO *b, int cmd, void (*fp)(struct bio_st *, int, const char *, int, long, long))
 324         {
 325         long ret;
 326         long (*cb)();
 327
 328         if (b == NULL) return(0);
 329
 330         if ((b->method == NULL) || (b->method->callback_ctrl == NULL))
 331                 {
 332                 BIOerr(BIO_F_BIO_CTRL,BIO_R_UNSUPPORTED_METHOD);
 333                 return(-2);
 334                 }
 335
 336         cb=b->callback;
 337
 338         if ((cb != NULL) &&
 339                 ((ret=cb(b,BIO_CB_CTRL,(void *)&fp,cmd,0,1L)) <= 0))
 340                 return(ret);
 341
 342         ret=b->method->callback_ctrl(b,cmd,fp);
 343
 344         if (cb != NULL)
 345                 ret=cb(b,BIO_CB_CTRL|BIO_CB_RETURN,(void *)&fp,cmd,
 346                         0,ret);
 347         return(ret);
 348         }
 349
 350 /* It is unfortunate to duplicate in functions what the BIO_(w)pending macros
 351  * do; but those macros have inappropriate return type, and for interfacing
 352  * from other programming languages, C macros aren't much of a help anyway. */
 353 size_t BIO_ctrl_pending(BIO *bio)
 354         {
 355         return BIO_ctrl(bio, BIO_CTRL_PENDING, 0, NULL);
 356         }
 357
 358 size_t BIO_ctrl_wpending(BIO *bio)
 359         {
 360         return BIO_ctrl(bio, BIO_CTRL_WPENDING, 0, NULL);
 361         }
 362
 363
 364 /* put the 'bio' on the end of b's list of operators */
 365 BIO *BIO_push(BIO *b, BIO *bio)
 366         {
 367         BIO *lb;
 368
 369         if (b == NULL) return(bio);
 370         lb=b;
 371         while (lb->next_bio != NULL)
 372                 lb=lb->next_bio;
 373         lb->next_bio=bio;
 374         if (bio != NULL)
 375                 bio->prev_bio=lb;
 376         /* called to do internal processing */
 377         BIO_ctrl(b,BIO_CTRL_PUSH,0,NULL);
 378         return(b);
 379         }
 380
 381 /* Remove the first and return the rest */
 382 BIO *BIO_pop(BIO *b)
 383         {
 384         BIO *ret;
 385
 386         if (b == NULL) return(NULL);
 387         ret=b->next_bio;
 388
 389         if (b->prev_bio != NULL)
 390                 b->prev_bio->next_bio=b->next_bio;
 391         if (b->next_bio != NULL)
 392                 b->next_bio->prev_bio=b->prev_bio;
 393
 394         b->next_bio=NULL;
 395         b->prev_bio=NULL;
 396         BIO_ctrl(b,BIO_CTRL_POP,0,NULL);
 397         return(ret);
 398         }
 399
 400 BIO *BIO_get_retry_BIO(BIO *bio, int *reason)
 401         {
 402         BIO *b,*last;
 403
 404         b=last=bio;
 405         for (;;)
 406                 {
 407                 if (!BIO_should_retry(b)) break;
 408                 last=b;
 409                 b=b->next_bio;
 410                 if (b == NULL) break;
 411                 }
 412         if (reason != NULL) *reason=last->retry_reason;
 413         return(last);
 414         }
 415
 416 int BIO_get_retry_reason(BIO *bio)
 417         {
 418         return(bio->retry_reason);
 419         }
 420
 421 BIO *BIO_find_type(BIO *bio, int type)
 422         {
 423         int mt,mask;
 424
 425         mask=type&0xff;
 426         do      {
 427                 if (bio->method != NULL)
 428                         {
 429                         mt=bio->method->type;
 430
 431                         if (!mask)
 432                                 {
 433                                 if (mt & type) return(bio);
 434                                 }
 435                         else if (mt == type)
 436                                 return(bio);
 437                         }
 438                 bio=bio->next_bio;
 439                 } while (bio != NULL);
 440         return(NULL);
 441         }
 442
 443 void BIO_free_all(BIO *bio)
 444         {
 445         BIO *b;
 446         int ref;
 447
 448         while (bio != NULL)
 449                 {
 450                 b=bio;
 451                 ref=b->references;
 452                 bio=bio->next_bio;
 453                 BIO_free(b);
 454                 /* Since ref count > 1, don't free anyone else. */
 455                 if (ref > 1) break;
 456                 }
 457         }
 458
 459 BIO *BIO_dup_chain(BIO *in)
 460         {
 461         BIO *ret=NULL,*eoc=NULL,*bio,*new;
 462
 463         for (bio=in; bio != NULL; bio=bio->next_bio)
 464                 {
 465                 if ((new=BIO_new(bio->method)) == NULL) goto err;
 466                 new->callback=bio->callback;
 467                 new->cb_arg=bio->cb_arg;
 468                 new->init=bio->init;
 469                 new->shutdown=bio->shutdown;
 470                 new->flags=bio->flags;
 471
 472                 /* This will let SSL_s_sock() work with stdin/stdout */
 473                 new->num=bio->num;
 474
 475                 if (!BIO_dup_state(bio,(char *)new))
 476                         {
 477                         BIO_free(new);
 478                         goto err;
 479                         }
 480
 481                 /* copy app data */
 482                 if (!CRYPTO_dup_ex_data(bio_meth,&new->ex_data,&bio->ex_data))
 483                         goto err;
 484
 485                 if (ret == NULL)
 486                         {
 487                         eoc=new;
 488                         ret=eoc;
 489                         }
 490                 else
 491                         {
 492                         BIO_push(eoc,new);
 493                         eoc=new;
 494                         }
 495                 }
 496         return(ret);
 497 err:
 498         if (ret != NULL)
 499                 BIO_free(ret);
 500         return(NULL);
 501         }
 502
 503 void BIO_copy_next_retry(BIO *b)
 504         {
 505         BIO_set_flags(b,BIO_get_retry_flags(b->next_bio));
 506         b->retry_reason=b->next_bio->retry_reason;
 507         }
 508
 509 int BIO_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
 510              CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func)
 511         {
 512         bio_meth_num++;
 513         return(CRYPTO_get_ex_new_index(bio_meth_num-1,&bio_meth,
 514                 argl,argp,new_func,dup_func,free_func));
 515         }
 516
 517 int BIO_set_ex_data(BIO *bio, int idx, void *data)
 518         {
 519         return(CRYPTO_set_ex_data(&(bio->ex_data),idx,data));
 520         }
 521
 522 void *BIO_get_ex_data(BIO *bio, int idx)
 523         {
 524         return(CRYPTO_get_ex_data(&(bio->ex_data),idx));
 525         }
 526
 527 unsigned long BIO_number_read(BIO *bio)
 528 {
 529         if(bio) return bio->num_read;
 530         return 0;
 531 }
 532
 533 unsigned long BIO_number_written(BIO *bio)
 534 {
 535         if(bio) return bio->num_write;
 536         return 0;
 537 }
 538
 539 IMPLEMENT_STACK_OF(BIO)