crypto/bio/bss_conn.c

   1 /*
   2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (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
  13 #include "bio_local.h"
  14
  15 #ifndef OPENSSL_NO_SOCK
  16
  17 typedef struct bio_connect_st {
  18     int state;
  19     int connect_family;
  20     char *param_hostname;
  21     char *param_service;
  22     int connect_mode;
  23
  24     BIO_ADDRINFO *addr_first;
  25     const BIO_ADDRINFO *addr_iter;
  26     /*
  27      * int socket; this will be kept in bio->num so that it is compatible
  28      * with the bss_sock bio
  29      */
  30     /*
  31      * called when the connection is initially made callback(BIO,state,ret);
  32      * The callback should return 'ret'.  state is for compatibility with the
  33      * ssl info_callback
  34      */
  35     BIO_info_cb *info_callback;
  36 } BIO_CONNECT;
  37
  38 static int conn_write(BIO *h, const char *buf, int num);
  39 static int conn_read(BIO *h, char *buf, int size);
  40 static int conn_puts(BIO *h, const char *str);
  41 static long conn_ctrl(BIO *h, int cmd, long arg1, void *arg2);
  42 static int conn_new(BIO *h);
  43 static int conn_free(BIO *data);
  44 static long conn_callback_ctrl(BIO *h, int cmd, BIO_info_cb *);
  45
  46 static int conn_state(BIO *b, BIO_CONNECT *c);
  47 static void conn_close_socket(BIO *data);
  48 BIO_CONNECT *BIO_CONNECT_new(void);
  49 void BIO_CONNECT_free(BIO_CONNECT *a);
  50
  51 #define BIO_CONN_S_BEFORE                1
  52 #define BIO_CONN_S_GET_ADDR              2
  53 #define BIO_CONN_S_CREATE_SOCKET         3
  54 #define BIO_CONN_S_CONNECT               4
  55 #define BIO_CONN_S_OK                    5
  56 #define BIO_CONN_S_BLOCKED_CONNECT       6
  57 #define BIO_CONN_S_CONNECT_ERROR         7
  58
  59 static const BIO_METHOD methods_connectp = {
  60     BIO_TYPE_CONNECT,
  61     "socket connect",
  62     /* TODO: Convert to new style write function */
  63     bwrite_conv,
  64     conn_write,
  65     /* TODO: Convert to new style read function */
  66     bread_conv,
  67     conn_read,
  68     conn_puts,
  69     NULL,                       /* conn_gets, */
  70     conn_ctrl,
  71     conn_new,
  72     conn_free,
  73     conn_callback_ctrl,
  74 };
  75
  76 static int conn_state(BIO *b, BIO_CONNECT *c)
  77 {
  78     int ret = -1, i;
  79     BIO_info_cb *cb = NULL;
  80
  81     if (c->info_callback != NULL)
  82         cb = c->info_callback;
  83
  84     for (;;) {
  85         switch (c->state) {
  86         case BIO_CONN_S_BEFORE:
  87             if (c->param_hostname == NULL && c->param_service == NULL) {
  88                 BIOerr(BIO_F_CONN_STATE, BIO_R_NO_HOSTNAME_OR_SERVICE_SPECIFIED);
  89                 ERR_add_error_data(4,
  90                                    "hostname=", c->param_hostname,
  91                                    " service=", c->param_service);
  92                 goto exit_loop;
  93             }
  94             c->state = BIO_CONN_S_GET_ADDR;
  95             break;
  96
  97         case BIO_CONN_S_GET_ADDR:
  98             {
  99                 int family = AF_UNSPEC;
 100                 switch (c->connect_family) {
 101                 case BIO_FAMILY_IPV6:
 102                     if (1) { /* This is a trick we use to avoid bit rot.
 103                               * at least the "else" part will always be
 104                               * compiled.
 105                               */
 106 #ifdef AF_INET6
 107                         family = AF_INET6;
 108                     } else {
 109 #endif
 110                         BIOerr(BIO_F_CONN_STATE, BIO_R_UNAVAILABLE_IP_FAMILY);
 111                         goto exit_loop;
 112                     }
 113                     break;
 114                 case BIO_FAMILY_IPV4:
 115                     family = AF_INET;
 116                     break;
 117                 case BIO_FAMILY_IPANY:
 118                     family = AF_UNSPEC;
 119                     break;
 120                 default:
 121                     BIOerr(BIO_F_CONN_STATE, BIO_R_UNSUPPORTED_IP_FAMILY);
 122                     goto exit_loop;
 123                 }
 124                 if (BIO_lookup(c->param_hostname, c->param_service,
 125                                BIO_LOOKUP_CLIENT,
 126                                family, SOCK_STREAM, &c->addr_first) == 0)
 127                     goto exit_loop;
 128             }
 129             if (c->addr_first == NULL) {
 130                 BIOerr(BIO_F_CONN_STATE, BIO_R_LOOKUP_RETURNED_NOTHING);
 131                 goto exit_loop;
 132             }
 133             c->addr_iter = c->addr_first;
 134             c->state = BIO_CONN_S_CREATE_SOCKET;
 135             break;
 136
 137         case BIO_CONN_S_CREATE_SOCKET:
 138             ret = BIO_socket(BIO_ADDRINFO_family(c->addr_iter),
 139                              BIO_ADDRINFO_socktype(c->addr_iter),
 140                              BIO_ADDRINFO_protocol(c->addr_iter), 0);
 141             if (ret == (int)INVALID_SOCKET) {
 142                 SYSerr(SYS_F_SOCKET, get_last_socket_error());
 143                 ERR_add_error_data(4,
 144                                    "hostname=", c->param_hostname,
 145                                    " service=", c->param_service);
 146                 BIOerr(BIO_F_CONN_STATE, BIO_R_UNABLE_TO_CREATE_SOCKET);
 147                 goto exit_loop;
 148             }
 149             b->num = ret;
 150             c->state = BIO_CONN_S_CONNECT;
 151             break;
 152
 153         case BIO_CONN_S_CONNECT:
 154             BIO_clear_retry_flags(b);
 155             ret = BIO_connect(b->num, BIO_ADDRINFO_address(c->addr_iter),
 156                               BIO_SOCK_KEEPALIVE | c->connect_mode);
 157             b->retry_reason = 0;
 158             if (ret == 0) {
 159                 if (BIO_sock_should_retry(ret)) {
 160                     BIO_set_retry_special(b);
 161                     c->state = BIO_CONN_S_BLOCKED_CONNECT;
 162                     b->retry_reason = BIO_RR_CONNECT;
 163                     ERR_clear_error();
 164                 } else if ((c->addr_iter = BIO_ADDRINFO_next(c->addr_iter))
 165                            != NULL) {
 166                     /*
 167                      * if there are more addresses to try, do that first
 168                      */
 169                     BIO_closesocket(b->num);
 170                     c->state = BIO_CONN_S_CREATE_SOCKET;
 171                     ERR_clear_error();
 172                     break;
 173                 } else {
 174                     SYSerr(SYS_F_CONNECT, get_last_socket_error());
 175                     ERR_add_error_data(4,
 176                                        "hostname=", c->param_hostname,
 177                                        " service=", c->param_service);
 178                     c->state = BIO_CONN_S_CONNECT_ERROR;
 179                     break;
 180                 }
 181                 goto exit_loop;
 182             } else {
 183                 c->state = BIO_CONN_S_OK;
 184             }
 185             break;
 186
 187         case BIO_CONN_S_BLOCKED_CONNECT:
 188             i = BIO_sock_error(b->num);
 189             if (i) {
 190                 BIO_clear_retry_flags(b);
 191                 SYSerr(SYS_F_CONNECT, i);
 192                 ERR_add_error_data(4,
 193                                    "hostname=", c->param_hostname,
 194                                    " service=", c->param_service);
 195                 BIOerr(BIO_F_CONN_STATE, BIO_R_NBIO_CONNECT_ERROR);
 196                 ret = 0;
 197                 goto exit_loop;
 198             } else
 199                 c->state = BIO_CONN_S_OK;
 200             break;
 201
 202         case BIO_CONN_S_CONNECT_ERROR:
 203             BIOerr(BIO_F_CONN_STATE, BIO_R_CONNECT_ERROR);
 204             ret = 0;
 205             goto exit_loop;
 206
 207         case BIO_CONN_S_OK:
 208             ret = 1;
 209             goto exit_loop;
 210         default:
 211             /* abort(); */
 212             goto exit_loop;
 213         }
 214
 215         if (cb != NULL) {
 216             if ((ret = cb((BIO *)b, c->state, ret)) == 0)
 217                 goto end;
 218         }
 219     }
 220
 221     /* Loop does not exit */
 222  exit_loop:
 223     if (cb != NULL)
 224         ret = cb((BIO *)b, c->state, ret);
 225  end:
 226     return ret;
 227 }
 228
 229 BIO_CONNECT *BIO_CONNECT_new(void)
 230 {
 231     BIO_CONNECT *ret;
 232
 233     if ((ret = OPENSSL_zalloc(sizeof(*ret))) == NULL) {
 234         BIOerr(BIO_F_BIO_CONNECT_NEW, ERR_R_MALLOC_FAILURE);
 235         return NULL;
 236     }
 237     ret->state = BIO_CONN_S_BEFORE;
 238     ret->connect_family = BIO_FAMILY_IPANY;
 239     return ret;
 240 }
 241
 242 void BIO_CONNECT_free(BIO_CONNECT *a)
 243 {
 244     if (a == NULL)
 245         return;
 246     OPENSSL_free(a->param_hostname);
 247     OPENSSL_free(a->param_service);
 248     BIO_ADDRINFO_free(a->addr_first);
 249     OPENSSL_free(a);
 250 }
 251
 252 const BIO_METHOD *BIO_s_connect(void)
 253 {
 254     return &methods_connectp;
 255 }
 256
 257 static int conn_new(BIO *bi)
 258 {
 259     bi->init = 0;
 260     bi->num = (int)INVALID_SOCKET;
 261     bi->flags = 0;
 262     if ((bi->ptr = (char *)BIO_CONNECT_new()) == NULL)
 263         return 0;
 264     else
 265         return 1;
 266 }
 267
 268 static void conn_close_socket(BIO *bio)
 269 {
 270     BIO_CONNECT *c;
 271
 272     c = (BIO_CONNECT *)bio->ptr;
 273     if (bio->num != (int)INVALID_SOCKET) {
 274         /* Only do a shutdown if things were established */
 275         if (c->state == BIO_CONN_S_OK)
 276             shutdown(bio->num, 2);
 277         BIO_closesocket(bio->num);
 278         bio->num = (int)INVALID_SOCKET;
 279     }
 280 }
 281
 282 static int conn_free(BIO *a)
 283 {
 284     BIO_CONNECT *data;
 285
 286     if (a == NULL)
 287         return 0;
 288     data = (BIO_CONNECT *)a->ptr;
 289
 290     if (a->shutdown) {
 291         conn_close_socket(a);
 292         BIO_CONNECT_free(data);
 293         a->ptr = NULL;
 294         a->flags = 0;
 295         a->init = 0;
 296     }
 297     return 1;
 298 }
 299
 300 static int conn_read(BIO *b, char *out, int outl)
 301 {
 302     int ret = 0;
 303     BIO_CONNECT *data;
 304
 305     data = (BIO_CONNECT *)b->ptr;
 306     if (data->state != BIO_CONN_S_OK) {
 307         ret = conn_state(b, data);
 308         if (ret <= 0)
 309             return ret;
 310     }
 311
 312     if (out != NULL) {
 313         clear_socket_error();
 314         ret = readsocket(b->num, out, outl);
 315         BIO_clear_retry_flags(b);
 316         if (ret <= 0) {
 317             if (BIO_sock_should_retry(ret))
 318                 BIO_set_retry_read(b);
 319         }
 320     }
 321     return ret;
 322 }
 323
 324 static int conn_write(BIO *b, const char *in, int inl)
 325 {
 326     int ret;
 327     BIO_CONNECT *data;
 328
 329     data = (BIO_CONNECT *)b->ptr;
 330     if (data->state != BIO_CONN_S_OK) {
 331         ret = conn_state(b, data);
 332         if (ret <= 0)
 333             return ret;
 334     }
 335
 336     clear_socket_error();
 337     ret = writesocket(b->num, in, inl);
 338     BIO_clear_retry_flags(b);
 339     if (ret <= 0) {
 340         if (BIO_sock_should_retry(ret))
 341             BIO_set_retry_write(b);
 342     }
 343     return ret;
 344 }
 345
 346 static long conn_ctrl(BIO *b, int cmd, long num, void *ptr)
 347 {
 348     BIO *dbio;
 349     int *ip;
 350     const char **pptr = NULL;
 351     long ret = 1;
 352     BIO_CONNECT *data;
 353
 354     data = (BIO_CONNECT *)b->ptr;
 355
 356     switch (cmd) {
 357     case BIO_CTRL_RESET:
 358         ret = 0;
 359         data->state = BIO_CONN_S_BEFORE;
 360         conn_close_socket(b);
 361         BIO_ADDRINFO_free(data->addr_first);
 362         data->addr_first = NULL;
 363         b->flags = 0;
 364         break;
 365     case BIO_C_DO_STATE_MACHINE:
 366         /* use this one to start the connection */
 367         if (data->state != BIO_CONN_S_OK)
 368             ret = (long)conn_state(b, data);
 369         else
 370             ret = 1;
 371         break;
 372     case BIO_C_GET_CONNECT:
 373         if (ptr != NULL) {
 374             pptr = (const char **)ptr;
 375             if (num == 0) {
 376                 *pptr = data->param_hostname;
 377             } else if (num == 1) {
 378                 *pptr = data->param_service;
 379             } else if (num == 2) {
 380                 *pptr = (const char *)BIO_ADDRINFO_address(data->addr_iter);
 381             } else if (num == 3) {
 382                 switch (BIO_ADDRINFO_family(data->addr_iter)) {
 383 # ifdef AF_INET6
 384                 case AF_INET6:
 385                     ret = BIO_FAMILY_IPV6;
 386                     break;
 387 # endif
 388                 case AF_INET:
 389                     ret = BIO_FAMILY_IPV4;
 390                     break;
 391                 case 0:
 392                     ret = data->connect_family;
 393                     break;
 394                 default:
 395                     ret = -1;
 396                     break;
 397                 }
 398             } else {
 399                 ret = 0;
 400             }
 401         } else {
 402             ret = 0;
 403         }
 404         break;
 405     case BIO_C_SET_CONNECT:
 406         if (ptr != NULL) {
 407             b->init = 1;
 408             if (num == 0) {
 409                 char *hold_service = data->param_service;
 410                 /* We affect the hostname regardless.  However, the input
 411                  * string might contain a host:service spec, so we must
 412                  * parse it, which might or might not affect the service
 413                  */
 414                 OPENSSL_free(data->param_hostname);
 415                 data->param_hostname = NULL;
 416                 ret = BIO_parse_hostserv(ptr,
 417                                          &data->param_hostname,
 418                                          &data->param_service,
 419                                          BIO_PARSE_PRIO_HOST);
 420                 if (hold_service != data->param_service)
 421                     OPENSSL_free(hold_service);
 422             } else if (num == 1) {
 423                 OPENSSL_free(data->param_service);
 424                 data->param_service = BUF_strdup(ptr);
 425             } else if (num == 2) {
 426                 const BIO_ADDR *addr = (const BIO_ADDR *)ptr;
 427                 if (ret) {
 428                     data->param_hostname = BIO_ADDR_hostname_string(addr, 1);
 429                     data->param_service = BIO_ADDR_service_string(addr, 1);
 430                     BIO_ADDRINFO_free(data->addr_first);
 431                     data->addr_first = NULL;
 432                     data->addr_iter = NULL;
 433                 }
 434             } else if (num == 3) {
 435                 data->connect_family = *(int *)ptr;
 436             } else {
 437                 ret = 0;
 438             }
 439         }
 440         break;
 441     case BIO_C_SET_NBIO:
 442         if (num != 0)
 443             data->connect_mode |= BIO_SOCK_NONBLOCK;
 444         else
 445             data->connect_mode &= ~BIO_SOCK_NONBLOCK;
 446         break;
 447     case BIO_C_SET_CONNECT_MODE:
 448         data->connect_mode = (int)num;
 449         break;
 450     case BIO_C_GET_FD:
 451         if (b->init) {
 452             ip = (int *)ptr;
 453             if (ip != NULL)
 454                 *ip = b->num;
 455             ret = b->num;
 456         } else
 457             ret = -1;
 458         break;
 459     case BIO_CTRL_GET_CLOSE:
 460         ret = b->shutdown;
 461         break;
 462     case BIO_CTRL_SET_CLOSE:
 463         b->shutdown = (int)num;
 464         break;
 465     case BIO_CTRL_PENDING:
 466     case BIO_CTRL_WPENDING:
 467         ret = 0;
 468         break;
 469     case BIO_CTRL_FLUSH:
 470         break;
 471     case BIO_CTRL_DUP:
 472         {
 473             dbio = (BIO *)ptr;
 474             if (data->param_hostname)
 475                 BIO_set_conn_hostname(dbio, data->param_hostname);
 476             if (data->param_service)
 477                 BIO_set_conn_port(dbio, data->param_service);
 478             BIO_set_conn_ip_family(dbio, data->connect_family);
 479             BIO_set_conn_mode(dbio, data->connect_mode);
 480             /*
 481              * FIXME: the cast of the function seems unlikely to be a good
 482              * idea
 483              */
 484             (void)BIO_set_info_callback(dbio, data->info_callback);
 485         }
 486         break;
 487     case BIO_CTRL_SET_CALLBACK:
 488         ret = 0; /* use callback ctrl */
 489         break;
 490     case BIO_CTRL_GET_CALLBACK:
 491         {
 492             BIO_info_cb **fptr;
 493
 494             fptr = (BIO_info_cb **)ptr;
 495             *fptr = data->info_callback;
 496         }
 497         break;
 498     default:
 499         ret = 0;
 500         break;
 501     }
 502     return ret;
 503 }
 504
 505 static long conn_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp)
 506 {
 507     long ret = 1;
 508     BIO_CONNECT *data;
 509
 510     data = (BIO_CONNECT *)b->ptr;
 511
 512     switch (cmd) {
 513     case BIO_CTRL_SET_CALLBACK:
 514         {
 515             data->info_callback = fp;
 516         }
 517         break;
 518     default:
 519         ret = 0;
 520         break;
 521     }
 522     return ret;
 523 }
 524
 525 static int conn_puts(BIO *bp, const char *str)
 526 {
 527     int n, ret;
 528
 529     n = strlen(str);
 530     ret = conn_write(bp, str, n);
 531     return ret;
 532 }
 533
 534 BIO *BIO_new_connect(const char *str)
 535 {
 536     BIO *ret;
 537
 538     ret = BIO_new(BIO_s_connect());
 539     if (ret == NULL)
 540         return NULL;
 541     if (BIO_set_conn_hostname(ret, str))
 542         return ret;
 543     BIO_free(ret);
 544     return NULL;
 545 }
 546
 547 #endif