implemented IETF Operational Status attribute
[strongswan.git] / src / libimcv / ietf / ietf_attr_op_status.c
1 /*
2 * Copyright (C) 2012 Andreas Steffen
3 * HSR Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 */
15
16 #include "ietf_attr_op_status.h"
17
18 #include <pa_tnc/pa_tnc_msg.h>
19 #include <bio/bio_writer.h>
20 #include <bio/bio_reader.h>
21 #include <debug.h>
22
23 #include <time.h>
24
25 typedef struct private_ietf_attr_op_status_t private_ietf_attr_op_status_t;
26
27 ENUM(op_status_names, OP_STATUS_UNKNOWN, OP_STATUS_OPERATIONAL,
28 "unknown",
29 "not installed",
30 "installed",
31 "operational"
32 );
33
34 ENUM(op_result_names, OP_RESULT_UNKNOWN, OP_RESULT_UNSUCCESSFUL,
35 "unknown",
36 "successful",
37 "errored",
38 "unsuccessful"
39 );
40
41 /**
42 * PA-TNC Operational Status type (see section 4.2.5 of RFC 5792)
43 *
44 * 1 2 3
45 * 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
46 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
47 * | Status | Result | Reserved |
48 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
49 * | Last Use |
50 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
51 * | Last Use (continued) |
52 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
53 * | Last Use (continued) |
54 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
55 * | Last Use (continued) |
56 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
57 * | Last Use (continued) |
58 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
59 */
60
61 #define OP_STATUS_SIZE 24
62
63 /**
64 * Private data of an ietf_attr_op_status_t object.
65 */
66 struct private_ietf_attr_op_status_t {
67
68 /**
69 * Public members of ietf_attr_op_status_t
70 */
71 ietf_attr_op_status_t public;
72
73 /**
74 * Vendor-specific attribute type
75 */
76 pen_type_t type;
77
78 /**
79 * Attribute value
80 */
81 chunk_t value;
82
83 /**
84 * Noskip flag
85 */
86 bool noskip_flag;
87
88 /**
89 * Status
90 */
91 u_int8_t status;
92
93 /**
94 * Result
95 */
96 u_int8_t result;
97
98 /**
99 * Last Use
100 */
101 time_t last_use;
102
103 /**
104 * Reference count
105 */
106 refcount_t ref;
107 };
108
109 METHOD(pa_tnc_attr_t, get_type, pen_type_t,
110 private_ietf_attr_op_status_t *this)
111 {
112 return this->type;
113 }
114
115 METHOD(pa_tnc_attr_t, get_value, chunk_t,
116 private_ietf_attr_op_status_t *this)
117 {
118 return this->value;
119 }
120
121 METHOD(pa_tnc_attr_t, get_noskip_flag, bool,
122 private_ietf_attr_op_status_t *this)
123 {
124 return this->noskip_flag;
125 }
126
127 METHOD(pa_tnc_attr_t, set_noskip_flag,void,
128 private_ietf_attr_op_status_t *this, bool noskip)
129 {
130 this->noskip_flag = noskip;
131 }
132
133 METHOD(pa_tnc_attr_t, build, void,
134 private_ietf_attr_op_status_t *this)
135 {
136 bio_writer_t *writer;
137 char last_use[24];
138 struct tm t;
139
140 if (this->value.ptr)
141 {
142 return;
143 }
144
145 /* Conversion from time_t to RFC 3339 ASCII string */
146 gmtime_r(&this->last_use, &t);
147 snprintf(last_use, 21, "%04d-%02d-%02dT%02d:%02d:%02dZ", 1900 + t.tm_year,
148 t.tm_mon + 1, t.tm_mday, t.tm_hour, t.tm_min, t.tm_sec);
149
150 writer = bio_writer_create(OP_STATUS_SIZE);
151 writer->write_uint8 (writer, this->status);
152 writer->write_uint8 (writer, this->result);
153 writer->write_uint16(writer, 0x0000);
154 writer->write_data (writer, chunk_create(last_use, 20));
155
156 this->value = chunk_clone(writer->get_buf(writer));
157 writer->destroy(writer);
158 }
159
160 METHOD(pa_tnc_attr_t, process, status_t,
161 private_ietf_attr_op_status_t *this, u_int32_t *offset)
162 {
163 bio_reader_t *reader;
164 chunk_t last_use;
165 u_int16_t reserved;
166 struct tm t;
167 int nr;
168
169 *offset = 0;
170
171 if (this->value.len != OP_STATUS_SIZE)
172 {
173 DBG1(DBG_TNC, "incorrect size for IETF operational status");
174 return FAILED;
175 }
176 reader = bio_reader_create(this->value);
177 reader->read_uint8 (reader, &this->status);
178 reader->read_uint8 (reader, &this->result);
179 reader->read_uint16(reader, &reserved);
180 reader->read_data (reader, 20, &last_use);
181 reader->destroy(reader);
182
183 if (this->status > OP_STATUS_ROOF)
184 {
185 DBG1(DBG_TNC, "invalid status value %c for IETF operational status",
186 this->status);
187 return FAILED;
188 }
189
190 *offset = 1;
191
192 if (this->result > OP_RESULT_ROOF)
193 {
194 DBG1(DBG_TNC, "invalid result value %c for IETF operational status",
195 this->result);
196 return FAILED;
197 }
198
199 *offset = 4;
200
201 /* Conversion from RFC 3339 ASCII string to time_t */
202 if (sscanf(last_use.ptr, "%4d-%2d-%2dT%2d:%2d:%2dZ", &t.tm_year, &t.tm_mon,
203 &t.tm_mday, &t.tm_hour, &t.tm_min, &t.tm_sec) != 6)
204 {
205 DBG1(DBG_TNC, "invalid last_use time format in IETF operational status");
206 return FAILED;
207 }
208 t.tm_year -= 1900;
209 t.tm_mon -= 1;
210 t.tm_isdst = 0;
211 this->last_use = mktime(&t) - timezone;
212
213 return SUCCESS;
214 }
215
216 METHOD(pa_tnc_attr_t, get_ref, pa_tnc_attr_t*,
217 private_ietf_attr_op_status_t *this)
218 {
219 ref_get(&this->ref);
220 return &this->public.pa_tnc_attribute;
221 }
222
223 METHOD(pa_tnc_attr_t, destroy, void,
224 private_ietf_attr_op_status_t *this)
225 {
226 if (ref_put(&this->ref))
227 {
228 free(this->value.ptr);
229 free(this);
230 }
231 }
232
233 METHOD(ietf_attr_op_status_t, get_status, u_int8_t,
234 private_ietf_attr_op_status_t *this)
235 {
236 return this->status;
237 }
238
239 METHOD(ietf_attr_op_status_t, get_result, u_int8_t,
240 private_ietf_attr_op_status_t *this)
241 {
242 return this->result;
243 }
244
245 METHOD(ietf_attr_op_status_t, get_last_use, time_t,
246 private_ietf_attr_op_status_t *this)
247 {
248 return this->last_use;
249 }
250
251 /**
252 * Described in header.
253 */
254 pa_tnc_attr_t *ietf_attr_op_status_create(u_int8_t status, u_int8_t result,
255 time_t last_use)
256 {
257 private_ietf_attr_op_status_t *this;
258
259 INIT(this,
260 .public = {
261 .pa_tnc_attribute = {
262 .get_type = _get_type,
263 .get_value = _get_value,
264 .get_noskip_flag = _get_noskip_flag,
265 .set_noskip_flag = _set_noskip_flag,
266 .build = _build,
267 .process = _process,
268 .get_ref = _get_ref,
269 .destroy = _destroy,
270 },
271 .get_status = _get_status,
272 .get_result = _get_result,
273 .get_last_use = _get_last_use,
274 },
275 .type = { PEN_IETF, IETF_ATTR_OPERATIONAL_STATUS },
276 .status = status,
277 .result = result,
278 .last_use = last_use,
279 .ref = 1,
280 );
281
282 return &this->public.pa_tnc_attribute;
283 }
284
285 /**
286 * Described in header.
287 */
288 pa_tnc_attr_t *ietf_attr_op_status_create_from_data(chunk_t data)
289 {
290 private_ietf_attr_op_status_t *this;
291
292 INIT(this,
293 .public = {
294 .pa_tnc_attribute = {
295 .get_type = _get_type,
296 .get_value = _get_value,
297 .build = _build,
298 .process = _process,
299 .get_ref = _get_ref,
300 .destroy = _destroy,
301 },
302 .get_status = _get_status,
303 .get_result = _get_result,
304 .get_last_use = _get_last_use,
305 },
306 .type = { PEN_IETF, IETF_ATTR_OPERATIONAL_STATUS },
307 .value = chunk_clone(data),
308 .ref = 1,
309 );
310
311 return &this->public.pa_tnc_attribute;
312 }
313