path: root/Source/charon/message.c

/**
 * @file message.c
 *
 * @brief Class message_t. Object of this type represents an IKEv2-Message.
 *
 */

/*
 * 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 <http://www.fsf.org/copyleft/gpl.txt>.
 *
 * 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.
 */

#include <stdlib.h>

#include "message.h"

#include "types.h"
#include "globals.h"
#include "ike_sa_id.h"
#include "generator.h"
#include "utils/linked_list.h"
#include "utils/allocator.h"
#include "utils/logger_manager.h"
#include "payloads/encodings.h"
#include "payloads/payload.h"
#include "parser.h"

/**
 * Entry for a payload in the internal used linked list
 * 
 */
typedef struct payload_entry_s payload_entry_t;

struct payload_entry_s {
	/**
	 * Type of payload
	 */
	payload_type_t payload_type;
	/**
	 * Data struct holding the data of given payload
	 */
	void *data_struct;
};


/**
 * Private data of an message_t object
 */
typedef struct private_message_s private_message_t;

struct private_message_s {

	/**
	 * Public part of a message_t object
	 */
	message_t public;


	/**
	 * Assigned exchange type
	 */
	exchange_type_t exchange_type;
	
	/**
	 * TRUE if message is from original initiator, FALSE otherwise.
	 */
	bool original_initiator;

	/**
	 * TRUE if message is request.
	 * FALSE if message is reply.
	 */
	bool is_request;
	
	/**
	 * Message ID of this message
	 */
	u_int32_t message_id;
	
	/**
	 * ID of assigned IKE_SA
	 */
	ike_sa_id_t *ike_sa_id;
	
	/**
	 * Assigned UDP packet.
	 * 
	 * Stores incoming packet or last generated one.
	 */
	packet_t *packet;
	 
	/**
	 * Linked List where payload data are stored in
	 */
	linked_list_t *payloads;
	
	 /**
	  * Assigned parser to parse Header and Body of this message
	  */
	parser_t *parser;
	
	/**
	 * logger for this message
	 */
	logger_t *logger;
	
};


/**
 * Implements message_t's set_ike_sa_id function.
 * See #message_s.set_ike_sa_id.
 */
static status_t set_ike_sa_id (private_message_t *this,ike_sa_id_t *ike_sa_id)
{
	status_t status;
	status = ike_sa_id->clone(ike_sa_id,&(this->ike_sa_id));
	return status;
}

/**
 * Implements message_t's get_ike_sa_id function.
 * See #message_s.get_ike_sa_id.
 */
static status_t get_ike_sa_id (private_message_t *this,ike_sa_id_t **ike_sa_id)
{
	status_t status;
	if (this->ike_sa_id == NULL)
	{
		return FAILED;
	}
	status = this->ike_sa_id->clone(this->ike_sa_id,ike_sa_id);
	return status;
}


/**
 * Implements message_t's set_message_id function.
 * See #message_s.set_message_id.
 */
static status_t set_message_id (private_message_t *this,u_int32_t message_id)
{
	this->message_id = message_id;
	return SUCCESS;
}


/**
 * Implements message_t's set_message_id function.
 * See #message_s.set_message_id.
 */
static u_int32_t get_message_id (private_message_t *this)
{
	return this->message_id;
}


/**
 * Implements message_t's set_exchange_type function.
 * See #message_s.set_exchange_type.
 */
static status_t set_exchange_type (private_message_t *this,exchange_type_t exchange_type)
{
	this->exchange_type = exchange_type;
	return SUCCESS;
}


/**
 * Implements message_t's get_exchange_type function.
 * See #message_s.get_exchange_type.
 */
static exchange_type_t get_exchange_type (private_message_t *this)
{
	return this->exchange_type;
}

/**
 * Implements message_t's set_original_initiator function.
 * See #message_s.set_original_initiator.
 */
static status_t set_original_initiator (private_message_t *this,bool original_initiator)
{
	this->original_initiator = original_initiator;
	return SUCCESS;
}

/**
 * Implements message_t's get_original_initiator function.
 * See #message_s.get_original_initiator.
 */
static exchange_type_t get_original_initiator (private_message_t *this)
{
	return this->original_initiator;
}

/**
 * Implements message_t's set_request function.
 * See #message_s.set_request.
 */
