root
/
openssl
mirror of https://github.com/openssl/openssl.git
1
0
Fork 0
Code Issues Actions 7 Packages Projects Releases Wiki Activity
openssl/ssl/statem
History
noctuelles de5a619aa0 fix: msg callback in dtls1_do_write that incorrectly shows message (like a certificate) that spans over multiple fragments. 
Reviewed-by: Paul Yang <paulyang.inf@gmail.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/27811)
 		2025-06-30 11:23:40 +01:00
..
README.md ssl: Correct filename in README 2021-09-27 09:39:17 +10:00
extensions.c fix: add parsing check in TLS compress_certificate extension handler 2025-06-10 19:39:29 +02:00
extensions_clnt.c Fix sigalg corner cases 2025-03-31 14:07:56 +02:00
extensions_cust.c Preserve connection custom extensions in SSL_set_SSL_CTX() 2025-06-20 15:55:29 +01:00
extensions_srvr.c statem: always save sigalgs during PHA 2025-04-01 15:10:54 +02:00
statem.c Move the Handshake read secret change earlier in the process for QUIC 0-RTT 2025-03-20 20:22:39 +01:00
statem_clnt.c Ensure client read app data secret change occurs after write for QUIC 2025-06-03 17:06:31 +01:00
statem_dtls.c fix: msg callback in dtls1_do_write that incorrectly shows message (like a certificate) that spans over multiple fragments. 2025-06-30 11:23:40 +01:00
statem_lib.c Ensure client read app data secret change occurs after write for QUIC 2025-06-03 17:06:31 +01:00
statem_local.h Copyright year updates 2025-03-12 13:35:59 +00:00
statem_srvr.c Implement explicit storing of the server_finished_hash 2025-06-03 17:06:31 +01:00

README.md

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_local.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_lib.c                | | statem_dtls.c                 |
|                             | |                               |
| Non core functions common   | | Non core functions common to  |
| to both servers and clients | | both DTLS servers and clients |
|_____________________________| |_______________________________|