moved updown script invocation to an optional plugin
[strongswan.git] / src / charon / sa / child_sa.h
1 /*
2 * Copyright (C) 2006-2008 Tobias Brunner
3 * Copyright (C) 2006-2007 Martin Willi
4 * Copyright (C) 2006 Daniel Roethlisberger
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 * $Id$
18 */
19
20 /**
21 * @defgroup child_sa child_sa
22 * @{ @ingroup sa
23 */
24
25 #ifndef CHILD_SA_H_
26 #define CHILD_SA_H_
27
28 typedef enum child_sa_state_t child_sa_state_t;
29 typedef struct child_sa_t child_sa_t;
30
31 #include <library.h>
32 #include <crypto/prf_plus.h>
33 #include <encoding/payloads/proposal_substructure.h>
34 #include <config/proposal.h>
35 #include <config/child_cfg.h>
36
37 /**
38 * States of a CHILD_SA
39 */
40 enum child_sa_state_t {
41
42 /**
43 * Just created, uninstalled CHILD_SA
44 */
45 CHILD_CREATED,
46
47 /**
48 * Installed SPD, but no SAD entries
49 */
50 CHILD_ROUTED,
51
52 /**
53 * Installed an in-use CHILD_SA
54 */
55 CHILD_INSTALLED,
56
57 /**
58 * While updating hosts, in update_hosts()
59 */
60 CHILD_UPDATING,
61
62 /**
63 * CHILD_SA which is rekeying
64 */
65 CHILD_REKEYING,
66
67 /**
68 * CHILD_SA in progress of delete
69 */
70 CHILD_DELETING,
71
72 /**
73 * CHILD_SA object gets destroyed
74 */
75 CHILD_DESTROYING,
76 };
77
78 /**
79 * enum strings for child_sa_state_t.
80 */
81 extern enum_name_t *child_sa_state_names;
82
83 /**
84 * Represents an IPsec SAs between two hosts.
85 *
86 * A child_sa_t contains two SAs. SAs for both
87 * directions are managed in one child_sa_t object. Both
88 * SAs and the policies have the same reqid.
89 *
90 * The procedure for child sa setup is as follows:
91 * - A gets SPIs for a proposal via child_sa_t.alloc
92 * - A send the updated proposal to B
93 * - B selects a suitable proposal
94 * - B calls child_sa_t.add to add and update the selected proposal
95 * - B sends the updated proposal to A
96 * - A calls child_sa_t.update to update the already allocated SPIs with the chosen proposal
97 *
98 * Once SAs are set up, policies can be added using add_policies.
99 */
100 struct child_sa_t {
101
102 /**
103 * Get the name of the config this CHILD_SA uses.
104 *
105 * @return name
106 */
107 char* (*get_name) (child_sa_t *this);
108
109 /**
110 * Get the reqid of the CHILD SA.
111 *
112 * Every CHILD_SA has a reqid. The kernel uses this ID to
113 * identify it.
114 *
115 * @return reqid of the CHILD SA
116 */
117 u_int32_t (*get_reqid)(child_sa_t *this);
118
119 /**
120 * Get the SPI of this CHILD_SA.
121 *
122 * Set the boolean parameter inbound to TRUE to
123 * get the SPI for which we receive packets, use
124 * FALSE to get those we use for sending packets.
125 *
126 * @param inbound TRUE to get inbound SPI, FALSE for outbound.
127 * @return SPI of the CHILD SA
128 */
129 u_int32_t (*get_spi) (child_sa_t *this, bool inbound);
130
131 /**
132 * Get the CPI of this CHILD_SA.
133 *
134 * Set the boolean parameter inbound to TRUE to
135 * get the CPI for which we receive packets, use
136 * FALSE to get those we use for sending packets.
137 *
138 * @param inbound TRUE to get inbound CPI, FALSE for outbound.
139 * @return CPI of the CHILD SA
140 */
141 u_int16_t (*get_cpi) (child_sa_t *this, bool inbound);
142
143 /**
144 * Get the protocol which this CHILD_SA uses to protect traffic.
145 *
146 * @return AH | ESP
147 */
148 protocol_id_t (*get_protocol) (child_sa_t *this);
149
150 /**
151 * Get info and statistics about this CHILD_SA.
152 *
153 * @param mode mode this IKE_SA uses
154 * @param encr_algo encryption algorithm used by this CHILD_SA.
155 * @param encr_key encryption key
156 * @param int_algo integrity algorithm used by this CHILD_SA
157 * @param int_key integrity key
158 * @param rekey time when rekeying is scheduled
159 * @param use_in time when last traffic was seen coming in
160 * @param use_out time when last traffic was seen going out
161 * @param use_fwd time when last traffic was getting forwarded
162 */
163 void (*get_stats)(child_sa_t *this, ipsec_mode_t *mode,
164 encryption_algorithm_t *encr,
165 chunk_t *encr_key_in, chunk_t *encr_key_out,
166 integrity_algorithm_t *int_algo,
167 chunk_t *int_key_in, chunk_t *int_key_out,
168 u_int32_t *rekey, u_int32_t *use_in, u_int32_t *use_out,
169 u_int32_t *use_fwd);
170
171 /**
172 * Allocate SPIs for given proposals.
173 *
174 * Since the kernel manages SPIs for us, we need
175 * to allocate them. If a proposal contains more
176 * than one protocol, for each protocol an SPI is
177 * allocated. SPIs are stored internally and written
178 * back to the proposal.
179 *
180 * @param proposals list of proposals for which SPIs are allocated
181 */
182 status_t (*alloc)(child_sa_t *this, linked_list_t* proposals);
183
184 /**
185 * Install the kernel SAs for a proposal, without previous SPI allocation.
186 *
187 * @param proposal proposal for which SPIs are allocated
188 * @param mode mode for the CHILD_SA
189 * @param prf_plus key material to use for key derivation
190 * @return SUCCESS or FAILED
191 */
192 status_t (*add)(child_sa_t *this, proposal_t *proposal, ipsec_mode_t mode,
193 prf_plus_t *prf_plus);
194
195 /**
196 * Install the kernel SAs for a proposal, after SPIs have been allocated.
197 *
198 * Updates an SA, for which SPIs are already allocated via alloc().
199 *
200 * @param proposal proposal for which SPIs are allocated
201 * @param mode mode for the CHILD_SA
202 * @param prf_plus key material to use for key derivation
203 * @return SUCCESS or FAILED
204 */
205 status_t (*update)(child_sa_t *this, proposal_t *proposal, ipsec_mode_t mode,
206 prf_plus_t *prf_plus);
207
208 /**
209 * Update the hosts in the kernel SAs and policies.
210 *
211 * The CHILD must be INSTALLED to do this update.
212 *
213 * @param me the new local host
214 * @param other the new remote host
215 * @param vip virtual IP, if any
216 * @param TRUE to use UDP encapsulation for NAT traversal
217 * @return SUCCESS or FAILED
218 */
219 status_t (*update_hosts)(child_sa_t *this, host_t *me, host_t *other,
220 host_t *vip, bool encap);
221
222 /**
223 * Install the policies using some traffic selectors.
224 *
225 * Supplied lists of traffic_selector_t's specify the policies
226 * to use for this child sa.
227 *
228 * @param my_ts traffic selectors for local site
229 * @param other_ts traffic selectors for remote site
230 * @param mode mode for the SA: tunnel/transport
231 * @param proto protocol for policy, ESP/AH
232 * @return SUCCESS or FAILED
233 */
234 status_t (*add_policies)(child_sa_t *this, linked_list_t *my_ts_list,
235 linked_list_t *other_ts_list, ipsec_mode_t mode,
236 protocol_id_t proto);
237
238 /**
239 * Get the traffic selectors of added policies of local host.
240 *
241 * @param local TRUE for own traffic selectors, FALSE for remote
242 * @return list of traffic selectors
243 */
244 linked_list_t* (*get_traffic_selectors) (child_sa_t *this, bool local);
245
246 /**
247 * Create an enumerator over installed policies.
248 *
249 * @return enumerator over pairs of traffic selectors.
250 */
251 enumerator_t* (*create_policy_enumerator)(child_sa_t *this);
252
253 /**
254 * Get the time of this child_sa_t's last use (i.e. last use of any of its policies)
255 *
256 * @param inbound query for in- or outbound usage
257 * @param use_time the time
258 * @return SUCCESS or FAILED
259 */
260 status_t (*get_use_time) (child_sa_t *this, bool inbound, time_t *use_time);
261
262 /**
263 * Get the state of the CHILD_SA.
264 */
265 child_sa_state_t (*get_state) (child_sa_t *this);
266
267 /**
268 * Set the state of the CHILD_SA.
269 *
270 * @param state state to set on CHILD_SA
271 */
272 void (*set_state) (child_sa_t *this, child_sa_state_t state);
273
274 /**
275 * Get the config used to set up this child sa.
276 *
277 * @return child_cfg
278 */
279 child_cfg_t* (*get_config) (child_sa_t *this);
280
281 /**
282 * Activate IPComp by setting the transform ID and CPI values.
283 *
284 * @param ipcomp the IPComp transform to use
285 * @param other_cpi other Compression Parameter Index
286 */
287 void (*activate_ipcomp) (child_sa_t *this, ipcomp_transform_t ipcomp,
288 u_int16_t other_cpi);
289
290 /**
291 * Returns the Compression Parameter Index (CPI) allocated from the kernel.
292 *
293 * @return allocated CPI
294 */
295 u_int16_t (*allocate_cpi) (child_sa_t *this);
296
297 /**
298 * Destroys a child_sa.
299 */
300 void (*destroy) (child_sa_t *this);
301 };
302
303 /**
304 * Constructor to create a new child_sa_t.
305 *
306 * @param me own address
307 * @param other remote address
308 * @param my_id id of own peer
309 * @param other_id id of remote peer
310 * @param config config to use for this CHILD_SA
311 * @param reqid reqid of old CHILD_SA when rekeying, 0 otherwise
312 * @param encap TRUE to enable UDP encapsulation (NAT traversal)
313 * @return child_sa_t object
314 */
315 child_sa_t * child_sa_create(host_t *me, host_t *other, child_cfg_t *config,
316 u_int32_t reqid, bool encap);
317
318 #endif /*CHILD_SA_H_ @} */