path: root/Source/charon/config/policy.c

/**
 * @file policy.c
 * 
 * @brief Implementation of policy_t.
 * 
 */

/*
 * 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 "policy.h"

#include <utils/linked_list.h>
#include <utils/identification.h>
#include <utils/logger.h>

typedef struct private_policy_t private_policy_t;

/**
 * Private data of an policy_t object
 */
struct private_policy_t {

	/**
	 * Public part
	 */
	policy_t public;
	
	/**
	 * id to use to identify us
	 */
	identification_t *my_id;
	
	/**
	 * allowed id for other
	 */
	identification_t *other_id;
	
	/**
	 * list for all proposals
	 */
	linked_list_t *proposals;
	
	/**
	 * list for traffic selectors for my site
	 */
	linked_list_t *my_ts;
	
	/**
	 * list for traffic selectors for others site
	 */
	linked_list_t *other_ts;

	/**
	 * select_traffic_selectors for both
	 */
	linked_list_t *(*select_traffic_selectors) (private_policy_t *,linked_list_t*,linked_list_t*);
};

/**
 * Implementation of policy_t.get_my_id
 */
static identification_t *get_my_id(private_policy_t *this)
{
	return this->my_id;
}

/**
 * Implementation of policy_t.get_other_id
 */
static identification_t *get_other_id(private_policy_t *this)
{
	return this->other_id;
}

/**
 * Implementation of policy_t.update_my_id
 */
static void update_my_id(private_policy_t *this, identification_t *my_id)
{
	this->my_id->destroy(this->my_id);
	this->my_id = my_id;
}

/**
 * Implementation of policy_t.update_other_id
 */
static void update_other_id(private_policy_t *this, identification_t *other_id)
{
	this->other_id->destroy(this->other_id);
	this->other_id = other_id;
}

/** 
 * Helper function which does the work for policy_t.update_my_ts and update_other_ts
 */
static void update_ts(linked_list_t* list, host_t *new_host)
{
	traffic_selector_t *ts;
	iterator_t *iterator;
	 
	iterator = list->create_iterator(list, TRUE);
	while (iterator->has_next(iterator))
	{
		iterator->current(iterator, (void**)&ts);
		ts->update_address_range(ts, new_host);
	}
	iterator->destroy(iterator);
}

/**
 * Implementation of policy_t.update_my_id
 */
static void update_my_ts(private_policy_t *this, host_t *my_host)
{
	update_ts(this->my_ts, my_host);
}

/**
 * Implementation of policy_t.update_other_ts
 */
static void update_other_ts(private_policy_t *this, host_t *my_host)
{
	update_ts(this->other_ts, my_host);
}

/**
 * Implementation of policy_t.get_my_traffic_selectors
 */
static linked_list_t *get_my_traffic_selectors(private_policy_t *this)
{
	return this->my_ts;
}

/**
 * Implementation of policy_t.get_other_traffic_selectors
 */
static linked_list_t *get_other_traffic_selectors(private_policy_t *this, traffic_selector_t **traffic_selectors[])
{
	return this->other_ts;
}

/**
 * Implementation of private_policy_t.select_my_traffic_selectors
 */
static linked_list_t *select_my_traffic_selectors(private_policy_t *this, linked_list_t *supplied)
{
	return this->select_traffic_selectors(this, this->my_ts, supplied);
}

/**
 * Implementation of private_policy_t.select_other_traffic_selectors
 */
static linked_list_t *select_other_traffic_selectors(private_policy_t *this, linked_list_t *supplied)
{
	return this->select_traffic_selectors(this, this->other_ts, supplied);
}
/**
 * Implementation of private_policy_t.select_traffic_selectors
 */
