Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ktls: forbid renegotiation #4229

Merged
merged 2 commits into from
Oct 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions error/s2n_errno.c
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,7 @@ static const char *no_such_error = "Internal s2n error";
ERR_ENTRY(S2N_ERR_KTLS_BAD_CMSG, "Error handling cmsghdr.") \
ERR_ENTRY(S2N_ERR_ATOMIC, "Atomic operations in this environment would require locking") \
ERR_ENTRY(S2N_ERR_TEST_ASSERTION, "Test assertion failed") \
ERR_ENTRY(S2N_ERR_KTLS_RENEG, "kTLS does not support secure renegotiation") \
/* clang-format on */

#define ERR_STR_CASE(ERR, str) \
Expand Down
1 change: 1 addition & 0 deletions error/s2n_errno.h
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,7 @@ typedef enum {
S2N_ERR_KTLS_UNSUPPORTED_CONN,
S2N_ERR_KTLS_ENABLE,
S2N_ERR_KTLS_BAD_CMSG,
S2N_ERR_KTLS_RENEG,
S2N_ERR_ATOMIC,
S2N_ERR_T_USAGE_END,
} s2n_error;
Expand Down
25 changes: 25 additions & 0 deletions tests/unit/s2n_ktls_test.c
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,12 @@ S2N_RESULT s2n_test_generate_fake_crypto_params(struct s2n_connection *conn)
return S2N_RESULT_OK;
}

static int s2n_test_reneg_cb(struct s2n_connection *conn, void *context,
s2n_renegotiate_response *response)
{
return S2N_SUCCESS;
}

int main(int argc, char **argv)
{
BEGIN_TEST();
Expand Down Expand Up @@ -327,6 +333,25 @@ int main(int argc, char **argv)
server_conn->managed_recv_io = true;
EXPECT_SUCCESS(s2n_connection_ktls_enable_recv(server_conn));
};

/* Fail if renegotiation potentially supported */
{
DEFER_CLEANUP(struct s2n_config *config = s2n_config_new(), s2n_config_ptr_free);

DEFER_CLEANUP(struct s2n_connection *client = s2n_connection_new(S2N_CLIENT),
s2n_connection_ptr_free);
EXPECT_OK(s2n_test_configure_connection_for_ktls(client));
EXPECT_SUCCESS(s2n_connection_set_config(client, config));

DEFER_CLEANUP(struct s2n_connection *server = s2n_connection_new(S2N_SERVER),
s2n_connection_ptr_free);
EXPECT_OK(s2n_test_configure_connection_for_ktls(server));
EXPECT_SUCCESS(s2n_connection_set_config(server, config));

EXPECT_SUCCESS(s2n_config_set_renegotiate_request_cb(config, s2n_test_reneg_cb, NULL));
EXPECT_FAILURE_WITH_ERRNO(s2n_connection_ktls_enable_recv(client), S2N_ERR_KTLS_RENEG);
lrstewart marked this conversation as resolved.
Show resolved Hide resolved
EXPECT_SUCCESS(s2n_connection_ktls_enable_recv(server));
};
};

/* Test s2n_ktls_init_aes128_gcm_crypto_info */
Expand Down
16 changes: 16 additions & 0 deletions tls/s2n_ktls.c
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
#include "tls/s2n_ktls.h"

#include "tls/s2n_prf.h"
#include "tls/s2n_tls.h"

/* Used for overriding setsockopt calls in testing */
s2n_setsockopt_fn s2n_setsockopt = setsockopt;
Expand Down Expand Up @@ -49,6 +50,8 @@ static S2N_RESULT s2n_ktls_validate(struct s2n_connection *conn, s2n_ktls_mode k
RESULT_ENSURE_REF(conn->secure->cipher_suite->record_alg);
const struct s2n_cipher *cipher = conn->secure->cipher_suite->record_alg->cipher;
RESULT_ENSURE_REF(cipher);
const struct s2n_config *config = conn->config;
RESULT_ENSURE_REF(config);

RESULT_ENSURE(s2n_ktls_is_supported_on_platform(), S2N_ERR_KTLS_UNSUPPORTED_PLATFORM);

Expand All @@ -66,6 +69,19 @@ static S2N_RESULT s2n_ktls_validate(struct s2n_connection *conn, s2n_ktls_mode k
/* Check if the cipher supports kTLS */
RESULT_ENSURE(cipher->ktls_supported, S2N_ERR_KTLS_UNSUPPORTED_CONN);

/* Renegotiation requires updating the keys, which kTLS doesn't currently support.
*
* Setting the renegotiation callback doesn't guarantee that a client will
* attempt to renegotiate. The callback can also be used to send warning alerts
* signaling that renegotiation was rejected. However, we can provide applications
* with a clearer signal earlier by preventing them from enabling ktls on a
* connection that MIGHT require renegotiation. We can relax this restriction
* later if necessary.
*/
bool may_receive_hello_request = s2n_result_is_ok(s2n_client_hello_request_validate(conn));
bool may_renegotiate = may_receive_hello_request && config->renegotiate_request_cb;
RESULT_ENSURE(!may_renegotiate, S2N_ERR_KTLS_RENEG);

/* kTLS I/O functionality is managed by s2n-tls. kTLS cannot be enabled if the
* application sets custom I/O (managed_send_io == false means application has
* set custom I/O).
Expand Down
2 changes: 2 additions & 0 deletions tls/s2n_renegotiate.c
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ S2N_RESULT s2n_renegotiate_validate(struct s2n_connection *conn)
RESULT_ENSURE(conn->mode == S2N_CLIENT, S2N_ERR_NO_RENEGOTIATION);
RESULT_ENSURE(conn->secure_renegotiation, S2N_ERR_NO_RENEGOTIATION);
RESULT_ENSURE(conn->handshake.renegotiation, S2N_ERR_INVALID_STATE);
RESULT_ENSURE(!conn->ktls_send_enabled, S2N_ERR_KTLS_RENEG);
RESULT_ENSURE(!conn->ktls_recv_enabled, S2N_ERR_KTLS_RENEG);
return S2N_RESULT_OK;
}

Expand Down
Loading