Make add_clienthello callbacks const.
This is less effective than it seems because both
((const SSL_HANDSHAKE*)hs)->ssl and ((const SSL*)ssl)->s3 are both
non-const pointers. I considered moving hs->ssl to hs->ssl_ and adding
const-overloaded accessors, but I'd need to repeat the same with
ssl->s3, at which point this seemed not worth it yet. Maybe later if we
rewrite everything to more idiomatic C++.
Bug: 275
Change-Id: I9912a3df205916fdf2191a3687013d717528038d
Reviewed-on: https://boringssl-review.googlesource.com/c/boringssl/+/47991
Reviewed-by: Adam Langley <agl@google.com>
diff --git a/ssl/internal.h b/ssl/internal.h
index 37a6b2c..8d7e493 100644
--- a/ssl/internal.h
+++ b/ssl/internal.h
@@ -488,7 +488,7 @@
uint16_t *out_max_version);
// ssl_supports_version returns whether |hs| supports |version|.
-bool ssl_supports_version(SSL_HANDSHAKE *hs, uint16_t version);
+bool ssl_supports_version(const SSL_HANDSHAKE *hs, uint16_t version);
// ssl_method_supports_version returns whether |method| supports |version|.
bool ssl_method_supports_version(const SSL_PROTOCOL_METHOD *method,
@@ -496,7 +496,7 @@
// ssl_add_supported_versions writes the supported versions of |hs| to |cbb|, in
// decreasing preference order.
-bool ssl_add_supported_versions(SSL_HANDSHAKE *hs, CBB *cbb);
+bool ssl_add_supported_versions(const SSL_HANDSHAKE *hs, CBB *cbb);
// ssl_negotiate_version negotiates a common version based on |hs|'s preferences
// and the peer preference list in |peer_versions|. On success, it returns true
diff --git a/ssl/ssl_versions.cc b/ssl/ssl_versions.cc
index 3bbb4e3..6caf070 100644
--- a/ssl/ssl_versions.cc
+++ b/ssl/ssl_versions.cc
@@ -260,8 +260,8 @@
return version;
}
-bool ssl_supports_version(SSL_HANDSHAKE *hs, uint16_t version) {
- SSL *const ssl = hs->ssl;
+bool ssl_supports_version(const SSL_HANDSHAKE *hs, uint16_t version) {
+ const SSL *const ssl = hs->ssl;
uint16_t protocol_version;
if (!ssl_method_supports_version(ssl->method, version) ||
!ssl_protocol_version_from_wire(&protocol_version, version) ||
@@ -273,7 +273,7 @@
return true;
}
-bool ssl_add_supported_versions(SSL_HANDSHAKE *hs, CBB *cbb) {
+bool ssl_add_supported_versions(const SSL_HANDSHAKE *hs, CBB *cbb) {
for (uint16_t version : get_method_versions(hs->ssl->method)) {
if (ssl_supports_version(hs, version) &&
!CBB_add_u16(cbb, version)) {
diff --git a/ssl/t1_lib.cc b/ssl/t1_lib.cc
index 57c9fd5..bd246f3 100644
--- a/ssl/t1_lib.cc
+++ b/ssl/t1_lib.cc
@@ -502,6 +502,7 @@
//
// The add callbacks receive a |CBB| to which the extension can be appended but
// the function is responsible for appending the type and length bytes too.
+// |add_clienthello| may be called multiple times and must not mutate |hs|.
//
// All callbacks return true for success and false for error. If a parse
// function returns zero then a fatal alert with value |*out_alert| will be
@@ -509,7 +510,7 @@
struct tls_extension {
uint16_t value;
- bool (*add_clienthello)(SSL_HANDSHAKE *hs, CBB *out);
+ bool (*add_clienthello)(const SSL_HANDSHAKE *hs, CBB *out);
bool (*parse_serverhello)(SSL_HANDSHAKE *hs, uint8_t *out_alert,
CBS *contents);
@@ -544,8 +545,8 @@
//
// https://tools.ietf.org/html/rfc6066#section-3.
-static bool ext_sni_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
- SSL *const ssl = hs->ssl;
+static bool ext_sni_add_clienthello(const SSL_HANDSHAKE *hs, CBB *out) {
+ const SSL *const ssl = hs->ssl;
if (ssl->hostname == nullptr) {
return true;
}
@@ -659,7 +660,7 @@
return true;
}
-static bool ext_ech_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
+static bool ext_ech_add_clienthello(const SSL_HANDSHAKE *hs, CBB *out) {
if (hs->max_version < TLS1_3_VERSION) {
return true;
}
@@ -753,7 +754,8 @@
return CBB_flush(out);
}
-static bool ext_ech_is_inner_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
+static bool ext_ech_is_inner_add_clienthello(const SSL_HANDSHAKE *hs,
+ CBB *out) {
return true;
}
@@ -776,8 +778,8 @@
//
// https://tools.ietf.org/html/rfc5746
-static bool ext_ri_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
- SSL *const ssl = hs->ssl;
+static bool ext_ri_add_clienthello(const SSL_HANDSHAKE *hs, CBB *out) {
+ const SSL *const ssl = hs->ssl;
// Renegotiation indication is not necessary in TLS 1.3.
if (hs->min_version >= TLS1_3_VERSION) {
return true;
@@ -941,7 +943,7 @@
//
// https://tools.ietf.org/html/rfc7627
-static bool ext_ems_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
+static bool ext_ems_add_clienthello(const SSL_HANDSHAKE *hs, CBB *out) {
// Extended master secret is not necessary in TLS 1.3.
if (hs->min_version >= TLS1_3_VERSION) {
return true;
@@ -1016,8 +1018,8 @@
//
// https://tools.ietf.org/html/rfc5077
-static bool ext_ticket_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
- SSL *const ssl = hs->ssl;
+static bool ext_ticket_add_clienthello(const SSL_HANDSHAKE *hs, CBB *out) {
+ const SSL *const ssl = hs->ssl;
// TLS 1.3 uses a different ticket extension.
if (hs->min_version >= TLS1_3_VERSION ||
SSL_get_options(ssl) & SSL_OP_NO_TICKET) {
@@ -1094,7 +1096,7 @@
//
// https://tools.ietf.org/html/rfc5246#section-7.4.1.4.1
-static bool ext_sigalgs_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
+static bool ext_sigalgs_add_clienthello(const SSL_HANDSHAKE *hs, CBB *out) {
if (hs->max_version < TLS1_2_VERSION) {
return true;
}
@@ -1133,7 +1135,7 @@
//
// https://tools.ietf.org/html/rfc6066#section-8
-static bool ext_ocsp_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
+static bool ext_ocsp_add_clienthello(const SSL_HANDSHAKE *hs, CBB *out) {
if (!hs->config->ocsp_stapling_enabled) {
return true;
}
@@ -1215,8 +1217,8 @@
//
// https://htmlpreview.github.io/?https://github.com/agl/technotes/blob/master/nextprotoneg.html
-static bool ext_npn_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
- SSL *const ssl = hs->ssl;
+static bool ext_npn_add_clienthello(const SSL_HANDSHAKE *hs, CBB *out) {
+ const SSL *const ssl = hs->ssl;
if (ssl->s3->initial_handshake_complete ||
ssl->ctx->next_proto_select_cb == NULL ||
SSL_is_dtls(ssl)) {
@@ -1338,7 +1340,7 @@
//
// https://tools.ietf.org/html/rfc6962#section-3.3.1
-static bool ext_sct_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
+static bool ext_sct_add_clienthello(const SSL_HANDSHAKE *hs, CBB *out) {
if (!hs->config->signed_cert_timestamps_enabled) {
return true;
}
@@ -1429,8 +1431,8 @@
//
// https://tools.ietf.org/html/rfc7301
-static bool ext_alpn_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
- SSL *const ssl = hs->ssl;
+static bool ext_alpn_add_clienthello(const SSL_HANDSHAKE *hs, CBB *out) {
+ const SSL *const ssl = hs->ssl;
if (hs->config->alpn_client_proto_list.empty() && ssl->quic_method) {
// ALPN MUST be used with QUIC.
OPENSSL_PUT_ERROR(SSL, SSL_R_NO_APPLICATION_PROTOCOL);
@@ -1643,8 +1645,8 @@
//
// https://tools.ietf.org/html/draft-balfanz-tls-channelid-01
-static bool ext_channel_id_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
- SSL *const ssl = hs->ssl;
+static bool ext_channel_id_add_clienthello(const SSL_HANDSHAKE *hs, CBB *out) {
+ const SSL *const ssl = hs->ssl;
if (!hs->config->channel_id_private || SSL_is_dtls(ssl)) {
return true;
}
@@ -1709,8 +1711,8 @@
//
// https://tools.ietf.org/html/rfc5764
-static bool ext_srtp_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
- SSL *const ssl = hs->ssl;
+static bool ext_srtp_add_clienthello(const SSL_HANDSHAKE *hs, CBB *out) {
+ const SSL *const ssl = hs->ssl;
const STACK_OF(SRTP_PROTECTION_PROFILE) *profiles =
SSL_get_srtp_profiles(ssl);
if (profiles == NULL ||
@@ -1850,7 +1852,7 @@
//
// https://tools.ietf.org/html/rfc4492#section-5.1.2
-static bool ext_ec_point_add_extension(SSL_HANDSHAKE *hs, CBB *out) {
+static bool ext_ec_point_add_extension(const SSL_HANDSHAKE *hs, CBB *out) {
CBB contents, formats;
if (!CBB_add_u16(out, TLSEXT_TYPE_ec_point_formats) ||
!CBB_add_u16_length_prefixed(out, &contents) ||
@@ -1863,7 +1865,7 @@
return true;
}
-static bool ext_ec_point_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
+static bool ext_ec_point_add_clienthello(const SSL_HANDSHAKE *hs, CBB *out) {
// The point format extension is unnecessary in TLS 1.3.
if (hs->min_version >= TLS1_3_VERSION) {
return true;
@@ -1943,7 +1945,7 @@
}
static bool ext_pre_shared_key_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
- SSL *const ssl = hs->ssl;
+ const SSL *const ssl = hs->ssl;
hs->needs_psk_binder = false;
if (hs->max_version < TLS1_3_VERSION || ssl->session == nullptr ||
ssl_session_protocol_version(ssl->session.get()) < TLS1_3_VERSION) {
@@ -2095,7 +2097,7 @@
//
// https://tools.ietf.org/html/rfc8446#section-4.2.9
-static bool ext_psk_key_exchange_modes_add_clienthello(SSL_HANDSHAKE *hs,
+static bool ext_psk_key_exchange_modes_add_clienthello(const SSL_HANDSHAKE *hs,
CBB *out) {
if (hs->max_version < TLS1_3_VERSION) {
return true;
@@ -2139,8 +2141,8 @@
//
// https://tools.ietf.org/html/rfc8446#section-4.2.10
-static bool ext_early_data_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
- SSL *const ssl = hs->ssl;
+static bool ext_early_data_add_clienthello(const SSL_HANDSHAKE *hs, CBB *out) {
+ const SSL *const ssl = hs->ssl;
// The second ClientHello never offers early data, and we must have already
// filled in |early_data_reason| by this point.
if (ssl->s3->used_hello_retry_request) {
@@ -2301,7 +2303,7 @@
return CBBFinishArray(cbb.get(), &hs->key_share_bytes);
}
-static bool ext_key_share_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
+static bool ext_key_share_add_clienthello(const SSL_HANDSHAKE *hs, CBB *out) {
if (hs->max_version < TLS1_3_VERSION) {
return true;
}
@@ -2426,8 +2428,9 @@
//
// https://tools.ietf.org/html/rfc8446#section-4.2.1
-static bool ext_supported_versions_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
- SSL *const ssl = hs->ssl;
+static bool ext_supported_versions_add_clienthello(const SSL_HANDSHAKE *hs,
+ CBB *out) {
+ const SSL *const ssl = hs->ssl;
if (hs->max_version <= TLS1_2_VERSION) {
return true;
}
@@ -2458,7 +2461,7 @@
//
// https://tools.ietf.org/html/rfc8446#section-4.2.2
-static bool ext_cookie_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
+static bool ext_cookie_add_clienthello(const SSL_HANDSHAKE *hs, CBB *out) {
if (hs->cookie.empty()) {
return true;
}
@@ -2481,8 +2484,9 @@
// https://tools.ietf.org/html/rfc4492#section-5.1.1
// https://tools.ietf.org/html/rfc8446#section-4.2.7
-static bool ext_supported_groups_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
- SSL *const ssl = hs->ssl;
+static bool ext_supported_groups_add_clienthello(const SSL_HANDSHAKE *hs,
+ CBB *out) {
+ const SSL *const ssl = hs->ssl;
CBB contents, groups_bytes;
if (!CBB_add_u16(out, TLSEXT_TYPE_supported_groups) ||
!CBB_add_u16_length_prefixed(out, &contents) ||
@@ -2563,7 +2567,7 @@
// QUIC Transport Parameters
static bool ext_quic_transport_params_add_clienthello_impl(
- SSL_HANDSHAKE *hs, CBB *out, bool use_legacy_codepoint) {
+ const SSL_HANDSHAKE *hs, CBB *out, bool use_legacy_codepoint) {
if (hs->config->quic_transport_params.empty() && !hs->ssl->quic_method) {
return true;
}
@@ -2596,14 +2600,14 @@
return true;
}
-static bool ext_quic_transport_params_add_clienthello(SSL_HANDSHAKE *hs,
+static bool ext_quic_transport_params_add_clienthello(const SSL_HANDSHAKE *hs,
CBB *out) {
return ext_quic_transport_params_add_clienthello_impl(
hs, out, /*use_legacy_codepoint=*/false);
}
-static bool ext_quic_transport_params_add_clienthello_legacy(SSL_HANDSHAKE *hs,
- CBB *out) {
+static bool ext_quic_transport_params_add_clienthello_legacy(
+ const SSL_HANDSHAKE *hs, CBB *out) {
return ext_quic_transport_params_add_clienthello_impl(
hs, out, /*use_legacy_codepoint=*/true);
}
@@ -2749,7 +2753,7 @@
//
// https://tools.ietf.org/html/draft-ietf-tls-subcerts
-static bool ext_delegated_credential_add_clienthello(SSL_HANDSHAKE *hs,
+static bool ext_delegated_credential_add_clienthello(const SSL_HANDSHAKE *hs,
CBB *out) {
return true;
}
@@ -2779,7 +2783,8 @@
// Certificate compression
-static bool cert_compression_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
+static bool cert_compression_add_clienthello(const SSL_HANDSHAKE *hs,
+ CBB *out) {
bool first = true;
CBB contents, algs;
@@ -2897,8 +2902,8 @@
return false;
}
-static bool ext_alps_add_clienthello(SSL_HANDSHAKE *hs, CBB *out) {
- SSL *const ssl = hs->ssl;
+static bool ext_alps_add_clienthello(const SSL_HANDSHAKE *hs, CBB *out) {
+ const SSL *const ssl = hs->ssl;
if (// ALPS requires TLS 1.3.
hs->max_version < TLS1_3_VERSION ||
// Do not offer ALPS without ALPN.
