2005-12-04 19:05:52 +00:00
|
|
|
/**
|
|
|
|
* @file kernel_interface.h
|
|
|
|
*
|
|
|
|
* @brief Interface of kernel_interface_t.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
2006-06-22 06:36:28 +00:00
|
|
|
* Copyright (C) 2006 Tobias Brunner, Daniel Roethlisberger
|
2006-07-07 08:49:06 +00:00
|
|
|
* Copyright (C) 2005-2006 Martin Willi
|
|
|
|
* Copyright (C) 2005 Jan Hutter
|
2005-12-04 19:05:52 +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.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef KERNEL_INTERFACE_H_
|
|
|
|
#define KERNEL_INTERFACE_H_
|
|
|
|
|
2006-10-30 14:07:05 +00:00
|
|
|
typedef struct natt_conf_t natt_conf_t;
|
|
|
|
typedef enum policy_dir_t policy_dir_t;
|
|
|
|
typedef struct kernel_interface_t kernel_interface_t;
|
|
|
|
|
2006-04-05 12:10:50 +00:00
|
|
|
#include <utils/host.h>
|
2006-06-09 07:31:30 +00:00
|
|
|
#include <crypto/prf_plus.h>
|
2005-12-05 16:09:42 +00:00
|
|
|
#include <encoding/payloads/proposal_substructure.h>
|
2005-12-04 19:05:52 +00:00
|
|
|
|
2006-06-22 06:36:28 +00:00
|
|
|
/**
|
2006-07-18 12:53:54 +00:00
|
|
|
* Configuration for NAT-T
|
2006-06-22 06:36:28 +00:00
|
|
|
*/
|
|
|
|
struct natt_conf_t {
|
2006-07-18 12:53:54 +00:00
|
|
|
/** source port to use for UDP-encapsulated packets */
|
|
|
|
u_int16_t sport;
|
|
|
|
/** dest port to use for UDP-encapsulated packets */
|
|
|
|
u_int16_t dport;
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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,
|
2006-06-22 06:36:28 +00:00
|
|
|
};
|
|
|
|
|
2005-12-04 19:05:52 +00:00
|
|
|
/**
|
2005-12-06 16:36:42 +00:00
|
|
|
* @brief Interface to the kernel.
|
|
|
|
*
|
2006-03-02 09:56:30 +00:00
|
|
|
* The kernel interface handles the communication with the kernel
|
|
|
|
* for SA and policy management. It allows setup of these, and provides
|
|
|
|
* further the handling of kernel events.
|
2006-07-12 11:42:36 +00:00
|
|
|
* 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.
|
2006-07-18 12:53:54 +00:00
|
|
|
*
|
2005-12-06 16:36:42 +00:00
|
|
|
* @b Constructors:
|
|
|
|
* - kernel_interface_create()
|
2006-07-18 12:53:54 +00:00
|
|
|
*
|
2005-12-04 19:05:52 +00:00
|
|
|
* @ingroup threads
|
|
|
|
*/
|
|
|
|
struct kernel_interface_t {
|
|
|
|
|
2005-12-06 16:36:42 +00:00
|
|
|
/**
|
2006-03-02 09:56:30 +00:00
|
|
|
* @brief Get a SPI from the kernel.
|
2006-06-22 06:36:28 +00:00
|
|
|
*
|
|
|
|
* @warning get_spi() implicitely creates an SA with
|
|
|
|
* the allocated SPI, therefore the replace flag
|
|
|
|
* in add_sa() must be set when installing this SA.
|
2005-12-11 17:36:37 +00:00
|
|
|
*
|
2006-03-02 09:56:30 +00:00
|
|
|
* @param this calling object
|
|
|
|
* @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[out] spi allocated spi
|
|
|
|
* @return
|
|
|
|
* - SUCCESS
|
|
|
|
* - FAILED if kernel comm failed
|
2005-12-06 16:36:42 +00:00
|
|
|
*/
|
2006-07-12 11:42:36 +00:00
|
|
|
status_t (*get_spi)(kernel_interface_t *this, host_t *src, host_t *dst,
|
|
|
|
protocol_id_t protocol, u_int32_t reqid, u_int32_t *spi);
|
2005-12-05 16:09:42 +00:00
|
|
|
|
2005-12-06 16:36:42 +00:00
|
|
|
/**
|
2006-03-02 09:56:30 +00:00
|
|
|
* @brief Add an SA to the SAD.
|
2005-12-11 17:36:37 +00:00
|
|
|
*
|
2006-03-02 09:56:30 +00:00
|
|
|
* add_sa() may update an already allocated
|
|
|
|
* SPI (via get_spi). In this case, the replace
|
2006-05-31 14:23:15 +00:00
|
|
|
* flag must be set.
|
2006-03-02 09:56:30 +00:00
|
|
|
* This function does install a single SA for a
|
2006-06-09 07:31:30 +00:00
|
|
|
* single protocol in one direction. The kernel-interface
|
|
|
|
* gets the keys itself from the PRF, as we don't know
|
|
|
|
* his algorithms and key sizes.
|
2005-12-11 17:36:37 +00:00
|
|
|
*
|
2006-05-31 14:23:15 +00:00
|
|
|
* @param this calling object
|
|
|
|
* @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
|
|
|
|
* @param expire_soft lifetime in seconds before rekeying
|
|
|
|
* @param expire_hard lieftime in seconds before delete
|
|
|
|
* @param enc_alg Algorithm to use for encryption (ESP only)
|
|
|
|
* @param int_alg Algorithm to use for integrity protection
|
2006-07-18 12:53:54 +00:00
|
|
|
* @param prf_plus PRF to derive keys from
|
|
|
|
* @param natt NAT-T Configuration, or NULL of no NAT-T used
|
2006-05-31 14:23:15 +00:00
|
|
|
* @param replace Should an already installed SA be updated?
|
2006-03-02 09:56:30 +00:00
|
|
|
* @return
|
2006-05-31 14:23:15 +00:00
|
|
|
* - SUCCESS
|
|
|
|
* - FAILED if kernel comm failed
|
2005-12-06 16:36:42 +00:00
|
|
|
*/
|
2006-07-12 11:42:36 +00:00
|
|
|
status_t (*add_sa) (kernel_interface_t *this,
|
|
|
|
host_t *src, host_t *dst, u_int32_t spi,
|
|
|
|
protocol_id_t protocol, u_int32_t reqid,
|
|
|
|
u_int64_t expire_soft, u_int64_t expire_hard,
|
|
|
|
algorithm_t *enc_alg, algorithm_t *int_alg,
|
2006-07-18 12:53:54 +00:00
|
|
|
prf_plus_t *prf_plus, natt_conf_t *natt, bool update);
|
2006-06-23 14:02:30 +00:00
|
|
|
|
2006-06-22 06:36:28 +00:00
|
|
|
/**
|
2006-07-18 12:53:54 +00:00
|
|
|
* @brief Update the hosts on an installed SA.
|
2006-06-22 06:36:28 +00:00
|
|
|
*
|
2006-07-18 12:53:54 +00:00
|
|
|
* 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.
|
2006-06-22 06:36:28 +00:00
|
|
|
*
|
2006-07-12 11:42:36 +00:00
|
|
|
* @param this calling object
|
|
|
|
* @param dst destination address for this SA
|
2006-07-18 12:53:54 +00:00
|
|
|
* @param spi SPI of the SA
|
|
|
|
* @param protocol protocol for this SA (ESP/AH)
|
2006-07-12 11:42:36 +00:00
|
|
|
* @param new_src new source address for this SA
|
|
|
|
* @param new_dst new destination address for this SA
|
2006-06-22 06:36:28 +00:00
|
|
|
* @param src_changes changes in src
|
|
|
|
* @param dst_changes changes in dst
|
|
|
|
* @return
|
2006-07-12 11:42:36 +00:00
|
|
|
* - SUCCESS
|
|
|
|
* - FAILED if kernel comm failed
|
2006-06-22 06:36:28 +00:00
|
|
|
*/
|
2006-07-18 12:53:54 +00:00
|
|
|
status_t (*update_sa)(kernel_interface_t *this, host_t *dst, u_int32_t spi,
|
|
|
|
protocol_id_t protocol,
|
|
|
|
host_t *new_src, host_t *new_dst,
|
|
|
|
host_diff_t src_changes, host_diff_t dst_changes);
|
|
|
|
|
2006-07-12 11:42:36 +00:00
|
|
|
/**
|
|
|
|
* @brief Query the use time of an SA.
|
2006-07-18 12:53:54 +00:00
|
|
|
*
|
|
|
|
* The use time of an SA is not the time of the last usage, but
|
|
|
|
* the time of the first usage of the SA.
|
2006-07-12 11:42:36 +00:00
|
|
|
*
|
|
|
|
* @param this calling object
|
|
|
|
* @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] use_time the time of this SA's last use
|
|
|
|
* @return
|
|
|
|
* - SUCCESS
|
|
|
|
* - FAILED if kernel comm failed
|
|
|
|
*/
|
|
|
|
status_t (*query_sa) (kernel_interface_t *this, host_t *dst, u_int32_t spi,
|
2006-07-18 12:53:54 +00:00
|
|
|
protocol_id_t protocol, u_int32_t *use_time);
|
2006-06-22 06:36:28 +00:00
|
|
|
|
2006-03-02 09:56:30 +00:00
|
|
|
/**
|
|
|
|
* @brief Delete a previusly installed SA from the SAD.
|
|
|
|
*
|
2006-07-12 11:42:36 +00:00
|
|
|
* @param this calling object
|
|
|
|
* @param dst destination address for this SA
|
|
|
|
* @param spi SPI allocated by us or remote peer
|
|
|
|
* @param protocol protocol for this SA (ESP/AH)
|
2006-03-02 09:56:30 +00:00
|
|
|
* @return
|
2006-07-12 11:42:36 +00:00
|
|
|
* - SUCCESS
|
|
|
|
* - FAILED if kernel comm failed
|
2006-03-02 09:56:30 +00:00
|
|
|
*/
|
2006-07-12 11:42:36 +00:00
|
|
|
status_t (*del_sa) (kernel_interface_t *this, host_t *dst, u_int32_t spi,
|
|
|
|
protocol_id_t protocol);
|
2006-03-01 15:56:51 +00:00
|
|
|
|
2006-03-02 09:56:30 +00:00
|
|
|
/**
|
|
|
|
* @brief Add a policy to the SPD.
|
|
|
|
*
|
2006-07-18 12:53:54 +00:00
|
|
|
* A policy is always associated to an SA. Traffic which matches a
|
|
|
|
* policy is handled by the SA with the same reqid.
|
|
|
|
* If the update flag is set, the policy is updated with the new
|
|
|
|
* src/dst addresses.
|
|
|
|
* If the update flag is not set, but a such policy is already in the
|
|
|
|
* kernel, the reference count to this policy is increased.
|
2006-03-02 09:56:30 +00:00
|
|
|
*
|
|
|
|
* @param this calling object
|
2006-07-18 12:53:54 +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
|
2006-06-09 08:41:41 +00:00
|
|
|
* @param protocol protocol to use to protect traffic (AH/ESP)
|
2006-03-02 09:56:30 +00:00
|
|
|
* @param reqid uniqe ID of an SA to use to enforce policy
|
2006-09-08 13:10:52 +00:00
|
|
|
* @param high_prio if TRUE, uses a higher priority than any with FALSE
|
2006-07-12 11:42:36 +00:00
|
|
|
* @param update update an existing policy, if TRUE
|
2006-03-02 09:56:30 +00:00
|
|
|
* @return
|
|
|
|
* - SUCCESS
|
|
|
|
* - FAILED if kernel comm failed
|
|
|
|
*/
|
2006-07-18 12:53:54 +00:00
|
|
|
status_t (*add_policy) (kernel_interface_t *this,
|
2006-07-12 11:42:36 +00:00
|
|
|
host_t *src, host_t *dst,
|
2006-07-18 12:53:54 +00:00
|
|
|
traffic_selector_t *src_ts,
|
|
|
|
traffic_selector_t *dst_ts,
|
|
|
|
policy_dir_t direction, protocol_id_t protocol,
|
2006-09-08 13:10:52 +00:00
|
|
|
u_int32_t reqid, bool high_prio, bool update);
|
2006-02-22 16:14:40 +00:00
|
|
|
|
2006-07-18 12:53:54 +00:00
|
|
|
/**
|
|
|
|
* @brief Query the use time of a policy.
|
|
|
|
*
|
|
|
|
* The use time of a policy is the time the policy was used
|
|
|
|
* for the last time.
|
|
|
|
*
|
|
|
|
* @param this calling object
|
|
|
|
* @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
|
|
|
|
* @param[out] use_time the time of this SA's last use
|
|
|
|
* @return
|
|
|
|
* - SUCCESS
|
|
|
|
* - FAILED if kernel comm failed
|
|
|
|
*/
|
|
|
|
status_t (*query_policy) (kernel_interface_t *this,
|
|
|
|
traffic_selector_t *src_ts,
|
|
|
|
traffic_selector_t *dst_ts,
|
|
|
|
policy_dir_t direction, u_int32_t *use_time);
|
|
|
|
|
2006-03-02 09:56:30 +00:00
|
|
|
/**
|
|
|
|
* @brief Remove a policy from the SPD.
|
2006-07-12 11:42:36 +00:00
|
|
|
*
|
2006-07-18 12:53:54 +00:00
|
|
|
* 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.
|
|
|
|
*
|
2006-03-02 09:56:30 +00:00
|
|
|
* @param this calling object
|
2006-07-18 12:53:54 +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
|
2006-03-02 09:56:30 +00:00
|
|
|
* @return
|
|
|
|
* - SUCCESS
|
|
|
|
* - FAILED if kernel comm failed
|
|
|
|
*/
|
2006-07-12 11:42:36 +00:00
|
|
|
status_t (*del_policy) (kernel_interface_t *this,
|
2006-07-18 12:53:54 +00:00
|
|
|
traffic_selector_t *src_ts,
|
|
|
|
traffic_selector_t *dst_ts,
|
|
|
|
policy_dir_t direction);
|
2006-03-01 15:56:51 +00:00
|
|
|
|
2005-12-04 19:05:52 +00:00
|
|
|
/**
|
|
|
|
* @brief Destroys a kernel_interface object.
|
|
|
|
*
|
|
|
|
* @param kernel_interface_t calling object
|
|
|
|
*/
|
|
|
|
void (*destroy) (kernel_interface_t *kernel_interface);
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
2005-12-06 16:36:42 +00:00
|
|
|
* @brief Creates an object of type kernel_interface_t.
|
2005-12-04 19:05:52 +00:00
|
|
|
*
|
|
|
|
* @ingroup threads
|
|
|
|
*/
|
2006-05-09 07:34:25 +00:00
|
|
|
kernel_interface_t *kernel_interface_create(void);
|
2005-12-04 19:05:52 +00:00
|
|
|
|
|
|
|
#endif /*KERNEL_INTERFACE_H_*/
|