blob: 4ba301a0fe9bc5c8bb1a1d2a126c5d42bd8ab3b2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
/*
* Copyright (C) 2007 Martin Willi
* 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.
*
* $Id: gateway.h 5003 2009-03-24 17:43:01Z martin $
*/
/**
* @defgroup gateway gateway
* @{ @ingroup manager
*/
#ifndef GATEWAY_H_
#define GATEWAY_H_
#include <utils/host.h>
#include <utils/enumerator.h>
typedef struct gateway_t gateway_t;
/**
* A connection to a gateway.
*/
struct gateway_t {
/**
* Send an XML request to the gateway.
*
* @param xml xml request string
* @return allocated xml response string
*/
char* (*request)(gateway_t *this, char *xml);
/**
* Query the list of IKE_SAs and all its children.
*
* @return enumerator over ikesa XML elements
*/
enumerator_t* (*query_ikesalist)(gateway_t *this);
/**
* Query the list of peer configs and its subconfigs.
*
* @return enumerator over peerconfig XML elements
*/
enumerator_t* (*query_configlist)(gateway_t *this);
/**
* Terminate an IKE or a CHILD SA.
*
* @param ike TRUE for IKE-, FALSE for a CHILD-SA
* @param id ID of the SA to terminate
* @return enumerator over control response XML children
*/
enumerator_t* (*terminate)(gateway_t *this, bool ike, u_int32_t id);
/**
* Initiate an IKE or a CHILD SA.
*
* @param ike TRUE for IKE-, FALSE for CHILD-SA
* @param name name of the peer/child config
* @return enumerator over control response XML children
*/
enumerator_t* (*initiate)(gateway_t *this, bool ike, char *name);
/**
* Destroy a gateway instance.
*/
void (*destroy)(gateway_t *this);
};
/**
* Create a gateway instance using a TCP connection.
*
* @param name name of the gateway
* @param host gateway connection endpoint
* @return gateway connection
*/
gateway_t *gateway_create_tcp(char *name, host_t *host);
/**
* Create a gateway instance using a UNIX socket.
*
* @param name name of the gateway
* @return gateway connection
*/
gateway_t *gateway_create_unix(char *name);
#endif /** GATEWAY_H_ @}*/
|
