libimcv: Added inactive field to device database table
[strongswan.git] / src / libcharon / daemon.h
index c0c834b..a37a314 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2006-2010 Tobias Brunner
+ * Copyright (C) 2006-2017 Tobias Brunner
  * Copyright (C) 2005-2009 Martin Willi
  * Copyright (C) 2006 Daniel Roethlisberger
  * Copyright (C) 2005 Jan Hutter
  * for more details.
  */
 
+/*
+ * Copyright (C) 2016 secunet Security Networks AG
+ * Copyright (C) 2016 Thomas Egerer
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
 /**
  * @defgroup libcharon libcharon
  *
+ * @defgroup attributes attributes
+ * @ingroup libcharon
+ *
  * @defgroup bus bus
  * @ingroup libcharon
  *
@@ -37,7 +63,7 @@
  * @defgroup payloads payloads
  * @ingroup encoding
  *
- * @defgroup ckernel kernel
+ * @defgroup kernel kernel
  * @ingroup libcharon
  *
  * @defgroup network network
  * @defgroup sa sa
  * @ingroup libcharon
  *
- * @defgroup authenticators authenticators
+ * @defgroup ikev1 ikev1
  * @ingroup sa
  *
+ * @defgroup ikev2 ikev2
+ * @ingroup sa
+ *
+ * @defgroup authenticators_v1 authenticators
+ * @ingroup ikev1
+ *
+ * @defgroup authenticators_v2 authenticators
+ * @ingroup ikev2
+ *
  * @defgroup eap eap
- * @ingroup authenticators
+ * @ingroup sa
  *
- * @defgroup tasks tasks
+ * @defgroup xauth xauth
  * @ingroup sa
  *
+ * @defgroup tasks_v1 tasks
+ * @ingroup ikev1
+ *
+ * @defgroup tasks_v2 tasks
+ * @ingroup ikev2
+ *
  * @addtogroup libcharon
  * @{
  *
  * IKE_SA.
  *
  * The controller, credential_manager, bus and backend_manager (config) are
- * places where a plugin ca register itself to privide information or observe
+ * places where a plugin ca register itself to provide information or observe
  * and control the daemon.
  */
 
 
 typedef struct daemon_t daemon_t;
 
+#include <attributes/attribute_manager.h>
+#include <kernel/kernel_interface.h>
 #include <network/sender.h>
 #include <network/receiver.h>
 #include <network/socket_manager.h>
 #include <control/controller.h>
 #include <bus/bus.h>
-#include <bus/listeners/file_logger.h>
-#include <bus/listeners/sys_logger.h>
+#include <bus/listeners/custom_logger.h>
 #include <sa/ike_sa_manager.h>
+#include <sa/child_sa_manager.h>
 #include <sa/trap_manager.h>
+#include <sa/shunt_manager.h>
+#include <sa/redirect_manager.h>
 #include <config/backend_manager.h>
-#include <sa/authenticators/eap/eap_manager.h>
-#include <sa/authenticators/eap/sim_manager.h>
-#include <tnccs/tnccs_manager.h>
+#include <sa/eap/eap_manager.h>
+#include <sa/xauth/xauth_manager.h>
 
 #ifdef ME
