crypto/bio/bss_fd.c

   1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   2  * All rights reserved.
   3  *
   4  * This package is an SSL implementation written
   5  * by Eric Young (eay@cryptsoft.com).
   6  * The implementation was written so as to conform with Netscapes SSL.
   7  *
   8  * This library is free for commercial and non-commercial use as long as
   9  * the following conditions are aheared to.  The following conditions
  10  * apply to all code found in this distribution, be it the RC4, RSA,
  11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  12  * included with this distribution is covered by the same copyright terms
  13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14  *
  15  * Copyright remains Eric Young's, and as such any Copyright notices in
  16  * the code are not to be removed.
  17  * If this package is used in a product, Eric Young should be given attribution
  18  * as the author of the parts of the library used.
  19  * This can be in the form of a textual message at program startup or
  20  * in documentation (online or textual) provided with the package.
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  * 1. Redistributions of source code must retain the copyright
  26  *    notice, this list of conditions and the following disclaimer.
  27  * 2. Redistributions in binary form must reproduce the above copyright
  28  *    notice, this list of conditions and the following disclaimer in the
  29  *    documentation and/or other materials provided with the distribution.
  30  * 3. All advertising materials mentioning features or use of this software
  31  *    must display the following acknowledgement:
  32  *    "This product includes cryptographic software written by
  33  *     Eric Young (eay@cryptsoft.com)"
  34  *    The word 'cryptographic' can be left out if the rouines from the library
  35  *    being used are not cryptographic related :-).
  36  * 4. If you include any Windows specific code (or a derivative thereof) from
  37  *    the apps directory (application code) you must include an acknowledgement:
  38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50  * SUCH DAMAGE.
  51  *
  52  * The licence and distribution terms for any publically available version or
  53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  54  * copied and put under another distribution licence
  55  * [including the GNU Public Licence.]
  56  */
  57
  58 #include <stdio.h>
  59 #include <errno.h>
  60 #define USE_SOCKETS
  61 #include "internal/cryptlib.h"
  62
  63 #if defined(OPENSSL_NO_POSIX_IO)
  64 /*
  65  * Dummy placeholder for BIO_s_fd...
  66  */
  67 BIO *BIO_new_fd(int fd, int close_flag)
  68 {
  69     return NULL;
  70 }
  71
  72 int BIO_fd_non_fatal_error(int err)
  73 {
  74     return 0;
  75 }
  76
  77 int BIO_fd_should_retry(int i)
  78 {
  79     return 0;
  80 }
  81
  82 BIO_METHOD *BIO_s_fd(void)
  83 {
  84     return NULL;
  85 }
  86 #else
  87 /*
  88  * As for unconditional usage of "UPLINK" interface in this module.
  89  * Trouble is that unlike Unix file descriptors [which are indexes
  90  * in kernel-side per-process table], corresponding descriptors on
  91  * platforms which require "UPLINK" interface seem to be indexes
  92  * in a user-land, non-global table. Well, in fact they are indexes
  93  * in stdio _iob[], and recall that _iob[] was the very reason why
  94  * "UPLINK" interface was introduced in first place. But one way on
  95  * another. Neither libcrypto or libssl use this BIO meaning that
  96  * file descriptors can only be provided by application. Therefore
  97  * "UPLINK" calls are due...
  98  */
  99 # include "bio_lcl.h"
 100
 101 static int fd_write(BIO *h, const char *buf, int num);
 102 static int fd_read(BIO *h, char *buf, int size);
 103 static int fd_puts(BIO *h, const char *str);
 104 static int fd_gets(BIO *h, char *buf, int size);
 105 static long fd_ctrl(BIO *h, int cmd, long arg1, void *arg2);
 106 static int fd_new(BIO *h);
 107 static int fd_free(BIO *data);
 108 int BIO_fd_should_retry(int s);
 109
 110 static BIO_METHOD methods_fdp = {
 111     BIO_TYPE_FD, "file descriptor",
 112     fd_write,
 113     fd_read,
 114     fd_puts,
 115     fd_gets,
 116     fd_ctrl,
 117     fd_new,
 118     fd_free,
 119     NULL,
 120 };
 121
 122 BIO_METHOD *BIO_s_fd(void)
 123 {
 124     return (&methods_fdp);
 125 }
 126
 127 BIO *BIO_new_fd(int fd, int close_flag)
 128 {
 129     BIO *ret;
 130     ret = BIO_new(BIO_s_fd());
 131     if (ret == NULL)
 132         return (NULL);
 133     BIO_set_fd(ret, fd, close_flag);
 134     return (ret);
 135 }
 136
 137 static int fd_new(BIO *bi)
 138 {
 139     bi->init = 0;
 140     bi->num = -1;
 141     bi->ptr = NULL;
 142     bi->flags = BIO_FLAGS_UPLINK; /* essentially redundant */
 143     return (1);
 144 }
 145
 146 static int fd_free(BIO *a)
 147 {
 148     if (a == NULL)
 149         return (0);
 150     if (a->shutdown) {
 151         if (a->init) {
 152             UP_close(a->num);
 153         }
 154         a->init = 0;
 155         a->flags = BIO_FLAGS_UPLINK;
 156     }
 157     return (1);
 158 }
 159
 160 static int fd_read(BIO *b, char *out, int outl)
 161 {
 162     int ret = 0;
 163
 164     if (out != NULL) {
 165         clear_sys_error();
 166         ret = UP_read(b->num, out, outl);
 167         BIO_clear_retry_flags(b);
 168         if (ret <= 0) {
 169             if (BIO_fd_should_retry(ret))
 170                 BIO_set_retry_read(b);
 171         }
 172     }
 173     return (ret);
 174 }
 175
 176 static int fd_write(BIO *b, const char *in, int inl)
 177 {
 178     int ret;
 179     clear_sys_error();
 180     ret = UP_write(b->num, in, inl);
 181     BIO_clear_retry_flags(b);
 182     if (ret <= 0) {
 183         if (BIO_fd_should_retry(ret))
 184             BIO_set_retry_write(b);
 185     }
 186     return (ret);
 187 }
 188
 189 static long fd_ctrl(BIO *b, int cmd, long num, void *ptr)
 190 {
 191     long ret = 1;
 192     int *ip;
 193
 194     switch (cmd) {
 195     case BIO_CTRL_RESET:
 196         num = 0;
 197     case BIO_C_FILE_SEEK:
 198         ret = (long)UP_lseek(b->num, num, 0);
 199         break;
 200     case BIO_C_FILE_TELL:
 201     case BIO_CTRL_INFO:
 202         ret = (long)UP_lseek(b->num, 0, 1);
 203         break;
 204     case BIO_C_SET_FD:
 205         fd_free(b);
 206         b->num = *((int *)ptr);
 207         b->shutdown = (int)num;
 208         b->init = 1;
 209         break;
 210     case BIO_C_GET_FD:
 211         if (b->init) {
 212             ip = (int *)ptr;
 213             if (ip != NULL)
 214                 *ip = b->num;
 215             ret = b->num;
 216         } else
 217             ret = -1;
 218         break;
 219     case BIO_CTRL_GET_CLOSE:
 220         ret = b->shutdown;
 221         break;
 222     case BIO_CTRL_SET_CLOSE:
 223         b->shutdown = (int)num;
 224         break;
 225     case BIO_CTRL_PENDING:
 226     case BIO_CTRL_WPENDING:
 227         ret = 0;
 228         break;
 229     case BIO_CTRL_DUP:
 230     case BIO_CTRL_FLUSH:
 231         ret = 1;
 232         break;
 233     default:
 234         ret = 0;
 235         break;
 236     }
 237     return (ret);
 238 }
 239
 240 static int fd_puts(BIO *bp, const char *str)
 241 {
 242     int n, ret;
 243
 244     n = strlen(str);
 245     ret = fd_write(bp, str, n);
 246     return (ret);
 247 }
 248
 249 static int fd_gets(BIO *bp, char *buf, int size)
 250 {
 251     int ret = 0;
 252     char *ptr = buf;
 253     char *end = buf + size - 1;
 254
 255     while ((ptr < end) && (fd_read(bp, ptr, 1) > 0) && (ptr[0] != '\n'))
 256         ptr++;
 257
 258     ptr[0] = '\0';
 259
 260     if (buf[0] != '\0')
 261         ret = strlen(buf);
 262     return (ret);
 263 }
 264
 265 int BIO_fd_should_retry(int i)
 266 {
 267     int err;
 268
 269     if ((i == 0) || (i == -1)) {
 270         err = get_last_sys_error();
 271
 272 # if defined(OPENSSL_SYS_WINDOWS) && 0/* more microsoft stupidity? perhaps
 273                                        * not? Ben 4/1/99 */
 274         if ((i == -1) && (err == 0))
 275             return (1);
 276 # endif
 277
 278         return (BIO_fd_non_fatal_error(err));
 279     }
 280     return (0);
 281 }
 282
 283 int BIO_fd_non_fatal_error(int err)
 284 {
 285     switch (err) {
 286
 287 # ifdef EWOULDBLOCK
 288 #  ifdef WSAEWOULDBLOCK
 289 #   if WSAEWOULDBLOCK != EWOULDBLOCK
 290     case EWOULDBLOCK:
 291 #   endif
 292 #  else
 293     case EWOULDBLOCK:
 294 #  endif
 295 # endif
 296
 297 # if defined(ENOTCONN)
 298     case ENOTCONN:
 299 # endif
 300
 301 # ifdef EINTR
 302     case EINTR:
 303 # endif
 304
 305 # ifdef EAGAIN
 306 #  if EWOULDBLOCK != EAGAIN
 307     case EAGAIN:
 308 #  endif
 309 # endif
 310
 311 # ifdef EPROTO
 312     case EPROTO:
 313 # endif
 314
 315 # ifdef EINPROGRESS
 316     case EINPROGRESS:
 317 # endif
 318
 319 # ifdef EALREADY
 320     case EALREADY:
 321 # endif
 322         return (1);
 323         /* break; */
 324     default:
 325         break;
 326     }
 327     return (0);
 328 }
 329 #endif