2008-04-09 12:54:47 +00:00
|
|
|
/*
|
2009-04-14 10:34:24 +00:00
|
|
|
* Copyright (C) 2008-2009 Martin Willi
|
2008-04-09 12:54:47 +00:00
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @defgroup attribute_manager attribute_manager
|
|
|
|
* @{ @ingroup attributes
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef ATTRIBUTE_MANAGER_H_
|
|
|
|
#define ATTRIBUTE_MANAGER_H_
|
|
|
|
|
2009-10-13 11:46:27 +00:00
|
|
|
#include "attribute_provider.h"
|
|
|
|
#include "attribute_handler.h"
|
2008-04-09 12:54:47 +00:00
|
|
|
|
2014-11-04 14:11:42 +00:00
|
|
|
#include <sa/ike_sa.h>
|
|
|
|
|
2008-04-09 12:54:47 +00:00
|
|
|
typedef struct attribute_manager_t attribute_manager_t;
|
|
|
|
|
|
|
|
/**
|
2009-04-24 14:13:52 +00:00
|
|
|
* The attribute manager hands out attributes or handles them.
|
|
|
|
*
|
|
|
|
* The attribute manager manages both, attribute providers and attribute
|
|
|
|
* handlers. Attribute providers are responsible to hand out attributes if
|
|
|
|
* a connecting peer requests them. Handlers handle such attributes if they
|
|
|
|
* are received on the requesting peer.
|
2008-04-09 12:54:47 +00:00
|
|
|
*/
|
|
|
|
struct attribute_manager_t {
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2008-04-09 12:54:47 +00:00
|
|
|
/**
|
|
|
|
* Acquire a virtual IP address to assign to a peer.
|
|
|
|
*
|
2012-09-11 08:41:11 +00:00
|
|
|
* @param pools list of pool names (char*) to acquire from
|
2014-11-04 14:11:42 +00:00
|
|
|
* @param ike_sa associated IKE_SA for which an address is requested
|
2008-04-09 12:54:47 +00:00
|
|
|
* @param requested IP in configuration request
|
|
|
|
* @return allocated address, NULL to serve none
|
|
|
|
*/
|
|
|
|
host_t* (*acquire_address)(attribute_manager_t *this,
|
2014-11-04 14:11:42 +00:00
|
|
|
linked_list_t *pool, ike_sa_t *ike_sa,
|
2009-04-14 10:34:24 +00:00
|
|
|
host_t *requested);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2008-04-09 12:54:47 +00:00
|
|
|
/**
|
|
|
|
* Release a previously acquired address.
|
|
|
|
*
|
2012-09-11 09:19:56 +00:00
|
|
|
* @param pools list of pool names (char*) to release to
|
2008-04-09 12:54:47 +00:00
|
|
|
* @param address address to release
|
2014-11-04 14:11:42 +00:00
|
|
|
* @param ike_sa associated IKE_SA for which an address is released
|
2012-08-24 12:31:24 +00:00
|
|
|
* @return TRUE if address released to pool
|
2008-04-09 12:54:47 +00:00
|
|
|
*/
|
2012-08-24 12:31:24 +00:00
|
|
|
bool (*release_address)(attribute_manager_t *this,
|
2012-09-11 09:19:56 +00:00
|
|
|
linked_list_t *pools, host_t *address,
|
2014-11-04 14:11:42 +00:00
|
|
|
ike_sa_t *ike_sa);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2009-04-24 14:13:52 +00:00
|
|
|
/**
|
|
|
|
* Create an enumerator over attributes to hand out to a peer.
|
|
|
|
*
|
2012-08-27 12:48:41 +00:00
|
|
|
* @param pool list of pools names (char*) to query attributes from
|
2014-11-04 14:11:42 +00:00
|
|
|
* @param ike_sa associated IKE_SA for which attributes are requested
|
2012-08-27 12:09:47 +00:00
|
|
|
* @param vip list of virtual IPs (host_t*) to assign to peer
|
2009-04-24 14:13:52 +00:00
|
|
|
* @return enumerator (configuration_attribute_type_t, chunk_t)
|
|
|
|
*/
|
2009-11-17 13:51:50 +00:00
|
|
|
enumerator_t* (*create_responder_enumerator)(attribute_manager_t *this,
|
2014-11-04 14:11:42 +00:00
|
|
|
linked_list_t *pool, ike_sa_t *ike_sa,
|
2012-08-27 12:48:41 +00:00
|
|
|
linked_list_t *vips);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2008-04-09 12:54:47 +00:00
|
|
|
/**
|
|
|
|
* Register an attribute provider to the manager.
|
|
|
|
*
|
|
|
|
* @param provider attribute provider to register
|
|
|
|
*/
|
|
|
|
void (*add_provider)(attribute_manager_t *this,
|
|
|
|
attribute_provider_t *provider);
|
|
|
|
/**
|
|
|
|
* Unregister an attribute provider from the manager.
|
|
|
|
*
|
|
|
|
* @param provider attribute provider to unregister
|
|
|
|
*/
|
|
|
|
void (*remove_provider)(attribute_manager_t *this,
|
|
|
|
attribute_provider_t *provider);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2009-04-24 14:13:52 +00:00
|
|
|
/**
|
|
|
|
* Handle a configuration attribute by passing them to the handlers.
|
|
|
|
*
|
2014-11-04 14:20:41 +00:00
|
|
|
* @param ike_sa associated IKE_SA to handle an attribute for
|
2009-11-17 13:51:50 +00:00
|
|
|
* @param handler handler we requested the attribute for, if any
|
2009-04-24 14:13:52 +00:00
|
|
|
* @param type type of configuration attribute
|
|
|
|
* @param data associated attribute data
|
|
|
|
* @return handler which handled this attribute, NULL if none
|
|
|
|
*/
|
2009-10-13 11:46:27 +00:00
|
|
|
attribute_handler_t* (*handle)(attribute_manager_t *this,
|
2014-11-04 14:20:41 +00:00
|
|
|
ike_sa_t *ike_sa, attribute_handler_t *handler,
|
2009-11-17 13:51:50 +00:00
|
|
|
configuration_attribute_type_t type, chunk_t data);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2009-04-24 14:13:52 +00:00
|
|
|
/**
|
|
|
|
* Release an attribute previously handle()d by a handler.
|
|
|
|
*
|
2014-11-04 14:20:41 +00:00
|
|
|
* @param ike_sa associated IKE_SA to release an attribute for
|
2009-10-13 11:46:27 +00:00
|
|
|
* @param server server from which the attribute was received
|
2009-04-24 14:13:52 +00:00
|
|
|
* @param type type of attribute to release
|
|
|
|
* @param data associated attribute data
|
|
|
|
*/
|
|
|
|
void (*release)(attribute_manager_t *this, attribute_handler_t *handler,
|
2014-11-04 14:20:41 +00:00
|
|
|
ike_sa_t *ike_sa, configuration_attribute_type_t type,
|
2009-04-24 14:13:52 +00:00
|
|
|
chunk_t data);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2009-11-17 13:51:50 +00:00
|
|
|
/**
|
|
|
|
* Create an enumerator over attributes to request from server.
|
|
|
|
*
|
2014-11-04 14:20:41 +00:00
|
|
|
* @param ike_sa associated IKE_SA to request attributes for
|
2012-08-27 12:09:47 +00:00
|
|
|
* @param vip list of virtual IPs (host_t*) going to request
|
2009-11-17 13:51:50 +00:00
|
|
|
* @return enumerator (attribute_handler_t, ca_type_t, chunk_t)
|
|
|
|
*/
|
|
|
|
enumerator_t* (*create_initiator_enumerator)(attribute_manager_t *this,
|
2014-11-04 14:20:41 +00:00
|
|
|
ike_sa_t *ike_sa, linked_list_t *vips);
|
2009-11-17 13:51:50 +00:00
|
|
|
|
2009-04-24 14:13:52 +00:00
|
|
|
/**
|
|
|
|
* Register an attribute handler to the manager.
|
|
|
|
*
|
|
|
|
* @param handler attribute handler to register
|
|
|
|
*/
|
|
|
|
void (*add_handler)(attribute_manager_t *this,
|
|
|
|
attribute_handler_t *handler);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2009-04-24 14:13:52 +00:00
|
|
|
/**
|
|
|
|
* Unregister an attribute handler from the manager.
|
|
|
|
*
|
|
|
|
* @param handler attribute handler to unregister
|
|
|
|
*/
|
|
|
|
void (*remove_handler)(attribute_manager_t *this,
|
|
|
|
attribute_handler_t *handler);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2008-04-09 12:54:47 +00:00
|
|
|
/**
|
2009-04-22 08:26:54 +00:00
|
|
|
* Destroy a attribute_manager instance.
|
|
|
|
*/
|
|
|
|
void (*destroy)(attribute_manager_t *this);
|
2008-04-09 12:54:47 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Create a attribute_manager instance.
|
|
|
|
*/
|
|
|
|
attribute_manager_t *attribute_manager_create();
|
|
|
|
|
2009-03-24 17:43:01 +00:00
|
|
|
#endif /** ATTRIBUTE_MANAGER_H_ @}*/
|