aboutsummaryrefslogtreecommitdiffstats
path: root/Source/charon/encoding/payloads/nonce_payload.c
blob: fa3730e2fdfcae4333e2dab1bc4d0a43a1b03bf3 (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
/**
 * @file nonce_payload.h
 * 
 * @brief Declaration of the class nonce_payload_t. 
 * 
 * An object of this type represents an IKEv2 Nonce-Payload.
 * 
 */

/*
 * 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.
 */
 
/* offsetof macro */
#include <stddef.h>

#include "nonce_payload.h"

#include <encoding/payloads/encodings.h>
#include <utils/allocator.h>



/**
 * Private data of an nonce_payload_t' Object
 * 
 */
typedef struct private_nonce_payload_s private_nonce_payload_t;

struct private_nonce_payload_s {
	/**
	 * public nonce_payload_t interface
	 */
	nonce_payload_t public;
	
	/**
	 * next payload type
	 */
	u_int8_t  next_payload;

	/**
	 * Critical flag
	 */
	bool critical;
	
	/**
	 * Length of this payload
	 */
	u_int16_t payload_length;
	
	/**
	 * the contained nonce value
	 */
	chunk_t nonce;
	
	/**
	 * @brief Computes the length of this payload.
	 *
	 * @param this 	calling private_nonce_payload_t object
	 * @return 		
	 * 				SUCCESS in any case
	 */
	status_t (*compute_length) (private_nonce_payload_t *this);
};

/**
 * Encoding rules to parse or generate a nonce payload
 * 
 * The defined offsets are the positions in a object of type 
 * private_nonce_payload_t.
 * 
 */
encoding_rule_t nonce_payload_encodings[] = {
 	/* 1 Byte next payload type, stored in the field next_payload */
	{ U_INT_8,			offsetof(private_nonce_payload_t, next_payload) 	},
	/* the critical bit */
	{ FLAG,				offsetof(private_nonce_payload_t, critical) 		},	
 	/* 7 Bit reserved bits, nowhere stored */
	{ RESERVED_BIT,	0 														}, 
	{ RESERVED_BIT,	0 														}, 
	{ RESERVED_BIT,	0 														}, 
	{ RESERVED_BIT,	0 														}, 
	{ RESERVED_BIT,	0 														}, 
	{ RESERVED_BIT,	0 														}, 
	{ RESERVED_BIT,	0 														}, 
	/* Length of the whole nonce payload*/
	{ PAYLOAD_LENGTH,	offsetof(private_nonce_payload_t, payload_length) 	},	
	/* some nonce bytes, lenth is defined in PAYLOAD_LENGTH */
	{ NONCE_DATA,			offsetof(private_nonce_payload_t, nonce) 		}
};

/*                           1                   2                   3
       0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      ! Next Payload  !C!  RESERVED   !         Payload Length        !
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      !                                                               !
      ~                            Nonce Data                         ~
      !                                                               !
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*/

/**
 * Implements payload_t's verify function.
 * See #payload_s.verify for description.
 */
static status_t verify(private_nonce_payload_t *this)
{
	if (this->critical)
	{
		/* critical bit is set! */
		return FAILED;
	}
	if ((this->nonce.len < 16) || ((this->nonce.len > 256)))
	{
		/* nonce length is wrong */
		return FAILED;
	}
	
	return SUCCESS;
}

/**
 * Implements nonce_payload_t's set_nonce function.
 * See #nonce_payload_t.set_nonce for description.
 */
static status_t set_nonce(private_nonce_payload_t *this, chunk_t nonce)
{
	if (nonce.len >= 16 && nonce.len <= 256)
	{

		this->nonce.ptr = allocator_clone_bytes(nonce.ptr, nonce.len);
		if (this->nonce.ptr == NULL)
		{
			return OUT_OF_RES;
		}	
		this->nonce.len = nonce.len;
		this->payload_length = NONCE_PAYLOAD_HEADER_LENGTH + nonce.len;
		return SUCCESS;	
	}
	return INVALID_ARG;
}

/**
 * Implements nonce_payload_t's get_nonce function.
 * See #nonce_payload_t.get_nonce for description.
 */
static status_t get_nonce(private_nonce_payload_t *this, chunk_t *nonce)
{
	nonce->ptr = allocator_clone_bytes(this->nonce.ptr,this->nonce.len);
	if (nonce->ptr == NULL)
	{
		return OUT_OF_RES;
	}
	nonce->len = this->nonce.len;
	return SUCCESS;
}


/**
 * Implements payload_t's get_encoding_rules function.
 * See #payload_s.get_encoding_rules for description.
 */
static status_t get_encoding_rules(private_nonce_payload_t *this, encoding_rule_t **rules, size_t *rule_count)
{
	*rules = nonce_payload_encodings;
	*rule_count = sizeof(nonce_payload_encodings) / sizeof(encoding_rule_t);
	
	return SUCCESS;
}

/**
 * Implements payload_t's get_type function.
 * See #payload_s.get_type for description.
 */
static payload_type_t get_type(private_nonce_payload_t *this)
{
	return NONCE;
}

/**
 * Implements payload_t's get_next_type function.
 * See #payload_s.get_next_type for description.
 */
static payload_type_t get_next_type(private_nonce_payload_t *this)
{
	return (this->next_payload);
}

/**
 * Implements payload_t's set_next_type function.
 * See #payload_s.set_next_type for description.
 */
static status_t set_next_type(private_nonce_payload_t *this,payload_type_t type)
{
	this->next_payload = type;
	return SUCCESS;
}

/**
 * Implements payload_t's get_length function.
 * See #payload_s.get_length for description.
 */
static size_t get_length(private_nonce_payload_t *this)
{
	this->compute_length(this);
	return this->payload_length;
}

/**
 * Implements payload_t's and nonce_payload_t's destroy function.
 * See #payload_s.destroy or nonce_payload_s.destroy for description.
 */
static status_t destroy(private_nonce_payload_t *this)
{
	if (this->nonce.ptr != NULL)
	{
		allocator_free(this->nonce.ptr);
	}
	
	allocator_free(this);	
	return SUCCESS;
}

/*
 * Described in header
 */
nonce_payload_t *nonce_payload_create()
{
	private_nonce_payload_t *this = allocator_alloc_thing(private_nonce_payload_t);
	if (this == NULL)
	{
		return NULL;	
	}	
	
	/* interface functions */
	this->public.payload_interface.verify = (status_t (*) (payload_t *))verify;
	this->public.payload_interface.get_encoding_rules = (status_t (*) (payload_t *, encoding_rule_t **, size_t *) ) get_encoding_rules;
	this->public.payload_interface.get_length = (size_t (*) (payload_t *)) get_length;
	this->public.payload_interface.get_next_type = (payload_type_t (*) (payload_t *)) get_next_type;
	this->public.payload_interface.set_next_type = (status_t (*) (payload_t *,payload_type_t)) set_next_type;
	this->public.payload_interface.get_type = (payload_type_t (*) (payload_t *)) get_type;
	this->public.payload_interface.destroy = (status_t (*) (payload_t *))destroy;
	
	/* public functions */
	this->public.destroy = (status_t (*) (nonce_payload_t *)) destroy;
	this->public.set_nonce = (status_t (*) (nonce_payload_t *,chunk_t)) set_nonce;
	this->public.get_nonce = (status_t (*) (nonce_payload_t *,chunk_t*)) get_nonce;
	
	/* private variables */
	this->critical = FALSE;
	this->next_payload = NO_PAYLOAD;
	this->payload_length = NONCE_PAYLOAD_HEADER_LENGTH;
	this->nonce.ptr = NULL;
	this->nonce.len = 0;

	return (&(this->public));
}