static status_t set_request (private_message_t *this,bool request)
{
	this->is_request = request;
	return SUCCESS;
}

/**
 * Implements message_t's get_request function.
 * See #message_s.get_request.
 */
static exchange_type_t get_request (private_message_t *this)
{
	return this->is_request;
}

static status_t add_payload(private_message_t *this, payload_t *payload)
{
	if (this->payloads->insert_last(this->payloads, payload) != SUCCESS)
	{
		return OUT_OF_RES;	
	}
	return SUCCESS;
}

static status_t set_source(private_message_t *this, host_t *host)
{
	if (this->packet->source != NULL)
	{
		this->packet->source->destroy(this->packet->source);	
	}
	this->packet->source = host;
	return SUCCESS;
}

static status_t set_destination(private_message_t *this, host_t *host)
{
	if (this->packet->destination != NULL)
	{
		this->packet->destination->destroy(this->packet->destination);	
	}
	this->packet->destination = host;
	return SUCCESS;
}

static status_t get_source(private_message_t *this, host_t **host)
{
	*host = this->packet->source;
	return SUCCESS;
}

static status_t get_destination(private_message_t *this, host_t **host)
{
	*host = this->packet->destination;
	return SUCCESS;
}


/**
 * Implements message_t's generate function.
 * See #message_s.generate.
 */
static status_t generate(private_message_t *this, packet_t **packet)
{
	generator_t *generator;
	ike_header_t *ike_header;
	payload_t *payload, *next_payload;
	linked_list_iterator_t *iterator;
	u_int64_t initiator_spi, responder_spi;
	bool is_initiator;
	status_t status;
	
	if (this->exchange_type == EXCHANGE_TYPE_UNDEFINED)
	{
		return INVALID_STATE;
	}
	
	if (this->packet->source == NULL ||
		this->packet->destination == NULL) 
	{
		return INVALID_STATE;
	}
	
	ike_header = ike_header_create();
	if (ike_header == NULL)
	{
		return OUT_OF_RES;
	}
	
	this->ike_sa_id->get_values(this->ike_sa_id, &initiator_spi, &responder_spi, &is_initiator); 
	
	ike_header->set_exchange_type(ike_header, this->exchange_type);
	ike_header->set_initiator_flag(ike_header, this->original_initiator);
	ike_header->set_message_id(ike_header, this->message_id);
	ike_header->set_response_flag(ike_header, !this->is_request);
	ike_header->set_initiator_flag(ike_header, is_initiator);
	ike_header->set_initiator_spi(ike_header, initiator_spi);
	ike_header->set_initiator_spi(ike_header, responder_spi);

	generator = generator_create();
	
	payload = (payload_t*)ike_header;

	if (this->payloads->create_iterator(this->payloads, &iterator, TRUE) != SUCCESS)
	{
		generator->destroy(generator);
		ike_header->destroy(ike_header);
		return OUT_OF_RES;
	}
	while(iterator->has_next(iterator))
	{
		iterator->current(iterator, (void**)&next_payload);
		payload->set_next_type(payload, next_payload->get_type(next_payload));
		status = generator->generate_payload(generator, payload);
		if (status != SUCCESS)
		{
			generator->destroy(generator);
			ike_header->destroy(ike_header);
			return status;
		}
		payload = next_payload;
	}
	iterator->destroy(iterator);
	
	payload->set_next_type(payload, NO_PAYLOAD);
	status = generator->generate_payload(generator, payload);
	if (status != SUCCESS)
	{
		generator->destroy(generator);
		ike_header->destroy(ike_header);
		return status;
	}
	
	ike_header->destroy(ike_header);
	
	
	
	if (this->packet->data.ptr != NULL)
	{
		allocator_free(this->packet->data.ptr);
	}	
	
	status = generator->write_to_chunk(generator, &(this->packet->data));
	if (status != SUCCESS)
	{
		generator->destroy(generator);
		return status;
	}
	
	this->packet->clone(this->packet, packet);
	
	generator->destroy(generator);
	return SUCCESS;
}

/**
 * Implements message_t's parse_header function.
 * See #message_s.parse_header.
 */
