summaryrefslogtreecommitdiff
path: root/src/charon/encoding/payloads/ike_header.h
blob: 95c20f810797efa8887878e912cfb95158963670 (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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
/**
 * @file ike_header.h
 * 
 * @brief Interface of ike_header_t. 
 * 
 */

/*
 * Copyright (C) 2005-2006 Martin Willi
 * Copyright (C) 2005 Jan Hutter
 * 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 IKE_HEADER_H_
#define IKE_HEADER_H_

typedef enum exchange_type_t exchange_type_t;
typedef struct ike_header_t ike_header_t;

#include <library.h>
#include <encoding/payloads/payload.h>

/**
 * Major Version of IKEv2.
 * 
 * @ingroup payloads
 */
#define IKE_MAJOR_VERSION 2

/**
 * Minor Version of IKEv2.
 * 
 * @ingroup payloads
 */
#define IKE_MINOR_VERSION 0

/**
 * Flag in IKEv2-Header. Always 0.
 * 
 * @ingroup payloads
 */
#define HIGHER_VERSION_SUPPORTED_FLAG 0

/**
 * Length of IKE Header in Bytes.
 * 
 * @ingroup payloads
 */
#define IKE_HEADER_LENGTH 28

/**
 * @brief Different types of IKE-Exchanges.
 *
 * See Draft for different types.
 * 
 * @ingroup payloads
 */
enum exchange_type_t{

	/**
	 * EXCHANGE_TYPE_UNDEFINED. In private space, since not a official message type.
	 */
	EXCHANGE_TYPE_UNDEFINED = 240,
	
	/**
	 * IKE_SA_INIT.
	 */
	IKE_SA_INIT = 34,

	/**
	 * IKE_AUTH.
	 */
	IKE_AUTH = 35,

	/**
	 * CREATE_CHILD_SA.
	 */
	CREATE_CHILD_SA = 36,

	/**
	 * INFORMATIONAL.
	 */
	INFORMATIONAL = 37 
};

/**
 * enum name for exchange_type_t
 * 
 * @ingroup payloads
 */
extern enum_name_t *exchange_type_names;

/**
 * @brief An object of this type represents an IKEv2 header and is used to 
 * generate and parse IKEv2 headers.
 * 
 * The header format of an IKEv2-Message is compatible to the 
 * ISAKMP-Header format to allow implementations supporting 
 * both versions of the IKE-protocol.
 * 
 * @b Constructors:
 * - ike_header_create()
 * 
 * @ingroup payloads
 */
struct ike_header_t {
	/**
	 * The payload_t interface.
	 */
	payload_t payload_interface;
	
	/**
	 * @brief Get the initiator spi.
	 *
	 * @param this 			ike_header_t object
	 * @return 				initiator_spi
	 */
	u_int64_t (*get_initiator_spi) (ike_header_t *this);
	
	/**
	 * @brief Set the initiator spi.
	 *
	 * @param this 			ike_header_t object
	 * @param initiator_spi	initiator_spi
	 */
	void (*set_initiator_spi) (ike_header_t *this, u_int64_t initiator_spi);
	
	/**
	 * @brief Get the responder spi.
	 *
	 * @param this 			ike_header_t object
	 * @return 				responder_spi
	 */
	u_int64_t (*get_responder_spi) (ike_header_t *this);
	
	/**
	 * @brief Set the responder spi.
	 *
	 * @param this 			ike_header_t object
	 * @param responder_spi	responder_spi
	 */
	void (*set_responder_spi) (ike_header_t *this, u_int64_t responder_spi);
	
	/**
	 * @brief Get the major version.
	 *
	 * @param this 			ike_header_t object
	 * @return 				major version
	 */
	u_int8_t (*get_maj_version) (ike_header_t *this);
	
	/**
	 * @brief Get the minor version.
	 *
	 * @param this 			ike_header_t object
	 * @return 				minor version
	 */
	u_int8_t (*get_min_version) (ike_header_t *this);
	
	/**
	 * @brief Get the response flag.
	 *
	 * @param this 			ike_header_t object
	 * @return 				response flag
	 */
	bool (*get_response_flag) (ike_header_t *this);
	
	/**
	 * @brief Set the response flag-
	 *
	 * @param this 			ike_header_t object
	 * @param response		response flag
	 * 
	 */
	void (*set_response_flag) (ike_header_t *this, bool response);
	/**
	 * @brief Get "higher version supported"-flag.
	 *
	 * @param this 			ike_header_t object
	 * @return 				version flag
	 */
	bool (*get_version_flag) (ike_header_t *this);
	
	/**
	 * @brief Get the initiator flag.
	 *
	 * @param this 			ike_header_t object
	 * @return 				initiator flag
	 */
	bool (*get_initiator_flag) (ike_header_t *this);
	
	/**
	 * @brief Set the initiator flag.
	 *
	 * @param this 			ike_header_t object
	 * @param initiator		initiator flag
	 * 
	 */
	void (*set_initiator_flag) (ike_header_t *this, bool initiator);

	/**
	 * @brief Get the exchange type.
	 *
	 * @param this 			ike_header_t object
	 * @return 				 exchange type
	 */
	u_int8_t (*get_exchange_type) (ike_header_t *this);
	
	/**
	 * @brief Set the  exchange type.
	 *
	 * @param this 			ike_header_t object
	 * @param exchange_type	exchange type
	 */
	void (*set_exchange_type) (ike_header_t *this, u_int8_t exchange_type);
	
	/**
	 * @brief Get the message id.
	 *
	 * @param this 			ike_header_t object
	 * @return 				message id
	 */
	u_int32_t (*get_message_id) (ike_header_t *this);
	
	/**
	 * @brief Set the message id.
	 *
	 * @param this 			ike_header_t object
	 * @param initiator_spi	message id
	 */
	void (*set_message_id) (ike_header_t *this, u_int32_t message_id);
	
	/**
	 * @brief Destroys a ike_header_t object.
	 *
	 * @param this 			ike_header_t object to destroy
	 */
	void (*destroy) (ike_header_t *this);
};

/**
 * @brief Create an ike_header_t object
 * 
 * @return ike_header_t object
 * 
 * @ingroup payloads
 */
ike_header_t *ike_header_create(void);

#endif /*IKE_HEADER_H_*/