path: root/tests/tls-session-ext-register.c

/*
 * Copyright (C) 2004-2016 Free Software Foundation, Inc.
 *
 * Author: Thierry Quemerais, Nikos Mavrogiannopoulos
 *
 * This file is part of GnuTLS.
 *
 * GnuTLS is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * GnuTLS is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>
 */

/* This program tests whether an extension is exchanged when registered
 * at the session level */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <stdio.h>
#include <stdlib.h>

#if defined(_WIN32)

/* socketpair isn't supported on Win32. */
int main(int argc, char **argv)
{
	exit(77);
}

#else

#include <string.h>
#include <sys/types.h>
#include <sys/socket.h>
#if !defined(_WIN32)
#include <sys/wait.h>
#include <signal.h>
#endif
#include <unistd.h>
#include <gnutls/gnutls.h>
#include <assert.h>

#include "utils.h"
#include "cert-common.h"

const char *side = "";

static void tls_log_func(int level, const char *str)
{
	fprintf(stderr, "%s|<%d>| %s", side, level, str);
}

#define TLSEXT_TYPE_SAMPLE 0xF1
#define TLSEXT_TYPE_IGN 0xF2

static int TLSEXT_TYPE_client_sent = 0;
static int TLSEXT_TYPE_client_received = 0;
static int TLSEXT_TYPE_server_sent = 0;
static int TLSEXT_TYPE_server_received = 0;
static int ign_extension_called = 0;

static void reset_vars(void)
{
	TLSEXT_TYPE_client_sent = 0;
	TLSEXT_TYPE_client_received = 0;
	TLSEXT_TYPE_server_sent = 0;
	TLSEXT_TYPE_server_received = 0;
	ign_extension_called = 0;
}

static const unsigned char ext_data[] = { 0xFE, 0xED };

#define myfail(fmt, ...) fail("%s: " fmt, name, ##__VA_ARGS__)

static int ext_recv_client_params(gnutls_session_t session,
				  const unsigned char *buf, size_t buflen)
{
	const char *name;
	name = gnutls_session_get_ptr(session);

	if (buflen != sizeof(ext_data))
		myfail("ext_recv_client_params: Invalid input buffer length\n");

	if (memcmp(buf, ext_data, sizeof(ext_data)) != 0)
		myfail("ext_recv_client_params: Invalid input buffer data\n");

	TLSEXT_TYPE_client_received = 1;

	gnutls_ext_set_data(session, TLSEXT_TYPE_SAMPLE, session);

	return 0; //Success
}

static int ext_send_client_params(gnutls_session_t session,
				  gnutls_buffer_t extdata)
{
	TLSEXT_TYPE_client_sent = 1;
	gnutls_buffer_append_data(extdata, ext_data, sizeof(ext_data));
	return sizeof(ext_data);
}

static int ext_recv_client_ign_params(gnutls_session_t session,
				      const unsigned char *buf, size_t buflen)
{
	return 0;
}

static int ext_send_client_ign_params(gnutls_session_t session,
				      gnutls_buffer_t extdata)
{
	ign_extension_called = 1;
	return 0;
}

static int ext_recv_server_params(gnutls_session_t session,
				  const unsigned char *buf, size_t buflen)
{
	const char *name;

	name = gnutls_session_get_ptr(session);

	if (buflen != sizeof(ext_data))
		myfail("ext_recv_server_params: Invalid input buffer length\n");

	if (memcmp(buf, ext_data, sizeof(ext_data)) != 0)
		myfail("ext_recv_server_params: Invalid input buffer data\n");

	TLSEXT_TYPE_server_received = 1;

	return 0; //Success
}

static int ext_send_server_params(gnutls_session_t session,
				  gnutls_buffer_t extdata)
{
	TLSEXT_TYPE_server_sent = 1;
	gnutls_buffer_append_data(extdata, ext_data, sizeof(ext_data));
	return sizeof(ext_data);
}

