57215350566fded3f5c0c33c5d6e145639ff706c
[strongswan.git] / src / libcharon / config / peer_cfg.h
1 /*
2 * Copyright (C) 2007-2008 Tobias Brunner
3 * Copyright (C) 2005-2009 Martin Willi
4 * Copyright (C) 2005 Jan Hutter
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 peer_cfg peer_cfg
20 * @{ @ingroup config
21 */
22
23 #ifndef PEER_CFG_H_
24 #define PEER_CFG_H_
25
26 typedef enum ike_version_t ike_version_t;
27 typedef enum cert_policy_t cert_policy_t;
28 typedef enum unique_policy_t unique_policy_t;
29 typedef struct peer_cfg_t peer_cfg_t;
30
31 #include <library.h>
32 #include <utils/identification.h>
33 #include <utils/enumerator.h>
34 #include <selectors/traffic_selector.h>
35 #include <config/proposal.h>
36 #include <config/ike_cfg.h>
37 #include <config/child_cfg.h>
38 #include <credentials/auth_cfg.h>
39
40 /**
41 * IKE version.
42 */
43 enum ike_version_t {
44 /** any version */
45 IKE_ANY = 0,
46 /** IKE version 1 */
47 IKEV1 = 1,
48 /** IKE version 2 */
49 IKEV2 = 2,
50 };
51
52 /**
53 * enum strings fro ike_version_t
54 */
55 extern enum_name_t *ike_version_names;
56
57 /**
58 * Certificate sending policy. This is also used for certificate
59 * requests when using this definition for the other peer. If
60 * it is CERT_NEVER_SEND, a certreq is omitted, otherwise its
61 * included.
62 *
63 * @warning These definitions must be the same as in pluto/starter,
64 * as they are sent over the stroke socket.
65 */
66 enum cert_policy_t {
67 /** always send certificates, even when not requested */
68 CERT_ALWAYS_SEND = 0,
69 /** send certificate upon cert request */
70 CERT_SEND_IF_ASKED = 1,
71 /** never send a certificate, even when requested */
72 CERT_NEVER_SEND = 2,
73 };
74
75 /**
76 * enum strings for cert_policy_t
77 */
78 extern enum_name_t *cert_policy_names;
79
80 /**
81 * Uniqueness of an IKE_SA, used to drop multiple connections with one peer.
82 */
83 enum unique_policy_t {
84 /** do not check for client uniqueness */
85 UNIQUE_NO,
86 /** replace unique IKE_SAs if new ones get established */
87 UNIQUE_REPLACE,
88 /** keep existing IKE_SAs, close the new ones on connection attept */
89 UNIQUE_KEEP,
90 };
91
92 /**
93 * enum strings for unique_policy_t
94 */
95 extern enum_name_t *unique_policy_names;
96
97 /**
98 * Configuration of a peer, specified by IDs.
99 *
100 * The peer config defines a connection between two given IDs. It contains
101 * exactly one ike_cfg_t, which is used for initiation. Additionally, it
102 * contains multiple child_cfg_t defining which CHILD_SAs are allowed for this
103 * peer.
104 * @verbatim
105 +-------------------+ +---------------+
106 +---------------+ | peer_cfg | +---------------+ |
107 | ike_cfg | +-------------------+ | child_cfg | |
108 +---------------+ | - ids | +---------------+ |
109 | - hosts | 1 1 | - cas | 1 n | - proposals | |
110 | - proposals |<-----| - auth info |----->| - traffic sel | |
111 | - ... | | - dpd config | | - ... |-+
112 +---------------+ | - ... | +---------------+
113 +-------------------+
114 | 1 0 |
115 | |
116 v n n V
117 +-------------------+ +-------------------+
118 +-------------------+ | +-------------------+ |
119 | auth_cfg | | | auth_cfg | |
120 +-------------------+ | +-------------------+ |
121 | - local rules |-+ | - remote constr. |-+
122 +-------------------+ +-------------------+
123 @endverbatim
124 *
125 * Each peer_cfg has two lists of authentication config attached. Local
126 * authentication configs define how to authenticate ourself against the remote
127 * peer. Each config is enforced using the multiple authentication extension
128 * (RFC4739).
129 * The remote authentication configs are handled as constraints. The peer has
130 * to fulfill each of these rules (using multiple authentication, in any order)
131 * to gain access to the configuration.
132 */
133 struct peer_cfg_t {
134
135 /**
136 * Get the name of the peer_cfg.
137 *
138 * Returned object is not getting cloned.
139 *
140 * @return peer_cfg's name
141 */
142 char* (*get_name) (peer_cfg_t *this);
143
144 /**
145 * Get the IKE version to use for initiating.
146 *
147 * @return IKE major version
148 */
149 ike_version_t (*get_ike_version)(peer_cfg_t *this);
150
151 /**
152 * Get the IKE config to use for initiaton.
153 *
154 * @return the IKE config to use
155 */
156 ike_cfg_t* (*get_ike_cfg) (peer_cfg_t *this);
157
158 /**
159 * Attach a CHILD config.
160 *
161 * @param child_cfg CHILD config to add
162 */
163 void (*add_child_cfg) (peer_cfg_t *this, child_cfg_t *child_cfg);
164
165 /**
166 * Detach a CHILD config, pointed to by an enumerator.
167 *
168 * @param enumerator enumerator indicating element position
169 */
170 void (*remove_child_cfg)(peer_cfg_t *this, enumerator_t *enumerator);
171
172 /**
173 * Create an enumerator for all attached CHILD configs.
174 *
175 * @return an enumerator over all CHILD configs.
176 */
177 enumerator_t* (*create_child_cfg_enumerator) (peer_cfg_t *this);
178
179 /**
180 * Select a CHILD config from traffic selectors.
181 *
182 * @param my_ts TS for local side
183 * @param other_ts TS for remote side
184 * @param my_host host to narrow down dynamic TS for local side
185 * @param other_host host to narrow down dynamic TS for remote side
186 * @return selected CHILD config, or NULL if no match found
187 */
188 child_cfg_t* (*select_child_cfg) (peer_cfg_t *this, linked_list_t *my_ts,
189 linked_list_t *other_ts, host_t *my_host,
190 host_t *other_host);
191
192 /**
193 * Add an authentication config to the peer configuration.
194 *
195 * @param config config to add
196 * @param local TRUE for local rules, FALSE for remote constraints
197 */
198 void (*add_auth_cfg)(peer_cfg_t *this, auth_cfg_t *cfg, bool local);
199
200 /**
201 * Create an enumerator over registered authentication configs.
202 *
203 * @param local TRUE for local rules, FALSE for remote constraints
204 * @return enumerator over auth_cfg_t*
205 */
206 enumerator_t* (*create_auth_cfg_enumerator)(peer_cfg_t *this, bool local);
207
208 /**
209 * Should be sent a certificate for this connection?
210 *
211 * @return certificate sending policy
212 */
213 cert_policy_t (*get_cert_policy) (peer_cfg_t *this);
214
215 /**
216 * How to handle uniqueness of IKE_SAs?
217 *
218 * @return unique policy
219 */
220 unique_policy_t (*get_unique_policy) (peer_cfg_t *this);
221
222 /**
223 * Get the max number of retries after timeout.
224 *
225 * @return max number retries
226 */
227 u_int32_t (*get_keyingtries) (peer_cfg_t *this);
228
229 /**
230 * Get a time to start rekeying.
231 *
232 * @param jitter remove a jitter value to randomize time
233 * @return time in s when to start rekeying, 0 disables rekeying
234 */
235 u_int32_t (*get_rekey_time)(peer_cfg_t *this, bool jitter);
236
237 /**
238 * Get a time to start reauthentication.
239 *
240 * @param jitter remove a jitter value to randomize time
241 * @return time in s when to start reauthentication, 0 disables it
242 */
243 u_int32_t (*get_reauth_time)(peer_cfg_t *this, bool jitter);
244
245 /**
246 * Get the timeout of a rekeying/reauthenticating SA.
247 *
248 * @return timeout in s
249 */
250 u_int32_t (*get_over_time)(peer_cfg_t *this);
251
252 /**
253 * Use MOBIKE (RFC4555) if peer supports it?
254 *
255 * @return TRUE to enable MOBIKE support
256 */
257 bool (*use_mobike) (peer_cfg_t *this);
258
259 /**
260 * Use/Accept aggressive mode with IKEv1?.
261 *
262 * @return TRUE to use aggressive mode
263 */
264 bool (*use_aggressive)(peer_cfg_t *this);
265
266 /**
267 * Get the DPD check interval.
268 *
269 * @return dpd_delay in seconds
270 */
271 u_int32_t (*get_dpd) (peer_cfg_t *this);
272
273 /**
274 * Get the DPD timeout interval (IKEv1 only)
275 *
276 * @return dpd_timeout in seconds
277 */
278 u_int32_t (*get_dpd_timeout) (peer_cfg_t *this);
279
280 /**
281 * Get a virtual IP for the local peer.
282 *
283 * If no virtual IP should be used, NULL is returned. %any means to request
284 * a virtual IP using configuration payloads. A specific address is also
285 * used for a request and may be changed by the server.
286 *
287 * @param suggestion NULL, %any or specific
288 * @return virtual IP, %any or NULL
289 */
290 host_t* (*get_virtual_ip) (peer_cfg_t *this);
291
292 /**
293 * Get the name of the pool to acquire configuration attributes from.
294 *
295 * @return pool name, NULL if none defined
296 */
297 char* (*get_pool)(peer_cfg_t *this);
298
299 #ifdef ME
300 /**
301 * Is this a mediation connection?
302 *
303 * @return TRUE, if this is a mediation connection
304 */
305 bool (*is_mediation) (peer_cfg_t *this);
306
307 /**
308 * Get peer_cfg of the connection this one is mediated through.
309 *
310 * @return the peer_cfg of the mediation connection
311 */
312 peer_cfg_t* (*get_mediated_by) (peer_cfg_t *this);
313
314 /**
315 * Get the id of the other peer at the mediation server.
316 *
317 * This is the leftid of the peer's connection with the mediation server.
318 *
319 * If it is not configured, it is assumed to be the same as the right id
320 * of this connection.
321 *
322 * @return the id of the other peer
323 */
324 identification_t* (*get_peer_id) (peer_cfg_t *this);
325 #endif /* ME */
326
327 /**
328 * Check if two peer configurations are equal.
329 *
330 * This method does not compare associated ike/child_cfg.
331 *
332 * @param other candidate to check for equality against this
333 * @return TRUE if peer_cfg and ike_cfg are equal
334 */
335 bool (*equals)(peer_cfg_t *this, peer_cfg_t *other);
336
337 /**
338 * Increase reference count.
339 *
340 * @return reference to this
341 */
342 peer_cfg_t* (*get_ref) (peer_cfg_t *this);
343
344 /**
345 * Destroys the peer_cfg object.
346 *
347 * Decrements the internal reference counter and
348 * destroys the peer_cfg when it reaches zero.
349 */
350 void (*destroy) (peer_cfg_t *this);
351 };
352
353 /**
354 * Create a configuration object for IKE_AUTH and later.
355 *
356 * name-string gets cloned, ID's not.
357 * Virtual IPs are used if they are != NULL. A %any host means the virtual
358 * IP should be obtained from the other peer.
359 * Lifetimes are in seconds. To prevent to peers to start rekeying at the
360 * same time, a jitter may be specified. Rekeying of an SA starts at
361 * (rekeylifetime - random(0, jitter)).
362 *
363 * @param name name of the peer_cfg
364 * @param ike_version which IKE version we should use for this peer
365 * @param ike_cfg IKE config to use when acting as initiator
366 * @param cert_policy should we send a certificate payload?
367 * @param unique uniqueness of an IKE_SA
368 * @param keyingtries how many keying tries should be done before giving up
369 * @param rekey_time timeout before starting rekeying
370 * @param reauth_time timeout before starting reauthentication
371 * @param jitter_time timerange to randomly subtract from rekey/reauth time
372 * @param over_time maximum overtime before closing a rekeying/reauth SA
373 * @param mobike use MOBIKE (RFC4555) if peer supports it
374 * @param aggressive use/accept aggressive mode with IKEv1
375 * @param dpd DPD check interval, 0 to disable
376 * @param dpd_timeout DPD timeout interval (IKEv1 only), if 0 default applies
377 * @param virtual_ip virtual IP for local host, or NULL
378 * @param pool pool name to get configuration attributes from, or NULL
379 * @param mediation TRUE if this is a mediation connection
380 * @param mediated_by peer_cfg_t of the mediation connection to mediate through
381 * @param peer_id ID that identifies our peer at the mediation server
382 * @return peer_cfg_t object
383 */
384 peer_cfg_t *peer_cfg_create(char *name, ike_version_t ike_version,
385 ike_cfg_t *ike_cfg, cert_policy_t cert_policy,
386 unique_policy_t unique, u_int32_t keyingtries,
387 u_int32_t rekey_time, u_int32_t reauth_time,
388 u_int32_t jitter_time, u_int32_t over_time,
389 bool mobike, bool aggressive, u_int32_t dpd,
390 u_int32_t dpd_timeout, host_t *virtual_ip,
391 char *pool, bool mediation, peer_cfg_t *mediated_by,
392 identification_t *peer_id);
393
394 #endif /** PEER_CFG_H_ @}*/