src/libimcv/ietf/ietf_attr_op_status.c

   1 /*
   2  * Copyright (C) 2012-2014 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 <utils/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          * Length of attribute value
  80          */
  81         size_t length;
  82
  83         /**
  84          * Attribute value or segment
  85          */
  86         chunk_t value;
  87
  88         /**
  89          * Noskip flag
  90          */
  91         bool noskip_flag;
  92
  93         /**
  94          * Status
  95          */
  96         u_int8_t status;
  97
  98         /**
  99          * Result
 100          */
 101         u_int8_t result;
 102
 103         /**
 104          * Last Use
 105          */
 106         time_t last_use;
 107
 108         /**
 109          * Reference count
 110          */
 111         refcount_t ref;
 112 };
 113
 114 METHOD(pa_tnc_attr_t, get_type, pen_type_t,
 115         private_ietf_attr_op_status_t *this)
 116 {
 117         return this->type;
 118 }
 119
 120 METHOD(pa_tnc_attr_t, get_value, chunk_t,
 121         private_ietf_attr_op_status_t *this)
 122 {
 123         return this->value;
 124 }
 125
 126 METHOD(pa_tnc_attr_t, get_noskip_flag, bool,
 127         private_ietf_attr_op_status_t *this)
 128 {
 129         return this->noskip_flag;
 130 }
 131
 132 METHOD(pa_tnc_attr_t, set_noskip_flag,void,
 133         private_ietf_attr_op_status_t *this, bool noskip)
 134 {
 135         this->noskip_flag = noskip;
 136 }
 137
 138 METHOD(pa_tnc_attr_t, build, void,
 139         private_ietf_attr_op_status_t *this)
 140 {
 141         bio_writer_t *writer;
 142         char last_use[24];
 143         struct tm t;
 144
 145         if (this->value.ptr)
 146         {
 147                 return;
 148         }
 149
 150         /* Conversion from time_t to RFC 3339 ASCII string */
 151         gmtime_r(&this->last_use, &t);
 152         snprintf(last_use, 21, "%04d-%02d-%02dT%02d:%02d:%02dZ", 1900 + t.tm_year,
 153                          t.tm_mon + 1, t.tm_mday, t.tm_hour, t.tm_min, t.tm_sec);
 154
 155         writer = bio_writer_create(OP_STATUS_SIZE);
 156         writer->write_uint8 (writer, this->status);
 157         writer->write_uint8 (writer, this->result);
 158         writer->write_uint16(writer, 0x0000);
 159         writer->write_data  (writer, chunk_create(last_use, 20));
 160
 161         this->value = writer->extract_buf(writer);
 162         this->length = this->value.len;
 163         writer->destroy(writer);
 164 }
 165
 166 METHOD(pa_tnc_attr_t, process, status_t,
 167         private_ietf_attr_op_status_t *this, u_int32_t *offset)
 168 {
 169         bio_reader_t *reader;
 170         chunk_t last_use;
 171         u_int16_t reserved;
 172         struct tm t;
 173
 174         *offset = 0;
 175
 176         if (this->value.len < this->length)
 177         {
 178                 return NEED_MORE;
 179         }
 180         if (this->value.len != OP_STATUS_SIZE)
 181         {
 182                 DBG1(DBG_TNC, "incorrect size for IETF operational status");
 183                 return FAILED;
 184         }
 185         reader = bio_reader_create(this->value);
 186         reader->read_uint8 (reader, &this->status);
 187         reader->read_uint8 (reader, &this->result);
 188         reader->read_uint16(reader, &reserved);
 189         reader->read_data  (reader, 20, &last_use);
 190         reader->destroy(reader);
 191
 192         if (this->status > OP_STATUS_ROOF)
 193         {
 194                 DBG1(DBG_TNC, "invalid status value %c for IETF operational status",
 195                                            this->status);
 196                 return FAILED;
 197         }
 198
 199         *offset = 1;
 200
 201         if (this->result > OP_RESULT_ROOF)
 202         {
 203                 DBG1(DBG_TNC, "invalid result value %c for IETF operational status",
 204                                            this->result);
 205                 return FAILED;
 206         }
 207
 208         *offset = 4;
 209
 210         /* Conversion from RFC 3339 ASCII string to time_t */
 211         if (sscanf(last_use.ptr, "%4d-%2d-%2dT%2d:%2d:%2dZ", &t.tm_year, &t.tm_mon,
 212                            &t.tm_mday, &t.tm_hour, &t.tm_min, &t.tm_sec) != 6)
 213         {
 214                 DBG1(DBG_TNC, "invalid last_use time format in IETF operational status");
 215                 return FAILED;
 216         }
 217         t.tm_year -= 1900;
 218         t.tm_mon -= 1;
 219         t.tm_isdst = 0;
 220         this->last_use = mktime(&t) - timezone;
 221
 222         return SUCCESS;
 223 }
 224
 225 METHOD(pa_tnc_attr_t, get_ref, pa_tnc_attr_t*,
 226         private_ietf_attr_op_status_t *this)
 227 {
 228         ref_get(&this->ref);
 229         return &this->public.pa_tnc_attribute;
 230 }
 231
 232 METHOD(pa_tnc_attr_t, destroy, void,
 233         private_ietf_attr_op_status_t *this)
 234 {
 235         if (ref_put(&this->ref))
 236         {
 237                 free(this->value.ptr);
 238                 free(this);
 239         }
 240 }
 241
 242 METHOD(ietf_attr_op_status_t, get_status, u_int8_t,
 243         private_ietf_attr_op_status_t *this)
 244 {
 245         return this->status;
 246 }
 247
 248 METHOD(ietf_attr_op_status_t, get_result, u_int8_t,
 249         private_ietf_attr_op_status_t *this)
 250 {
 251         return this->result;
 252 }
 253
 254 METHOD(ietf_attr_op_status_t, get_last_use, time_t,
 255         private_ietf_attr_op_status_t *this)
 256 {
 257         return this->last_use;
 258 }
 259
 260 /**
 261  * Described in header.
 262  */
 263 pa_tnc_attr_t *ietf_attr_op_status_create(u_int8_t status, u_int8_t result,
 264                                                                                   time_t last_use)
 265 {
 266         private_ietf_attr_op_status_t *this;
 267
 268         INIT(this,
 269                 .public = {
 270                         .pa_tnc_attribute = {
 271                                 .get_type = _get_type,
 272                                 .get_value = _get_value,
 273                                 .get_noskip_flag = _get_noskip_flag,
 274                                 .set_noskip_flag = _set_noskip_flag,
 275                                 .build = _build,
 276                                 .process = _process,
 277                                 .get_ref = _get_ref,
 278                                 .destroy = _destroy,
 279                         },
 280                         .get_status = _get_status,
 281                         .get_result = _get_result,
 282                         .get_last_use = _get_last_use,
 283                 },
 284                 .type = { PEN_IETF, IETF_ATTR_OPERATIONAL_STATUS },
 285                 .status = status,
 286                 .result = result,
 287                 .last_use = last_use,
 288                 .ref = 1,
 289         );
 290
 291         return &this->public.pa_tnc_attribute;
 292 }
 293
 294 /**
 295  * Described in header.
 296  */
 297 pa_tnc_attr_t *ietf_attr_op_status_create_from_data(size_t length, chunk_t data)
 298 {
 299         private_ietf_attr_op_status_t *this;
 300
 301         INIT(this,
 302                 .public = {
 303                         .pa_tnc_attribute = {
 304                                 .get_type = _get_type,
 305                                 .get_value = _get_value,
 306                                 .get_noskip_flag = _get_noskip_flag,
 307                                 .set_noskip_flag = _set_noskip_flag,
 308                                 .build = _build,
 309                                 .process = _process,
 310                                 .get_ref = _get_ref,
 311                                 .destroy = _destroy,
 312                         },
 313                         .get_status = _get_status,
 314                         .get_result = _get_result,
 315                         .get_last_use = _get_last_use,
 316                 },
 317                 .type = { PEN_IETF, IETF_ATTR_OPERATIONAL_STATUS },
 318                 .value = chunk_clone(data),
 319                 .ref = 1,
 320         );
 321
 322         return &this->public.pa_tnc_attribute;
 323 }
 324