Moved host_t and host_resolver_t to a new networking subfolder
[strongswan.git] / src / libipsec / ipsec_sa_mgr.h
1 /*
2 * Copyright (C) 2012 Tobias Brunner
3 * Copyright (C) 2012 Giuliano Grassi
4 * Copyright (C) 2012 Ralf Sager
5 * Hochschule fuer Technik Rapperswil
6 *
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2 of the License, or (at your
10 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
14 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 * for more details.
16 */
17
18 /**
19 * @defgroup ipsec_sa_mgr ipsec_sa_mgr
20 * @{ @ingroup libipsec
21 */
22
23 #ifndef IPSEC_SA_MGR_H_
24 #define IPSEC_SA_MGR_H_
25
26 #include "ipsec_sa.h"
27
28 #include <library.h>
29 #include <ipsec/ipsec_types.h>
30 #include <selectors/traffic_selector.h>
31 #include <networking/host.h>
32
33 typedef struct ipsec_sa_mgr_t ipsec_sa_mgr_t;
34
35 /**
36 * IPsec SA manager
37 *
38 * The first methods are modeled after those in kernel_ipsec_t.
39 */
40 struct ipsec_sa_mgr_t {
41
42 /**
43 * Allocate an SPI for an inbound IPsec SA
44 *
45 * @param src source address of the SA
46 * @param dst destination address of the SA
47 * @param protocol protocol of the SA (only ESP supported)
48 * @param reqid reqid for the SA
49 * @param spi the allocated SPI
50 * @return SUCCESS of operation successful
51 */
52 status_t (*get_spi)(ipsec_sa_mgr_t *this, host_t *src, host_t *dst,
53 u_int8_t protocol, u_int32_t reqid, u_int32_t *spi);
54
55 /**
56 * Add a new SA
57 *
58 * @param src source address for this SA (gets cloned)
59 * @param dst destination address for this SA (gets cloned)
60 * @param spi SPI for this SA
61 * @param protocol protocol for this SA (only ESP is supported)
62 * @param reqid reqid for this SA
63 * @param mark mark for this SA (ignored)
64 * @param tfc Traffic Flow Confidentiality (not yet supported)
65 * @param lifetime lifetime for this SA
66 * @param enc_alg encryption algorithm for this SA
67 * @param enc_key encryption key for this SA
68 * @param int_alg integrity protection algorithm
69 * @param int_key integrity protection key
70 * @param mode mode for this SA (only tunnel mode is supported)
71 * @param ipcomp IPcomp transform (not supported, use IPCOMP_NONE)
72 * @param cpi CPI for IPcomp (ignored)
73 * @param encap enable UDP encapsulation (must be TRUE)
74 * @param esn Extended Sequence Numbers (currently not supported)
75 * @param inbound TRUE if this is an inbound SA, FALSE otherwise
76 * @param src_ts source traffic selector
77 * @param dst_ts destination traffic selector
78 * @return SUCCESS if operation completed
79 */
80 status_t (*add_sa)(ipsec_sa_mgr_t *this, host_t *src, host_t *dst,
81 u_int32_t spi, u_int8_t protocol, u_int32_t reqid,
82 mark_t mark, u_int32_t tfc, lifetime_cfg_t *lifetime,
83 u_int16_t enc_alg, chunk_t enc_key, u_int16_t int_alg,
84 chunk_t int_key, ipsec_mode_t mode, u_int16_t ipcomp,
85 u_int16_t cpi, bool encap, bool esn, bool inbound,
86 traffic_selector_t *src_ts, traffic_selector_t *dst_ts);
87
88 /**
89 * Update the hosts on an installed SA.
90 *
91 * @param spi SPI of the SA
92 * @param protocol protocol for this SA (ESP/AH)
93 * @param cpi CPI for IPComp, 0 if no IPComp is used
94 * @param src current source address
95 * @param dst current destination address
96 * @param new_src new source address
97 * @param new_dst new destination address
98 * @param encap current use of UDP encapsulation
99 * @param new_encap new use of UDP encapsulation
100 * @param mark optional mark for this SA
101 * @return SUCCESS if operation completed
102 */
103 status_t (*update_sa)(ipsec_sa_mgr_t *this,
104 u_int32_t spi, u_int8_t protocol, u_int16_t cpi,
105 host_t *src, host_t *dst,
106 host_t *new_src, host_t *new_dst,
107 bool encap, bool new_encap, mark_t mark);
108
109 /**
110 * Delete a previously added SA
111 *
112 * @param spi SPI of the SA
113 * @param src source address of the SA
114 * @param dst destination address of the SA
115 * @param protocol protocol of the SA
116 * @param cpi CPI for IPcomp
117 * @param mark optional mark
118 * @return SUCCESS if operation completed
119 */
120 status_t (*del_sa)(ipsec_sa_mgr_t *this, host_t *src, host_t *dst,
121 u_int32_t spi, u_int8_t protocol, u_int16_t cpi,
122 mark_t mark);
123
124 /**
125 * Flush all SAs
126 *
127 * @return SUCCESS if operation completed
128 */
129 status_t (*flush_sas)(ipsec_sa_mgr_t *this);
130
131 /**
132 * Checkout an installed IPsec SA by SPI and destination address
133 * Can be used to find the correct SA for an inbound packet.
134 *
135 * The matching SA is locked until it is checked in using checkin().
136 * If the matching SA is already checked out, this call blocks until the
137 * SA is checked in.
138 *
139 * Since other threads may be waiting for the checked out SA, it should be
140 * checked in as soon as possible after use.
141 *
142 * @param spi SPI (e.g. of an inbound packet)
143 * @param dst destination address (e.g. of an inbound packet)
144 * @return the matching IPsec SA, or NULL if none is found
145 */
146 ipsec_sa_t *(*checkout_by_spi)(ipsec_sa_mgr_t *this, u_int32_t spi,
147 host_t *dst);
148
149 /**
150 * Checkout an installed IPsec SA by its reqid and inbound/outbound flag.
151 * Can be used to find the correct SA for an outbound packet.
152 *
153 * The matching SA is locked until it is checked in using checkin().
154 * If the matching SA is already checked out, this call blocks until the
155 * SA is checked in.
156 *
157 * Since other threads may be waiting for a checked out SA, it should be
158 * checked in as soon as possible after use.
159 *
160 * @param reqid reqid of the SA
161 * @param inbound TRUE for an inbound SA, FALSE for an outbound SA
162 * @return the matching IPsec SA, or NULL if none is found
163 */
164 ipsec_sa_t *(*checkout_by_reqid)(ipsec_sa_mgr_t *this, u_int32_t reqid,
165 bool inbound);
166
167 /**
168 * Checkin an SA after use.
169 *
170 * @param sa checked out SA
171 */
172 void (*checkin)(ipsec_sa_mgr_t *this, ipsec_sa_t *sa);
173
174 /**
175 * Destroy an ipsec_sa_mgr_t
176 */
177 void (*destroy)(ipsec_sa_mgr_t *this);
178
179 };
180
181 /**
182 * Create an ipsec_sa_mgr instance
183 *
184 * @return IPsec SA manager instance
185 */
186 ipsec_sa_mgr_t *ipsec_sa_mgr_create();
187
188 #endif /** IPSEC_SA_MGR_H_ @}*/