/** * @file sa_payload.c * * @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 #include #include typedef struct private_sa_payload_t private_sa_payload_t; /** * Private data of an sa_payload_t' Object * */ struct private_sa_payload_t { /** * 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; /** * @brief Computes the length of this payload. * * @param this calling private_sa_payload_t object * @return * SUCCESS in any case */ status_t (*compute_length) (private_sa_payload_t *this); }; /** * Encoding rules to parse or generate a IKEv2-SA Payload * * 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) } }; /* 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 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ ! Next Payload !C! RESERVED ! Payload Length ! +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ ! ! ~ ~ ! ! +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ */ /** * Implements payload_t's verify function. * See #payload_s.verify for description. */ static status_t verify(private_sa_payload_t *this) { int proposal_number = 1; status_t status; linked_list_iterator_t *iterator; bool first = TRUE; if (this->critical) { /* critical bit set! */ return FAILED; } /* check proposal numbering */ status = this->proposals->create_iterator(this->proposals,&iterator,TRUE); if (status != SUCCESS) { return status; } while(iterator->has_next(iterator)) { proposal_substructure_t *current_proposal; status = iterator->current(iterator,(void **)¤t_proposal); { break; } if (current_proposal->get_proposal_number(current_proposal) > proposal_number) { if (first) { /* first number must be 1 */ status = FAILED; break; } if (current_proposal->get_proposal_number(current_proposal) != (proposal_number + 1)) { /* must be only one more then previous proposal */ status = FAILED; break; } } else if (current_proposal->get_proposal_number(current_proposal) < proposal_number) { iterator->destroy(iterator); /* must not be smaller then proceeding one */ status = FAILED; break; } first = FALSE; } iterator->destroy(iterator); return status; } /** * 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 set_next_type function. * See #payload_s.set_next_type for description. */ static status_t set_next_type(private_sa_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_sa_payload_t *this) { this->compute_length(this); return this->payload_length; } /** * Implements sa_payload_t's create_proposal_substructure_iterator function. * See #sa_payload_s.create_proposal_substructure_iterator for description. */ static status_t create_proposal_substructure_iterator (private_sa_payload_t *this,linked_list_iterator_t **iterator,bool forward) { return (this->proposals->create_iterator(this->proposals,iterator,forward)); } /** * Implements sa_payload_t's add_proposal_substructure function. * See #sa_payload_s.add_proposal_substructure for description. */ static status_t add_proposal_substructure (private_sa_payload_t *this,proposal_substructure_t *proposal) { status_t status; status = this->proposals->insert_last(this->proposals,(void *) proposal); this->compute_length(this); return status; } /** * Implements private_sa_payload_t's compute_length function. * See #private_sa_payload_s.compute_length for description. */ static status_t compute_length (private_sa_payload_t *this) { linked_list_iterator_t *iterator; status_t status; size_t length = SA_PAYLOAD_HEADER_LENGTH; status = this->proposals->create_iterator(this->proposals,&iterator,TRUE); if (status != SUCCESS) { return length; } while (iterator->has_next(iterator)) { payload_t *current_proposal; iterator->current(iterator,(void **) ¤t_proposal); length += current_proposal->get_length(current_proposal); } iterator->destroy(iterator); this->payload_length = length; return SUCCESS; } /* * 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; } /* public interface */ this->public.payload_interface.verify = (status_t (*) (payload_t *))verify; 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.create_proposal_substructure_iterator = (status_t (*) (sa_payload_t *,linked_list_iterator_t **,bool)) create_proposal_substructure_iterator; this->public.add_proposal_substructure = (status_t (*) (sa_payload_t *,proposal_substructure_t *)) add_proposal_substructure; this->public.destroy = (status_t (*) (sa_payload_t *)) destroy; /* private functions */ this->compute_length = compute_length; /* 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)); }