-#include <sa/connect_manager.h>
-#include <sa/mediation_manager.h>
+#include <sa/ikev2/connect_manager.h>
+#include <sa/ikev2/mediation_manager.h>
 #endif /* ME */
 
 /**
@@ -162,16 +206,31 @@ typedef struct daemon_t daemon_t;
 #define DEFAULT_THREADS 16
 
 /**
- * UDP Port on which the daemon will listen for incoming traffic.
+ * Primary UDP port used by IKE.
  */
 #define IKEV2_UDP_PORT 500
 
 /**
- * UDP Port to which the daemon will float to if NAT is detected.
+ * UDP port defined for use in case a NAT is detected.
  */
 #define IKEV2_NATT_PORT 4500
 
 /**
+ * UDP port on which the daemon will listen for incoming traffic (also used as
+ * source port for outgoing traffic).
+ */
+#ifndef CHARON_UDP_PORT
+#define CHARON_UDP_PORT IKEV2_UDP_PORT
+#endif
+
+/**
+ * UDP port used by the daemon in case a NAT is detected.
+ */
+#ifndef CHARON_NATT_PORT
+#define CHARON_NATT_PORT IKEV2_NATT_PORT
+#endif
+
+/**
  * Main class of daemon, contains some globals.
  */
 struct daemon_t {
@@ -182,16 +241,36 @@ struct daemon_t {
        socket_manager_t *socket;
 
        /**
+        * Kernel interface to communicate with kernel
+        */
+       kernel_interface_t *kernel;
+
+       /**
         * A ike_sa_manager_t instance.
         */
        ike_sa_manager_t *ike_sa_manager;
 
        /**
+        * A child_sa_manager_t instance.
+        */
+       child_sa_manager_t *child_sa_manager;
+
+       /**
         * Manager for triggering policies, called traps
         */
        trap_manager_t *traps;
 
        /**
+        * Manager for shunt PASS|DROP policies
+        */
+       shunt_manager_t *shunts;
+
+       /**
+        * Manager for IKE redirect providers
+        */
+       redirect_manager_t *redirect;
+
+       /**
         * Manager for the different configuration backends.
         */
        backend_manager_t *backends;
@@ -207,19 +286,14 @@ struct daemon_t {
        receiver_t *receiver;
 
        /**
-        * The signaling bus.
-        */
-       bus_t *bus;
-
-       /**
-        * A list of installed file_logger_t's
+        * Manager for IKE configuration attributes
         */
-       linked_list_t *file_loggers;
+       attribute_manager_t *attributes;
 
        /**
-        * A list of installed sys_logger_t's
+        * The signaling bus.
         */
-       linked_list_t *sys_loggers;
+       bus_t *bus;
 
        /**
         * Controller to control the daemon
@@ -232,14 +306,9 @@ struct daemon_t {
        eap_manager_t *eap;
 
        /**
-        * SIM manager to maintain (U)SIM cards/providers
+        * XAuth manager to maintain registered XAuth methods
         */
-       sim_manager_t *sim;
-
-       /**
-        * TNCCS manager to maintain registered TNCCS protocols
-        */
-       tnccs_manager_t *tnccs;
+       xauth_manager_t *xauth;
 
 #ifdef ME
        /**
@@ -254,45 +323,47 @@ struct daemon_t {
 #endif /* ME */
 
        /**
-        * User ID the daemon will user after initialization
+        * Initialize the daemon.
+        *
+        * @param plugins       list of plugins to load
+        * @return                      TRUE, if successful
         */
-       uid_t uid;
+       bool (*initialize)(daemon_t *this, char *plugins);
 
        /**
-        * Group ID the daemon will use after initialization
+        * Starts the daemon, i.e. spawns the threads of the thread pool.
         */
-       gid_t gid;
+       void (*start)(daemon_t *this);
 
        /**
-        * Do not drop a given capability after initialization.
+        * Load/Reload loggers defined in strongswan.conf
         *
-        * Some plugins might need additional capabilites. They tell the daemon
-        * during plugin initialization which one they need, the daemon won't
-        * drop these.
+        * If none are defined in strongswan.conf default loggers configured via
+        * set_default_loggers() are loaded.
         */
-       void (*keep_cap)(daemon_t *this, u_int cap);
+       void (*load_loggers)(daemon_t *this);
 
        /**
-        * Drop all capabilities of the current process.
-        *
-        * Drops all capabalities, excect those exlcuded using keep_cap().
-        * This should be called after the initialization of the daemon because
-        * some plugins require the process to keep additional capabilities.
+        * Configure default loggers if none are defined in strongswan.conf
         *
-        * @return              TRUE if successful, FALSE otherwise
+        * @param levels        debug levels used to create default loggers if none are
+        *                                      defined in strongswan.conf (NULL to disable)
+        * @param to_stderr     TRUE to log to stderr/stdout if no loggers are defined
+        *                                      in strongswan.conf (logging to syslog is always enabled)
         */
-       bool (*drop_capabilities)(daemon_t *this);
+       void (*set_default_loggers)(daemon_t *this, level_t levels[DBG_MAX],
+                                                               bool to_stderr);
 
        /**
-        * Initialize the daemon.
-        */
-       bool (*initialize)(daemon_t *this, bool syslog, level_t levels[]);
-
-       /**
-        * Starts the daemon, i.e. spawns the threads of the thread pool.
+        * Set the log level for the given log group for all loaded loggers.
+        *
+        * This change is not persistent and gets reset if loggers are reloaded
+        * via load_loggers().
+        *
+        * @param group         log group
+        * @param level         log level
         */
-       void (*start)(daemon_t *this);
-
+       void (*set_level)(daemon_t *this, debug_t group, level_t level);
 };
 
 /**
@@ -305,6 +376,12 @@ extern daemon_t *charon;
 /**
  * Initialize libcharon and create the "charon" instance of daemon_t.
  *
+ * This function initializes the bus, listeners can be registered before
+ * calling initialize().
+ *
+ * libcharon_init() may be called multiple times in a single process, but each
+ * caller must call libcharon_deinit() for each call to libcharon_init().
+ *
  * @return             FALSE if integrity check failed
  */
 bool libcharon_init();
@@ -314,4 +391,15 @@ bool libcharon_init();
  */
 void libcharon_deinit();
 
+/**
+ * Register a custom logger constructor.
+ *
+ * To be called from __attribute__((constructor)) functions.
+ *
+ * @param name                         name of the logger (also used for loglevel config)
+ * @param constructor          constructor to create custom logger
+ */
+void register_custom_logger(char *name,
+                                                       custom_logger_constructor_t constructor);
+
 #endif /** DAEMON_H_ @}*/