static char *cert = NULL;
static char *privkey = NULL;
+#define LOG_BUFFER_SIZE 1024
+static char server_log_buffer[LOG_BUFFER_SIZE + 1] = {0};
+static int server_log_buffer_index = 0;
+static char client_log_buffer[LOG_BUFFER_SIZE + 1] = {0};
+static int client_log_buffer_index = 0;
+static int error_writing_log = 0;
+
#ifndef OPENSSL_NO_OCSP
static const unsigned char orespder[] = "Dummy OCSP Response";
static int ocsp_server_called = 0;
#define NUM_EXTRA_CERTS 40
+/*
+ * This structure is used to validate that the correct number of log messages
+ * of various types are emitted when emitting secret logs.
+ */
+struct sslapitest_log_counts {
+ unsigned int rsa_key_exchange_count;
+ unsigned int master_secret_count;
+ unsigned int client_handshake_secret_count;
+ unsigned int server_handshake_secret_count;
+ unsigned int client_application_secret_count;
+ unsigned int server_application_secret_count;
+};
+
+static void client_keylog_callback(const SSL *ssl, const char *line) {
+ int line_length = strlen(line);
+
+ /* If the log doesn't fit, error out. */
+ if ((client_log_buffer_index + line_length) > LOG_BUFFER_SIZE) {
+ printf("No room in client log\n");
+ error_writing_log = 1;
+ return;
+ }
+
+ strcat(client_log_buffer, line);
+ client_log_buffer_index += line_length;
+ client_log_buffer[client_log_buffer_index] = '\n';
+ client_log_buffer_index += 1;
+
+ return;
+}
+
+static void server_keylog_callback(const SSL *ssl, const char *line) {
+ int line_length = strlen(line);
+
+ /* If the log doesn't fit, error out. */
+ if ((server_log_buffer_index + line_length) > LOG_BUFFER_SIZE) {
+ printf("No room in server log\n");
+ error_writing_log = 1;
+ return;
+ }
+
+ strcat(server_log_buffer, line);
+ server_log_buffer_index += line_length;
+ server_log_buffer[server_log_buffer_index] = '\n';
+ server_log_buffer_index += 1;
+
+ return;
+}
+
+static int compare_hex_encoded_buffer(const char *hex_encoded,
+ size_t hex_length,
+ const uint8_t *raw,
+ size_t raw_length) {
+ size_t i;
+ size_t j;
+
+ /* One byte too big, just to be safe. */
+ char hexed[3] = {0};
+
+ if ((raw_length * 2) != hex_length) {
+ printf("Inconsistent hex encoded lengths.\n");
+ return 1;
+ }
+
+ for (i = j = 0; (i < raw_length) && ((j + 1) < hex_length); i++) {
+ sprintf(hexed, "%02x", raw[i]);
+ if ((hexed[0] != hex_encoded[j]) || (hexed[1] != hex_encoded[j + 1])) {
+ printf("Hex output does not match.\n");
+ return 1;
+ }
+ j += 2;
+ }
+
+ return 0;
+}
+
+static int test_keylog_output(char *buffer, const SSL *ssl,
+ const SSL_SESSION *session,
+ struct sslapitest_log_counts *expected) {
+ char *token = NULL;
+ unsigned char actual_client_random[SSL3_RANDOM_SIZE] = {0};
+ size_t client_random_size = SSL3_RANDOM_SIZE;
+ unsigned char actual_master_key[SSL_MAX_MASTER_KEY_LENGTH] = {0};
+ size_t master_key_size = SSL_MAX_MASTER_KEY_LENGTH;
+ unsigned int rsa_key_exchange_count = 0;
+ unsigned int master_secret_count = 0;
+ unsigned int client_handshake_secret_count = 0;
+ unsigned int server_handshake_secret_count = 0;
+ unsigned int client_application_secret_count = 0;
+ unsigned int server_application_secret_count = 0;
+
+ token = strtok(buffer, " \n");
+ while (token) {
+ if (strcmp(token, "RSA") == 0) {
+ /*
+ * Premaster secret. Tokens should be: 16 ASCII bytes of
+ * hex-encoded encrypted secret, then the hex-encoded pre-master
+ * secret.
+ */
+ token = strtok(NULL, " \n");
+ if (!token) {
+ printf("Unexpectedly short premaster secret log.\n");
+ return 0;
+ }
+ if (strlen(token) != 16) {
+ printf("Bad value for encrypted secret: %s\n", token);
+ return 0;
+ }
+ token = strtok(NULL, " \n");
+ if (!token) {
+ printf("Unexpectedly short premaster secret log.\n");
+ return 0;
+ }
+ /*
+ * We can't sensibly check the log because the premaster secret is
+ * transient, and OpenSSL doesn't keep hold of it once the master
+ * secret is generated.
+ */
+ rsa_key_exchange_count++;
+ } else if (strcmp(token, "CLIENT_RANDOM") == 0) {
+ /*
+ * Master secret. Tokens should be: 64 ASCII bytes of hex-encoded
+ * client random, then the hex-encoded master secret.
+ */
+ client_random_size = SSL_get_client_random(ssl,
+ actual_client_random,
+ SSL3_RANDOM_SIZE);
+ if (client_random_size != SSL3_RANDOM_SIZE) {
+ printf("Unexpected short client random.\n");
+ return 0;
+ }
+
+ token = strtok(NULL, " \n");
+ if (!token) {
+ printf("Unexpected short master secret log.\n");
+ return 0;
+ }
+ if (strlen(token) != 64) {
+ printf("Bad value for client random: %s\n", token);
+ return 0;
+ }
+ if (compare_hex_encoded_buffer(token, 64, actual_client_random,
+ client_random_size)) {
+ printf("Bad value for client random: %s\n", token);
+ return 0;
+ }
+
+ token = strtok(NULL, " \n");
+ if (!token) {
+ printf("Unexpectedly short master secret log.\n");
+ return 0;
+ }
+
+ master_key_size = SSL_SESSION_get_master_key(session,
+ actual_master_key,
+ master_key_size);
+ if (!master_key_size) {
+ printf("Error getting master key to compare.\n");
+ return 0;
+ }
+ if (compare_hex_encoded_buffer(token, strlen(token),
+ actual_master_key,
+ master_key_size)) {
+ printf("Bad value for master key: %s\n", token);
+ return 0;
+ }
+
+ master_secret_count++;
+ } else if ((strcmp(token, "CLIENT_HANDSHAKE_TRAFFIC_SECRET") == 0) ||
+ (strcmp(token, "SERVER_HANDSHAKE_TRAFFIC_SECRET") == 0) ||
+ (strcmp(token, "CLIENT_TRAFFIC_SECRET_0") == 0) ||
+ (strcmp(token, "SERVER_TRAFFIC_SECRET_0") == 0)) {
+ /*
+ * TLSv1.3 secret. Tokens should be: 64 ASCII bytes of hex-encoded
+ * client random, and then the hex-encoded secret. In this case,
+ * we treat all of these secrets identically and then just
+ * distinguish between them when counting what we saw.
+ */
+ if (strcmp(token, "CLIENT_HANDSHAKE_TRAFFIC_SECRET") == 0)
+ client_handshake_secret_count++;
+ else if (strcmp(token, "SERVER_HANDSHAKE_TRAFFIC_SECRET") == 0)
+ server_handshake_secret_count++;
+ else if (strcmp(token, "CLIENT_TRAFFIC_SECRET_0") == 0)
+ client_application_secret_count++;
+ else if (strcmp(token, "SERVER_TRAFFIC_SECRET_0") == 0)
+ server_application_secret_count++;
+
+ client_random_size = SSL_get_client_random(ssl,
+ actual_client_random,
+ SSL3_RANDOM_SIZE);
+ if (client_random_size != SSL3_RANDOM_SIZE) {
+ printf("Unexpected short client random.\n");
+ return 0;
+ }
+
+ token = strtok(NULL, " \n");
+ if (!token) {
+ printf("Unexpected short client handshake secret log.\n");
+ return 0;
+ }
+ if (strlen(token) != 64) {
+ printf("Bad value for client random: %s\n", token);
+ return 0;
+ }
+ if (compare_hex_encoded_buffer(token, 64, actual_client_random,
+ client_random_size)) {
+ printf("Bad value for client random: %s\n", token);
+ return 0;
+ }
+
+ token = strtok(NULL, " \n");
+ if (!token) {
+ printf("Unexpectedly short master secret log.\n");
+ return 0;
+ }
+
+ /*
+ * TODO(TLS1.3): test that application traffic secrets are what
+ * we expect */
+ } else {
+ printf("Unexpected token in buffer: %s\n", token);
+ return 0;
+ }
+
+ token = strtok(NULL, " \n");
+ }
+
+ /* Return whether we got what we expected. */
+ return ((rsa_key_exchange_count == expected->rsa_key_exchange_count) &&
+ (master_secret_count == expected->master_secret_count) &&
+ (client_handshake_secret_count == expected->client_handshake_secret_count) &&
+ (server_handshake_secret_count == expected->server_handshake_secret_count) &&
+ (client_application_secret_count == expected->client_application_secret_count) &&
+ (server_application_secret_count == expected->server_application_secret_count));
+}
+
+static int test_keylog(void) {
+ SSL_CTX *cctx = NULL, *sctx = NULL;
+ SSL *clientssl = NULL, *serverssl = NULL;
+ int testresult = 0;
+ int rc;
+ struct sslapitest_log_counts expected = {0};
+
+ /* Clean up logging space */
+ memset(client_log_buffer, 0, LOG_BUFFER_SIZE + 1);
+ memset(server_log_buffer, 0, LOG_BUFFER_SIZE + 1);
+ client_log_buffer_index = 0;
+ server_log_buffer_index = 0;
+ error_writing_log = 0;
+
+ if (!create_ssl_ctx_pair(TLS_server_method(), TLS_client_method(), &sctx,
+ &cctx, cert, privkey)) {
+ printf("Unable to create SSL_CTX pair\n");
+ return 0;
+ }
+
+ /* We cannot log the master secret for TLSv1.3, so we should forbid it. */
+ SSL_CTX_set_options(cctx, SSL_OP_NO_TLSv1_3);
+ SSL_CTX_set_options(sctx, SSL_OP_NO_TLSv1_3);
+
+ /* We also want to ensure that we use RSA-based key exchange. */
+ rc = SSL_CTX_set_cipher_list(cctx, "RSA");
+ if (rc == 0) {
+ printf("Unable to restrict to RSA key exchange.\n");
+ goto end;
+ }
+
+ if (SSL_CTX_get_keylog_callback(cctx)) {
+ printf("Unexpected initial value for client "
+ "SSL_CTX_get_keylog_callback()\n");
+ goto end;
+ }
+ if (SSL_CTX_get_keylog_callback(sctx)) {
+ printf("Unexpected initial value for server "
+ "SSL_CTX_get_keylog_callback()\n");
+ goto end;
+ }
+
+ SSL_CTX_set_keylog_callback(cctx, client_keylog_callback);
+ SSL_CTX_set_keylog_callback(sctx, server_keylog_callback);
+
+ if (SSL_CTX_get_keylog_callback(cctx) != client_keylog_callback) {
+ printf("Unexpected set value for client "
+ "SSL_CTX_get_keylog_callback()\n");
+ }
+
+ if (SSL_CTX_get_keylog_callback(sctx) != server_keylog_callback) {
+ printf("Unexpected set value for server "
+ "SSL_CTX_get_keylog_callback()\n");
+ }
+
+ /* Now do a handshake and check that the logs have been written to. */
+ if (!create_ssl_objects(sctx, cctx, &serverssl, &clientssl, NULL, NULL)) {
+ printf("Unable to create SSL objects\n");
+ goto end;
+ }
+
+ if (!create_ssl_connection(serverssl, clientssl)) {
+ printf("Unable to create SSL connection\n");
+ goto end;
+ }
+
+ if (error_writing_log) {
+ printf("Error encountered while logging\n");
+ goto end;
+ }
+
+ if ((client_log_buffer_index == 0) || (server_log_buffer_index == 0)) {
+ printf("No logs written\n");
+ goto end;
+ }
+
+ /*
+ * Now we want to test that our output data was vaguely sensible. We
+ * do that by using strtok and confirming that we have more or less the
+ * data we expect. For both client and server, we expect to see one master
+ * secret. The client should also see a RSA key exchange.
+ */
+ expected.rsa_key_exchange_count = 1;
+ expected.master_secret_count = 1;
+ if (!test_keylog_output(client_log_buffer, clientssl,
+ SSL_get_session(clientssl), &expected)) {
+ printf("Error encountered in client log buffer\n");
+ goto end;
+ }
+
+ expected.rsa_key_exchange_count = 0;
+ if (!test_keylog_output(server_log_buffer, serverssl,
+ SSL_get_session(serverssl), &expected)) {
+ printf("Error encountered in server log buffer\n");
+ goto end;
+ }
+
+ testresult = 1;
+
+end:
+ SSL_free(serverssl);
+ SSL_free(clientssl);
+ SSL_CTX_free(sctx);
+ SSL_CTX_free(cctx);
+
+ return testresult;
+}
+
+#ifndef OPENSSL_NO_TLS1_3
+static int test_keylog_no_master_key(void) {
+ SSL_CTX *cctx = NULL, *sctx = NULL;
+ SSL *clientssl = NULL, *serverssl = NULL;
+ int testresult = 0;
+ struct sslapitest_log_counts expected = {0};
+
+ /* Clean up logging space */
+ memset(client_log_buffer, 0, LOG_BUFFER_SIZE + 1);
+ memset(server_log_buffer, 0, LOG_BUFFER_SIZE + 1);
+ client_log_buffer_index = 0;
+ server_log_buffer_index = 0;
+ error_writing_log = 0;
+
+ if (!create_ssl_ctx_pair(TLS_server_method(), TLS_client_method(), &sctx,
+ &cctx, cert, privkey)) {
+ printf("Unable to create SSL_CTX pair\n");
+ return 0;
+ }
+
+ if (SSL_CTX_get_keylog_callback(cctx)) {
+ printf("Unexpected initial value for client "
+ "SSL_CTX_get_keylog_callback()\n");
+ goto end;
+ }
+ if (SSL_CTX_get_keylog_callback(sctx)) {
+ printf("Unexpected initial value for server "
+ "SSL_CTX_get_keylog_callback()\n");
+ goto end;
+ }
+
+ SSL_CTX_set_keylog_callback(cctx, client_keylog_callback);
+ SSL_CTX_set_keylog_callback(sctx, server_keylog_callback);
+
+ if (SSL_CTX_get_keylog_callback(cctx) != client_keylog_callback) {
+ printf("Unexpected set value for client "
+ "SSL_CTX_get_keylog_callback()\n");
+ }
+
+ if (SSL_CTX_get_keylog_callback(sctx) != server_keylog_callback) {
+ printf("Unexpected set value for server "
+ "SSL_CTX_get_keylog_callback()\n");
+ }
+
+ /* Now do a handshake and check that the logs have been written to. */
+ if (!create_ssl_objects(sctx, cctx, &serverssl, &clientssl, NULL, NULL)) {
+ printf("Unable to create SSL objects\n");
+ goto end;
+ }
+
+ if (!create_ssl_connection(serverssl, clientssl)) {
+ printf("Unable to create SSL connection\n");
+ goto end;
+ }
+
+ if (error_writing_log) {
+ printf("Error encountered while logging\n");
+ goto end;
+ }
+
+ /*
+ * Now we want to test that our output data was vaguely sensible. For this
+ * test, we expect no CLIENT_RANDOM entry becuase it doesn't make sense for
+ * TLSv1.3, but we do expect both client and server to emit keys.
+ */
+ expected.client_handshake_secret_count = 1;
+ expected.server_handshake_secret_count = 1;
+ expected.client_application_secret_count = 1;
+ expected.server_application_secret_count = 1;
+ if (!test_keylog_output(client_log_buffer, clientssl,
+ SSL_get_session(clientssl), &expected)) {
+ printf("Error encountered in client log buffer\n");
+ goto end;
+ }
+ if (!test_keylog_output(server_log_buffer, serverssl,
+ SSL_get_session(serverssl), &expected)) {
+ printf("Error encountered in server log buffer\n");
+ goto end;
+ }
+
+ testresult = 1;
+
+end:
+ SSL_free(serverssl);
+ SSL_free(clientssl);
+ SSL_CTX_free(sctx);
+ SSL_CTX_free(cctx);
+
+ return testresult;
+}
+#endif
+
static int execute_test_large_message(const SSL_METHOD *smeth,
const SSL_METHOD *cmeth, int read_ahead)
{
SSL_CTX_set_min_proto_version(cctx, TLS1_2_VERSION);
#endif
- /*
- * TODO(TLS1.3): Test temporarily disabled for TLS1.3 until we've
- * implemented session resumption.
- */
- SSL_CTX_set_max_proto_version(cctx, TLS1_2_VERSION);
-
/* Set up session cache */
if (fix.use_ext_cache) {
SSL_CTX_sess_set_new_cb(cctx, new_session_cb);
ADD_TEST(test_ssl_bio_change_rbio);
ADD_TEST(test_ssl_bio_change_wbio);
ADD_ALL_TESTS(test_set_sigalgs, OSSL_NELEM(testsigalgs) * 2);
+ ADD_TEST(test_keylog);
+#ifndef OPENSSL_NO_TLS1_3
+ ADD_TEST(test_keylog_no_master_key);
+#endif
testresult = run_tests(argv[0]);
projects / openssl.git / blobdiff