|
Packit |
c4476c |
/*
|
|
Packit |
c4476c |
* Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved.
|
|
Packit |
c4476c |
*
|
|
Packit |
c4476c |
* Licensed under the OpenSSL license (the "License"). You may not use
|
|
Packit |
c4476c |
* this file except in compliance with the License. You can obtain a copy
|
|
Packit |
c4476c |
* in the file LICENSE in the source distribution or at
|
|
Packit |
c4476c |
* https://www.openssl.org/source/license.html
|
|
Packit |
c4476c |
*/
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
/*****************************************************************************
|
|
Packit |
c4476c |
* *
|
|
Packit |
c4476c |
* These enums should be considered PRIVATE to the state machine. No *
|
|
Packit |
c4476c |
* non-state machine code should need to use these *
|
|
Packit |
c4476c |
* *
|
|
Packit |
c4476c |
*****************************************************************************/
|
|
Packit |
c4476c |
/*
|
|
Packit |
c4476c |
* Valid return codes used for functions performing work prior to or after
|
|
Packit |
c4476c |
* sending or receiving a message
|
|
Packit |
c4476c |
*/
|
|
Packit |
c4476c |
typedef enum {
|
|
Packit |
c4476c |
/* Something went wrong */
|
|
Packit |
c4476c |
WORK_ERROR,
|
|
Packit |
c4476c |
/* We're done working and there shouldn't be anything else to do after */
|
|
Packit |
c4476c |
WORK_FINISHED_STOP,
|
|
Packit |
c4476c |
/* We're done working move onto the next thing */
|
|
Packit |
c4476c |
WORK_FINISHED_CONTINUE,
|
|
Packit |
c4476c |
/* We're working on phase A */
|
|
Packit |
c4476c |
WORK_MORE_A,
|
|
Packit |
c4476c |
/* We're working on phase B */
|
|
Packit |
c4476c |
WORK_MORE_B,
|
|
Packit |
c4476c |
/* We're working on phase C */
|
|
Packit |
c4476c |
WORK_MORE_C
|
|
Packit |
c4476c |
} WORK_STATE;
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
/* Write transition return codes */
|
|
Packit |
c4476c |
typedef enum {
|
|
Packit |
c4476c |
/* Something went wrong */
|
|
Packit |
c4476c |
WRITE_TRAN_ERROR,
|
|
Packit |
c4476c |
/* A transition was successfully completed and we should continue */
|
|
Packit |
c4476c |
WRITE_TRAN_CONTINUE,
|
|
Packit |
c4476c |
/* There is no more write work to be done */
|
|
Packit |
c4476c |
WRITE_TRAN_FINISHED
|
|
Packit |
c4476c |
} WRITE_TRAN;
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
/* Message flow states */
|
|
Packit |
c4476c |
typedef enum {
|
|
Packit |
c4476c |
/* No handshake in progress */
|
|
Packit |
c4476c |
MSG_FLOW_UNINITED,
|
|
Packit |
c4476c |
/* A permanent error with this connection */
|
|
Packit |
c4476c |
MSG_FLOW_ERROR,
|
|
Packit |
c4476c |
/* We are reading messages */
|
|
Packit |
c4476c |
MSG_FLOW_READING,
|
|
Packit |
c4476c |
/* We are writing messages */
|
|
Packit |
c4476c |
MSG_FLOW_WRITING,
|
|
Packit |
c4476c |
/* Handshake has finished */
|
|
Packit |
c4476c |
MSG_FLOW_FINISHED
|
|
Packit |
c4476c |
} MSG_FLOW_STATE;
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
/* Read states */
|
|
Packit |
c4476c |
typedef enum {
|
|
Packit |
c4476c |
READ_STATE_HEADER,
|
|
Packit |
c4476c |
READ_STATE_BODY,
|
|
Packit |
c4476c |
READ_STATE_POST_PROCESS
|
|
Packit |
c4476c |
} READ_STATE;
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
/* Write states */
|
|
Packit |
c4476c |
typedef enum {
|
|
Packit |
c4476c |
WRITE_STATE_TRANSITION,
|
|
Packit |
c4476c |
WRITE_STATE_PRE_WORK,
|
|
Packit |
c4476c |
WRITE_STATE_SEND,
|
|
Packit |
c4476c |
WRITE_STATE_POST_WORK
|
|
Packit |
c4476c |
} WRITE_STATE;
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
typedef enum {
|
|
Packit |
c4476c |
/* The enc_write_ctx can be used normally */
|
|
Packit |
c4476c |
ENC_WRITE_STATE_VALID,
|
|
Packit |
c4476c |
/* The enc_write_ctx cannot be used */
|
|
Packit |
c4476c |
ENC_WRITE_STATE_INVALID,
|
|
Packit |
c4476c |
/* Write alerts in plaintext, but otherwise use the enc_write_ctx */
|
|
Packit |
c4476c |
ENC_WRITE_STATE_WRITE_PLAIN_ALERTS
|
|
Packit |
c4476c |
} ENC_WRITE_STATES;
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
typedef enum {
|
|
Packit |
c4476c |
/* The enc_read_ctx can be used normally */
|
|
Packit |
c4476c |
ENC_READ_STATE_VALID,
|
|
Packit |
c4476c |
/* We may receive encrypted or plaintext alerts */
|
|
Packit |
c4476c |
ENC_READ_STATE_ALLOW_PLAIN_ALERTS
|
|
Packit |
c4476c |
} ENC_READ_STATES;
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
/*****************************************************************************
|
|
Packit |
c4476c |
* *
|
|
Packit |
c4476c |
* This structure should be considered "opaque" to anything outside of the *
|
|
Packit |
c4476c |
* state machine. No non-state machine code should be accessing the members *
|
|
Packit |
c4476c |
* of this structure. *
|
|
Packit |
c4476c |
* *
|
|
Packit |
c4476c |
*****************************************************************************/
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
struct ossl_statem_st {
|
|
Packit |
c4476c |
MSG_FLOW_STATE state;
|
|
Packit |
c4476c |
WRITE_STATE write_state;
|
|
Packit |
c4476c |
WORK_STATE write_state_work;
|
|
Packit |
c4476c |
READ_STATE read_state;
|
|
Packit |
c4476c |
WORK_STATE read_state_work;
|
|
Packit |
c4476c |
OSSL_HANDSHAKE_STATE hand_state;
|
|
Packit |
c4476c |
/* The handshake state requested by an API call (e.g. HelloRequest) */
|
|
Packit |
c4476c |
OSSL_HANDSHAKE_STATE request_state;
|
|
Packit |
c4476c |
int in_init;
|
|
Packit |
c4476c |
int read_state_first_init;
|
|
Packit |
c4476c |
/* true when we are actually in SSL_accept() or SSL_connect() */
|
|
Packit |
c4476c |
int in_handshake;
|
|
Packit |
c4476c |
/*
|
|
Packit |
c4476c |
* True when are processing a "real" handshake that needs cleaning up (not
|
|
Packit |
c4476c |
* just a HelloRequest or similar).
|
|
Packit |
c4476c |
*/
|
|
Packit |
c4476c |
int cleanuphand;
|
|
Packit |
c4476c |
/* Should we skip the CertificateVerify message? */
|
|
Packit |
c4476c |
unsigned int no_cert_verify;
|
|
Packit |
c4476c |
int use_timer;
|
|
Packit |
c4476c |
ENC_WRITE_STATES enc_write_state;
|
|
Packit |
c4476c |
ENC_READ_STATES enc_read_state;
|
|
Packit |
c4476c |
};
|
|
Packit |
c4476c |
typedef struct ossl_statem_st OSSL_STATEM;
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
/*****************************************************************************
|
|
Packit |
c4476c |
* *
|
|
Packit |
c4476c |
* The following macros/functions represent the libssl internal API to the *
|
|
Packit |
c4476c |
* state machine. Any libssl code may call these functions/macros *
|
|
Packit |
c4476c |
* *
|
|
Packit |
c4476c |
*****************************************************************************/
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
__owur int ossl_statem_accept(SSL *s);
|
|
Packit |
c4476c |
__owur int ossl_statem_connect(SSL *s);
|
|
Packit |
c4476c |
void ossl_statem_clear(SSL *s);
|
|
Packit |
c4476c |
void ossl_statem_set_renegotiate(SSL *s);
|
|
Packit |
c4476c |
void ossl_statem_fatal(SSL *s, int al, int func, int reason, const char *file,
|
|
Packit |
c4476c |
int line);
|
|
Packit |
c4476c |
# define SSL_AD_NO_ALERT -1
|
|
Packit |
c4476c |
# ifndef OPENSSL_NO_ERR
|
|
Packit |
c4476c |
# define SSLfatal(s, al, f, r) ossl_statem_fatal((s), (al), (f), (r), \
|
|
Packit |
c4476c |
OPENSSL_FILE, OPENSSL_LINE)
|
|
Packit |
c4476c |
# else
|
|
Packit |
c4476c |
# define SSLfatal(s, al, f, r) ossl_statem_fatal((s), (al), (f), (r), NULL, 0)
|
|
Packit |
c4476c |
# endif
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
int ossl_statem_in_error(const SSL *s);
|
|
Packit |
c4476c |
void ossl_statem_set_in_init(SSL *s, int init);
|
|
Packit |
c4476c |
int ossl_statem_get_in_handshake(SSL *s);
|
|
Packit |
c4476c |
void ossl_statem_set_in_handshake(SSL *s, int inhand);
|
|
Packit |
c4476c |
__owur int ossl_statem_skip_early_data(SSL *s);
|
|
Packit |
c4476c |
void ossl_statem_check_finish_init(SSL *s, int send);
|
|
Packit |
c4476c |
void ossl_statem_set_hello_verify_done(SSL *s);
|
|
Packit |
c4476c |
__owur int ossl_statem_app_data_allowed(SSL *s);
|
|
Packit |
c4476c |
__owur int ossl_statem_export_allowed(SSL *s);
|
|
Packit |
c4476c |
__owur int ossl_statem_export_early_allowed(SSL *s);
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
/* Flush the write BIO */
|
|
Packit |
c4476c |
int statem_flush(SSL *s);
|