From: Thierry Quemerais Date: Thu, 19 Mar 2015 19:15:11 +0000 (+0100) Subject: Added a way to add custom extensions from public API. X-Git-Tag: gnutls_3_4_0~167 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=433e72f3dabae870cc0a0efa3a5ea34f2ff764a6;p=thirdparty%2Fgnutls.git Added a way to add custom extensions from public API. Signed-off-by: Thierry Quemerais --- diff --git a/lib/gnutls_extensions.c b/lib/gnutls_extensions.c index 3c5d45289a..0eb0403c88 100644 --- a/lib/gnutls_extensions.c +++ b/lib/gnutls_extensions.c @@ -730,3 +730,24 @@ _gnutls_ext_get_resumed_session_data(gnutls_session_t session, } return GNUTLS_E_INVALID_REQUEST; } + +int +gnutls_ext_register(const char *name, int type, gnutls_ext_parse_type_t parse_type, + gnutls_ext_recv_func recv_func, gnutls_ext_send_func send_func, + gnutls_ext_deinit_data_func deinit_func, gnutls_ext_pack_func pack_func, + gnutls_ext_unpack_func unpack_func, gnutls_ext_epoch_func epoch_func) +{ + extension_entry_st tmp_mod; + + tmp_mod.name = name; + tmp_mod.type = type; + tmp_mod.parse_type = parse_type; + tmp_mod.recv_func = recv_func; + tmp_mod.send_func = send_func; + tmp_mod.deinit_func = deinit_func; + tmp_mod.pack_func = pack_func; + tmp_mod.unpack_func = unpack_func; + tmp_mod.epoch_func = epoch_func; + + return _gnutls_ext_register(&tmp_mod); +} diff --git a/lib/gnutls_extensions.h b/lib/gnutls_extensions.h index 11c0faf1b4..01e865b27e 100644 --- a/lib/gnutls_extensions.h +++ b/lib/gnutls_extensions.h @@ -23,13 +23,7 @@ #ifndef GNUTLS_EXTENSIONS_H #define GNUTLS_EXTENSIONS_H -#include - -typedef int (*gnutls_ext_recv_func) (gnutls_session_t session, - const unsigned char *data, - size_t len); -typedef int (*gnutls_ext_send_func) (gnutls_session_t session, - gnutls_buffer_st * extdata); +#include int _gnutls_parse_extensions(gnutls_session_t session, gnutls_ext_parse_type_t parse_type, @@ -42,13 +36,6 @@ void _gnutls_ext_deinit(void); void _gnutls_extension_list_add(gnutls_session_t session, uint16_t type); -typedef void (*gnutls_ext_deinit_data_func) (extension_priv_data_t data); -typedef int (*gnutls_ext_pack_func) (extension_priv_data_t data, - gnutls_buffer_st * packed_data); -typedef int (*gnutls_ext_unpack_func) (gnutls_buffer_st * packed_data, - extension_priv_data_t * data); -typedef int (*gnutls_ext_epoch_func) (gnutls_session_t session); - void _gnutls_ext_free_session_data(gnutls_session_t session); /* functions to be used by extensions internally @@ -99,4 +86,9 @@ typedef struct { int _gnutls_ext_register(extension_entry_st *); +int gnutls_ext_register(const char *name, int type, gnutls_ext_parse_type_t parse_type, + gnutls_ext_recv_func recv_func, gnutls_ext_send_func send_func, + gnutls_ext_deinit_data_func deinit_func, gnutls_ext_pack_func pack_func, + gnutls_ext_unpack_func unpack_func, gnutls_ext_epoch_func epoch_func); + #endif diff --git a/lib/gnutls_int.h b/lib/gnutls_int.h index ced8fccce9..41ea3551c0 100644 --- a/lib/gnutls_int.h +++ b/lib/gnutls_int.h @@ -140,29 +140,6 @@ typedef struct { */ #define MAX_EXT_TYPES 32 - /** - * gnutls_ext_parse_type_t: - * @GNUTLS_EXT_NONE: Never parsed - * @GNUTLS_EXT_ANY: Any extension type. - * @GNUTLS_EXT_APPLICATION: Application extension. - * @GNUTLS_EXT_TLS: TLS-internal extension. - * @GNUTLS_EXT_MANDATORY: Extension parsed even if resuming (or extensions are disabled). - * - * Enumeration of different TLS extension types. This flag - * indicates for an extension whether it is useful to application - * level or TLS level only. This is (only) used to parse the - * application level extensions before the "client_hello" callback - * is called. - */ -typedef enum { - GNUTLS_EXT_ANY = 0, - GNUTLS_EXT_APPLICATION = 1, - GNUTLS_EXT_TLS = 2, - GNUTLS_EXT_MANDATORY = 3, - GNUTLS_EXT_NONE = 4 -} gnutls_ext_parse_type_t; - - /* expire time for resuming sessions */ #define DEFAULT_EXPIRE_TIME 3600 #define DEFAULT_HANDSHAKE_TIMEOUT_MS 40*1000 @@ -754,11 +731,6 @@ typedef struct { unsigned int packets_dropped; } dtls_st; -typedef union { - void *ptr; - uint32_t num; -} extension_priv_data_t; - typedef struct { /* holds all the parsed data received by the record layer */ mbuffer_head_st record_buffer; diff --git a/lib/gnutls_str.c b/lib/gnutls_str.c index b7434848c6..60f4d74196 100644 --- a/lib/gnutls_str.c +++ b/lib/gnutls_str.c @@ -114,6 +114,12 @@ static void align_allocd_with_data(gnutls_buffer_st * dest) dest->data = dest->allocd; } +int +gnutls_buffer_append_data(gnutls_buffer_st * dest, const void *data, size_t data_size) +{ + return _gnutls_buffer_append_data(dest, data, data_size); +} + int _gnutls_buffer_append_data(gnutls_buffer_st * dest, const void *data, size_t data_size) diff --git a/lib/gnutls_str.h b/lib/gnutls_str.h index f6268074d3..c264ad491e 100644 --- a/lib/gnutls_str.h +++ b/lib/gnutls_str.h @@ -33,7 +33,7 @@ void _gnutls_mem_cpy(char *dest, size_t dest_tot_size, const char *src, size_t src_size); void _gnutls_str_cat(char *dest, size_t dest_tot_size, const char *src); -typedef struct { +typedef struct gnutls_buffer{ uint8_t *allocd; /* pointer to allocated data */ uint8_t *data; /* API: pointer to data to copy from */ size_t max_length; diff --git a/lib/includes/gnutls/gnutls.h.in b/lib/includes/gnutls/gnutls.h.in index 665326ea31..048d5d2e36 100644 --- a/lib/includes/gnutls/gnutls.h.in +++ b/lib/includes/gnutls/gnutls.h.in @@ -2217,6 +2217,64 @@ void gnutls_certificate_set_pin_function(gnutls_certificate_credentials_t, gnutls_pin_callback_t fn, void *userdata); +/* Public string related functions */ +typedef struct gnutls_buffer gnutls_buffer_st; + +int gnutls_buffer_append_data(gnutls_buffer_st *, const void *data, size_t data_size); + +/* Public extensions related functions */ + +typedef union { + void *ptr; + int num; +} extension_priv_data_t; + +typedef int (*gnutls_ext_recv_func) (gnutls_session_t session, + const unsigned char *data, + size_t len); + +typedef int (*gnutls_ext_send_func) (gnutls_session_t session, + gnutls_buffer_st * extdata); + +typedef void (*gnutls_ext_deinit_data_func) (extension_priv_data_t data); + +typedef int (*gnutls_ext_pack_func) (extension_priv_data_t data, + gnutls_buffer_st * packed_data); + +typedef int (*gnutls_ext_unpack_func) (gnutls_buffer_st * packed_data, + extension_priv_data_t * data); + +typedef int (*gnutls_ext_epoch_func) (gnutls_session_t session); + +/** + * gnutls_ext_parse_type_t: + * @GNUTLS_EXT_NONE: Never parsed + * @GNUTLS_EXT_ANY: Any extension type. + * @GNUTLS_EXT_APPLICATION: Application extension. + * @GNUTLS_EXT_TLS: TLS-internal extension. + * @GNUTLS_EXT_MANDATORY: Extension parsed even if resuming (or extensions are disabled). + * + * Enumeration of different TLS extension types. This flag + * indicates for an extension whether it is useful to application + * level or TLS level only. This is (only) used to parse the + * application level extensions before the "client_hello" callback + * is called. + */ +typedef enum { + GNUTLS_EXT_ANY = 0, + GNUTLS_EXT_APPLICATION = 1, + GNUTLS_EXT_TLS = 2, + GNUTLS_EXT_MANDATORY = 3, + GNUTLS_EXT_NONE = 4 +} gnutls_ext_parse_type_t; + + /* Register a custom tls extension + */ +int gnutls_ext_register(const char *name, int type, gnutls_ext_parse_type_t parse_type, + gnutls_ext_recv_func recv_func, gnutls_ext_send_func send_func, + gnutls_ext_deinit_data_func deinit_func, gnutls_ext_pack_func pack_func, + gnutls_ext_unpack_func unpack_func, gnutls_ext_epoch_func epoch_func); + /* FIPS140-2 related functions */ int gnutls_fips140_mode_enabled(void); diff --git a/lib/libgnutls.map b/lib/libgnutls.map index f72c4bbf5b..3baf1c04f0 100644 --- a/lib/libgnutls.map +++ b/lib/libgnutls.map @@ -1019,6 +1019,8 @@ GNUTLS_3_4 gnutls_crypto_register_aead_cipher; gnutls_crypto_register_mac; gnutls_crypto_register_digest; + gnutls_ext_register; + gnutls_buffer_append_data; local: *; }; diff --git a/tests/mini-extension.c b/tests/mini-extension.c new file mode 100644 index 0000000000..7ec85d6e8f --- /dev/null +++ b/tests/mini-extension.c @@ -0,0 +1,314 @@ +/* + * Copyright (C) 2004-2012 Free Software Foundation, Inc. + * + * Author: Thierry Quemerais + * + * 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 General Public License + * along with GnuTLS; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + */ + +/* Parts copied from GnuTLS example programs. */ + +#ifdef HAVE_CONFIG_H +#include +#endif + +#include +#include + +#if defined(_WIN32) + +/* socketpair isn't supported on Win32. */ +int main(int argc, char **argv) +{ + exit(77); +} + +#else + +#include +#include +#include +#if !defined(_WIN32) +#include +#endif +#include +#include + +#include "utils.h" + +/* A very basic TLS client, with extension + */ + +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 + +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 const unsigned char ext_data[] = +{ + 0xFE, + 0xED +}; + +static int ext_recv_client_params(gnutls_session_t session, const unsigned char *buf, size_t buflen) +{ + if (buflen != sizeof(ext_data)) + fail("ext_recv_client_params: Invalid input buffer length\n"); + + if (memcmp(buf, ext_data, sizeof(ext_data)) != 0) + fail("ext_recv_client_params: Invalid input buffer data\n"); + + TLSEXT_TYPE_client_received = 1; + + return 0; //Success +} + +static int ext_send_client_params(gnutls_session_t session, gnutls_buffer_st * extdata) +{ + TLSEXT_TYPE_client_sent = 1; + gnutls_buffer_append_data(extdata, ext_data, sizeof(ext_data)); + return sizeof(ext_data); +} + +static int ext_recv_server_params(gnutls_session_t session, const unsigned char *buf, size_t buflen) +{ + if (buflen != sizeof(ext_data)) + fail("ext_recv_server_params: Invalid input buffer length\n"); + + if (memcmp(buf, ext_data, sizeof(ext_data)) != 0) + fail("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_st * 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) +{ + int ret; + gnutls_session_t session; + gnutls_certificate_credentials_t clientx509cred; + + global_init(); + gnutls_global_set_log_function(tls_log_func); + if (debug) + gnutls_global_set_log_level(4711); + + side = "client"; + + gnutls_certificate_allocate_credentials(&clientx509cred); + + /* Initialize TLS session + */ + gnutls_init(&session, GNUTLS_CLIENT); + + /* Use default priorities */ + gnutls_priority_set_direct(session, "PERFORMANCE:+ANON-ECDH:+ANON-DH", + NULL); + + /* put the anonymous credentials to the current session + */ + gnutls_credentials_set(session, GNUTLS_CRD_CERTIFICATE, + clientx509cred); + + gnutls_transport_set_int(session, sd); + + gnutls_ext_register("ext_client", TLSEXT_TYPE_SAMPLE, GNUTLS_EXT_TLS, ext_recv_client_params, ext_send_client_params, NULL, NULL, NULL, NULL); + + /* Perform the TLS handshake + */ + ret = gnutls_handshake(session); + + if (ret < 0) { + fail("client: Handshake failed\n"); + gnutls_perror(ret); + goto end; + } else { + if (debug) + success("client: Handshake was completed\n"); + } + + if (TLSEXT_TYPE_client_sent != 1 && TLSEXT_TYPE_client_received != 1) + fail("client: extension not properly sent/received\n"); + + gnutls_bye(session, GNUTLS_SHUT_RDWR); + +end: + close(sd); + + gnutls_deinit(session); + + gnutls_certificate_free_credentials(clientx509cred); + + gnutls_global_deinit(); +} + +/* This is a sample TLS 1.0 server, for extension + */ + +static unsigned char server_cert_pem[] = + "-----BEGIN CERTIFICATE-----\n" + "MIICVjCCAcGgAwIBAgIERiYdMTALBgkqhkiG9w0BAQUwGTEXMBUGA1UEAxMOR251\n" + "VExTIHRlc3QgQ0EwHhcNMDcwNDE4MTMyOTIxWhcNMDgwNDE3MTMyOTIxWjA3MRsw\n" + "GQYDVQQKExJHbnVUTFMgdGVzdCBzZXJ2ZXIxGDAWBgNVBAMTD3Rlc3QuZ251dGxz\n" + "Lm9yZzCBnDALBgkqhkiG9w0BAQEDgYwAMIGIAoGA17pcr6MM8C6pJ1aqU46o63+B\n" + "dUxrmL5K6rce+EvDasTaDQC46kwTHzYWk95y78akXrJutsoKiFV1kJbtple8DDt2\n" + "DZcevensf9Op7PuFZKBroEjOd35znDET/z3IrqVgbtm2jFqab7a+n2q9p/CgMyf1\n" + "tx2S5Zacc1LWn9bIjrECAwEAAaOBkzCBkDAMBgNVHRMBAf8EAjAAMBoGA1UdEQQT\n" + "MBGCD3Rlc3QuZ251dGxzLm9yZzATBgNVHSUEDDAKBggrBgEFBQcDATAPBgNVHQ8B\n" + "Af8EBQMDB6AAMB0GA1UdDgQWBBTrx0Vu5fglyoyNgw106YbU3VW0dTAfBgNVHSME\n" + "GDAWgBTpPBz7rZJu5gakViyi4cBTJ8jylTALBgkqhkiG9w0BAQUDgYEAaFEPTt+7\n" + "bzvBuOf7+QmeQcn29kT6Bsyh1RHJXf8KTk5QRfwp6ogbp94JQWcNQ/S7YDFHglD1\n" + "AwUNBRXwd3riUsMnsxgeSDxYBfJYbDLeohNBsqaPDJb7XailWbMQKfAbFQ8cnOxg\n" + "rOKLUQRWJ0K3HyXRMhbqjdLIaQiCvQLuizo=\n" "-----END CERTIFICATE-----\n"; + +const gnutls_datum_t server_cert = { server_cert_pem, + sizeof(server_cert_pem) +}; + +static unsigned char server_key_pem[] = + "-----BEGIN RSA PRIVATE KEY-----\n" + "MIICXAIBAAKBgQDXulyvowzwLqknVqpTjqjrf4F1TGuYvkrqtx74S8NqxNoNALjq\n" + "TBMfNhaT3nLvxqResm62ygqIVXWQlu2mV7wMO3YNlx696ex/06ns+4VkoGugSM53\n" + "fnOcMRP/PciupWBu2baMWppvtr6far2n8KAzJ/W3HZLllpxzUtaf1siOsQIDAQAB\n" + "AoGAYAFyKkAYC/PYF8e7+X+tsVCHXppp8AoP8TEZuUqOZz/AArVlle/ROrypg5kl\n" + "8YunrvUdzH9R/KZ7saNZlAPLjZyFG9beL/am6Ai7q7Ma5HMqjGU8kTEGwD7K+lbG\n" + "iomokKMOl+kkbY/2sI5Czmbm+/PqLXOjtVc5RAsdbgvtmvkCQQDdV5QuU8jap8Hs\n" + "Eodv/tLJ2z4+SKCV2k/7FXSKWe0vlrq0cl2qZfoTUYRnKRBcWxc9o92DxK44wgPi\n" + "oMQS+O7fAkEA+YG+K9e60sj1K4NYbMPAbYILbZxORDecvP8lcphvwkOVUqbmxOGh\n" + "XRmTZUuhBrJhJKKf6u7gf3KWlPl6ShKEbwJASC118cF6nurTjuLf7YKARDjNTEws\n" + "qZEeQbdWYINAmCMj0RH2P0mvybrsXSOD5UoDAyO7aWuqkHGcCLv6FGG+qwJAOVqq\n" + "tXdUucl6GjOKKw5geIvRRrQMhb/m5scb+5iw8A4LEEHPgGiBaF5NtJZLALgWfo5n\n" + "hmC8+G8F0F78znQtPwJBANexu+Tg5KfOnzSILJMo3oXiXhf5PqXIDmbN0BKyCKAQ\n" + "LfkcEcUbVfmDaHpvzwY9VEaoMOKVLitETXdNSxVpvWM=\n" + "-----END RSA PRIVATE KEY-----\n"; + +const gnutls_datum_t server_key = { server_key_pem, + sizeof(server_key_pem) +}; + +int err, ret; +char topbuf[512]; +gnutls_session_t session; +int optval = 1; + +static void server(int sd) +{ + gnutls_certificate_credentials_t serverx509cred; + + /* this must be called once in the program + */ + global_init(); + gnutls_global_set_log_function(tls_log_func); + if (debug) + gnutls_global_set_log_level(4711); + + side = "server"; + + gnutls_certificate_allocate_credentials(&serverx509cred); + gnutls_certificate_set_x509_key_mem(serverx509cred, + &server_cert, &server_key, + GNUTLS_X509_FMT_PEM); + + gnutls_init(&session, GNUTLS_SERVER); + + /* avoid calling all the priority functions, since the defaults + * are adequate. + */ + gnutls_priority_set_direct(session, "PERFORMANCE:+ANON-ECDH:+ANON-DH", + NULL); + + gnutls_credentials_set(session, GNUTLS_CRD_CERTIFICATE, + serverx509cred); + + gnutls_ext_register("ext_server", TLSEXT_TYPE_SAMPLE, GNUTLS_EXT_TLS, ext_recv_server_params, ext_send_server_params, NULL, NULL, NULL, NULL); + + gnutls_transport_set_int(session, sd); + ret = gnutls_handshake(session); + if (ret < 0) { + close(sd); + gnutls_deinit(session); + fail("server: Handshake has failed (%s)\n\n", + gnutls_strerror(ret)); + return; + } + if (debug) + success("server: Handshake was completed\n"); + + if (TLSEXT_TYPE_server_sent != 1 && TLSEXT_TYPE_server_received != 1) + fail("server: extension not properly sent/received\n"); + + /* do not wait for the peer to close the connection. + */ + gnutls_bye(session, GNUTLS_SHUT_WR); + + close(sd); + gnutls_deinit(session); + + gnutls_certificate_free_credentials(serverx509cred); + + gnutls_global_deinit(); + + if (debug) + success("server: finished\n"); +} + +void doit(void) +{ + pid_t child; + int sockets[2]; + + err = socketpair(AF_UNIX, SOCK_STREAM, 0, sockets); + if (err == -1) { + perror("socketpair"); + fail("socketpair failed\n"); + return; + } + + child = fork(); + if (child < 0) { + perror("fork"); + fail("fork"); + return; + } + + if (child) { + int status; + /* parent */ + server(sockets[0]); + wait(&status); + } else + client(sockets[1]); +} + +#endif /* _WIN32 */