aboutsummaryrefslogtreecommitdiffstats
path: root/Source/charon/config/configuration_manager.h
blob: e15f6a538360c0f3c153c75e100d563ca6ad00ec (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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
/**
 * @file configuration_manager.h
 * 
 * @brief Manages all configuration aspects of the daemon.
 *  
 */

/*
 * Copyright (C) 2005 Jan Hutter, 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.
 */

#ifndef CONFIGURATION_MANAGER_H_
#define CONFIGURATION_MANAGER_H_

#include <types.h>
#include <utils/linked_list.h>
#include <network/host.h>
#include <encoding/payloads/transform_substructure.h>
#include <transforms/prfs/prf.h>
#include <transforms/signers/signer.h>
#include <transforms/crypters/crypter.h>


typedef struct configuration_manager_t configuration_manager_t;

/**
 * @brief Manages all configuration aspects of the daemon.
 * 
 * Currently the configuration manager class does not store specific configurations.
 * It is expected, that in future different configurations are stored in a linked list 
 * or a hash map and are managed by this class.
 * 
 */
struct configuration_manager_t { 
	
	/**
	 * Gets the remote host information for a specific configuration name.
	 * 
	 * A host information consist of IP address and UDP port.
	 * 
	 * @param this	calling object
	 * @param name	name of the configuration
	 * @param host	remote host information gets stored at this location
	 * 
	 * @return		
	 * 				- NOT_FOUND
	 * 				- SUCCESS
	 */
	status_t (*get_remote_host) (configuration_manager_t *this, char *name, host_t **host);

	/**
	 * Gets the local host information for a specific configuration name
	 * 
	 * A host information consist of IP address and UDP port.
	 * 
	 * @param this	calling object
	 * @param name	name of the configuration
	 * @param host	local host information gets stored at this location
	 * 
	 * @return		
	 * 				- NOT_FOUND (not yet implemented)
	 * 				- SUCCESS
	 */
	status_t (*get_local_host) (configuration_manager_t *this, char *name, host_t **host);
	
	/**
	 * Returns the DH group number to use when initiating a connection.
	 * 
	 * To make sure that different group numbers are supported in case 
	 * a group number is not supported by other peer, a priority has to get defined.
	 * 
	 * 
	 * @param this				calling object
	 * @param name				name of the configuration
	 * @param dh_group_number	the DH group number gets stored at this location
	 * @param priority			priority to use for selection of DH group number.
	 * 							Highest priority is 1. All higher values have lower
	 * 							priority.
	 * 
	 * @return		
	 *							- FAILED (not yet implemented)
	 * 							- NOT_FOUND (not yet implemented)
	 * 							- SUCCESS
	 */
	status_t (*get_dh_group_number) (configuration_manager_t *this, char *name, u_int16_t *dh_group_number, u_int16_t priority);
	
	/**
	 * Returns the proposals which should be used to initiate a connection with a specific
	 * host.
	 * 
	 * The proposals of type proposal_substructure_t * are returned over the given iterator 
	 * and have to be destroyed by the caller.
	 * 
	 * 
	 * @param this				calling object
	 * @param host				host information used to find the correct proposals
	 * @param list				iterator where the proposals are written to
	 * 
	 * @return		
	 * 							- NOT_FOUND (not yet implemented)
	 * 							- SUCCESS
	 */
	status_t (*get_proposals_for_host) (configuration_manager_t *this, host_t *host, iterator_t *list);
	
	/**
	 * Checks the suggested proposals passed as iterator in and selects one proposal to be sent as selection
	 * of this proposals.
	 * 
	 * Currently there is no check implemented. The first suggested proposal is cloned and then as selected returned.
	 * 
	 * 
	 * @param this				calling object
	 * @param host				host information used to find the correct proposals
	 * @param in					iterator with suggested proposals of type proposal_substructure_t *
	 * @param out				The selected proposals of type proposal_substructure_t * are written to this iterator
	 * 
	 * @return		
	 * 							- FAILED
	 * 							- NOT_FOUND (not yet implemented)
	 * 							- SUCCESS
	 */
	status_t (*select_proposals_for_host) (configuration_manager_t *this, host_t *host, iterator_t *in, iterator_t *out);
	
	/**
	 * Checks if the selected proposals of a remote hosts are valid.
	 * 
	 * 
	 * @param this				calling object
	 * @param host				host information
	 * @param proposals			iterator with selected proposals
	 * @param[out] valid			TRUE if selected proposals are accepted
	 * 
	 * @return			
	 * 												- FAILED
	 * 												- NOT_FOUND (not yet implemented)
	 * 												- SUCCESS
	 */
	status_t (*check_selected_proposals_for_host) (configuration_manager_t *this,
												   host_t *host, 
												   iterator_t *proposals,
												   bool *valid);
	
	/**
	 * Checks if a given dh_group number is allowed for a specific host
	 * 
	 * 
	 * @param this				calling object
	 * @param host				host information
	 * @param group				DH group number to check if allowed
	 * @param[out] allowed		will be set to TRUE if group number is allowed, FALSE otherwise
	 * 
	 * @return		
	 * 							- FAILED
	 * 							- NOT_FOUND (not yet implemented)
	 * 							- SUCCESS
	 */
	status_t (*is_dh_group_allowed_for_host) (configuration_manager_t *this, host_t *host, diffie_hellman_group_t group, bool *allowed);
	
	/**
	 * Destroys configuration manager
	 * 
	 * 
	 * @param this				calling object
	 * @return		
	 * 							- SUCCESS
	 */
	status_t (*destroy) (configuration_manager_t *this);
};

/**
 * Creates the mighty configuration manager
 * 
 * @return 
 * 			- pointer to created manager object if succeeded
 * 			- NULL if memory allocation failed
 */
configuration_manager_t *configuration_manager_create();

#endif /*CONFIGURATION_MANAGER_H_*/