static void client(int sd, const char *name, const char *prio, unsigned flags,
		   unsigned expected_ok)
{
	int ret;
	gnutls_session_t session;
	gnutls_certificate_credentials_t clientx509cred;
	const char *ext_name;
	void *p;

	side = "client";

	assert(gnutls_certificate_allocate_credentials(&clientx509cred) >= 0);

	/* Initialize TLS session
	 */
	assert(gnutls_init(&session, GNUTLS_CLIENT) >= 0);
	gnutls_session_set_ptr(session, (void *)name);

	/* Use default priorities */
	assert(gnutls_priority_set_direct(session, prio, NULL) >= 0);

	/* put the anonymous credentials to the current session
	 */
	gnutls_credentials_set(session, GNUTLS_CRD_CERTIFICATE, clientx509cred);

	gnutls_transport_set_int(session, sd);
	gnutls_handshake_set_timeout(session, get_timeout());

	ret = gnutls_session_ext_register(session, "ext_ign", TLSEXT_TYPE_IGN,
					  GNUTLS_EXT_TLS,
					  ext_recv_client_ign_params,
					  ext_send_client_ign_params, NULL,
					  NULL, NULL, flags);
	if (ret < 0)
		myfail("client: register extension\n");

	ext_name =
		gnutls_ext_get_name2(session, TLSEXT_TYPE_IGN, GNUTLS_EXT_ANY);
	if (ext_name == NULL || strcmp(ext_name, "ext_ign"))
		myfail("client: retrieve name of extension %u\n",
		       TLSEXT_TYPE_IGN);

	ext_name = gnutls_ext_get_name2(session, TLSEXT_TYPE_IGN,
					GNUTLS_EXT_APPLICATION);
	if (ext_name)
		myfail("client: retrieve name of extension %u (expected none)\n",
		       TLSEXT_TYPE_IGN);

	ret = gnutls_session_ext_register(session, "ext_client",
					  TLSEXT_TYPE_SAMPLE, GNUTLS_EXT_TLS,
					  ext_recv_client_params,
					  ext_send_client_params, NULL, NULL,
					  NULL, flags);
	if (ret < 0)
		myfail("client: register extension\n");

	/* Perform the TLS handshake
	 */
	ret = gnutls_handshake(session);

	if (ret < 0) {
		if (!expected_ok) {
			if (debug)
				success("client: handshake failed as expected: %s\n",
					gnutls_strerror(ret));
		} else {
			myfail("client: Handshake failed: %s\n",
			       gnutls_strerror(ret));
		}
		goto end;
	} else {
		if (debug)
			success("client: Handshake was completed\n");
	}

	if (TLSEXT_TYPE_client_sent != 1 || TLSEXT_TYPE_client_received != 1) {
		if (expected_ok) {
			myfail("client: extension not properly sent/received\n");
		} else {
			goto end;
		}
	}

	ret = gnutls_ext_get_data(session, TLSEXT_TYPE_SAMPLE, &p);
	if (ret < 0) {
		myfail("gnutls_ext_get_data: %s\n", gnutls_strerror(ret));
	}

	if (p != session) {
		myfail("client: gnutls_ext_get_data failed\n");
	}

	if (ign_extension_called == 0) {
		myfail("registered ign extension was not called\n");
	}

	gnutls_bye(session, GNUTLS_SHUT_RDWR);

	if (!expected_ok)
		myfail("client: expected failure but succeeded!\n");

end:
	close(sd);

	gnutls_deinit(session);

	gnutls_certificate_free_credentials(clientx509cred);
}

static void server(int sd, const char *name, const char *prio, unsigned flags,
		   unsigned expected_ok)
{
	gnutls_certificate_credentials_t serverx509cred;
	int ret;
	gnutls_session_t session;

	side = "server";

	assert(gnutls_certificate_allocate_credentials(&serverx509cred) >= 0);
	assert(gnutls_certificate_set_x509_key_mem(serverx509cred, &server_cert,
						   &server_key,
						   GNUTLS_X509_FMT_PEM) >= 0);

	assert(gnutls_init(&session, GNUTLS_SERVER) >= 0);
	gnutls_session_set_ptr(session, (void *)name);

	/* avoid calling all the priority functions, since the defaults
	 * are adequate.
	 */
	assert(gnutls_priority_set_direct(session, prio, NULL) >= 0);

	gnutls_credentials_set(session, GNUTLS_CRD_CERTIFICATE, serverx509cred);

	assert(gnutls_session_ext_register(
		       session, "ext_server", TLSEXT_TYPE_SAMPLE,
		       GNUTLS_EXT_TLS, ext_recv_server_params,
		       ext_send_server_params, NULL, NULL, NULL, flags) >= 0);

	gnutls_transport_set_int(session, sd);
	gnutls_handshake_set_timeout(session, get_timeout());

	ret = gnutls_handshake(session);
	if (ret < 0) {
		if (!expected_ok) {
			if (debug)
				success("server: handshake failed as expected: %s\n",
					gnutls_strerror(ret));
			goto cleanup;
		} else {
			close(sd);
			gnutls_deinit(session);
			myfail("server: Handshake has failed (%s)\n",
			       gnutls_strerror(ret));
		}
		return;
	}
	if (debug)
		success("server: Handshake was completed\n");

	if (TLSEXT_TYPE_server_sent != 1 || TLSEXT_TYPE_server_received != 1) {
		if (expected_ok)
			myfail("server: extension not properly sent/received\n");
		else
			goto cleanup;
	}

	/* do not wait for the peer to close the connection.
	 */
	gnutls_bye(session, GNUTLS_SHUT_WR);

	if (!expected_ok)
		myfail("server: expected failure but succeeded!\n");

cleanup:
	close(sd);
	gnutls_deinit(session);

	gnutls_certificate_free_credentials(serverx509cred);

	if (debug)
		success("server: finished\n");
}

