-removed freeing of nonce data
[strongswan.git] / Source / charon / payloads / nonce_payload.c
1 /**
2 * @file nonce_payload.h
3 *
4 * @brief Declaration of the class nonce_payload_t.
5 *
6 * An object of this type represents an IKEv2 Nonce-Payload.
7 *
8 */
9
10 /*
11 * Copyright (C) 2005 Jan Hutter, Martin Willi
12 * Hochschule fuer Technik Rapperswil
13 *
14 * This program is free software; you can redistribute it and/or modify it
15 * under the terms of the GNU General Public License as published by the
16 * Free Software Foundation; either version 2 of the License, or (at your
17 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
18 *
19 * This program is distributed in the hope that it will be useful, but
20 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
21 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 * for more details.
23 */
24
25 /* offsetof macro */
26 #include <stddef.h>
27
28 #include "nonce_payload.h"
29
30 #include "encodings.h"
31 #include "../utils/allocator.h"
32
33
34
35 /**
36 * Private data of an nonce_payload_t' Object
37 *
38 */
39 typedef struct private_nonce_payload_s private_nonce_payload_t;
40
41 struct private_nonce_payload_s {
42 /**
43 * public nonce_payload_t interface
44 */
45 nonce_payload_t public;
46
47 /**
48 * next payload type
49 */
50 u_int8_t next_payload;
51
52 /**
53 * Critical flag
54 */
55 bool critical;
56
57 /**
58 * Length of this payload
59 */
60 u_int16_t payload_length;
61
62 /**
63 * the contained nonce value
64 */
65 chunk_t nonce;
66
67 /**
68 * @brief Computes the length of this payload.
69 *
70 * @param this calling private_nonce_payload_t object
71 * @return
72 * SUCCESS in any case
73 */
74 status_t (*compute_length) (private_nonce_payload_t *this);
75 };
76
77 /**
78 * Encoding rules to parse or generate a nonce payload
79 *
80 * The defined offsets are the positions in a object of type
81 * private_nonce_payload_t.
82 *
83 */
84 encoding_rule_t nonce_payload_encodings[] = {
85 /* 1 Byte next payload type, stored in the field next_payload */
86 { U_INT_8, offsetof(private_nonce_payload_t, next_payload) },
87 /* the critical bit */
88 { FLAG, offsetof(private_nonce_payload_t, critical) },
89 /* 7 Bit reserved bits, nowhere stored */
90 { RESERVED_BIT, 0 },
91 { RESERVED_BIT, 0 },
92 { RESERVED_BIT, 0 },
93 { RESERVED_BIT, 0 },
94 { RESERVED_BIT, 0 },
95 { RESERVED_BIT, 0 },
96 { RESERVED_BIT, 0 },
97 /* Length of the whole nonce payload*/
98 { PAYLOAD_LENGTH, offsetof(private_nonce_payload_t, payload_length) },
99 /* some nonce bytes, lenth is defined in PAYLOAD_LENGTH */
100 { NONCE_DATA, offsetof(private_nonce_payload_t, nonce) }
101 };
102
103 /* 1 2 3
104 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
105 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
106 ! Next Payload !C! RESERVED ! Payload Length !
107 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
108 ! !
109 ~ Nonce Data ~
110 ! !
111 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
112 */
113
114 /**
115 * Implements payload_t's verify function.
116 * See #payload_s.verify for description.
117 */
118 static status_t verify(private_nonce_payload_t *this)
119 {
120 if (this->critical)
121 {
122 /* critical bit is set! */
123 return FAILED;
124 }
125 if ((this->nonce.len < 16) || ((this->nonce.len > 256)))
126 {
127 /* nonce length is wrong */
128 return FAILED;
129 }
130
131 return SUCCESS;
132 }
133
134 /**
135 * Implements payload_t's and nonce_payload_t's destroy function.
136 * See #payload_s.destroy or nonce_payload_s.destroy for description.
137 */
138 static status_t destroy(private_nonce_payload_t *this)
139 {
140 allocator_free(this);
141
142 return SUCCESS;
143 }
144
145 /**
146 * Implements nonce_payload_t's set_nonce function.
147 * See #nonce_payload_t.set_nonce for description.
148 */
149 static status_t set_nonce(private_nonce_payload_t *this, chunk_t nonce)
150 {
151 if (nonce.len >= 16 && nonce.len <= 256)
152 {
153 this->nonce.len = nonce.len;
154 this->nonce.ptr = nonce.ptr;
155 this->payload_length = NONCE_PAYLOAD_HEADER_LENGTH + nonce.len;
156 return SUCCESS;
157 }
158 return INVALID_ARG;
159 }
160
161 /**
162 * Implements nonce_payload_t's get_nonce function.
163 * See #nonce_payload_t.get_nonce for description.
164 */
165 static status_t get_nonce(private_nonce_payload_t *this, chunk_t *nonce)
166 {
167 nonce->ptr = this->nonce.ptr;
168 nonce->len = this->nonce.len;
169 return SUCCESS;
170 }
171
172 /**
173 * Implements payload_t's get_encoding_rules function.
174 * See #payload_s.get_encoding_rules for description.
175 */
176 static status_t get_encoding_rules(private_nonce_payload_t *this, encoding_rule_t **rules, size_t *rule_count)
177 {
178 *rules = nonce_payload_encodings;
179 *rule_count = sizeof(nonce_payload_encodings) / sizeof(encoding_rule_t);
180
181 return SUCCESS;
182 }
183
184 /**
185 * Implements payload_t's get_type function.
186 * See #payload_s.get_type for description.
187 */
188 static payload_type_t get_type(private_nonce_payload_t *this)
189 {
190 return NONCE;
191 }
192
193 /**
194 * Implements payload_t's get_next_type function.
195 * See #payload_s.get_next_type for description.
196 */
197 static payload_type_t get_next_type(private_nonce_payload_t *this)
198 {
199 return (this->next_payload);
200 }
201
202 /**
203 * Implements payload_t's set_next_type function.
204 * See #payload_s.set_next_type for description.
205 */
206 static status_t set_next_type(private_nonce_payload_t *this,payload_type_t type)
207 {
208 this->next_payload = type;
209 return SUCCESS;
210 }
211
212 /**
213 * Implements payload_t's get_length function.
214 * See #payload_s.get_length for description.
215 */
216 static size_t get_length(private_nonce_payload_t *this)
217 {
218 this->compute_length(this);
219 return this->payload_length;
220 }
221
222 /*
223 * Described in header
224 */
225 nonce_payload_t *nonce_payload_create()
226 {
227 private_nonce_payload_t *this = allocator_alloc_thing(private_nonce_payload_t);
228 if (this == NULL)
229 {
230 return NULL;
231 }
232
233 this->public.payload_interface.verify = (status_t (*) (payload_t *))verify;
234 this->public.payload_interface.get_encoding_rules = (status_t (*) (payload_t *, encoding_rule_t **, size_t *) ) get_encoding_rules;
235 this->public.payload_interface.get_length = (size_t (*) (payload_t *)) get_length;
236 this->public.payload_interface.get_next_type = (payload_type_t (*) (payload_t *)) get_next_type;
237 this->public.payload_interface.set_next_type = (status_t (*) (payload_t *,payload_type_t)) set_next_type;
238 this->public.payload_interface.get_type = (payload_type_t (*) (payload_t *)) get_type;
239 this->public.payload_interface.destroy = (status_t (*) (payload_t *))destroy;
240 this->public.destroy = (status_t (*) (nonce_payload_t *)) destroy;
241 this->public.set_nonce = (status_t (*) (nonce_payload_t *,chunk_t)) set_nonce;
242 this->public.get_nonce = (status_t (*) (nonce_payload_t *,chunk_t*)) get_nonce;
243
244 this->critical = FALSE;
245 this->next_payload = NO_PAYLOAD;
246 this->payload_length = NONCE_PAYLOAD_HEADER_LENGTH;
247 this->nonce.ptr = NULL;
248 this->nonce.len = 0;
249
250 return (&(this->public));
251 }
252
253