automatically establish a PSK authenticated SA between cluster nodes
[strongswan.git] / src / charon / plugins / ha_sync / ha_sync_socket.h
1 /*
2 * Copyright (C) 2008 Martin Willi
3 * Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 */
15
16 /**
17 * @defgroup ha_sync_socket ha_sync_socket
18 * @{ @ingroup ha_sync
19 */
20
21 #ifndef HA_SYNC_SOCKET_H_
22 #define HA_SYNC_SOCKET_H_
23
24 #include "ha_sync_message.h"
25
26 #include <sa/ike_sa.h>
27
28 /**
29 * UDP port we use for communication
30 */
31 #define HA_SYNC_PORT 4510
32
33 typedef struct ha_sync_socket_t ha_sync_socket_t;
34
35 /**
36 * Socket to send/received SA synchronization data
37 */
38 struct ha_sync_socket_t {
39
40 /**
41 * Push synchronization information to the responsible node.
42 *
43 * @param message message to send, gets destroyed by push()
44 */
45 void (*push)(ha_sync_socket_t *this, ha_sync_message_t *message);
46
47 /**
48 * Pull synchronization information from a peer we are responsible.
49 *
50 * @return received message
51 */
52 ha_sync_message_t *(*pull)(ha_sync_socket_t *this);
53
54 /**
55 * Check if an IKE_SA is used for exchanging sync messages.
56 *
57 * @param ike_Sa ike_sa to check
58 * @return TRUE if IKE_SA is used to secure sync messages
59 */
60 bool (*is_sync_sa)(ha_sync_socket_t *this, ike_sa_t *ike_sa);
61
62 /**
63 * Destroy a ha_sync_socket_t.
64 */
65 void (*destroy)(ha_sync_socket_t *this);
66 };
67
68 /**
69 * Create a ha_sync_socket instance.
70 */
71 ha_sync_socket_t *ha_sync_socket_create();
72
73 #endif /* HA_SYNC_SOCKET_ @}*/