1 /* 2 * Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved. 3 * 4 * Licensed under the OpenSSL license (the "License"). You may not use 5 * this file except in compliance with the License. You can obtain a copy 6 * in the file LICENSE in the source distribution or at 7 * https://www.openssl.org/source/license.html 8 */ 9 10 /***************************************************************************** 11 * * 12 * These enums should be considered PRIVATE to the state machine. No * 13 * non-state machine code should need to use these * 14 * * 15 *****************************************************************************/ 16 /* 17 * Valid return codes used for functions performing work prior to or after 18 * sending or receiving a message 19 */ 20 typedef enum { 21 /* Something went wrong */ 22 WORK_ERROR, 23 /* We're done working and there shouldn't be anything else to do after */ 24 WORK_FINISHED_STOP, 25 /* We're done working move onto the next thing */ 26 WORK_FINISHED_CONTINUE, 27 /* We're working on phase A */ 28 WORK_MORE_A, 29 /* We're working on phase B */ 30 WORK_MORE_B 31 } WORK_STATE; 32 33 /* Write transition return codes */ 34 typedef enum { 35 /* Something went wrong */ 36 WRITE_TRAN_ERROR, 37 /* A transition was successfully completed and we should continue */ 38 WRITE_TRAN_CONTINUE, 39 /* There is no more write work to be done */ 40 WRITE_TRAN_FINISHED 41 } WRITE_TRAN; 42 43 /* Message flow states */ 44 typedef enum { 45 /* No handshake in progress */ 46 MSG_FLOW_UNINITED, 47 /* A permanent error with this connection */ 48 MSG_FLOW_ERROR, 49 /* We are about to renegotiate */ 50 MSG_FLOW_RENEGOTIATE, 51 /* We are reading messages */ 52 MSG_FLOW_READING, 53 /* We are writing messages */ 54 MSG_FLOW_WRITING, 55 /* Handshake has finished */ 56 MSG_FLOW_FINISHED 57 } MSG_FLOW_STATE; 58 59 /* Read states */ 60 typedef enum { 61 READ_STATE_HEADER, 62 READ_STATE_BODY, 63 READ_STATE_POST_PROCESS 64 } READ_STATE; 65 66 /* Write states */ 67 typedef enum { 68 WRITE_STATE_TRANSITION, 69 WRITE_STATE_PRE_WORK, 70 WRITE_STATE_SEND, 71 WRITE_STATE_POST_WORK 72 } WRITE_STATE; 73 74 /***************************************************************************** 75 * * 76 * This structure should be considered "opaque" to anything outside of the * 77 * state machine. No non-state machine code should be accessing the members * 78 * of this structure. * 79 * * 80 *****************************************************************************/ 81 82 struct ossl_statem_st { 83 MSG_FLOW_STATE state; 84 WRITE_STATE write_state; 85 WORK_STATE write_state_work; 86 READ_STATE read_state; 87 WORK_STATE read_state_work; 88 OSSL_HANDSHAKE_STATE hand_state; 89 int in_init; 90 int read_state_first_init; 91 /* true when we are actually in SSL_accept() or SSL_connect() */ 92 int in_handshake; 93 /* Should we skip the CertificateVerify message? */ 94 unsigned int no_cert_verify; 95 int use_timer; 96 }; 97 typedef struct ossl_statem_st OSSL_STATEM; 98 99 /***************************************************************************** 100 * * 101 * The following macros/functions represent the libssl internal API to the * 102 * state machine. Any libssl code may call these functions/macros * 103 * * 104 *****************************************************************************/ 105 106 __owur int ossl_statem_accept(SSL *s); 107 __owur int ossl_statem_connect(SSL *s); 108 void ossl_statem_clear(SSL *s); 109 void ossl_statem_set_renegotiate(SSL *s); 110 void ossl_statem_set_error(SSL *s); 111 int ossl_statem_in_error(const SSL *s); 112 void ossl_statem_set_in_init(SSL *s, int init); 113 int ossl_statem_get_in_handshake(SSL *s); 114 void ossl_statem_set_in_handshake(SSL *s, int inhand); 115 void ossl_statem_set_hello_verify_done(SSL *s); 116 __owur int ossl_statem_app_data_allowed(SSL *s); 117