crypto/bio/bss_fd.c

   1 /* crypto/bio/bss_fd.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 #define USE_SOCKETS
  62 #include "cryptlib.h"
  63
  64 #if defined(OPENSSL_NO_POSIX_IO)
  65 /*
  66  * One can argue that one should implement dummy placeholder for
  67  * BIO_s_fd here...
  68  */
  69 #else
  70 /*
  71  * As for unconditional usage of "UPLINK" interface in this module.
  72  * Trouble is that unlike Unix file descriptors [which are indexes
  73  * in kernel-side per-process table], corresponding descriptors on
  74  * platforms which require "UPLINK" interface seem to be indexes
  75  * in a user-land, non-global table. Well, in fact they are indexes
  76  * in stdio _iob[], and recall that _iob[] was the very reason why
  77  * "UPLINK" interface was introduced in first place. But one way on
  78  * another. Neither libcrypto or libssl use this BIO meaning that
  79  * file descriptors can only be provided by application. Therefore
  80  * "UPLINK" calls are due...
  81  */
  82 #include "bio_lcl.h"
  83
  84 static int fd_write(BIO *h, const char *buf, int num);
  85 static int fd_read(BIO *h, char *buf, int size);
  86 static int fd_puts(BIO *h, const char *str);
  87 static long fd_ctrl(BIO *h, int cmd, long arg1, void *arg2);
  88 static int fd_new(BIO *h);
  89 static int fd_free(BIO *data);
  90 int BIO_fd_should_retry(int s);
  91
  92 static BIO_METHOD methods_fdp=
  93         {
  94         BIO_TYPE_FD,"file descriptor",
  95         fd_write,
  96         fd_read,
  97         fd_puts,
  98         NULL, /* fd_gets, */
  99         fd_ctrl,
 100         fd_new,
 101         fd_free,
 102         NULL,
 103         };
 104
 105 BIO_METHOD *BIO_s_fd(void)
 106         {
 107         return(&methods_fdp);
 108         }
 109
 110 BIO *BIO_new_fd(int fd,int close_flag)
 111         {
 112         BIO *ret;
 113         ret=BIO_new(BIO_s_fd());
 114         if (ret == NULL) return(NULL);
 115         BIO_set_fd(ret,fd,close_flag);
 116         return(ret);
 117         }
 118
 119 static int fd_new(BIO *bi)
 120         {
 121         bi->init=0;
 122         bi->num=-1;
 123         bi->ptr=NULL;
 124         bi->flags=BIO_FLAGS_UPLINK; /* essentially redundant */
 125         return(1);
 126         }
 127
 128 static int fd_free(BIO *a)
 129         {
 130         if (a == NULL) return(0);
 131         if (a->shutdown)
 132                 {
 133                 if (a->init)
 134                         {
 135                         UP_close(a->num);
 136                         }
 137                 a->init=0;
 138                 a->flags=BIO_FLAGS_UPLINK;
 139                 }
 140         return(1);
 141         }
 142
 143 static int fd_read(BIO *b, char *out,int outl)
 144         {
 145         int ret=0;
 146
 147         if (out != NULL)
 148                 {
 149                 clear_sys_error();
 150                 ret=UP_read(b->num,out,outl);
 151                 BIO_clear_retry_flags(b);
 152                 if (ret <= 0)
 153                         {
 154                         if (BIO_fd_should_retry(ret))
 155                                 BIO_set_retry_read(b);
 156                         }
 157                 }
 158         return(ret);
 159         }
 160
 161 static int fd_write(BIO *b, const char *in, int inl)
 162         {
 163         int ret;
 164         clear_sys_error();
 165         ret=UP_write(b->num,in,inl);
 166         BIO_clear_retry_flags(b);
 167         if (ret <= 0)
 168                 {
 169                 if (BIO_fd_should_retry(ret))
 170                         BIO_set_retry_write(b);
 171                 }
 172         return(ret);
 173         }
 174
 175 static long fd_ctrl(BIO *b, int cmd, long num, void *ptr)
 176         {
 177         long ret=1;
 178         int *ip;
 179
 180         switch (cmd)
 181                 {
 182         case BIO_CTRL_RESET:
 183                 num=0;
 184         case BIO_C_FILE_SEEK:
 185                 ret=(long)UP_lseek(b->num,num,0);
 186                 break;
 187         case BIO_C_FILE_TELL:
 188         case BIO_CTRL_INFO:
 189                 ret=(long)UP_lseek(b->num,0,1);
 190                 break;
 191         case BIO_C_SET_FD:
 192                 fd_free(b);
 193                 b->num= *((int *)ptr);
 194                 b->shutdown=(int)num;
 195                 b->init=1;
 196                 break;
 197         case BIO_C_GET_FD:
 198                 if (b->init)
 199                         {
 200                         ip=(int *)ptr;
 201                         if (ip != NULL) *ip=b->num;
 202                         ret=b->num;
 203                         }
 204                 else
 205                         ret= -1;
 206                 break;
 207         case BIO_CTRL_GET_CLOSE:
 208                 ret=b->shutdown;
 209                 break;
 210         case BIO_CTRL_SET_CLOSE:
 211                 b->shutdown=(int)num;
 212                 break;
 213         case BIO_CTRL_PENDING:
 214         case BIO_CTRL_WPENDING:
 215                 ret=0;
 216                 break;
 217         case BIO_CTRL_DUP:
 218         case BIO_CTRL_FLUSH:
 219                 ret=1;
 220                 break;
 221         default:
 222                 ret=0;
 223                 break;
 224                 }
 225         return(ret);
 226         }
 227
 228 static int fd_puts(BIO *bp, const char *str)
 229         {
 230         int n,ret;
 231
 232         n=strlen(str);
 233         ret=fd_write(bp,str,n);
 234         return(ret);
 235         }
 236
 237 int BIO_fd_should_retry(int i)
 238         {
 239         int err;
 240
 241         if ((i == 0) || (i == -1))
 242                 {
 243                 err=get_last_sys_error();
 244
 245 #if defined(OPENSSL_SYS_WINDOWS) && 0 /* more microsoft stupidity? perhaps not? Ben 4/1/99 */
 246                 if ((i == -1) && (err == 0))
 247                         return(1);
 248 #endif
 249
 250                 return(BIO_fd_non_fatal_error(err));
 251                 }
 252         return(0);
 253         }
 254
 255 int BIO_fd_non_fatal_error(int err)
 256         {
 257         switch (err)
 258                 {
 259
 260 #ifdef EWOULDBLOCK
 261 # ifdef WSAEWOULDBLOCK
 262 #  if WSAEWOULDBLOCK != EWOULDBLOCK
 263         case EWOULDBLOCK:
 264 #  endif
 265 # else
 266         case EWOULDBLOCK:
 267 # endif
 268 #endif
 269
 270 #if defined(ENOTCONN)
 271         case ENOTCONN:
 272 #endif
 273
 274 #ifdef EINTR
 275         case EINTR:
 276 #endif
 277
 278 #ifdef EAGAIN
 279 #if EWOULDBLOCK != EAGAIN
 280         case EAGAIN:
 281 # endif
 282 #endif
 283
 284 #ifdef EPROTO
 285         case EPROTO:
 286 #endif
 287
 288 #ifdef EINPROGRESS
 289         case EINPROGRESS:
 290 #endif
 291
 292 #ifdef EALREADY
 293         case EALREADY:
 294 #endif
 295                 return(1);
 296                 /* break; */
 297         default:
 298                 break;
 299                 }
 300         return(0);
 301         }
 302 #endif