LCOV - code coverage report
Current view: top level - waltz/quic/tests - fuzz_quic_wire.c (source / functions) Hit Total Coverage
Test: cov.lcov Lines: 113 260 43.5 %
Date: 2025-01-08 12:08:44 Functions: 5 11 45.5 %

          Line data    Source code
       1             : /* fuzz_quic_wire is a simple and stateless fuzz target for fd_quic.
       2             : 
       3             :    The attack surface consists of fd_quic's packet handlers.
       4             :    The input vectors are the raw contents of UDP datagrams (in encrypted
       5             :    form)  A custom mutator is used to temporarily remove the decryption
       6             :    before calling the generic libFuzzer mutator.  If we tried mutating
       7             :    the encrypted inputs directly, everything would just be an encryption
       8             :    failure.
       9             : 
      10             :    The goal of fuzz_quic_wire is to cover the early upstream stages of
      11             :    the QUIC packet processing pipeline.  This includes packet header
      12             :    parsing, connection creation, retry handling, etc. */
      13             : 
      14             : #include "../../../util/sanitize/fd_fuzz.h"
      15             : #include "fd_quic_test_helpers.h"
      16             : #include "../crypto/fd_quic_crypto_suites.h"
      17             : #include "../templ/fd_quic_parse_util.h"
      18             : #include "../../tls/test_tls_helper.h"
      19             : #include "../../../util/net/fd_ip4.h"
      20             : #include "../../../util/net/fd_udp.h"
      21             : #include "../fd_quic_proto.h"
      22             : #include "../fd_quic_proto.c"
      23             : #include "../fd_quic_private.h"
      24             : 
      25             : #include <assert.h>
      26             : #include <stdlib.h> /* putenv, atexit */
      27             : 
      28             : static FD_TL ulong g_clock;
      29             : 
      30             : static ulong
      31        6699 : test_clock( void * context FD_FN_UNUSED ) {
      32        6699 :   return g_clock;
      33        6699 : }
      34             : 
      35             : int
      36             : LLVMFuzzerInitialize( int *    pargc,
      37          18 :                       char *** pargv ) {
      38          18 :   putenv( "FD_LOG_BACKTRACE=0" );
      39          18 :   fd_boot( pargc, pargv );
      40          18 :   atexit( fd_halt );
      41          18 :   fd_log_level_logfile_set(0);
      42          18 :   fd_log_level_stderr_set(0);
      43          18 : # ifndef FD_DEBUG_MODE
      44          18 :   fd_log_level_core_set(3); /* crash on warning log */
      45          18 : # endif
      46          18 :   return 0;
      47          18 : }
      48             : 
      49             : static int
      50             : _aio_send( void *                    ctx,
      51             :            fd_aio_pkt_info_t const * batch,
      52             :            ulong                     batch_cnt,
      53             :            ulong *                   opt_batch_idx,
      54         150 :            int                       flush ) {
      55         150 :   (void)flush;
      56         150 :   (void)batch;
      57         150 :   (void)batch_cnt;
      58         150 :   (void)opt_batch_idx;
      59         150 :   (void)ctx;
      60         150 :   return 0;
      61         150 : }
      62             : 
      63             : static void
      64             : send_udp_packet( fd_quic_t *   quic,
      65             :                  uchar const * data,
      66        2088 :                  ulong         size ) {
      67             : 
      68        2088 :   uchar buf[16384];
      69             : 
      70        2088 :   ulong headers_sz = sizeof(fd_ip4_hdr_t) + sizeof(fd_udp_hdr_t);
      71             : 
      72        2088 :   uchar * cur = buf;
      73        2088 :   uchar * end = buf + sizeof(buf);
      74             : 
      75        2088 :   fd_ip4_hdr_t ip4 = {
      76        2088 :     .verihl      = FD_IP4_VERIHL(4,5),
      77        2088 :     .protocol    = FD_IP4_HDR_PROTOCOL_UDP,
      78        2088 :     .net_tot_len = (ushort)( sizeof(fd_ip4_hdr_t)+sizeof(fd_udp_hdr_t)+size ),
      79        2088 :   };
      80        2088 :   fd_udp_hdr_t udp = {
      81        2088 :     .net_sport = 8000,
      82        2088 :     .net_dport = 8001,
      83        2088 :     .net_len   = (ushort)( sizeof(fd_udp_hdr_t)+size ),
      84        2088 :     .check     = 0
      85        2088 :   };
      86             : 
      87             :   /* Guaranteed to not overflow */
      88        2088 :   fd_quic_encode_ip4( cur, (ulong)( end-cur ), &ip4 ); cur += sizeof(fd_ip4_hdr_t);
      89        2088 :   fd_quic_encode_udp( cur, (ulong)( end-cur ), &udp ); cur += sizeof(fd_udp_hdr_t);
      90             : 
      91        2088 :   if( cur + size > end ) return;
      92        2088 :   fd_memcpy( cur, data, size );
      93             : 
      94             :   /* Main fuzz entrypoint */
      95             : 
      96        2088 :   fd_quic_process_packet( quic, buf, headers_sz + size );
      97        2088 : }
      98             : 
      99             : int
     100             : LLVMFuzzerTestOneInput( uchar const * data,
     101        2088 :                         ulong         size ) {
     102             : 
     103        2088 :   fd_rng_t _rng[1]; fd_rng_t * rng = fd_rng_join( fd_rng_new( _rng, 0U, 0UL ) );
     104             : 
     105             :   /* Memory region to hold the QUIC instance */
     106        2088 :   static uchar quic_mem[ 1<<23 ] __attribute__((aligned(FD_QUIC_ALIGN)));
     107             : 
     108             :   /* Create ultra low limits for QUIC instance for maximum performance */
     109        2088 :   fd_quic_limits_t const quic_limits = {
     110        2088 :     .conn_cnt         = 2,
     111        2088 :     .handshake_cnt    = 2,
     112        2088 :     .conn_id_cnt      = 4,
     113        2088 :     .inflight_pkt_cnt = 8UL,
     114        2088 :     .stream_pool_cnt  = 8UL
     115        2088 :   };
     116             : 
     117             :   /* Enable features depending on the last few bits.  The last bits are
     118             :      pseudorandom (either ignored or belong to the MAC tag) */
     119        2088 :   uint last_byte = 0U;
     120        2088 :   if( size > 0 ) last_byte = data[ size-1 ];
     121        2088 :   int enable_retry = !!(last_byte & 1);
     122        2088 :   int role         =   (last_byte & 2) ? FD_QUIC_ROLE_SERVER : FD_QUIC_ROLE_CLIENT;
     123        2088 :   int established  = !!(last_byte & 4);
     124             : 
     125        2088 :   assert( fd_quic_footprint( &quic_limits ) <= sizeof(quic_mem) );
     126           0 :   void *      shquic = fd_quic_new( quic_mem, &quic_limits );
     127        2088 :   fd_quic_t * quic   = fd_quic_join( shquic );
     128             : 
     129        2088 :   fd_quic_config_anonymous( quic, role );
     130             : 
     131        2088 :   fd_tls_test_sign_ctx_t test_signer[1];
     132        2088 :   fd_tls_test_sign_ctx( test_signer, rng );
     133        2088 :   fd_quic_config_test_signer( quic, test_signer );
     134             : 
     135        2088 :   quic->cb.now = test_clock;
     136        2088 :   quic->config.retry = enable_retry;
     137             : 
     138        2088 :   fd_aio_t aio_[1];
     139        2088 :   fd_aio_t * aio = fd_aio_join( fd_aio_new( aio_, NULL, _aio_send ) );
     140        2088 :   assert( aio );
     141             : 
     142           0 :   fd_quic_set_aio_net_tx( quic, aio );
     143        2088 :   assert( fd_quic_init( quic ) );
     144           0 :   assert( quic->config.idle_timeout > 0 );
     145             : 
     146           0 :   fd_quic_state_t * state = fd_quic_get_state( quic );
     147             : 
     148             :   /* Create dummy connection */
     149        2088 :   ulong             our_conn_id  = 0UL;
     150        2088 :   fd_quic_conn_id_t peer_conn_id = { .sz=8 };
     151        2088 :   uint              dst_ip_addr  = 0U;
     152        2088 :   ushort            dst_udp_port = (ushort)0;
     153             : 
     154        2088 :   fd_quic_conn_t * conn =
     155        2088 :     fd_quic_conn_create( quic,
     156        2088 :                          our_conn_id, &peer_conn_id,
     157        2088 :                          dst_ip_addr,  (ushort)dst_udp_port,
     158        2088 :                          1  /* we are the server */ );
     159        2088 :   assert( conn );
     160           0 :   assert( conn->svc_type == FD_QUIC_SVC_WAIT );
     161             : 
     162           0 :   conn->tx_max_data                            =       512UL;
     163        2088 :   conn->tx_initial_max_stream_data_uni         =        64UL;
     164        2088 :   conn->srx->rx_max_data                       =       512UL;
     165        2088 :   conn->srx->rx_sup_stream_id                  =        32UL;
     166        2088 :   conn->tx_max_datagram_sz                     = FD_QUIC_MTU;
     167        2088 :   conn->tx_sup_stream_id                       =        32UL;
     168             : 
     169        2088 :   if( established ) {
     170         861 :     conn->state = FD_QUIC_CONN_STATE_ACTIVE;
     171         861 :     conn->keys_avail = 0xff;
     172         861 :   }
     173             : 
     174        2088 :   g_clock = 1000UL;
     175             : 
     176             :   /* Calls fuzz entrypoint */
     177        2088 :   send_udp_packet( quic, data, size );
     178             : 
     179             :   /* svc_quota is the max number of service calls that we expect to
     180             :      schedule in response to a single packet. */
     181        2088 :   long svc_quota = fd_long_max( (long)size, 1000L );
     182             : 
     183        2169 :   while( state->svc_queue[ FD_QUIC_SVC_INSTANT ].tail!=UINT_MAX ) {
     184          81 :     fd_quic_service( quic );
     185          81 :     assert( --svc_quota > 0 );
     186          81 :   }
     187        2088 :   assert( conn->svc_type != FD_QUIC_SVC_INSTANT );
     188             : 
     189             :   /* Generate ACKs */
     190        2088 :   while( state->svc_queue[ FD_QUIC_SVC_ACK_TX ].head != UINT_MAX ) {
     191           0 :     fd_quic_conn_t * conn = fd_quic_conn_at_idx( state, state->svc_queue[ FD_QUIC_SVC_ACK_TX ].head );
     192           0 :     g_clock = conn->svc_time;
     193           0 :     fd_quic_service( quic );
     194           0 :     assert( --svc_quota > 0 );
     195           0 :   }
     196        2088 :   assert( conn->svc_type != FD_QUIC_SVC_INSTANT &&
     197        2088 :           conn->svc_type != FD_QUIC_SVC_ACK_TX );
     198             : 
     199             :   /* Simulate conn timeout */
     200        6618 :   while( state->svc_queue[ FD_QUIC_SVC_WAIT ].head != UINT_MAX ) {
     201        4530 :     ulong idle_timeout_ts = conn->last_activity + quic->config.idle_timeout + 1UL;
     202        4530 :     fd_quic_conn_t * conn = fd_quic_conn_at_idx( state, state->svc_queue[ FD_QUIC_SVC_WAIT ].head );
     203             : 
     204             :     /* Idle timeouts should not be scheduled significantly late */
     205        4530 :     assert( conn->svc_time < idle_timeout_ts + (ulong)2e9 );
     206             : 
     207           0 :     g_clock = conn->svc_time;
     208        4530 :     fd_quic_service( quic );
     209        4530 :     assert( --svc_quota > 0 );
     210        4530 :   }
     211        2088 :   assert( conn->svc_type == UINT_MAX );
     212           0 :   assert( conn->state == FD_QUIC_CONN_STATE_DEAD || conn->state == FD_QUIC_CONN_STATE_INVALID );
     213             : 
     214           0 :   fd_quic_delete( fd_quic_leave( fd_quic_fini( quic ) ) );
     215        2088 :   fd_aio_delete( fd_aio_leave( aio ) );
     216        2088 :   fd_rng_delete( fd_rng_leave( rng ) );
     217        2088 :   return 0;
     218        2088 : }
     219             : 
     220             : #if !FD_QUIC_DISABLE_CRYPTO
     221             : 
     222             : static fd_quic_crypto_keys_t const keys[1] = {{
     223             :   .pkt_key    = {0},
     224             :   .iv         = {0},
     225             :   .hp_key     = {0},
     226             : }};
     227             : 
     228             : /* guess_packet_size attempts to discover the end of a QUIC packet.
     229             :    Returns the total length (including GCM tag) on success, sets *pn_off
     230             :    to the packet number offset and *pn to the packet number.  Returns
     231             :    0UL on failure. */
     232             : 
     233             : static ulong
     234             : guess_packet_size( uchar const * data,
     235             :                    ulong         size,
     236           0 :                    ulong *       pn_off ) {
     237             : 
     238           0 :   uchar const * cur_ptr = data;
     239           0 :   ulong         cur_sz  = size;
     240             : 
     241           0 :   ulong pkt_num_pnoff = 0UL;
     242           0 :   ulong total_len     = size;
     243             : 
     244           0 :   if( FD_UNLIKELY( size < 1 ) ) return FD_QUIC_PARSE_FAIL;
     245           0 :   uchar hdr_form = fd_quic_h0_hdr_form( *cur_ptr );
     246             : 
     247           0 :   ulong rc;
     248           0 :   if( hdr_form == 1 ) {  /* long header */
     249             : 
     250           0 :     uchar long_packet_type = fd_quic_h0_long_packet_type( *cur_ptr );
     251           0 :     cur_ptr += 1; cur_sz -= 1UL;
     252           0 :     fd_quic_long_hdr_t long_hdr[1];
     253           0 :     rc = fd_quic_decode_long_hdr( long_hdr, cur_ptr, cur_sz );
     254           0 :     if( rc == FD_QUIC_PARSE_FAIL ) return 0UL;
     255           0 :     cur_ptr += rc; cur_sz -= rc;
     256             : 
     257           0 :     switch( long_packet_type ) {
     258           0 :     case FD_QUIC_PKT_TYPE_INITIAL: {
     259           0 :       fd_quic_initial_t initial[1];
     260           0 :       rc = fd_quic_decode_initial( initial, cur_ptr, cur_sz );
     261           0 :       if( rc == FD_QUIC_PARSE_FAIL ) return 0UL;
     262           0 :       cur_ptr += rc; cur_sz -= rc;
     263             : 
     264           0 :       pkt_num_pnoff = initial->pkt_num_pnoff;
     265           0 :       total_len     = pkt_num_pnoff + initial->len;
     266           0 :       break;
     267           0 :     }
     268           0 :     case FD_QUIC_PKT_TYPE_HANDSHAKE: {
     269           0 :       fd_quic_handshake_t handshake[1];
     270           0 :       rc = fd_quic_decode_handshake( handshake, cur_ptr, cur_sz );
     271           0 :       if( rc == FD_QUIC_PARSE_FAIL ) return 0UL;
     272           0 :       cur_ptr += rc; cur_sz -= rc;
     273             : 
     274           0 :       pkt_num_pnoff = handshake->pkt_num_pnoff;
     275           0 :       total_len     = pkt_num_pnoff + handshake->len;
     276           0 :       break;
     277           0 :     }
     278           0 :     case FD_QUIC_PKT_TYPE_RETRY:
     279             :       /* Do we need to decrypt Retry packets?  I'm not sure */
     280             :       /* TODO correctly derive size of packet in case there is another
     281             :               packet following the retry packet */
     282           0 :       return 0UL;
     283           0 :     case FD_QUIC_PKT_TYPE_ZERO_RTT:
     284             :       /* No support for 0-RTT yet */
     285           0 :       return 0UL;
     286           0 :     default:
     287           0 :       __builtin_unreachable();
     288           0 :     }
     289             : 
     290           0 :   } else {  /* short header */
     291             : 
     292           0 :     fd_quic_one_rtt_t one_rtt[1];
     293           0 :     one_rtt->dst_conn_id_len = 8;
     294           0 :     rc = fd_quic_decode_one_rtt( one_rtt, cur_ptr, cur_sz );
     295           0 :     if( rc == FD_QUIC_PARSE_FAIL ) return 0UL;
     296           0 :     cur_ptr += rc; cur_sz -= rc;
     297             : 
     298           0 :     pkt_num_pnoff = one_rtt->pkt_num_pnoff;
     299             : 
     300           0 :   }
     301             : 
     302           0 :   *pn_off = pkt_num_pnoff;
     303           0 :   return total_len;
     304           0 : }
     305             : 
     306             : /* decrypt_packet attempts to decrypt the first QUIC packet in the given
     307             :    buffer.  data points to the first byte of the QUIC packet.  size is
     308             :    the number of bytes until the end of the UDP datagram.  Returns the
     309             :    number of bytes that belonged to the first packet (<= size) on
     310             :    success.  Returns 0 on failure and leaves the packet (partially)
     311             :    encrypted. */
     312             : 
     313             : static ulong
     314             : decrypt_packet( uchar * const data,
     315           0 :                 ulong   const size ) {
     316             : 
     317           0 :   ulong pkt_num_pnoff = 0UL;
     318           0 :   ulong total_len = guess_packet_size( data, size, &pkt_num_pnoff );
     319           0 :   if( !total_len ) return 0UL;
     320             : 
     321             :   /* Decrypt the packet */
     322             : 
     323           0 :   int decrypt_res = fd_quic_crypto_decrypt_hdr( data, size, pkt_num_pnoff, keys );
     324           0 :   if( decrypt_res != FD_QUIC_SUCCESS ) return 0UL;
     325             : 
     326           0 :   uint  pkt_number_sz = fd_quic_h0_pkt_num_len( data[0] ) + 1u;
     327           0 :   ulong pkt_number    = fd_quic_pktnum_decode( data+pkt_num_pnoff, pkt_number_sz );
     328             : 
     329           0 :   decrypt_res =
     330           0 :     fd_quic_crypto_decrypt( data,           size,
     331           0 :                             pkt_num_pnoff,  pkt_number,
     332           0 :                             keys );
     333           0 :   if( decrypt_res != FD_QUIC_SUCCESS ) return 0UL;
     334             : 
     335           0 :   return fd_ulong_min( total_len + FD_QUIC_CRYPTO_TAG_SZ, size );
     336           0 : }
     337             : 
     338             : /* decrypt_payload attempts to remove packet protection of a UDP
     339             :    datagram payload in-place.  Note that a UDP datagram can contain
     340             :    multiple QUIC packets. */
     341             : 
     342             : static int
     343             : decrypt_payload( uchar * data,
     344           0 :                  ulong   size ) {
     345             : 
     346           0 :   if( size < 16 ) return 0;
     347             : 
     348             :   /* Heuristic: If the last 16 bytes of the packet (the AES-GCM tag) are
     349             :      zero consider it an unencrypted packet */
     350             : 
     351           0 :   uint mask=0U;
     352           0 :   for( ulong j=0UL; j<16UL; j++ ) mask |= data[size-16+j];
     353           0 :   if( !mask ) return 1;
     354             : 
     355           0 :   uchar * cur_ptr = data;
     356           0 :   ulong   cur_sz  = size;
     357             : 
     358           0 :   do {
     359             : 
     360           0 :     ulong sz = decrypt_packet( cur_ptr, cur_sz );
     361           0 :     if( !sz ) return 0;
     362           0 :     assert( sz <= cur_sz );  /* prevent out of bounds */
     363             : 
     364           0 :     cur_ptr += sz;  cur_sz -= sz;
     365             : 
     366           0 :   } while( cur_sz );
     367             : 
     368           0 :   return 1;
     369           0 : }
     370             : 
     371             : static ulong
     372             : encrypt_packet( uchar * const data,
     373           0 :                 ulong   const size ) {
     374             : 
     375           0 :   uchar out[ FD_QUIC_MTU ];
     376             : 
     377           0 :   ulong pkt_num_pnoff = 0UL;
     378           0 :   ulong total_len = guess_packet_size( data, size, &pkt_num_pnoff );
     379           0 :   if( ( total_len < FD_QUIC_CRYPTO_TAG_SZ ) |
     380           0 :       ( total_len > size                  ) |
     381           0 :       ( total_len > sizeof(out)           ) )
     382           0 :     return size;
     383             : 
     384           0 :   uchar first = data[0];
     385           0 :   ulong pkt_number_sz = ( first & 0x03u ) + 1;
     386             : 
     387           0 :   ulong         out_sz = total_len;
     388           0 :   uchar const * hdr    = data;
     389           0 :   ulong         hdr_sz = pkt_num_pnoff + pkt_number_sz;
     390             : 
     391           0 :   ulong pkt_number = 0UL;
     392           0 :   for( ulong j = 0UL; j < pkt_number_sz; ++j ) {
     393           0 :     pkt_number = ( pkt_number << 8UL ) + (ulong)( hdr[pkt_num_pnoff + j] );
     394           0 :   }
     395             : 
     396           0 :   if( ( out_sz          < hdr_sz ) |
     397           0 :       ( out_sz - hdr_sz < FD_QUIC_CRYPTO_TAG_SZ ) )
     398           0 :     return size;
     399             : 
     400           0 :   uchar const * pay    = hdr + hdr_sz;
     401           0 :   ulong         pay_sz = out_sz - hdr_sz - FD_QUIC_CRYPTO_TAG_SZ;
     402             : 
     403           0 :   int encrypt_res =
     404           0 :     fd_quic_crypto_encrypt( out, &out_sz,
     405           0 :                             hdr, hdr_sz,
     406           0 :                             pay, pay_sz,
     407           0 :                             keys, keys,
     408           0 :                             pkt_number );
     409           0 :   if( encrypt_res != FD_QUIC_SUCCESS )
     410           0 :     return size;
     411           0 :   assert( out_sz == total_len );
     412             : 
     413           0 :   fd_memcpy( data, out, out_sz );
     414           0 :   return out_sz;
     415           0 : }
     416             : 
     417             : static void
     418             : encrypt_payload( uchar * data,
     419           0 :                  ulong   size ) {
     420             : 
     421           0 :   uchar * cur_ptr = data;
     422           0 :   ulong   cur_sz  = size;
     423             : 
     424           0 :   while( cur_sz ) {
     425           0 :     ulong sz = encrypt_packet( cur_ptr, cur_sz );
     426           0 :     assert( sz );            /* prevent infinite loop */
     427           0 :     assert( sz <= cur_sz );  /* prevent out of bounds */
     428             : 
     429           0 :     cur_ptr += sz;  cur_sz -= sz;
     430           0 :   }
     431           0 : }
     432             : 
     433             : /* LLVMFuzzerCustomMutator has the following behavior:
     434             : 
     435             :    - If the input is not encrypted, mutates the raw input, and produces
     436             :      an encrypted output
     437             :    - If the input is encrypted, mutates the decrypted input, and
     438             :      produces another encrypted output
     439             :    - If the input appears to be encrypted but fails to decrypt, mutates
     440             :      the raw encrypted input, and produces another output that will fail
     441             :      to decrypt. */
     442             : 
     443             : ulong
     444             : LLVMFuzzerCustomMutator( uchar * data,
     445             :                          ulong   data_sz,
     446             :                          ulong   max_sz,
     447           0 :                          uint    seed ) {
     448           0 :   int ok = decrypt_payload( data, data_sz );
     449           0 :   data_sz = LLVMFuzzerMutate( data, data_sz, max_sz );
     450           0 :   if( ok ) encrypt_payload( data, data_sz );
     451           0 :   (void)seed;
     452           0 :   return data_sz;
     453           0 : }
     454             : 
     455             : /* Find a strategy for custom crossover of decrypted packets */
     456             : 
     457             : #endif /* !FD_QUIC_DISABLE_CRYPTO */

Generated by: LCOV version 1.14