ssl/quic/quic_impl.c

   1 /*
   2  * Copyright 2022 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 <openssl/macros.h>
  11 #include <openssl/objects.h>
  12 #include <openssl/sslerr.h>
  13 #include <crypto/rand.h>
  14 #include "quic_local.h"
  15 #include "internal/quic_dummy_handshake.h"
  16 #include "internal/quic_rx_depack.h"
  17 #include "internal/quic_error.h"
  18 #include "internal/time.h"
  19
  20 static void aon_write_finish(QUIC_CONNECTION *qc);
  21
  22 /*
  23  * QUIC Front-End I/O API: Common Utilities
  24  * ========================================
  25  */
  26
  27 /*
  28  * Block until a predicate is met.
  29  *
  30  * Precondition: Must have a channel.
  31  */
  32 static int block_until_pred(QUIC_CONNECTION *qc,
  33                             int (*pred)(void *arg), void *pred_arg,
  34                             uint32_t flags)
  35 {
  36     QUIC_REACTOR *rtor;
  37
  38     assert(qc->ch != NULL);
  39
  40     rtor = ossl_quic_channel_get_reactor(qc->ch);
  41     return ossl_quic_reactor_block_until_pred(rtor, pred, pred_arg, flags);
  42 }
  43
  44 /*
  45  * Raise a 'normal' error, meaning one that can be reported via SSL_get_error()
  46  * rather than via ERR.
  47  */
  48 static int quic_raise_normal_error(QUIC_CONNECTION *qc,
  49                                    int err)
  50 {
  51     qc->last_error = err;
  52     return 0;
  53 }
  54
  55 /*
  56  * Raise a 'non-normal' error, meaning any error that is not reported via
  57  * SSL_get_error() and must be reported via ERR.
  58  */
  59 static int quic_raise_non_normal_error(QUIC_CONNECTION *qc,
  60                                        const char *file,
  61                                        int line,
  62                                        const char *func,
  63                                        int reason,
  64                                        const char *fmt,
  65                                        ...)
  66 {
  67     va_list args;
  68
  69     ERR_new();
  70     ERR_set_debug(file, line, func);
  71
  72     va_start(args, fmt);
  73     ERR_vset_error(ERR_LIB_SSL, reason, fmt, args);
  74     va_end(args);
  75
  76     qc->last_error = SSL_ERROR_SSL;
  77     return 0;
  78 }
  79
  80 #define QUIC_RAISE_NORMAL_ERROR(qc, err)                        \
  81     quic_raise_normal_error((qc), (err))
  82
  83 #define QUIC_RAISE_NON_NORMAL_ERROR(qc, reason, msg)            \
  84     quic_raise_non_normal_error((qc),                           \
  85                                 OPENSSL_FILE, OPENSSL_LINE,     \
  86                                 OPENSSL_FUNC,                   \
  87                                 (reason),                       \
  88                                 (msg))
  89
  90 /*
  91  * Should be called at entry of every public function to confirm we have a valid
  92  * QUIC_CONNECTION.
  93  */
  94 static ossl_inline int expect_quic_conn(const QUIC_CONNECTION *qc)
  95 {
  96     if (!ossl_assert(qc != NULL))
  97         return QUIC_RAISE_NON_NORMAL_ERROR(NULL, ERR_R_INTERNAL_ERROR, NULL);
  98
  99     return 1;
 100
 101 }
 102
 103 /*
 104  * QUIC Front-End I/O API: Initialization
 105  * ======================================
 106  *
 107  *         SSL_new                  => ossl_quic_new
 108  *                                     ossl_quic_init
 109  *         SSL_reset                => ossl_quic_reset
 110  *         SSL_clear                => ossl_quic_clear
 111  *                                     ossl_quic_deinit
 112  *         SSL_free                 => ossl_quic_free
 113  *
 114  */
 115
 116 /* SSL_new */
 117 SSL *ossl_quic_new(SSL_CTX *ctx)
 118 {
 119     QUIC_CONNECTION *qc = NULL;
 120     SSL *ssl_base = NULL;
 121
 122     qc = OPENSSL_zalloc(sizeof(*qc));
 123     if (qc == NULL)
 124         goto err;
 125
 126     /* Initialise the QUIC_CONNECTION's stub header. */
 127     ssl_base = &qc->ssl;
 128     if (!ossl_ssl_init(ssl_base, ctx, SSL_TYPE_QUIC_CONNECTION)) {
 129         ssl_base = NULL;
 130         goto err;
 131     }
 132
 133     /* Channel is not created yet. */
 134     qc->ssl_mode   = qc->ssl.ctx->mode;
 135     qc->last_error = SSL_ERROR_NONE;
 136     qc->blocking   = 1;
 137     return ssl_base;
 138
 139 err:
 140     OPENSSL_free(qc);
 141     return NULL;
 142 }
 143
 144 /* SSL_free */
 145 void ossl_quic_free(SSL *s)
 146 {
 147     QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
 148
 149     /* We should never be called on anything but a QUIC_CONNECTION. */
 150     if (!expect_quic_conn(qc))
 151         return;
 152
 153     ossl_quic_channel_free(qc->ch);
 154
 155     BIO_free(qc->net_rbio);
 156     BIO_free(qc->net_wbio);
 157
 158     /* Note: SSL_free calls OPENSSL_free(qc) for us */
 159 }
 160
 161 /* SSL method init */
 162 int ossl_quic_init(SSL *s)
 163 {
 164     QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
 165
 166     if (!expect_quic_conn(qc))
 167         return 0;
 168
 169     /* Same op as SSL_clear, forward the call. */
 170     return ossl_quic_clear(s);
 171 }
 172
 173 /* SSL method deinit */
 174 void ossl_quic_deinit(SSL *s)
 175 {
 176     /* No-op. */
 177 }
 178
 179 /* SSL_reset */
 180 int ossl_quic_reset(SSL *s)
 181 {
 182     QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
 183
 184     if (!expect_quic_conn(qc))
 185         return 0;
 186
 187     /* TODO(QUIC); Currently a no-op. */
 188     return 1;
 189 }
 190
 191 /* SSL_clear */
 192 int ossl_quic_clear(SSL *s)
 193 {
 194     QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
 195
 196     if (!expect_quic_conn(qc))
 197         return 0;
 198
 199     /* TODO(QUIC): Currently a no-op. */
 200     return 1;
 201 }
 202
 203 /*
 204  * QUIC Front-End I/O API: Network BIO Configuration
 205  * =================================================
 206  *
 207  * Handling the different BIOs is difficult:
 208  *
 209  *   - It is more or less a requirement that we use non-blocking network I/O;
 210  *     we need to be able to have timeouts on recv() calls, and make best effort
 211  *     (non blocking) send() and recv() calls.
 212  *
 213  *     The only sensible way to do this is to configure the socket into
 214  *     non-blocking mode. We could try to do select() before calling send() or
 215  *     recv() to get a guarantee that the call will not block, but this will
 216  *     probably run into issues with buggy OSes which generate spurious socket
 217  *     readiness events. In any case, relying on this to work reliably does not
 218  *     seem sane.
 219  *
 220  *     Timeouts could be handled via setsockopt() socket timeout options, but
 221  *     this depends on OS support and adds another syscall to every network I/O
 222  *     operation. It also has obvious thread safety concerns if we want to move
 223  *     to concurrent use of a single socket at some later date.
 224  *
 225  *     Some OSes support a MSG_DONTWAIT flag which allows a single I/O option to
 226  *     be made non-blocking. However some OSes (e.g. Windows) do not support
 227  *     this, so we cannot rely on this.
 228  *
 229  *     As such, we need to configure any FD in non-blocking mode. This may
 230  *     confound users who pass a blocking socket to libssl. However, in practice
 231  *     it would be extremely strange for a user of QUIC to pass an FD to us,
 232  *     then also try and send receive traffic on the same socket(!). Thus the
 233  *     impact of this should be limited, and can be documented.
 234  *
 235  *   - We support both blocking and non-blocking operation in terms of the API
 236  *     presented to the user. One prospect is to set the blocking mode based on
 237  *     whether the socket passed to us was already in blocking mode. However,
 238  *     Windows has no API for determining if a socket is in blocking mode (!),
 239  *     therefore this cannot be done portably. Currently therefore we expose an
 240  *     explicit API call to set this, and default to blocking mode.
 241  *
 242  *   - We need to determine our initial destination UDP address. The "natural"
 243  *     way for a user to do this is to set the peer variable on a BIO_dgram.
 244  *     However, this has problems because BIO_dgram's peer variable is used for
 245  *     both transmission and reception. This means it can be constantly being
 246  *     changed to a malicious value (e.g. if some random unrelated entity on the
 247  *     network starts sending traffic to us) on every read call. This is not a
 248  *     direct issue because we use the 'stateless' BIO_sendmmsg and BIO_recvmmsg
 249  *     calls only, which do not use this variable. However, we do need to let
 250  *     the user specify the peer in a 'normal' manner. The compromise here is
 251  *     that we grab the current peer value set at the time the write BIO is set
 252  *     and do not read the value again.
 253  *
 254  *   - We also need to support memory BIOs (e.g. BIO_dgram_pair) or custom BIOs.
 255  *     Currently we do this by only supporting non-blocking mode.
 256  *
 257  */
 258
 259 /*
 260  * Determines what initial destination UDP address we should use, if possible.
 261  * If this fails the client must set the destination address manually, or use a
 262  * BIO which does not need a destination address.
 263  */
 264 static int csm_analyse_init_peer_addr(BIO *net_wbio, BIO_ADDR *peer)
 265 {
 266     if (!BIO_dgram_get_peer(net_wbio, peer))
 267         return 0;
 268
 269     return 1;
 270 }
 271
 272 void ossl_quic_conn_set0_net_rbio(QUIC_CONNECTION *qc, BIO *net_rbio)
 273 {
 274     if (qc->net_rbio == net_rbio)
 275         return;
 276
 277     if (qc->ch != NULL && !ossl_quic_channel_set_net_rbio(qc->ch, net_rbio))
 278         return;
 279
 280     BIO_free(qc->net_rbio);
 281     qc->net_rbio = net_rbio;
 282
 283     /*
 284      * If what we have is not pollable (e.g. a BIO_dgram_pair) disable blocking
 285      * mode as we do not support it for non-pollable BIOs.
 286      */
 287     if (net_rbio != NULL) {
 288         BIO_POLL_DESCRIPTOR d = {0};
 289
 290         if (!BIO_get_rpoll_descriptor(net_rbio, &d)
 291             || d.type != BIO_POLL_DESCRIPTOR_TYPE_SOCK_FD) {
 292             qc->blocking = 0;
 293             qc->can_poll_net_rbio = 0;
 294         } else {
 295             qc->can_poll_net_rbio = 1;
 296         }
 297     }
 298 }
 299
 300 void ossl_quic_conn_set0_net_wbio(QUIC_CONNECTION *qc, BIO *net_wbio)
 301 {
 302     if (qc->net_wbio == net_wbio)
 303         return;
 304
 305     if (qc->ch != NULL && !ossl_quic_channel_set_net_wbio(qc->ch, net_wbio))
 306         return;
 307
 308     BIO_free(qc->net_wbio);
 309     qc->net_wbio = net_wbio;
 310
 311     if (net_wbio != NULL) {
 312         BIO_POLL_DESCRIPTOR d = {0};
 313
 314         if (!BIO_get_wpoll_descriptor(net_wbio, &d)
 315             || d.type != BIO_POLL_DESCRIPTOR_TYPE_SOCK_FD) {
 316             qc->blocking = 0;
 317             qc->can_poll_net_wbio = 0;
 318         } else {
 319             qc->can_poll_net_wbio = 1;
 320         }
 321
 322         /*
 323          * If we do not have a peer address yet, and we have not started trying
 324          * to connect yet, try to autodetect one.
 325          */
 326         if (BIO_ADDR_family(&qc->init_peer_addr) == AF_UNSPEC
 327             && !qc->started) {
 328             if (!csm_analyse_init_peer_addr(net_wbio, &qc->init_peer_addr))
 329                 /* best effort */
 330                 BIO_ADDR_clear(&qc->init_peer_addr);
 331
 332             if (qc->ch != NULL)
 333                 ossl_quic_channel_set_peer_addr(qc->ch, &qc->init_peer_addr);
 334         }
 335     }
 336 }
 337
 338 BIO *ossl_quic_conn_get_net_rbio(const QUIC_CONNECTION *qc)
 339 {
 340     return qc->net_rbio;
 341 }
 342
 343 BIO *ossl_quic_conn_get_net_wbio(const QUIC_CONNECTION *qc)
 344 {
 345     return qc->net_wbio;
 346 }
 347
 348 int ossl_quic_conn_get_blocking_mode(const QUIC_CONNECTION *qc)
 349 {
 350     return qc->blocking;
 351 }
 352
 353 int ossl_quic_conn_set_blocking_mode(QUIC_CONNECTION *qc, int blocking)
 354 {
 355     /* Cannot enable blocking mode if we do not have pollable FDs. */
 356     if (blocking != 0 &&
 357         (!qc->can_poll_net_rbio || !qc->can_poll_net_wbio))
 358         return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_UNSUPPORTED, NULL);
 359
 360     qc->blocking = (blocking != 0);
 361     return 1;
 362 }
 363
 364 int ossl_quic_conn_set_initial_peer_addr(QUIC_CONNECTION *qc,
 365                                          const BIO_ADDR *peer_addr)
 366 {
 367     if (qc->started)
 368         return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
 369                                            NULL);
 370
 371     if (peer_addr == NULL) {
 372         BIO_ADDR_clear(&qc->init_peer_addr);
 373         return 1;
 374     }
 375
 376     qc->init_peer_addr = *peer_addr;
 377     return 1;
 378 }
 379
 380 /*
 381  * QUIC Front-End I/O API: Asynchronous I/O Management
 382  * ===================================================
 383  *
 384  *   (BIO/)SSL_tick                 => ossl_quic_tick
 385  *   (BIO/)SSL_get_tick_timeout     => ossl_quic_get_tick_timeout
 386  *   (BIO/)SSL_get_poll_fd          => ossl_quic_get_poll_fd
 387  *
 388  */
 389
 390 /* Returns 1 if the connection is being used in blocking mode. */
 391 static int blocking_mode(const QUIC_CONNECTION *qc)
 392 {
 393     return qc->blocking;
 394 }
 395
 396 /* SSL_tick; ticks the reactor. */
 397 int ossl_quic_tick(QUIC_CONNECTION *qc)
 398 {
 399     if (qc->ch == NULL)
 400         return 1;
 401
 402     ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(qc->ch));
 403     return 1;
 404 }
 405
 406 /*
 407  * SSL_get_tick_timeout. Get the time in milliseconds until the SSL object
 408  * should be ticked by the application by calling SSL_tick(). tv is set to 0 if
 409  * the object should be ticked immediately and tv->tv_sec is set to -1 if no
 410  * timeout is currently active.
 411  */
 412 int ossl_quic_get_tick_timeout(QUIC_CONNECTION *qc, struct timeval *tv)
 413 {
 414     OSSL_TIME deadline = ossl_time_infinite();
 415
 416     if (qc->ch != NULL)
 417         deadline
 418             = ossl_quic_reactor_get_tick_deadline(ossl_quic_channel_get_reactor(qc->ch));
 419
 420     if (ossl_time_is_infinite(deadline)) {
 421         tv->tv_sec  = -1;
 422         tv->tv_usec = 0;
 423         return 1;
 424     }
 425
 426     *tv = ossl_time_to_timeval(ossl_time_subtract(deadline, ossl_time_now()));
 427     return 1;
 428 }
 429
 430 /* SSL_get_rpoll_descriptor */
 431 int ossl_quic_get_rpoll_descriptor(QUIC_CONNECTION *qc, BIO_POLL_DESCRIPTOR *desc)
 432 {
 433     if (desc == NULL || qc->net_rbio == NULL)
 434         return 0;
 435
 436     return BIO_get_rpoll_descriptor(qc->net_rbio, desc);
 437 }
 438
 439 /* SSL_get_wpoll_descriptor */
 440 int ossl_quic_get_wpoll_descriptor(QUIC_CONNECTION *qc, BIO_POLL_DESCRIPTOR *desc)
 441 {
 442     if (desc == NULL || qc->net_wbio == NULL)
 443         return 0;
 444
 445     return BIO_get_wpoll_descriptor(qc->net_wbio, desc);
 446 }
 447
 448 /* SSL_want_net_read */
 449 int ossl_quic_get_want_net_read(QUIC_CONNECTION *qc)
 450 {
 451     if (qc->ch == NULL)
 452         return 0;
 453
 454     return ossl_quic_reactor_want_net_read(ossl_quic_channel_get_reactor(qc->ch));
 455 }
 456
 457 /* SSL_want_net_write */
 458 int ossl_quic_get_want_net_write(QUIC_CONNECTION *qc)
 459 {
 460     if (qc->ch == NULL)
 461         return 0;
 462
 463     return ossl_quic_reactor_want_net_write(ossl_quic_channel_get_reactor(qc->ch));
 464 }
 465
 466 /*
 467  * QUIC Front-End I/O API: Connection Lifecycle Operations
 468  * =======================================================
 469  *
 470  *         SSL_do_handshake         => ossl_quic_do_handshake
 471  *         SSL_set_connect_state    => ossl_quic_set_connect_state
 472  *         SSL_set_accept_state     => ossl_quic_set_accept_state
 473  *         SSL_shutdown             => ossl_quic_shutdown
 474  *         SSL_ctrl                 => ossl_quic_ctrl
 475  *   (BIO/)SSL_connect              => ossl_quic_connect
 476  *   (BIO/)SSL_accept               => ossl_quic_accept
 477  *
 478  */
 479
 480 /* SSL_shutdown */
 481 int ossl_quic_shutdown(SSL *s)
 482 {
 483     QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
 484
 485     if (!expect_quic_conn(qc))
 486         return 0;
 487
 488     if (qc->ch != NULL)
 489         ossl_quic_channel_local_close(qc->ch);
 490
 491     return 1;
 492 }
 493
 494 /* SSL_ctrl */
 495 static void fixup_mode_change(QUIC_CONNECTION *qc)
 496 {
 497     /* If enabling EPW mode, cancel any AON write */
 498     if ((qc->ssl_mode & SSL_MODE_ENABLE_PARTIAL_WRITE) != 0)
 499         aon_write_finish(qc);
 500 }
 501
 502 long ossl_quic_ctrl(SSL *s, int cmd, long larg, void *parg)
 503 {
 504     QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
 505
 506     if (!expect_quic_conn(qc))
 507         return 0;
 508
 509     switch (cmd) {
 510     case SSL_CTRL_MODE:
 511         qc->ssl_mode |= (uint32_t)larg;
 512         fixup_mode_change(qc);
 513         return qc->ssl_mode;
 514     case SSL_CTRL_CLEAR_MODE:
 515         qc->ssl_mode &= ~(uint32_t)larg;
 516         fixup_mode_change(qc);
 517         return qc->ssl_mode;
 518     default:
 519         return 0;
 520     }
 521 }
 522
 523 /* SSL_set_connect_state */
 524 void ossl_quic_set_connect_state(QUIC_CONNECTION *qc)
 525 {
 526     /* Cannot be changed after handshake started */
 527     if (qc->started)
 528         return;
 529
 530     qc->as_server = 0;
 531 }
 532
 533 /* SSL_set_accept_state */
 534 void ossl_quic_set_accept_state(QUIC_CONNECTION *qc)
 535 {
 536     /* Cannot be changed after handshake started */
 537     if (qc->started)
 538         return;
 539
 540     qc->as_server = 1;
 541 }
 542
 543 /* SSL_do_handshake */
 544 struct quic_handshake_wait_args {
 545     QUIC_CONNECTION     *qc;
 546 };
 547
 548 static int quic_handshake_wait(void *arg)
 549 {
 550     struct quic_handshake_wait_args *args = arg;
 551
 552     if (!ossl_quic_channel_is_active(args->qc->ch))
 553         return -1;
 554
 555     if (ossl_quic_channel_is_handshake_complete(args->qc->ch))
 556         return 1;
 557
 558     return 0;
 559 }
 560
 561 static int configure_channel(QUIC_CONNECTION *qc)
 562 {
 563     assert(qc->ch != NULL);
 564
 565     if (!ossl_quic_channel_set_net_rbio(qc->ch, qc->net_rbio)
 566         || !ossl_quic_channel_set_net_wbio(qc->ch, qc->net_wbio)
 567         || !ossl_quic_channel_set_peer_addr(qc->ch, &qc->init_peer_addr))
 568         return 0;
 569
 570     return 1;
 571 }
 572
 573 /*
 574  * Creates a channel and configures it with the information we have accumulated
 575  * via calls made to us from the application prior to starting a handshake
 576  * attempt.
 577  */
 578 static int ensure_channel_and_start(QUIC_CONNECTION *qc)
 579 {
 580     QUIC_CHANNEL_ARGS args = {0};
 581
 582     if (qc->ch != NULL)
 583         return 1;
 584
 585     args.libctx     = qc->ssl.ctx->libctx;
 586     args.propq      = qc->ssl.ctx->propq;
 587     args.is_server  = 0;
 588
 589     qc->ch = ossl_quic_channel_new(&args);
 590     if (qc->ch == NULL)
 591         return 0;
 592
 593     if (!configure_channel(qc)
 594         || !ossl_quic_channel_start(qc->ch)) {
 595         ossl_quic_channel_free(qc->ch);
 596         qc->ch = NULL;
 597         return 0;
 598     }
 599
 600     qc->stream0 = ossl_quic_channel_get_stream_by_id(qc->ch, 0);
 601     if (qc->stream0 == NULL) {
 602         ossl_quic_channel_free(qc->ch);
 603         qc->ch = NULL;
 604         return 0;
 605     }
 606
 607     qc->started = 1;
 608     return 1;
 609 }
 610
 611 int ossl_quic_do_handshake(QUIC_CONNECTION *qc)
 612 {
 613     int ret;
 614
 615     if (qc->ch != NULL && ossl_quic_channel_is_term_any(qc->ch))
 616         return QUIC_RAISE_NON_NORMAL_ERROR(qc, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
 617
 618     if (BIO_ADDR_family(&qc->init_peer_addr) == AF_UNSPEC)
 619         /* Peer address must have been set. */
 620         return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_PASSED_INVALID_ARGUMENT, NULL);
 621
 622     if (qc->as_server)
 623         /* TODO(QUIC): Server mode not currently supported */
 624         return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_PASSED_INVALID_ARGUMENT, NULL);
 625
 626     if (qc->net_rbio == NULL || qc->net_wbio == NULL)
 627         /* Need read and write BIOs. */
 628         return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_PASSED_INVALID_ARGUMENT, NULL);
 629
 630     /*
 631      * Start connection process. Note we may come here multiple times in
 632      * non-blocking mode, which is fine.
 633      */
 634     if (!ensure_channel_and_start(qc))
 635         return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
 636
 637     if (ossl_quic_channel_is_handshake_complete(qc->ch))
 638         /* The handshake is now done. */
 639         return 1;
 640
 641     if (blocking_mode(qc)) {
 642         /* In blocking mode, wait for the handshake to complete. */
 643         struct quic_handshake_wait_args args;
 644
 645         args.qc     = qc;
 646
 647         ret = block_until_pred(qc, quic_handshake_wait, &args, 0);
 648         if (!ossl_quic_channel_is_active(qc->ch))
 649             return QUIC_RAISE_NON_NORMAL_ERROR(qc, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
 650         else if (ret <= 0)
 651             return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
 652
 653         assert(ossl_quic_channel_is_handshake_complete(qc->ch));
 654         return 1;
 655     } else {
 656         /* Otherwise, indicate that the handshake isn't done yet. */
 657         return QUIC_RAISE_NORMAL_ERROR(qc, SSL_ERROR_WANT_READ);
 658     }
 659 }
 660
 661 /* SSL_connect */
 662 int ossl_quic_connect(SSL *s)
 663 {
 664     QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
 665
 666     if (!expect_quic_conn(qc))
 667         return 0;
 668
 669     /* Ensure we are in connect state (no-op if non-idle). */
 670     ossl_quic_set_connect_state(qc);
 671
 672     /* Begin or continue the handshake */
 673     return ossl_quic_do_handshake(qc);
 674 }
 675
 676 /* SSL_accept */
 677 int ossl_quic_accept(SSL *s)
 678 {
 679     QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
 680
 681     if (!expect_quic_conn(qc))
 682         return 0;
 683
 684     /* Ensure we are in accept state (no-op if non-idle). */
 685     ossl_quic_set_accept_state(qc);
 686
 687     /* Begin or continue the handshake */
 688     return ossl_quic_do_handshake(qc);
 689 }
 690
 691 /*
 692  * QUIC Front-End I/O API: Steady-State Operations
 693  * ===============================================
 694  *
 695  * Here we dispatch calls to the steady-state front-end I/O API functions; that
 696  * is, the functions used during the established phase of a QUIC connection
 697  * (e.g. SSL_read, SSL_write).
 698  *
 699  * Each function must handle both blocking and non-blocking modes. As discussed
 700  * above, all QUIC I/O is implemented using non-blocking mode internally.
 701  *
 702  *         SSL_get_error        => partially implemented by ossl_quic_get_error
 703  *   (BIO/)SSL_read             => ossl_quic_read
 704  *   (BIO/)SSL_write            => ossl_quic_write
 705  *         SSL_pending          => ossl_quic_pending
 706  */
 707
 708 /* SSL_get_error */
 709 int ossl_quic_get_error(const QUIC_CONNECTION *qc, int i)
 710 {
 711     return qc->last_error;
 712 }
 713
 714 /*
 715  * SSL_write
 716  * ---------
 717  *
 718  * The set of functions below provide the implementation of the public SSL_write
 719  * function. We must handle:
 720  *
 721  *   - both blocking and non-blocking operation at the application level,
 722  *     depending on how we are configured;
 723  *
 724  *   - SSL_MODE_ENABLE_PARTIAL_WRITE being on or off;
 725  *
 726  *   - SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER.
 727  *
 728  */
 729 static void quic_post_write(QUIC_CONNECTION *qc, int did_append, int do_tick)
 730 {
 731     /*
 732      * We have appended at least one byte to the stream.
 733      * Potentially mark stream as active, depending on FC.
 734      */
 735     if (did_append)
 736         ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(qc->ch),
 737                                           qc->stream0);
 738
 739     /*
 740      * Try and send.
 741      *
 742      * TODO(QUIC): It is probably inefficient to try and do this immediately,
 743      * plus we should eventually consider Nagle's algorithm.
 744      */
 745     if (do_tick)
 746         ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(qc->ch));
 747 }
 748
 749 struct quic_write_again_args {
 750     QUIC_CONNECTION     *qc;
 751     const unsigned char *buf;
 752     size_t              len;
 753     size_t              total_written;
 754 };
 755
 756 static int quic_write_again(void *arg)
 757 {
 758     struct quic_write_again_args *args = arg;
 759     size_t actual_written = 0;
 760
 761     if (!ossl_quic_channel_is_active(args->qc->ch))
 762         /* If connection is torn down due to an error while blocking, stop. */
 763         return -2;
 764
 765     if (!ossl_quic_sstream_append(args->qc->stream0->sstream,
 766                                   args->buf, args->len, &actual_written))
 767         return -2;
 768
 769     quic_post_write(args->qc, actual_written > 0, 0);
 770
 771     args->buf           += actual_written;
 772     args->len           -= actual_written;
 773     args->total_written += actual_written;
 774
 775     if (actual_written == 0)
 776         /* Written everything, done. */
 777         return 1;
 778
 779     /* Not written everything yet, keep trying. */
 780     return 0;
 781 }
 782
 783 static int quic_write_blocking(QUIC_CONNECTION *qc, const void *buf, size_t len,
 784                                size_t *written)
 785 {
 786     int res;
 787     struct quic_write_again_args args;
 788     size_t actual_written = 0;
 789
 790     /* First make a best effort to append as much of the data as possible. */
 791     if (!ossl_quic_sstream_append(qc->stream0->sstream, buf, len,
 792                                   &actual_written)) {
 793         /* Stream already finished or allocation error. */
 794         *written = 0;
 795         return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
 796     }
 797
 798     quic_post_write(qc, actual_written > 0, 1);
 799
 800     if (actual_written == len) {
 801         /* Managed to append everything on the first try. */
 802         *written = actual_written;
 803         return 1;
 804     }
 805
 806     /*
 807      * We did not manage to append all of the data immediately, so the stream
 808      * buffer has probably filled up. This means we need to block until some of
 809      * it is freed up.
 810      */
 811     args.qc             = qc;
 812     args.buf            = (const unsigned char *)buf + actual_written;
 813     args.len            = len - actual_written;
 814     args.total_written  = 0;
 815
 816     res = block_until_pred(qc, quic_write_again, &args, 0);
 817     if (res <= 0) {
 818         if (!ossl_quic_channel_is_active(qc->ch))
 819             return QUIC_RAISE_NON_NORMAL_ERROR(qc, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
 820         else
 821             return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
 822     }
 823
 824     *written = args.total_written;
 825     return 1;
 826 }
 827
 828 static void aon_write_begin(QUIC_CONNECTION *qc, const unsigned char *buf,
 829                             size_t buf_len, size_t already_sent)
 830 {
 831     assert(!qc->aon_write_in_progress);
 832
 833     qc->aon_write_in_progress = 1;
 834     qc->aon_buf_base          = buf;
 835     qc->aon_buf_pos           = already_sent;
 836     qc->aon_buf_len           = buf_len;
 837 }
 838
 839 static void aon_write_finish(QUIC_CONNECTION *qc)
 840 {
 841     qc->aon_write_in_progress   = 0;
 842     qc->aon_buf_base            = NULL;
 843     qc->aon_buf_pos             = 0;
 844     qc->aon_buf_len             = 0;
 845 }
 846
 847 static int quic_write_nonblocking_aon(QUIC_CONNECTION *qc, const void *buf,
 848                                       size_t len, size_t *written)
 849 {
 850     const void *actual_buf;
 851     size_t actual_len, actual_written = 0;
 852     int accept_moving_buffer
 853         = ((qc->ssl_mode & SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER) != 0);
 854
 855     if (qc->aon_write_in_progress) {
 856         /*
 857          * We are in the middle of an AON write (i.e., a previous write did not
 858          * manage to append all data to the SSTREAM and we have EPW mode
 859          * disabled.)
 860          */
 861         if ((!accept_moving_buffer && qc->aon_buf_base != buf)
 862             || len != qc->aon_buf_len)
 863             /*
 864              * Pointer must not have changed if we are not in accept moving
 865              * buffer mode. Length must never change.
 866              */
 867             return QUIC_RAISE_NON_NORMAL_ERROR(qc, SSL_R_BAD_WRITE_RETRY, NULL);
 868
 869         actual_buf = (unsigned char *)buf + qc->aon_buf_pos;
 870         actual_len = len - qc->aon_buf_pos;
 871         assert(actual_len > 0);
 872     } else {
 873         actual_buf = buf;
 874         actual_len = len;
 875     }
 876
 877     /* First make a best effort to append as much of the data as possible. */
 878     if (!ossl_quic_sstream_append(qc->stream0->sstream, actual_buf, actual_len,
 879                                   &actual_written)) {
 880         /* Stream already finished or allocation error. */
 881         *written = 0;
 882         return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
 883     }
 884
 885     quic_post_write(qc, actual_written > 0, 1);
 886
 887     if (actual_written == actual_len) {
 888         /* We have sent everything. */
 889         if (qc->aon_write_in_progress) {
 890             /*
 891              * We have sent everything, and we were in the middle of an AON
 892              * write. The output write length is the total length of the AON
 893              * buffer, not however many bytes we managed to write to the stream
 894              * in this call.
 895              */
 896             *written = qc->aon_buf_len;
 897             aon_write_finish(qc);
 898         } else {
 899             *written = actual_written;
 900         }
 901
 902         return 1;
 903     }
 904
 905     if (qc->aon_write_in_progress) {
 906         /*
 907          * AON write is in progress but we have not written everything yet. We
 908          * may have managed to send zero bytes, or some number of bytes less
 909          * than the total remaining which need to be appended during this
 910          * AON operation.
 911          */
 912         qc->aon_buf_pos += actual_written;
 913         assert(qc->aon_buf_pos < qc->aon_buf_len);
 914         return QUIC_RAISE_NORMAL_ERROR(qc, SSL_ERROR_WANT_WRITE);
 915     }
 916
 917     /*
 918      * Not in an existing AON operation but partial write is not enabled, so we
 919      * need to begin a new AON operation. However we needn't bother if we didn't
 920      * actually append anything.
 921      */
 922     if (actual_written > 0)
 923         aon_write_begin(qc, buf, len, actual_written);
 924
 925     /*
 926      * AON - We do not publicly admit to having appended anything until AON
 927      * completes.
 928      */
 929     *written = 0;
 930     return QUIC_RAISE_NORMAL_ERROR(qc, SSL_ERROR_WANT_WRITE);
 931 }
 932
 933 static int quic_write_nonblocking_epw(QUIC_CONNECTION *qc, const void *buf, size_t len,
 934                                       size_t *written)
 935 {
 936     /* Simple best effort operation. */
 937     if (!ossl_quic_sstream_append(qc->stream0->sstream, buf, len, written)) {
 938         /* Stream already finished or allocation error. */
 939         *written = 0;
 940         return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
 941     }
 942
 943     quic_post_write(qc, *written > 0, 1);
 944     return 1;
 945 }
 946
 947 int ossl_quic_write(SSL *s, const void *buf, size_t len, size_t *written)
 948 {
 949     QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
 950     int partial_write = ((qc->ssl_mode & SSL_MODE_ENABLE_PARTIAL_WRITE) != 0);
 951
 952     *written = 0;
 953
 954     if (!expect_quic_conn(qc))
 955         return 0;
 956
 957     /* If we haven't started the handshake, do so automatically. */
 958     if (!qc->started && !ossl_quic_do_handshake(qc))
 959         return 0;
 960
 961     if (qc->ch != NULL && ossl_quic_channel_is_term_any(qc->ch))
 962         return QUIC_RAISE_NON_NORMAL_ERROR(qc, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
 963
 964     if (qc->stream0 == NULL || qc->stream0->sstream == NULL)
 965         return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
 966
 967     if (blocking_mode(qc))
 968         return quic_write_blocking(qc, buf, len, written);
 969     else if (partial_write)
 970         return quic_write_nonblocking_epw(qc, buf, len, written);
 971     else
 972         return quic_write_nonblocking_aon(qc, buf, len, written);
 973 }
 974
 975 /*
 976  * SSL_read
 977  * --------
 978  */
 979 struct quic_read_again_args {
 980     QUIC_CONNECTION *qc;
 981     QUIC_STREAM     *stream;
 982     void            *buf;
 983     size_t          len;
 984     size_t          *bytes_read;
 985     int             peek;
 986 };
 987
 988 static int quic_read_actual(QUIC_CONNECTION *qc,
 989                             QUIC_STREAM *stream,
 990                             void *buf, size_t buf_len,
 991                             size_t *bytes_read,
 992                             int peek)
 993 {
 994     int is_fin = 0;
 995
 996     if (stream->rstream == NULL)
 997         return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
 998
 999     if (peek) {
1000         if (!ossl_quic_rstream_peek(stream->rstream, buf, buf_len,
1001                                     bytes_read, &is_fin))
1002             return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
1003
1004     } else {
1005         if (!ossl_quic_rstream_read(stream->rstream, buf, buf_len,
1006                                     bytes_read, &is_fin))
1007             return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
1008     }
1009
1010     if (!peek) {
1011         if (*bytes_read > 0) {
1012             /*
1013              * We have read at least one byte from the stream. Inform stream-level
1014              * RXFC of the retirement of controlled bytes. Update the active stream
1015              * status (the RXFC may now want to emit a frame granting more credit to
1016              * the peer).
1017              */
1018             OSSL_RTT_INFO rtt_info;
1019
1020             ossl_statm_get_rtt_info(ossl_quic_channel_get_statm(qc->ch), &rtt_info);
1021
1022             if (!ossl_quic_rxfc_on_retire(&qc->stream0->rxfc, *bytes_read,
1023                                           rtt_info.smoothed_rtt))
1024                 return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
1025         }
1026
1027         if (is_fin)
1028             stream->recv_fin_retired = 1;
1029
1030         if (*bytes_read > 0)
1031             ossl_quic_stream_map_update_state(ossl_quic_channel_get_qsm(qc->ch),
1032                                               qc->stream0);
1033     }
1034
1035     return 1;
1036 }
1037
1038 static int quic_read_again(void *arg)
1039 {
1040     struct quic_read_again_args *args = arg;
1041
1042     if (!ossl_quic_channel_is_active(args->qc->ch))
1043         /* If connection is torn down due to an error while blocking, stop. */
1044         return -2;
1045
1046     if (!quic_read_actual(args->qc, args->stream,
1047                           args->buf, args->len, args->bytes_read,
1048                           args->peek))
1049         return -1;
1050
1051     if (*args->bytes_read > 0)
1052         /* got at least one byte, the SSL_read op can finish now */
1053         return 1;
1054
1055     return 0; /* did not write anything, keep trying */
1056 }
1057
1058 static int quic_read(SSL *s, void *buf, size_t len, size_t *bytes_read, int peek)
1059 {
1060     int res;
1061     QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_SSL(s);
1062     struct quic_read_again_args args;
1063
1064     *bytes_read = 0;
1065
1066     if (!expect_quic_conn(qc))
1067         return 0;
1068
1069     if (qc->ch != NULL && ossl_quic_channel_is_term_any(qc->ch))
1070         return QUIC_RAISE_NON_NORMAL_ERROR(qc, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1071
1072     /* If we haven't started the handshake, do so automatically. */
1073     if (!qc->started && !ossl_quic_do_handshake(qc))
1074         return 0;
1075
1076     if (qc->stream0 == NULL)
1077         return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
1078
1079     if (!quic_read_actual(qc, qc->stream0, buf, len, bytes_read, peek))
1080         return 0;
1081
1082     if (*bytes_read > 0) {
1083         /*
1084          * Even though we succeeded, tick the reactor here to ensure we are
1085          * handling other aspects of the QUIC connection.
1086          */
1087         ossl_quic_reactor_tick(ossl_quic_channel_get_reactor(qc->ch));
1088         return 1;
1089     } else if (blocking_mode(qc)) {
1090         /*
1091          * We were not able to read anything immediately, so our stream
1092          * buffer is empty. This means we need to block until we get
1093          * at least one byte.
1094          */
1095         args.qc         = qc;
1096         args.stream     = qc->stream0;
1097         args.buf        = buf;
1098         args.len        = len;
1099         args.bytes_read = bytes_read;
1100         args.peek       = peek;
1101
1102         res = block_until_pred(qc, quic_read_again, &args, 0);
1103         if (res <= 0) {
1104             if (!ossl_quic_channel_is_active(qc->ch))
1105                 return QUIC_RAISE_NON_NORMAL_ERROR(qc, SSL_R_PROTOCOL_IS_SHUTDOWN, NULL);
1106             else
1107                 return QUIC_RAISE_NON_NORMAL_ERROR(qc, ERR_R_INTERNAL_ERROR, NULL);
1108         }
1109     }
1110
1111     return 1;
1112 }
1113
1114 int ossl_quic_read(SSL *s, void *buf, size_t len, size_t *bytes_read)
1115 {
1116     return quic_read(s, buf, len, bytes_read, 0);
1117 }
1118
1119 int ossl_quic_peek(SSL *s, void *buf, size_t len, size_t *bytes_read)
1120 {
1121     return quic_read(s, buf, len, bytes_read, 1);
1122 }
1123
1124 /*
1125  * SSL_pending
1126  * -----------
1127  */
1128 size_t ossl_quic_pending(const SSL *s)
1129 {
1130     const QUIC_CONNECTION *qc = QUIC_CONNECTION_FROM_CONST_SSL(s);
1131     size_t avail = 0;
1132     int fin = 0;
1133
1134     if (!expect_quic_conn(qc))
1135         return 0;
1136
1137     if (qc->stream0 == NULL || qc->stream0->rstream == NULL)
1138         /* Cannot raise errors here because we are const, just fail. */
1139         return 0;
1140
1141     if (!ossl_quic_rstream_available(qc->stream0->rstream, &avail, &fin))
1142         return 0;
1143
1144     return avail;
1145 }
1146
1147 /*
1148  * QUIC Front-End I/O API: SSL_CTX Management
1149  * ==========================================
1150  */
1151
1152 long ossl_quic_ctx_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg)
1153 {
1154     switch (cmd) {
1155     default:
1156         return ssl3_ctx_ctrl(ctx, cmd, larg, parg);
1157     }
1158 }
1159
1160 long ossl_quic_callback_ctrl(SSL *s, int cmd, void (*fp) (void))
1161 {
1162     return ssl3_callback_ctrl(s, cmd, fp);
1163 }
1164
1165 long ossl_quic_ctx_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp) (void))
1166 {
1167     return ssl3_ctx_callback_ctrl(ctx, cmd, fp);
1168 }
1169
1170 int ossl_quic_renegotiate_check(SSL *ssl, int initok)
1171 {
1172     /* We never do renegotiation. */
1173     return 0;
1174 }
1175
1176 /*
1177  * This is the subset of TLS1.3 ciphers which can be used with QUIC and which we
1178  * actually support.
1179  */
1180 static SSL_CIPHER tls13_quic_ciphers[] = {
1181     {
1182         1,
1183         TLS1_3_RFC_AES_128_GCM_SHA256,
1184         TLS1_3_RFC_AES_128_GCM_SHA256,
1185         TLS1_3_CK_AES_128_GCM_SHA256,
1186         SSL_kANY,
1187         SSL_aANY,
1188         SSL_AES128GCM,
1189         SSL_AEAD,
1190         TLS1_3_VERSION, TLS1_3_VERSION,
1191         0, 0,
1192         SSL_HIGH,
1193         SSL_HANDSHAKE_MAC_SHA256,
1194         128,
1195         128,
1196     }, {
1197         1,
1198         TLS1_3_RFC_AES_256_GCM_SHA384,
1199         TLS1_3_RFC_AES_256_GCM_SHA384,
1200         TLS1_3_CK_AES_256_GCM_SHA384,
1201         SSL_kANY,
1202         SSL_aANY,
1203         SSL_AES256GCM,
1204         SSL_AEAD,
1205         TLS1_3_VERSION, TLS1_3_VERSION,
1206         0, 0,
1207         SSL_HIGH,
1208         SSL_HANDSHAKE_MAC_SHA384,
1209         256,
1210         256,
1211     },
1212     {
1213         1,
1214         TLS1_3_RFC_CHACHA20_POLY1305_SHA256,
1215         TLS1_3_RFC_CHACHA20_POLY1305_SHA256,
1216         TLS1_3_CK_CHACHA20_POLY1305_SHA256,
1217         SSL_kANY,
1218         SSL_aANY,
1219         SSL_CHACHA20POLY1305,
1220         SSL_AEAD,
1221         TLS1_3_VERSION, TLS1_3_VERSION,
1222         0, 0,
1223         SSL_HIGH,
1224         SSL_HANDSHAKE_MAC_SHA256,
1225         256,
1226         256,
1227     }
1228 };
1229
1230 int ossl_quic_num_ciphers(void)
1231 {
1232     return OSSL_NELEM(tls13_quic_ciphers);
1233 }
1234
1235 const SSL_CIPHER *ossl_quic_get_cipher(unsigned int u)
1236 {
1237     if (u >= OSSL_NELEM(tls13_quic_ciphers))
1238         return NULL;
1239
1240     return &tls13_quic_ciphers[u];
1241 }