diff --git a/Source/charon/generator.c b/Source/charon/generator.c index 523af80a6..4acec7265 100644 --- a/Source/charon/generator.c +++ b/Source/charon/generator.c @@ -37,6 +37,7 @@ #include "payloads/transform_substructure.h" #include "payloads/sa_payload.h" #include "payloads/ke_payload.h" +#include "payloads/notify_payload.h" extern logger_manager_t *global_logger_manager; @@ -671,6 +672,8 @@ static status_t generate_payload (private_generator_t *this,payload_t *payload) /* get payload type */ payload_type = payload->get_type(payload); + /* spi size has to get reseted */ + this->last_spi_size = 0; this->logger->log(this->logger,CONTROL,"Start generating payload of type %s",mapping_find(payload_type_t_mappings,payload_type)); @@ -746,7 +749,6 @@ static status_t generate_payload (private_generator_t *this,payload_t *payload) return status; } - /* before iterative generate the transforms, store the current payload length position */ u_int32_t payload_length_position_offset = this->last_payload_length_position_offset; /* Length of KE_PAYLOAD is calculated */ u_int16_t length_of_ke_payload = KE_PAYLOAD_HEADER_LENGTH + ((chunk_t *)(this->data_struct + rules[i].offset))->len; @@ -759,7 +761,31 @@ static status_t generate_payload (private_generator_t *this,payload_t *payload) return status; } break; - } + } + case NOTIFICATION_DATA: + { + /* the Notification Data value is generated from chunk */ + status = this->generate_from_chunk(this,rules[i].offset); + if (status != SUCCESS) + { + this->logger->log(this->logger,CONTROL_MORE,"Could no write notification data from chunk"); + return status; + } + + u_int32_t payload_length_position_offset = this->last_payload_length_position_offset; + /* Length of Notification PAYLOAD is calculated */ + u_int16_t length_of_notify_payload = NOTIFY_PAYLOAD_HEADER_LENGTH + ((chunk_t *)(this->data_struct + rules[i].offset))->len; + length_of_notify_payload += this->last_spi_size; + u_int16_t int16_val = htons(length_of_notify_payload); + + status = this->write_bytes_to_buffer_at_offset(this,&int16_val,sizeof(u_int16_t),payload_length_position_offset); + if (status != SUCCESS) + { + this->logger->log(this->logger,CONTROL_MORE,"Could no write payload length into buffer"); + return status; + } + break; + } case PROPOSALS: { /* before iterative generate the transforms, store the current payload length position */ diff --git a/Source/charon/payloads/ke_payload.c b/Source/charon/payloads/ke_payload.c index cfb1fb99b..cfbd536c4 100644 --- a/Source/charon/payloads/ke_payload.c +++ b/Source/charon/payloads/ke_payload.c @@ -31,7 +31,6 @@ #include "encodings.h" #include "../utils/allocator.h" -#include "../utils/linked_list.h" /** @@ -118,8 +117,10 @@ encoding_rule_t ke_payload_encodings[] = { */ static status_t destroy(private_ke_payload_t *this) { - if (this->key_exchange_data.ptr != NULL); - allocator_free(this->key_exchange_data.ptr); + if (this->key_exchange_data.ptr != NULL) + { + allocator_free(this->key_exchange_data.ptr); + } allocator_free(this); return SUCCESS; } diff --git a/Source/charon/payloads/notify_payload.c b/Source/charon/payloads/notify_payload.c new file mode 100644 index 000000000..3526038d7 --- /dev/null +++ b/Source/charon/payloads/notify_payload.c @@ -0,0 +1,378 @@ +/** + * @file notify_payload.c + * + * @brief Declaration of the class notify_payload_t. + * + * An object of this type represents an IKEv2 Notify-Payload. + * + * See section 3.10 of Draft for details of this payload type. + * + */ + +/* + * Copyright (C) 2005 Jan Hutter, Martin Willi + * Hochschule fuer Technik Rapperswil + * + * This program 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 2 of the License, or (at your + * option) any later version. See . + * + * This program 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. + */ + +/* offsetof macro */ +#include + +#include "notify_payload.h" + +#include "encodings.h" +#include "../utils/allocator.h" + +/** + * Private data of an notify_payload_t Object + * + */ +typedef struct private_notify_payload_s private_notify_payload_t; + +struct private_notify_payload_s { + /** + * public notify_payload_t interface + */ + notify_payload_t public; + + /** + * next payload type + */ + u_int8_t next_payload; + + /** + * Critical flag + */ + bool critical; + + /** + * Length of this payload + */ + u_int16_t payload_length; + + /** + * protocol id + */ + u_int8_t protocol_id; + + /** + * spi size + */ + u_int8_t spi_size; + + /** + * notify message type + */ + u_int16_t notify_message_type; + + /** + * Security parameter index (spi) + */ + chunk_t spi; + + /** + * Notification data + */ + chunk_t notification_data; + + /** + * @brief Computes the length of this payload. + * + * @param this calling private_ke_payload_t object + * @return + * SUCCESS in any case + */ + status_t (*compute_length) (private_notify_payload_t *this); +}; + +/** + * Encoding rules to parse or generate a IKEv2-Notify Payload + * + * The defined offsets are the positions in a object of type + * private_notify_payload_t. + * + */ +encoding_rule_t notify_payload_encodings[] = { + /* 1 Byte next payload type, stored in the field next_payload */ + { U_INT_8, offsetof(private_notify_payload_t, next_payload) }, + /* the critical bit */ + { FLAG, offsetof(private_notify_payload_t, critical) }, + /* 7 Bit reserved bits, nowhere stored */ + { RESERVED_BIT, 0 }, + { RESERVED_BIT, 0 }, + { RESERVED_BIT, 0 }, + { RESERVED_BIT, 0 }, + { RESERVED_BIT, 0 }, + { RESERVED_BIT, 0 }, + { RESERVED_BIT, 0 }, + /* Length of the whole payload*/ + { PAYLOAD_LENGTH, offsetof(private_notify_payload_t, payload_length) }, + /* Protocol ID as 8 bit field*/ + { U_INT_8, offsetof(private_notify_payload_t, protocol_id) }, + /* SPI Size as 8 bit field*/ + { SPI_SIZE, offsetof(private_notify_payload_t, spi_size) }, + /* Notify message type as 16 bit field*/ + { U_INT_16, offsetof(private_notify_payload_t, notify_message_type) }, + /* SPI as variable length field*/ + { SPI, offsetof(private_notify_payload_t, spi) }, + /* Key Exchange Data is from variable size */ + { NOTIFICATION_DATA, offsetof(private_notify_payload_t, notification_data) } +}; + +/** + * Implements payload_t's and notify_payload_t's destroy function. + * See #payload_s.destroy or notify_payload_s.destroy for description. + */ +static status_t destroy(private_notify_payload_t *this) +{ + if (this->notification_data.ptr != NULL) + { + allocator_free(this->notification_data.ptr); + } + if (this->spi.ptr != NULL) + { + allocator_free(this->spi.ptr); + } + + allocator_free(this); + return SUCCESS; +} + +/** + * Implements payload_t's get_encoding_rules function. + * See #payload_s.get_encoding_rules for description. + */ +static status_t get_encoding_rules(private_notify_payload_t *this, encoding_rule_t **rules, size_t *rule_count) +{ + *rules = notify_payload_encodings; + *rule_count = sizeof(notify_payload_encodings) / sizeof(encoding_rule_t); + return SUCCESS; +} + +/** + * Implements payload_t's get_type function. + * See #payload_s.get_type for description. + */ +static payload_type_t get_type(private_notify_payload_t *this) +{ + return KEY_EXCHANGE; +} + +/** + * Implements payload_t's get_next_type function. + * See #payload_s.get_next_type for description. + */ +static payload_type_t get_next_type(private_notify_payload_t *this) +{ + return (this->next_payload); +} + +/** + * Implements payload_t's set_next_type function. + * See #payload_s.set_next_type for description. + */ +static status_t set_next_type(private_notify_payload_t *this,payload_type_t type) +{ + this->next_payload = type; + return SUCCESS; +} + +/** + * Implements payload_t's get_length function. + * See #payload_s.get_length for description. + */ +static size_t get_length(private_notify_payload_t *this) +{ + this->compute_length(this); + return this->payload_length; +} + +/** + * Implements private_ke_payload_t's compute_length function. + * See #private_ke_payload_s.compute_length for description. + */ +static status_t compute_length (private_notify_payload_t *this) +{ + size_t length = NOTIFY_PAYLOAD_HEADER_LENGTH; + if (this->notification_data.ptr != NULL) + { + length += this->notification_data.len; + } + if (this->spi.ptr != NULL) + { + length += this->spi.len; + } + + this->payload_length = length; + + return SUCCESS; +} + + +/** + * Implements notify_payload_t's get_protocol_id function. + * See #notify_payload_s.get_protocol_id for description. + */ +u_int8_t get_protocol_id(private_notify_payload_t *this) +{ + return this->protocol_id; +} + +/** + * Implements notify_payload_t's set_protocol_id function. + * See #notify_payload_s.set_protocol_id for description. + */ +status_t set_protocol_id(private_notify_payload_t *this, u_int8_t protocol_id) +{ + this->protocol_id = protocol_id; + return SUCCESS; +} + +/** + * Implements notify_payload_t's get_notification_data function. + * See #notify_payload_s.get_notification_data for description. + */ +u_int16_t get_notify_message_type(private_notify_payload_t *this) +{ + return this->notify_message_type; +} + +/** + * Implements notify_payload_t's get_notification_data function. + * See #notify_payload_s.get_notification_data for description. + */ +status_t set_notify_message_type(private_notify_payload_t *this, u_int16_t notify_message_type) +{ + this->notify_message_type = notify_message_type; + return SUCCESS; +} + +/** + * Implements notify_payload_t's get_spi function. + * See #notify_payload_s.get_spi for description. + */ +chunk_t get_spi(private_notify_payload_t *this) +{ + return (this->spi); +} + +/** + * Implements notify_payload_t's set_spi function. + * See #notify_payload_s.set_spi for description. + */ +status_t set_spi(private_notify_payload_t *this, chunk_t spi) +{ + /* destroy existing data first */ + if (this->spi.ptr != NULL) + { + /* free existing value */ + allocator_free(this->spi.ptr); + this->spi.ptr = NULL; + this->spi.len = 0; + + } + + this->spi.ptr = allocator_clone_bytes(spi.ptr,spi.len); + if (this->spi.ptr == NULL) + { + return OUT_OF_RES; + } + this->spi.len = spi.len; + this->spi_size = spi.len; + this->compute_length(this); + + return SUCCESS; +} + + +/** + * Implements notify_payload_t's get_notification_data function. + * See #notify_payload_s.get_notification_data for description. + */ +chunk_t get_notification_data(private_notify_payload_t *this) +{ + return (this->notification_data); +} + +/** + * Implements notify_payload_t's get_notification_data function. + * See #notify_payload_s.get_notification_data for description. + */ +status_t set_notification_data(private_notify_payload_t *this, chunk_t notification_data) +{ + /* destroy existing data first */ + if (this->notification_data.ptr != NULL) + { + /* free existing value */ + allocator_free(this->notification_data.ptr); + this->notification_data.ptr = NULL; + this->notification_data.len = 0; + + } + + this->notification_data.ptr = allocator_clone_bytes(notification_data.ptr,notification_data.len); + if (this->notification_data.ptr == NULL) + { + return OUT_OF_RES; + } + this->notification_data.len = notification_data.len; + this->compute_length(this); + + return SUCCESS; +} + +/* + * Described in header + */ +notify_payload_t *notify_payload_create() +{ + private_notify_payload_t *this = allocator_alloc_thing(private_notify_payload_t); + if (this == NULL) + { + return NULL; + } + /* interface functions */ + this->public.payload_interface.get_encoding_rules = (status_t (*) (payload_t *, encoding_rule_t **, size_t *) ) get_encoding_rules; + this->public.payload_interface.get_length = (size_t (*) (payload_t *)) get_length; + this->public.payload_interface.get_next_type = (payload_type_t (*) (payload_t *)) get_next_type; + this->public.payload_interface.set_next_type = (status_t (*) (payload_t *,payload_type_t)) set_next_type; + this->public.payload_interface.get_type = (payload_type_t (*) (payload_t *)) get_type; + this->public.payload_interface.destroy = (status_t (*) (payload_t *))destroy; + + /* public functions */ + this->public.get_protocol_id = (u_int8_t (*) (notify_payload_t *)) get_protocol_id; + this->public.set_protocol_id = (status_t (*) (notify_payload_t *,u_int8_t)) set_protocol_id; + this->public.get_notify_message_type = (u_int16_t (*) (notify_payload_t *)) get_notify_message_type; + this->public.set_notify_message_type = (status_t (*) (notify_payload_t *,u_int16_t)) set_notify_message_type; + this->public.get_spi = (chunk_t (*) (notify_payload_t *)) get_spi; + this->public.set_spi = (status_t (*) (notify_payload_t *,chunk_t)) set_spi; + this->public.get_notification_data = (chunk_t (*) (notify_payload_t *)) get_notification_data; + this->public.set_notification_data = (status_t (*) (notify_payload_t *,chunk_t)) set_notification_data; + this->public.destroy = (status_t (*) (notify_payload_t *)) destroy; + + /* private functions */ + this->compute_length = compute_length; + + /* set default values of the fields */ + this->critical = NOTIFY_PAYLOAD_CRITICAL_FLAG; + this->next_payload = NO_PAYLOAD; + this->payload_length = NOTIFY_PAYLOAD_HEADER_LENGTH; + this->protocol_id = 0; + this->notify_message_type = 0; + this->spi.ptr = NULL; + this->spi.len = 0; + this->notification_data.ptr = NULL; + this->notification_data.len = 0; + + return (&(this->public)); +} + diff --git a/Source/charon/payloads/notify_payload.h b/Source/charon/payloads/notify_payload.h new file mode 100644 index 000000000..e4911b0ad --- /dev/null +++ b/Source/charon/payloads/notify_payload.h @@ -0,0 +1,159 @@ +/** + * @file notify_payload.h + * + * @brief Declaration of the class notify_payload_t. + * + * An object of this type represents an IKEv2 Notify-Payload. + * + * See section 3.10 of Draft for details of this payload type. + * + */ + +/* + * Copyright (C) 2005 Jan Hutter, Martin Willi + * Hochschule fuer Technik Rapperswil + * + * This program 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 2 of the License, or (at your + * option) any later version. See . + * + * This program 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. + */ + + +#ifndef NOTIFY_PAYLOAD_H_ +#define NOTIFY_PAYLOAD_H_ + +#include "../types.h" +#include "payload.h" +#include "../utils/linked_list.h" + +/** + * Critical flag must not be set + */ +#define NOTIFY_PAYLOAD_CRITICAL_FLAG FALSE; + +/** + * Notify payload length in bytes without any spi and notification data + */ +#define NOTIFY_PAYLOAD_HEADER_LENGTH 8 + +/** + * Object representing an IKEv2-Notify Payload + * + * The Notify Payload format is described in Draft section 3.10. + * + */ +typedef struct notify_payload_s notify_payload_t; + +struct notify_payload_s { + /** + * implements payload_t interface + */ + payload_t payload_interface; + + /** + * @brief Gets the protocol id of this payload. + * + * @param this calling notify_payload_t object + * @return protocol id of this payload + */ + u_int8_t (*get_protocol_id) (notify_payload_t *this); + + /** + * @brief Sets the protocol id of this payload. + * + * @param this calling notify_payload_t object + * @param protocol_id protocol id to set + * @return SUCCESS + */ + status_t (*set_protocol_id) (notify_payload_t *this, u_int8_t protocol_id); + + /** + * @brief Gets the notify message type of this payload. + * + * @param this calling notify_payload_t object + * @return notify message type of this payload + */ + u_int16_t (*get_notify_message_type) (notify_payload_t *this); + + /** + * @brief Sets notify message type of this payload. + * + * @param this calling notify_payload_t object + * @param notify_message_type notify message type to set + * @return SUCCESS + */ + status_t (*set_notify_message_type) (notify_payload_t *this, u_int16_t notify_message_type); + + /** + * @brief Returns the currently set spi of this payload. + * + * @warning Returned data are not copied. + * + * @param this calling notify_payload_t object + * @return chunk_t pointing to the value + */ + chunk_t (*get_spi) (notify_payload_t *this); + + /** + * @brief Sets the spi of this payload. + * + * @warning Value is getting copied. + * + * @param this calling notify_payload_t object + * @param spi chunk_t pointing to the value to set + * @return + * - SUCCESS or + * - OUT_OF_RES + */ + status_t (*set_spi) (notify_payload_t *this, chunk_t spi); + + /** + * @brief Returns the currently set notification data of payload. + * + * @warning Returned data are not copied. + * + * @param this calling notify_payload_t object + * @return chunk_t pointing to the value + */ + chunk_t (*get_notification_data) (notify_payload_t *this); + + /** + * @brief Sets the notification data of this payload. + * + * @warning Value is getting copied. + * + * @param this calling notify_payload_t object + * @param notification_data chunk_t pointing to the value to set + * @return + * - SUCCESS or + * - OUT_OF_RES + */ + status_t (*set_notification_data) (notify_payload_t *this, chunk_t notification_data); + + /** + * @brief Destroys an notify_payload_t object. + * + * @param this notify_payload_t object to destroy + * @return + * SUCCESS in any case + */ + status_t (*destroy) (notify_payload_t *this); +}; + +/** + * @brief Creates an empty notify_payload_t object + * + * @return + * - created notify_payload_t object, or + * - NULL if failed + */ +notify_payload_t *notify_payload_create(); + + +#endif /*NOTIFY_PAYLOAD_H_*/ diff --git a/Source/charon/testcases/generator_test.c b/Source/charon/testcases/generator_test.c index a28b8f37e..76150060c 100644 --- a/Source/charon/testcases/generator_test.c +++ b/Source/charon/testcases/generator_test.c @@ -36,6 +36,7 @@ #include "../payloads/proposal_substructure.h" #include "../payloads/sa_payload.h" #include "../payloads/ke_payload.h" +#include "../payloads/notify_payload.h" /* * Described in Header @@ -673,3 +674,64 @@ void test_generator_with_ke_payload(tester_t *tester) } +/* + * Described in header + */ +void test_generator_with_notify_payload(tester_t *tester) +{ + generator_t *generator; + notify_payload_t *notify_payload; + logger_t *logger; + status_t status; + chunk_t generated_data; + chunk_t spi,notification_data; + + logger = global_logger_manager->create_logger(global_logger_manager,TESTER,"Message with Notify Payload"); + + /* create generator */ + generator = generator_create(); + tester->assert_true(tester,(generator != NULL), "generator create check"); + + notify_payload = notify_payload_create(); + + + spi.ptr = "12345"; + spi.len = strlen(spi.ptr); + + notification_data.ptr = "67890"; + notification_data.len = strlen(notification_data.ptr); + + notify_payload->set_protocol_id(notify_payload,255); + notify_payload->set_notify_message_type(notify_payload,63333); /* Hex F765 */ + notify_payload->set_spi(notify_payload,spi); + notify_payload->set_notification_data(notify_payload,notification_data); + + status = generator->generate_payload(generator,(payload_t *)notify_payload); + tester->assert_true(tester,(status == SUCCESS),"generate_payload call check"); + tester->assert_true(tester,(generator->write_to_chunk(generator,&generated_data) == SUCCESS),"write_to_chunk call check"); + logger->log_chunk(logger,RAW,"generated payload",&generated_data); + + u_int8_t expected_generation[] = { + /* payload header */ + 0x00,0x00,0x00,0x12, + 0xFF,0x05,0xF7,0x65, + /* spi */ + 0x31,0x32,0x33,0x34, + 0x35, + /* notification data */ + 0x36,0x37,0x38,0x39, + 0x30, + }; + + logger->log_bytes(logger,RAW,"expected payload",expected_generation,sizeof(expected_generation)); + + tester->assert_true(tester,(memcmp(expected_generation,generated_data.ptr,sizeof(expected_generation)) == 0), "compare generated data"); + + allocator_free_chunk(generated_data); + + tester->assert_true(tester,(notify_payload->destroy(notify_payload) == SUCCESS), "notify_payload destroy call check"); + tester->assert_true(tester,(generator->destroy(generator) == SUCCESS), "generator destroy call check"); + + global_logger_manager->destroy_logger(global_logger_manager,logger); + +} \ No newline at end of file diff --git a/Source/charon/testcases/generator_test.h b/Source/charon/testcases/generator_test.h index 6b72994b4..0c6fc22f4 100644 --- a/Source/charon/testcases/generator_test.h +++ b/Source/charon/testcases/generator_test.h @@ -74,5 +74,13 @@ void test_generator_with_sa_payload(tester_t *tester); */ void test_generator_with_ke_payload(tester_t *tester); +/** + * @brief Test function used to test the generator with Notify payload + * + * + * @param tester associated tester object + */ +void test_generator_with_notify_payload(tester_t *tester); + #endif /*GENERATOR_TEST_H_*/ diff --git a/Source/charon/testcases/testcases.c b/Source/charon/testcases/testcases.c index b99c3e640..80fa21ef7 100644 --- a/Source/charon/testcases/testcases.c +++ b/Source/charon/testcases/testcases.c @@ -127,6 +127,7 @@ test_t generator_test3 = {test_generator_with_transform_substructure,"Generator: test_t generator_test4 = {test_generator_with_proposal_substructure,"Generator: proposal substructure"}; test_t generator_test5 = {test_generator_with_sa_payload,"Generator: Message with SA Payload"}; test_t generator_test6 = {test_generator_with_ke_payload,"Generator: KE Payload"}; +test_t generator_test7 = {test_generator_with_notify_payload,"Generator: Notify Payload"}; /** @@ -210,6 +211,7 @@ logger_manager_t *global_logger_manager; &generator_test4, &generator_test5, &generator_test6, + &generator_test7, &ike_sa_manager_test, &packet_test, NULL @@ -226,9 +228,8 @@ logger_manager_t *global_logger_manager; tester_t *tester = tester_create(test_output, FALSE); - -// tester->perform_tests(tester,all_tests); - tester->perform_test(tester,&parser_test4); + tester->perform_tests(tester,all_tests); +// tester->perform_test(tester,&generator_test7); tester->destroy(tester); diff --git a/Source/charon/utils/logger_manager.c b/Source/charon/utils/logger_manager.c index 22c1059f0..26635d9ef 100644 --- a/Source/charon/utils/logger_manager.c +++ b/Source/charon/utils/logger_manager.c @@ -29,7 +29,7 @@ /** * Maximum length of a logger name */ -#define MAX_LOGGER_NAME 30 +#define MAX_LOGGER_NAME 45 typedef struct private_logger_manager_s private_logger_manager_t; struct private_logger_manager_s {