From da42afc5ec9e228832ded89cf70213006510c5f5 Mon Sep 17 00:00:00 2001 From: Jan Hutter Date: Mon, 14 Nov 2005 10:14:22 +0000 Subject: [PATCH] Introduced payload types sa_payload and proposal_substructure --- Source/charon/payloads/encodings.c | 5 +- Source/charon/payloads/encodings.h | 23 +- Source/charon/payloads/ike_header.c | 4 +- Source/charon/payloads/payload.c | 2 + Source/charon/payloads/payload.h | 20 +- .../charon/payloads/proposal_substructure.c | 223 ++++++++++++++++++ .../charon/payloads/proposal_substructure.h | 68 ++++++ Source/charon/payloads/sa_payload.c | 191 +++++++++++++++ Source/charon/payloads/sa_payload.h | 78 ++++++ 9 files changed, 608 insertions(+), 6 deletions(-) create mode 100644 Source/charon/payloads/proposal_substructure.c create mode 100644 Source/charon/payloads/proposal_substructure.h create mode 100644 Source/charon/payloads/sa_payload.c create mode 100644 Source/charon/payloads/sa_payload.h diff --git a/Source/charon/payloads/encodings.c b/Source/charon/payloads/encodings.c index cde2a5329..5662a8c2f 100644 --- a/Source/charon/payloads/encodings.c +++ b/Source/charon/payloads/encodings.c @@ -37,5 +37,8 @@ mapping_t encoding_type_t_mappings[] = { {PAYLOAD_LENGTH, "PAYLOAD_LENGTH"}, {HEADER_LENGTH, "HEADER_LENGTH"}, {SPI_SIZE, "SPI_SIZE"}, - {PROPOSALS, "PROPOSALS"} + {SPI, "SPI"}, + {PROPOSALS, "PROPOSALS"}, + {TRANSFORMS, "TRANSFORMS"}, + {MAPPING_END, NULL} }; diff --git a/Source/charon/payloads/encodings.h b/Source/charon/payloads/encodings.h index 867955d44..e3db10839 100644 --- a/Source/charon/payloads/encodings.h +++ b/Source/charon/payloads/encodings.h @@ -181,6 +181,15 @@ enum encoding_type_e{ * The current read pointer is moved 32 bit forward afterwards. */ SPI_SIZE, + /** + * Representating a spi field + * + * When generating the content of the chunkt pointing to + * is written. + * + * When parsing SPI_SIZE bytes are read and written into the chunk pointing to. + */ + SPI, /** * Representating one or more proposal substructures * @@ -192,7 +201,19 @@ enum encoding_type_e{ * When parsing the parsed proposal_substructure_t objects have * to be stored in the pointed linked_list. */ - PROPOSALS + PROPOSALS, + /** + * Representating one or more transform substructures + * + * The offset points to a linked_list_t pointer. + * + * When generating the transform_substructure_t objects are stored + * in the pointed linked_list. + * + * When parsing the parsed transform_substructure_t objects have + * to be stored in the pointed linked_list. + */ + TRANSFORMS }; /** diff --git a/Source/charon/payloads/ike_header.c b/Source/charon/payloads/ike_header.c index dad11b450..84b059580 100644 --- a/Source/charon/payloads/ike_header.c +++ b/Source/charon/payloads/ike_header.c @@ -65,7 +65,7 @@ encoding_rule_t ike_header_encodings[] = { /* 4 Byte message id, stored in the field message_id */ { U_INT_32, offsetof(ike_header_t, message_id) }, /* 4 Byte length fied, stored in the field length */ - { LENGTH, offsetof(ike_header_t, length) } + { HEADER_LENGTH, offsetof(ike_header_t, length) } }; @@ -116,7 +116,7 @@ static payload_type_t get_next_type(payload_t *this) */ static size_t get_length(payload_t *this) { - return sizeof(ike_header_t); + return IKE_HEADER_LENGTH; } /* diff --git a/Source/charon/payloads/payload.c b/Source/charon/payloads/payload.c index a22160101..af0eb7839 100644 --- a/Source/charon/payloads/payload.c +++ b/Source/charon/payloads/payload.c @@ -52,6 +52,8 @@ mapping_t payload_type_t_mappings[] = { {CONFIGURATION, "CONFIGURATION"}, {EXTENSIBLE_AUTHENTICATION, "EXTENSIBLE_AUTHENTICATION"}, {HEADER, "HEADER"}, + {PROPOSAL_SUBSTRUCTURE, "PROPOSAL_SUBSTRUCTURE"}, + {TRANSFORM_SUBSTRUCTURE, "TRANSFORM_SUBSTRUCTURE"}, {MAPPING_END, NULL} }; diff --git a/Source/charon/payloads/payload.h b/Source/charon/payloads/payload.h index 1625a866b..0749a653c 100644 --- a/Source/charon/payloads/payload.h +++ b/Source/charon/payloads/payload.h @@ -111,12 +111,28 @@ enum payload_type_e{ EXTENSIBLE_AUTHENTICATION = 48, /** - * Header has value 140 of PRIVATE USE space + * Header has a value of PRIVATE USE space * * This payload type is not send over wire and just * used internally to handle IKEv2-Header like a payload. */ - HEADER = 140 + HEADER = 140, + + /** + * PROPOSAL_SUBSTRUCTURE has a value of PRIVATE USE space + * + * This payload type is not send over wire and just + * used internally to handle a proposal substructure like a payload. + */ + PROPOSAL_SUBSTRUCTURE = 141, + + /** + * TRANSFORM_SUBSTRUCTURE has a value of PRIVATE USE space + * + * This payload type is not send over wire and just + * used internally to handle a transform substructure like a payload. + */ + TRANSFORM_SUBSTRUCTURE = 142, }; diff --git a/Source/charon/payloads/proposal_substructure.c b/Source/charon/payloads/proposal_substructure.c new file mode 100644 index 000000000..509e2bc80 --- /dev/null +++ b/Source/charon/payloads/proposal_substructure.c @@ -0,0 +1,223 @@ +/** + * @file proposal_substructure.h + * + * @brief Declaration of the class proposal_substructure_t. + * + * An object of this type represents an IKEv2 PROPOSAL Substructure and contains transforms. + * + */ + +/* + * 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 "proposal_substructure.h" + +#include "encodings.h" +#include "../types.h" +#include "../utils/allocator.h" +#include "../utils/linked_list.h" + +/** + * Private data of an proposal_substructure_t' Object + * + */ +typedef struct private_proposal_substructure_s private_proposal_substructure_t; + +struct private_proposal_substructure_s { + /** + * public proposal_substructure_t interface + */ + proposal_substructure_t public; + + /** + * next payload type + */ + u_int8_t next_payload; + + + /** + * Length of this payload + */ + u_int16_t proposal_length; + + + /** + * Proposal number + */ + u_int8_t proposal_number; + + /** + * Protocol ID + */ + u_int8_t protocol_id; + + /** + * SPI size of the following SPI + */ + u_int8_t spi_size; + + /** + * Number of transforms + */ + u_int8_t transforms_count; + + /** + * SPI is stored as chunk + */ + chunk_t spi; + + /** + * Transforms are stored in a linked_list_t + */ + linked_list_t * transforms; +}; + +/** + * Encoding rules to parse or generate a Proposal substructure + * + * The defined offsets are the positions in a object of type + * private_proposal_substructure_t. + * + */ +encoding_rule_t proposal_substructure_encodings[] = { + /* 1 Byte next payload type, stored in the field next_payload */ + { U_INT_8, offsetof(private_proposal_substructure_t, next_payload) }, + /* Reserved Byte is skipped */ + { RESERVED_BYTE, 0 }, + /* Length of the whole SA payload*/ + { PAYLOAD_LENGTH, offsetof(private_proposal_substructure_t, proposal_length) }, + /* proposal number is a number of 8 bit */ + { U_INT_8, offsetof(private_proposal_substructure_t, proposal_number) }, + /* protocol ID is a number of 8 bit */ + { U_INT_8, offsetof(private_proposal_substructure_t, protocol_id) }, + /* SPI Size has its own type */ + { SPI_SIZE, offsetof(private_proposal_substructure_t, spi_size) }, + /* Number of transforms is a number of 8 bit */ + { U_INT_8, offsetof(private_proposal_substructure_t, transforms_count) }, + /* SPI is a chunk of variable size*/ + { SPI, offsetof(private_proposal_substructure_t, spi) }, + /* Transforms are stored in a transform substructure, + offset points to a linked_list_t pointer */ + { TRANSFORMS, offsetof(private_proposal_substructure_t, transforms) } +}; + +/** + * Implements payload_t's and proposal_substructure_t's destroy function. + * See #payload_s.destroy or proposal_substructure_s.destroy for description. + */ +static status_t destroy(private_proposal_substructure_t *this) +{ + /* all proposals are getting destroyed */ + while (this->transforms->get_count(this->transforms) > 0) + { + transforms_substructure_t *current_transform; + if (this->transforms->remove_last(this->transforms,(void **)¤t_transform) != SUCCESS) + { + break; + } + current_transform->destroy(current_transform); + } + this->transforms->destroy(this->transforms); + + 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_proposal_substructure_t *this, encoding_rule_t **rules, size_t *rule_count) +{ + *rules = proposal_substructure_encodings; + *rule_count = sizeof(proposal_substructure_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_proposal_substructure_t *this) +{ + return PROPOSAL_SUBSTRUCTURE; +} + +/** + * Implements payload_t's get_next_type function. + * See #payload_s.get_next_type for description. + */ +static payload_type_t get_next_type(private_proposal_substructure_t *this) +{ + return (this->next_payload); +} + +/** + * Implements payload_t's get_length function. + * See #payload_s.get_length for description. + */ +static size_t get_length(private_proposal_substructure_t *this) +{ + return this->proposal_length; +} + +/* + * Described in header + */ +proposal_substructure_t *proposal_substructure_create() +{ + private_proposal_substructure_t *this = allocator_alloc_thing(private_proposal_substructure_t); + if (this == NULL) + { + return NULL; + } + + 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.get_type = (payload_type_t (*) (payload_t *)) get_type; + this->public.payload_interface.destroy = (status_t (*) (payload_t *))destroy; + this->public.destroy = (status_t (*) (proposal_substructure_t *)) destroy; + + /* set default values of the fields */ + this->next_payload = NO_PAYLOAD; + this->proposal_length = 0; + this->proposal_number = 0; + this->protocol_id = 0; + this->transforms_count = 0; + this->spi_size = 0; + this->spi.ptr = NULL; + this->spi.len = 0; + + this->transforms = linked_list_create(); + + if (this->transforms == NULL) + { + allocator_free(this); + return NULL; + } + return (&(this->public)); +} + + diff --git a/Source/charon/payloads/proposal_substructure.h b/Source/charon/payloads/proposal_substructure.h new file mode 100644 index 000000000..2d1731c7b --- /dev/null +++ b/Source/charon/payloads/proposal_substructure.h @@ -0,0 +1,68 @@ +/** + * @file proposal_substructure.h + * + * @brief Declaration of the class proposal_substructure_t. + * + * An object of this type represents an IKEv2 PROPOSAL Substructure and contains transforms. + * + */ + +/* + * 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 PROPOSAL_SUBSTRUCTURE_H_ +#define PROPOSAL_SUBSTRUCTURE_H_ + + +#include "../types.h" +#include "payload.h" + +/** + * Object representing an IKEv2- PROPOSAL SUBSTRUCTURE + * + * The PROPOSAL SUBSTRUCTURE format is described in RFC section 3.3.1. + * + */ +typedef struct proposal_substructure_s proposal_substructure_t; + +struct proposal_substructure_s { + /** + * implements payload_t interface + */ + payload_t payload_interface; + + /** + * @brief Destroys an proposal_substructure_t object. + * + * @param this proposal_substructure_t object to destroy + * @return + * SUCCESS in any case + */ + status_t (*destroy) (proposal_substructure_t *this); +}; + +/** + * @brief Creates an empty proposal_substructure_t object + * + * @return + * - created proposal_substructure_t object, or + * - NULL if failed + */ + +proposal_substructure_t *proposal_substructure_create(); + + + +#endif /*PROPOSAL_SUBSTRUCTURE_H_*/ diff --git a/Source/charon/payloads/sa_payload.c b/Source/charon/payloads/sa_payload.c new file mode 100644 index 000000000..a58570c42 --- /dev/null +++ b/Source/charon/payloads/sa_payload.c @@ -0,0 +1,191 @@ +/** + * @file sa_payload.h + * + * @brief Declaration of the class sa_payload_t. + * + * An object of this type represents an IKEv2 SA-Payload and contains proposal + * substructures. + * + */ + +/* + * 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 "sa_payload.h" + +#include "encodings.h" +#include "../utils/allocator.h" +#include "../utils/linked_list.h" + + +/** + * Private data of an sa_payload_t' Object + * + */ +typedef struct private_sa_payload_s private_sa_payload_t; + +struct private_sa_payload_s { + /** + * public sa_payload_t interface + */ + sa_payload_t public; + + /** + * next payload type + */ + u_int8_t next_payload; + + /** + * Critical flag + */ + bool critical; + + /** + * Length of this payload + */ + u_int16_t payload_length; + + /** + * Proposals in this payload are stored in a linked_list_t + */ + linked_list_t * proposals; +}; + +/** + * Encoding rules to parse or generate a IKEv2-Header + * + * The defined offsets are the positions in a object of type + * private_sa_payload_t. + * + */ +encoding_rule_t sa_payload_encodings[] = { + /* 1 Byte next payload type, stored in the field next_payload */ + { U_INT_8, offsetof(private_sa_payload_t, next_payload) }, + /* the critical bit */ + { FLAG, offsetof(private_sa_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 SA payload*/ + { PAYLOAD_LENGTH, offsetof(private_sa_payload_t, payload_length) }, + /* Proposals are stored in a proposal substructure, + offset points to a linked_list_t pointer */ + { PROPOSALS, offsetof(private_sa_payload_t, proposals) } +}; + +/** + * Implements payload_t's and sa_payload_t's destroy function. + * See #payload_s.destroy or sa_payload_s.destroy for description. + */ +static status_t destroy(private_sa_payload_t *this) +{ + /* all proposals are getting destroyed */ + while (this->proposals->get_count(this->proposals) > 0) + { + proposal_substructure_t *current_proposal; + if (this->proposals->remove_last(this->proposals,(void **)¤t_proposal) != SUCCESS) + { + break; + } + current_proposal->destroy(current_proposal); + } + this->proposals->destroy(this->proposals); + + 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_sa_payload_t *this, encoding_rule_t **rules, size_t *rule_count) +{ + *rules = sa_payload_encodings; + *rule_count = sizeof(sa_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_sa_payload_t *this) +{ + return SECURITY_ASSOCIATION; +} + +/** + * Implements payload_t's get_next_type function. + * See #payload_s.get_next_type for description. + */ +static payload_type_t get_next_type(private_sa_payload_t *this) +{ + return (this->next_payload); +} + +/** + * Implements payload_t's get_length function. + * See #payload_s.get_length for description. + */ +static size_t get_length(private_sa_payload_t *this) +{ + return this->payload_length; +} + +/* + * Described in header + */ +sa_payload_t *sa_payload_create() +{ + private_sa_payload_t *this = allocator_alloc_thing(private_sa_payload_t); + if (this == NULL) + { + return NULL; + } + + 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.get_type = (payload_type_t (*) (payload_t *)) get_type; + this->public.payload_interface.destroy = (status_t (*) (payload_t *))destroy; + this->public.destroy = (status_t (*) (sa_payload_t *)) destroy; + + /* set default values of the fields */ + this->critical = SA_PAYLOAD_CRITICAL_FLAG; + this->next_payload = NO_PAYLOAD; + this->payload_length = SA_PAYLOAD_HEADER_LENGTH; + + this->proposals = linked_list_create(); + + if (this->proposals == NULL) + { + allocator_free(this); + return NULL; + } + return (&(this->public)); +} + + diff --git a/Source/charon/payloads/sa_payload.h b/Source/charon/payloads/sa_payload.h new file mode 100644 index 000000000..d53c2595d --- /dev/null +++ b/Source/charon/payloads/sa_payload.h @@ -0,0 +1,78 @@ +/** + * @file sa_payload.h + * + * @brief Declaration of the class sa_payload_t. + * + * An object of this type represents an IKEv2 SA-Payload and contains proposal + * substructures. + * + */ + +/* + * 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 SA_PAYLOAD_H_ +#define SA_PAYLOAD_H_ + +#include "../types.h" +#include "payload.h" +#include "proposal_substructure.h" + +/** + * Critical flag must not be set + */ +#define SA_PAYLOAD_CRITICAL_FLAG FALSE; + +/** + * SA_PAYLOAD length in bytes without any proposal substructure + */ +#define SA_PAYLOAD_HEADER_LENGTH 4 + +/** + * Object representing an IKEv2-SA Payload + * + * The SA Payload format is described in RFC section 3.3. + * + */ +typedef struct sa_payload_s sa_payload_t; + +struct sa_payload_s { + /** + * implements payload_t interface + */ + payload_t payload_interface; + + /** + * @brief Destroys an sa_payload_t object. + * + * @param this sa_payload_t object to destroy + * @return + * SUCCESS in any case + */ + status_t (*destroy) (sa_payload_t *this); +}; + +/** + * @brief Creates an empty sa_payload_t object + * + * @return + * - created sa_payload_t object, or + * - NULL if failed + */ + +sa_payload_t *sa_payload_create(); + + +#endif /*SA_PAYLOAD_H_*/