src/net/tls.c

   1 /*
   2  * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License as
   6  * published by the Free Software Foundation; either version 2 of the
   7  * License, or any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  */
  18
  19 /**
  20  * @file
  21  *
  22  * Transport Layer Security Protocol
  23  */
  24
  25 #include <stdint.h>
  26 #include <stdlib.h>
  27 #include <stdarg.h>
  28 #include <string.h>
  29 #include <errno.h>
  30 #include <byteswap.h>
  31 #include <gpxe/hmac.h>
  32 #include <gpxe/md5.h>
  33 #include <gpxe/sha1.h>
  34 #include <gpxe/aes.h>
  35 #include <gpxe/rsa.h>
  36 #include <gpxe/xfer.h>
  37 #include <gpxe/open.h>
  38 #include <gpxe/filter.h>
  39 #include <gpxe/tls.h>
  40
  41 static int tls_send_plaintext ( struct tls_session *tls, unsigned int type,
  42                                 const void *data, size_t len );
  43 static void tls_clear_cipher ( struct tls_session *tls,
  44                                struct tls_cipherspec *cipherspec );
  45
  46 /**
  47  * Free TLS session
  48  *
  49  * @v refcnt            Reference counter
  50  */
  51 static void free_tls ( struct refcnt *refcnt ) {
  52         struct tls_session *tls =
  53                 container_of ( refcnt, struct tls_session, refcnt );
  54
  55         /* Free dynamically-allocated resources */
  56         tls_clear_cipher ( tls, &tls->tx_cipherspec );
  57         tls_clear_cipher ( tls, &tls->tx_cipherspec_pending );
  58         tls_clear_cipher ( tls, &tls->rx_cipherspec );
  59         tls_clear_cipher ( tls, &tls->rx_cipherspec_pending );
  60         free ( tls->rsa_mod );
  61         free ( tls->rsa_pub_exp );
  62         free ( tls->rx_data );
  63
  64         /* Free TLS structure itself */
  65         free ( tls );
  66 }
  67
  68 /**
  69  * Finish with TLS session
  70  *
  71  * @v tls               TLS session
  72  * @v rc                Status code
  73  */
  74 static void tls_close ( struct tls_session *tls, int rc ) {
  75
  76         /* Remove process */
  77         process_del ( &tls->process );
  78
  79         /* Close ciphertext and plaintext streams */
  80         xfer_nullify ( &tls->cipherstream.xfer );
  81         xfer_close ( &tls->cipherstream.xfer, rc );
  82         xfer_nullify ( &tls->plainstream.xfer );
  83         xfer_close ( &tls->plainstream.xfer, rc );
  84 }
  85
  86 /******************************************************************************
  87  *
  88  * Random number generation
  89  *
  90  ******************************************************************************
  91  */
  92
  93 /**
  94  * Generate random data
  95  *
  96  * @v data              Buffer to fill
  97  * @v len               Length of buffer
  98  */
  99 static void tls_generate_random ( void *data, size_t len ) {
 100         /* FIXME: Some real random data source would be nice... */
 101         memset ( data, 0x01, len );
 102 }
 103
 104 /**
 105  * Update HMAC with a list of ( data, len ) pairs
 106  *
 107  * @v digest            Hash function to use
 108  * @v digest_ctx        Digest context
 109  * @v args              ( data, len ) pairs of data, terminated by NULL
 110  */
 111 static void tls_hmac_update_va ( struct crypto_algorithm *digest,
 112                                  void *digest_ctx, va_list args ) {
 113         void *data;
 114         size_t len;
 115
 116         while ( ( data = va_arg ( args, void * ) ) ) {
 117                 len = va_arg ( args, size_t );
 118                 hmac_update ( digest, digest_ctx, data, len );
 119         }
 120 }
 121
 122 /**
 123  * Generate secure pseudo-random data using a single hash function
 124  *
 125  * @v tls               TLS session
 126  * @v digest            Hash function to use
 127  * @v secret            Secret
 128  * @v secret_len        Length of secret
 129  * @v out               Output buffer
 130  * @v out_len           Length of output buffer
 131  * @v seeds             ( data, len ) pairs of seed data, terminated by NULL
 132  */
 133 static void tls_p_hash_va ( struct tls_session *tls,
 134                             struct crypto_algorithm *digest,
 135                             void *secret, size_t secret_len,
 136                             void *out, size_t out_len,
 137                             va_list seeds ) {
 138         uint8_t secret_copy[secret_len];
 139         uint8_t digest_ctx[digest->ctxsize];
 140         uint8_t digest_ctx_partial[digest->ctxsize];
 141         uint8_t a[digest->digestsize];
 142         uint8_t out_tmp[digest->digestsize];
 143         size_t frag_len = digest->digestsize;
 144         va_list tmp;
 145
 146         /* Copy the secret, in case HMAC modifies it */
 147         memcpy ( secret_copy, secret, secret_len );
 148         secret = secret_copy;
 149         DBGC2 ( tls, "TLS %p %s secret:\n", tls, digest->name );
 150         DBGC2_HD ( tls, secret, secret_len );
 151
 152         /* Calculate A(1) */
 153         hmac_init ( digest, digest_ctx, secret, &secret_len );
 154         va_copy ( tmp, seeds );
 155         tls_hmac_update_va ( digest, digest_ctx, tmp );
 156         va_end ( tmp );
 157         hmac_final ( digest, digest_ctx, secret, &secret_len, a );
 158         DBGC2 ( tls, "TLS %p %s A(1):\n", tls, digest->name );
 159         DBGC2_HD ( tls, &a, sizeof ( a ) );
 160
 161         /* Generate as much data as required */
 162         while ( out_len ) {
 163                 /* Calculate output portion */
 164                 hmac_init ( digest, digest_ctx, secret, &secret_len );
 165                 hmac_update ( digest, digest_ctx, a, sizeof ( a ) );
 166                 memcpy ( digest_ctx_partial, digest_ctx, digest->ctxsize );
 167                 va_copy ( tmp, seeds );
 168                 tls_hmac_update_va ( digest, digest_ctx, tmp );
 169                 va_end ( tmp );
 170                 hmac_final ( digest, digest_ctx,
 171                              secret, &secret_len, out_tmp );
 172
 173                 /* Copy output */
 174                 if ( frag_len > out_len )
 175                         frag_len = out_len;
 176                 memcpy ( out, out_tmp, frag_len );
 177                 DBGC2 ( tls, "TLS %p %s output:\n", tls, digest->name );
 178                 DBGC2_HD ( tls, out, frag_len );
 179
 180                 /* Calculate A(i) */
 181                 hmac_final ( digest, digest_ctx_partial,
 182                              secret, &secret_len, a );
 183                 DBGC2 ( tls, "TLS %p %s A(n):\n", tls, digest->name );
 184                 DBGC2_HD ( tls, &a, sizeof ( a ) );
 185
 186                 out += frag_len;
 187                 out_len -= frag_len;
 188         }
 189 }
 190
 191 /**
 192  * Generate secure pseudo-random data
 193  *
 194  * @v tls               TLS session
 195  * @v secret            Secret
 196  * @v secret_len        Length of secret
 197  * @v out               Output buffer
 198  * @v out_len           Length of output buffer
 199  * @v ...               ( data, len ) pairs of seed data, terminated by NULL
 200  */
 201 static void tls_prf ( struct tls_session *tls, void *secret, size_t secret_len,
 202                       void *out, size_t out_len, ... ) {
 203         va_list seeds;
 204         va_list tmp;
 205         size_t subsecret_len;
 206         void *md5_secret;
 207         void *sha1_secret;
 208         uint8_t out_md5[out_len];
 209         uint8_t out_sha1[out_len];
 210         unsigned int i;
 211
 212         va_start ( seeds, out_len );
 213
 214         /* Split secret into two, with an overlap of up to one byte */
 215         subsecret_len = ( ( secret_len + 1 ) / 2 );
 216         md5_secret = secret;
 217         sha1_secret = ( secret + secret_len - subsecret_len );
 218
 219         /* Calculate MD5 portion */
 220         va_copy ( tmp, seeds );
 221         tls_p_hash_va ( tls, &md5_algorithm, md5_secret, subsecret_len,
 222                         out_md5, out_len, seeds );
 223         va_end ( tmp );
 224
 225         /* Calculate SHA1 portion */
 226         va_copy ( tmp, seeds );
 227         tls_p_hash_va ( tls, &sha1_algorithm, sha1_secret, subsecret_len,
 228                         out_sha1, out_len, seeds );
 229         va_end ( tmp );
 230
 231         /* XOR the two portions together into the final output buffer */
 232         for ( i = 0 ; i < out_len ; i++ ) {
 233                 *( ( uint8_t * ) out + i ) = ( out_md5[i] ^ out_sha1[i] );
 234         }
 235
 236         va_end ( seeds );
 237 }
 238
 239 /**
 240  * Generate secure pseudo-random data
 241  *
 242  * @v secret            Secret
 243  * @v secret_len        Length of secret
 244  * @v out               Output buffer
 245  * @v out_len           Length of output buffer
 246  * @v label             String literal label
 247  * @v ...               ( data, len ) pairs of seed data
 248  */
 249 #define tls_prf_label( tls, secret, secret_len, out, out_len, label, ... ) \
 250         tls_prf ( (tls), (secret), (secret_len), (out), (out_len),         \
 251                   label, ( sizeof ( label ) - 1 ), __VA_ARGS__, NULL )
 252
 253 /******************************************************************************
 254  *
 255  * Secret management
 256  *
 257  ******************************************************************************
 258  */
 259
 260 /**
 261  * Generate master secret
 262  *
 263  * @v tls               TLS session
 264  *
 265  * The pre-master secret and the client and server random values must
 266  * already be known.
 267  */
 268 static void tls_generate_master_secret ( struct tls_session *tls ) {
 269         DBGC ( tls, "TLS %p pre-master-secret:\n", tls );
 270         DBGC_HD ( tls, &tls->pre_master_secret,
 271                   sizeof ( tls->pre_master_secret ) );
 272         DBGC ( tls, "TLS %p client random bytes:\n", tls );
 273         DBGC_HD ( tls, &tls->client_random, sizeof ( tls->server_random ) );
 274         DBGC ( tls, "TLS %p server random bytes:\n", tls );
 275         DBGC_HD ( tls, &tls->server_random, sizeof ( tls->server_random ) );
 276
 277         tls_prf_label ( tls, tls->pre_master_secret,
 278                         sizeof ( tls->pre_master_secret ),
 279                         tls->master_secret, sizeof ( tls->master_secret ),
 280                         "master secret",
 281                         tls->client_random, sizeof ( tls->client_random ),
 282                         tls->server_random, sizeof ( tls->server_random ) );
 283
 284         DBGC ( tls, "TLS %p generated master secret:\n", tls );
 285         DBGC_HD ( tls, &tls->master_secret, sizeof ( tls->master_secret ) );
 286 }
 287
 288 /**
 289  * Generate key material
 290  *
 291  * @v tls               TLS session
 292  *
 293  * The master secret must already be known.
 294  */
 295 static int tls_generate_keys ( struct tls_session *tls ) {
 296         struct tls_cipherspec *tx_cipherspec = &tls->tx_cipherspec_pending;
 297         struct tls_cipherspec *rx_cipherspec = &tls->rx_cipherspec_pending;
 298         size_t hash_size = tx_cipherspec->digest->digestsize;
 299         size_t key_size = tx_cipherspec->key_len;
 300         size_t iv_size = tx_cipherspec->cipher->blocksize;
 301         size_t total = ( 2 * ( hash_size + key_size + iv_size ) );
 302         uint8_t key_block[total];
 303         uint8_t *key;
 304         int rc;
 305
 306         /* Generate key block */
 307         tls_prf_label ( tls, tls->master_secret, sizeof ( tls->master_secret ),
 308                         key_block, sizeof ( key_block ), "key expansion",
 309                         tls->server_random, sizeof ( tls->server_random ),
 310                         tls->client_random, sizeof ( tls->client_random ) );
 311
 312         /* Split key block into portions */
 313         key = key_block;
 314
 315         /* TX MAC secret */
 316         memcpy ( tx_cipherspec->mac_secret, key, hash_size );
 317         DBGC ( tls, "TLS %p TX MAC secret:\n", tls );
 318         DBGC_HD ( tls, key, hash_size );
 319         key += hash_size;
 320
 321         /* RX MAC secret */
 322         memcpy ( rx_cipherspec->mac_secret, key, hash_size );
 323         DBGC ( tls, "TLS %p RX MAC secret:\n", tls );
 324         DBGC_HD ( tls, key, hash_size );
 325         key += hash_size;
 326
 327         /* TX key */
 328         if ( ( rc = cipher_setkey ( tx_cipherspec->cipher,
 329                                     tx_cipherspec->cipher_ctx,
 330                                     key, key_size ) ) != 0 ) {
 331                 DBGC ( tls, "TLS %p could not set TX key: %s\n",
 332                        tls, strerror ( rc ) );
 333                 return rc;
 334         }
 335         DBGC ( tls, "TLS %p TX key:\n", tls );
 336         DBGC_HD ( tls, key, key_size );
 337         key += key_size;
 338
 339         /* RX key */
 340         if ( ( rc = cipher_setkey ( rx_cipherspec->cipher,
 341                                     rx_cipherspec->cipher_ctx,
 342                                     key, key_size ) ) != 0 ) {
 343                 DBGC ( tls, "TLS %p could not set TX key: %s\n",
 344                        tls, strerror ( rc ) );
 345                 return rc;
 346         }
 347
 348         /* FIXME: AES needs to be fixed to not require this */
 349         AES_convert_key ( rx_cipherspec->cipher_ctx );
 350
 351         DBGC ( tls, "TLS %p RX key:\n", tls );
 352         DBGC_HD ( tls, key, key_size );
 353         key += key_size;
 354
 355         /* TX initialisation vector */
 356         cipher_setiv ( tx_cipherspec->cipher, tx_cipherspec->cipher_ctx, key );
 357         DBGC ( tls, "TLS %p TX IV:\n", tls );
 358         DBGC_HD ( tls, key, iv_size );
 359         key += iv_size;
 360
 361         /* RX initialisation vector */
 362         cipher_setiv ( rx_cipherspec->cipher, rx_cipherspec->cipher_ctx, key );
 363         DBGC ( tls, "TLS %p RX IV:\n", tls );
 364         DBGC_HD ( tls, key, iv_size );
 365         key += iv_size;
 366
 367         assert ( ( key_block + total ) == key );
 368
 369         return 0;
 370 }
 371
 372 /******************************************************************************
 373  *
 374  * Cipher suite management
 375  *
 376  ******************************************************************************
 377  */
 378
 379 /**
 380  * Clear cipher suite
 381  *
 382  * @v cipherspec        TLS cipher specification
 383  */
 384 static void tls_clear_cipher ( struct tls_session *tls __unused,
 385                                struct tls_cipherspec *cipherspec ) {
 386         free ( cipherspec->dynamic );
 387         memset ( cipherspec, 0, sizeof ( cipherspec ) );
 388         cipherspec->pubkey = &crypto_null;
 389         cipherspec->cipher = &crypto_null;
 390         cipherspec->digest = &crypto_null;
 391 }
 392
 393 /**
 394  * Set cipher suite
 395  *
 396  * @v tls               TLS session
 397  * @v cipherspec        TLS cipher specification
 398  * @v pubkey            Public-key encryption elgorithm
 399  * @v cipher            Bulk encryption cipher algorithm
 400  * @v digest            MAC digest algorithm
 401  * @v key_len           Key length
 402  * @ret rc              Return status code
 403  */
 404 static int tls_set_cipher ( struct tls_session *tls,
 405                             struct tls_cipherspec *cipherspec,
 406                             struct crypto_algorithm *pubkey,
 407                             struct crypto_algorithm *cipher,
 408                             struct crypto_algorithm *digest,
 409                             size_t key_len ) {
 410         size_t total;
 411         void *dynamic;
 412
 413         /* Clear out old cipher contents, if any */
 414         tls_clear_cipher ( tls, cipherspec );
 415
 416         /* Allocate dynamic storage */
 417         total = ( pubkey->ctxsize + 2 * cipher->ctxsize + digest->digestsize );
 418         dynamic = malloc ( total );
 419         if ( ! dynamic ) {
 420                 DBGC ( tls, "TLS %p could not allocate %zd bytes for crypto "
 421                        "context\n", tls, total );
 422                 return -ENOMEM;
 423         }
 424         memset ( dynamic, 0, total );
 425
 426         /* Assign storage */
 427         cipherspec->dynamic = dynamic;
 428         cipherspec->pubkey_ctx = dynamic;       dynamic += pubkey->ctxsize;
 429         cipherspec->cipher_ctx = dynamic;       dynamic += cipher->ctxsize;
 430         cipherspec->cipher_next_ctx = dynamic;  dynamic += cipher->ctxsize;
 431         cipherspec->mac_secret = dynamic;       dynamic += digest->digestsize;
 432         assert ( ( cipherspec->dynamic + total ) == dynamic );
 433
 434         /* Store parameters */
 435         cipherspec->pubkey = pubkey;
 436         cipherspec->cipher = cipher;
 437         cipherspec->digest = digest;
 438         cipherspec->key_len = key_len;
 439
 440         return 0;
 441 }
 442
 443 /**
 444  * Select next cipher suite
 445  *
 446  * @v tls               TLS session
 447  * @v cipher_suite      Cipher suite specification
 448  * @ret rc              Return status code
 449  */
 450 static int tls_select_cipher ( struct tls_session *tls,
 451                                unsigned int cipher_suite ) {
 452         struct crypto_algorithm *pubkey = &crypto_null;
 453         struct crypto_algorithm *cipher = &crypto_null;
 454         struct crypto_algorithm *digest = &crypto_null;
 455         size_t key_len = 0;
 456         int rc;
 457
 458         switch ( cipher_suite ) {
 459         case htons ( TLS_RSA_WITH_AES_128_CBC_SHA ):
 460                 key_len = ( 128 / 8 );
 461                 cipher = &aes_algorithm;
 462                 digest = &sha1_algorithm;
 463                 break;
 464         case htons ( TLS_RSA_WITH_AES_256_CBC_SHA ):
 465                 key_len = ( 256 / 8 );
 466                 cipher = &aes_algorithm;
 467                 digest = &sha1_algorithm;
 468                 break;
 469         default:
 470                 DBGC ( tls, "TLS %p does not support cipher %04x\n",
 471                        tls, ntohs ( cipher_suite ) );
 472                 return -ENOTSUP;
 473         }
 474
 475         /* Set ciphers */
 476         if ( ( rc = tls_set_cipher ( tls, &tls->tx_cipherspec_pending, pubkey,
 477                                      cipher, digest, key_len ) ) != 0 )
 478                 return rc;
 479         if ( ( rc = tls_set_cipher ( tls, &tls->rx_cipherspec_pending, pubkey,
 480                                      cipher, digest, key_len ) ) != 0 )
 481                 return rc;
 482
 483         DBGC ( tls, "TLS %p selected %s-%s-%d-%s\n", tls,
 484                pubkey->name, cipher->name, ( key_len * 8 ), digest->name );
 485
 486         return 0;
 487 }
 488
 489 /**
 490  * Activate next cipher suite
 491  *
 492  * @v tls               TLS session
 493  * @v pending           Pending cipher specification
 494  * @v active            Active cipher specification to replace
 495  * @ret rc              Return status code
 496  */
 497 static int tls_change_cipher ( struct tls_session *tls,
 498                                struct tls_cipherspec *pending,
 499                                struct tls_cipherspec *active ) {
 500
 501         /* Sanity check */
 502         if ( /* FIXME (when pubkey is not hard-coded to RSA):
 503               * ( pending->pubkey == &crypto_null ) || */
 504              ( pending->cipher == &crypto_null ) ||
 505              ( pending->digest == &crypto_null ) ) {
 506                 DBGC ( tls, "TLS %p refusing to use null cipher\n", tls );
 507                 return -ENOTSUP;
 508         }
 509
 510         tls_clear_cipher ( tls, active );
 511         memswap ( active, pending, sizeof ( *active ) );
 512         return 0;
 513 }
 514
 515 /******************************************************************************
 516  *
 517  * Handshake verification
 518  *
 519  ******************************************************************************
 520  */
 521
 522 /**
 523  * Add handshake record to verification hash
 524  *
 525  * @v tls               TLS session
 526  * @v data              Handshake record
 527  * @v len               Length of handshake record
 528  */
 529 static void tls_add_handshake ( struct tls_session *tls,
 530                                 const void *data, size_t len ) {
 531
 532         digest_update ( &md5_algorithm, tls->handshake_md5_ctx, data, len );
 533         digest_update ( &sha1_algorithm, tls->handshake_sha1_ctx, data, len );
 534 }
 535
 536 /**
 537  * Calculate handshake verification hash
 538  *
 539  * @v tls               TLS session
 540  * @v out               Output buffer
 541  *
 542  * Calculates the MD5+SHA1 digest over all handshake messages seen so
 543  * far.
 544  */
 545 static void tls_verify_handshake ( struct tls_session *tls, void *out ) {
 546         struct crypto_algorithm *md5 = &md5_algorithm;
 547         struct crypto_algorithm *sha1 = &sha1_algorithm;
 548         uint8_t md5_ctx[md5->ctxsize];
 549         uint8_t sha1_ctx[sha1->ctxsize];
 550         void *md5_digest = out;
 551         void *sha1_digest = ( out + md5->digestsize );
 552
 553         memcpy ( md5_ctx, tls->handshake_md5_ctx, sizeof ( md5_ctx ) );
 554         memcpy ( sha1_ctx, tls->handshake_sha1_ctx, sizeof ( sha1_ctx ) );
 555         digest_final ( md5, md5_ctx, md5_digest );
 556         digest_final ( sha1, sha1_ctx, sha1_digest );
 557 }
 558
 559 /******************************************************************************
 560  *
 561  * Record handling
 562  *
 563  ******************************************************************************
 564  */
 565
 566 /**
 567  * Transmit Handshake record
 568  *
 569  * @v tls               TLS session
 570  * @v data              Plaintext record
 571  * @v len               Length of plaintext record
 572  * @ret rc              Return status code
 573  */
 574 static int tls_send_handshake ( struct tls_session *tls,
 575                                 void *data, size_t len ) {
 576
 577         /* Add to handshake digest */
 578         tls_add_handshake ( tls, data, len );
 579
 580         /* Send record */
 581         return tls_send_plaintext ( tls, TLS_TYPE_HANDSHAKE, data, len );
 582 }
 583
 584 /**
 585  * Transmit Client Hello record
 586  *
 587  * @v tls               TLS session
 588  * @ret rc              Return status code
 589  */
 590 static int tls_send_client_hello ( struct tls_session *tls ) {
 591         struct {
 592                 uint32_t type_length;
 593                 uint16_t version;
 594                 uint8_t random[32];
 595                 uint8_t session_id_len;
 596                 uint16_t cipher_suite_len;
 597                 uint16_t cipher_suites[2];
 598                 uint8_t compression_methods_len;
 599                 uint8_t compression_methods[1];
 600         } __attribute__ (( packed )) hello;
 601
 602         memset ( &hello, 0, sizeof ( hello ) );
 603         hello.type_length = ( cpu_to_le32 ( TLS_CLIENT_HELLO ) |
 604                               htonl ( sizeof ( hello ) -
 605                                       sizeof ( hello.type_length ) ) );
 606         hello.version = htons ( TLS_VERSION_TLS_1_0 );
 607         memcpy ( &hello.random, tls->client_random, sizeof ( hello.random ) );
 608         hello.cipher_suite_len = htons ( sizeof ( hello.cipher_suites ) );
 609         hello.cipher_suites[0] = htons ( TLS_RSA_WITH_AES_128_CBC_SHA );
 610         hello.cipher_suites[1] = htons ( TLS_RSA_WITH_AES_256_CBC_SHA );
 611         hello.compression_methods_len = sizeof ( hello.compression_methods );
 612
 613         return tls_send_handshake ( tls, &hello, sizeof ( hello ) );
 614 }
 615
 616 /**
 617  * Transmit Client Key Exchange record
 618  *
 619  * @v tls               TLS session
 620  * @ret rc              Return status code
 621  */
 622 static int tls_send_client_key_exchange ( struct tls_session *tls ) {
 623         /* FIXME: Hack alert */
 624         RSA_CTX *rsa_ctx;
 625         RSA_pub_key_new ( &rsa_ctx, tls->rsa_mod, tls->rsa_mod_len,
 626                           tls->rsa_pub_exp, tls->rsa_pub_exp_len );
 627         struct {
 628                 uint32_t type_length;
 629                 uint16_t encrypted_pre_master_secret_len;
 630                 uint8_t encrypted_pre_master_secret[rsa_ctx->num_octets];
 631         } __attribute__ (( packed )) key_xchg;
 632
 633         memset ( &key_xchg, 0, sizeof ( key_xchg ) );
 634         key_xchg.type_length = ( cpu_to_le32 ( TLS_CLIENT_KEY_EXCHANGE ) |
 635                                  htonl ( sizeof ( key_xchg ) -
 636                                          sizeof ( key_xchg.type_length ) ) );
 637         key_xchg.encrypted_pre_master_secret_len
 638                 = htons ( sizeof ( key_xchg.encrypted_pre_master_secret ) );
 639
 640         /* FIXME: Hack alert */
 641         DBGC ( tls, "RSA encrypting plaintext, modulus, exponent:\n" );
 642         DBGC_HD ( tls, &tls->pre_master_secret,
 643                   sizeof ( tls->pre_master_secret ) );
 644         DBGC_HD ( tls, tls->rsa_mod, tls->rsa_mod_len );
 645         DBGC_HD ( tls, tls->rsa_pub_exp, tls->rsa_pub_exp_len );
 646         RSA_encrypt ( rsa_ctx, tls->pre_master_secret,
 647                       sizeof ( tls->pre_master_secret ),
 648                       key_xchg.encrypted_pre_master_secret, 0 );
 649         DBGC ( tls, "RSA encrypt done.  Ciphertext:\n" );
 650         DBGC_HD ( tls, &key_xchg.encrypted_pre_master_secret,
 651                   sizeof ( key_xchg.encrypted_pre_master_secret ) );
 652         RSA_free ( rsa_ctx );
 653
 654
 655         return tls_send_handshake ( tls, &key_xchg, sizeof ( key_xchg ) );
 656 }
 657
 658 /**
 659  * Transmit Change Cipher record
 660  *
 661  * @v tls               TLS session
 662  * @ret rc              Return status code
 663  */
 664 static int tls_send_change_cipher ( struct tls_session *tls ) {
 665         static const uint8_t change_cipher[1] = { 1 };
 666         return tls_send_plaintext ( tls, TLS_TYPE_CHANGE_CIPHER,
 667                                     change_cipher, sizeof ( change_cipher ) );
 668 }
 669
 670 /**
 671  * Transmit Finished record
 672  *
 673  * @v tls               TLS session
 674  * @ret rc              Return status code
 675  */
 676 static int tls_send_finished ( struct tls_session *tls ) {
 677         struct {
 678                 uint32_t type_length;
 679                 uint8_t verify_data[12];
 680         } __attribute__ (( packed )) finished;
 681         uint8_t digest[MD5_DIGEST_SIZE + SHA1_DIGEST_SIZE];
 682
 683         memset ( &finished, 0, sizeof ( finished ) );
 684         finished.type_length = ( cpu_to_le32 ( TLS_FINISHED ) |
 685                                  htonl ( sizeof ( finished ) -
 686                                          sizeof ( finished.type_length ) ) );
 687         tls_verify_handshake ( tls, digest );
 688         tls_prf_label ( tls, tls->master_secret, sizeof ( tls->master_secret ),
 689                         finished.verify_data, sizeof ( finished.verify_data ),
 690                         "client finished", digest, sizeof ( digest ) );
 691
 692         return tls_send_handshake ( tls, &finished, sizeof ( finished ) );
 693 }
 694
 695 /**
 696  * Receive new Change Cipher record
 697  *
 698  * @v tls               TLS session
 699  * @v data              Plaintext record
 700  * @v len               Length of plaintext record
 701  * @ret rc              Return status code
 702  */
 703 static int tls_new_change_cipher ( struct tls_session *tls,
 704                                    void *data, size_t len ) {
 705         int rc;
 706
 707         if ( ( len != 1 ) || ( *( ( uint8_t * ) data ) != 1 ) ) {
 708                 DBGC ( tls, "TLS %p received invalid Change Cipher\n", tls );
 709                 DBGC_HD ( tls, data, len );
 710                 return -EINVAL;
 711         }
 712
 713         if ( ( rc = tls_change_cipher ( tls, &tls->rx_cipherspec_pending,
 714                                         &tls->rx_cipherspec ) ) != 0 ) {
 715                 DBGC ( tls, "TLS %p could not activate RX cipher: %s\n",
 716                        tls, strerror ( rc ) );
 717                 return rc;
 718         }
 719         tls->rx_seq = ~( ( uint64_t ) 0 );
 720
 721         return 0;
 722 }
 723
 724 /**
 725  * Receive new Alert record
 726  *
 727  * @v tls               TLS session
 728  * @v data              Plaintext record
 729  * @v len               Length of plaintext record
 730  * @ret rc              Return status code
 731  */
 732 static int tls_new_alert ( struct tls_session *tls, void *data, size_t len ) {
 733         struct {
 734                 uint8_t level;
 735                 uint8_t description;
 736                 char next[0];
 737         } __attribute__ (( packed )) *alert = data;
 738         void *end = alert->next;
 739
 740         /* Sanity check */
 741         if ( end != ( data + len ) ) {
 742                 DBGC ( tls, "TLS %p received overlength Alert\n", tls );
 743                 DBGC_HD ( tls, data, len );
 744                 return -EINVAL;
 745         }
 746
 747         switch ( alert->level ) {
 748         case TLS_ALERT_WARNING:
 749                 DBGC ( tls, "TLS %p received warning alert %d\n",
 750                        tls, alert->description );
 751                 return 0;
 752         case TLS_ALERT_FATAL:
 753                 DBGC ( tls, "TLS %p received fatal alert %d\n",
 754                        tls, alert->description );
 755                 return -EPERM;
 756         default:
 757                 DBGC ( tls, "TLS %p received unknown alert level %d"
 758                        "(alert %d)\n", tls, alert->level, alert->description );
 759                 return -EIO;
 760         }
 761 }
 762
 763 /**
 764  * Receive new Server Hello record
 765  *
 766  * @v tls               TLS session
 767  * @v data              Plaintext record
 768  * @v len               Length of plaintext record
 769  * @ret rc              Return status code
 770  */
 771 static int tls_new_server_hello ( struct tls_session *tls,
 772                                   void *data, size_t len ) {
 773         struct {
 774                 uint32_t type_length;
 775                 uint16_t version;
 776                 uint8_t random[32];
 777                 uint8_t session_id_len;
 778                 char next[0];
 779         } __attribute__ (( packed )) *hello_a = data;
 780         struct {
 781                 uint8_t session_id[hello_a->session_id_len];
 782                 uint16_t cipher_suite;
 783                 uint8_t compression_method;
 784                 char next[0];
 785         } __attribute__ (( packed )) *hello_b = ( void * ) &hello_a->next;
 786         void *end = hello_b->next;
 787         int rc;
 788
 789         /* Sanity check */
 790         if ( end != ( data + len ) ) {
 791                 DBGC ( tls, "TLS %p received overlength Server Hello\n", tls );
 792                 DBGC_HD ( tls, data, len );
 793                 return -EINVAL;
 794         }
 795
 796         /* Check protocol version */
 797         if ( ntohs ( hello_a->version ) < TLS_VERSION_TLS_1_0 ) {
 798                 DBGC ( tls, "TLS %p does not support protocol version %d.%d\n",
 799                        tls, ( ntohs ( hello_a->version ) >> 8 ),
 800                        ( ntohs ( hello_a->version ) & 0xff ) );
 801                 return -ENOTSUP;
 802         }
 803
 804         /* Copy out server random bytes */
 805         memcpy ( tls->server_random, hello_a->random,
 806                  sizeof ( tls->server_random ) );
 807
 808         /* Select cipher suite */
 809         if ( ( rc = tls_select_cipher ( tls, hello_b->cipher_suite ) ) != 0 )
 810                 return rc;
 811
 812         /* Generate secrets */
 813         tls_generate_master_secret ( tls );
 814         if ( ( rc = tls_generate_keys ( tls ) ) != 0 )
 815                 return rc;
 816
 817         return 0;
 818 }
 819
 820 /**
 821  * Receive new Certificate record
 822  *
 823  * @v tls               TLS session
 824  * @v data              Plaintext record
 825  * @v len               Length of plaintext record
 826  * @ret rc              Return status code
 827  */
 828 static int tls_new_certificate ( struct tls_session *tls,
 829                                  void *data, size_t len ) {
 830         struct {
 831                 uint32_t type_length;
 832                 uint8_t length[3];
 833                 uint8_t first_cert_length[3];
 834                 uint8_t asn1_start[0];
 835         } __attribute__ (( packed )) *certificate = data;
 836         uint8_t *cert = certificate->asn1_start;
 837         int offset = 0;
 838
 839         /* FIXME */
 840         (void) len;
 841
 842         if (asn1_next_obj(cert, &offset, ASN1_SEQUENCE) < 0 ||
 843             asn1_next_obj(cert, &offset, ASN1_SEQUENCE) < 0 ||
 844             asn1_skip_obj(cert, &offset, ASN1_EXPLICIT_TAG) ||
 845             asn1_skip_obj(cert, &offset, ASN1_INTEGER) ||
 846             asn1_skip_obj(cert, &offset, ASN1_SEQUENCE) ||
 847             asn1_skip_obj(cert, &offset, ASN1_SEQUENCE) ||
 848             asn1_skip_obj(cert, &offset, ASN1_SEQUENCE) ||
 849             asn1_skip_obj(cert, &offset, ASN1_SEQUENCE) ||
 850             asn1_next_obj(cert, &offset, ASN1_SEQUENCE) < 0 ||
 851             asn1_skip_obj(cert, &offset, ASN1_SEQUENCE) ||
 852             asn1_next_obj(cert, &offset, ASN1_BIT_STRING) < 0) {
 853                 DBGC ( tls, "TLS %p invalid certificate\n", tls );
 854                 DBGC_HD ( tls, cert + offset, 64 );
 855                 return -EPERM;
 856         }
 857
 858         offset++;
 859
 860         if (asn1_next_obj(cert, &offset, ASN1_SEQUENCE) < 0) {
 861                 DBGC ( tls, "TLS %p invalid certificate\n", tls );
 862                 DBGC_HD ( tls, cert + offset, 64 );
 863                 return -EPERM;
 864         }
 865
 866         tls->rsa_mod_len = asn1_get_int(cert, &offset, &tls->rsa_mod);
 867         tls->rsa_pub_exp_len = asn1_get_int(cert, &offset, &tls->rsa_pub_exp);
 868
 869         DBGC_HD ( tls, tls->rsa_mod, tls->rsa_mod_len );
 870         DBGC_HD ( tls, tls->rsa_pub_exp, tls->rsa_pub_exp_len );
 871
 872         return 0;
 873 }
 874
 875 /**
 876  * Receive new Server Hello Done record
 877  *
 878  * @v tls               TLS session
 879  * @v data              Plaintext record
 880  * @v len               Length of plaintext record
 881  * @ret rc              Return status code
 882  */
 883 static int tls_new_server_hello_done ( struct tls_session *tls,
 884                                        void *data, size_t len ) {
 885         struct {
 886                 uint32_t type_length;
 887                 char next[0];
 888         } __attribute__ (( packed )) *hello_done = data;
 889         void *end = hello_done->next;
 890
 891         /* Sanity check */
 892         if ( end != ( data + len ) ) {
 893                 DBGC ( tls, "TLS %p received overlength Server Hello Done\n",
 894                        tls );
 895                 DBGC_HD ( tls, data, len );
 896                 return -EINVAL;
 897         }
 898
 899         /* Check that we are ready to send the Client Key Exchange */
 900         if ( tls->tx_state != TLS_TX_NONE ) {
 901                 DBGC ( tls, "TLS %p received Server Hello Done while in "
 902                        "TX state %d\n", tls, tls->tx_state );
 903                 return -EIO;
 904         }
 905
 906         /* Start sending the Client Key Exchange */
 907         tls->tx_state = TLS_TX_CLIENT_KEY_EXCHANGE;
 908
 909         return 0;
 910 }
 911
 912 /**
 913  * Receive new Finished record
 914  *
 915  * @v tls               TLS session
 916  * @v data              Plaintext record
 917  * @v len               Length of plaintext record
 918  * @ret rc              Return status code
 919  */
 920 static int tls_new_finished ( struct tls_session *tls,
 921                               void *data, size_t len ) {
 922
 923         /* FIXME: Handle this properly */
 924         tls->tx_state = TLS_TX_DATA;
 925         ( void ) data;
 926         ( void ) len;
 927         return 0;
 928 }
 929
 930 /**
 931  * Receive new Handshake record
 932  *
 933  * @v tls               TLS session
 934  * @v data              Plaintext record
 935  * @v len               Length of plaintext record
 936  * @ret rc              Return status code
 937  */
 938 static int tls_new_handshake ( struct tls_session *tls,
 939                                void *data, size_t len ) {
 940         uint8_t *type = data;
 941         int rc;
 942
 943         switch ( *type ) {
 944         case TLS_SERVER_HELLO:
 945                 rc = tls_new_server_hello ( tls, data, len );
 946                 break;
 947         case TLS_CERTIFICATE:
 948                 rc = tls_new_certificate ( tls, data, len );
 949                 break;
 950         case TLS_SERVER_HELLO_DONE:
 951                 rc = tls_new_server_hello_done ( tls, data, len );
 952                 break;
 953         case TLS_FINISHED:
 954                 rc = tls_new_finished ( tls, data, len );
 955                 break;
 956         default:
 957                 DBGC ( tls, "TLS %p ignoring handshake type %d\n",
 958                        tls, *type );
 959                 rc = 0;
 960                 break;
 961         }
 962
 963         /* Add to handshake digest (except for Hello Requests, which
 964          * are explicitly excludede).
 965          */
 966         if ( *type != TLS_HELLO_REQUEST )
 967                 tls_add_handshake ( tls, data, len );
 968
 969         return rc;
 970 }
 971
 972 /**
 973  * Receive new record
 974  *
 975  * @v tls               TLS session
 976  * @v type              Record type
 977  * @v data              Plaintext record
 978  * @v len               Length of plaintext record
 979  * @ret rc              Return status code
 980  */
 981 static int tls_new_record ( struct tls_session *tls,
 982                             unsigned int type, void *data, size_t len ) {
 983
 984         switch ( type ) {
 985         case TLS_TYPE_CHANGE_CIPHER:
 986                 return tls_new_change_cipher ( tls, data, len );
 987         case TLS_TYPE_ALERT:
 988                 return tls_new_alert ( tls, data, len );
 989         case TLS_TYPE_HANDSHAKE:
 990                 return tls_new_handshake ( tls, data, len );
 991         case TLS_TYPE_DATA:
 992                 return xfer_deliver_raw ( &tls->plainstream.xfer, data, len );
 993         default:
 994                 /* RFC4346 says that we should just ignore unknown
 995                  * record types.
 996                  */
 997                 DBGC ( tls, "TLS %p ignoring record type %d\n", tls, type );
 998                 return 0;
 999         }
1000 }
1001
1002 /******************************************************************************
1003  *
1004  * Record encryption/decryption
1005  *
1006  ******************************************************************************
1007  */
1008
1009 /**
1010  * Calculate HMAC
1011  *
1012  * @v tls               TLS session
1013  * @v cipherspec        Cipher specification
1014  * @v seq               Sequence number
1015  * @v tlshdr            TLS header
1016  * @v data              Data
1017  * @v len               Length of data
1018  * @v mac               HMAC to fill in
1019  */
1020 static void tls_hmac ( struct tls_session *tls __unused,
1021                        struct tls_cipherspec *cipherspec,
1022                        uint64_t seq, struct tls_header *tlshdr,
1023                        const void *data, size_t len, void *hmac ) {
1024         struct crypto_algorithm *digest = cipherspec->digest;
1025         uint8_t digest_ctx[digest->ctxsize];
1026
1027         hmac_init ( digest, digest_ctx, cipherspec->mac_secret,
1028                     &digest->digestsize );
1029         seq = cpu_to_be64 ( seq );
1030         hmac_update ( digest, digest_ctx, &seq, sizeof ( seq ) );
1031         hmac_update ( digest, digest_ctx, tlshdr, sizeof ( *tlshdr ) );
1032         hmac_update ( digest, digest_ctx, data, len );
1033         hmac_final ( digest, digest_ctx, cipherspec->mac_secret,
1034                      &digest->digestsize, hmac );
1035 }
1036
1037 /**
1038  * Allocate and assemble stream-ciphered record from data and MAC portions
1039  *
1040  * @v tls               TLS session
1041  * @ret data            Data
1042  * @ret len             Length of data
1043  * @ret digest          MAC digest
1044  * @ret plaintext_len   Length of plaintext record
1045  * @ret plaintext       Allocated plaintext record
1046  */
1047 static void * tls_assemble_stream ( struct tls_session *tls,
1048                                     const void *data, size_t len,
1049                                     void *digest, size_t *plaintext_len ) {
1050         size_t mac_len = tls->tx_cipherspec.digest->digestsize;
1051         void *plaintext;
1052         void *content;
1053         void *mac;
1054
1055         /* Calculate stream-ciphered struct length */
1056         *plaintext_len = ( len + mac_len );
1057
1058         /* Allocate stream-ciphered struct */
1059         plaintext = malloc ( *plaintext_len );
1060         if ( ! plaintext )
1061                 return NULL;
1062         content = plaintext;
1063         mac = ( content + len );
1064
1065         /* Fill in stream-ciphered struct */
1066         memcpy ( content, data, len );
1067         memcpy ( mac, digest, mac_len );
1068
1069         return plaintext;
1070 }
1071
1072 /**
1073  * Allocate and assemble block-ciphered record from data and MAC portions
1074  *
1075  * @v tls               TLS session
1076  * @ret data            Data
1077  * @ret len             Length of data
1078  * @ret digest          MAC digest
1079  * @ret plaintext_len   Length of plaintext record
1080  * @ret plaintext       Allocated plaintext record
1081  */
1082 static void * tls_assemble_block ( struct tls_session *tls,
1083                                    const void *data, size_t len,
1084                                    void *digest, size_t *plaintext_len ) {
1085         size_t blocksize = tls->tx_cipherspec.cipher->blocksize;
1086         size_t iv_len = blocksize;
1087         size_t mac_len = tls->tx_cipherspec.digest->digestsize;
1088         size_t padding_len;
1089         void *plaintext;
1090         void *iv;
1091         void *content;
1092         void *mac;
1093         void *padding;
1094
1095         /* FIXME: TLSv1.1 has an explicit IV */
1096         iv_len = 0;
1097
1098         /* Calculate block-ciphered struct length */
1099         padding_len = ( ( blocksize - 1 ) & -( iv_len + len + mac_len + 1 ) );
1100         *plaintext_len = ( iv_len + len + mac_len + padding_len + 1 );
1101
1102         /* Allocate block-ciphered struct */
1103         plaintext = malloc ( *plaintext_len );
1104         if ( ! plaintext )
1105                 return NULL;
1106         iv = plaintext;
1107         content = ( iv + iv_len );
1108         mac = ( content + len );
1109         padding = ( mac + mac_len );
1110
1111         /* Fill in block-ciphered struct */
1112         memset ( iv, 0, iv_len );
1113         memcpy ( content, data, len );
1114         memcpy ( mac, digest, mac_len );
1115         memset ( padding, padding_len, ( padding_len + 1 ) );
1116
1117         return plaintext;
1118 }
1119
1120 /**
1121  * Send plaintext record
1122  *
1123  * @v tls               TLS session
1124  * @v type              Record type
1125  * @v data              Plaintext record
1126  * @v len               Length of plaintext record
1127  * @ret rc              Return status code
1128  */
1129 static int tls_send_plaintext ( struct tls_session *tls, unsigned int type,
1130                                 const void *data, size_t len ) {
1131         struct tls_header plaintext_tlshdr;
1132         struct tls_header *tlshdr;
1133         struct tls_cipherspec *cipherspec = &tls->tx_cipherspec;
1134         void *plaintext = NULL;
1135         size_t plaintext_len;
1136         struct io_buffer *ciphertext = NULL;
1137         size_t ciphertext_len;
1138         size_t mac_len = cipherspec->digest->digestsize;
1139         uint8_t mac[mac_len];
1140         int rc;
1141
1142         /* Construct header */
1143         plaintext_tlshdr.type = type;
1144         plaintext_tlshdr.version = htons ( TLS_VERSION_TLS_1_0 );
1145         plaintext_tlshdr.length = htons ( len );
1146
1147         /* Calculate MAC */
1148         tls_hmac ( tls, cipherspec, tls->tx_seq, &plaintext_tlshdr,
1149                    data, len, mac );
1150
1151         /* Allocate and assemble plaintext struct */
1152         if ( is_stream_cipher ( cipherspec->cipher ) ) {
1153                 plaintext = tls_assemble_stream ( tls, data, len, mac,
1154                                                   &plaintext_len );
1155         } else {
1156                 plaintext = tls_assemble_block ( tls, data, len, mac,
1157                                                  &plaintext_len );
1158         }
1159         if ( ! plaintext ) {
1160                 DBGC ( tls, "TLS %p could not allocate %zd bytes for "
1161                        "plaintext\n", tls, plaintext_len );
1162                 rc = -ENOMEM;
1163                 goto done;
1164         }
1165
1166         DBGC2 ( tls, "Sending plaintext data:\n" );
1167         DBGC2_HD ( tls, plaintext, plaintext_len );
1168
1169         /* Allocate ciphertext */
1170         ciphertext_len = ( sizeof ( *tlshdr ) + plaintext_len );
1171         ciphertext = xfer_alloc_iob ( &tls->cipherstream.xfer,
1172                                       ciphertext_len );
1173         if ( ! ciphertext ) {
1174                 DBGC ( tls, "TLS %p could not allocate %zd bytes for "
1175                        "ciphertext\n", tls, ciphertext_len );
1176                 rc = -ENOMEM;
1177                 goto done;
1178         }
1179
1180         /* Assemble ciphertext */
1181         tlshdr = iob_put ( ciphertext, sizeof ( *tlshdr ) );
1182         tlshdr->type = type;
1183         tlshdr->version = htons ( TLS_VERSION_TLS_1_0 );
1184         tlshdr->length = htons ( plaintext_len );
1185         memcpy ( cipherspec->cipher_next_ctx, cipherspec->cipher_ctx,
1186                  cipherspec->cipher->ctxsize );
1187         if ( ( rc = cipher_encrypt ( cipherspec->cipher,
1188                                      cipherspec->cipher_next_ctx, plaintext,
1189                                      iob_put ( ciphertext, plaintext_len ),
1190                                      plaintext_len ) ) != 0 ) {
1191                 DBGC ( tls, "TLS %p could not encrypt: %s\n",
1192                        tls, strerror ( rc ) );
1193                 DBGC_HD ( tls, plaintext, plaintext_len );
1194                 goto done;
1195         }
1196
1197         /* Free plaintext as soon as possible to conserve memory */
1198         free ( plaintext );
1199         plaintext = NULL;
1200
1201         /* Send ciphertext */
1202         rc = xfer_deliver_iob ( &tls->cipherstream.xfer, ciphertext );
1203         ciphertext = NULL;
1204         if ( rc != 0 ) {
1205                 DBGC ( tls, "TLS %p could not deliver ciphertext: %s\n",
1206                        tls, strerror ( rc ) );
1207                 goto done;
1208         }
1209
1210         /* Update TX state machine to next record */
1211         tls->tx_seq += 1;
1212         memcpy ( tls->tx_cipherspec.cipher_ctx,
1213                  tls->tx_cipherspec.cipher_next_ctx,
1214                  tls->tx_cipherspec.cipher->ctxsize );
1215
1216  done:
1217         free ( plaintext );
1218         free_iob ( ciphertext );
1219         return rc;
1220 }
1221
1222 /**
1223  * Split stream-ciphered record into data and MAC portions
1224  *
1225  * @v tls               TLS session
1226  * @v plaintext         Plaintext record
1227  * @v plaintext_len     Length of record
1228  * @ret data            Data
1229  * @ret len             Length of data
1230  * @ret digest          MAC digest
1231  * @ret rc              Return status code
1232  */
1233 static int tls_split_stream ( struct tls_session *tls,
1234                               void *plaintext, size_t plaintext_len,
1235                               void **data, size_t *len, void **digest ) {
1236         void *content;
1237         size_t content_len;
1238         void *mac;
1239         size_t mac_len;
1240
1241         /* Decompose stream-ciphered data */
1242         mac_len = tls->rx_cipherspec.digest->digestsize;
1243         if ( plaintext_len < mac_len ) {
1244                 DBGC ( tls, "TLS %p received underlength record\n", tls );
1245                 DBGC_HD ( tls, plaintext, plaintext_len );
1246                 return -EINVAL;
1247         }
1248         content_len = ( plaintext_len - mac_len );
1249         content = plaintext;
1250         mac = ( content + content_len );
1251
1252         /* Fill in return values */
1253         *data = content;
1254         *len = content_len;
1255         *digest = mac;
1256
1257         return 0;
1258 }
1259
1260 /**
1261  * Split block-ciphered record into data and MAC portions
1262  *
1263  * @v tls               TLS session
1264  * @v plaintext         Plaintext record
1265  * @v plaintext_len     Length of record
1266  * @ret data            Data
1267  * @ret len             Length of data
1268  * @ret digest          MAC digest
1269  * @ret rc              Return status code
1270  */
1271 static int tls_split_block ( struct tls_session *tls,
1272                              void *plaintext, size_t plaintext_len,
1273                              void **data, size_t *len,
1274                              void **digest ) {
1275         void *iv;
1276         size_t iv_len;
1277         void *content;
1278         size_t content_len;
1279         void *mac;
1280         size_t mac_len;
1281         void *padding;
1282         size_t padding_len;
1283         unsigned int i;
1284
1285         /* Decompose block-ciphered data */
1286         if ( plaintext_len < 1 ) {
1287                 DBGC ( tls, "TLS %p received underlength record\n", tls );
1288                 DBGC_HD ( tls, plaintext, plaintext_len );
1289                 return -EINVAL;
1290         }
1291         iv_len = tls->rx_cipherspec.cipher->blocksize;
1292
1293         /* FIXME: TLSv1.1 uses an explicit IV */
1294         iv_len = 0;
1295
1296         mac_len = tls->rx_cipherspec.digest->digestsize;
1297         padding_len = *( ( uint8_t * ) ( plaintext + plaintext_len - 1 ) );
1298         if ( plaintext_len < ( iv_len + mac_len + padding_len + 1 ) ) {
1299                 DBGC ( tls, "TLS %p received underlength record\n", tls );
1300                 DBGC_HD ( tls, plaintext, plaintext_len );
1301                 return -EINVAL;
1302         }
1303         content_len = ( plaintext_len - iv_len - mac_len - padding_len - 1 );
1304         iv = plaintext;
1305         content = ( iv + iv_len );
1306         mac = ( content + content_len );
1307         padding = ( mac + mac_len );
1308
1309         /* Verify padding bytes */
1310         for ( i = 0 ; i < padding_len ; i++ ) {
1311                 if ( *( ( uint8_t * ) ( padding + i ) ) != padding_len ) {
1312                         DBGC ( tls, "TLS %p received bad padding\n", tls );
1313                         DBGC_HD ( tls, plaintext, plaintext_len );
1314                         return -EINVAL;
1315                 }
1316         }
1317
1318         /* Fill in return values */
1319         *data = content;
1320         *len = content_len;
1321         *digest = mac;
1322
1323         return 0;
1324 }
1325
1326 /**
1327  * Receive new ciphertext record
1328  *
1329  * @v tls               TLS session
1330  * @v tlshdr            Record header
1331  * @v ciphertext        Ciphertext record
1332  * @ret rc              Return status code
1333  */
1334 static int tls_new_ciphertext ( struct tls_session *tls,
1335                                 struct tls_header *tlshdr, void *ciphertext ) {
1336         struct tls_header plaintext_tlshdr;
1337         struct tls_cipherspec *cipherspec = &tls->rx_cipherspec;
1338         size_t record_len = ntohs ( tlshdr->length );
1339         void *plaintext = NULL;
1340         void *data;
1341         size_t len;
1342         void *mac;
1343         size_t mac_len = cipherspec->digest->digestsize;
1344         uint8_t verify_mac[mac_len];
1345         int rc;
1346
1347         /* Allocate buffer for plaintext */
1348         plaintext = malloc ( record_len );
1349         if ( ! plaintext ) {
1350                 DBGC ( tls, "TLS %p could not allocate %zd bytes for "
1351                        "decryption buffer\n", tls, record_len );
1352                 rc = -ENOMEM;
1353                 goto done;
1354         }
1355
1356         /* Decrypt the record */
1357         if ( ( rc = cipher_decrypt ( cipherspec->cipher,
1358                                      cipherspec->cipher_ctx, ciphertext,
1359                                      plaintext, record_len ) ) != 0 ) {
1360                 DBGC ( tls, "TLS %p could not decrypt: %s\n",
1361                        tls, strerror ( rc ) );
1362                 DBGC_HD ( tls, ciphertext, record_len );
1363                 goto done;
1364         }
1365
1366         /* Split record into content and MAC */
1367         if ( is_stream_cipher ( cipherspec->cipher ) ) {
1368                 if ( ( rc = tls_split_stream ( tls, plaintext, record_len,
1369                                                &data, &len, &mac ) ) != 0 )
1370                         goto done;
1371         } else {
1372                 if ( ( rc = tls_split_block ( tls, plaintext, record_len,
1373                                               &data, &len, &mac ) ) != 0 )
1374                         goto done;
1375         }
1376
1377         /* Verify MAC */
1378         plaintext_tlshdr.type = tlshdr->type;
1379         plaintext_tlshdr.version = tlshdr->version;
1380         plaintext_tlshdr.length = htons ( len );
1381         tls_hmac ( tls, cipherspec, tls->rx_seq, &plaintext_tlshdr,
1382                    data, len, verify_mac);
1383         if ( memcmp ( mac, verify_mac, mac_len ) != 0 ) {
1384                 DBGC ( tls, "TLS %p failed MAC verification\n", tls );
1385                 DBGC_HD ( tls, plaintext, record_len );
1386                 goto done;
1387         }
1388
1389         DBGC2 ( tls, "Received plaintext data:\n" );
1390         DBGC2_HD ( tls, data, len );
1391
1392         /* Process plaintext record */
1393         if ( ( rc = tls_new_record ( tls, tlshdr->type, data, len ) ) != 0 )
1394                 goto done;
1395
1396         rc = 0;
1397  done:
1398         free ( plaintext );
1399         return rc;
1400 }
1401
1402 /******************************************************************************
1403  *
1404  * Plaintext stream operations
1405  *
1406  ******************************************************************************
1407  */
1408
1409 /**
1410  * Close interface
1411  *
1412  * @v xfer              Plainstream data transfer interface
1413  * @v rc                Reason for close
1414  */
1415 static void tls_plainstream_close ( struct xfer_interface *xfer, int rc ) {
1416         struct tls_session *tls =
1417                 container_of ( xfer, struct tls_session, plainstream.xfer );
1418
1419         tls_close ( tls, rc );
1420 }
1421
1422 /**
1423  * Check flow control window
1424  *
1425  * @v xfer              Plainstream data transfer interface
1426  * @ret len             Length of window
1427  */
1428 static size_t tls_plainstream_window ( struct xfer_interface *xfer ) {
1429         struct tls_session *tls =
1430                 container_of ( xfer, struct tls_session, plainstream.xfer );
1431
1432         /* Block window unless we are ready to accept data */
1433         if ( tls->tx_state != TLS_TX_DATA )
1434                 return 0;
1435
1436         return filter_window ( xfer );
1437 }
1438
1439 /**
1440  * Deliver datagram as raw data
1441  *
1442  * @v xfer              Plainstream data transfer interface
1443  * @v data              Data buffer
1444  * @v len               Length of data buffer
1445  * @ret rc              Return status code
1446  */
1447 static int tls_plainstream_deliver_raw ( struct xfer_interface *xfer,
1448                                          const void *data, size_t len ) {
1449         struct tls_session *tls =
1450                 container_of ( xfer, struct tls_session, plainstream.xfer );
1451
1452         /* Refuse unless we are ready to accept data */
1453         if ( tls->tx_state != TLS_TX_DATA )
1454                 return -ENOTCONN;
1455
1456         return tls_send_plaintext ( tls, TLS_TYPE_DATA, data, len );
1457 }
1458
1459 /** TLS plaintext stream operations */
1460 static struct xfer_interface_operations tls_plainstream_operations = {
1461         .close          = tls_plainstream_close,
1462         .vredirect      = ignore_xfer_vredirect,
1463         .seek           = filter_seek,
1464         .window         = tls_plainstream_window,
1465         .alloc_iob      = default_xfer_alloc_iob,
1466         .deliver_iob    = xfer_deliver_as_raw,
1467         .deliver_raw    = tls_plainstream_deliver_raw,
1468 };
1469
1470 /******************************************************************************
1471  *
1472  * Ciphertext stream operations
1473  *
1474  ******************************************************************************
1475  */
1476
1477 /**
1478  * Close interface
1479  *
1480  * @v xfer              Plainstream data transfer interface
1481  * @v rc                Reason for close
1482  */
1483 static void tls_cipherstream_close ( struct xfer_interface *xfer, int rc ) {
1484         struct tls_session *tls =
1485                 container_of ( xfer, struct tls_session, cipherstream.xfer );
1486
1487         tls_close ( tls, rc );
1488 }
1489
1490 /**
1491  * Handle received TLS header
1492  *
1493  * @v tls               TLS session
1494  * @ret rc              Returned status code
1495  */
1496 static int tls_newdata_process_header ( struct tls_session *tls ) {
1497         size_t data_len = ntohs ( tls->rx_header.length );
1498
1499         /* Allocate data buffer now that we know the length */
1500         assert ( tls->rx_data == NULL );
1501         tls->rx_data = malloc ( data_len );
1502         if ( ! tls->rx_data ) {
1503                 DBGC ( tls, "TLS %p could not allocate %zd bytes "
1504                        "for receive buffer\n", tls, data_len );
1505                 return -ENOMEM;
1506         }
1507
1508         /* Move to data state */
1509         tls->rx_state = TLS_RX_DATA;
1510
1511         return 0;
1512 }
1513
1514 /**
1515  * Handle received TLS data payload
1516  *
1517  * @v tls               TLS session
1518  * @ret rc              Returned status code
1519  */
1520 static int tls_newdata_process_data ( struct tls_session *tls ) {
1521         int rc;
1522
1523         /* Process record */
1524         if ( ( rc = tls_new_ciphertext ( tls, &tls->rx_header,
1525                                          tls->rx_data ) ) != 0 )
1526                 return rc;
1527
1528         /* Increment RX sequence number */
1529         tls->rx_seq += 1;
1530
1531         /* Free data buffer */
1532         free ( tls->rx_data );
1533         tls->rx_data = NULL;
1534
1535         /* Return to header state */
1536         tls->rx_state = TLS_RX_HEADER;
1537
1538         return 0;
1539 }
1540
1541 /**
1542  * Receive new ciphertext
1543  *
1544  * @v app               Stream application
1545  * @v data              Data received
1546  * @v len               Length of received data
1547  * @ret rc              Return status code
1548  */
1549 static int tls_cipherstream_deliver_raw ( struct xfer_interface *xfer,
1550                                           const void *data, size_t len ) {
1551         struct tls_session *tls =
1552                 container_of ( xfer, struct tls_session, cipherstream.xfer );
1553         size_t frag_len;
1554         void *buf;
1555         size_t buf_len;
1556         int ( * process ) ( struct tls_session *tls );
1557         int rc;
1558
1559         while ( len ) {
1560                 /* Select buffer according to current state */
1561                 switch ( tls->rx_state ) {
1562                 case TLS_RX_HEADER:
1563                         buf = &tls->rx_header;
1564                         buf_len = sizeof ( tls->rx_header );
1565                         process = tls_newdata_process_header;
1566                         break;
1567                 case TLS_RX_DATA:
1568                         buf = tls->rx_data;
1569                         buf_len = ntohs ( tls->rx_header.length );
1570                         process = tls_newdata_process_data;
1571                         break;
1572                 default:
1573                         assert ( 0 );
1574                         return -EINVAL;
1575                 }
1576
1577                 /* Copy data portion to buffer */
1578                 frag_len = ( buf_len - tls->rx_rcvd );
1579                 if ( frag_len > len )
1580                         frag_len = len;
1581                 memcpy ( ( buf + tls->rx_rcvd ), data, frag_len );
1582                 tls->rx_rcvd += frag_len;
1583                 data += frag_len;
1584                 len -= frag_len;
1585
1586                 /* Process data if buffer is now full */
1587                 if ( tls->rx_rcvd == buf_len ) {
1588                         if ( ( rc = process ( tls ) ) != 0 ) {
1589                                 tls_close ( tls, rc );
1590                                 return rc;
1591                         }
1592                         tls->rx_rcvd = 0;
1593                 }
1594         }
1595
1596         return 0;
1597 }
1598
1599 /** TLS ciphertext stream operations */
1600 static struct xfer_interface_operations tls_cipherstream_operations = {
1601         .close          = tls_cipherstream_close,
1602         .vredirect      = xfer_vopen,
1603         .seek           = filter_seek,
1604         .window         = filter_window,
1605         .alloc_iob      = default_xfer_alloc_iob,
1606         .deliver_iob    = xfer_deliver_as_raw,
1607         .deliver_raw    = tls_cipherstream_deliver_raw,
1608 };
1609
1610 /******************************************************************************
1611  *
1612  * Controlling process
1613  *
1614  ******************************************************************************
1615  */
1616
1617 /**
1618  * TLS TX state machine
1619  *
1620  * @v process           TLS process
1621  */
1622 static void tls_step ( struct process *process ) {
1623         struct tls_session *tls =
1624                 container_of ( process, struct tls_session, process );
1625         int rc;
1626
1627         /* Wait for cipherstream to become ready */
1628         if ( ! xfer_window ( &tls->cipherstream.xfer ) )
1629                 return;
1630
1631         switch ( tls->tx_state ) {
1632         case TLS_TX_NONE:
1633                 /* Nothing to do */
1634                 break;
1635         case TLS_TX_CLIENT_HELLO:
1636                 /* Send Client Hello */
1637                 if ( ( rc = tls_send_client_hello ( tls ) ) != 0 ) {
1638                         DBGC ( tls, "TLS %p could not send Client Hello: %s\n",
1639                                tls, strerror ( rc ) );
1640                         goto err;
1641                 }
1642                 tls->tx_state = TLS_TX_NONE;
1643                 break;
1644         case TLS_TX_CLIENT_KEY_EXCHANGE:
1645                 /* Send Client Key Exchange */
1646                 if ( ( rc = tls_send_client_key_exchange ( tls ) ) != 0 ) {
1647                         DBGC ( tls, "TLS %p could send Client Key Exchange: "
1648                                "%s\n", tls, strerror ( rc ) );
1649                         goto err;
1650                 }
1651                 tls->tx_state = TLS_TX_CHANGE_CIPHER;
1652                 break;
1653         case TLS_TX_CHANGE_CIPHER:
1654                 /* Send Change Cipher, and then change the cipher in use */
1655                 if ( ( rc = tls_send_change_cipher ( tls ) ) != 0 ) {
1656                         DBGC ( tls, "TLS %p could not send Change Cipher: "
1657                                "%s\n", tls, strerror ( rc ) );
1658                         goto err;
1659                 }
1660                 if ( ( rc = tls_change_cipher ( tls,
1661                                                 &tls->tx_cipherspec_pending,
1662                                                 &tls->tx_cipherspec )) != 0 ){
1663                         DBGC ( tls, "TLS %p could not activate TX cipher: "
1664                                "%s\n", tls, strerror ( rc ) );
1665                         goto err;
1666                 }
1667                 tls->tx_seq = 0;
1668                 tls->tx_state = TLS_TX_FINISHED;
1669                 break;
1670         case TLS_TX_FINISHED:
1671                 /* Send Finished */
1672                 if ( ( rc = tls_send_finished ( tls ) ) != 0 ) {
1673                         DBGC ( tls, "TLS %p could not send Finished: %s\n",
1674                                tls, strerror ( rc ) );
1675                         goto err;
1676                 }
1677                 tls->tx_state = TLS_TX_NONE;
1678                 break;
1679         case TLS_TX_DATA:
1680                 /* Nothing to do */
1681                 break;
1682         default:
1683                 assert ( 0 );
1684         }
1685
1686         return;
1687
1688  err:
1689         tls_close ( tls, rc );
1690 }
1691
1692 /******************************************************************************
1693  *
1694  * Instantiator
1695  *
1696  ******************************************************************************
1697  */
1698
1699 int add_tls ( struct xfer_interface *xfer, struct xfer_interface **next ) {
1700         struct tls_session *tls;
1701
1702         /* Allocate and initialise TLS structure */
1703         tls = malloc ( sizeof ( *tls ) );
1704         if ( ! tls )
1705                 return -ENOMEM;
1706         memset ( tls, 0, sizeof ( *tls ) );
1707         tls->refcnt.free = free_tls;
1708         filter_init ( &tls->plainstream, &tls_plainstream_operations,
1709                       &tls->cipherstream, &tls_cipherstream_operations,
1710                       &tls->refcnt );
1711         tls_clear_cipher ( tls, &tls->tx_cipherspec );
1712         tls_clear_cipher ( tls, &tls->tx_cipherspec_pending );
1713         tls_clear_cipher ( tls, &tls->rx_cipherspec );
1714         tls_clear_cipher ( tls, &tls->rx_cipherspec_pending );
1715         *( ( uint32_t * ) tls->client_random ) = 0; /* GMT Unix time */
1716         tls_generate_random ( ( tls->client_random + 4 ),
1717                               ( sizeof ( tls->client_random ) - 4 ) );
1718         *( ( uint16_t * ) tls->pre_master_secret )
1719                 = htons ( TLS_VERSION_TLS_1_0 );
1720         tls_generate_random ( ( tls->pre_master_secret + 2 ),
1721                               ( sizeof ( tls->pre_master_secret ) - 2 ) );
1722         digest_init ( &md5_algorithm, tls->handshake_md5_ctx );
1723         digest_init ( &sha1_algorithm, tls->handshake_sha1_ctx );
1724         tls->tx_state = TLS_TX_CLIENT_HELLO;
1725         process_init ( &tls->process, tls_step, &tls->refcnt );
1726
1727         /* Attach to parent interface, mortalise self, and return */
1728         xfer_plug_plug ( &tls->plainstream.xfer, xfer );
1729         *next = &tls->cipherstream.xfer;
1730         ref_put ( &tls->refcnt );
1731         return 0;
1732 }
1733