static linked_list_t *select_traffic_selectors(private_policy_t *this, linked_list_t *stored, linked_list_t *supplied)
{
	iterator_t *supplied_iter, *stored_iter;
	traffic_selector_t *supplied_ts, *stored_ts, *selected_ts;
	linked_list_t *selected = linked_list_create();
	
	
	stored_iter = stored->create_iterator(stored, TRUE);
	supplied_iter = supplied->create_iterator(supplied, TRUE);
	
	/* iterate over all stored selectors */
	while (stored_iter->has_next(stored_iter))
	{
		stored_iter->current(stored_iter, (void**)&stored_ts);
		
		supplied_iter->reset(supplied_iter);
		/* iterate over all supplied traffic selectors */
		while (supplied_iter->has_next(supplied_iter))
		{
			supplied_iter->current(supplied_iter, (void**)&supplied_ts);
			
			selected_ts = stored_ts->get_subset(stored_ts, supplied_ts);
			if (selected_ts)
			{
				/* got a match, add to list */
				selected->insert_last(selected, (void*)selected_ts);
			}
		}
	}
	stored_iter->destroy(stored_iter);
	supplied_iter->destroy(supplied_iter);
	
	return selected;
}

/**
 * Implementation of policy_t.get_proposal_iterator
 */
static linked_list_t *get_proposals(private_policy_t *this)
{
	return this->proposals;
}

/**
 * Implementation of policy_t.select_proposal
 */
static proposal_t *select_proposal(private_policy_t *this, linked_list_t *proposals)
{
	iterator_t *stored_iter, *supplied_iter;
	proposal_t *stored, *supplied, *selected;
	
	stored_iter = this->proposals->create_iterator(this->proposals, TRUE);
	supplied_iter = proposals->create_iterator(proposals, TRUE);
	
	/* compare all stored proposals with all supplied. Stored ones are preferred. */
	while (stored_iter->has_next(stored_iter))
	{
		supplied_iter->reset(supplied_iter);
		stored_iter->current(stored_iter, (void**)&stored);

		while (supplied_iter->has_next(supplied_iter))
		{
			supplied_iter->current(supplied_iter, (void**)&supplied);
			selected = stored->select(stored, supplied);
			if (selected)
			{
				/* they match, return */
				stored_iter->destroy(stored_iter);
				supplied_iter->destroy(supplied_iter);
				return selected;
			}
		}
	}
	
	/* no proposal match :-(, will result in a NO_PROPOSAL_CHOSEN... */
	stored_iter->destroy(stored_iter);
	supplied_iter->destroy(supplied_iter);
	
	return NULL;
}

/**
 * Implementation of policy_t.add_my_traffic_selector
 */
static void add_my_traffic_selector(private_policy_t *this, traffic_selector_t *traffic_selector)
{
	this->my_ts->insert_last(this->my_ts, (void*)traffic_selector);
}

/**
 * Implementation of policy_t.add_other_traffic_selector
 */
static void add_other_traffic_selector(private_policy_t *this, traffic_selector_t *traffic_selector)
{
	this->other_ts->insert_last(this->other_ts, (void*)traffic_selector);
}

/**
 * Implementation of policy_t.add_proposal
 */
static void add_proposal(private_policy_t *this, proposal_t *proposal)
{
	this->proposals->insert_last(this->proposals, (void*)proposal);
}

/**
 * Implements policy_t.destroy.
 */
static status_t destroy(private_policy_t *this)
{	
	proposal_t *proposal;
	traffic_selector_t *traffic_selector;
	
	
	/* delete proposals */
	while(this->proposals->remove_last(this->proposals, (void**)&proposal) == SUCCESS)
	{
		proposal->destroy(proposal);
	}
	this->proposals->destroy(this->proposals);
	
	/* delete traffic selectors */
	while(this->my_ts->remove_last(this->my_ts, (void**)&traffic_selector) == SUCCESS)
	{
		traffic_selector->destroy(traffic_selector);
	}
	this->my_ts->destroy(this->my_ts);
	
	/* delete traffic selectors */
	while(this->other_ts->remove_last(this->other_ts, (void**)&traffic_selector) == SUCCESS)
	{
		traffic_selector->destroy(traffic_selector);
	}
	this->other_ts->destroy(this->other_ts);
	
	/* delete ids */
	this->my_id->destroy(this->my_id);
	this->other_id->destroy(this->other_id);
	
	free(this);
	return SUCCESS;
}

