crypto/bio/bss_sock.c

   1 /*
   2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <stdio.h>
  11 #include <errno.h>
  12 #include "bio_lcl.h"
  13 #include "internal/cryptlib.h"
  14 #include "internal/ktls.h"
  15
  16 #ifndef OPENSSL_NO_SOCK
  17
  18 # include <openssl/bio.h>
  19
  20 # ifdef WATT32
  21 /* Watt-32 uses same names */
  22 #  undef sock_write
  23 #  undef sock_read
  24 #  undef sock_puts
  25 #  define sock_write SockWrite
  26 #  define sock_read  SockRead
  27 #  define sock_puts  SockPuts
  28 # endif
  29
  30 static int sock_write(BIO *h, const char *buf, int num);
  31 static int sock_read(BIO *h, char *buf, int size);
  32 static int sock_puts(BIO *h, const char *str);
  33 static long sock_ctrl(BIO *h, int cmd, long arg1, void *arg2);
  34 static int sock_new(BIO *h);
  35 static int sock_free(BIO *data);
  36 int BIO_sock_should_retry(int s);
  37
  38 static const BIO_METHOD methods_sockp = {
  39     BIO_TYPE_SOCKET,
  40     "socket",
  41     /* TODO: Convert to new style write function */
  42     bwrite_conv,
  43     sock_write,
  44     /* TODO: Convert to new style read function */
  45     bread_conv,
  46     sock_read,
  47     sock_puts,
  48     NULL,                       /* sock_gets,         */
  49     sock_ctrl,
  50     sock_new,
  51     sock_free,
  52     NULL,                       /* sock_callback_ctrl */
  53 };
  54
  55 const BIO_METHOD *BIO_s_socket(void)
  56 {
  57     return &methods_sockp;
  58 }
  59
  60 BIO *BIO_new_socket(int fd, int close_flag)
  61 {
  62     BIO *ret;
  63
  64     ret = BIO_new(BIO_s_socket());
  65     if (ret == NULL)
  66         return NULL;
  67     BIO_set_fd(ret, fd, close_flag);
  68 # ifndef OPENSSL_NO_KTLS
  69     {
  70         /*
  71          * The new socket is created successfully regardless of ktls_enable.
  72          * ktls_enable doesn't change any functionality of the socket, except
  73          * changing the setsockopt to enable the processing of ktls_start.
  74          * Thus, it is not a problem to call it for non-TLS sockets.
  75          */
  76         ktls_enable(fd);
  77     }
  78 # endif
  79     return ret;
  80 }
  81
  82 static int sock_new(BIO *bi)
  83 {
  84     bi->init = 0;
  85     bi->num = 0;
  86     bi->ptr = NULL;
  87     bi->flags = 0;
  88     return 1;
  89 }
  90
  91 static int sock_free(BIO *a)
  92 {
  93     if (a == NULL)
  94         return 0;
  95     if (a->shutdown) {
  96         if (a->init) {
  97             BIO_closesocket(a->num);
  98         }
  99         a->init = 0;
 100         a->flags = 0;
 101     }
 102     return 1;
 103 }
 104
 105 static int sock_read(BIO *b, char *out, int outl)
 106 {
 107     int ret = 0;
 108
 109     if (out != NULL) {
 110         clear_socket_error();
 111         ret = readsocket(b->num, out, outl);
 112         BIO_clear_retry_flags(b);
 113         if (ret <= 0) {
 114             if (BIO_sock_should_retry(ret))
 115                 BIO_set_retry_read(b);
 116         }
 117     }
 118     return ret;
 119 }
 120
 121 static int sock_write(BIO *b, const char *in, int inl)
 122 {
 123     int ret = 0;
 124
 125     clear_socket_error();
 126 # ifndef OPENSSL_NO_KTLS
 127     if (BIO_should_ktls_ctrl_msg_flag(b)) {
 128         unsigned char record_type = (intptr_t)b->ptr;
 129         ret = ktls_send_ctrl_message(b->num, record_type, in, inl);
 130         if (ret >= 0) {
 131             ret = inl;
 132             BIO_clear_ktls_ctrl_msg_flag(b);
 133         }
 134     } else
 135 # endif
 136         ret = writesocket(b->num, in, inl);
 137     BIO_clear_retry_flags(b);
 138     if (ret <= 0) {
 139         if (BIO_sock_should_retry(ret))
 140             BIO_set_retry_write(b);
 141     }
 142     return ret;
 143 }
 144
 145 static long sock_ctrl(BIO *b, int cmd, long num, void *ptr)
 146 {
 147     long ret = 1;
 148     int *ip;
 149 # ifndef OPENSSL_NO_KTLS
 150     struct tls12_crypto_info_aes_gcm_128 *crypto_info;
 151 # endif
 152
 153     switch (cmd) {
 154     case BIO_C_SET_FD:
 155         sock_free(b);
 156         b->num = *((int *)ptr);
 157         b->shutdown = (int)num;
 158         b->init = 1;
 159         break;
 160     case BIO_C_GET_FD:
 161         if (b->init) {
 162             ip = (int *)ptr;
 163             if (ip != NULL)
 164                 *ip = b->num;
 165             ret = b->num;
 166         } else
 167             ret = -1;
 168         break;
 169     case BIO_CTRL_GET_CLOSE:
 170         ret = b->shutdown;
 171         break;
 172     case BIO_CTRL_SET_CLOSE:
 173         b->shutdown = (int)num;
 174         break;
 175     case BIO_CTRL_DUP:
 176     case BIO_CTRL_FLUSH:
 177         ret = 1;
 178         break;
 179 # ifndef OPENSSL_NO_KTLS
 180     case BIO_CTRL_SET_KTLS_SEND:
 181         crypto_info = (struct tls12_crypto_info_aes_gcm_128 *)ptr;
 182         ret = ktls_start(b->num, crypto_info, sizeof(*crypto_info), num);
 183         if (ret)
 184             BIO_set_ktls_flag(b);
 185         break;
 186     case BIO_CTRL_GET_KTLS_SEND:
 187         return BIO_should_ktls_flag(b);
 188     case BIO_CTRL_SET_KTLS_SEND_CTRL_MSG:
 189         BIO_set_ktls_ctrl_msg_flag(b);
 190         b->ptr = (void *)num;
 191         ret = 0;
 192         break;
 193     case BIO_CTRL_CLEAR_KTLS_CTRL_MSG:
 194         BIO_clear_ktls_ctrl_msg_flag(b);
 195         ret = 0;
 196         break;
 197 # endif
 198     default:
 199         ret = 0;
 200         break;
 201     }
 202     return ret;
 203 }
 204
 205 static int sock_puts(BIO *bp, const char *str)
 206 {
 207     int n, ret;
 208
 209     n = strlen(str);
 210     ret = sock_write(bp, str, n);
 211     return ret;
 212 }
 213
 214 int BIO_sock_should_retry(int i)
 215 {
 216     int err;
 217
 218     if ((i == 0) || (i == -1)) {
 219         err = get_last_socket_error();
 220
 221         return BIO_sock_non_fatal_error(err);
 222     }
 223     return 0;
 224 }
 225
 226 int BIO_sock_non_fatal_error(int err)
 227 {
 228     switch (err) {
 229 # if defined(OPENSSL_SYS_WINDOWS)
 230 #  if defined(WSAEWOULDBLOCK)
 231     case WSAEWOULDBLOCK:
 232 #  endif
 233 # endif
 234
 235 # ifdef EWOULDBLOCK
 236 #  ifdef WSAEWOULDBLOCK
 237 #   if WSAEWOULDBLOCK != EWOULDBLOCK
 238     case EWOULDBLOCK:
 239 #   endif
 240 #  else
 241     case EWOULDBLOCK:
 242 #  endif
 243 # endif
 244
 245 # if defined(ENOTCONN)
 246     case ENOTCONN:
 247 # endif
 248
 249 # ifdef EINTR
 250     case EINTR:
 251 # endif
 252
 253 # ifdef EAGAIN
 254 #  if EWOULDBLOCK != EAGAIN
 255     case EAGAIN:
 256 #  endif
 257 # endif
 258
 259 # ifdef EPROTO
 260     case EPROTO:
 261 # endif
 262
 263 # ifdef EINPROGRESS
 264     case EINPROGRESS:
 265 # endif
 266
 267 # ifdef EALREADY
 268     case EALREADY:
 269 # endif
 270         return 1;
 271     default:
 272         break;
 273     }
 274     return 0;
 275 }
 276
 277 #endif                          /* #ifndef OPENSSL_NO_SOCK */