2007-04-10 06:01:03 +00:00
|
|
|
/*
|
2008-05-08 16:19:11 +00:00
|
|
|
* Copyright (C) 2008 Tobias Brunner
|
2007-04-10 06:01:03 +00:00
|
|
|
* Copyright (C) 2005-2007 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 <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.
|
2008-03-13 14:14:44 +00:00
|
|
|
*
|
|
|
|
* $Id$
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @defgroup child_cfg child_cfg
|
|
|
|
* @{ @ingroup config
|
2007-04-10 06:01:03 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef CHILD_CFG_H_
|
|
|
|
#define CHILD_CFG_H_
|
|
|
|
|
2008-04-11 08:14:48 +00:00
|
|
|
typedef enum action_t action_t;
|
2008-05-08 16:19:11 +00:00
|
|
|
typedef enum ipcomp_transform_t ipcomp_transform_t;
|
2007-04-10 06:01:03 +00:00
|
|
|
typedef struct child_cfg_t child_cfg_t;
|
|
|
|
|
|
|
|
#include <library.h>
|
|
|
|
#include <config/proposal.h>
|
|
|
|
#include <config/traffic_selector.h>
|
2008-09-25 13:56:23 +00:00
|
|
|
#include <kernel/kernel_ipsec.h>
|
2007-04-10 06:01:03 +00:00
|
|
|
|
2008-04-11 08:14:48 +00:00
|
|
|
/**
|
|
|
|
* Action to take when DPD detected/connection gets closed by peer.
|
|
|
|
*/
|
|
|
|
enum action_t {
|
|
|
|
/** No action */
|
|
|
|
ACTION_NONE,
|
|
|
|
/** Route config to reestablish on demand */
|
|
|
|
ACTION_ROUTE,
|
|
|
|
/** Restart config immediately */
|
|
|
|
ACTION_RESTART,
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* enum names for action_t.
|
|
|
|
*/
|
|
|
|
extern enum_name_t *action_names;
|
|
|
|
|
2008-05-08 16:19:11 +00:00
|
|
|
/**
|
|
|
|
* IPComp transform IDs, as in RFC 4306
|
|
|
|
*/
|
|
|
|
enum ipcomp_transform_t {
|
|
|
|
IPCOMP_NONE = 241,
|
|
|
|
IPCOMP_OUI = 1,
|
|
|
|
IPCOMP_DEFLATE = 2,
|
|
|
|
IPCOMP_LZS = 3,
|
|
|
|
IPCOMP_LZJH = 4,
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* enum strings for ipcomp_transform_t.
|
|
|
|
*/
|
|
|
|
extern enum_name_t *ipcomp_transform_names;
|
|
|
|
|
2007-04-10 06:01:03 +00:00
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* A child_cfg_t defines the config template for a CHILD_SA.
|
2007-04-10 06:01:03 +00:00
|
|
|
*
|
|
|
|
* After creation, proposals and traffic selectors may be added to the config.
|
|
|
|
* A child_cfg object is referenced multiple times, and is not thread save.
|
2007-04-11 07:20:39 +00:00
|
|
|
* Reading from the object is save, adding things is not allowed while other
|
2007-04-10 06:01:03 +00:00
|
|
|
* threads may access the object.
|
|
|
|
* A reference counter handles the number of references hold to this config.
|
2007-04-11 07:20:39 +00:00
|
|
|
*
|
|
|
|
* @see peer_cfg_t to get an overview over the configurations.
|
2007-04-10 06:01:03 +00:00
|
|
|
*/
|
|
|
|
struct child_cfg_t {
|
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Get the name of the child_cfg.
|
2007-04-10 06:01:03 +00:00
|
|
|
*
|
|
|
|
* @return child_cfg's name
|
|
|
|
*/
|
|
|
|
char *(*get_name) (child_cfg_t *this);
|
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Add a proposal to the list.
|
2007-04-10 06:01:03 +00:00
|
|
|
*
|
|
|
|
* The proposals are stored by priority, first added
|
|
|
|
* is the most prefered.
|
|
|
|
* After add, proposal is owned by child_cfg.
|
|
|
|
*
|
|
|
|
* @param proposal proposal to add
|
|
|
|
*/
|
|
|
|
void (*add_proposal) (child_cfg_t *this, proposal_t *proposal);
|
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Get the list of proposals for the CHILD_SA.
|
2007-04-10 06:01:03 +00:00
|
|
|
*
|
|
|
|
* Resulting list and all of its proposals must be freed after use.
|
|
|
|
*
|
2007-04-19 08:02:19 +00:00
|
|
|
* @param strip_dh TRUE strip out diffie hellman groups
|
2007-04-10 06:01:03 +00:00
|
|
|
* @return list of proposals
|
|
|
|
*/
|
2007-04-19 08:02:19 +00:00
|
|
|
linked_list_t* (*get_proposals)(child_cfg_t *this, bool strip_dh);
|
2007-04-10 06:01:03 +00:00
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Select a proposal from a supplied list.
|
2007-04-10 06:01:03 +00:00
|
|
|
*
|
|
|
|
* Returned propsal is newly created and must be destroyed after usage.
|
|
|
|
*
|
|
|
|
* @param proposals list from from wich proposals are selected
|
2007-04-19 08:02:19 +00:00
|
|
|
* @param strip_dh TRUE strip out diffie hellman groups
|
2007-04-10 06:01:03 +00:00
|
|
|
* @return selected proposal, or NULL if nothing matches
|
|
|
|
*/
|
2007-04-19 08:02:19 +00:00
|
|
|
proposal_t* (*select_proposal)(child_cfg_t*this, linked_list_t *proposals,
|
|
|
|
bool strip_dh);
|
2007-04-10 06:01:03 +00:00
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Add a traffic selector to the config.
|
2007-04-10 06:01:03 +00:00
|
|
|
*
|
|
|
|
* Use the "local" parameter to add it for the local or the remote side.
|
|
|
|
* After add, traffic selector is owned by child_cfg.
|
|
|
|
*
|
|
|
|
* @param local TRUE for local side, FALSE for remote
|
|
|
|
* @param ts traffic_selector to add
|
|
|
|
*/
|
|
|
|
void (*add_traffic_selector)(child_cfg_t *this, bool local,
|
|
|
|
traffic_selector_t *ts);
|
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Get a list of traffic selectors to use for the CHILD_SA.
|
2007-04-10 06:01:03 +00:00
|
|
|
*
|
|
|
|
* The config contains two set of traffic selectors, one for the local
|
|
|
|
* side, one for the remote side.
|
|
|
|
* If a list with traffic selectors is supplied, these are used to narrow
|
|
|
|
* down the traffic selector list to the greatest common divisor.
|
|
|
|
* Some traffic selector may be "dymamic", meaning they are narrowed down
|
|
|
|
* to a specific address (host-to-host or virtual-IP setups). Use
|
|
|
|
* the "host" parameter to narrow such traffic selectors to that address.
|
|
|
|
* Resulted list and its traffic selectors must be destroyed after use.
|
|
|
|
*
|
|
|
|
* @param local TRUE for TS on local side, FALSE for remote
|
|
|
|
* @param supplied list with TS to select from, or NULL
|
|
|
|
* @param host address to use for narrowing "dynamic" TS', or NULL
|
|
|
|
* @return list containing the traffic selectors
|
|
|
|
*/
|
|
|
|
linked_list_t *(*get_traffic_selectors)(child_cfg_t *this, bool local,
|
|
|
|
linked_list_t *supplied,
|
|
|
|
host_t *host);
|
|
|
|
|
2008-11-03 02:05:41 +00:00
|
|
|
/**
|
|
|
|
* Checks the [single] traffic selectors for equality
|
|
|
|
*
|
|
|
|
* @param local TRUE for TS on local side, FALSE for remote
|
|
|
|
* @param ts single traffic selector to compare with
|
|
|
|
* @return TRUE if TS are equal, FALSE otherwise
|
|
|
|
*/
|
|
|
|
bool (*equal_traffic_selectors)(child_cfg_t *this, bool local,
|
|
|
|
traffic_selector_t *ts);
|
|
|
|
|
2007-04-10 06:01:03 +00:00
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Get the updown script to run for the CHILD_SA.
|
2007-04-10 06:01:03 +00:00
|
|
|
*
|
|
|
|
* @return path to updown script
|
|
|
|
*/
|
|
|
|
char* (*get_updown)(child_cfg_t *this);
|
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Should we allow access to the local host (gateway)?
|
2007-04-10 06:01:03 +00:00
|
|
|
*
|
|
|
|
* @return value of hostaccess flag
|
|
|
|
*/
|
|
|
|
bool (*get_hostaccess) (child_cfg_t *this);
|
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Get the lifetime of a CHILD_SA.
|
2007-04-10 06:01:03 +00:00
|
|
|
*
|
|
|
|
* If "rekey" is set to TRUE, a lifetime is returned before the first
|
|
|
|
* rekeying should be started. If it is FALSE, the actual lifetime is
|
|
|
|
* returned when the CHILD_SA must be deleted.
|
|
|
|
* The rekey time automatically contains a jitter to avoid simlutaneous
|
|
|
|
* rekeying.
|
|
|
|
*
|
|
|
|
* @param rekey TRUE to get rekey time
|
|
|
|
* @return lifetime in seconds
|
|
|
|
*/
|
|
|
|
u_int32_t (*get_lifetime) (child_cfg_t *this, bool rekey);
|
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Get the mode to use for the CHILD_SA.
|
2007-04-10 06:01:03 +00:00
|
|
|
*
|
|
|
|
* The mode is either tunnel, transport or BEET. The peer must agree
|
|
|
|
* on the method, fallback is tunnel mode.
|
|
|
|
*
|
2008-04-11 08:14:48 +00:00
|
|
|
* @return ipsec mode
|
2007-04-10 06:01:03 +00:00
|
|
|
*/
|
2008-09-25 13:56:23 +00:00
|
|
|
ipsec_mode_t (*get_mode) (child_cfg_t *this);
|
2007-04-10 06:01:03 +00:00
|
|
|
|
2008-04-11 08:14:48 +00:00
|
|
|
/**
|
2008-04-14 08:17:18 +00:00
|
|
|
* Action to take on DPD.
|
2008-04-11 08:14:48 +00:00
|
|
|
*
|
2008-04-14 08:17:18 +00:00
|
|
|
* @return DPD action
|
2008-04-11 08:14:48 +00:00
|
|
|
*/
|
2008-04-14 08:17:18 +00:00
|
|
|
action_t (*get_dpd_action) (child_cfg_t *this);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Action to take if CHILD_SA gets closed.
|
|
|
|
*
|
|
|
|
* @return close action
|
|
|
|
*/
|
|
|
|
action_t (*get_close_action) (child_cfg_t *this);
|
2008-04-11 08:14:48 +00:00
|
|
|
|
2007-04-19 08:02:19 +00:00
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Get the DH group to use for CHILD_SA setup.
|
2007-04-19 08:02:19 +00:00
|
|
|
*
|
2008-03-13 14:14:44 +00:00
|
|
|
* @return dh group to use
|
2007-04-19 08:02:19 +00:00
|
|
|
*/
|
|
|
|
diffie_hellman_group_t (*get_dh_group)(child_cfg_t *this);
|
|
|
|
|
2008-05-08 16:19:11 +00:00
|
|
|
/**
|
|
|
|
* Check whether IPComp should be used, if the other peer supports it.
|
|
|
|
*
|
|
|
|
* @return TRUE, if IPComp should be used
|
|
|
|
* FALSE, otherwise
|
|
|
|
*/
|
|
|
|
bool (*use_ipcomp)(child_cfg_t *this);
|
|
|
|
|
2007-04-10 06:01:03 +00:00
|
|
|
/**
|
2008-05-06 10:55:42 +00:00
|
|
|
* Increase the reference count.
|
2007-04-10 06:01:03 +00:00
|
|
|
*
|
2008-05-06 10:55:42 +00:00
|
|
|
* @return reference to this
|
2007-04-10 06:01:03 +00:00
|
|
|
*/
|
2008-05-06 10:55:42 +00:00
|
|
|
child_cfg_t* (*get_ref) (child_cfg_t *this);
|
2007-04-10 06:01:03 +00:00
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Destroys the child_cfg object.
|
2007-04-10 06:01:03 +00:00
|
|
|
*
|
|
|
|
* Decrements the internal reference counter and
|
|
|
|
* destroys the child_cfg when it reaches zero.
|
|
|
|
*/
|
|
|
|
void (*destroy) (child_cfg_t *this);
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
2008-03-13 14:14:44 +00:00
|
|
|
* Create a configuration template for CHILD_SA setup.
|
2007-04-10 06:01:03 +00:00
|
|
|
*
|
|
|
|
* The "name" string gets cloned.
|
|
|
|
* Lifetimes are in seconds. To prevent to peers to start rekeying at the
|
|
|
|
* same time, a jitter may be specified. Rekeying of an SA starts at
|
|
|
|
* (rekeytime - random(0, jitter)). You should specify
|
|
|
|
* lifetime > rekeytime > jitter.
|
|
|
|
* After a call to create, a reference is obtained (refcount = 1).
|
|
|
|
*
|
|
|
|
* @param name name of the child_cfg
|
|
|
|
* @param lifetime lifetime after CHILD_SA expires and gets deleted
|
|
|
|
* @param rekeytime time when rekeying should be initiated
|
|
|
|
* @param jitter range of randomization time to remove from rekeytime
|
|
|
|
* @param updown updown script to execute on up/down event
|
|
|
|
* @param hostaccess TRUE to allow access to the local host
|
|
|
|
* @param mode mode to propose for CHILD_SA, transport, tunnel or BEET
|
2008-04-14 08:17:18 +00:00
|
|
|
* @param dpd_action DPD action
|
2008-05-08 16:19:11 +00:00
|
|
|
* @param close_action close action
|
|
|
|
* @param ipcomp use IPComp, if peer supports it
|
2007-04-10 06:01:03 +00:00
|
|
|
* @return child_cfg_t object
|
|
|
|
*/
|
|
|
|
child_cfg_t *child_cfg_create(char *name, u_int32_t lifetime,
|
2007-04-11 07:20:39 +00:00
|
|
|
u_int32_t rekeytime, u_int32_t jitter,
|
2008-09-25 13:56:23 +00:00
|
|
|
char *updown, bool hostaccess, ipsec_mode_t mode,
|
2008-05-08 16:19:11 +00:00
|
|
|
action_t dpd_action, action_t close_action,
|
|
|
|
bool ipcomp);
|
2007-04-10 06:01:03 +00:00
|
|
|
|
2008-03-13 14:14:44 +00:00
|
|
|
#endif /* CHILD_CFG_H_ @} */
|