openssl

mirror of https://github.com/openssl/openssl.git synced 2024-12-15 06:01:37 +08:00

History

Ben Kaduk 2c0267fdc9 Restore historical SSL_get_servername() behavior Commit `1c4aa31d79` modified the state machine to clean up stale ext.hostname values from SSL objects in the case when SNI was not negotiated for the current handshake. This is natural from the TLS perspective, since this information is an extension that the client offered but we ignored, and since we ignored it we do not need to keep it around for anything else. However, as documented in https://github.com/openssl/openssl/issues/7014 , there appear to be some deployed code that relies on retrieving such an ignored SNI value from the client, after the handshake has completed. Because the 1.1.1 release is on a stable branch and should preserve the published ABI, restore the historical behavior by retaining the ext.hostname value sent by the client, in the SSL structure, for subsequent retrieval. [extended tests] Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7115)		2018-09-07 15:21:27 +01:00
..
extensions_clnt.c	Use the same min-max version range on the client consistently	2018-08-22 15:15:19 +01:00
extensions_cust.c	Update copyright year	2018-02-13 13:59:25 +00:00
extensions_srvr.c	Send a NewSessionTicket after using an external PSK	2018-09-04 11:22:26 +01:00
extensions.c	Restore historical SSL_get_servername() behavior	2018-09-07 15:21:27 +01:00
README
statem_clnt.c	Process KeyUpdate and NewSessionTicket messages after a close_notify	2018-09-07 11:15:20 +01:00
statem_dtls.c	Don't memcpy the contents of an empty fragment	2018-05-12 09:59:02 +01:00
statem_lib.c	Ensure certificate callbacks work correctly in TLSv1.3	2018-09-07 11:20:37 +01:00
statem_locl.h	Don't calculate the Finished MAC twice	2018-02-09 15:27:32 +00:00
statem_srvr.c	Ignore EPIPE when sending NewSessionTickets in TLSv1.3	2018-09-04 11:06:48 +01:00
statem.c	Ensure that we write out alerts correctly after early_data	2018-08-08 10:16:58 +01:00
statem.h	Tolerate encrypted or plaintext alerts	2018-08-08 10:16:58 +01:00

README

State Machine Design
====================

This file provides some guidance on the thinking behind the design of the
state machine code to aid future maintenance.

The state machine code replaces an older state machine present in OpenSSL
versions 1.0.2 and below. The new state machine has the following objectives:
    - Remove duplication of state code between client and server
    - Remove duplication of state code between TLS and DTLS
    - Simplify transitions and bring the logic together in a single location
      so that it is easier to validate
    - Remove duplication of code between each of the message handling functions
    - Receive a message first and then work out whether that is a valid
      transition - not the other way around (the other way causes lots of issues
      where we are expecting one type of message next but actually get something
      else)
    - Separate message flow state from handshake state (in order to better
      understand each)
      - message flow state = when to flush buffers; handling restarts in the
        event of NBIO events; handling the common flow of steps for reading a
        message and the common flow of steps for writing a message etc
      - handshake state = what handshake message are we working on now
    - Control complexity: only the state machine can change state: keep all
      the state changes local to the state machine component

The message flow state machine is divided into a reading sub-state machine and a
writing sub-state machine. See the source comments in statem.c for a more
detailed description of the various states and transitions possible.

Conceptually the state machine component is designed as follows:

                        libssl
                           |
---------------------------|-----statem.h--------------------------------------
                           |
                    _______V____________________
                   |                            |
                   |    statem.c                |
                   |                            |
                   |    Core state machine code |
                   |____________________________|
        statem_locl.h     ^          ^
                 _________|          |_______
                |                            |
   _____________|____________   _____________|____________
  |                          | |                          |
  | statem_clnt.c            | | statem_srvr.c            |
  |                          | |                          |
  | TLS/DTLS client specific | | TLS/DTLS server specific |
  | state machine code       | | state machine code       |
  |__________________________| |__________________________|
               |        |_______________|__       |
               |        ________________|  |      |
               |       |                   |      |
   ____________V_______V________   ________V______V_______________
  |                             | |                               |
  | statem_both.c               | | statem_dtls.c                 |
  |                             | |                               |
  | Non core functions common   | | Non core functions common to  |
  | to both servers and clients | | both DTLS servers and clients |
  |_____________________________| |_______________________________|