static status_t parse_header (private_message_t *this)
{
	ike_header_t *ike_header;
	status_t status;
	
	this->parser->reset_context(this->parser);
	status = this->parser->parse_payload(this->parser,HEADER,(payload_t **) &ike_header);
	if (status != SUCCESS)
	{
		return status;
		
	}
	ike_header->destroy(ike_header);
	return SUCCESS;	
}


/**
 * Implements message_t's destroy function.
 * See #message_s.destroy.
 */
static status_t destroy (private_message_t *this)
{
	linked_list_iterator_t *iterator;
	
	if (this->packet != NULL)
	{
		this->packet->destroy(this->packet);
	}
	if (this->ike_sa_id != NULL)
	{
		this->ike_sa_id->destroy(this->ike_sa_id);
	}
	
	this->payloads->create_iterator(this->payloads, &iterator, TRUE);
	while (iterator->has_next(iterator))
	{
		payload_t *payload;
		iterator->current(iterator, (void**)&payload);	
		this->logger->log(this->logger, CONTROL_MORE, "Destroying payload of type %s", 
			mapping_find(payload_type_m, payload->get_type(payload)));
		payload->destroy(payload);
	}
	iterator->destroy(iterator);
	this->payloads->destroy(this->payloads);
	allocator_free(this);
	return SUCCESS;
}

/*
 * Described in Header-File
 */
message_t *message_create_from_packet(packet_t *packet)
{
	private_message_t *this = allocator_alloc_thing(private_message_t);
	if (this == NULL)
	{
		return NULL;
	}

	/* public functions */
	this->public.set_message_id = (status_t(*)(message_t*, u_int32_t))set_message_id;
	this->public.get_message_id = (u_int32_t(*)(message_t*))get_message_id;
	this->public.set_ike_sa_id = (status_t(*)(message_t*, ike_sa_id_t *))set_ike_sa_id;
	this->public.get_ike_sa_id = (status_t(*)(message_t*, ike_sa_id_t **))get_ike_sa_id;
	this->public.set_exchange_type = (status_t(*)(message_t*, exchange_type_t))set_exchange_type;
	this->public.get_exchange_type = (exchange_type_t(*)(message_t*))get_exchange_type;
	this->public.set_original_initiator = (status_t(*)(message_t*, bool))set_original_initiator;
	this->public.get_original_initiator = (bool(*)(message_t*))get_original_initiator;
	this->public.set_request = (status_t(*)(message_t*, bool))set_request;
	this->public.get_request = (bool(*)(message_t*))get_request;
	this->public.add_payload = (status_t(*)(message_t*,payload_t*))add_payload;
	this->public.generate = (status_t (*) (message_t *, packet_t**)) generate;
	this->public.set_source = (status_t (*) (message_t*,host_t*)) set_source;
	this->public.get_source = (status_t (*) (message_t*,host_t**)) get_source;
	this->public.set_destination = (status_t (*) (message_t*,host_t*)) set_destination;
	this->public.get_destination = (status_t (*) (message_t*,host_t**)) get_destination;
	this->public.parse_header = 	(status_t (*) (message_t *)) parse_header;
	this->public.destroy = (status_t(*)(message_t*))destroy;
		
	/* public values */
	this->exchange_type = EXCHANGE_TYPE_UNDEFINED;
 	this->original_initiator = TRUE;
 	this->is_request = TRUE;
 	this->ike_sa_id = NULL;
 	this->message_id = 0;

	/* private values */
	if (packet == NULL)
	{
		packet = packet_create();	
	}
	if (packet == NULL)
	{
		allocator_free(this);
		return NULL;
	}
	this->packet = packet;
	this->payloads = linked_list_create();
	if (this->payloads == NULL)
	{
		allocator_free(this);
		return NULL;
	}
	
	/* parser is created from data of packet */
 	this->parser = parser_create(this->packet->data);
 	if (this->parser == NULL)
 	{
 		this->payloads->destroy(this->payloads);
		allocator_free(this);
		return NULL;
 	}
		
	this->logger = global_logger_manager->create_logger(global_logger_manager, MESSAGE, NULL);
	if (this->logger == NULL)
	{
		this->parser->destroy(this->parser);
		this->payloads->destroy(this->payloads);
		allocator_free(this);
		return NULL;
	}

	return (&this->public);
}

/*
 * Described in Header-File
 */
message_t *message_create()
{
	return message_create_from_packet(NULL);
}