2008-09-25 07:56:58 +00:00
|
|
|
/*
|
2009-08-27 09:41:52 +00:00
|
|
|
* Copyright (C) 2006-2009 Tobias Brunner
|
2008-09-25 07:56:58 +00:00
|
|
|
* Copyright (C) 2006 Daniel Roethlisberger
|
|
|
|
* Copyright (C) 2005-2006 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.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @defgroup kernel_ipsec kernel_ipsec
|
|
|
|
* @{ @ingroup kernel
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef KERNEL_IPSEC_H_
|
|
|
|
#define KERNEL_IPSEC_H_
|
|
|
|
|
2008-09-25 13:56:23 +00:00
|
|
|
typedef enum ipsec_mode_t ipsec_mode_t;
|
2008-09-25 07:56:58 +00:00
|
|
|
typedef enum policy_dir_t policy_dir_t;
|
|
|
|
typedef struct kernel_ipsec_t kernel_ipsec_t;
|
|
|
|
|
|
|
|
#include <utils/host.h>
|
|
|
|
#include <crypto/prf_plus.h>
|
2009-08-27 09:41:52 +00:00
|
|
|
#include <config/proposal.h>
|
|
|
|
#include <config/child_cfg.h>
|
2008-09-25 07:56:58 +00:00
|
|
|
|
2008-09-25 13:56:23 +00:00
|
|
|
/**
|
2009-04-30 11:37:54 +00:00
|
|
|
* Mode of a CHILD_SA.
|
2008-09-25 13:56:23 +00:00
|
|
|
*/
|
|
|
|
enum ipsec_mode_t {
|
|
|
|
/** transport mode, no inner address */
|
2009-04-30 11:37:54 +00:00
|
|
|
MODE_TRANSPORT = 1,
|
2008-09-25 13:56:23 +00:00
|
|
|
/** tunnel mode, inner and outer addresses */
|
2009-04-30 11:37:54 +00:00
|
|
|
MODE_TUNNEL,
|
2008-09-25 13:56:23 +00:00
|
|
|
/** BEET mode, tunnel mode but fixed, bound inner addresses */
|
2009-04-30 11:37:54 +00:00
|
|
|
MODE_BEET,
|
2008-09-25 13:56:23 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* enum names for ipsec_mode_t.
|
|
|
|
*/
|
|
|
|
extern enum_name_t *ipsec_mode_names;
|
|
|
|
|
2008-09-25 07:56:58 +00:00
|
|
|
/**
|
|
|
|
* Direction of a policy. These are equal to those
|
|
|
|
* defined in xfrm.h, but we want to stay implementation
|
|
|
|
* neutral here.
|
|
|
|
*/
|
|
|
|
enum policy_dir_t {
|
|
|
|
/** Policy for inbound traffic */
|
|
|
|
POLICY_IN = 0,
|
|
|
|
/** Policy for outbound traffic */
|
|
|
|
POLICY_OUT = 1,
|
|
|
|
/** Policy for forwarded traffic */
|
|
|
|
POLICY_FWD = 2,
|
|
|
|
};
|
|
|
|
|
2008-10-14 08:46:31 +00:00
|
|
|
/**
|
|
|
|
* enum names for policy_dir_t.
|
|
|
|
*/
|
|
|
|
extern enum_name_t *policy_dir_names;
|
|
|
|
|
2008-09-25 07:56:58 +00:00
|
|
|
/**
|
|
|
|
* Interface to the ipsec subsystem of the kernel.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2008-09-25 07:56:58 +00:00
|
|
|
* The kernel ipsec interface handles the communication with the kernel
|
2009-09-04 11:46:09 +00:00
|
|
|
* for SA and policy management. It allows setup of these, and provides
|
2008-09-25 07:56:58 +00:00
|
|
|
* further the handling of kernel events.
|
|
|
|
* Policy information are cached in the interface. This is necessary to do
|
|
|
|
* reference counting. The Linux kernel does not allow the same policy
|
|
|
|
* installed twice, but we need this as CHILD_SA exist multiple times
|
|
|
|
* when rekeying. Thats why we do reference counting of policies.
|
|
|
|
*/
|
|
|
|
struct kernel_ipsec_t {
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2008-09-25 07:56:58 +00:00
|
|
|
/**
|
|
|
|
* Get a SPI from the kernel.
|
|
|
|
*
|
|
|
|
* @param src source address of SA
|
|
|
|
* @param dst destination address of SA
|
|
|
|
* @param protocol protocol for SA (ESP/AH)
|
|
|
|
* @param reqid unique ID for this SA
|
|
|
|
* @param spi allocated spi
|
|
|
|
* @return SUCCESS if operation completed
|
|
|
|
*/
|
2009-09-04 11:46:09 +00:00
|
|
|
status_t (*get_spi)(kernel_ipsec_t *this, host_t *src, host_t *dst,
|
2008-09-25 07:56:58 +00:00
|
|
|
protocol_id_t protocol, u_int32_t reqid, u_int32_t *spi);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2008-09-25 07:56:58 +00:00
|
|
|
/**
|
|
|
|
* Get a Compression Parameter Index (CPI) from the kernel.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2008-09-25 07:56:58 +00:00
|
|
|
* @param src source address of SA
|
|
|
|
* @param dst destination address of SA
|
|
|
|
* @param reqid unique ID for the corresponding SA
|
|
|
|
* @param cpi allocated cpi
|
|
|
|
* @return SUCCESS if operation completed
|
|
|
|
*/
|
2009-09-04 11:46:09 +00:00
|
|
|
status_t (*get_cpi)(kernel_ipsec_t *this, host_t *src, host_t *dst,
|
2008-09-25 07:56:58 +00:00
|
|
|
u_int32_t reqid, u_int16_t *cpi);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2008-09-25 07:56:58 +00:00
|
|
|
/**
|
|
|
|
* Add an SA to the SAD.
|
2009-08-27 09:41:52 +00:00
|
|
|
*
|
2008-09-25 07:56:58 +00:00
|
|
|
* add_sa() may update an already allocated
|
|
|
|
* SPI (via get_spi). In this case, the replace
|
|
|
|
* flag must be set.
|
|
|
|
* This function does install a single SA for a
|
2009-08-27 09:41:52 +00:00
|
|
|
* single protocol in one direction.
|
|
|
|
*
|
2008-09-25 07:56:58 +00:00
|
|
|
* @param src source address for this SA
|
|
|
|
* @param dst destination address for this SA
|
|
|
|
* @param spi SPI allocated by us or remote peer
|
|
|
|
* @param protocol protocol for this SA (ESP/AH)
|
|
|
|
* @param reqid unique ID for this SA
|
2009-08-27 09:41:52 +00:00
|
|
|
* @param lifetime lifetime_cfg_t for this SA
|
2008-09-25 07:56:58 +00:00
|
|
|
* @param enc_alg Algorithm to use for encryption (ESP only)
|
2008-10-14 15:17:44 +00:00
|
|
|
* @param enc_key key to use for encryption
|
2008-09-25 07:56:58 +00:00
|
|
|
* @param int_alg Algorithm to use for integrity protection
|
2008-10-14 15:17:44 +00:00
|
|
|
* @param int_key key to use for integrity protection
|
2008-09-25 07:56:58 +00:00
|
|
|
* @param mode mode of the SA (tunnel, transport)
|
|
|
|
* @param ipcomp IPComp transform to use
|
2008-11-11 09:22:00 +00:00
|
|
|
* @param cpi CPI for IPComp
|
2008-09-25 07:56:58 +00:00
|
|
|
* @param encap enable UDP encapsulation for NAT traversal
|
2008-11-11 09:22:00 +00:00
|
|
|
* @param inbound TRUE if this is an inbound SA
|
2008-09-25 07:56:58 +00:00
|
|
|
* @return SUCCESS if operation completed
|
|
|
|
*/
|
|
|
|
status_t (*add_sa) (kernel_ipsec_t *this,
|
|
|
|
host_t *src, host_t *dst, u_int32_t spi,
|
|
|
|
protocol_id_t protocol, u_int32_t reqid,
|
2009-08-27 09:41:52 +00:00
|
|
|
lifetime_cfg_t *lifetime,
|
|
|
|
u_int16_t enc_alg, chunk_t enc_key,
|
|
|
|
u_int16_t int_alg, chunk_t int_key,
|
2008-11-11 09:22:00 +00:00
|
|
|
ipsec_mode_t mode, u_int16_t ipcomp, u_int16_t cpi,
|
|
|
|
bool encap, bool inbound);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2008-09-25 07:56:58 +00:00
|
|
|
/**
|
|
|
|
* Update the hosts on an installed SA.
|
|
|
|
*
|
|
|
|
* We cannot directly update the destination address as the kernel
|
|
|
|
* requires the spi, the protocol AND the destination address (and family)
|
|
|
|
* to identify SAs. Therefore if the destination address changed we
|
|
|
|
* create a new SA and delete the old one.
|
|
|
|
*
|
|
|
|
* @param spi SPI of the SA
|
|
|
|
* @param protocol protocol for this SA (ESP/AH)
|
2008-11-11 09:22:00 +00:00
|
|
|
* @param cpi CPI for IPComp, 0 if no IPComp is used
|
2008-09-25 07:56:58 +00:00
|
|
|
* @param src current source address
|
|
|
|
* @param dst current destination address
|
|
|
|
* @param new_src new source address
|
|
|
|
* @param new_dst new destination address
|
2008-11-11 09:22:00 +00:00
|
|
|
* @param encap current use of UDP encapsulation
|
|
|
|
* @param new_encap new use of UDP encapsulation
|
|
|
|
* @return SUCCESS if operation completed, NOT_SUPPORTED if
|
|
|
|
* the kernel interface can't update the SA
|
2008-09-25 07:56:58 +00:00
|
|
|
*/
|
|
|
|
status_t (*update_sa)(kernel_ipsec_t *this,
|
2008-11-11 09:22:00 +00:00
|
|
|
u_int32_t spi, protocol_id_t protocol, u_int16_t cpi,
|
2009-09-04 11:46:09 +00:00
|
|
|
host_t *src, host_t *dst,
|
2008-11-11 09:22:00 +00:00
|
|
|
host_t *new_src, host_t *new_dst,
|
|
|
|
bool encap, bool new_encap);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2009-07-30 19:33:19 +00:00
|
|
|
/**
|
|
|
|
* Query the number of bytes processed by an SA from the SAD.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2009-07-30 19:33:19 +00:00
|
|
|
* @param src source address for this SA
|
|
|
|
* @param dst destination address for this SA
|
|
|
|
* @param spi SPI allocated by us or remote peer
|
|
|
|
* @param protocol protocol for this SA (ESP/AH)
|
|
|
|
* @param[out] bytes the number of bytes processed by SA
|
|
|
|
* @return SUCCESS if operation completed
|
|
|
|
*/
|
|
|
|
status_t (*query_sa) (kernel_ipsec_t *this, host_t *src, host_t *dst,
|
|
|
|
u_int32_t spi, protocol_id_t protocol, u_int64_t *bytes);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2008-09-25 07:56:58 +00:00
|
|
|
/**
|
|
|
|
* Delete a previusly installed SA from the SAD.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2009-04-30 11:37:54 +00:00
|
|
|
* @param src source address for this SA
|
2008-09-25 07:56:58 +00:00
|
|
|
* @param dst destination address for this SA
|
|
|
|
* @param spi SPI allocated by us or remote peer
|
|
|
|
* @param protocol protocol for this SA (ESP/AH)
|
2008-11-11 09:22:00 +00:00
|
|
|
* @param cpi CPI for IPComp or 0
|
2008-09-25 07:56:58 +00:00
|
|
|
* @return SUCCESS if operation completed
|
|
|
|
*/
|
2009-04-30 11:37:54 +00:00
|
|
|
status_t (*del_sa) (kernel_ipsec_t *this, host_t *src, host_t *dst,
|
|
|
|
u_int32_t spi, protocol_id_t protocol, u_int16_t cpi);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2008-09-25 07:56:58 +00:00
|
|
|
/**
|
|
|
|
* Add a policy to the SPD.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2008-09-25 07:56:58 +00:00
|
|
|
* A policy is always associated to an SA. Traffic which matches a
|
|
|
|
* policy is handled by the SA with the same reqid.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2008-09-25 07:56:58 +00:00
|
|
|
* @param src source address of SA
|
|
|
|
* @param dst dest address of SA
|
|
|
|
* @param src_ts traffic selector to match traffic source
|
|
|
|
* @param dst_ts traffic selector to match traffic dest
|
|
|
|
* @param direction direction of traffic, POLICY_IN, POLICY_OUT, POLICY_FWD
|
2008-11-11 09:22:00 +00:00
|
|
|
* @param spi SPI of SA
|
2008-09-25 07:56:58 +00:00
|
|
|
* @param protocol protocol to use to protect traffic (AH/ESP)
|
|
|
|
* @param reqid unique ID of an SA to use to enforce policy
|
|
|
|
* @param mode mode of SA (tunnel, transport)
|
|
|
|
* @param ipcomp the IPComp transform used
|
2008-11-11 09:22:00 +00:00
|
|
|
* @param cpi CPI for IPComp
|
|
|
|
* @param routed TRUE, if this policy is routed in the kernel
|
2008-09-25 07:56:58 +00:00
|
|
|
* @return SUCCESS if operation completed
|
|
|
|
*/
|
|
|
|
status_t (*add_policy) (kernel_ipsec_t *this,
|
|
|
|
host_t *src, host_t *dst,
|
|
|
|
traffic_selector_t *src_ts,
|
|
|
|
traffic_selector_t *dst_ts,
|
2008-11-11 09:22:00 +00:00
|
|
|
policy_dir_t direction, u_int32_t spi,
|
|
|
|
protocol_id_t protocol, u_int32_t reqid,
|
|
|
|
ipsec_mode_t mode, u_int16_t ipcomp, u_int16_t cpi,
|
|
|
|
bool routed);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2008-09-25 07:56:58 +00:00
|
|
|
/**
|
|
|
|
* Query the use time of a policy.
|
|
|
|
*
|
2009-08-31 15:59:00 +00:00
|
|
|
* The use time of a policy is the time the policy was used for the last
|
|
|
|
* time. It is not the system time, but a monotonic timestamp as returned
|
|
|
|
* by time_monotonic.
|
2009-09-04 11:46:09 +00:00
|
|
|
*
|
2008-09-25 07:56:58 +00:00
|
|
|
* @param src_ts traffic selector to match traffic source
|
|
|
|
* @param dst_ts traffic selector to match traffic dest
|
|
|
|
* @param direction direction of traffic, POLICY_IN, POLICY_OUT, POLICY_FWD
|
2009-08-31 15:59:00 +00:00
|
|
|
* @param[out] use_time the monotonic timestamp of this SA's last use
|
2008-09-25 07:56:58 +00:00
|
|
|
* @return SUCCESS if operation completed
|
|
|
|
*/
|
|
|
|
status_t (*query_policy) (kernel_ipsec_t *this,
|
2009-09-04 11:46:09 +00:00
|
|
|
traffic_selector_t *src_ts,
|
2008-09-25 07:56:58 +00:00
|
|
|
traffic_selector_t *dst_ts,
|
|
|
|
policy_dir_t direction, u_int32_t *use_time);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2008-09-25 07:56:58 +00:00
|
|
|
/**
|
|
|
|
* Remove a policy from the SPD.
|
|
|
|
*
|
|
|
|
* The kernel interface implements reference counting for policies.
|
|
|
|
* If the same policy is installed multiple times (in the case of rekeying),
|
|
|
|
* the reference counter is increased. del_policy() decreases the ref counter
|
|
|
|
* and removes the policy only when no more references are available.
|
|
|
|
*
|
|
|
|
* @param src_ts traffic selector to match traffic source
|
|
|
|
* @param dst_ts traffic selector to match traffic dest
|
|
|
|
* @param direction direction of traffic, POLICY_IN, POLICY_OUT, POLICY_FWD
|
2008-11-11 09:22:00 +00:00
|
|
|
* @param unrouted TRUE, if this policy is unrouted from the kernel
|
2008-09-25 07:56:58 +00:00
|
|
|
* @return SUCCESS if operation completed
|
|
|
|
*/
|
|
|
|
status_t (*del_policy) (kernel_ipsec_t *this,
|
2009-09-04 11:46:09 +00:00
|
|
|
traffic_selector_t *src_ts,
|
2008-09-25 07:56:58 +00:00
|
|
|
traffic_selector_t *dst_ts,
|
2008-11-11 09:22:00 +00:00
|
|
|
policy_dir_t direction,
|
|
|
|
bool unrouted);
|
2009-09-04 11:46:09 +00:00
|
|
|
|
2008-09-25 07:56:58 +00:00
|
|
|
/**
|
|
|
|
* Destroy the implementation.
|
|
|
|
*/
|
|
|
|
void (*destroy) (kernel_ipsec_t *this);
|
|
|
|
};
|
|
|
|
|
2009-03-24 17:43:01 +00:00
|
|
|
#endif /** KERNEL_IPSEC_H_ @}*/
|