summaryrefslogtreecommitdiff
path: root/src/libcharon/encoding/payloads/ike_header.h
blob: fa89c393910412d89328e4124c81820f01e01d2a (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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
/*
 * Copyright (C) 2007 Tobias Brunner
 * Copyright (C) 2005-2011 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.
 */

/**
 * @defgroup ike_header ike_header
 * @{ @ingroup payloads
 */

#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 IKEv1 we implement.
 */
#define IKEV1_MAJOR_VERSION 1

/**
 * Minor Version of IKEv1 we implement.
 */
#define IKEV1_MINOR_VERSION 0

/**
 * Major Version of IKEv2 we implement.
 */
#define IKEV2_MAJOR_VERSION 2

/**
 * Minor Version of IKEv2 we implement.
 */
#define IKEV2_MINOR_VERSION 0

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

/**
 * Different types of IKE-Exchanges.
 *
 * See RFC for different types.
 */
enum exchange_type_t{

	/**
	 * Identity Protection (Main mode).
	 */
	ID_PROT = 2,

	/**
	 * Authentication Only.
	 */
	AUTH_ONLY = 3,

	/**
	 * Aggressive (Aggressive mode)
	 */
	AGGRESSIVE = 4,

	/**
	 * Informational in IKEv1
	 */
	INFORMATIONAL_V1 = 5,

	/**
	 * Transaction (ISAKMP Cfg Mode "draft-ietf-ipsec-isakmp-mode-cfg-05")
	 */
	TRANSACTION = 6,

	/**
	 * Quick Mode
	 */
	QUICK_MODE = 32,

	/**
	 * New Group Mode
	 */
	NEW_GROUP_MODE = 33,

	/**
	 * IKE_SA_INIT.
	 */
	IKE_SA_INIT = 34,

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

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

	/**
	 * INFORMATIONAL in IKEv2.
	 */
	INFORMATIONAL = 37,

	/**
	 * IKE_SESSION_RESUME (RFC 5723).
	 */
	IKE_SESSION_RESUME = 38,

#ifdef ME
	/**
	 * ME_CONNECT
	 */
	ME_CONNECT = 240,
#endif /* ME */

	/**
	 * Undefined exchange type, in private space.
	 */
	EXCHANGE_TYPE_UNDEFINED = 255,
};

/**
 * enum name for exchange_type_t
 */
extern enum_name_t *exchange_type_names;

/**
 * An object of this type represents an IKE header of either IKEv1 or IKEv2.
 */
struct ike_header_t {
	/**
	 * The payload_t interface.
	 */
	payload_t payload_interface;

	/**
	 * Get the initiator spi.
	 *
	 * @return				initiator_spi
	 */
	uint64_t (*get_initiator_spi) (ike_header_t *this);

	/**
	 * Set the initiator spi.
	 *
	 * @param initiator_spi	initiator_spi
	 */
	void (*set_initiator_spi) (ike_header_t *this, uint64_t initiator_spi);

	/**
	 * Get the responder spi.
	 *
	 * @return				responder_spi
	 */
	uint64_t (*get_responder_spi) (ike_header_t *this);

	/**
	 * Set the responder spi.
	 *
	 * @param responder_spi	responder_spi
	 */
	void (*set_responder_spi) (ike_header_t *this, uint64_t responder_spi);

	/**
	 * Get the major version.
	 *
	 * @return				major version
	 */
	uint8_t (*get_maj_version) (ike_header_t *this);

	/**
	 * Set the major version.
	 *
	 * @param major			major version
	 */
	void (*set_maj_version) (ike_header_t *this, uint8_t major);

	/**
	 * Get the minor version.
	 *
	 * @return				minor version
	 */
	uint8_t (*get_min_version) (ike_header_t *this);

	/**
	 * Set the minor version.
	 *
	 * @param minor			minor version
	 */
	void (*set_min_version) (ike_header_t *this, uint8_t minor);

	/**
	 * Get the response flag.
	 *
	 * @return				response flag
	 */
	bool (*get_response_flag) (ike_header_t *this);

	/**
	 * Set the response flag-
	 *
	 * @param response		response flag
	 */
	void (*set_response_flag) (ike_header_t *this, bool response);

	/**
	 * Get "higher version supported"-flag.
	 *
	 * @return				version flag
	 */
	bool (*get_version_flag) (ike_header_t *this);

	/**
	 * Set the "higher version supported"-flag.
	 *
	 * @param version		flag value
	 */
	void (*set_version_flag)(ike_header_t *this, bool version);

	/**
	 * Get the initiator flag.
	 *
	 * @return				initiator flag
	 */
	bool (*get_initiator_flag) (ike_header_t *this);

	/**
	 * Set the initiator flag.
	 *
	 * @param initiator		initiator flag
	 */
	void (*set_initiator_flag) (ike_header_t *this, bool initiator);

	/**
	 * Get the encryption flag.
	 *
	 * @return				encryption flag
	 */
	bool (*get_encryption_flag) (ike_header_t *this);

	/**
	 * Set the encryption flag.
	 *
	 * @param encryption		encryption flag
	 */
	void (*set_encryption_flag) (ike_header_t *this, bool encryption);

	/**
	 * Get the commit flag.
	 *
	 * @return				commit flag
	 */
	bool (*get_commit_flag) (ike_header_t *this);

	/**
	 * Set the commit flag.
	 *
	 * @param commit		commit flag
	 */
	void (*set_commit_flag) (ike_header_t *this, bool commit);

	/**
	 * Get the authentication only flag.
	 *
	 * @return				authonly flag
	 */
	bool (*get_authonly_flag) (ike_header_t *this);

	/**
	 * Set the authentication only flag.
	 *
	 * @param authonly		authonly flag
	 */
	void (*set_authonly_flag) (ike_header_t *this, bool authonly);

	/**
	 * Get the exchange type.
	 *
	 * @return				exchange type
	 */
	uint8_t (*get_exchange_type) (ike_header_t *this);

	/**
	 * Set the  exchange type.
	 *
	 * @param exchange_type	exchange type
	 */
	void (*set_exchange_type) (ike_header_t *this, uint8_t exchange_type);

	/**
	 * Get the message id.
	 *
	 * @return				message id
	 */
	uint32_t (*get_message_id) (ike_header_t *this);

	/**
	 * Set the message id.
	 *
	 * @param initiator_spi	message id
	 */
	void (*set_message_id) (ike_header_t *this, uint32_t message_id);

	/**
	 * Destroys a ike_header_t object.
	 */
	void (*destroy) (ike_header_t *this);
};

/**
 * Create an empty ike_header_t object.
 *
 * @return ike_header_t object
 */
ike_header_t *ike_header_create(void);

/**
 * Create an ike_header_t object for a specific major/minor version
 *
 * @return ike_header_t object
 */
ike_header_t *ike_header_create_version(int major, int minor);

#endif /** IKE_HEADER_H_ @}*/