/**
 * Implements policy_t.clone.
 */
static policy_t *clone(private_policy_t *this)
{
	private_policy_t *clone = (private_policy_t*)policy_create(this->my_id->clone(this->my_id), 
															   this->other_id->clone(this->other_id));
	iterator_t *iterator;
	proposal_t *proposal;
	traffic_selector_t *ts;
	
	/* clone all proposals */
	iterator = this->proposals->create_iterator(this->proposals, TRUE);
	while (iterator->has_next(iterator))
	{
		iterator->current(iterator, (void**)&proposal);
		proposal = proposal->clone(proposal);
		clone->proposals->insert_last(clone->proposals, (void*)proposal);
	}
	iterator->destroy(iterator);
	
	/* clone all local traffic selectors */
	iterator = this->my_ts->create_iterator(this->my_ts, TRUE);
	while (iterator->has_next(iterator))
	{
		iterator->current(iterator, (void**)&ts);
		ts = ts->clone(ts);
		clone->my_ts->insert_last(clone->my_ts, (void*)ts);
	}
	iterator->destroy(iterator);
	
	/* clone all remote traffic selectors */
	iterator = this->other_ts->create_iterator(this->other_ts, TRUE);
	while (iterator->has_next(iterator))
	{
		iterator->current(iterator, (void**)&ts);
		ts = ts->clone(ts);
		clone->other_ts->insert_last(clone->other_ts, (void*)ts);
	}
	iterator->destroy(iterator);
	
	return &clone->public;
}

/*
 * Described in header-file
 */
policy_t *policy_create(identification_t *my_id, identification_t *other_id)
{
	private_policy_t *this = malloc_thing(private_policy_t);

	/* public functions */
	this->public.get_my_id = (identification_t*(*)(policy_t*))get_my_id;
	this->public.get_other_id = (identification_t*(*)(policy_t*))get_other_id;
	this->public.update_my_id = (void(*)(policy_t*,identification_t*))update_my_id;
	this->public.update_other_id = (void(*)(policy_t*,identification_t*))update_other_id;
	this->public.update_my_ts = (void(*)(policy_t*,host_t*))update_my_ts;
	this->public.update_other_ts = (void(*)(policy_t*,host_t*))update_other_ts;
	this->public.get_my_traffic_selectors = (linked_list_t*(*)(policy_t*))get_my_traffic_selectors;
	this->public.select_my_traffic_selectors = (linked_list_t*(*)(policy_t*,linked_list_t*))select_my_traffic_selectors;
	this->public.get_other_traffic_selectors = (linked_list_t*(*)(policy_t*))get_other_traffic_selectors;
	this->public.select_other_traffic_selectors = (linked_list_t*(*)(policy_t*,linked_list_t*))select_other_traffic_selectors;
	this->public.get_proposals = (linked_list_t*(*)(policy_t*))get_proposals;
	this->public.select_proposal = (proposal_t*(*)(policy_t*,linked_list_t*))select_proposal;
	this->public.add_my_traffic_selector = (void(*)(policy_t*,traffic_selector_t*))add_my_traffic_selector;
	this->public.add_other_traffic_selector = (void(*)(policy_t*,traffic_selector_t*))add_other_traffic_selector;
	this->public.add_proposal = (void(*)(policy_t*,proposal_t*))add_proposal;
	this->public.clone = (policy_t*(*)(policy_t*))clone;
	this->public.destroy = (void(*)(policy_t*))destroy;
	
	/* apply init values */
	this->my_id = my_id;
	this->other_id = other_id;
	
	/* init private members*/
	this->select_traffic_selectors = select_traffic_selectors;
	this->proposals = linked_list_create();
	this->my_ts = linked_list_create();
	this->other_ts = linked_list_create();

	return (&this->public);
}