/* $OpenBSD: tls13_internal.h,v 1.28 2019/04/05 20:23:38 tb Exp $ */ /* * Copyright (c) 2018 Bob Beck * Copyright (c) 2018 Theo Buehler * Copyright (c) 2018, 2019 Joel Sing * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #ifndef HEADER_TLS13_INTERNAL_H #define HEADER_TLS13_INTERNAL_H #include #include #include "bytestring.h" __BEGIN_HIDDEN_DECLS #define TLS13_HS_CLIENT 1 #define TLS13_HS_SERVER 2 #define TLS13_IO_SUCCESS 1 #define TLS13_IO_EOF 0 #define TLS13_IO_FAILURE -1 #define TLS13_IO_WANT_POLLIN -2 #define TLS13_IO_WANT_POLLOUT -3 #define TLS13_IO_USE_LEGACY -4 typedef void (*tls13_alert_cb)(uint8_t _alert_desc, void *_cb_arg); typedef int (*tls13_post_handshake_cb)(void *_cb_arg); typedef ssize_t (*tls13_read_cb)(void *_buf, size_t _buflen, void *_cb_arg); typedef ssize_t (*tls13_write_cb)(const void *_buf, size_t _buflen, void *_cb_arg); struct tls13_buffer; struct tls13_buffer *tls13_buffer_new(size_t init_size); void tls13_buffer_free(struct tls13_buffer *buf); ssize_t tls13_buffer_extend(struct tls13_buffer *buf, size_t len, tls13_read_cb read_cb, void *cb_arg); void tls13_buffer_cbs(struct tls13_buffer *buf, CBS *cbs); int tls13_buffer_finish(struct tls13_buffer *buf, uint8_t **out, size_t *out_len); struct tls13_secret { uint8_t *data; size_t len; }; /* RFC 8446 Section 7.1 Page 92 */ struct tls13_secrets { const EVP_MD *digest; int resumption; int init_done; int early_done; int handshake_done; int schedule_done; int insecure; /* Set by tests */ struct tls13_secret zeros; struct tls13_secret empty_hash; struct tls13_secret extracted_early; struct tls13_secret binder_key; struct tls13_secret client_early_traffic; struct tls13_secret early_exporter_master; struct tls13_secret derived_early; struct tls13_secret extracted_handshake; struct tls13_secret client_handshake_traffic; struct tls13_secret server_handshake_traffic; struct tls13_secret derived_handshake; struct tls13_secret extracted_master; struct tls13_secret client_application_traffic; struct tls13_secret server_application_traffic; struct tls13_secret exporter_master; struct tls13_secret resumption_master; }; struct tls13_secrets *tls13_secrets_create(const EVP_MD *digest, int resumption); void tls13_secrets_destroy(struct tls13_secrets *secrets); int tls13_hkdf_expand_label(struct tls13_secret *out, const EVP_MD *digest, const struct tls13_secret *secret, const char *label, const struct tls13_secret *context); int tls13_derive_early_secrets(struct tls13_secrets *secrets, uint8_t *psk, size_t psk_len, const struct tls13_secret *context); int tls13_derive_handshake_secrets(struct tls13_secrets *secrets, const uint8_t *ecdhe, size_t ecdhe_len, const struct tls13_secret *context); int tls13_derive_application_secrets(struct tls13_secrets *secrets, const struct tls13_secret *context); /* * Record Layer. */ struct tls13_record_layer; struct tls13_record_layer *tls13_record_layer_new(tls13_read_cb wire_read, tls13_write_cb wire_write, tls13_alert_cb alert_cb, tls13_post_handshake_cb post_handshake_cb, void *cb_arg); void tls13_record_layer_free(struct tls13_record_layer *rl); void tls13_record_layer_set_aead(struct tls13_record_layer *rl, const EVP_AEAD *aead); void tls13_record_layer_set_hash(struct tls13_record_layer *rl, const EVP_MD *hash); void tls13_record_layer_handshake_completed(struct tls13_record_layer *rl); int tls13_record_layer_set_read_traffic_key(struct tls13_record_layer *rl, struct tls13_secret *read_key); int tls13_record_layer_set_write_traffic_key(struct tls13_record_layer *rl, struct tls13_secret *write_key); ssize_t tls13_read_handshake_data(struct tls13_record_layer *rl, uint8_t *buf, size_t n); ssize_t tls13_write_handshake_data(struct tls13_record_layer *rl, const uint8_t *buf, size_t n); ssize_t tls13_read_application_data(struct tls13_record_layer *rl, uint8_t *buf, size_t n); ssize_t tls13_write_application_data(struct tls13_record_layer *rl, const uint8_t *buf, size_t n); /* * Handshake Messages. */ struct tls13_handshake_msg; struct tls13_handshake_msg *tls13_handshake_msg_new(void); void tls13_handshake_msg_free(struct tls13_handshake_msg *msg); void tls13_handshake_msg_data(struct tls13_handshake_msg *msg, CBS *cbs); uint8_t tls13_handshake_msg_type(struct tls13_handshake_msg *msg); int tls13_handshake_msg_content(struct tls13_handshake_msg *msg, CBS *cbs); int tls13_handshake_msg_start(struct tls13_handshake_msg *msg, CBB *body, uint8_t msg_type); int tls13_handshake_msg_finish(struct tls13_handshake_msg *msg); int tls13_handshake_msg_recv(struct tls13_handshake_msg *msg, struct tls13_record_layer *rl); int tls13_handshake_msg_send(struct tls13_handshake_msg *msg, struct tls13_record_layer *rl); struct tls13_handshake_stage { uint8_t hs_type; uint8_t message_number; }; struct ssl_handshake_tls13_st; struct tls13_ctx { SSL *ssl; struct ssl_handshake_tls13_st *hs; uint8_t mode; struct tls13_handshake_stage handshake_stage; int handshake_completed; const EVP_AEAD *aead; const EVP_MD *hash; struct tls13_record_layer *rl; struct tls13_handshake_msg *hs_msg; }; struct tls13_ctx *tls13_ctx_new(int mode); void tls13_ctx_free(struct tls13_ctx *ctx); const EVP_AEAD *tls13_cipher_aead(const SSL_CIPHER *cipher); const EVP_MD *tls13_cipher_hash(const SSL_CIPHER *cipher); /* * Legacy interfaces. */ int tls13_legacy_connect(SSL *ssl); int tls13_legacy_return_code(SSL *ssl, ssize_t ret); ssize_t tls13_legacy_wire_read_cb(void *buf, size_t n, void *arg); ssize_t tls13_legacy_wire_write_cb(const void *buf, size_t n, void *arg); int tls13_legacy_read_bytes(SSL *ssl, int type, unsigned char *buf, int len, int peek); int tls13_legacy_write_bytes(SSL *ssl, int type, const void *buf, int len); /* * Message Types - RFC 8446, Section B.3. * * Values listed as "_RESERVED" were used in previous versions of TLS and are * listed here for completeness. TLS 1.3 implementations MUST NOT send them but * might receive them from older TLS implementations. */ #define TLS13_MT_HELLO_REQUEST_RESERVED 0 #define TLS13_MT_CLIENT_HELLO 1 #define TLS13_MT_SERVER_HELLO 2 #define TLS13_MT_HELLO_VERIFY_REQUEST_RESERVED 3 #define TLS13_MT_NEW_SESSION_TICKET 4 #define TLS13_MT_END_OF_EARLY_DATA 5 #define TLS13_MT_HELLO_RETRY_REQUEST_RESERVED 6 #define TLS13_MT_ENCRYPTED_EXTENSIONS 8 #define TLS13_MT_CERTIFICATE 11 #define TLS13_MT_SERVER_KEY_EXCHANGE_RESERVED 12 #define TLS13_MT_CERTIFICATE_REQUEST 13 #define TLS13_MT_SERVER_HELLO_DONE_RESERVED 14 #define TLS13_MT_CERTIFICATE_VERIFY 15 #define TLS13_MT_CLIENT_KEY_EXCHANGE_RESERVED 16 #define TLS13_MT_FINISHED 20 #define TLS13_MT_CERTIFICATE_URL_RESERVED 21 #define TLS13_MT_CERTIFICATE_STATUS_RESERVED 22 #define TLS13_MT_SUPPLEMENTAL_DATA_RESERVED 23 #define TLS13_MT_KEY_UPDATE 24 #define TLS13_MT_MESSAGE_HASH 254 int tls13_handshake_perform(struct tls13_ctx *ctx); int tls13_client_hello_send(struct tls13_ctx *ctx); int tls13_client_hello_recv(struct tls13_ctx *ctx); int tls13_client_hello_retry_send(struct tls13_ctx *ctx); int tls13_client_hello_retry_recv(struct tls13_ctx *ctx); int tls13_client_end_of_early_data_send(struct tls13_ctx *ctx); int tls13_client_end_of_early_data_recv(struct tls13_ctx *ctx); int tls13_client_certificate_send(struct tls13_ctx *ctx); int tls13_client_certificate_recv(struct tls13_ctx *ctx); int tls13_client_certificate_verify_send(struct tls13_ctx *ctx); int tls13_client_certificate_verify_recv(struct tls13_ctx *ctx); int tls13_client_finished_recv(struct tls13_ctx *ctx); int tls13_client_finished_send(struct tls13_ctx *ctx); int tls13_client_finished_sent(struct tls13_ctx *ctx); int tls13_client_key_update_send(struct tls13_ctx *ctx); int tls13_client_key_update_recv(struct tls13_ctx *ctx); int tls13_server_hello_recv(struct tls13_ctx *ctx); int tls13_server_hello_send(struct tls13_ctx *ctx); int tls13_server_hello_retry_recv(struct tls13_ctx *ctx); int tls13_server_hello_retry_send(struct tls13_ctx *ctx); int tls13_server_encrypted_extensions_recv(struct tls13_ctx *ctx); int tls13_server_encrypted_extensions_send(struct tls13_ctx *ctx); int tls13_server_certificate_recv(struct tls13_ctx *ctx); int tls13_server_certificate_send(struct tls13_ctx *ctx); int tls13_server_certificate_request_recv(struct tls13_ctx *ctx); int tls13_server_certificate_request_send(struct tls13_ctx *ctx); int tls13_server_certificate_verify_send(struct tls13_ctx *ctx); int tls13_server_certificate_verify_recv(struct tls13_ctx *ctx); int tls13_server_finished_recv(struct tls13_ctx *ctx); int tls13_server_finished_send(struct tls13_ctx *ctx); __END_HIDDEN_DECLS #endif