/** * @file ike_header.c * * @brief Implementation of ike_header_t. * */ /* * Copyright (C) 2005-2006 Martin Willi * Copyright (C) 2005 Jan Hutter * 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 "ike_header.h" #include typedef struct private_ike_header_t private_ike_header_t; /** * Private data of an ike_header_t object. * */ struct private_ike_header_t { /** * Public interface. */ ike_header_t public; /** * SPI of the initiator. */ u_int64_t initiator_spi; /** * SPI of the responder. */ u_int64_t responder_spi; /** * Next payload type. */ u_int8_t next_payload; /** * IKE major version. */ u_int8_t maj_version; /** * IKE minor version. */ u_int8_t min_version; /** * Exchange type . */ u_int8_t exchange_type; /** * Flags of the Message. * */ struct { /** * Sender is initiator of the associated IKE_SA_INIT-Exchange. */ bool initiator; /** * Is protocol supporting higher version? */ bool version; /** * TRUE, if this is a response, FALSE if its a Request. */ bool response; } flags; /** * Associated Message-ID. */ u_int32_t message_id; /** * Length of the whole IKEv2-Message (header and all payloads). */ u_int32_t length; }; ENUM_BEGIN(exchange_type_names, EXCHANGE_TYPE_UNDEFINED, EXCHANGE_TYPE_UNDEFINED, "EXCHANGE_TYPE_UNDEFINED"); ENUM_NEXT(exchange_type_names, IKE_SA_INIT, INFORMATIONAL, EXCHANGE_TYPE_UNDEFINED, "IKE_SA_INIT", "IKE_AUTH", "CREATE_CHILD_SA", "INFORMATIONAL"); ENUM_END(exchange_type_names, INFORMATIONAL); /** * Encoding rules to parse or generate a IKEv2-Header. * * The defined offsets are the positions in a object of type * ike_header_t. * */ encoding_rule_t ike_header_encodings[] = { /* 8 Byte SPI, stored in the field initiator_spi */ { IKE_SPI, offsetof(private_ike_header_t, initiator_spi) }, /* 8 Byte SPI, stored in the field responder_spi */ { IKE_SPI, offsetof(private_ike_header_t, responder_spi) }, /* 1 Byte next payload type, stored in the field next_payload */ { U_INT_8, offsetof(private_ike_header_t, next_payload) }, /* 4 Bit major version, stored in the field maj_version */ { U_INT_4, offsetof(private_ike_header_t, maj_version) }, /* 4 Bit minor version, stored in the field min_version */ { U_INT_4, offsetof(private_ike_header_t, min_version) }, /* 8 Bit for the exchange type */ { U_INT_8, offsetof(private_ike_header_t, exchange_type) }, /* 2 Bit reserved bits, nowhere stored */ { RESERVED_BIT, 0 }, { RESERVED_BIT, 0 }, /* 3 Bit flags, stored in the fields response, version and initiator */ { FLAG, offsetof(private_ike_header_t, flags.response) }, { FLAG, offsetof(private_ike_header_t, flags.version) }, { FLAG, offsetof(private_ike_header_t, flags.initiator) }, /* 3 Bit reserved bits, nowhere stored */ { RESERVED_BIT, 0 }, { RESERVED_BIT, 0 }, { RESERVED_BIT, 0 }, /* 4 Byte message id, stored in the field message_id */ { U_INT_32, offsetof(private_ike_header_t, message_id) }, /* 4 Byte length fied, stored in the field length */ { HEADER_LENGTH, offsetof(private_ike_header_t, length) } }; /* 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ ! IKE_SA Initiator's SPI ! ! ! +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ ! IKE_SA Responder's SPI ! ! ! +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ ! Next Payload ! MjVer ! MnVer ! Exchange Type ! Flags ! +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ ! Message ID ! +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ ! Length ! +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ */ /** * Implementation of payload_t.verify. */ static status_t verify(private_ike_header_t *this) { if ((this->exchange_type < IKE_SA_INIT) || (this->exchange_type > INFORMATIONAL)) { /* unsupported exchange type */ return FAILED; } if (this->initiator_spi == 0) { /* initiator spi not set */ return FAILED; } /* verification of version is not done in here */ return SUCCESS; } /** * Implementation of payload_t.set_next_type. */ static void set_next_type(payload_t *this,payload_type_t type) { ((private_ike_header_t *)this)->next_payload = type; } /** * Implementation of ike_header_t.get_initiator_spi. */ static u_int64_t get_initiator_spi(private_ike_header_t *this) { return this->initiator_spi; } /** * Implementation of ike_header_t.set_initiator_spi. */ static void set_initiator_spi(private_ike_header_t *this, u_int64_t initiator_spi) { this->initiator_spi = initiator_spi; } /** * Implementation of ike_header_t.get_responder_spi. */ static u_int64_t get_responder_spi(private_ike_header_t *this) { return this->responder_spi; } /** * Implementation of ike_header_t.set_responder_spi. */ static void set_responder_spi(private_ike_header_t *this, u_int64_t responder_spi) { this->responder_spi = responder_spi; } /** * Implementation of ike_header_t.get_maj_version. */ static u_int8_t get_maj_version(private_ike_header_t *this) { return this->maj_version; } /** * Implementation of ike_header_t.get_min_version. */ static u_int8_t get_min_version(private_ike_header_t *this) { return this->min_version; } /** * Implementation of ike_header_t.get_response_flag. */ static bool get_response_flag(private_ike_header_t *this) { return this->flags.response; } /** * Implementation of ike_header_t.set_response_flag. */ static void set_response_flag(private_ike_header_t *this, bool response) { this->flags.response = response; } /** * Implementation of ike_header_t.get_version_flag. */ static bool get_version_flag(private_ike_header_t *this) { return this->flags.version; } /** * Implementation of ike_header_t.get_initiator_flag. */ static bool get_initiator_flag(private_ike_header_t *this) { return this->flags.initiator; } /** * Implementation of ike_header_t.set_initiator_flag. */ static void set_initiator_flag(private_ike_header_t *this, bool initiator) { this->flags.initiator = initiator; } /** * Implementation of ike_header_t.get_exchange_type. */ static u_int8_t get_exchange_type(private_ike_header_t *this) { return this->exchange_type; } /** * Implementation of ike_header_t.set_exchange_type. */ static void set_exchange_type(private_ike_header_t *this, u_int8_t exchange_type) { this->exchange_type = exchange_type; } /** * Implements ike_header_t's get_message_id function. * See #ike_header_t.get_message_id for description. */ static u_int32_t get_message_id(private_ike_header_t *this) { return this->message_id; } /** * Implementation of ike_header_t.set_message_id. */ static void set_message_id(private_ike_header_t *this, u_int32_t message_id) { this->message_id = message_id; } /** * Implementation of ike_header_t.destroy and payload_t.destroy. */ static void destroy(ike_header_t *this) { free(this); } /** * Implementation of payload_t.get_encoding_rules. */ static void get_encoding_rules(payload_t *this, encoding_rule_t **rules, size_t *rule_count) { *rules = ike_header_encodings; *rule_count = sizeof(ike_header_encodings) / sizeof(encoding_rule_t); } /** * Implementation of payload_t.get_type. */ static payload_type_t get_type(payload_t *this) { return HEADER; } /** * Implementation of payload_t.get_next_type. */ static payload_type_t get_next_type(payload_t *this) { return (((private_ike_header_t*)this)->next_payload); } /** * Implementation of payload_t.get_length. */ static size_t get_length(payload_t *this) { return (((private_ike_header_t*)this)->length); } /* * Described in header. */ ike_header_t *ike_header_create() { private_ike_header_t *this = malloc_thing(private_ike_header_t); this->public.payload_interface.verify = (status_t (*) (payload_t *))verify; this->public.payload_interface.get_encoding_rules = get_encoding_rules; this->public.payload_interface.get_length = get_length; this->public.payload_interface.get_next_type = get_next_type; this->public.payload_interface.set_next_type = set_next_type; this->public.payload_interface.get_type = get_type; this->public.payload_interface.destroy = (void (*) (payload_t *))destroy; this->public.destroy = destroy; this->public.get_initiator_spi = (u_int64_t (*) (ike_header_t*))get_initiator_spi; this->public.set_initiator_spi = (void (*) (ike_header_t*,u_int64_t))set_initiator_spi; this->public.get_responder_spi = (u_int64_t (*) (ike_header_t*))get_responder_spi; this->public.set_responder_spi = (void (*) (ike_header_t *,u_int64_t))set_responder_spi; this->public.get_maj_version = (u_int8_t (*) (ike_header_t*))get_maj_version; this->public.get_min_version = (u_int8_t (*) (ike_header_t*))get_min_version; this->public.get_response_flag = (bool (*) (ike_header_t*))get_response_flag; this->public.set_response_flag = (void (*) (ike_header_t*,bool))set_response_flag; this->public.get_version_flag = (bool (*) (ike_header_t*))get_version_flag; this->public.get_initiator_flag = (bool (*) (ike_header_t*))get_initiator_flag; this->public.set_initiator_flag = (void (*) (ike_header_t*,bool))set_initiator_flag; this->public.get_exchange_type = (u_int8_t (*) (ike_header_t*))get_exchange_type; this->public.set_exchange_type = (void (*) (ike_header_t*,u_int8_t))set_exchange_type; this->public.get_message_id = (u_int32_t (*) (ike_header_t*))get_message_id; this->public.set_message_id = (void (*) (ike_header_t*,u_int32_t))set_message_id; /* set default values of the fields */ this->initiator_spi = 0; this->responder_spi = 0; this->next_payload = 0; this->maj_version = IKE_MAJOR_VERSION; this->min_version = IKE_MINOR_VERSION; this->exchange_type = EXCHANGE_TYPE_UNDEFINED; this->flags.initiator = TRUE; this->flags.version = HIGHER_VERSION_SUPPORTED_FLAG; this->flags.response = FALSE; this->message_id = 0; this->length = IKE_HEADER_LENGTH; return (ike_header_t*)this; }