#define try_common(name, prio, flags, sok, cok) \
	try(name, prio, flags, flags, sok, cok)

static void try(const char *name, const char *prio, unsigned server_flags,
		unsigned client_flags, unsigned server_ok, unsigned client_ok)
{
	pid_t child;
	int sockets[2];
	int err;

	success("Testing: %s: ", name);
	reset_vars();

	err = socketpair(AF_UNIX, SOCK_STREAM, 0, sockets);
	if (err == -1) {
		perror("socketpair");
		myfail("socketpair failed\n");
		return;
	}

	child = fork();
	if (child < 0) {
		perror("fork");
		myfail("fork");
		return;
	}

	if (child) {
		int status;
		/* parent */
		close(sockets[1]);
		server(sockets[0], name, prio, server_flags, server_ok);
		wait(&status);
		check_wait_status(status);
		success("ok");
	} else {
		close(sockets[0]);
		client(sockets[1], name, prio, client_flags, client_ok);
		_exit(0);
	}

	success("\n");
}

void doit(void)
{
	unsigned i;
	int ret;

	signal(SIGPIPE, SIG_IGN);

	global_init();
	gnutls_global_set_log_function(tls_log_func);
	if (debug)
		gnutls_global_set_log_level(5);

	try_common("TLS1.2 both ways (default)",
		   "NORMAL:+ANON-ECDH:-VERS-TLS-ALL:+VERS-TLS1.2", 0, 1, 1);
	try_common("TLS1.2 both ways",
		   "NORMAL:+ANON-ECDH:-VERS-TLS-ALL:+VERS-TLS1.2",
		   GNUTLS_EXT_FLAG_CLIENT_HELLO |
			   GNUTLS_EXT_FLAG_TLS12_SERVER_HELLO,
		   1, 1);

	try_common("TLS1.2 client only",
		   "NORMAL:+ANON-ECDH:-VERS-TLS-ALL:+VERS-TLS1.2",
		   GNUTLS_EXT_FLAG_CLIENT_HELLO, 0, 0);
	try_common("TLS1.2 client and TLS 1.3 server",
		   "NORMAL:+ANON-ECDH:-VERS-TLS-ALL:+VERS-TLS1.2",
		   GNUTLS_EXT_FLAG_CLIENT_HELLO |
			   GNUTLS_EXT_FLAG_TLS13_SERVER_HELLO,
		   0, 0);
	try_common("TLS1.2 server only",
		   "NORMAL:+ANON-ECDH:-VERS-TLS-ALL:+VERS-TLS1.2",
		   GNUTLS_EXT_FLAG_TLS12_SERVER_HELLO, 0, 0);

	try("TLS1.2 client rejects",
	    "NORMAL:+ANON-ECDH:-VERS-TLS-ALL:+VERS-TLS1.2",
	    GNUTLS_EXT_FLAG_CLIENT_HELLO | GNUTLS_EXT_FLAG_TLS12_SERVER_HELLO,
	    GNUTLS_EXT_FLAG_CLIENT_HELLO, 0, 0);
	try("TLS1.2 never on client hello",
	    "NORMAL:+ANON-ECDH:-VERS-TLS-ALL:+VERS-TLS1.2",
	    GNUTLS_EXT_FLAG_TLS12_SERVER_HELLO, GNUTLS_EXT_FLAG_CLIENT_HELLO, 0,
	    0);

	/* check whether we can crash the library by adding many extensions */
	success("Testing: register many global extensions\n");
	for (i = 0; i < 64; i++) {
		ret = gnutls_ext_register(
			"ext_serverxx", TLSEXT_TYPE_SAMPLE + i + 1,
			GNUTLS_EXT_TLS, ext_recv_server_params,
			ext_send_server_params, NULL, NULL, NULL);
		if (ret < 0) {
			success("failed registering extension no %d (expected)\n",
				i + 1);
			break;
		}
	}

	gnutls_global_deinit();
}

#endif /* _WIN32 */