strongswan/src/charon/daemon.h

390 lines
8.7 KiB
C
Raw Normal View History

2005-11-11 11:20:45 +00:00
/**
* @file daemon.h
*
2005-12-06 12:54:34 +00:00
* @brief Interface of daemon_t.
2005-11-11 11:20:45 +00:00
*
*/
/*
2006-06-22 06:36:28 +00:00
* Copyright (C) 2006 Tobias Brunner, Daniel Roethlisberger
2006-07-07 08:49:06 +00:00
* Copyright (C) 2005-2006 Martin Willi
* Copyright (C) 2005 Jan Hutter
2005-11-11 11:20:45 +00:00
* Hochschule fuer Technik Rapperswil
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*/
#ifndef DAEMON_H_
#define DAEMON_H_
2005-11-29 10:25:07 +00:00
#include <threads/sender.h>
#include <threads/receiver.h>
#include <threads/scheduler.h>
2006-02-09 16:25:02 +00:00
#include <threads/kernel_interface.h>
2005-12-06 12:54:34 +00:00
#include <threads/thread_pool.h>
#include <threads/stroke_interface.h>
2005-12-06 12:54:34 +00:00
#include <network/socket.h>
#include <bus/bus.h>
#include <bus/listeners/file_logger.h>
#include <bus/listeners/sys_logger.h>
2005-11-29 10:25:07 +00:00
#include <sa/ike_sa_manager.h>
#include <queues/send_queue.h>
#include <queues/job_queue.h>
#include <queues/event_queue.h>
#include <utils/logger_manager.h>
#include <config/configuration.h>
#include <config/connections/connection_store.h>
#include <config/policies/policy_store.h>
#include <config/credentials/credential_store.h>
2005-11-29 10:25:07 +00:00
2006-04-05 12:10:50 +00:00
/**
* @defgroup charon charon
2006-04-05 12:10:50 +00:00
*
* @brief IKEv2 keying daemon.
*
* @section Architecture
2006-04-05 12:10:50 +00:00
*
* All IKEv2 stuff is handled in charon. It uses a newer and more flexible
* architecture than pluto. Charon uses a thread-pool, which allows parallel
* execution SA-management. Beside the thread-pool, there are some special purpose
* threads which do their job for the common health of the daemon.
@verbatim
+------+
| E Q |
| v u |---+ +------+ +------+
| e e | | | | | IKE- |
| n u | +-----------+ | |--| SA |
| t e | | | | I M | +------+
+------------+ | - | | Scheduler | | K a |
| receiver | +------+ | | | E n | +------+
+----+-------+ +-----------+ | - a | | IKE- |
| | +------+ | | S g |--| SA |
+-------+--+ +-----| J Q |---+ +------------+ | A e | +------+
-| socket | | o u | | | | - r |
+-------+--+ | b e | | Thread- | | |
| | - u | | Pool | | |
+----+-------+ | e |------| |---| |
| sender | +------+ +------------+ +------+
+----+-------+
| +------+
| | S Q |
| | e u |
| | n e |
+------------| d u |
| - e |
+--+---+
@endverbatim
* The thread-pool is the heart of the architecture. It processes jobs from a
* (fully synchronized) job-queue. Mostly, a job is associated with a specific
* IKE SA. These IKE SAs are synchronized, only one thread can work one an IKE SA.
* This makes it unnecesary to use further synchronisation methods once a IKE SA
* is checked out. The (rather complex) synchronization of IKE SAs is completely
* done in the IKE SA manager.
* The sceduler is responsible for event firing. It waits until a event in the
* (fully synchronized) event-queue is ready for processing and pushes the event
* down to the job-queue. A thread form the pool will pick it up as quick as
* possible. Every thread can queue events or jobs. Furter, an event can place a
* packet in the send-queue. The sender thread waits for those packets and sends
* them over the wire, via the socket. The receiver does exactly the opposite of
* the sender. It waits on the socket, reads in packets an places them on the
* job-queue for further processing by a thread from the pool.
* There are even more threads, not drawn in the upper scheme. The stroke thread
* is responsible for reading and processessing commands from another process. The
* kernel interface thread handles communication from and to the kernel via a
* netlink socket. It waits for kernel events and processes them appropriately.
*/
/**
* @defgroup config config
*
* Classes implementing configuration related things.
*
* @ingroup charon
*/
/**
* @defgroup encoding encoding
*
* Classes used to encode and decode IKEv2 messages.
*
* @ingroup charon
*/
/**
* @defgroup payloads payloads
*
* Classes representing specific IKEv2 payloads.
*
* @ingroup encoding
*/
/**
* @defgroup network network
*
* Classes for network relevant stuff.
*
* @ingroup charon
*/
/**
* @defgroup queues queues
*
* Different kind of queues
* (thread save lists).
*
* @ingroup charon
*/
/**
* @defgroup jobs jobs
*
* Jobs used in job queue and event queue.
*
* @ingroup queues
*/
/**
* @defgroup sa sa
*
* Security associations for IKE and IPSec,
* and some helper classes.
*
* @ingroup charon
*/
/**
2006-07-12 14:08:52 +00:00
* @defgroup transactions transactions
*
2006-07-12 14:08:52 +00:00
* Transactions represent a request/response
* message exchange to implement the IKEv2
* protocol exchange scenarios.
*
* @ingroup sa
*/
/**
* @defgroup threads threads
*
* Threaded classes, which will do their job alone.
*
* @ingroup charon
*/
/**
* @defgroup bus bus
*
* Signaling bus and its listeners.
*
* @ingroup charon
*/
2005-11-29 10:25:07 +00:00
/**
2005-12-06 12:54:34 +00:00
* Name of the daemon.
*
* @ingroup charon
2005-11-29 10:25:07 +00:00
*/
2005-11-16 12:06:34 +00:00
#define DAEMON_NAME "charon"
2005-11-29 10:25:07 +00:00
/**
2005-12-06 12:54:34 +00:00
* @brief Number of threads in the thread pool.
2005-11-29 10:25:07 +00:00
*
* There are several other threads, this defines
* only the number of threads in thread_pool_t.
*
* @ingroup charon
2005-11-29 10:25:07 +00:00
*/
2005-11-29 11:27:25 +00:00
#define NUMBER_OF_WORKING_THREADS 4
2005-11-16 12:06:34 +00:00
2005-11-29 10:25:07 +00:00
/**
2005-12-06 12:54:34 +00:00
* UDP Port on which the daemon will listen for incoming traffic.
*
* @ingroup charon
2005-11-29 10:25:07 +00:00
*/
2006-02-13 13:42:01 +00:00
#define IKEV2_UDP_PORT 500
2006-06-22 06:36:28 +00:00
/**
* UDP Port to which the daemon will float to if NAT is detected.
*
* @ingroup charon
*/
#define IKEV2_NATT_PORT 4500
/**
* PID file, in which charon stores its process id
*
* @ingroup charon
*/
#define PID_FILE IPSEC_PIDDIR "/charon.pid"
/**
* Configuration directory
*
* @ingroup charon
*/
#define CONFIG_DIR IPSEC_CONFDIR
/**
* Directory of IPsec relevant files
*
* @ingroup charon
*/
#define IPSEC_D_DIR CONFIG_DIR "/ipsec.d"
/**
2006-05-30 07:38:41 +00:00
* Default directory for private keys
*
* @ingroup charon
*/
#define PRIVATE_KEY_DIR IPSEC_D_DIR "/private"
/**
2006-05-30 07:38:41 +00:00
* Default directory for end entity certificates
*
* @ingroup charon
*/
#define CERTIFICATE_DIR IPSEC_D_DIR "/certs"
2006-05-30 07:38:41 +00:00
/**
* Default directory for trusted CA certificates
*
* @ingroup charon
*/
#define CA_CERTIFICATE_DIR IPSEC_D_DIR "/cacerts"
2006-06-14 12:44:12 +00:00
/**
* Default directory for CRLs
*
* @ingroup charon
*/
#define CRL_DIR IPSEC_D_DIR "/crls"
/**
* Secrets files
*
* @ingroup charon
*/
#define SECRETS_FILE CONFIG_DIR "/ipsec.secrets"
2005-12-06 12:54:34 +00:00
2005-11-29 10:25:07 +00:00
typedef struct daemon_t daemon_t;
/**
2005-12-06 12:54:34 +00:00
* @brief Main class of daemon, contains some globals.
*
* @ingroup charon
2005-11-29 10:25:07 +00:00
*/
struct daemon_t {
/**
2005-12-06 12:54:34 +00:00
* A socket_t instance.
2005-11-29 10:25:07 +00:00
*/
socket_t *socket;
2005-11-29 10:25:07 +00:00
/**
2005-12-06 12:54:34 +00:00
* A send_queue_t instance.
2005-11-29 10:25:07 +00:00
*/
send_queue_t *send_queue;
2005-12-06 12:54:34 +00:00
2005-11-29 10:25:07 +00:00
/**
2005-12-06 12:54:34 +00:00
* A job_queue_t instance.
2005-11-29 10:25:07 +00:00
*/
job_queue_t *job_queue;
2005-12-06 12:54:34 +00:00
2005-11-29 10:25:07 +00:00
/**
2005-12-06 12:54:34 +00:00
* A event_queue_t instance.
2005-11-29 10:25:07 +00:00
*/
event_queue_t *event_queue;
2005-12-06 12:54:34 +00:00
2005-11-29 10:25:07 +00:00
/**
2005-12-06 12:54:34 +00:00
* A ike_sa_manager_t instance.
2005-11-29 10:25:07 +00:00
*/
ike_sa_manager_t *ike_sa_manager;
2005-12-06 12:54:34 +00:00
2005-11-29 10:25:07 +00:00
/**
* A configuration_t instance.
2005-11-29 10:25:07 +00:00
*/
configuration_t *configuration;
2005-11-29 10:25:07 +00:00
/**
* A connection_store_t instance.
*/
connection_store_t *connections;
/**
* A policy_store_t instance.
*/
policy_store_t *policies;
/**
* A credential_store_t instance.
*/
credential_store_t *credentials;
2005-11-29 10:25:07 +00:00
/**
2005-12-06 12:54:34 +00:00
* The Sender-Thread.
2005-11-29 10:25:07 +00:00
*/
sender_t *sender;
/**
2005-12-06 12:54:34 +00:00
* The Receiver-Thread.
2005-11-29 10:25:07 +00:00
*/
receiver_t *receiver;
/**
2005-12-06 12:54:34 +00:00
* The Scheduler-Thread.
2005-11-29 10:25:07 +00:00
*/
scheduler_t *scheduler;
/**
2005-12-06 12:54:34 +00:00
* The Thread pool managing the worker threads.
2005-11-29 10:25:07 +00:00
*/
thread_pool_t *thread_pool;
/**
* The signaling bus.
*/
bus_t *bus;
/**
* A bus listener logging to stdout
*/
file_logger_t *outlog;
/**
* A bus listener logging to syslog
*/
sys_logger_t *syslog;
2006-02-09 16:25:02 +00:00
/**
* Kernel Interface to communicate with kernel
*/
kernel_interface_t *kernel_interface;
/**
* IPC interface, as whack in pluto
*/
stroke_t *stroke;
2005-11-29 10:25:07 +00:00
/**
2005-12-06 12:54:34 +00:00
* @brief Shut down the daemon.
2005-11-29 10:25:07 +00:00
*
2005-11-29 11:27:25 +00:00
* @param this the daemon to kill
2006-02-09 16:25:02 +00:00
* @param reason describtion why it will be killed
2005-11-29 10:25:07 +00:00
*/
2005-11-29 11:27:25 +00:00
void (*kill) (daemon_t *this, char *reason);
2005-11-29 10:25:07 +00:00
};
/**
2006-02-09 16:25:02 +00:00
* The one and only instance of the daemon.
2005-11-29 10:25:07 +00:00
*/
extern daemon_t *charon;
2005-11-11 11:20:45 +00:00
#endif /*DAEMON_H_*/