updated API doc for socket.h
[strongswan.git] / src / charon / config / child_cfg.h
index c7401d6..ddd4807 100644 (file)
@@ -1,4 +1,5 @@
 /*
+ * Copyright (C) 2008 Tobias Brunner
  * Copyright (C) 2005-2007 Martin Willi
  * Copyright (C) 2005 Jan Hutter
  * Hochschule fuer Technik Rapperswil
 #ifndef CHILD_CFG_H_
 #define CHILD_CFG_H_
 
-typedef enum mode_t mode_t;
+typedef enum action_t action_t;
+typedef enum ipcomp_transform_t ipcomp_transform_t;
 typedef struct child_cfg_t child_cfg_t;
 
 #include <library.h>
 #include <config/proposal.h>
 #include <config/traffic_selector.h>
+#include <kernel/kernel_ipsec.h>
 
 /**
- * Mode of an CHILD_SA.
- *
- * These are equal to those defined in XFRM, so don't change.
+ * Action to take when DPD detected/connection gets closed by peer.
  */
-enum mode_t {
-       /** transport mode, no inner address */
-       MODE_TRANSPORT = 0,
-       /** tunnel mode, inner and outer addresses */
-       MODE_TUNNEL = 1,
-       /** BEET mode, tunnel mode but fixed, bound inner addresses */
-       MODE_BEET = 4,
+enum action_t {
+       /** No action */
+       ACTION_NONE,
+       /** Route config to reestablish on demand */
+       ACTION_ROUTE,
+       /** Restart config immediately */
+       ACTION_RESTART,
 };
 
 /**
- * enum names for mode_t.
+ * enum names for action_t.
  */
-extern enum_name_t *mode_names;
+extern enum_name_t *action_names;
+
+/**
+ * IPComp transform IDs, as in RFC 4306
+ */
+enum ipcomp_transform_t {
+       IPCOMP_NONE = 241,
+       IPCOMP_OUI = 1,
+       IPCOMP_DEFLATE = 2,
+       IPCOMP_LZS = 3,
+       IPCOMP_LZJH = 4,
+};
+
+/**
+ * enum strings for ipcomp_transform_t.
+ */
+extern enum_name_t *ipcomp_transform_names;
 
 /**
  * A child_cfg_t defines the config template for a CHILD_SA.
@@ -137,6 +154,17 @@ struct child_cfg_t {
                                                                                        host_t *host);
 
        /**
+        * Checks [single] traffic selectors for equality 
+        *
+        * @param local                 TRUE for TS on local side, FALSE for remote
+        * @param ts                    list with single traffic selector to compare with
+        * @param host                  address to use for narrowing "dynamic" TS', or NULL
+        * @return                              TRUE if TS are equal, FALSE otherwise
+        */ 
+       bool (*equal_traffic_selectors)(child_cfg_t *this, bool local,
+                                                                  linked_list_t *ts_list, host_t *host);
+
+       /**
         * Get the updown script to run for the CHILD_SA.
         * 
         * @return                              path to updown script
@@ -170,9 +198,23 @@ struct child_cfg_t {
         * The mode is either tunnel, transport or BEET. The peer must agree
         * on the method, fallback is tunnel mode.
         * 
-        * @return                              lifetime in seconds
+        * @return                              ipsec mode
         */
-       mode_t (*get_mode) (child_cfg_t *this);
+       ipsec_mode_t (*get_mode) (child_cfg_t *this);
+       
+       /**
+        * Action to take on DPD.
+        *
+        * @return                              DPD action
+        */     
+       action_t (*get_dpd_action) (child_cfg_t *this);
+       
+       /**
+        * Action to take if CHILD_SA gets closed.
+        *
+        * @return                              close action
+        */     
+       action_t (*get_close_action) (child_cfg_t *this);
        
        /**
         * Get the DH group to use for CHILD_SA setup.
@@ -182,15 +224,44 @@ struct child_cfg_t {
        diffie_hellman_group_t (*get_dh_group)(child_cfg_t *this);
        
        /**
-        * Get a new reference.
+        * Check whether IPComp should be used, if the other peer supports it.
+        * 
+        * @return                              TRUE, if IPComp should be used
+        *                                              FALSE, otherwise
+        */
+       bool (*use_ipcomp)(child_cfg_t *this);
+
+       /**
+        * Sets two options needed for Mobile IPv6 interoperability
+        * 
+        * @proxy_mode                  use IPsec transport proxy mode (default FALSE)
+        * @install_policy              install IPsec kernel policies (default TRUE)
+        */
+       void (*set_mipv6_options)(child_cfg_t *this, bool proxy_mod,
+                                                                                                bool install_policy);
+
+       /**
+        * Check whether IPsec transport SA should be set up in proxy mode
+        * 
+        * @return                              TRUE, if proxy mode should be used
+        *                                              FALSE, otherwise
+        */
+       bool (*use_proxy_mode)(child_cfg_t *this);
+       
+       /**
+        * Check whether IPsec policies should be installed in the kernel
+        * 
+        * @return                              TRUE, if IPsec kernel policies should be installed
+        *                                              FALSE, otherwise
+        */
+       bool (*install_policy)(child_cfg_t *this);
+       
+       /**
+        * Increase the reference count.
         *
-        * Get a new reference to this child_cfg by increasing
-        * it's internal reference counter.
-        * Do not call get_ref or any other function until you
-        * already have a reference. Otherwise the object may get
-        * destroyed while calling get_ref(),
+        * @return                              reference to this
         */
-       void (*get_ref) (child_cfg_t *this);
+       child_cfg_t* (*get_ref) (child_cfg_t *this);
        
        /**
         * Destroys the child_cfg object.
@@ -218,10 +289,14 @@ struct child_cfg_t {
  * @param updown                       updown script to execute on up/down event
  * @param hostaccess           TRUE to allow access to the local host
  * @param mode                         mode to propose for CHILD_SA, transport, tunnel or BEET
+ * @param dpd_action           DPD action
+ * @param close_action         close action
+ * @param ipcomp                       use IPComp, if peer supports it
  * @return                                     child_cfg_t object
  */
 child_cfg_t *child_cfg_create(char *name, u_int32_t lifetime,
                                                          u_int32_t rekeytime, u_int32_t jitter,
-                                                         char *updown, bool hostaccess, mode_t mode);
+                                                         char *updown, bool hostaccess, ipsec_mode_t mode,
+                                                         action_t dpd_action, action_t close_action, bool ipcomp);
 
 #endif /* CHILD_CFG_H_ @} */